r10k 3.5.2

data/integration/lib/r10k_utils.rb

@@ -0,0 +1,222 @@
+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)
+
+  #Remove r10k cache
+  cachedir = '/var/cache/r10k'
+  on(master, "rm -rf #{cachedir}")
+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')
+  r10k_fqp = get_r10k_fqp(master)
+
+  step 'Reset Git Repo to Known Good State'
+  r10k_revert_environment(master, commit_sha, git_repo_path)
+
+  # RK-297 workaround. Without this, tests will fail with an error like the following:
+  # [2017-06-02 11:11:46 - ERROR] Object not found - no match for id (60e4ea82c9fdf86974a13f78b839a497325de04b)
+  # This cleanup should not be necessary when RK-297 has been resolved.
+  #
+  step 'Remove git directories from codedir to prevent cache errors'
+  on(master, "find #{environment_path } -name .git -type d -print0 | xargs -r0 -- rm -r")
+
+  step 'Restore Original "production" Environment'
+  on(master, "#{r10k_fqp} 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')
+  r10k_fqp = get_r10k_fqp(master)
+
+  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_fqp} deploy environment -v")
+  end
+end
+
+# Get the fully qualified path for r10k.
+#
+# ==== Arguments
+#
+# * +host+ - The Beaker host to introspect
+#
+# ==== Returns
+#
+# +string+ - The fully qualified path for r10k
+#
+# ==== Examples
+#
+# get_r10k_fqp(master)
+def get_r10k_fqp(host)
+  puppet_version = get_puppet_version(host)
+  if puppet_version < 4.0
+    fqp = '/opt/puppet/bin/r10k'
+  else
+    fqp = '/opt/puppetlabs/puppet/bin/r10k'
+  end
+  fqp
+end
+
+# Get the version of puppet that is installed on a host.
+#
+# ==== Arguments
+#
+# * +host+ - The Beaker host to introspect
+#
+# ==== Returns
+#
+# +float+ - the version of puppet as a float
+#
+# ==== Examples
+#
+# get_puppet_version(master)
+def get_puppet_version(host)
+  on(host, puppet('--version')) do |result|
+    @version =  result.stdout.match(/(\d){1}.(\d){1,2}.(\d){1,2}/)[0].to_f
+  end
+  @version
+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,6 @@
+require 'beaker-pe'
+
+test_name 'CODEMGMT-20 - C48 - Install Puppet Enterprise'
+
+step 'Install PE'
+install_pe

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

@@ -0,0 +1,48 @@
+require 'erb'
+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)
+
+local_files_root_path = ENV['FILES'] || 'files'
+git_manifest_template_path = File.join(local_files_root_path, 'pre-suite', 'git_config.pp.erb')
+git_manifest = ERB.new(File.read(git_manifest_template_path)).result(binding)
+
+step 'Get PE Version'
+pe_version = get_puppet_version(master)
+fail_test('This pre-suite requires PE 3.7 or above!') if pe_version < 3.7
+
+#Setup
+step 'Stub Forge on Master'
+stub_forge_on(master)
+
+step 'Read module path'
+on(master, puppet('config print basemodulepath')) do |result|
+  (result.stdout.include? ':') ? separator = ':' : separator = ';'
+  @module_path = result.stdout.split(separator).first
+end
+
+step 'Install "git" Module'
+on(master, puppet("module install  puppetlabs-git --modulepath #{@module_path}"))
+
+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/20_pe_r10k.rb

@@ -0,0 +1,55 @@
+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'
+r10k_fqp = get_r10k_fqp(master)
+
+step 'Get PE Version'
+pe_version = get_puppet_version(master)
+fail_test('This pre-suite requires PE 3.7 or above!') if pe_version < 3.7
+
+#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}")
+
+step 'Deploy "production" Environment via r10k'
+on(master, "#{r10k_fqp} 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/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/tests/Puppetfile/HTTP_PROXY_affects_forge_source.rb

@@ -0,0 +1,72 @@
+require 'git_utils'
+require 'r10k_utils'
+require 'master_manipulator'
+test_name 'CODEMGMT-730 - C97981 - HTTP_PROXY affects git source in puppetfile'
+
+#Init
+env_path = on(master, puppet('config print environmentpath')).stdout.rstrip
+r10k_fqp = get_r10k_fqp(master)
+
+git_repo_path = '/git_repos'
+git_repo_name = 'environments'
+git_control_remote = File.join(git_repo_path, "#{git_repo_name}.git")
+git_environments_path = '/root/environments'
+last_commit = git_last_commit(master, git_environments_path)
+git_provider = ENV['GIT_PROVIDER']
+
+r10k_config_path = get_r10k_config_file_path(master)
+r10k_config_bak_path = "#{r10k_config_path}.bak"
+
+puppetfile =<<-EOS
+mod 'puppetlabs/apache', '0.10.0'
+EOS
+
+proxy_env_value = 'http://iloveferrits.net:3219'
+
+#In-line files
+r10k_conf = <<-CONF
+proxy: 'http://ilovedogs.com:3128'
+cachedir: '/var/cache/r10k'
+git:
+  provider: '#{git_provider}'
+sources:
+  control:
+    basedir: "#{env_path}"
+    remote: "#{git_control_remote}"
+forge:
+  proxy: "http://ilovecats.net:3128"
+CONF
+
+teardown do
+  master.clear_env_var('HTTP_PROXY')
+
+  step 'Restore Original "r10k" Config'
+  on(master, "mv #{r10k_config_bak_path} #{r10k_config_path}")
+
+  step 'cleanup r10k'
+  clean_up_r10k(master, last_commit, git_environments_path)
+end
+
+master.add_env_var('HTTP_PROXY', proxy_env_value)
+
+step 'Backup Current "r10k" Config'
+on(master, "mv #{r10k_config_path} #{r10k_config_bak_path}")
+
+step 'Update the "r10k" Config'
+create_remote_file(master, r10k_config_path, r10k_conf)
+
+step 'Checkout "production" Branch'
+git_on(master, 'checkout production', git_environments_path)
+
+step 'Copy Puppetfile to "production" Environment Git Repo'
+create_remote_file(master, "#{git_environments_path}/Puppetfile", puppetfile)
+
+step 'Push Changes'
+git_add_commit_push(master, 'production', 'add Puppetfile', git_environments_path)
+
+#test
+on(master, "#{r10k_fqp} deploy environment -p", :accept_all_exit_codes => true) do |r|
+  regex = /using proxy http:\/\/ilovecats\.net:3128/i
+  assert(r.exit_code == 1, 'expected error code was not observed')
+  assert_match(regex, r.stderr, 'The expected error message was not observed' )
+end

data/integration/tests/Puppetfile/HTTP_PROXY_affects_git_source.rb

@@ -0,0 +1,70 @@
+require 'git_utils'
+require 'r10k_utils'
+require 'master_manipulator'
+test_name 'CODEMGMT-730 - C97982 - HTTP_PROXY affects git source in puppetfile'
+
+#Init
+env_path = on(master, puppet('config print environmentpath')).stdout.rstrip
+r10k_fqp = get_r10k_fqp(master)
+
+git_repo_path = '/git_repos'
+git_repo_name = 'environments'
+git_control_remote = File.join(git_repo_path, "#{git_repo_name}.git")
+git_environments_path = '/root/environments'
+last_commit = git_last_commit(master, git_environments_path)
+git_provider = ENV['GIT_PROVIDER']
+
+r10k_config_path = get_r10k_config_file_path(master)
+r10k_config_bak_path = "#{r10k_config_path}.bak"
+
+puppetfile =<<-EOS
+mod 'motd',
+  :git    => 'https://github.com/puppetlabs/puppetlabs-motd'
+EOS
+
+proxy_env_value = 'http://ferritsarebest.net:3219'
+
+#In-line files
+r10k_conf = <<-CONF
+cachedir: '/var/cache/r10k'
+git:
+  provider: '#{git_provider}'
+sources:
+  control:
+    basedir: "#{env_path}"
+    remote: "#{git_control_remote}"
+CONF
+
+teardown do
+  master.clear_env_var('HTTP_PROXY')
+
+  step 'Restore Original "r10k" Config'
+  on(master, "mv #{r10k_config_bak_path} #{r10k_config_path}")
+
+  step 'cleanup r10k'
+  clean_up_r10k(master, last_commit, git_environments_path)
+end
+
+master.add_env_var('HTTP_PROXY', proxy_env_value)
+
+step 'Backup Current "r10k" Config'
+on(master, "mv #{r10k_config_path} #{r10k_config_bak_path}")
+
+step 'Update the "r10k" Config'
+create_remote_file(master, r10k_config_path, r10k_conf)
+
+step 'Checkout "production" Branch'
+git_on(master, 'checkout production', git_environments_path)
+
+step 'Copy Puppetfile to "production" Environment Git Repo'
+create_remote_file(master, "#{git_environments_path}/Puppetfile", puppetfile)
+
+step 'Push Changes'
+git_add_commit_push(master, 'production', 'add Puppetfile', git_environments_path)
+
+#test
+on(master, "#{r10k_fqp} deploy environment -p", :accept_all_exit_codes => true) do |r|
+  regex = /(Couldn't|Could not) resolve proxy.*ferritsarebest\.net/i
+  assert(r.exit_code == 1, 'expected error code was not observed')
+  assert_match(regex, r.stderr, 'The expected error message was not observed' )
+end