「Xdebug」の記事 - Crieit

Docker の php:7-alpine イメージで Composer と Xdebug を使えるようにする

2022-05-10T22:39:48+09:00

経緯

slimphp/Slim-Skeleton を利用したいと考えました。

手元の端末で開発しようとしたところ、 XAMPP に Xdebug を入れ忘れていたことに気付きました。しかも、 XAMPP の PHP のバージョンで Xdebug のインストールが止まってしまいました。

そこで、スケルトンプロジェクトに付随している Docker Compose での開発を試みましたが、この Docker Compose 内で pull してくるイメージは Composer も Xdebug もないので入れることにしました。

コード

ディレクトリ構造

root/
    ├ _docker/                               // Dockerに関する設定置き場
    │    ├ dockerfiles/
    │    │    ├ settings/
    │    │    │    └ php.ini                 // PHPの設定 (Xdebug 有効化)
    │    │    │
    │    │    └ Dockerfile
    │    │
    │    ├ mysql/                            // MariaDB 用ディレクトリ
    │    │    └ .gitkeep
    │    │
    │    └ phpmyadmin/
    │         ├ conf/
    │         │    └ phpmyadmin-misc.ini     // phpMyAdmin の設定 (メモリ上限など)
    │         │
    │         └ sessions/
    │              └ .gitkeep
    │
    └ docker-compose.yml

Docker に関する部分のみ列挙。

docker-compose.yml

version: '3.7'

volumes:
    logs:
        driver: local

services:
    slim:
        build:
            context: ./_docker/dockerfiles/
            dockerfile: Dockerfile
        working_dir: /var/www
        command: php -S 0.0.0.0:8080 -t public
        environment:
            docker: "true"
        ports:
            - 8080:8080
        volumes:
            - .:/var/www
            - ./logs:/var/www/logs
    db:
        image: mariadb
        restart: always
        ports:
            - 3306:3306
        volumes:
            - ./_docker/mysql/mysql:/var/lib/mysql
            - ./_docker/mysql/initdb.d:/docker-entrypoint-initdb.d
        environment:
            - MYSQL_ROOT_PASSWORD=pwd
            - MYSQL_DATABASE=test
            - MYSQL_USER=user
            - MYSQL_PASSWORD=pwd
    phpmyadmin:
        image: phpmyadmin/phpmyadmin
        volumes:
            - ./_docker/phpmyadmin/sessions:/sessions
            - ./_docker/phpmyadmin/conf/phpmyadmin-misc.ini:/usr/local/etc/php/conf.d/phpmyadmin-misc.ini
        environment:
            - PMA_ARBITRARY=1
            - PMA_HOST=db
            - PMA_USER=user
            - PMA_PASSWORD=pwd
        ports:
            - 8081:80

変更点は以下。

PHP 用環境: Dockerfile を使ったイメージにカスタマイズ
DB: MariaDB のイメージをそのまま利用
- environment のパラメータはそのまま使用。アプリケーションや phpMyAdmin 側と動機は取れていないですがひとまずはこれで……
phpMyAdmin: これも phpMyAdmin 公式イメージを流用

_docker/dockerfiles/Dockerfile

FROM php:7-alpine
RUN apk --update add curl
RUN set -ex \
  && apk --no-cache add \
  autoconf build-base
RUN pecl install xdebug
RUN docker-php-ext-enable xdebug
RUN docker-php-ext-install pdo_mysql
COPY settings/php.ini /usr/local/etc/php/conf.d
RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/bin --filename=composer

php:7-alpine をベースに Xdebug と Composer を追加。

_docker/dockerfiles/settings/php.ini

xdebug.mode=coverage

Xdebug でカバレッジを有効化するための設定を追加するため。なお、 Dockerfile で COPY する際のホストマシンでのパスは Dockerfile の存在するディレクトリから下でないと参照できない という地味な制約があるので dockerfiles ディレクトリをわざわざ掘りました。

_docker/phpmyadmin/conf/phpmyadmin-misc.ini

allow_url_fopen = Off
max_execution_time = 600
memory_limit = 64M
post_max_size = 64M
upload_max_filesize = 64M

メモリ上限等のカスタマイズ。

これで今回はカバレッジ出力まで動作することを確認しました。

参考

Xdebug

PHPUnitでHTMLコードカバレッジを出すまで(Docker使用) - Qiita

Warning: XDEBUG_MODE=coverage or xdebug.mode=coverage has to be set

が出たので step3 について実施。

なお、今回のケースでは

extension=xdebug.so

は不要だった。

Dockerfile

Dockerで作るNginx + PHP7 + Xdebug環境 | Crudzoo

ほぼこれでOK.

php-alpineコンテナにxdebugをインストールする時にハマったメモ - Qiita

こちらも参照。 php -v で with Xdebug と付いていればOK。

Dockerfile の COPY

【Docker】COPYで指定されたファイルは、Dockerfileが存在するディレクトリからの相対パスで、親ディレクトリを見れない - タカの技術ノート

Mariadb

could not find driver

普通に考えたら確かにドライバがないので追加して解決。

シェル

dockerでalpine linux ベースのcontainerに入って、shellを使いたいとき。 - Qiita

bash ではなく ash 。 bin/ash 指定。

sr -c

docker-compose.ymlのcommandプロパティに複数コマンドを設定する方法 | ゲンゾウ用ポストイット

最終的には使わずに済みましたが念のためメモ。

DockerでXdebugのインストールを失敗した場合

2020-03-04T22:44:48+09:00

DockerのコンテナにXdebugをインストールしようとして失敗した。
発生したエラーは以下の2点。

autoconfがインストールされていなかった
Cコンパイラがインストールされていなかった

実行環境

Docker 2.2.0.0
PHP 7.4
- php:7.4-fpm-alpine
Xdebug 2.9.2

その1 autoconfがインストールされていない

以下のようなエラーが表示された場合はautoconfがインストールされていない。

downloading xdebug-2.9.2.tgz ...
Starting to download xdebug-2.9.2.tgz (242,959 bytes)
..................................................done: 242,959 bytes
90 source files, building
running: phpize
Configuring for:
PHP Api Version:         20190902
Zend Module Api No:      20190902
Zend Extension Api No:   320190902
Cannot find autoconf. Please check your autoconf installation and the
$PHP_AUTOCONF environment variable. Then, rerun this script.

ERROR: `phpize' failed

この場合はapk add autoconfを実行してインストールすればよい。

その2 コンパイラがインストールされていない

以下のようなエラーが表示された場合はコンパイラのインストールがされていない。

downloading xdebug-2.9.2.tgz ...
Starting to download xdebug-2.9.2.tgz (242,959 bytes)
..................................................done: 242,959 bytes
90 source files, building
running: phpize
Configuring for:
PHP Api Version:         20190902
Zend Module Api No:      20190902
Zend Extension Api No:   320190902
building in /tmp/pear/temp/pear-build-defaultuserhmhpmF/xdebug-2.9.2
running: /tmp/pear/temp/xdebug/configure --with-php-config=/usr/local/bin/php-config
checking for grep that handles long lines and -e... /bin/grep
checking for egrep... /bin/grep -E
checking for a sed that does not truncate output... /bin/sed
checking for pkg-config... no
checking for cc... no
checking for gcc... no
configure: error: in `/tmp/pear/temp/pear-build-defaultuserhmhpmF/xdebug-2.9.2':
configure: error: no acceptable C compiler found in $PATH
See `config.log' for more details
ERROR: `/tmp/pear/temp/xdebug/configure --with-php-config=/usr/local/bin/php-config' failed

この場合はapk add gcc g++ makeを実行してインストールすればコンパイルが可能になる。

また、apk add build-baseの実行でも必要なパッケージのインストールが行える。
build-baseは以下7つのパッケージをインストールする。

binutils
file
fortify-headers
g++
gcc
libc-dev
make

参考

php-alpineコンテナにxdebugをインストールする時にハマったメモ - Qiita

VSCodeのRemote DevelopmentでDocker内のPHPでデバッグしてみた

2019-06-08T10:30:51+09:00

VSCodeのStable版でRemote Developmentのプレビュー版が使えるようになったので先日Node.jsで試してみましたが、PHPのXdebugによるデバッグも試してみました。

Remote Developmentの拡張機能のインストールは下記の記事と同じです。

VSCodeのRemote DevelopmentでDocker内のNodeでデバッグしてみた

サンプルのプロジェクトをclone

PHPにもサンプルのプロジェクトがありますので、そちらをcloneしてきます。

git clone https://github.com/microsoft/vscode-remote-try-php.git

プロジェクトを開く

cloneしてきたフォルダを開いたら、下記のボタンをクリックしてRemote-Containers: Open Folder in Container...を選択します。フォルダを指定するとDockerイメージがビルドされ、コンテナの中でVSCodeが開き直され準備完了です。

デバッグする

基本的な準備はできたのでデバッグしてみます。下記のように、適当な箇所にブレークポイントを設置します。

デバッグをスタートするためF5を押すか、下記のようにデバッグメニューの実行ボタンをクリックします。

問題なければ下記のように停止し、変数の中身を見ることができます。

ブラウザアクセスでデバッグする

上記の方法だと、コマンドラインでの実行としてのデバッグになりますので、ブラウザでアクセスしてもブレークポイントで停止できません。そのため、サーバーとしての動作でも止められるように.vscode/launch.jsonのconfigurationsに下記のような設定を追加します。

        {
            "name": "Listen for XDebug",
            "type": "php",
            "request": "launch",
            "port": 9000
        },

次にデバッグメニューでその設定を選択して起動します。するとXdebugのListenがスタートします。

次に、プログラムをサーバー起動させます。これでブラウザからアクセスできるようになります。

php -S localhost:8000

これでhttp://localhost:8000にブラウザアクセスすると先程の同様にブレークポイントで止まります。

まとめ

通常の開発にはあまり使わないかもしれませんが、フレームワークの中の処理を追いたいとか、APIやテストの開発時には便利そうですね。また他の言語も試してみたいと思います。