Added docker environment for local development

Author: cebe

Makefile

@@ -6,34 +6,55 @@ ifeq ($(XDEBUG),1)
 XPHPARGS=-dzend_extension=xdebug.so -dxdebug.remote_enable=1 -dxdebug.remote_autostart=1
 endif
 
+# Run make with IN_DOCKER=1 to run yarn and php commands in a docker container
+DOCKER_PHP=
+DOCKER_NODE=
+IN_DOCKER=0
+ifeq ($(IN_DOCKER),1)
+DOCKER_PHP=docker-compose run --rm php
+DOCKER_NODE=docker-compose run --rm -w /app node
+endif
+
 all:
+	@echo "the following commands are available:"
+	@echo ""
+	@echo "make check-style              # check code style"
+	@echo "make fix-style                # fix code style"
+	@echo "make install                  # install dependencies"
+	@echo "make test                     # run PHPUnit tests"
+	@echo "make lint                     # check validity of test data"
+	@echo "make stan                     # check code with PHPStan"
+	@echo ""
+	@echo "You may add the IN_DOCKER parameter to run a command inside of docker container and not directly."
+	@echo "make IN_DOCKER=1 ..."
+
 
 check-style: php-cs-fixer.phar
 	PHP_CS_FIXER_IGNORE_ENV=1 ./php-cs-fixer.phar fix src/ --diff --dry-run
 
 fix-style: php-cs-fixer.phar
-	vendor/bin/indent --tabs composer.json
-	vendor/bin/indent --spaces .php_cs.dist
-	./php-cs-fixer.phar fix src/ --diff
+	$(DOCKER_PHP) vendor/bin/indent --tabs composer.json
+	$(DOCKER_PHP) vendor/bin/indent --spaces .php_cs.dist
+	$(DOCKER_PHP) ./php-cs-fixer.phar fix src/ --diff
 
-install:
-	composer install --prefer-dist --no-interaction --no-progress --ansi
-	yarn install
+install: composer.lock yarn.lock
+	$(DOCKER_PHP) composer install --prefer-dist --no-interaction --no-progress --ansi
+	$(DOCKER_NODE) yarn install
 
 test:
-	php $(PHPARGS) $(XPHPARGS) vendor/bin/phpunit --verbose --colors=always $(TESTCASE)
-	php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/recursion.json
-	php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/recursion2.yaml
+	$(DOCKER_PHP) php $(PHPARGS) $(XPHPARGS) vendor/bin/phpunit --verbose --colors=always $(TESTCASE)
+	$(DOCKER_PHP) php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/recursion.json
+	$(DOCKER_PHP) php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/recursion2.yaml
 
 lint: install
-	php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/reference/playlist.json
-	php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/recursion.json
-	php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/recursion2.yaml
-	yarn run speccy lint tests/spec/data/reference/playlist.json
-	yarn run speccy lint tests/spec/data/recursion.json
+	$(DOCKER_PHP) php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/reference/playlist.json
+	$(DOCKER_PHP) php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/recursion.json
+	$(DOCKER_PHP) php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/recursion2.yaml
+	$(DOCKER_NODE) yarn run speccy lint tests/spec/data/reference/playlist.json
+	$(DOCKER_NODE) yarn run speccy lint tests/spec/data/recursion.json
 
 stan:
-	php $(PHPARGS) vendor/bin/phpstan analyse -l 5 src
+	$(DOCKER_PHP) php $(PHPARGS) vendor/bin/phpstan analyse -l 5 src
 
 # copy openapi3 json schema
 schemas/openapi-v3.0.json: vendor/oai/openapi-specification/schemas/v3.0/schema.json

README.md

@@ -277,6 +277,16 @@ This library is currently work in progress, the following list tracks completene
   - [x] OAuth Flow Object
   - [x] Security Requirement Object
 
+# Development
+
+You may use the docker environment for local development:
+
+    docker-compose build
+    make IN_DOCKER=1 install
+    make IN_DOCKER=1 test
+    ...
+
+
 # Support
 
 **Need help with your API project?**

docker-compose.yml

@@ -0,0 +1,22 @@
+version: "3"
+services:
+    php:
+        build:
+            dockerfile: tests/docker/Dockerfile
+            context: .
+        volumes:
+            - ./tests/tmp/.composer:/root/.composer:rw
+            - .:/app
+        environment:
+            - TZ=UTC
+            - TIMEZONE=UTC
+            - IN_DOCKER=docker
+            - PHP_XDEBUG_ENABLED=1
+            - XDEBUG_CONFIG="remote_host=host.docker.internal"
+            - PHP_IDE_CONFIG="serverName=Docker"
+        tty: true
+    node:
+        image: node:11
+        volumes:
+#            - ./tests/tmp/.composer:/root/.composer:rw
+            - .:/app

tests/.gitignore

@@ -0,0 +1 @@
+/tmp

tests/docker/Dockerfile

@@ -0,0 +1,57 @@
+FROM php:7.4-cli
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN echo "force-unsafe-io" > /etc/dpkg/dpkg.cfg.d/02apt-speedup && \
+    echo "Acquire::http {No-Cache=True;};" > /etc/apt/apt.conf.d/no-cache
+RUN apt-get update && \
+    apt-get -y install \
+        gnupg2 && \
+    apt-key update && \
+    apt-get update && \
+    apt-get install -y --no-install-recommends \
+            libzip-dev \
+            libonig-dev \
+            vim \
+            git \
+            unzip\
+            libxml2-dev \
+            curl \
+            libcurl4-openssl-dev \
+            libssl-dev \
+        --no-install-recommends && \
+        apt-get clean && \
+        rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* \
+        && pecl install xdebug-2.9.6 \
+        && docker-php-ext-enable xdebug \
+        && docker-php-ext-install \
+                zip \
+                curl \
+                mbstring
+
+# Install composer
+ENV COMPOSER_ALLOW_SUPERUSER=1 \
+    PHP_USER_ID=33 \
+    PHP_ENABLE_XDEBUG=1 \
+    COMPOSER_HOME=/root/.composer/ \
+    PATH=/app:/app/vendor/bin:/root/.composer/vendor/bin:$PATH
+
+RUN curl -o /tmp/composer-setup.php https://getcomposer.org/installer \
+&& curl -o /tmp/composer-setup.sig https://composer.github.io/installer.sig \
+# Make sure we're installing what we think we're installing!
+&& php -r "if (hash('SHA384', file_get_contents('/tmp/composer-setup.php')) !== trim(file_get_contents('/tmp/composer-setup.sig'))) { unlink('/tmp/composer-setup.php'); echo 'Invalid installer' . PHP_EOL; exit(1); }" \
+&& php /tmp/composer-setup.php --no-ansi --install-dir=/usr/local/bin --filename=composer \
+&& rm -f /tmp/composer-setup.*
+
+# Enable Xdebug
+ENV XDEBUGINI_PATH=/usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
+
+RUN echo "xdebug.idekey=PHP_STORM" >> $XDEBUGINI_PATH && \
+    echo "xdebug.default_enable=1" >> $XDEBUGINI_PATH && \
+    echo "xdebug.remote_enable=1" >> $XDEBUGINI_PATH && \
+    echo "xdebug.remote_connect_back=1" >> $XDEBUGINI_PATH && \
+    echo "xdebug.remote_log=xdebug_remote.log" >> $XDEBUGINI_PATH && \
+    echo "xdebug.remote_port=9000" >> $XDEBUGINI_PATH && \
+    echo "xdebug.remote_autostart=1" >> $XDEBUGINI_PATH
+
+WORKDIR /app