Mac mini + Docker + Jenkins環境を構築し、Laravelのテストを実行する(その2)

/LaravelSampe
  - /.docker // Dockerfileなどを格納
  - /src  // Laravelプロジェクトを格納
  - docker-compose.yml
  - docker-compose.override.jenkins.yml // Jenkins環境で動作するためのdocker-compose.overrideファイル

pipeline {
    agent any // 任意の利用可能なエージェントで実行

    environment {
        GIT_REPO_URL = 'https://git.XXXX/git/XXXXX/LaravelSample.git' // GitリポジトリがあるURL
        BRANCH = 'main'  // ビルド対象となるブランチ名
        DOCKER_DIR = '.' // docker-compose.yml が存在するディレクトリ
        ENV_FILE = '.env.example' // テストで使用する.envファイル
        LARAVEL_APP_SERVICE_NAME = 'web_app' // dockerのPHPのイメージ名（docker-composeに記述)

        // Docker Compose Override ファイルの定義
        DOCKER_COMPOSE_OVERRIDE_SOURCE = 'docker-compose.override.jenkins.yml'
        DOCKER_COMPOSE_OVERRIDE_TARGET = 'docker-compose.override.yml'
    }

    triggers {
        cron '0 0 * * *' // 毎日夜中0時に実行
    }

    stages {
        stage('Checkout Source Code') {
            steps {
                script {
                    // 最初の環境をクリーンにする
                    echo "Cleaning workspace..."
                    cleanWs()
                    
                    echo "Checking out source code from ${GIT_REPO_URL}..."
                    // Git 認証情報が必要な場合は credentialsId を指定
                    // credentialsId: 'your-git-credentials-id'
                    git url: GIT_REPO_URL, branch: BRANCH
                }
            }
        }

        stage('Prepare Docker Compose Override') {
            steps {
                script {
                    echo "Preparing Docker Compose override file..."
                    dir("${DOCKER_DIR}") { // docker-compose.yml と同じディレクトリで操作
                        if (fileExists(env.DOCKER_COMPOSE_OVERRIDE_SOURCE)) {
                            echo "Copying ${env.DOCKER_COMPOSE_OVERRIDE_SOURCE} to ${env.DOCKER_COMPOSE_OVERRIDE_TARGET}..."
                            sh "cp ${env.DOCKER_COMPOSE_OVERRIDE_SOURCE} ${env.DOCKER_COMPOSE_OVERRIDE_TARGET}"
                        } else {
                            error "Error: ${env.DOCKER_COMPOSE_OVERRIDE_SOURCE} not found in ${env.DOCKER_DIR}."
                        }
                    }
                }
            }
        }

        stage('Build and Start Docker Environment') {
            steps {
                script {
                    echo "Navigating to Docker directory: ${DOCKER_DIR}"
                    dir("${DOCKER_DIR}") {
                        echo "Building and starting Docker containers..."
                        // --build オプションで、コンテナの再ビルドを確実に実行
                        sh "docker-compose up -d --build"
                    }
                }
            }
        }

        stage('Verify Mount and Update Laravel Dependencies') { 
            steps {
                script {
                    echo "Verifying /app mount in ${LARAVEL_APP_SERVICE_NAME} container..."
                    sh "docker exec ${LARAVEL_APP_SERVICE_NAME} ls -la /app/" 

                    echo "Updating Laravel dependencies and optimizing..."
                    sh "docker exec ${LARAVEL_APP_SERVICE_NAME} composer install --no-interaction --prefer-dist"
                    
                    sh "docker exec ${LARAVEL_APP_SERVICE_NAME} cp ${ENV_FILE} .env"
                    
                    sh "docker exec ${LARAVEL_APP_SERVICE_NAME} php artisan key:generate --ansi"
                    
                    sh "docker exec ${LARAVEL_APP_SERVICE_NAME} php artisan config:clear || true" 
                    sh "docker exec ${LARAVEL_APP_SERVICE_NAME} php artisan cache:clear || true" 
                    sh "docker exec ${LARAVEL_APP_SERVICE_NAME} php artisan route:clear || true" 
                    sh "docker exec ${LARAVEL_APP_SERVICE_NAME} php artisan view:clear || true" 
                    sh "docker exec ${LARAVEL_APP_SERVICE_NAME} php artisan optimize:clear || true" 
                }
            }
        }
        
        stage('Run Database Migrations (if needed for tests)') {
            steps {
                script {
                    echo "Running database migrations..."
                    sh "docker exec ${LARAVEL_APP_SERVICE_NAME} php artisan migrate --force"
                }
            }
        }

        stage('Run Laravel Tests') {
            steps {
                script {
                    echo "Running Laravel tests..."
                    sh "docker exec ${LARAVEL_APP_SERVICE_NAME} php artisan test"
                }
            }
        }

        stage('Clean up Docker Environment') {
            steps {
                script {
                    echo "Stopping and removing Docker containers..."
                    dir("${DOCKER_DIR}") {
                        sh "docker-compose down"
                    }
                }
            }
        }
    }

    post {
        always {
            echo "Pipeline finished. Status: ${currentBuild.result}"
        }
        failure {
            echo "Pipeline failed! Check logs for details."
        }
    }
}