r10k 1.4.2 → 1.5.1

data/integration/files/README.mkd

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

data/integration/files/hiera.yaml

@@ -0,0 +1,8 @@
+---
+:backends:
+  - yaml
+:hierarchy:
+  - "%{environment}"
+
+:yaml:
+  :datadir: "/etc/puppetlabs/puppet/environments/%{environment}/hiera"

data/integration/files/modules/helloworld/manifests/init.pp

@@ -0,0 +1,3 @@
+class helloworld {
+  notify { "Hello world!": message => "I am in the ${environment} environment"}
+}

data/integration/files/modules/hieratest/manifests/init.pp

@@ -0,0 +1,3 @@
+class hieratest ($hiera_message = "default text") {
+  notify { "Hiera test!": message => $hiera_message}
+}

data/integration/files/modules/unicode/files/pretend_unicode

@@ -0,0 +1 @@
+Ha ha ha! I am in Korean!

data/integration/files/modules/unicode/manifests/init.pp

@@ -0,0 +1,6 @@
+class unicode {
+  file { '/tmp/unicode.file':
+    ensure => file,
+    source => "puppet:///modules/unicode/굢챣샃뻧븣럩윕컾뾐깩"
+  }
+}

data/integration/files/pre-suite/prod_env.config

@@ -0,0 +1,3 @@
+# Puppet Enterprise requires $basemodulepath
+modulepath = site:dist:modules:$basemodulepath
+manifest   = manifests/site.pp

data/integration/files/r10k_conf.yaml.erb

@@ -0,0 +1,9 @@
+cachedir: '/var/cache/r10k'
+git:
+  provider: '<%= git_provider %>'
+sources:
+  <% for source in sources %>
+    <%= source.repo_name %>:
+      basedir: "<%= env_path %>"
+      remote: "<%= source.control_remote %>"
+  <% end %>

data/integration/lib/README.mkd

@@ -0,0 +1,4 @@
+Lib
+===========================
+
+This folder contains Ruby files that extends Beaker.

data/integration/lib/git_utils.rb

@@ -0,0 +1,205 @@
+# Execute a git command on a host.
+#
+# ==== Attributes
+#
+# * +host+ - One or more hosts to act upon, or a role (String or Symbol) that identifies one or more hosts.
+# * +git_sub_command+ - The git sub-command to execute including arguments. (The 'git' command is assumed.)
+# * +git_repo_path+ - The path to the git repository on the target host.
+# * +opts+ - Options to alter execution.
+#
+# ==== Returns
+#
+# +nil+
+#
+# ==== Examples
+#
+# git_on(master, 'add file.txt', '~/git_repo')
+def git_on(host, git_sub_command, git_repo_path, opts = {})
+  git_command = "git --git-dir=#{git_repo_path}/.git --work-tree=#{git_repo_path} #{git_sub_command}"
+
+  on(host, git_command, opts)
+end
+
+# Add all uncommitted files located in a repository.
+#
+# ==== Attributes
+#
+# * +host+ - One or more hosts to act upon, or a role (String or Symbol) that identifies one or more hosts.
+# * +git_repo_path+ - The path to the git repository on the target host.
+#
+# ==== Returns
+#
+# +nil+
+#
+# ==== Examples
+#
+# git_add_everything(master, '~/git_repo')
+def git_add_everything(host, git_repo_path)
+  git_on(host, "add #{git_repo_path}/*", git_repo_path)
+end
+
+# Push branch to origin remote.
+#
+# ==== Attributes
+#
+# * +host+ - One or more hosts to act upon, or a role (String or Symbol) that identifies one or more hosts.
+# * +branch+ - The branch to push.
+# * +git_repo_path+ - The path to the git repository on the target host.
+#
+# ==== Returns
+#
+# +nil+
+#
+# ==== Examples
+#
+# git_push(master, 'production', '~/git_repo')
+def git_push(host, branch, git_repo_path)
+  git_on(host, "push origin #{branch}", git_repo_path)
+end
+
+# Commit changes and push branch to origin remote.
+#
+# ==== Attributes
+#
+# * +host+ - One or more hosts to act upon, or a role (String or Symbol) that identifies one or more hosts.
+# * +branch+ - The branch to push.
+# * +message+ - A single-line commit message. (Don't quote message!)
+# * +git_repo_path+ - The path to the git repository on the target host.
+#
+# ==== Returns
+#
+# +nil+
+#
+# ==== Examples
+#
+# git_commit_push(master, 'production', 'Awesome stuff!', '~/git_repo')
+def git_commit_push(host, branch, message, git_repo_path)
+  git_on(host, "commit -m \"#{message}\"", git_repo_path)
+  git_push(host, branch, git_repo_path)
+end
+
+# Add all uncommitted files located in a repository, commit changes and push branch to origin remote.
+#
+# ==== Attributes
+#
+# * +host+ - One or more hosts to act upon, or a role (String or Symbol) that identifies one or more hosts.
+# * +branch+ - The branch to push.
+# * +message+ - A single-line commit message. (Don't quote message!)
+# * +git_repo_path+ - The path to the git repository on the target host.
+#
+# ==== Returns
+#
+# +nil+
+#
+# ==== Examples
+#
+# git_add_commit_push(master, 'production', 'Awesome stuff!', '~/git_repo')
+def git_add_commit_push(host, branch, message, git_repo_path)
+  git_add_everything(host, git_repo_path)
+  git_commit_push(host, branch, message, git_repo_path)
+end
+
+# Get the last commit SHA.
+#
+# ==== Attributes
+#
+# * +host+ - One or more hosts to act upon, or a role (String or Symbol) that identifies one or more hosts.
+# * +git_repo_path+ - The path to the git repository on the target host.
+#
+# ==== Returns
+#
+# +string+ - The SHA of the last commit.
+#
+# ==== Examples
+#
+# last_commit = git_last_commit(master, '~/git_repo')
+def git_last_commit(host, git_repo_path)
+  sha_regex = /commit (\w{40})/
+
+  return sha_regex.match(git_on(host, 'log', git_repo_path).stdout)[1]
+end
+
+# Hard reset the git repository to a specific commit.
+#
+# ==== 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 HEAD to this commit SHA.
+# * +git_repo_path+ - The path to the git repository on the target host.
+#
+# ==== Returns
+#
+# +nil+
+#
+# ==== Examples
+#
+# git_reset_hard(master, 'ff81c01c5', '~/git_repo')
+def git_reset_hard(host, commit_sha, git_repo_path)
+  git_on(host, "reset --hard #{commit_sha}", git_repo_path)
+end
+
+# Create a bare Git repository.
+#
+# ==== Attributes
+#
+# * +host+ - The Puppet host on which to create a bare git repo.
+# * +git_repo_parent_path+ - The parent path that contains the desired Git repository.
+# * +git_repo_name+ - The name of the repository.
+#
+# ==== Returns
+#
+# +string+ - The path to the newly created Git repository.
+#
+# ==== Examples
+#
+# git_init_bare_repo(master, '/git/repos', 'environments')
+def git_init_bare_repo(host, git_repo_parent_path, git_repo_name)
+  #Init
+  git_repo_path = File.join(git_repo_parent_path, "#{git_repo_name}.git")
+
+  #Initialize bare Git repository
+  on(host, "mkdir -p #{git_repo_path}")
+  on(host, "git init --bare #{git_repo_path}")
+
+  return git_repo_path
+end
+
+# Clone a Git repository.
+#
+# ==== Attributes
+#
+# * +host+ - The Puppet host on which to create a bare git repo.
+# * +git_clone_path+ - The destination path for the git clone.
+# * +git_source+ - The origin from which to clone.
+#
+# ==== Returns
+#
+# +nil+
+#
+# ==== Examples
+#
+# git_clone_repo(master, '~/repos/r10k', '/git/repos/environments.git')
+def git_clone_repo(host, git_clone_path, git_source)
+  on(host, "git clone #{git_source} #{git_clone_path}")
+end
+
+# Create a bare Git repository and then clone the repository.
+#
+# ==== Attributes
+#
+# * +host+ - The Puppet host on which to create a bare git repo.
+# * +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.
+#
+# ==== Returns
+#
+# +string+ - The path to the newly created Git repository.
+#
+# ==== Examples
+#
+# git_init_bare_repo_and_clone(master, '/git/repos', 'environments', '~/repos/r10k')
+def git_init_bare_repo_and_clone(host, git_repo_parent_path, git_repo_name, git_clone_path)
+  origin_git_repo_path = git_init_bare_repo(host, git_repo_parent_path, git_repo_name)
+  git_clone_repo(host, git_clone_path, origin_git_repo_path)
+end

data/integration/lib/master_manipulator.rb

@@ -0,0 +1,205 @@
+# Create a "site.pp" file with file bucket enabled. Also, allow
+# the creation of a custom node definition or use the 'default'
+# node definition.
+#
+# ==== Attributes
+#
+# * +master_certname+ - Certificate name of Puppet master.
+# * +manifest+ - A Puppet manifest to inject into the node definition.
+# * +node_def_name+ - A node definition pattern or name.
+#
+# ==== Returns
+#
+# +string+ - A combined manifest with node definition containing input manifest
+#
+# ==== Examples
+#
+# site_pp = create_site_pp("puppetmaster", '', node_def_name='agent')
+def create_site_pp(master_certname, manifest='', node_def_name='default')
+  default_def = <<-MANIFEST
+node default {
+}
+MANIFEST
+
+  node_def = <<-MANIFEST
+node #{node_def_name} {
+
+#{manifest}
+}
+MANIFEST
+
+  if node_def_name != 'default'
+    node_def = "#{default_def}\n#{node_def}"
+  end
+
+  site_pp = <<-MANIFEST
+filebucket { 'main':
+  server => '#{master_certname}',
+  path   => false,
+}
+
+File { backup => 'main' }
+
+#{node_def}
+MANIFEST
+
+  return site_pp
+end
+
+# Read a Puppet manifest file and inject the content into a
+# "default" node definition. (Used mostly to overide site.pp)
+#
+# ==== Attributes
+#
+# * +manifest_path+ - The file path to target manifest.
+# * +master_certname+ - Certificate name of Puppet master.
+#
+# ==== Returns
+#
+# +string+ - A combined manifest with node definition containg input manifest
+#
+# ==== Examples
+#
+# site_pp = create_node_manifest("/tmp/test.pp", "master")
+def create_node_manifest(manifest_path, master_certname, node_def_name='default')
+  manifest = File.read(manifest_path)
+
+  site_pp = <<-MANIFEST
+filebucket { 'main':
+  server => '#{master_certname}',
+  path   => false,
+}
+
+File { backup => 'main' }
+
+node default {
+
+#{manifest}
+}
+MANIFEST
+
+  return site_pp
+end
+
+# Set mode, owner and group on a remote path.
+#
+# ==== Attributes
+#
+# * +host+ - The remote host containing the target path.
+# * +path+ - The path to set mode, user and group upon.
+# * +mode+ - The desired mode to set on the path in as a string.
+# * +owner+ - The owner to set on the path. (Puppet user if not specified.)
+# * +group+ - The group to set on the path. (Puppet group if not specified.)
+#
+# ==== Returns
+#
+# nil
+#
+# ==== Examples
+#
+# set_perms_on_remote(master, "/tmp/test/site.pp", "777")
+def set_perms_on_remote(host, path, mode, owner=nil, group=nil)
+  if (owner.nil?)
+    owner = on(host, puppet('config', 'print', 'user')).stdout.rstrip
+  end
+
+  if (group.nil?)
+    group = on(host, puppet('config', 'print', 'group')).stdout.rstrip
+  end
+
+  on(host, "chmod -R #{mode} #{path}")
+  on(host, "chown -R #{owner}:#{group} #{path}")
+end
+
+# Inject temporary "site.pp" onto target host. This will also create
+# a "modules" folder in the target remote directory.
+#
+# ==== Attributes
+#
+# * +master+ - The target master for injection.
+# * +site_pp_path+ - A path on the remote host into which the site.pp will be injected.
+# * +manifest+ - The manifest content to inject into "site.pp" to the host target path.
+#
+# ==== Returns
+#
+# nil
+#
+# ==== Examples
+#
+# site_pp = inject_site_pp(master, "/tmp/test/site.pp", manifest)
+def inject_site_pp(master, site_pp_path, manifest)
+  site_pp_dir = File.dirname(site_pp_path)
+  create_remote_file(master, site_pp_path, manifest)
+
+  set_perms_on_remote(master, site_pp_dir, "777")
+end
+
+# Create a temporary directory environment and inject a "site.pp" for the target environment.
+#
+# ==== Attributes
+#
+# * +master+ - The master on which to create a new Puppet environment.
+# * +env_root_path+ - The base path on the master that contains all environments.
+# * +env_seed_name+ - The seed name to use for generating an environment name.
+# * +manifest+ - The manifest content to inject into "site.pp" of the newly created environment.
+#
+# ==== Returns
+#
+# +string+ - The environment name that was generated.
+#
+# ==== Examples
+#
+# temp_env_name = create_temp_dir_env(master, "/tmp/test/site.pp", "stuff", manifest)
+def create_temp_dir_env(master, env_root_path, env_seed_name, manifest)
+  env_name = "#{env_seed_name}" + rand(36**16).to_s(36)
+  env_path = "#{env_root_path}/#{env_name}"
+  env_site_pp_path = "#{env_path}/manifests/site.pp"
+
+  on(master, "mkdir -p #{env_path}/manifests #{env_path}/modules")
+  set_perms_on_remote(master, env_path, "777")
+
+  inject_site_pp(master, env_site_pp_path, manifest)
+
+  return env_name
+end
+
+# Restart the puppet server and wait for it to come back up
+# ==== Attributes
+# *+host+ - the host that this should operate on
+# *+opts+ - an options hash - not required
+#   *+:timeout+ - the amount of time in seconds to wait for success
+#   *+:frequency+ - The time to wait between retries
+#
+# Raises a standard error if the wait is uncessfull
+#
+# ==== Example
+# restart_puppet_server(master)
+# restart_puppet_server(master, {:time_out => 200, :frequency => 10})
+def restart_puppet_server(host, opts = {})
+
+  on(host, "puppet resource service pe-puppetserver ensure=stopped")
+  on(host, "puppet resource service pe-puppetserver ensure=running")
+  masterHostName = on(host, "hostname").stdout.chomp
+  opts[:time_out] ||= 100
+  opts[:frequency] ||= 5
+  i = 0
+
+  # -k to ignore HTTPS error that isn't relevant to us
+  curl_call = "-I -k https://#{masterHostName}:8140/production/certificate_statuses/all"
+
+  while i < opts[:time_out] do
+    sleep opts[:frequency]
+    i += 1
+    exit_code = curl_on(host, curl_call, :acceptable_exit_codes => [0,1,7]).exit_code
+
+    # Exit code 7 is "connection refused"
+    if exit_code != '7'
+      sleep 20
+      puts 'Restarting the Puppet Server was successful!'
+      return
+    end
+  end
+
+  raise StandardError, 'Attempting to restart the puppet server was not successful in the time alloted.'
+
+end