Updating to Version 3.14.2+180807

- context needed to change

.gitignore

@@ -2,3 +2,4 @@
 .\#*
 
 .venv/
+container-structure-test

.travis.yml

@@ -2,9 +2,10 @@ sudo: required
 language: bash
 services:
   - docker
+
 matrix:
   include:
-    - env: TEST=limesurvey-apache
-      script: docker build -t martialblog/limesurvey-apache -f apache/Dockerfile .
-    - env: TEST=limesurvey-fpm
-      script: docker build -t martialblog/limesurvey-fpm -f fpm/Dockerfile .
+    - env: TAG=martialblog/limesurvey-apache
+      script: cd apache; docker build -q -t $TAG . && cd ..; ./tests/run.sh $TAG
+    - env: TAG=martialblog/limesurvey-fpm
+      script: cd fpm; docker build -q -t $TAG . && cd ..; ./tests/run.sh $TAG

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing
+
+Every Pull Request is welcome.
+
+## Upgrading the Version
+
+To upgrade the LimeSurvey Version the ARG variable needs to be changed.
+
+```bash
+$ grep Agrep ARG apache/Dockerfile
+ARG version='3.7.0+180418'
+```
+
+Since this is a reoccuring and boring task, a script is provided.
+
+```bash
+# Dependencies
+python3 -m venv .venv
+source .venv/bin/activate
+pip3 install -r requirements.txt
+
+# Upgrades to latest Limesurvey version
+./upgrade.py
+```
+
+## Testing
+
+In order to make sure the image works as promised, some tests are provided:
+
+```bash
+./tests/run.sh
+```
+
+For further information:  https://github.com/GoogleContainerTools/container-structure-test

README.md

@@ -11,7 +11,7 @@ The apache image comes with an Apache Webserver and PHP installed.
 
 # Apache Configuration
 
-To change to Apache Webserver configuration mount a Volume into the Container at:
+To change to Apache Webserver configuration, mount a Volume into the Container at:
 
  - /etc/apache2/sites-available/000-default.conf
 
@@ -19,7 +19,7 @@ See the example configuration provided.
 
 # Using the fpm image
 
-To use the fpm image you need an additional web server that can proxy http-request to the fpm-port of the container.
+To use the fpm image, you need an additional web server that can proxy http-request to the fpm-port of the container. See *docker-compose.fpm.yml* for example
 
 # Using an external database
 
@@ -27,15 +27,39 @@ LimeSurvey requires an external database (MySQL, PostgreSQL) to run. See *docker
 
 # Persistent data
 
-To preserve the uploaded files assign the upload folder into a volume. See *docker-compose.yml* for details.
+To preserve the uploaded files assign the upload folder into a volume. See *docker-compose.yml* for example.
+
+Path: */var/www/html/upload/*
 
 # LimeSurvey Configuration
 
-To change to LimeSurvey configuration simply mount a Volume into the Container at:
+The entrypoint will create a new config.php if none is provided and run the LimeSurvey command line interface for installation.
+
+To change to LimeSurvey configuration, you can mount a Volume into the Container at:
 
  - /my-data/config.php:/var/www/html/application/config/config.php
 
-**Hint**: If this configuration is present, the LimeSurvey Installer will not run.
+**Hint**: If this configuration is present before the installation, the LimeSurvey Web Installer will not run automatically.
+
+# Environment Variables
+
+| Parameter       | Description                               |
+| ---------       | -----------                               |
+| DB_TYPE         | Database Type to use. mysql or pgsql      |
+| DB_HOST         | Database server hostname                  |
+| DB_PORT         | Database server port                      |
+| DB_NAME         | Database name                             |
+| DB_TABLE_PREFIX | Database table prefix                     |
+| DB_USERNAME     | Database user                             |
+| DB_PASSWORD     | Database user's password                  |
+| ADMIN_USER      | LimeSurvey Admin User                     |
+| ADMIN_NAME      | LimeSurvey Admin Username                 |
+| ADMIN_EMAIL     | LimeSurvey Admin Email                    |
+| ADMIN_PASSWORD  | LimeSurvey Admin Password                 |
+| PUBLIC_URL      | Public URL for public scripts             |
+| URL_FORMAT      | URL Format. path or get                   |
+
+For further details on the settings see: https://manual.limesurvey.org/Optional_settings#Advanced_Path_Settings
 
 # References
 

apache/Dockerfile

@@ -1,6 +1,6 @@
 FROM php:7.2-apache
 LABEL maintainer="markus@martialblog.de"
-ARG version='3.6.3+180416'
+ARG version='3.14.2+180807'
 
 # Install OS dependencies
 RUN apt-get update && \
@@ -12,6 +12,7 @@ RUN apt-get update && \
     libkrb5-dev \
     libpng-dev \
     libpq-dev \
+    netcat \
     && apt-get autoclean; apt-get autoremove && \
     rm -rf /var/lib/apt/lists/*
 
@@ -38,3 +39,7 @@ ADD "https://github.com/LimeSurvey/LimeSurvey/archive/${version}.tar.gz" /tmp
 RUN tar xzvf "/tmp/${version}.tar.gz" --strip-components=1 -C /var/www/html/ && \
     rm "/tmp/${version}.tar.gz" && \
     chown -R www-data:www-data /var/www/html
+
+COPY entrypoint.sh entrypoint.sh
+ENTRYPOINT ["/var/www/html/entrypoint.sh"]
+CMD ["apache2-foreground"]

apache/entrypoint.sh

@@ -0,0 +1,91 @@
+#!/bin/bash
+# Entrypoint for Docker Container
+
+
+DB_TYPE=${DB_TYPE:-'mysql'}
+DB_HOST=${DB_HOST:-'mysql'}
+DB_PORT=${DB_PORT:-'3306'}
+DB_NAME=${DB_NAME:-'limesurvey'}
+DB_TABLE_PREFIX=${DB_TABLE_PREFIX:-'lime_'}
+DB_USERNAME=${DB_USERNAME:-'limesurvey'}
+DB_PASSWORD=${DB_PASSWORD:-}
+
+ADMIN_USER=${ADMIN_USER:-'admin'}
+ADMIN_NAME=${ADMIN_NAME:-'admin'}
+ADMIN_EMAIL=${ADMIN_EMAIL:-'foobar@example.com'}
+ADMIN_PASSWORD=${ADMIN_PASSWORD:-'-'}
+
+PUBLIC_URL=${PUBLIC_URL:-}
+URL_FORMAT=${URL_FORMAT:-'path'}
+
+
+# Check if database is available
+until nc -z -v -w30 $DB_HOST $DB_PORT
+do
+    echo "Info: Waiting for database connection..."
+    sleep 5
+done
+
+
+# Check if already provisioned
+if [ -f application/config/config.php ]; then
+    echo 'Info: config.php already provisioned'
+else
+    echo 'Info: Generating config.php'
+
+    if [ "$DB_TYPE" = 'mysql' ]; then
+        echo 'Info: Using MySQL configuration'
+        DB_CHARSET=${DB_CHARSET:-'utf8mb4'}
+        cp application/config/config-sample-mysql.php application/config/config.php
+    fi
+
+    if [ "$DB_TYPE" = 'pgsql' ]; then
+        echo 'Info: Using PostgreSQL configuration'
+        DB_CHARSET=${DB_CHARSET:-'utf8'}
+        cp application/config/config-sample-pgsql.php application/config/config.php
+    fi
+
+    # Set Database config
+    sed -i "s#\('connectionString' => \).*,\$#\\1'${DB_TYPE}:host=${DB_HOST};port=${DB_PORT};dbname=${DB_NAME};',#g" application/config/config.php
+    sed -i "s#\('username' => \).*,\$#\\1'${DB_USERNAME}',#g" application/config/config.php
+    sed -i "s#\('password' => \).*,\$#\\1'${DB_PASSWORD}',#g" application/config/config.php
+    sed -i "s#\('charset' => \).*,\$#\\1'${DB_CHARSET}',#g" application/config/config.php
+    sed -i "s#\('tablePrefix' => \).*,\$#\\1'${DB_TABLE_PREFIX}',#g" application/config/config.php
+
+    # Set URL config
+    sed -i "s#\('urlFormat' => \).*,\$#\\1'${URL_FORMAT}',#g" application/config/config.php
+
+    # Set Public URL
+    if [ -z "$PUBLIC_URL" ]; then
+        echo 'Info: Setting PublicURL'
+        sed -i "s#\('debug'=>0,\)\$#'publicurl'=>'${PUBLIC_URL}',\n\t\t\\1 #g" application/config/config.php
+    fi
+fi
+
+
+# Check if LimeSurvey database is provisioned
+echo 'Info: Check if database already provisioned. Nevermind the Stack trace.'
+php application/commands/console.php updatedb
+
+
+if [ $? -eq 0 ]; then
+    echo 'Info: Database already provisioned'
+else
+    # Check if DB_PASSWORD is set
+    if [ -z "$DB_PASSWORD" ]; then
+        echo >&2 'Error: Missing DB_PASSWORD'
+        exit 1
+    fi
+
+    # Check if DB_PASSWORD is set
+    if [ -z "$ADMIN_PASSWORD" ]; then
+        echo >&2 'Error: Missing ADMIN_PASSWORD'
+        exit 1
+    fi
+
+    echo ''
+    echo 'Running console.php install'
+    php application/commands/console.php install $ADMIN_USER $ADMIN_PASSWORD $ADMIN_NAME $ADMIN_EMAIL
+fi
+
+exec "$@"

docker-compose.fpm.yml

@@ -0,0 +1,35 @@
+version: "3.0"
+services:
+  limesurvey:
+    build:
+      context: fpm/
+      dockerfile: Dockerfile
+    volumes:
+      - /tmp/upload/:/var/www/html/upload/
+      - lime:/var/www/html
+    links:
+      - lime-db
+    depends_on:
+      - lime-db
+    environment:
+      - "DB_HOST=docker-limesurvey_lime-db_1"
+      - "DB_PASSWORD=secret"
+      - "ADMIN_PASSWORD=foobar"
+  lime-web:
+    image: nginx
+    links:
+      - limesurvey
+    ports:
+      - "8080:80"
+    volumes:
+      - ./examples/nginx.conf:/etc/nginx/nginx.conf:ro
+      - lime:/var/www/html
+  lime-db:
+    image: mysql:5.7
+    environment:
+      - "MYSQL_USER=limesurvey"
+      - "MYSQL_DATABASE=limesurvey"
+      - "MYSQL_PASSWORD=secret"
+      - "MYSQL_ROOT_PASSWORD=secret"
+volumes:
+  lime:

docker-compose.pgsql.yml

@@ -0,0 +1,26 @@
+version: "3.0"
+services:
+  limesurvey:
+    build:
+      context: apache/
+      dockerfile: Dockerfile
+    volumes:
+      - /tmp/upload/:/var/www/html/upload/
+    links:
+      - lime-db
+    depends_on:
+      - lime-db
+    ports:
+      - "8080:80"
+    environment:
+      - "DB_TYPE=pgsql"
+      - "DB_PORT=5432"
+      - "DB_HOST=docker-limesurvey_lime-db_1"
+      - "DB_PASSWORD=secret"
+      - "ADMIN_PASSWORD=foobar"
+  lime-db:
+    image: postgres:10
+    environment:
+      - "POSTGRES_USER=limesurvey"
+      - "POSTGRES_DB=limesurvey"
+      - "POSTGRES_PASSWORD=secret"

docker-compose.yml

@@ -2,8 +2,8 @@ version: "3.0"
 services:
   limesurvey:
     build:
-      context: .
-      dockerfile: apache/Dockerfile
+      context: apache/
+      dockerfile: Dockerfile
     volumes:
       - /tmp/upload/:/var/www/html/upload/
     links:
@@ -12,6 +12,10 @@ services:
       - lime-db
     ports:
       - "8080:80"
+    environment:
+      - "DB_HOST=docker-limesurvey_lime-db_1"
+      - "DB_PASSWORD=secret"
+      - "ADMIN_PASSWORD=foobar"
   lime-db:
     image: mysql:5.7
     environment:

examples/nginx.conf

@@ -0,0 +1,37 @@
+worker_processes 1;
+
+error_log  /var/log/nginx/error.log warn;
+pid        /var/run/nginx.pid;
+
+events {
+    worker_connections  1024;
+}
+
+http {
+    server {
+        listen 80;
+        index index.php;
+        set $host_path "/var/www/html";
+        root /var/www/html;
+        server_name localhost;
+        charset utf-8;
+        location / {
+            try_files $uri /index.php?$args;
+        }
+        location ~ ^/(protected|framework|themes/\w+/views) {
+            deny  all;
+        }
+        location ~ \.(js|css|png|jpg|gif|swf|ico|pdf|mov|fla|zip|rar)$ {
+            try_files $uri =404;
+        }
+        location ~ \.php$ {
+            fastcgi_split_path_info  ^(.+\.php)(.*)$;
+            try_files $uri index.php;
+            include fastcgi_params;
+            fastcgi_index index.php;
+            fastcgi_pass  limesurvey:9000;
+            fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
+            fastcgi_param  SCRIPT_NAME      $fastcgi_script_name;
+        }
+    }
+}

fpm/Dockerfile

@@ -1,6 +1,6 @@
 FROM php:7.2-fpm
 LABEL maintainer="markus@martialblog.de"
-ARG version='3.6.3+180416'
+ARG version='3.14.2+180807'
 
 # Install OS dependencies
 RUN apt-get update && \
@@ -12,6 +12,7 @@ RUN apt-get update && \
     libkrb5-dev \
     libpng-dev \
     libpq-dev \
+    netcat \
     && apt-get autoclean; apt-get autoremove && \
     rm -rf /var/lib/apt/lists/*
 
@@ -38,3 +39,9 @@ ADD "https://github.com/LimeSurvey/LimeSurvey/archive/${version}.tar.gz" /tmp
 RUN tar xzvf "/tmp/${version}.tar.gz" --strip-components=1 -C /var/www/html/ && \
     rm "/tmp/${version}.tar.gz" && \
     chown -R www-data:www-data /var/www/html
+
+EXPOSE 9000
+
+COPY entrypoint.sh entrypoint.sh
+ENTRYPOINT ["/var/www/html/entrypoint.sh"]
+CMD ["php-fpm"]

fpm/entrypoint.sh

@@ -0,0 +1,91 @@
+#!/bin/bash
+# Entrypoint for Docker Container
+
+
+DB_TYPE=${DB_TYPE:-'mysql'}
+DB_HOST=${DB_HOST:-'mysql'}
+DB_PORT=${DB_PORT:-'3306'}
+DB_NAME=${DB_NAME:-'limesurvey'}
+DB_TABLE_PREFIX=${DB_TABLE_PREFIX:-'lime_'}
+DB_USERNAME=${DB_USERNAME:-'limesurvey'}
+DB_PASSWORD=${DB_PASSWORD:-}
+
+ADMIN_USER=${ADMIN_USER:-'admin'}
+ADMIN_NAME=${ADMIN_NAME:-'admin'}
+ADMIN_EMAIL=${ADMIN_EMAIL:-'foobar@example.com'}
+ADMIN_PASSWORD=${ADMIN_PASSWORD:-'-'}
+
+PUBLIC_URL=${PUBLIC_URL:-}
+URL_FORMAT=${URL_FORMAT:-'path'}
+
+
+# Check if database is available
+until nc -z -v -w30 $DB_HOST $DB_PORT
+do
+    echo "Info: Waiting for database connection..."
+    sleep 5
+done
+
+
+# Check if already provisioned
+if [ -f application/config/config.php ]; then
+    echo 'Info: config.php already provisioned'
+else
+    echo 'Info: Generating config.php'
+
+    if [ "$DB_TYPE" = 'mysql' ]; then
+        echo 'Info: Using MySQL configuration'
+        DB_CHARSET=${DB_CHARSET:-'utf8mb4'}
+        cp application/config/config-sample-mysql.php application/config/config.php
+    fi
+
+    if [ "$DB_TYPE" = 'pgsql' ]; then
+        echo 'Info: Using PostgreSQL configuration'
+        DB_CHARSET=${DB_CHARSET:-'utf8'}
+        cp application/config/config-sample-pgsql.php application/config/config.php
+    fi
+
+    # Set Database config
+    sed -i "s#\('connectionString' => \).*,\$#\\1'${DB_TYPE}:host=${DB_HOST};port=${DB_PORT};dbname=${DB_NAME};',#g" application/config/config.php
+    sed -i "s#\('username' => \).*,\$#\\1'${DB_USERNAME}',#g" application/config/config.php
+    sed -i "s#\('password' => \).*,\$#\\1'${DB_PASSWORD}',#g" application/config/config.php
+    sed -i "s#\('charset' => \).*,\$#\\1'${DB_CHARSET}',#g" application/config/config.php
+    sed -i "s#\('tablePrefix' => \).*,\$#\\1'${DB_TABLE_PREFIX}',#g" application/config/config.php
+
+    # Set URL config
+    sed -i "s#\('urlFormat' => \).*,\$#\\1'${URL_FORMAT}',#g" application/config/config.php
+
+    # Set Public URL
+    if [ -z "$PUBLIC_URL" ]; then
+        echo 'Info: Setting PublicURL'
+        sed -i "s#\('debug'=>0,\)\$#'publicurl'=>'${PUBLIC_URL}',\n\t\t\\1 #g" application/config/config.php
+    fi
+fi
+
+
+# Check if LimeSurvey database is provisioned
+echo 'Info: Check if database already provisioned. Nevermind the Stack trace.'
+php application/commands/console.php updatedb
+
+
+if [ $? -eq 0 ]; then
+    echo 'Info: Database already provisioned'
+else
+    # Check if DB_PASSWORD is set
+    if [ -z "$DB_PASSWORD" ]; then
+        echo >&2 'Error: Missing DB_PASSWORD'
+        exit 1
+    fi
+
+    # Check if DB_PASSWORD is set
+    if [ -z "$ADMIN_PASSWORD" ]; then
+        echo >&2 'Error: Missing ADMIN_PASSWORD'
+        exit 1
+    fi
+
+    echo ''
+    echo 'Running console.php install'
+    php application/commands/console.php install $ADMIN_USER $ADMIN_PASSWORD $ADMIN_NAME $ADMIN_EMAIL
+fi
+
+exec "$@"

requirements.txt

@@ -0,0 +1 @@
+feedparser==5.2.1

tests/image_tests.yaml

@@ -0,0 +1,84 @@
+schemaVersion: "2.0.0"
+
+globalEnvVars:
+  - key: "PATH"
+    value: "/env/bin:$PATH"
+
+fileContentTests:
+  - name: 'Limesurvey admin file content'
+    path: '/var/www/html/admin/index.php'
+    expectedContents: ['LimeSurvey']
+  - name: 'Entrypoint file content'
+    path: '/var/www/html/entrypoint.sh'
+    expectedContents: ['console.php', 'ADMIN_USER']
+
+fileExistenceTests:
+  - name: 'Limesurvey files'
+    path: '/var/www/html/index.php'
+    shouldExist: true
+    permissions: '-rw-rw-r--'
+  - name: 'Limesurvey admin files'
+    path: '/var/www/html/admin/index.php'
+    shouldExist: true
+    permissions: '-rw-rw-r--'
+  - name: 'Ldap syslink'
+    path: '/usr/lib/x86_64-linux-gnu/libldap.so'
+    shouldExist: true
+  - name:  "Dependencies - PHP - gd"
+    path: '/usr/local/etc/php/conf.d/docker-php-ext-gd.ini'
+    shouldExist: true
+  - name:  "Dependencies - PHP - imap"
+    path: '/usr/local/etc/php/conf.d/docker-php-ext-imap.ini'
+    shouldExist: true
+  - name:  "Dependencies - PHP - ldap"
+    path: '/usr/local/etc/php/conf.d/docker-php-ext-ldap.ini'
+    shouldExist: true
+  - name:  "Dependencies - PHP - pgsql"
+    path: '/usr/local/etc/php/conf.d/docker-php-ext-pgsql.ini'
+    shouldExist: true
+  - name:  "Dependencies - PHP - zip"
+    path: '/usr/local/etc/php/conf.d/docker-php-ext-zip.ini'
+    shouldExist: true
+  - name:  "Dependencies - PHP - sodium"
+    path: '/usr/local/etc/php/conf.d/docker-php-ext-sodium.ini'
+    shouldExist: true
+  - name:  "Dependencies - PHP - pdo_mysql"
+    path: '/usr/local/etc/php/conf.d/docker-php-ext-pdo_mysql.ini'
+    shouldExist: true
+  - name:  "Dependencies - PHP - pdo_pgsql"
+    path: '/usr/local/etc/php/conf.d/docker-php-ext-pdo_pgsql.ini'
+    shouldExist: true
+
+commandTests:
+  - name:  "Dependencies - netcat"
+    command: "dpkg"
+    args: ["-l", "netcat"]
+    exitCode: 0
+  - name:  "Dependencies - libldap2-dev"
+    command: "dpkg"
+    args: ["-l", "libldap2-dev"]
+    exitCode: 0
+  - name:  "Dependencies - zlib1g-dev"
+    command: "dpkg"
+    args: ["-l", "zlib1g-dev"]
+    exitCode: 0
+  - name:  "Dependencies - libc-client-dev"
+    command: "dpkg"
+    args: ["-l", "libc-client-dev"]
+    exitCode: 0
+  - name:  "Dependencies - libkrb5-dev"
+    command: "dpkg"
+    args: ["-l", "libkrb5-dev"]
+    exitCode: 0
+  - name:  "Dependencies - libpng-dev"
+    command: "dpkg"
+    args: ["-l", "libpng-dev"]
+    exitCode: 0
+  - name:  "Dependencies - libpq-dev"
+    command: "dpkg"
+    args: ["-l", "libpq-dev"]
+    exitCode: 0
+  - name:  "Dependencies - PHP Modules"
+    command: "php"
+    args: ["-m"]
+    expectedOutput: ["ldap", "zip", "pdo_mysql", "pdo_sqlite", "gd", "mbstring", "PDO", "imap"]

tests/run.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+IMAGE=$1
+
+if [ ! -f container-structure-test ]; then
+   curl -LO https://storage.googleapis.com/container-structure-test/latest/container-structure-test-linux-amd64
+   mv container-structure-test-linux-amd64 container-structure-test
+   chmod +x container-structure-test
+fi
+
+./container-structure-test test --image $IMAGE --config tests/image_tests.yaml

upgrade.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 
 
+import argparse
 import feedparser
 import sys
 import subprocess
@@ -17,15 +18,25 @@ docker_feed = feedparser.parse(docker_feed_url)
 limesv_current_release = limesv_feed.entries[0].title_detail.value
 docker_current_release = docker_feed.entries[0].title_detail.value
 
+argumentparser = argparse.ArgumentParser(description='Updates the LimeSurvey Version in the Dockerfiles')
+argumentparser.add_argument('--noop', dest='noop', action="store_true", required=False, help="Don't push just commit")
+argumentparser.add_argument('--check', dest='check', action="store_true", required=False, help="Only check if there's a new version available")
+
+cmdargs = argumentparser.parse_args()
+
 if limesv_current_release == docker_current_release:
     print('Nothing to do.')
     sys.exit(0)
 
-print('New Version {} available. Upgrading...'.format(limesv_current_release))
-commit_message = 'Update to Version {}'.format(limesv_current_release)
+print('New Version {} available.'.format(limesv_current_release))
+
+if cmdargs.check:
+    sys.exit(0)
+
+commit_message = 'Updating to Version {}'.format(limesv_current_release)
 
 # Dockerfiles
-regexp = 's/[0-9]\.[0-9]\.[0-9]+[0-9]*/{new_version}/'.format(new_version=limesv_current_release)
+regexp = 's/[0-9]+\.[0-9]+\.[0-9]+[0-9]*/{new_version}/'.format(new_version=limesv_current_release)
 subprocess.call(['sed', '-i', '-e',  regexp, dockerfile_apache])
 subprocess.call(['sed', '-i', '-e',  regexp, dockerfile_fpm])
 print('> Updated Dockerfiles')
@@ -38,6 +49,9 @@ subprocess.call(['git', 'commit',  '-m', commit_message])
 subprocess.call(['git', 'tag', limesv_current_release])
 print('> Created new Commit and Tag')
 
+if cmdargs.noop:
+    sys.exit(0)
+
 # Git Push
 # subprocess.call(['git', 'push', 'origin', limesv_current_release])
 subprocess.call(['git', 'push'])