Task/gitpod optimize

.gitattributes

@@ -3,6 +3,7 @@
 /.gitattributes     export-ignore
 /.gitignore         export-ignore
 /.github            export-ignore
+/.gitpod            export-ignore
 /tests              export-ignore
 /.php.cs            export-ignore
 /codeception.yml   export-ignore

.gitignore

@@ -7,6 +7,7 @@ typo3-core
 packages/*
 !packages/.gitkeep
 .ddev/
-config/
+/config/
 test-acceptance-tdk/
-/tests/_support/_generated
+/tests/_support/_generated
+/.vscode

.gitpod.yml

@@ -1,53 +1,64 @@
+---
+# Example
+# 8.1 https://gitpod.io/#TDK_PHP_VERSION=8.1,TDK_BRANCH=main,TDK_PATCH_REF=refs%2Fchanges%2F43%2F70643%2F36,TDK_USERNAME=ochorocho,TDK_PATCH_ID=70643/https://github.com/ochorocho/tdk/tree/task/gitpod-optimize
+# 8.0 https://gitpod.io/#TDK_PHP_VERSION=8.0,TDK_BRANCH=main,TDK_PATCH_REF=refs%2Fchanges%2F43%2F70643%2F36,TDK_USERNAME=ochorocho,TDK_PATCH_ID=70643/https://github.com/ochorocho/tdk/tree/task/gitpod-optimize
+# Detect php: https://gitpod.io/#TDK_BRANCH=11.5,TDK_PATCH_REF=refs%2Fchanges%2F43%2F70643%2F36,TDK_USERNAME=ochorocho,TDK_PATCH_ID=70643/https://github.com/ochorocho/tdk/tree/task/gitpod-optimize
+
 image: ochorocho/gitpod-tdk:latest
 
 tasks:
-  - init: |
-      .gitpod/utils/ddev-in-gitpod-setup.sh
-      ddev config --docroot=public --create-docroot --project-type=typo3 --project-name=typo3
-    command: |
-      .gitpod/utils/env-setup.sh
+  - name: TDK
+    init: |
+      mkdir -p .vscode
+      cp -Rp .gitpod/vscode/settings.json .vscode/settings.json
+      cp -Rp .gitpod/vscode/launch.json .vscode/launch.json
+      tdk php "$(php .gitpod/php/version.php)" --no-reload
+      gp open .gitpod/info.md
       composer tdk:clone
       composer tdk:checkout
       composer install
       composer tdk:set-git-config
       composer tdk:enable-hooks -- --force
       composer tdk:apply-patch
-      ddev start
+      mkdir -p public/typo3conf
       touch public/FIRST_INSTALL
+      cp -Rp .gitpod/typo3/AdditionalConfiguration.php public/typo3conf/AdditionalConfiguration.php
+    command: |
+      tdk php "$(php .gitpod/php/version.php)"
+      sudo service mailhog start
+      sudo service mysql start
+      sudo service cron start
+      sleep 5
+      tdk db create
       composer tdk:help
+      tdk preview fe
+      gp sync-done tdk-done
 
-# VScode xdebug extension
 vscode:
   extensions:
-    # PHP extensions.
     - felixfbecker.php-debug
     - wongjn.php-sniffer
     - neilbrayfield.php-docblocker
     - bmewburn.vscode-intelephense-client
-
-    # Bash extensions.
-    - timonwong.shellcheck
-    - rogalmic.bash-debug
+    # @todo: Installing sqltools does not work as expected
+    #        it requires a window reload in some cases
+    - mtxr.sqltools
+    - mtxr.sqltools-driver-mysql
 
 ports:
-  # Used by ddev - direct-bind https port
-  - port: 2222
-    onOpen: ignore
-  # Used by ddev - local db clients
   - port: 3306
+    name: database
     onOpen: ignore
-  # Used by projector
-  - port: 6942
-    onOpen: ignore
-  # Used by MailHog
-  - port: 8025
+  - port: 8001
+    name: apache
     onOpen: ignore
-  # Used by phpMyAdmin
-  - port: 8036
+  - port: 1025
+    name: mailhog catcher
     onOpen: ignore
-  # Direct-connect ddev-webserver port that is the main port
-  - port: 8080
+  - port: 8025
+    name: mailhog
     onOpen: ignore
-  # xdebug port
-  - port: 9000
+  - port: 9003
+    name: xdebug
+    description: xdebug
     onOpen: ignore

.gitpod/docker/Dockerfile

@@ -0,0 +1,48 @@
+# Image on docker hub: https://hub.docker.com/r/ochorocho/gitpod-tdk/tags
+FROM gitpod/workspace-base:latest
+
+USER root
+
+# Add custom config/scripts to container
+COPY config /config
+COPY config/apache.conf /etc/apache2/apache2.conf
+COPY config/envvars.txt /etc/apache2/envvars
+COPY scripts/mailhog /etc/init.d/mailhog
+COPY scripts/mysql /etc/init.d/mysql
+COPY scripts/tdk /usr/bin/
+COPY scripts/tdk-completion /etc/bash_completion.d/
+COPY config/mysql-client.cnf /etc/mysql/mysql.conf.d/client.cnf
+COPY config/mysql.cnf /etc/mysql/mysql.conf.d/mysql.cnf
+# Allow ImageMagick 6 to read/write pdf files
+COPY config/imagemagick-policy.xml /etc/ImageMagick-6/policy.xml
+
+# Install required packages
+RUN add-apt-repository --yes ppa:ondrej/php && \
+    apt-get update && \
+    apt-get install --no-install-recommends -y -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" \
+    bash-completion cron imagemagick apache2 libapache2-mod-php* php*-xdebug php*-curl php*-zip php*-gd php*-intl php*-mysql php*-mbstring golang-go mysql-server ghostscript php-xdebug-all-dev && \
+    phpenmod zip curl gd intl mysqli pdo_mysql mbstring pdo xdebug && \
+    a2enmod alias authz_core autoindex deflate expires filter headers setenvif rewrite && \
+    # Configure all available PHP versions + xdebug
+    bash /config/php-setup.sh && \
+    # Enable autocompletion
+    echo "source /etc/profile.d/bash_completion.sh" >> /etc/bash.bashrc && \
+    # Install mailhog
+    go get github.com/mailhog/MailHog && \
+    curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/bin --filename=composer && \
+    # Cleanup image
+    apt-get remove -y --purge \
+    python3.8 python python3 python3.8-minimal gcc-7 build-essential apt-utils make linux-headers gcc g++ subversion mercurial emacs-bin-common emacsen-common vim-common vim && \
+    apt-get autoremove -y && \
+    apt-get clean && \
+    rm -Rf /var/lib/mysql/* /var/lib/apt/lists /usr/share/doc/ /config && \
+    # Create log file and set permissions, otherwise it will be reported as missing
+    touch /var/log/apache2/xdebug.log /var/log/cron.log && \
+    mkdir -p /var/run/mysqld /var/log/mysql && \
+    chown -R gitpod:gitpod /etc/apache2 /home/gitpod /var/log/apache2 /etc/mysql /var/run/mysqld /var/log/mysql /var/lib/mysql /var/lib/mysql-files /var/lib/mysql-keyring /var/lib/mysql-upgrade /var/log/cron.log && \
+    chmod a+x /etc/init.d/mysql /etc/init.d/mailhog /usr/bin/tdk && \
+    # Required to run cronjob as user "gitpod" to avoid permission issues
+    echo "* * * * * gitpod /usr/bin/tdk cron >> /var/log/cron.log" > /etc/cron.d/typo3
+
+# @todo Reset required?!
+# export APACHE_SERVER_NAME=$(gp url 8001 | sed -e s/https:\\/\\/// | sed -e s/\\///)

.gitpod/docker/build.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+#--no-cache
+DOCKER_BUILDKIT=1 docker build --no-cache --progress=plain . -f Dockerfile -t ochorocho/gitpod-tdk:latest && docker run --rm -it -v `pwd`/test.sh:/tmp/test.sh --entrypoint "bash" ochorocho/gitpod-tdk:latest /tmp/test.sh
+docker images | grep ochorocho/gitpod-tdk
+# docker push ochorocho/gitpod-tdk:latest

.gitpod/docker/config/apache.conf

@@ -0,0 +1,38 @@
+# Apache httpd v2.4 minimal configuration
+# see https://wiki.apache.org/httpd/Minimal_Config for documentation
+
+ServerRoot ${GITPOD_REPO_ROOT}
+
+PidFile ${APACHE_PID_FILE}
+User ${APACHE_RUN_USER}
+Group ${APACHE_RUN_GROUP}
+
+# Modules as installed/activated via apt-get
+IncludeOptional /etc/apache2/mods-enabled/*.load
+IncludeOptional /etc/apache2/mods-enabled/*.conf
+
+# Configure hostname and port for server
+ServerName ${APACHE_SERVER_NAME}
+Listen *:8001
+
+# Configure Logging
+LogFormat "%h %l %u %t \"%r\" %>s %b" common
+CustomLog ${APACHE_LOG_DIR}/access.log common
+ErrorLog ${APACHE_LOG_DIR}/error.log
+
+# Never change this block
+<Directory />
+    AllowOverride None
+    Require all denied
+</Directory>
+
+# Direcrory and files to be served
+DirectoryIndex index.html index.htm index.php
+DocumentRoot "${GITPOD_REPO_ROOT}/${APACHE_DOCROOT_IN_REPO}"
+<Directory "${GITPOD_REPO_ROOT}/${APACHE_DOCROOT_IN_REPO}">
+    AllowOverride all
+    Require all granted
+</Directory>
+
+# Include conf installed via apt-get
+IncludeOptional /etc/apache2/conf-enabled/*.conf

.gitpod/docker/config/envvars.txt

@@ -0,0 +1,10 @@
+export APACHE_RUN_USER="gitpod"
+export APACHE_RUN_GROUP="gitpod"
+export APACHE_RUN_DIR=/var/run/apache2
+export APACHE_PID_FILE="$APACHE_RUN_DIR/apache.pid"
+export APACHE_LOCK_DIR=/var/lock/apache2
+export APACHE_DOCROOT_IN_REPO=public
+export APACHE_SERVER_NAME=localhost
+export APACHE_LOG_DIR=/var/log/apache2
+export TYPO3_CONTEXT=Development
+export GITPOD_REPO_ROOT=/workspace/tdk

.gitpod/docker/config/imagemagick-policy.xml

@@ -0,0 +1,97 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE policymap [
+        <!ELEMENT policymap (policy)+>
+        <!ATTLIST policymap xmlns CDATA #FIXED ''>
+        <!ELEMENT policy EMPTY>
+        <!ATTLIST policy xmlns CDATA #FIXED '' domain NMTOKEN #REQUIRED
+                name NMTOKEN #IMPLIED pattern CDATA #IMPLIED rights NMTOKEN #IMPLIED
+                stealth NMTOKEN #IMPLIED value CDATA #IMPLIED>
+        ]>
+<!--
+  Configure ImageMagick policies.
+
+  Domains include system, delegate, coder, filter, path, or resource.
+
+  Rights include none, read, write, execute and all.  Use | to combine them,
+  for example: "read | write" to permit read from, or write to, a path.
+
+  Use a glob expression as a pattern.
+
+  Suppose we do not want users to process MPEG video images:
+
+    <policy domain="delegate" rights="none" pattern="mpeg:decode" />
+
+  Here we do not want users reading images from HTTP:
+
+    <policy domain="coder" rights="none" pattern="HTTP" />
+
+  The /repository file system is restricted to read only.  We use a glob
+  expression to match all paths that start with /repository:
+
+    <policy domain="path" rights="read" pattern="/repository/*" />
+
+  Lets prevent users from executing any image filters:
+
+    <policy domain="filter" rights="none" pattern="*" />
+
+  Any large image is cached to disk rather than memory:
+
+    <policy domain="resource" name="area" value="1GP"/>
+
+  Define arguments for the memory, map, area, width, height and disk resources
+  with SI prefixes (.e.g 100MB).  In addition, resource policies are maximums
+  for each instance of ImageMagick (e.g. policy memory limit 1GB, -limit 2GB
+  exceeds policy maximum so memory limit is 1GB).
+
+  Rules are processed in order.  Here we want to restrict ImageMagick to only
+  read or write a small subset of proven web-safe image types:
+
+    <policy domain="delegate" rights="none" pattern="*" />
+    <policy domain="filter" rights="none" pattern="*" />
+    <policy domain="coder" rights="none" pattern="*" />
+    <policy domain="coder" rights="read|write" pattern="{GIF,JPEG,PNG,WEBP}" />
+-->
+<policymap>
+    <!-- <policy domain="system" name="shred" value="2"/> -->
+    <!-- <policy domain="system" name="precision" value="6"/> -->
+    <!-- <policy domain="system" name="memory-map" value="anonymous"/> -->
+    <!-- <policy domain="system" name="max-memory-request" value="256MiB"/> -->
+    <!-- <policy domain="resource" name="temporary-path" value="/tmp"/> -->
+    <policy domain="resource" name="memory" value="256MiB"/>
+    <policy domain="resource" name="map" value="512MiB"/>
+    <policy domain="resource" name="width" value="16KP"/>
+    <policy domain="resource" name="height" value="16KP"/>
+    <!-- <policy domain="resource" name="list-length" value="128"/> -->
+    <policy domain="resource" name="area" value="128MB"/>
+    <policy domain="resource" name="disk" value="1GiB"/>
+    <!-- <policy domain="resource" name="file" value="768"/> -->
+    <!-- <policy domain="resource" name="thread" value="4"/> -->
+    <!-- <policy domain="resource" name="throttle" value="0"/> -->
+    <!-- <policy domain="resource" name="time" value="3600"/> -->
+    <!-- <policy domain="coder" rights="none" pattern="MVG" /> -->
+    <!-- <policy domain="module" rights="none" pattern="{PS,PDF,XPS}" /> -->
+    <!-- <policy domain="delegate" rights="none" pattern="HTTPS" /> -->
+    <!-- <policy domain="path" rights="none" pattern="@*" /> -->
+    <!-- <policy domain="cache" name="memory-map" value="anonymous"/> -->
+    <!-- <policy domain="cache" name="synchronize" value="True"/> -->
+    <!-- <policy domain="cache" name="shared-secret" value="passphrase" stealth="true"/> -->
+    <!-- <policy domain="system" name="pixel-cache-memory" value="anonymous"/> -->
+    <!-- <policy domain="system" name="shred" value="2"/> -->
+    <!-- <policy domain="system" name="precision" value="6"/> -->
+    <!-- not needed due to the need to use explicitly by mvg: -->
+    <!-- <policy domain="delegate" rights="none" pattern="MVG" /> -->
+    <!-- use curl -->
+    <policy domain="delegate" rights="none" pattern="URL" />
+    <policy domain="delegate" rights="none" pattern="HTTPS" />
+    <policy domain="delegate" rights="none" pattern="HTTP" />
+    <!-- in order to avoid to get image with password text -->
+    <policy domain="path" rights="none" pattern="@*"/>
+    <!-- disable ghostscript format types -->
+    <policy domain="coder" rights="none" pattern="PS" />
+    <policy domain="coder" rights="none" pattern="PS2" />
+    <policy domain="coder" rights="none" pattern="PS3" />
+    <policy domain="coder" rights="none" pattern="EPS" />
+    <!--policy domain="coder" rights="none" pattern="PDF" /-->
+    <policy domain="coder" rights="write | read" pattern="PDF" />
+    <policy domain="coder" rights="none" pattern="XPS" />
+</policymap>

.gitpod/docker/config/mysql-client.cnf

@@ -0,0 +1,10 @@
+[client]
+host     = localhost
+user     = root
+password =
+socket   = /var/run/mysqld/mysqld.sock
+[mysql_upgrade]
+host     = localhost
+user     = root
+password =
+socket   = /var/run/mysqld/mysqld.sock

.gitpod/docker/config/mysql.cnf

@@ -0,0 +1,26 @@
+[mysqld_safe]
+socket		= /var/run/mysqld/mysqld.sock
+nice		= 0
+
+[mysqld]
+user		= gitpod
+pid-file	= /var/run/mysqld/mysqld.pid
+socket		= /var/run/mysqld/mysqld.sock
+port		= 3306
+basedir		= /usr
+datadir		= /workspace/mysql
+tmpdir		= /tmp
+lc-messages-dir	= /usr/share/mysql
+skip-external-locking
+bind-address		= 127.0.0.1
+
+key_buffer_size		= 16M
+max_allowed_packet	= 16M
+thread_stack		= 192K
+thread_cache_size   = 8
+
+myisam-recover-options  = BACKUP
+
+general_log_file        = /var/log/mysql/mysql.log
+general_log             = 1
+log_error               = /var/log/mysql/error.log

.gitpod/docker/config/php-setup.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+# Configure all php versions
+# * 40-php.ini
+# * 20-xdebug.ini
+
+ALL_VERSIONS=$(ls /etc/php)
+for version in $ALL_VERSIONS
+do
+    cat /config/xdebug.ini | sudo tee "/etc/php/${version}/apache2/conf.d/20-xdebug.ini" > /dev/null
+    echo -e "memory_limit=256M\nmax_execution_time=240\nmax_input_vars=1500" | sudo tee -a "/etc/php/${version}/cli/conf.d/40-php.ini" | sudo tee -a  "/etc/php/${version}/apache2/conf.d/40-php.ini"
+done

.gitpod/docker/config/xdebug.ini

@@ -0,0 +1,10 @@
+zend_extension=xdebug.so
+
+xdebug.mode = debug
+xdebug.client_host = 0.0.0.0
+xdebug.client_port = 9003
+xdebug.start_with_request=yes
+xdebug.log="/var/log/apache2/xdebug.log"
+xdebug.idekey = VSCODE
+xdebug.discover_client_host=false
+xdebug.max_nesting_level=500