akerl-r10k 3.14.2.1

data/docker/r10k/release.Dockerfile

@@ -0,0 +1,55 @@
+ARG alpine_version=3.14
+FROM alpine:${alpine_version}
+
+ARG vcs_ref
+ARG build_date
+ARG version="3.1.0"
+# Used by entrypoint to submit metrics to Google Analytics.
+# Published images should use "production" for this build_arg.
+ARG pupperware_analytics_stream="dev"
+# required to schedule runs of "r10k" in K8s
+ARG supercronic_version="0.1.9"
+ARG supercronic_sha1sum="5ddf8ea26b56d4a7ff6faecdd8966610d5cb9d85"
+ARG supercronic="supercronic-linux-amd64"
+ARG supercronic_url="https://github.com/aptible/supercronic/releases/download/v$supercronic_version/$supercronic"
+
+LABEL org.label-schema.maintainer="Puppet Release Team <release@puppet.com>" \
+      org.label-schema.vendor="Puppet" \
+      org.label-schema.url="https://github.com/puppetlabs/r10k" \
+      org.label-schema.name="r10k" \
+      org.label-schema.license="Apache-2.0" \
+      org.label-schema.vcs-url="https://github.com/puppetlabs/r10k" \
+      org.label-schema.schema-version="1.0" \
+      org.label-schema.dockerfile="/release.Dockerfile"
+
+COPY adduser.sh docker-entrypoint.sh /
+COPY docker-entrypoint.d /docker-entrypoint.d
+
+ENTRYPOINT ["/docker-entrypoint.sh"]
+CMD ["help"]
+
+# dyanmic LABELs and ENV vars placed lower for the sake of Docker layer caching
+ENV PUPPERWARE_ANALYTICS_STREAM="$pupperware_analytics_stream"
+
+LABEL org.label-schema.version="$version" \
+      org.label-schema.vcs-ref="$vcs_ref" \
+      org.label-schema.build-date="$build_date"
+
+SHELL ["/bin/ash", "-eo", "pipefail", "-c"]
+# ignore apk and gem pinning
+# hadolint ignore=DL3018,DL3028
+RUN chmod a+x /adduser.sh /docker-entrypoint.sh /docker-entrypoint.d/*.sh && \
+    /adduser.sh && \
+    chown -R puppet: /docker-entrypoint.d /docker-entrypoint.sh && \
+    apk add --no-cache ruby openssh-client git ruby-rugged curl ruby-dev make gcc musl-dev && \
+    gem install --no-doc r10k:"$version" json etc && \
+    curl --fail --silent --show-error --location --remote-name "$supercronic_url" && \
+    echo "${supercronic_sha1sum}  ${supercronic}" | sha1sum -c - && \
+    chmod +x "$supercronic" && \
+    mv "$supercronic" "/usr/local/bin/${supercronic}" && \
+    ln -s "/usr/local/bin/${supercronic}" /usr/local/bin/supercronic
+
+USER puppet
+WORKDIR /home/puppet
+
+COPY release.Dockerfile /

data/docker/spec/dockerfile_spec.rb

@@ -0,0 +1,37 @@
+require 'rspec/core'
+require 'fileutils'
+require 'open3'
+include Pupperware::SpecHelpers
+
+ENV['SPEC_DIRECTORY'] = File.dirname(__FILE__)
+# unifies volume naming
+ENV['COMPOSE_PROJECT_NAME'] ||= 'r10k'
+
+RSpec.configure do |c|
+  c.before(:suite) do
+    ENV['R10K_IMAGE'] = require_test_image
+    pull_images(['r10k_check','r10k_install'])
+    teardown_cluster()
+    # no certs to preload, but if the suite adds puppetserver, be explicit
+    docker_compose_up(preload_certs: true)
+  end
+
+  c.after(:suite) do
+    teardown_cluster()
+    FileUtils.rm_rf(File.join(ENV['SPEC_DIRECTORY'], 'fixtures', 'modules'))
+  end
+end
+
+describe 'r10k container' do
+  {
+    'r10k_check': 'validate',
+    'r10k_install': 'install',
+  }.each do |container, op|
+    it "should #{op} the Puppetfile" do
+      container = get_service_container(container)
+      wait_on_container_exit(container)
+      expect(get_container_exit_code(container)).to eq(0)
+      emit_log(container)
+    end
+  end
+end

data/docker/spec/fixtures/Puppetfile

@@ -0,0 +1,2 @@
+moduledir '/tmp/modules'
+mod 'puppetlabs/ntp'

data/integration/Gemfile

@@ -0,0 +1,19 @@
+source ENV['GEM_SOURCE'] || 'https://artifactory.delivery.puppetlabs.net/artifactory/api/gems/rubygems/'
+
+def location_for(place, fake_version = nil)
+  if place =~ /^(git:[^#]*)#(.*)/
+    [fake_version, { :git => $1, :branch => $2, :require => false }].compact
+  elsif place =~ /^file:\/\/(.*)/
+    ['>= 0', { :path => File.expand_path($1), :require => false }]
+  else
+    [place, { :require => false }]
+  end
+end
+
+gem 'beaker', *location_for(ENV['BEAKER_VERSION'] || '~> 4.5')
+gem 'beaker-pe', '~> 2.0'
+gem 'beaker-answers'
+gem 'beaker-hostgenerator', *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION'] || '~> 1.1')
+gem 'beaker-abs', *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 0.4')
+gem 'rototiller', '= 0.1.0'
+gem 'beaker-qa-i18n'

data/integration/README.mkd

@@ -0,0 +1,29 @@
+Integration Tests
+===========================
+
+This folder contains integration tests for the r10k project. These tests were originally written by the QA team
+at Puppet Labs and is actively maintained by the QA team. Feel free to contribute tests to this folder as long
+as they are written with [Beaker](https://github.com/puppetlabs/beaker) and follow the guidelines
+below.
+
+## Integration?
+
+The r10k project already contains RSpec tests and you might be wondering why there is a need to have a set of
+tests separate from those tests. At Puppet Labs we define an "integration" test as:
+
+> Validating the system state and/or side effects while completing a complete life cycle of user stories using a
+> system. This type of test crosses the boundary of a discrete tool in the process of testing a defined user
+> objective that utilizes a system composed of integrated components.
+
+What this means for this project is that we will install and configure all infrastructure needed in a real-world
+r10k environment.
+
+## Running Tests
+
+Included in this folder under the "test_run_scripts" sub-folder are simple Bash scripts that will run suites of
+Beaker tests. This scripts utilize environment variables for specifying test infrastructure. For security
+reasons we do not provide examples from the Puppet Labs testing environment.
+
+## Documentation
+
+Each sub-folder contains a "README.mdk" that describes the content found in the sub-folder.

data/integration/Rakefile

@@ -0,0 +1,79 @@
+require 'rototiller'
+require 'fileutils'
+
+namespace :ci do
+  namespace :test do
+
+    desc 'Tests at the component level for the pe-r10k project'
+    task :component => [:check_pe_r10k_env_vars] do
+      Rake::Task[:beaker].invoke
+    end
+  end
+end
+
+desc 'Run tests against a packaged PE build'
+task :acceptance do
+  @acceptance_pre_suite = 'pre-suite'
+  Rake::Task[:beaker].invoke
+end
+
+desc 'The acceptance tests for r10k, run in the beaker framework'
+rototiller_task :beaker => [:beaker_hostgenerator] do |t|
+
+  common_setup = <<-EOS
+pre-suite/00_pe_install.rb,
+component/pre-suite/05_install_dev_r10k.rb,
+pre-suite/10_git_config.rb,
+pre-suite/20_pe_r10k.rb,
+EOS
+  common_setup.gsub!("\n", '')
+
+  flags = [
+      {:name => '--hosts', :default => 'configs/generated', :override_env => 'BEAKER_HOST'},
+      {:name => '--keyfile', :default => "#{ENV['HOME']}/.ssh/id_rsa-acceptance", :override_env => 'BEAKER_KEYFILE'},
+      {:name => '--load-path', :default => 'lib'},
+      {:name => '--pre-suite', :default => @acceptance_pre_suite || common_setup, :override_env => 'BEAKER_PRE_SUITE'},
+      {:name => '--tests', :default => 'tests', :override_env => 'BEAKER_TESTS'},
+      {:name => '--preserve-hosts', :default => 'onfail', :override_env => 'BEAKER_PRESERVE_HOSTS'},
+  ]
+  t.add_flag(*flags)
+
+  t.add_env do |env|
+    env.name = 'PE_FAMILY'
+    env.message = 'The puppet enterprise major branch to install from'
+  end
+
+  t.add_env do |env|
+    env.name = 'pe_dist_dir'
+    env.message = 'The location to download PE from, for example "https://artifactory.delivery.puppetlabs.net/artifactory/generic_enterprise__local/20XX.X/ci-ready"'
+    ENV['pe_dist_dir'] ||= "https://artifactory.delivery.puppetlabs.net/artifactory/generic_enterprise__local/#{ENV['PE_FAMILY']}/ci-ready"
+  end
+
+  t.add_env do |env|
+    env.name = 'GIT_PROVIDER'
+    env.message = 'The git provider that r10k should use on a SUT'
+  end
+
+  t.add_command({:name => 'beaker --debug', :override_env => 'BEAKER_EXECUTABLE'})
+end
+
+desc 'Generate a host configuration used by Beaker'
+rototiller_task :beaker_hostgenerator do |t|
+  if ENV['BEAKER_HOST'].nil?
+    FileUtils.mkdir_p 'configs'
+    t.add_command do |c|
+      c.name = 'beaker-hostgenerator'
+      c.argument = '> configs/generated'
+    end
+
+    # This is a hack :(
+    t.add_flag(:name => '', :default => 'centos7-64mdca-64.fa', :override_env => 'TEST_TARGET')
+
+    t.add_flag(:name => '--global-config', :default => '{forge_host=forge-aio01-petest.puppetlabs.com}', :override_env => 'BHG_GLOBAL_CONFIG')
+  end
+end
+
+rototiller_task :check_pe_r10k_env_vars do |t|
+  t.add_env(:name => 'SHA', :message => 'The sha for pe-r10k')
+end
+

data/integration/component/pre-suite/05_install_dev_r10k.rb

@@ -0,0 +1,12 @@
+test_name "Install PE r10k" do
+
+  step "Install PE r10k" do
+    variant, version, arch, codename = master['platform'].to_array
+    if variant == 'ubuntu' && version.split('.').first.to_i >= 18
+      on master, "echo 'Acquire::AllowInsecureRepositories \"true\";' > /etc/apt/apt.conf.d/90insecure"
+    end
+
+    install_dev_repos_on('pe-r10k', master, ENV['SHA'], '/tmp/repo_configs', {:dev_builds_url => 'http://builds.delivery.puppetlabs.net'})
+    master.install_package('pe-r10k')
+  end
+end

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/git_config.pp.erb

@@ -0,0 +1,19 @@
+$git_package = $osfamily ? {
+  'Debian' => 'git-core',
+  default  => 'git'
+}
+class { 'git':
+  package_name => $git_package
+}
+->
+git::config { 'user.name':
+  value => 'Tester',
+}
+->
+git::config { 'user.email':
+  value => 'tester@puppetlabs.com',
+}
+->
+file { '<%= git_repo_path %>':
+  ensure => directory
+}

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