r10k 1.4.2 → 1.5.1

data/integration/lib/r10k_utils.rb

@@ -0,0 +1,166 @@
+require 'git_utils'
+
+# Retrieve the file path for the "r10k.yaml" configuration file.
+#
+# ==== Attributes
+#
+# * +master+ - The Puppet master on which r10k is installed.
+#
+# ==== Returns
+#
+# +string+ - Absolute file path to "r10k.yaml" config file.
+#
+# ==== Examples
+#
+# get_r10k_config_file_path(master)
+def get_r10k_config_file_path(master)
+  confdir = on(master, puppet('config print confdir')).stdout.rstrip
+
+  return File.join(File.dirname(confdir), 'r10k', 'r10k.yaml')
+end
+
+# Verify that a pristine "production" environment exists on the master.
+# (And only the "production" environment!)
+#
+# ==== Attributes
+#
+# * +master+ - The Puppet master on which to verify the "production" environment.
+#
+# ==== Returns
+#
+# +nil+
+#
+# ==== Examples
+#
+# verify_production_environment(master)
+def verify_production_environment(master)
+  environment_path = on(master, puppet('config', 'print', 'environmentpath')).stdout.rstrip
+  prod_env_md5sum_path = File.join(environment_path, 'production', 'manifests', '.site_pp.md5')
+
+  #Verify MD5 sum of "site.pp"
+  on(master, "md5sum -c #{prod_env_md5sum_path}")
+
+  #Verify that "production" is the only environment available.
+  on(master, "test `ls #{environment_path} | wc -l` -eq 1")
+  on(master, "ls #{environment_path} | grep \"production\"")
+end
+
+# Revert the Puppet environments back to a pristine 'production' branch while deleting all other branches.
+#
+# ==== Attributes
+#
+# * +host+ - One or more hosts to act upon, or a role (String or Symbol) that identifies one or more hosts.
+# * +commit_sha+ - The reset 'production' branch HEAD to this commit SHA.
+# * +git_repo_path+ - The path to the git repository on the target host.
+#
+# ==== Returns
+#
+# +nil+
+#
+# ==== Examples
+#
+# r10k_revert_environment(master, 'ff81c01c5', '~/git_repo')
+def r10k_revert_environment(host, commit_sha, git_repo_path)
+  #Reset 'production' branch to know clean state.
+  git_on(host, 'checkout production', git_repo_path)
+  git_reset_hard(host, commit_sha, git_repo_path)
+
+  #Get all branches except for 'production'.
+  local_branches = git_on(host, 'branch | grep -v "production" | xargs', git_repo_path).stdout()
+
+  #Delete all other branches except for 'production' locally and remotely.
+  if local_branches != "\n"
+    git_on(host, "branch -D #{local_branches}", git_repo_path)
+  end
+
+  #Force push changes to remote.
+  git_on(host, 'push origin --mirror --force', git_repo_path)
+  git_on(host, 'push origin --mirror --force', git_repo_path)
+end
+
+# Clean-up the r10k environment on the master to bring it back to a known good state.
+#
+# ==== Attributes
+#
+# * +host+ - The Puppet master on which to verify the "production" environment.
+# * +commit_sha+ - The reset HEAD to this commit SHA.
+# * +git_repo_path+ - The path to the git repository on the target host.
+#
+# ==== Returns
+#
+# +nil+
+#
+# ==== Examples
+#
+# clean_up_r10k(master, 'ff81c01c5', '~/git_repo')
+def clean_up_r10k(master, commit_sha, git_repo_path)
+  environment_path = on(master, puppet('config', 'print', 'environmentpath')).stdout.rstrip
+  prod_env_modules_path = File.join(environment_path, 'production', 'modules')
+  prod_env_site_path = File.join(environment_path, 'production', 'site')
+
+  step 'Reset Git Repo to Known Good State'
+  r10k_revert_environment(master, commit_sha, git_repo_path)
+
+  step 'Restore Original "production" Environment'
+  on(master, 'r10k deploy environment -v')
+
+  step 'Verify "production" Environment is at Original State'
+  verify_production_environment(master)
+
+  step 'Remove Any Modules from the "production" Environment'
+  on(master, "rm -rf #{prod_env_modules_path}/*")
+  on(master, "rm -rf #{prod_env_site_path}/*")
+end
+
+# Create a new r10k Git source that is copied from the current "production" environment.
+#
+# ==== Attributes
+#
+# * +master+ - The Puppet master on which to create a new Git source.
+# * +git_repo_parent_path+ - The parent path that contains the desired Git repository.
+# * +git_repo_name+ - The name of the repository.
+# * +git_clone_path+ - The destination path for the git clone.
+# * +env_name+ - The initial branch name (environment) for first commit.
+# * +deploy?+ - A flag indicating if r10k environment deployment should be kicked off after cloning.
+#
+# ==== Returns
+#
+# +string+ - The path to the newly created Git repository.
+#
+# ==== Examples
+#
+# init_r10k_source_from_prod(master, '/git/repos', 'environments', '~/repos/r10k', 'test', deploy=true)
+def init_r10k_source_from_prod(master, git_repo_parent_path, git_repo_name, git_clone_path, env_name, deploy=false)
+  #Init
+  env_path = on(master, puppet('config print environmentpath')).stdout.rstrip
+  prod_env_path = File.join(env_path, 'production')
+
+  local_files_root_path = ENV['FILES'] || 'files'
+  prod_env_config_path = 'pre-suite/prod_env.config'
+  prod_env_config = File.read(File.join(local_files_root_path, prod_env_config_path))
+
+  #Create Git origin repo and clone.
+  git_init_bare_repo_and_clone(master, git_repo_parent_path, git_repo_name, git_clone_path)
+
+  #Copy current contents of production environment to the git clone path
+  on(master, "cp -r #{prod_env_path}/* #{git_clone_path}")
+
+  #Create hidden files in the "site" and "modules" folders so that git copies the directories.
+  on(master, "mkdir -p #{git_clone_path}/modules #{git_clone_path}/site")
+  on(master, "touch #{git_clone_path}/modules/.keep;touch #{git_clone_path}/site/.keep")
+
+  #Create MD5 sum file for the "site.pp" file.
+  on(master, "md5sum #{git_clone_path}/manifests/site.pp > #{git_clone_path}/manifests/.site_pp.md5")
+
+  #Add environment config that specifies module lookup path for production.
+  create_remote_file(master, "#{git_clone_path}/environment.conf", prod_env_config)
+  git_on(master, "add #{git_clone_path}/*", git_clone_path)
+  git_on(master, "commit -m \"Add #{env_name} environment.\"", git_clone_path)
+  git_on(master, "branch -m #{env_name}", git_clone_path)
+  git_on(master, "push -u origin #{env_name}", git_clone_path)
+
+  #Attempt to deploy environments.
+  if deploy
+    on(master, 'r10k deploy environment -v')
+  end
+end

data/integration/manifests/README.mkd

@@ -0,0 +1,4 @@
+Manifests
+===========================
+
+This folder contains manifests used for testing the r10k project. The manifests are organized by test suite.

data/integration/pre-suite/00_pe_install.rb

@@ -0,0 +1,4 @@
+test_name 'CODEMGMT-20 - C48 - Install Puppet Enterprise'
+
+step 'Install PE'
+install_pe

data/integration/pre-suite/01_git_config.rb

@@ -0,0 +1,59 @@
+require 'git_utils'
+require 'r10k_utils'
+require 'master_manipulator'
+test_name 'CODEMGMT-20 - C59120 - Install and Configure Git for r10k'
+
+#Init
+env_path = on(master, puppet('config print environmentpath')).stdout.rstrip
+prod_env_path = File.join(env_path, 'production')
+
+git_repo_path = '/git_repos'
+git_repo_name = 'environments'
+git_control_remote = File.join(git_repo_path, "#{git_repo_name}.git")
+git_control_remote_head_path = File.join(git_control_remote, 'HEAD')
+git_environments_path = File.join('/root', git_repo_name)
+
+step 'Get PE Version'
+pe_major = on(master, 'facter -p pe_major_version').stdout.rstrip
+pe_minor = on(master, 'facter -p pe_minor_version').stdout.rstrip
+pe_version = "#{pe_major}.#{pe_minor}".to_f
+
+if pe_version < 3.7
+  fail_test('This pre-suite requires PE 3.7 or above!')
+end
+
+#In-line files
+git_manifest = <<-MANIFEST
+class { 'git': }
+->
+git::config { 'user.name':
+  value => 'Tester',
+}
+->
+git::config { 'user.email':
+  value => 'tester@puppetlabs.com',
+}
+->
+file { '#{git_repo_path}':
+  ensure => directory
+}
+MANIFEST
+
+#Setup
+step 'Stub Forge on Master'
+stub_forge_on(master)
+
+step 'Install "git" Module'
+on(master, puppet('module install puppetlabs-git --modulepath /opt/puppet/share/puppet/modules'))
+
+step 'Install and Configure Git'
+on(master, puppet('apply'), :stdin => git_manifest, :acceptable_exit_codes => [0,2]) do |result|
+  assert_no_match(/Error:/, result.stderr, 'Unexpected error was detected!')
+end
+
+step 'Create "production" Environment on Git'
+init_r10k_source_from_prod(master, git_repo_path, git_repo_name, git_environments_path, 'production')
+
+step 'Change Default Branch to "production" on Git Control Remote'
+create_remote_file(master, git_control_remote_head_path, "ref: refs/heads/production\n")
+on(master, "chmod 644 #{git_control_remote_head_path}")

data/integration/pre-suite/02_pe_r10k.rb

@@ -0,0 +1,60 @@
+require 'git_utils'
+require 'r10k_utils'
+require 'master_manipulator'
+test_name 'CODEMGMT-21 - C59119 - Configure r10k for Puppet Enterprise'
+
+#Init
+env_path = on(master, puppet('config print environmentpath')).stdout.rstrip
+prod_env_path = File.join(env_path, 'production')
+
+r10k_config_path = get_r10k_config_file_path(master)
+
+git_repo_path = '/git_repos'
+git_repo_name = 'environments'
+git_control_remote = File.join(git_repo_path, "#{git_repo_name}.git")
+git_provider = ENV['GIT_PROVIDER'] || 'shellgit'
+
+pe_major = on(master, 'facter -p pe_major_version').stdout.rstrip
+pe_minor = on(master, 'facter -p pe_minor_version').stdout.rstrip
+pe_version = "#{pe_major}.#{pe_minor}".to_f
+
+if pe_version < 3.7
+  fail_test('This pre-suite requires PE 3.7 or above!')
+end
+
+#In-line files
+r10k_conf = <<-CONF
+cachedir: '/var/cache/r10k'
+git:
+  provider: '#{git_provider}'
+sources:
+  control:
+    basedir: "#{env_path}"
+    remote: "#{git_control_remote}"
+CONF
+
+#Setup
+step 'Remove Current Puppet "production" Environment'
+on(master, "rm -rf #{prod_env_path}")
+
+step 'Configure r10k'
+create_remote_file(master, r10k_config_path, r10k_conf)
+on(master, "chmod 644 #{r10k_config_path}")
+#Work-a-round until CODEMGMT-110 is resolved
+on(master, "ln -s #{r10k_config_path} /etc/r10k.yaml")
+
+step 'Deploy "production" Environment via r10k'
+on(master, 'r10k deploy environment -v')
+
+step 'Disable Environment Caching on Master'
+on(master, puppet('config set environment_timeout 0 --section main'))
+
+#This should be temporary until we get a better solution.
+step 'Disable Node Classifier'
+on(master, puppet('config', 'set node_terminus plain', '--section master'))
+
+step 'Restart the Puppet Server Service'
+restart_puppet_server(master)
+
+step 'Run Puppet Agent on All Nodes'
+on(agents, puppet('agent', '--test', '--environment production'))

data/integration/pre-suite/03_test_utils.rb

@@ -0,0 +1,17 @@
+test_name 'CODEMGMT-62 - C63199 - Install Utilities for r10k Integration Testing'
+
+#Init
+filebucket_path = '/opt/filebucket'
+filebucket_script_path = '/etc/profile.d/filebucket_path.sh'
+
+filebucket_script = <<-SCRIPT
+#!/bin/bash
+export PATH="${PATH}:#{filebucket_path}"
+SCRIPT
+
+step 'Install "filebucket" File Generator'
+create_remote_file(master, filebucket_script_path, filebucket_script)
+on(master, "git clone https://github.com/cowofevil/filebucket.git #{filebucket_path}")
+
+on(master, "chmod 755 #{filebucket_script_path}")
+on(master, "chmod 755 #{filebucket_path}/filebucketapp.py")

data/integration/pre-suite/README.mkd

@@ -0,0 +1,5 @@
+Pre-suite
+===========================
+
+This folder contains the [Beaker](https://github.com/puppetlabs/beaker) pre-suite tasks that configures test
+test infrastructure for testing.

data/integration/test_run_scripts/README.mkd

@@ -0,0 +1,5 @@
+Test Run Scripts
+===========================
+
+This folder contains shell scripts for running automated tests locally on your personal machine. The scripts are
+organized by test suite.

data/integration/test_run_scripts/all_tests-rugged-pe-centos6.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+SCRIPT_PATH=$(pwd)
+BASENAME_CMD="basename ${SCRIPT_PATH}"
+SCRIPT_BASE_PATH=`eval ${BASENAME_CMD}`
+
+if [ $SCRIPT_BASE_PATH = "test_run_scripts" ]; then
+  cd ../
+fi
+
+export pe_dist_dir=http://neptune.puppetlabs.lan/3.8/ci-ready/
+export GIT_PROVIDER=rugged
+
+beaker \
+  --preserve-hosts onfail \
+  --config configs/pe/centos-6-64mda \
+  --debug \
+  --tests tests \
+  --keyfile ~/.ssh/id_rsa-acceptance \
+  --pre-suite pre-suite \
+  --load-path lib

data/integration/test_run_scripts/all_tests-rugged-pe-rhel7.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+SCRIPT_PATH=$(pwd)
+BASENAME_CMD="basename ${SCRIPT_PATH}"
+SCRIPT_BASE_PATH=`eval ${BASENAME_CMD}`
+
+if [ $SCRIPT_BASE_PATH = "test_run_scripts" ]; then
+  cd ../
+fi
+
+export pe_dist_dir=http://neptune.puppetlabs.lan/3.8/ci-ready/
+export GIT_PROVIDER=rugged
+
+beaker \
+  --preserve-hosts onfail \
+  --config configs/pe/redhat-7-64mda \
+  --debug \
+  --tests tests \
+  --keyfile ~/.ssh/id_rsa-acceptance \
+  --pre-suite pre-suite \
+  --load-path lib

data/integration/test_run_scripts/all_tests-rugged-pe-sles11.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+SCRIPT_PATH=$(pwd)
+BASENAME_CMD="basename ${SCRIPT_PATH}"
+SCRIPT_BASE_PATH=`eval ${BASENAME_CMD}`
+
+if [ $SCRIPT_BASE_PATH = "test_run_scripts" ]; then
+  cd ../
+fi
+
+export pe_dist_dir=http://neptune.puppetlabs.lan/3.8/ci-ready/
+export GIT_PROVIDER=rugged
+
+beaker \
+  --preserve-hosts onfail \
+  --config configs/pe/sles-11-64mda \
+  --debug \
+  --tests tests \
+  --keyfile ~/.ssh/id_rsa-acceptance \
+  --pre-suite pre-suite \
+  --load-path lib

data/integration/test_run_scripts/all_tests-rugged-pe-ubuntu1204.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+SCRIPT_PATH=$(pwd)
+BASENAME_CMD="basename ${SCRIPT_PATH}"
+SCRIPT_BASE_PATH=`eval ${BASENAME_CMD}`
+
+if [ $SCRIPT_BASE_PATH = "test_run_scripts" ]; then
+  cd ../
+fi
+
+export pe_dist_dir=http://neptune.puppetlabs.lan/3.8/ci-ready/
+export GIT_PROVIDER=rugged
+
+beaker \
+  --preserve-hosts onfail \
+  --config configs/pe/ubuntu-1204-64mda \
+  --debug \
+  --tests tests \
+  --keyfile ~/.ssh/id_rsa-acceptance \
+  --pre-suite pre-suite \
+  --load-path lib

data/integration/test_run_scripts/all_tests-rugged-pe-ubuntu1404.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+SCRIPT_PATH=$(pwd)
+BASENAME_CMD="basename ${SCRIPT_PATH}"
+SCRIPT_BASE_PATH=`eval ${BASENAME_CMD}`
+
+if [ $SCRIPT_BASE_PATH = "test_run_scripts" ]; then
+  cd ../
+fi
+
+export pe_dist_dir=http://neptune.puppetlabs.lan/3.8/ci-ready/
+export GIT_PROVIDER=rugged
+
+beaker \
+  --preserve-hosts onfail \
+  --config configs/pe/ubuntu-1404-64mda \
+  --debug \
+  --tests tests \
+  --keyfile ~/.ssh/id_rsa-acceptance \
+  --pre-suite pre-suite \
+  --load-path lib

data/integration/test_run_scripts/all_tests-shellgit-pe-centos6.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+SCRIPT_PATH=$(pwd)
+BASENAME_CMD="basename ${SCRIPT_PATH}"
+SCRIPT_BASE_PATH=`eval ${BASENAME_CMD}`
+
+if [ $SCRIPT_BASE_PATH = "test_run_scripts" ]; then
+  cd ../
+fi
+
+export pe_dist_dir=http://neptune.puppetlabs.lan/3.8/ci-ready/
+export GIT_PROVIDER=shellgit
+
+beaker \
+  --preserve-hosts onfail \
+  --config configs/pe/centos-6-64mda \
+  --debug \
+  --tests tests \
+  --keyfile ~/.ssh/id_rsa-acceptance \
+  --pre-suite pre-suite \
+  --load-path lib