arduanov/perl-debug

Введение

Этот репозиторий содержит примеры конфигурации для запуска Docker контейнера с perl сервисом и настройкой дебаггера.

Директории проекта:

• docker-app - докер контейнеры perl и nginx
• docker-uwsgi - докер контейнеры uwsgi и nginx
• lib - код запускаемого сервиса

Подготовка

Запуск docker compose

• Написать Dockerfile для запуска Perl сервиса
• Написать docker-compose.yml для запуска Perl сервиса
• Запустить докер контейнеры из директории с файлом docker-compose.yml

  cd docker-app
  docker compose up --build

• Запущенный сервис будет доступен по адресу http://localhost

Perl модули из Docker контейнера в Jetbrains IDE

• Установить любую Jetbrains IDE, есть абсолютно бесплатная Jetbrains Community Edition
• Установить плагин Perl в Jetbrains IDE
  • Settings > Plugins > Perl (скрин)
• Настроить интерпретатор Perl
  • Settings > Languages & Frameworks > Perl5 (скрин)
• Выбрать интерпретатор в докер контейнере
  • Docker > Add System Perl (скрин)
• Выбрать докер контейнер (скрин)
  • Выбрать путь к перл бинарнику (скрин)
    • Это либо /usr/local/bin/perl, либо /usr/bin/perl
• IDE начнет индексацию perl модулей в докер контейнере
• При обновлении зависимостей в докере - необходимо переиндексировать перл либы в IDE
  • Tools > Perl5 > Refresh Interpreter Information (скрин)
• Теперь в Jetbrains IDE есть все Perl модули

Настройка дебаггера

PSGI / Plack

• В Dockerfile добавить команду установки дебаггера Camelcadedb

  RUN \
    cpanm Devel::Camelcadedb \
    && rm -rf /root/.cpanm

• Прописать загрузку модуля Camelcadedb в параметре command в Dockerfile:

  • Для Server::PSGI command: [ "perl", "-d:Camelcadedb", "/opt/app/docker-app/app/app.pl" ]
  • Для Plack command: [ "plackup", "-p", "3000", "-M","Devel::Camelcadedb" , "/opt/app/docker-app/app/app-plack.pl"]

• Прописать энвы в docker-compose.yml

  environment:
    PERL5LIB: /opt/app/lib
    PERL5_DEBUG_AUTOSTART: ${DEBUG-0}
    PERL5_DEBUG_ROLE: client
    PERL5_DEBUG_HOST: host.docker.internal
    PERL5_DEBUG_PORT: 40000
  

• Настроить IDE для дебага

  • Открыть docker restart app.run.xml и импортировать настройки (скрин 1, скрин 2)
  • Открыть Perl debug app.run.xml и импортировать настройки (скрин 1, скрин 2)

• Выбрать конфигурацию Perl debug app (скрин)

• Запустить докер контейнеры из директории с файлом docker-compose.yml

  cd docker-app
  docker compose up

• Запустить дебаггер (скрин)

uWSGI

• В Dockerfile добавить команду установки дебаггера Camelcadedb и Plack::Middleware::Camelcadedb

  RUN cpanm Devel::Camelcadedb \
    Plack::Middleware::Camelcadedb \
    && rm -rf /root/.cpanm

• Прописать энвы в docker-compose.yml

  environment:
    PERL5LIB: /opt/app/lib
    PERL5_DEBUG_HOST: "host.docker.internal"
    PERL5_DEBUG_PORT: 40000
  

• Настроить IDE для дебага
  • Открыть Perl debug uwsgi.run.xml и импортировать настройки (скрин 1, скрин 2)
• Выбрать конфигурацию Perl debug uwsgi (скрин)
• Запустить докер контейнеры из директории с файлом docker-compose.yml

  cd docker-app
  docker compose up

• Запустить дебаггер (скрин)

Работа с дебаггером

• Убедиться что дебаггер запущен
• Поставить брейкпонт в Base.pm (скрин)
• Открыть в браузере http://localhost
• Окно IDE станет активным и выполнение кода остановится на брейкпойнте (скрин)
• Для продолжения работы кода есть несколько вариантов:
  • Resume Program - перейти к следующему брейкпойнту (скрин)
  • Step Over - перейти к следующей строке (скрин)
  • Step Into - перейти к коду вызываемой функции (скрин)