Merge pull request #374 from MyIgel/master

Refactored .gitlab-ci.yml, added deploy to production

.gitlab-ci.yml

@@ -12,28 +12,35 @@ variables:
   MYSQL_USER: engel
   MYSQL_PASSWORD: engelsystem
   MYSQL_HOST: mariadb
-  COMPOSER_HOME: .composer
   MYSQL_RANDOM_ROOT_PASSWORD: "yes"
+  COMPOSER_HOME: .composer
 
 before_script:
   # Fix permissions after gitlab messed them up
-  - find . -type f -exec chmod 644 {} \;
+  - &before_fix_permissions |-
-  - find . -type d -exec chmod 755 {} \;
+    find . -type f -exec chmod 644 {} \;
+    find . -type d -exec chmod 755 {} \;
   # Install required Packages
-  - apt update -yqq
+  - &before_install_packages |-
-  - apt install -yqq git unzip mariadb-client
+    apt update -yqq
-  - docker-php-ext-install pdo pdo_mysql gettext
+    apt install -yqq git unzip
+    docker-php-ext-install pdo pdo_mysql gettext
   # Install xdebug
-  - pecl install xdebug
+  - &before_install_xdebug |-
-  - docker-php-ext-enable xdebug
+    pecl install xdebug
+    docker-php-ext-enable xdebug
   # MySQL DB
-  - mysql -h "$MYSQL_HOST" -u "$MYSQL_USER" -p"$MYSQL_PASSWORD" "$MYSQL_DATABASE" < db/install.sql
+  - &before_setup_mysql |-
-  - mysql -h "$MYSQL_HOST" -u "$MYSQL_USER" -p"$MYSQL_PASSWORD" "$MYSQL_DATABASE" < db/update.sql
+    apt install -yqq mariadb-client
+    mysql -h "$MYSQL_HOST" -u "$MYSQL_USER" -p"$MYSQL_PASSWORD" "$MYSQL_DATABASE" < db/install.sql
+    mysql -h "$MYSQL_HOST" -u "$MYSQL_USER" -p"$MYSQL_PASSWORD" "$MYSQL_DATABASE" < db/update.sql
   # Install Composer
-  - curl -sS https://getcomposer.org/installer | php -- --no-ansi --install-dir /usr/local/bin/ --filename composer
+  - &before_install_composer |-
-  - /usr/local/bin/composer --no-ansi install
+    curl -sS https://getcomposer.org/installer | php -- --no-ansi --install-dir /usr/local/bin/ --filename composer
+    /usr/local/bin/composer --no-ansi install
 
 .test_template: &test_definition
+  stage: test
   artifacts:
     name: "${CI_JOB_NAME}_${CI_PROJECT_ID}_${PHP_VERSION}"
     expire_in: 1 week
@@ -43,49 +50,66 @@ before_script:
   script: vendor/bin/phpunit --colors=never --coverage-text --coverage-html ./coverage/
 
 test:7.0:
-  image: php:7.0
   <<: *test_definition
+  image: php:7.0
 
 test:7.1:
-  image: php:7.1
   <<: *test_definition
+  image: php:7.1
 
-deploy_staging:
+.deploy_template: &deploy_definition
+  services: []
   stage: deploy
   only:
   - master
+  before_script:
+    - *before_fix_permissions
+    - *before_install_packages
+    - *before_install_composer
+
+.deploy_template_script:
+  # Configure SSH
+  - &deployment_ssh |-
+    mkdir -p ~/.ssh
+    echo "$SSH_PRIVATE_KEY" | sed -e 's/\r//g' > ~/.ssh/id_ed25519
+    chmod 600 ~/.ssh/id_ed25519
+
+  # Install project and dependencies
+  - &deployment_dependencies |-
+    chmod +x ./deploy.sh
+    apt update && apt install -yqq rsync openssh-client
+    /usr/local/bin/composer --no-ansi install --no-dev
+    /usr/local/bin/composer --no-ansi dump-autoload --optimize
+
+deploy_staging:
+  <<: *deploy_definition
+  environment:
+    name: staging
   script:
+    # Check if deployment variables where set
     - |-
-      if [ -z "${SSH_PRIVATE_KEY}" ] || [ -z "${REMOTE}" ] || [ -z "${REMOTE_PATH}" ]; then
+      if [ -z "${SSH_PRIVATE_KEY}" ] || [ -z "${STAGING_REMOTE}" ] || [ -z "${STAGING_REMOTE_PATH}" ]; then
         echo "Skipping deployment";
         exit
       fi
-    - mkdir -p ~/.ssh
+    - *deployment_ssh
-    - echo "$SSH_PRIVATE_KEY" | sed -e 's/\r//g' > ~/.ssh/id_ed25519
+    - *deployment_dependencies
-    - chmod 600 ~/.ssh/id_ed25519
+    # Deploy to server
-    - apt update && apt install -yqq rsync openssh-client
+    - ./deploy.sh -r "${STAGING_REMOTE}" -p "${STAGING_REMOTE_PATH}" -i "${CI_JOB_ID}-${CI_COMMIT_SHA}"
-    - /usr/local/bin/composer --no-ansi install --no-dev
-    - /usr/local/bin/composer --no-ansi dump-autoload --optimize
-    - echo "syncing ${PWD}/ to ${REMOTE}:${REMOTE_PATH}/${CI_JOB_ID}-${CI_COMMIT_SHA}/"
-    - |-
-      rsync -vAax --exclude '.git*' --exclude .composer/ \
-        -e "ssh -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no" \
-        ./ "${REMOTE}:${REMOTE_PATH}/${CI_JOB_ID}-${CI_COMMIT_SHA}/"
-    - |-
-      ssh -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no "${REMOTE}" "
-        set -e
-
-        if [[ -f \"${REMOTE_PATH}/current/config/config.php\" ]]; then
-          echo \"Config backup\"
-          cp \"${REMOTE_PATH}/current/config/config.php\" config.php
-        fi
 
-        echo \"Changing symlink\"
+deploy_production:
-        unlink \"${REMOTE_PATH}/current\"
+  <<: *deploy_definition
-        ln -s \"${REMOTE_PATH}/${CI_JOB_ID}-${CI_COMMIT_SHA}\" \"${REMOTE_PATH}/current\"
+  environment:
-
+    name: production
-        if [[ -f config.php ]]; then
+  when: manual
-          echo \"Restoring config\"
+  script:
-          cp  config.php \"${REMOTE_PATH}/current/config/config.php\"
+    # Check if deployment variables where set
+    - |-
+      if [ -z "${SSH_PRIVATE_KEY}" ] || [ -z "${PRODUCTION_REMOTE}" ] || [ -z "${PRODUCTION_REMOTE_PATH}" ]; then
+        echo "Skipping deployment";
+        exit
       fi
-      "
+    - *deployment_ssh
+    - *deployment_dependencies
+    # Deploy to server
+    - ./deploy.sh -r "${PRODUCTION_REMOTE}" -p "${PRODUCTION_REMOTE_PATH}" -i "${CI_JOB_ID}-${CI_COMMIT_SHA}"

README.md

@@ -5,19 +5,30 @@
 
 Please visit https://engelsystem.de for a feature list.
 
+To report bugs use [engelsystem/issues](https://github.com/engelsystem/engelsystem/issues)
+
 ## Installation
 
 ### Requirements:
  * PHP >= 7.0.0
- * MySQL-Server >= 5.5.x
+ * MySQL-Server >= 5.5 or MariaDB-Server >= 5.5 
  * Webserver, i.e. lighttpd, nginx, or Apache
 
 ### Directions:
  * Clone the master branch: `git clone https://github.com/engelsystem/engelsystem.git`
  * Install [Composer](https://getcomposer.org/download/)
- * Install project dependencies: `composer install`
+ * Install project dependencies:
- * Webserver must have write access to the 'import' directory and read access for all other directories
+     ```bash
- * Webserver must point to the public directory.
+     composer install
+     ```
+    On production systems it is recommended to use
+    ```bash
+    composer install --no-dev
+    composerdump-autoload --optimize
+    ```
+    to install the engelsystem
+ * The webserver must have write access to the 'import' directory and read access for all other directories
+ * The webserver must point to the public directory.
 
  * Recommended: Directory Listing should be disabled.
  * There must a be MySQL database created with a user who has full rights to that database.
@@ -31,12 +42,41 @@ Engelsystem can now be used.
  * Make sure the config allows for sessions.
  * Both Apache and Nginx allow for different VirtualHost configurations.
 
-Report Bugs: https://github.com/engelsystem/engelsystem/issues
-
 ## Development
 Since the engelsystem is open source, you can help to improve the system. We really love to get pull requests containing fixes or implementations of our Github issues.
 
 Please create single pull requests for every feature instead of creating one big monster of pull request containing a complete rewrite.
 
+### Testing
+To run the unit tests use
+```bash
+vendor/bin/phpunit --testsuite Unit
+``` 
+
+If a database is configured and the engelsystem is allowed to mess around with some files, you can run feature tests. The tests can potentially delete some database entries, so they should never be run on a production system!
+```bash
+vendor/bin/phpunit --testsuite Feature
+# or for unit- and feature tests:
+vendor/bin/phpunit
+``` 
+
+### CI & Build Pipeline
+The engelsystem can be tested and automatically deployed to a testing/staging/production environment.
+This functionality requires a [GitLab](https://about.gitlab.com/) server with a running docker minion.
+
+To use the deployment features the following secret variables need to be defined (if undefined the step will be skipped):
+```bash
+SSH_PRIVATE_KEY         # The ssh private key
+STAGING_REMOTE          # The staging server, e.g. user@remote.host
+STAGING_REMOTE_PATH     # The psth on the remote server, e.g. /var/www/engelsystem
+PRODUCTION_REMOTE       # Same as STAGING_REMOTE but for the production environment
+PRODUCTION_REMOTE_PATH  # Same as STAGING_REMOTE_PATH but for the production environment
+```
+
+#### deploy.sh
+The `deploy.sh` script can be used to deploy the engelsystem. It uses rsync to deploy the application to a server over ssh.
+
+For usage see `./deploy.sh -h`
+
 ### Codestyle
 Please ensure that your pull requests follow [PSR-2](http://www.php-fig.org/psr/psr-2/) and [PSR-4](http://www.php-fig.org/psr/psr-4/).

deploy.sh

@@ -0,0 +1,72 @@
+#!/usr/bin/env bash
+
+set -e
+
+remote_host=
+remote_path=
+deploy_id=
+
+show_help(){
+    echo "Usage: $0 [OPTION]..." >&2
+    echo "Deploys a software with rsync over ssh" >&2
+    echo "The options -i, -p and -r are required" >&2
+    echo "" >&2
+    echo "  -h          Display this help screen" >&2
+    echo "  -i <id>     Sets the id, a unique name for the deployment" >&2
+    echo "  -p <path>   Define the base path on the server" >&2
+    echo "  -r <host>   The remote server name and user" >&2
+}
+
+while getopts ":hi:p:r:" opt; do
+    case ${opt} in
+        h)
+            show_help
+            exit 1
+            ;;
+        r)
+            remote_host="$OPTARG"
+            ;;
+        p)
+            remote_path="$OPTARG"
+            ;;
+        i)
+            deploy_id="$OPTARG"
+            ;;
+        \?)
+            echo "Invalid option: -$OPTARG" >&2
+            exit 1
+            ;;
+        :)
+            echo "The option -$OPTARG requires an argument" >&2
+            exit 1
+            ;;
+    esac
+done
+
+if [ -z "${remote_host}" ] || [ -z "${remote_path}" ] || [ -z "${deploy_id}" ]; then
+    show_help
+    exit 1
+fi
+
+echo "syncing ${PWD}/ to ${remote_host}:${remote_path}/${deploy_id}/"
+
+rsync -vAax --exclude '.git*' --exclude .composer/ \
+    -e "ssh -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no" \
+    ./ "${remote_host}:${remote_path}/${deploy_id}/"
+
+ssh -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no "${remote_host}" "
+    set -e
+
+    if [[ -f \"${remote_path}/current/config/config.php\" ]]; then
+        echo \"Config backup\"
+        cp \"${remote_path}/current/config/config.php\" \"${deploy_id}-config.php\"
+    fi
+
+    echo \"Changing symlink\"
+    unlink \"${remote_path}/current\" && ln -s \"${remote_path}/${deploy_id}\" \"${remote_path}/current\"
+
+    if [[ -f \"${deploy_id}-config.php\" ]]; then
+        echo \"Restoring config\"
+        cp  \"${deploy_id}-config.php\" \"${remote_path}/current/config/config.php\"
+    fi
+"