Installing and setting up WordPress and Nginx for Travis CI tests.

# the setup I'm using requires the use of `sudo`
# to run some commands as super-user, as such I
# require it at the top of the configuration file
sudo: required

# this tells Travis to set up the box with some common tools
# used in PHP projects; while one can start with a "blank"
# box I find this convenient
language: php

# no email notifications for me; this is personal choice
notifications:
  email: false

# I want my project to be tested with the following PHP versions
php:
  - '7.0'
  - '7.1'
  - nightly

matrix:
  fast_finish: true

  # if the tests fail on the "nightly" version of PHP that's fine
  allow_failures:
    - php: nightly

# I will need to use a database in my tests so, in place of installing and
# setting up a MySQL server I simply require it; this will make the `mysql`
# binary available
services:
  - mysql

cache:
  apt: true
  directories:
    - vendor
    - $HOME/.composer/cache/files

addons:

  # instead of adding a line, in the `before_install` or `install`
  # sections to install packages using `apt-get install...` I simply
  # delegate the task to Travis
  apt:
    packages:

    # I will need PHP in its FPM version, MySQL PHP extensions and Nginx
    # itself
      - php5-fpm
      - php5-mysql
      - nginx

  # if I need to resolve pretty URLs to the local machine in place
  # of adding a line that tries to modify the `/etc/hosts` file I can
  # specify all the modifications I'd like to do here.
  # there is no `*.site.localhost` option so I need to add an entry for
  # each subdomain I want to use
  hosts:
    - site.localhost
    - test1.site.localhost

env:
  # here I define some environment variables I will be able to use
  # in scripts and in the PHP application itself
  # e.g `$SITE_FOLDER` will return `/tmp/site` in a bash script
  # while `$siteFolder = getenv('SITE_FOLDER');` will return the same
  # value in a PHP script
  global:
    - SITE_URL="http://site.localhost"
    - SITE_DOMAIN="site.localhost"
    - DB_NAME="test"

before_install:
  # create the databases that will be used by the site using `mysql` binary
  # user is `root`, password is empty and host is `localhost`
  - mysql -e "create database IF NOT EXISTS $DB_NAME;" -uroot

install:
  # install Composer dependencies
  - composer install --prefer-dist

  # copy the Nginx configuration file for the site among the available ones from 
  # the `build` folder; the content of the Nginx configuration file I'm using is
  # specific to WordPress (see below) so use whatever you need to use.
  # Given the current environment configuration it will be copied to `/etc/nginx/sites-available/site.localhost`
  - sudo cp build/travis-nginx-conf /etc/nginx/sites-available/$SITE_DOMAIN

  # using sed replace the placeholder text in the Nginx configuration file to use the
  # correct site folder path and domain
  - sudo sed -e "s?%TRAVIS_BUILD_DIR%?$TRAVIS_BUILD_DIR?g" --in-place /etc/nginx/sites-available/$SITE_DOMAIN
  - sudo sed -e "s?%SITE_DOMAIN%?$SITE_DOMAIN?g" --in-place /etc/nginx/sites-available/$SITE_DOMAIN

  # enable the site by creating a symbolic link in the `sites-enabled` folder
  - sudo ln -s /etc/nginx/sites-available/$SITE_DOMAIN /etc/nginx/sites-enabled/

before_script:

  # restart Nginx and PHP-FPM services to make sure the new site is loaded
  - sudo service php5-fpm restart
  - sudo service nginx restart

script:
  # finally run the tests...
  - curl http://site.localhost

server {
    listen 80;

    server_name %SITE_DOMAIN% *.%SITE_DOMAIN%;

    root %TRAVIS_BUILD_DIR%;

    index index.php;

    client_body_in_file_only clean;
    client_body_buffer_size 32K;

    client_max_body_size 300M;

    sendfile on;
    send_timeout 300s;

    location / {
        try_files $uri $uri/ /index.php?$args ;
    }

    location ~ \.php$ {
        try_files $uri =404;
        fastcgi_pass unix:/var/run/php5-fpm.sock;
        fastcgi_index index.php;
        include fastcgi_params;
    }

    # Expire images, icons, video, audio, HTC in 1 hour, *pretty* ok in development
    location ~* \.(?:jpg|jpeg|gif|png|ico|cur|gz|svg|svgz|mp4|ogg|ogv|webm|htc)$ {
      expires 1h;
      access_log off;
      add_header Cache-Control "public";
    }

    # Do not cache CSS and Javascript files at all
    location ~* \.(?:css|js)$ {
      # set this to `off` to avoid issues with the virtual machine
      sendfile off;
      expires -1;
      access_log off;
      add_header Cache-Control "public";
    }
}

sudo: required

language: php

notifications:
  email: false

php:
  - '7.0'
  - '7.1'
  - nightly

matrix:
  fast_finish: true
  allow_failures:
    - php: nightly
    - env: WP_VERSION=nightly

services:
  - mysql

cache:
  apt: true
  directories:
    - vendor
    - $HOME/.composer/cache/files

addons:
  apt:
    packages:
      # required by WordPress
      - libjpeg-dev
      - libpng12-dev
      - php5-fpm
      - php5-mysql
      - nginx
  hosts:
    - wp.localhost
    - test1.wp.localhost
    - test2.wp.localhost

env:
  global:
    - WP_FOLDER="/tmp/wordpress"
    - WP_URL="http://wp.localhost"
    - WP_DOMAIN="wp.localhost"
    - DB_NAME="test"
    - TEST_DB_NAME="wploader"
    - WP_TABLE_PREFIX="wp_"
    - WP_ADMIN_USERNAME="admin"
    - WP_ADMIN_PASSWORD="admin"
    - WP_SUBDOMAIN_1="test1"
    - WP_SUBDOMAIN_1_TITLE="Test Subdomain 1"
    - WP_SUBDOMAIN_2="test2"
    - WP_SUBDOMAIN_2_TITLE="Test Subdomain 2"
  matrix:
    - WP_VERSION=latest
    - WP_VERSION=nightly

before_install:
  # create the databases that will be used in the tests
  - mysql -e "create database IF NOT EXISTS $DB_NAME;" -uroot
  - mysql -e "create database IF NOT EXISTS $TEST_DB_NAME;" -uroot
  # set up folders
  - mkdir -p $WP_FOLDER
  - mkdir tools
  # install wp-cli in the `tools` folder
  - wget https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar -P $(pwd)/tools/
  - chmod +x tools/wp-cli.phar && mv tools/wp-cli.phar tools/wp
  # append the `tools` folder to the PATH
  - export PATH=$PATH:$(pwd)/tools
  # prepend the `vendor/bin` folder the PATH
  - export PATH=vendor/bin:$PATH

install:
  - composer install --prefer-dist

  # install WordPress in the `wordpress` folder
  - cd $WP_FOLDER
  - wp core download --version=$WP_VERSION
  - wp config create --dbname="$DB_NAME" --dbuser="root" --dbpass="" --dbhost="127.0.0.1" --dbprefix="$WP_TABLE_PREFIX"
  - wp core multisite-install --url="$WP_URL" --base="/" --subdomains --title="Test" --admin_user="$WP_ADMIN_USERNAME" --admin_password="$WP_ADMIN_PASSWORD" --admin_email="admin@$WP_DOMAIN" --skip-email

  # flush rewrite rules to use pretty permalinks
  - wp rewrite structure '/%postname%/' --hard

  # create the two subdomain sites I need
  - wp site create --slug="$WP_SUBDOMAIN_1" --title="$WP_SUBDOMAIN_1_TITLE"
  - wp site create --slug="$WP_SUBDOMAIN_2" --title="$WP_SUBDOMAIN_2_TITLE"

  # update WordPress database to avoid prompts
  - wp core update-db --network

  # export a dump of the just installed database to the _data folder
  - wp db export $TRAVIS_BUILD_DIR/tests/_data/dump.sql

  # get back to the build folder
  - cd $TRAVIS_BUILD_DIR

  # copy the Nginx configuration file to the default site and replace the path and domain
  - sudo cp build/travis-nginx-conf /etc/nginx/sites-available/$WP_DOMAIN
  - sudo sed -e "s?%WP_FOLDER%?$WP_FOLDER?g" --in-place /etc/nginx/sites-available/$WP_DOMAIN
  - sudo sed -e "s?%WP_DOMAIN%?$WP_DOMAIN?g" --in-place /etc/nginx/sites-available/$WP_DOMAIN

  # enable the WordPress installation
  - sudo ln -s /etc/nginx/sites-available/$WP_DOMAIN /etc/nginx/sites-enabled/

before_script:
  - sudo service php5-fpm restart
  - sudo service nginx restart

  # symbolically link the plugin root folder to the WordPress installation folder
  # if you are using wp-browser use the Symlinker extension and skip this
  - ln -s $TRAVIS_BUILD_DIR $WP_FOLDER/wp-content/plugins

  # build Codeception modules
  - codecept build

script:
  - codecept run acceptance
  - codecept run functional
  - codecept run integration
  - codecept run unit

map $http_host $blogid {
    default       -999;
    #Ref: http://wordpress.org/extend/plugins/nginx-helper/
    #include %WP_FOLDER%/wp-content/plugins/nginx-helper/map.conf;
}

server {
    listen 80;

    server_name %WP_DOMAIN% *.%WP_DOMAIN%;

    root %WP_FOLDER%;
    index index.php;

    client_body_in_file_only clean;
    client_body_buffer_size 32K;

    client_max_body_size 300M;

    sendfile on;
    send_timeout 300s;

    location / {
        try_files $uri $uri/ /index.php?$args ;
    }

    location ~ \.php$ {
        try_files $uri =404;
        fastcgi_pass unix:/var/run/php5-fpm.sock;
        fastcgi_index index.php;
        include fastcgi_params;
    }

    #WPMU Files
    location ~ ^/files/(.*)$ {
            try_files /wp-content/blogs.dir/$blogid/$uri /wp-includes/ms-files.php?file=$1 ;
            access_log off;
            log_not_found off;
            expires max;
    }

    #WPMU x-sendfile to avoid php readfile()
    location ^~ /blogs.dir {
        internal;
        alias %WP_FOLDER%/wp-content/blogs.dir;
        access_log off;
        log_not_found off;
        expires max;
    }

    # Expire images, icons, video, audio, HTC in 1 hour, *pretty* ok in development
    location ~* \.(?:jpg|jpeg|gif|png|ico|cur|gz|svg|svgz|mp4|ogg|ogv|webm|htc)$ {
      expires 1h;
      access_log off;
      add_header Cache-Control "public";
    }

    # Do not cache CSS and Javascript files at all
    location ~* \.(?:css|js)$ {
      # set this to `off` to avoid issues with the virtual machine
      sendfile off;
      expires -1;
      access_log off;
      add_header Cache-Control "public";
    }
}