CircleCI config.ymlの作成方法について（laravel）

Question

実現したいこと

config.ymlを作成して、CircleCIでテストを自動で行えるよう設定したい。
最終的にはデプロイの自動化まで設定したい。

発生している問題・分からないこと

CircleCIのconfig.ymlファイルの作成手順について、教えていただきたいです。
Laravel学習中です。アプリケーションを作成し、AWS（EC2）にデプロイしました。テストファイルも作成済みです。

開発環境ではDocker(docker-compose.yml)を用いてphp、nginx、mysql、phpmyadminのコンテナを作成したので、これと同じような手順でビルドできれば良いかなと考えています。
具体的には以下の通りです。

• Docker Compose upでphpとmysqlのコンテナを作成（CIの環境ではnginx、phpmyadminは不要かと思いますので、省略）
• composer install
• .envファイルの設定（Environment Variablesで設定すべき？）
• アプリケーションキーの生成
• データベースのセットアップ
• テストの実行

現状Docker Compose upのところで、以下のようなエラーが発生しています。

FileNotFoundError: [Errno 2] No such file or directory: 'docker': 'docker'
[65] Failed to execute script docker-compose

エラーの解消も必要なのですが、そもそも環境構築の経験や知識がほとんどないので、全く的外れなものを作っているのではないかという気がしています。
大枠としてこのような作成手順で良いのかという観点でアドバイスいただけたらありがたいです。

よろしくお願いいたします。

該当のソースコード

version: 2.1

jobs:
  build:
    docker:
      - image: php:8.1-fpm
    steps:
      - checkout

      # Dockerのセットアップ
      - setup_remote_docker:
          version: 20.10.7

      # Docker Compose のインストール
      - run:
          name: Install Docker Compose
          command: |
            curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
            chmod +x /usr/local/bin/docker-compose
            ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

      # シンボリックリンクの確認
      - run:
          name: Verify Symbolic Link
          command: |
            if [ -L /usr/bin/docker-compose ]; then
              echo "Symbolic link exists."
              ls -l /usr/bin/docker-compose
            else
              echo "Symbolic link does not exist."
            fi

      # Docker Compose のパス確認
      - run:
          name: Check Docker Compose Path
          command: |
            if command -v docker-compose >/dev/null 2>&1; then
              echo "Docker Compose is available in PATH"
              which docker-compose
            else
              echo "Docker Compose is not available in PATH"
            fi

      # Docker Compose がインストールされているか確認
      - run:
          name: Check Docker Compose version
          command: docker-compose --version

      # Docker Compose プロジェクトの構築と起動
      - run:
          name: Docker Compose up
          command: |
            pwd
            docker-compose -f docker-compose.yml up -d --build

      # 依存関係のインストール
      - run:
          name: Install dependencies
          command: docker-compose exec php composer install

      # 環境変数ファイルのコピー
      - run:
          name: Copy .env
          command: |
            cp .env.example .env

      # .envファイルの設定更新
      - run:
          name: Update .env for testing
          command: |
            sed -i 's/DB_HOST=127.0.0.1/DB_HOST=mysql/' .env && \
            sed -i 's/DB_DATABASE=laravel/DB_DATABASE=laravel_db/' .env && \
            sed -i 's/DB_USERNAME=root/DB_USERNAME=laravel_user/' .env && \
            sed -i 's/DB_PASSWORD=/DB_PASSWORD=laravel_pass/' .env

      # アプリケーションキーの生成
      - run:
          name: Generate application key
          command: docker-compose exec php php artisan key:generate

      # データベースのセットアップ
      - run:
          name: Wait for MySQL
          command: docker-compose exec php sh -c 'while ! mysqladmin ping -hmysql --silent; do sleep 1; done'

      - run:
          name: Run migrations
          command: docker-compose exec php php artisan migrate --force

      # PHPUnitテストの実行
      - run:
          name: Run tests
          command: docker-compose exec php ./vendor/bin/phpunit

workflows:
  version: 2
  build_and_test:
    jobs:
      - build

試したこと・調べたこと

• teratailやGoogle等で検索した
• ソースコードを自分なりに変更した
• 知人に聞いた
• その他

上記の詳細・結果

    docker:
      - image: 

        environment:
            MYSQL_ROOT_PASSWORD: pass
            MYSQL_DATABASE: laravel
            MYSQL_USER: laravel

mysqlのイメージを追加すべき？またはdocker-compose.ymlにまとめて記述されているので追加は不要？

補足

Dockerfileとdocker-compose.ymlの内容は以下の通りです。

Dockerfile

FROM php:8.1-fpm

COPY php.ini /usr/local/etc/php/

RUN apt update \
    && apt install -y default-mysql-client zlib1g-dev libzip-dev unzip libpng-dev libjpeg-dev \
    && docker-php-ext-configure gd --with-jpeg \
    && docker-php-ext-install pdo_mysql zip gd

RUN curl -sS https://getcomposer.org/installer | php \
    && mv composer.phar /usr/local/bin/composer \
    && composer self-update

WORKDIR /var/www

docker-compose.yml

version: '3.8'

services:
    nginx:
        image: nginx:1.21.1
        ports:
            - "80:80"
        volumes:
            - ./docker/nginx/default.conf:/etc/nginx/conf.d/default.conf
            - ./src:/var/www/
        depends_on:
            - php

    php:
        build: ./docker/php
        volumes:
            - ./src:/var/www/

    mysql:
        image: mysql:8.0.26
        environment:
            MYSQL_ROOT_PASSWORD: root
            MYSQL_DATABASE: laravel_db
            MYSQL_USER: laravel_user
            MYSQL_PASSWORD: laravel_pass
        command:
            mysqld --default-authentication-plugin=mysql_native_password
        volumes:
            - ./docker/mysql/data:/var/lib/mysql
            - ./docker/mysql/my.cnf:/etc/mysql/conf.d/my.cnf
        platform: linux/amd64

    phpmyadmin:
        image: phpmyadmin/phpmyadmin
        environment:
            - PMA_ARBITRARY=1
            - PMA_HOST=mysql
            - PMA_USER=laravel_user
            - PMA_PASSWORD=laravel_pass
        depends_on:
            - mysql
        ports:
            - 8080:80
        platform: linux/amd64

Comments

[Eggpan]

> Failed to execute script docker-compose
となっていますが、docker-compose.ymlやDockerfileの内容を追記いただくことはできますか？

docker-compose upが失敗しているように見受けられます。
また、エラーに直接関係あるかはわかりませんが、docker-compose v1.xはEOLになって1年ほどたちますので利用しないほうがよいかと思います。

[aid2020]

コメントありがとうございます。
補足に追記しましたので、お気付きの点があれば教えていただけると幸いです。
EOLの部分は修正してみたいと思います。

Answer 1

エラーの解消も必要なのですが、そもそも環境構築の経験や知識がほとんどないので、全く的外れなものを作っているのではないかという気がしています。
大枠としてこのような作成手順で良いのかという観点でアドバイスいただけたらありがたいです。

作成手順としては問題ないです。
しかし、何を目的として何を達成したいのかによると思います。

CircleCI で Docker をビルドしてテスト、そのままEC2へDockerをデプロイする。という流れを作るのは自然ですし、環境の差異を無くす方法を達成したいのかと思います。

しかしDockerでビルドしてもテスト環境や本番環境は別でビルドする事になれば(例えばcomposerのdevを含めないとかで十分あり得ます)少しずれてしまう行動になってしまいます。
完全に同じ環境で整えるのは手間がかかり過ぎてしまうので、どこかで妥協する必要もあります。個人的にはDockerで環境構築してもaptのバージョンアップデートにより作り直しになった経験もあるので、手間がかかってしまう割に使える期間が短いと感じます。

LaravelであればDockerに依存しなくても基本的なLAMP環境であれば使えるので、手間を嫌うのであればそちらも選択肢に入れても良いかもしれません。
いわゆるレガシーと呼ぶ人も居ますが、長期間の使用実績がある魅力もあります。
Dockerでの環境構築は新しい技術ですが、環境構築を行う時間も大量に必要になるので、アプリケーションとしてユーザーに機能を提供する時間が少なくなってしまうパターンが考えられます。

精神論的な話になってしまいましたが、最終的にサービス公開後のユーザーにとってメリット(バグが無い or 素早く新しいサービスが体験できる)になるのであればなんだっていいと思います。

Comments

[aid2020]

環境構築はこれまでDockerしか利用してきませんでしたが、XAMPPまたはMAMPを使用するということも十分選択肢になるという事ですね。作成手順としては問題ないということでもう少し見直してみたいと思います。回答ありがとうございました。

[ytsuyuzaki]

エラーの解消とは別のことを書きましたが、回答になっていたのであれば幸いです。
他、回答が必要であれば私で出来る事ならお力添えしたいと思います。
無ければベストアンサーに選んでいただき、質問を解決状態にしてもらえればと思います。

Answer 2

質問は全部無視して後から見る人のために
CIでLaravelをテストするベストな方法を書く。

• GitHub Actionsを使う。
• Laravelのテスト程度にDockerは不要。MySQLも不要。
• GitHub Actionsを使えばLaravel公式の書き方を参考にできる。 https://github.com/laravel/laravel/blob/11.x/.github/workflows/tests.yml

とはいえPHPが動く環境さえ用意すればGitHub Actions以外でも流れは同じ。

composer install
cp .env.example .env
php artisan key:generate
vendor/bin/phpunit

Dockerを使うような余計なことをするから難しくなる。

環境変数はphpunit.xmlで設定。
https://github.com/laravel/laravel/blob/11.x/phpunit.xml
テストでデータベースを使うならphpunit.xmlでインメモリSQLiteを使うように設定が必要。
コメントになってる部分を外す。

<env name="DB_CONNECTION" value="sqlite"/>
<env name="DB_DATABASE" value=":memory:"/>

Laravel11でSailを使ってない場合、プロジェクト作成後すぐにここを変えないとローカルのテストでもDBが消される。

Laravelプロジェクトの99%はインメモリSQLiteで十分。
本物のMySQLを使ったテストが必要になることはない。

Comments

[aid2020]

Docker関連の理解が不足しているので、引き続き学習したいと思いますが、
大筋の流れは合っているようなので、もっと他のシンプルな方法で設定しても良いように感じました。
回答ありがとうございました。