Merge pull request #2113 from geerlingguy/2109-github-actions-molecule

Migrate from shell script and Travis CI to Molecule and GitHub Actions

Author: geerlingguy

.github/FUNDING.yml

@@ -1,4 +1,4 @@
 # These are supported funding model platforms
-
+---
 github: geerlingguy
 patreon: geerlingguy

.github/workflows/ci.yml

@@ -0,0 +1,99 @@
+---
+name: CI
+'on':
+  pull_request:
+  push:
+    branches:
+      - master
+  schedule:
+    - cron: "20 3 * * 0"
+
+jobs:
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the codebase.
+        uses: actions/checkout@v2
+
+      - name: Set up Python 3.
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+
+      - name: Set up Ruby.
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: Install test dependencies.
+        run: |
+          pip3 install yamllint
+          gem install rubocop
+
+      - name: Lint code.
+        run: |
+          yamllint .
+          rubocop ./Vagrantfile ./lib/drupalvm \
+            --except Metrics/LineLength,Security/Eval,Style/MutableConstant,Metrics/BlockLength,Metrics/MethodLength,Style/ConditionalAssignment,Style/IfUnlessModifier,Style/CaseLikeIf
+
+  molecule:
+    name: Molecule
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          # Defaults.
+          - distro: ubuntu1804
+            playbook: converge.yml
+          - distro: debian10
+            playbook: converge.yml
+          - distro: centos8
+            playbook: converge.yml
+
+            # TODO: Add PHP 7.4 test.
+            # local_config: tests/ubuntu1804-php74.config.yml
+            # test_extras: false
+            # - distro: ubuntu1804
+            #   playbook: TODO
+
+            # TODO: Add Postgresql test.
+            # local_config: tests/ubuntu1804-postgresql.config.yml
+            # config_dir: /var/www/drupalvm/config
+            # test_extras: false
+            # - distro: ubunt1804
+            #   playbook: TODO
+
+    steps:
+      - name: Check out the codebase.
+        uses: actions/checkout@v2
+
+      - name: Set up Python 3.
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+
+      - name: Install test dependencies.
+        run: pip3 install ansible molecule[docker] docker
+
+      # See: https://github.com/geerlingguy/ansible-role-mysql/issues/422
+      - name: Disable AppArmor on Debian.
+        run: |
+            set -x
+            sudo apt-get install apparmor-profiles
+            sudo ln -s /etc/apparmor.d/usr.sbin.mysqld /etc/apparmor.d/disable/
+            sudo apparmor_parser -R /etc/apparmor.d/usr.sbin.mysqld
+        if: ${{ startsWith(matrix.distro, 'debian') }}
+
+      - name: Copy test scaffold files into place.
+        run: |
+          cp example.drupal.make.yml drupal.make.yml
+          cp example.drupal.composer.json drupal.composer.json
+
+      - name: Run Molecule tests.
+        run: molecule test
+        env:
+          PY_COLORS: '1'
+          ANSIBLE_FORCE_COLOR: '1'
+          MOLECULE_DISTRO: ${{ matrix.distro }}

.travis.yml

@@ -0,0 +1,18 @@
+---
+extends: default
+
+rules:
+  line-length:
+    max: 200
+    level: warning
+  truthy:
+    allowed-values: ['true', 'false', 'yes', 'no']
+  braces:
+    min-spaces-inside: 1
+    max-spaces-inside: 1
+    min-spaces-inside-empty: -1
+    max-spaces-inside-empty: -1
+
+ignore: |
+  */stale.yml
+  provisioning/roles/

.yamllint

@@ -1,6 +1,6 @@
 ![Drupal VM Logo](https://raw.githubusercontent.com/geerlingguy/drupal-vm/master/docs/images/drupal-vm-logo.png)
 
-[![Build Status](https://travis-ci.com/geerlingguy/drupal-vm.svg?branch=master)](https://travis-ci.com/geerlingguy/drupal-vm) [![Documentation Status](https://readthedocs.org/projects/drupal-vm/badge/?version=latest)](http://docs.drupalvm.com) [![Packagist](https://img.shields.io/packagist/v/geerlingguy/drupal-vm.svg)](https://packagist.org/packages/geerlingguy/drupal-vm) [![Docker Automated build](https://img.shields.io/docker/automated/geerlingguy/drupal-vm.svg?maxAge=2592000)](https://hub.docker.com/r/geerlingguy/drupal-vm/) [![](https://images.microbadger.com/badges/image/geerlingguy/drupal-vm.svg)](https://microbadger.com/images/geerlingguy/drupal-vm "Get your own image badge on microbadger.com") [![irc://irc.freenode.net/drupal-vm](https://img.shields.io/badge/irc.freenode.net-%23drupal--vm-brightgreen.svg)](https://riot.im/app/#/room/#drupal-vm:matrix.org)
+[![CI](https://github.com/geerlingguy/drupal-vm/workflows/CI/badge.svg?event=push)](https://github.com/geerlingguy/drupal-vm/actions?query=workflow%3ACI) [![Documentation Status](https://readthedocs.org/projects/drupal-vm/badge/?version=latest)](http://docs.drupalvm.com) [![Packagist](https://img.shields.io/packagist/v/geerlingguy/drupal-vm.svg)](https://packagist.org/packages/geerlingguy/drupal-vm) [![Docker Automated build](https://img.shields.io/docker/automated/geerlingguy/drupal-vm.svg?maxAge=2592000)](https://hub.docker.com/r/geerlingguy/drupal-vm/) [![](https://images.microbadger.com/badges/image/geerlingguy/drupal-vm.svg)](https://microbadger.com/images/geerlingguy/drupal-vm "Get your own image badge on microbadger.com") [![irc://irc.freenode.net/drupal-vm](https://img.shields.io/badge/irc.freenode.net-%23drupal--vm-brightgreen.svg)](https://riot.im/app/#/room/#drupal-vm:matrix.org)
 
 [Drupal VM](https://www.drupalvm.com/) is a VM for Drupal, built with Ansible.
 
@@ -168,14 +168,13 @@ Drupal VM runs on almost any modern computer that can run VirtualBox and Vagrant
 
 ## Tests
 
-To run basic integration tests using Docker:
+To run basic integration tests using Docker and Molecule:
 
   1. [Install Docker](https://docs.docker.com/engine/installation/).
+  2. Install Molecule: `pip3 install ansible molecule[docker]`
   2. In this project directory, run: `composer run-tests`
 
-> Note: If you're on a Mac, you need to use [Docker's Edge release](https://docs.docker.com/docker-for-mac/install/#download-docker-for-mac), at least until [this issue](https://github.com/docker/for-mac/issues/77) is resolved.
-
-The project's automated tests are run via Travis CI, and the more comprehensive test suite covers multiple Linux distributions and many different Drupal VM use cases and deployment techniques.
+The project's automated tests are run via GitHub Actions, and the more comprehensive test suite covers multiple Linux distributions and many different Drupal VM use cases and deployment techniques.
 
 ## License
 

README.md

@@ -25,7 +25,7 @@
         "process-timeout": 1800
     },
     "scripts": {
-        "run-tests": "./tests/run-tests.sh",
+        "run-tests": "molecule test",
         "docker-bake": "./provisioning/docker/bake.sh",
         "docker-save-image": "./provisioning/docker/save-image.sh",
         "docker-load-image": "./provisioning/docker/load-image.sh"

composer.json

@@ -95,7 +95,7 @@ drupal_major_version: 9
 drupal_domain: "{{ vagrant_hostname }}"
 drupal_site_name: "Drupal"
 drupal_install_profile: standard
-drupal_enable_modules: [ 'devel' ]
+drupal_enable_modules: ['devel']
 drupal_account_name: admin
 drupal_account_pass: admin
 
@@ -285,7 +285,7 @@ composer_global_packages: []
 # reference the directory where your `config.yml` is.
 pre_provision_scripts: []
 post_provision_scripts: []
-  # - "{{ playbook_dir }}/../examples/scripts/configure-solr.sh"
+# - "{{ playbook_dir }}/../examples/scripts/configure-solr.sh"
 
 # MySQL Configuration.
 mysql_root_password: root

default.config.yml

@@ -1,3 +1,4 @@
+---
 version: "3"
 
 services:

example.docker-compose.yml

@@ -1,3 +1,4 @@
+---
 site_name: Drupal VM Documentation
 
 repo_url: https://github.com/geerlingguy/drupal-vm
@@ -9,69 +10,69 @@ extra_javascript:
 
 markdown_extensions:
   - toc:
-      permalink: True
+      permalink: true
 
 pages:
   - Home: 'index.md'
   - Getting Started:
-    - Installation:
-      - 'macOS': 'getting-started/installation-macos.md'
-      - 'Windows': 'getting-started/installation-windows.md'
-      - 'Linux': 'getting-started/installation-linux.md'
-    - 'Configuring Drupal VM': 'getting-started/configure-drupalvm.md'
-    - 'Syncing Folders': 'getting-started/syncing-folders.md'
+      - Installation:
+          - 'macOS': 'getting-started/installation-macos.md'
+          - 'Windows': 'getting-started/installation-windows.md'
+          - 'Linux': 'getting-started/installation-linux.md'
+      - 'Configuring Drupal VM': 'getting-started/configure-drupalvm.md'
+      - 'Syncing Folders': 'getting-started/syncing-folders.md'
   - Building your codebase:
-    - 'Using a local Drupal codebase': 'deployment/local-codebase.md'
-    - 'Using a composer package': 'deployment/composer-package.md'
-    - 'Using composer.json': 'deployment/composer.md'
-    - 'Using a Drush Make file': 'deployment/drush-make.md'
-    - 'Drupal VM as a Composer Dependency': 'deployment/composer-dependency.md'
-    - 'Deploying Drupal via Git': 'deployment/git.md'
+      - 'Using a local Drupal codebase': 'deployment/local-codebase.md'
+      - 'Using a composer package': 'deployment/composer-package.md'
+      - 'Using composer.json': 'deployment/composer.md'
+      - 'Using a Drush Make file': 'deployment/drush-make.md'
+      - 'Drupal VM as a Composer Dependency': 'deployment/composer-dependency.md'
+      - 'Deploying Drupal via Git': 'deployment/git.md'
   - Basic configurations:
-    - 'Using different base OSes': 'configurations/base-os.md'
-    - 'Using a different PHP version': 'configurations/php.md'
-    - Webservers:
-      - 'Apache': 'configurations/webservers-apache.md'
-      - 'Nginx': 'configurations/webservers-nginx.md'
-    - Databases:
-      - 'Connect to the MySQL Database': 'configurations/databases-mysql.md'
-      - 'Use MariaDB instead of MySQL': 'configurations/databases-mariadb.md'
-      - 'Use PostgreSQL instead of MySQL': 'configurations/databases-postgresql.md'
+      - 'Using different base OSes': 'configurations/base-os.md'
+      - 'Using a different PHP version': 'configurations/php.md'
+      - Webservers:
+          - 'Apache': 'configurations/webservers-apache.md'
+          - 'Nginx': 'configurations/webservers-nginx.md'
+      - Databases:
+          - 'Connect to the MySQL Database': 'configurations/databases-mysql.md'
+          - 'Use MariaDB instead of MySQL': 'configurations/databases-mariadb.md'
+          - 'Use PostgreSQL instead of MySQL': 'configurations/databases-postgresql.md'
   - Installed extras:
-    - 'adminer (Database UI)': 'extras/adminer.md'
-    - 'blackfire (Profiling tool)': 'extras/blackfire.md'
-    - 'drupalconsole (Drupal CLI)': 'extras/drupal-console.md'
-    - 'drush (Drupal CLI)': 'extras/drush.md'
-    - 'elasticsearch (Search engine)': 'extras/elasticsearch.md'
-    - 'java': 'extras/java.md'
-    - 'mailhog (Mail catcher)': 'extras/mailhog.md'
-    - 'memcached (In-memory cache)': 'extras/memcached.md'
-    - 'newrelic (Performance monitoring)': 'extras/newrelic.md'
-    - 'nodejs': 'extras/nodejs.md'
-    - 'pimpmylog (Log viewer)': 'extras/pimpmylog.md'
-    - 'redis (In-memory database)': 'extras/redis.md'
-    - 'ruby': 'extras/ruby.md'
-    - 'selenium (BDD with Behat)': 'extras/selenium.md'
-    - 'solr (Search engine)': 'extras/solr.md'
-    - 'tideways (Profiling tool)': 'extras/tideways.md'
-    - 'upload-progress': 'extras/upload-progress.md'
-    - 'varnish (Caching reverse proxy)': 'extras/varnish.md'
-    - 'xdebug (Debugging tool)': 'extras/xdebug.md'
-    - 'xhprof (Profiling tool)': 'extras/xhprof.md'
+      - 'adminer (Database UI)': 'extras/adminer.md'
+      - 'blackfire (Profiling tool)': 'extras/blackfire.md'
+      - 'drupalconsole (Drupal CLI)': 'extras/drupal-console.md'
+      - 'drush (Drupal CLI)': 'extras/drush.md'
+      - 'elasticsearch (Search engine)': 'extras/elasticsearch.md'
+      - 'java': 'extras/java.md'
+      - 'mailhog (Mail catcher)': 'extras/mailhog.md'
+      - 'memcached (In-memory cache)': 'extras/memcached.md'
+      - 'newrelic (Performance monitoring)': 'extras/newrelic.md'
+      - 'nodejs': 'extras/nodejs.md'
+      - 'pimpmylog (Log viewer)': 'extras/pimpmylog.md'
+      - 'redis (In-memory database)': 'extras/redis.md'
+      - 'ruby': 'extras/ruby.md'
+      - 'selenium (BDD with Behat)': 'extras/selenium.md'
+      - 'solr (Search engine)': 'extras/solr.md'
+      - 'tideways (Profiling tool)': 'extras/tideways.md'
+      - 'upload-progress': 'extras/upload-progress.md'
+      - 'varnish (Caching reverse proxy)': 'extras/varnish.md'
+      - 'xdebug (Debugging tool)': 'extras/xdebug.md'
+      - 'xhprof (Profiling tool)': 'extras/xhprof.md'
   - Extending Drupal VM:
-    - 'Adding Vagrant plugins Vagrantfile.local': 'extending/vagrantfile.md'
-    - 'Passing on CLI arguments to ansible': 'extending/ansible-args.md'
-    - 'Pre- and Post-Provision Scripts': 'extending/scripts.md'
+      - 'Adding Vagrant plugins Vagrantfile.local': 'extending/vagrantfile.md'
+      - 'Passing on CLI arguments to ansible': 'extending/ansible-args.md'
+      - 'Pre- and Post-Provision Scripts': 'extending/scripts.md'
   - Other Information:
-    - 'Networking Notes': 'other/networking.md'
-    - 'Vagrant LXC provider': 'other/vagrant-lxc.md'
-    - 'Improving Performance': 'other/performance.md'
-    - 'Docker': 'other/docker.md'
-    - 'Custom Vagrant Base Box': 'other/custom-base-box.md'
-    - 'BigPipe with Drupal VM': 'other/bigpipe.md'
-    - 'Drupal multisite': 'deployment/multisite.md'
-    - 'Drupal 6 Notes': 'other/drupal-6.md'
-    - 'Drupal VM Management Tools': 'other/management-tools.md'
-    - 'Emulating Acquia Cloud environment': 'other/acquia.md'
-    - 'Deploying to a production environment': 'other/production.md'
-    - 'Wordpress or other applications': 'other/wordpress-other-applications.md'
+      - 'Networking Notes': 'other/networking.md'
+      - 'Vagrant LXC provider': 'other/vagrant-lxc.md'
+      - 'Improving Performance': 'other/performance.md'
+      - 'Docker': 'other/docker.md'
+      - 'Custom Vagrant Base Box': 'other/custom-base-box.md'
+      - 'BigPipe with Drupal VM': 'other/bigpipe.md'
+      - 'Drupal multisite': 'deployment/multisite.md'
+      - 'Drupal 6 Notes': 'other/drupal-6.md'
+      - 'Drupal VM Management Tools': 'other/management-tools.md'
+      - 'Emulating Acquia Cloud environment': 'other/acquia.md'
+      - 'Deploying to a production environment': 'other/production.md'
+      - 'Wordpress or other applications': 'other/wordpress-other-applications.md'