Merge pull request #815 from geerlingguy/roles-in-vm

Include roles with Drupal VM codebase

Author: geerlingguy

.gitignore

@@ -4,6 +4,7 @@
 .vagrant/
 .bundle/
 *.retry
+.galaxy_install_info
 vagrant_ansible_inventory_default
 local.config.yml
 config.yml
@@ -12,5 +13,4 @@ Vagrantfile.local
 examples/prod/inventory
 examples/prod/bootstrap/vars.yml
 scripts/
-roles/
 drupal/

.travis.yml

@@ -49,9 +49,6 @@ script:
   # Setup directories.
   - 'sudo docker exec "$(cat ${container_id})" mkdir -p ${DRUPALVM_DIR}/drupal'
 
-  # Install dependencies.
-  - 'sudo docker exec "$(cat ${container_id})" ansible-galaxy install -r ${DRUPALVM_DIR}/provisioning/requirements.yml'
-
   # Setup config directory.
   - '[[ ! -z "${config_dir}" ]] && sudo docker exec "$(cat ${container_id})" mkdir -p ${config_dir} || true'
 
@@ -64,7 +61,7 @@ script:
   - '[[ ! -z "${local_config}" ]] && sudo docker exec "$(cat ${container_id})" bash -c "cp ${DRUPALVM_DIR}/${local_config} ${config_dir:-$DRUPALVM_DIR}/local.config.yml" || true'
 
   # Vagrantfile syntax check
-  - 'rubocop --except LineLength,Eval,MutableConstant'
+  - 'rubocop ./Vagrantfile --except LineLength,Eval,MutableConstant'
 
   # Ansible syntax check.
   - 'sudo docker exec --tty "$(cat ${container_id})" env TERM=xterm ansible-playbook ${DRUPALVM_DIR}/provisioning/playbook.yml --syntax-check'

Vagrantfile

@@ -122,7 +122,6 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
   if which('ansible-playbook')
     config.vm.provision 'ansible' do |ansible|
       ansible.playbook = "#{host_drupalvm_dir}/provisioning/playbook.yml"
-      ansible.galaxy_role_file = "#{host_drupalvm_dir}/provisioning/requirements.yml"
       ansible.extra_vars = {
         config_dir: host_config_dir
       }
@@ -137,7 +136,6 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
   # else
   #   config.vm.provision "ansible_local" do |ansible|
   #     ansible.playbook = "#{guest_drupalvm_dir}/provisioning/playbook.yml"
-  #     ansible.galaxy_role_file = "#{guest_drupalvm_dir}/provisioning/requirements.yml"
   #     ansible.extra_vars = {
   #       config_dir: guest_config_dir
   #     }

docs/other/overriding-configurations.md

@@ -45,9 +45,6 @@ config.vm.provider :virtualbox do |v|
   # Cap the host CPU execution at 50% usage.
   v.customize ["modifyvm", :id, "--cpuexecutioncap", "50"]
 end
-
-# Disable the galaxy role re-installation during provisions.
-config.vm.provisioners[0].config.galaxy_role_file = nil
 ```
 
 ### Example: Using the `vagrant-aws` provider

docs/other/php-56.md

@@ -1,7 +1,5 @@
 Drupal VM defaults to PHP 7, but you can install and use 5.6 if you need to maximize compatibility with older Drupal 6 and 7 sites.
 
-_Note: If you have Ansible installed on your host machine, make sure you're running the latest version of all Ansible role dependencies by running `ansible-galaxy install -r provisioning/requirements.yml --force` inside the root Drupal VM project folder._
-
 ## Ubuntu 16.04
 
 Ubuntu 16.04 Xenial defaults to PHP 7.0 in it's system packages. No older versions of PHP will be supported if using this base box.

provisioning/JJG-Ansible-Windows/windows.sh

@@ -71,8 +71,8 @@ if ! command -v ansible >/dev/null; then
 fi
 
 # Install requirements.
-echo "Installing Ansible roles from requirements file, if available."
-find "$PLAYBOOK_DIR" \( -name "requirements.yml" -o -name "requirements.txt" \) -exec sudo ansible-galaxy install --force --ignore-errors -r {} \;
+#echo "Installing Ansible roles from requirements file, if available."
+#find "$PLAYBOOK_DIR" \( -name "requirements.yml" -o -name "requirements.txt" \) -exec sudo ansible-galaxy install --force --ignore-errors -r {} \;
 
 # Run the playbook.
 echo "Running Ansible provisioner defined in Vagrantfile."

provisioning/README.md

@@ -0,0 +1,15 @@
+# Drupal VM - Ansible Provisioning
+
+Drupal VM uses the Ansible provisioner to build all the software that runs and supplements Drupal sites.
+
+The Ansible configuration uses a variety of open source community-maintained Ansible Roles that are hosted on Ansible Galaxy, but Drupal VM includes the roles in the codebase for efficiency's sake.
+
+**You should NOT make any manual changes to the roles in the `roles` directory**, but rather, contribute to the upstream roles corresponding to the role's folder name (e.g. for issues with the `geerlingguy.apache` role, see the [`geerlingguy.apache`](https://galaxy.ansible.com/geerlingguy/apache/) role page on Ansible Galaxy, and the role's [issue tracker on GitHub](https://github.com/geerlingguy/ansible-role-apache/issues)).
+
+## Adding and Updating Galaxy roles
+
+From time to time, third party roles need to be added or updated to enable new Drupal VM functionality or fix bugs. To update a role (e.g. `geerlingguy.apache`), find the role's `version` setting inside `requirements.yml`, bump the version to the required or latest version of the role, then run the following command _in the same directory as this README file_:
+
+    $ ansible-galaxy install -r requirements.yml --force
+
+Then commit the updated `requirements.yml` file and the new and updated files within the `roles` directory in a new PR to the Drupal VM project.

provisioning/ansible.cfg

@@ -0,0 +1,2 @@
+[defaults]
+roles_path = ./roles

provisioning/roles/arknoll.selenium/.gitignore

@@ -0,0 +1,24 @@
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+Icon?
+ehthumbs.db
+Thumbs.db
+
+# IDE files #
+#################
+/.settings
+/.buildpath
+/.project
+/nbproject
+*.komodoproject
+*.kpf
+/.idea
+
+# Other files #
+###############
+!empty

provisioning/roles/arknoll.selenium/.travis.yml

@@ -0,0 +1,35 @@
+---
+language: python
+python: "2.7"
+
+env:
+  - ANSIBLE_VERSION=1.6
+  - ANSIBLE_VERSION=1.7
+  - ANSIBLE_VERSION=1.8
+
+before_install:
+  - sudo apt-get update -qq
+
+install:
+  # Install Ansible.
+  - pip install ansible==$ANSIBLE_VERSION
+
+  # Add ansible.cfg to pick up roles path.
+  - "printf '[defaults]\\nroles_path = ../' > ansible.cfg"
+
+script:
+  # Check the role/playbook's syntax.
+  - "ansible-playbook -i tests/inventory tests/test.yml --syntax-check"
+
+  # Run the role/playbook with ansible-playbook.
+  - "ansible-playbook -i tests/inventory tests/test.yml --connection=local --sudo -vvvv"
+
+  # Run the role/playbook again, checking to make sure it's idempotent.
+  - >
+    ansible-playbook -i tests/inventory tests/test.yml --connection=local --sudo
+    | grep -q 'changed=0.*failed=0'
+    && (echo 'Idempotence test: pass' && exit 0)
+    || (echo 'Idempotence test: fail' && exit 1)
+
+notifications:
+  email: false