r10k 3.5.2

data/docker/.gitignore

@@ -0,0 +1 @@
+TEST-rspec.xml

data/docker/.rspec

@@ -0,0 +1,4 @@
+--require pupperware/spec_helper
+--format RspecJunitFormatter
+--out TEST-rspec.xml
+--format documentation

data/docker/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gem 'pupperware',
+    :git => 'https://github.com/puppetlabs/pupperware.git',
+    :branch => 'master',
+    :glob => 'gem/*.gemspec'
+
+group :test do
+    gem 'rspec'
+    gem 'rspec_junit_formatter'
+end

data/docker/Makefile

@@ -0,0 +1,89 @@
+PUPPERWARE_ANALYTICS_STREAM ?= dev
+NAMESPACE ?= puppet
+git_describe = $(shell git describe --tags)
+vcs_ref := $(shell git rev-parse HEAD)
+build_date := $(shell date -u +%FT%T)
+hadolint_available := $(shell hadolint --help > /dev/null 2>&1; echo $$?)
+hadolint_command := hadolint
+hadolint_container := hadolint/hadolint:latest
+export BUNDLE_PATH = $(PWD)/.bundle/gems
+export BUNDLE_BIN = $(PWD)/.bundle/bin
+export GEMFILE = $(PWD)/Gemfile
+export DOCKER_BUILDKIT = 1
+
+ifeq ($(IS_RELEASE),true)
+	VERSION ?= $(shell echo $(git_describe) | sed 's/-.*//')
+	PUBLISHED_VERSION ?= $(shell curl --silent 'https://rubygems.org/api/v1/gems/r10k.json' | jq '."version"' | tr -d '"')
+	CONTAINER_EXISTS = $(shell DOCKER_CLI_EXPERIMENTAL=enabled docker manifest inspect $(NAMESPACE)/r10k:$(VERSION) > /dev/null 2>&1; echo $$?)
+ifeq ($(CONTAINER_EXISTS),0)
+	SKIP_BUILD ?= true
+else ifneq ($(VERSION),$(PUBLISHED_VERSION))
+	SKIP_BUILD ?= true
+endif
+
+	LATEST_VERSION ?= latest
+	dockerfile := release.Dockerfile
+	dockerfile_context := r10k
+else
+	VERSION ?= edge
+	IS_LATEST := false
+	dockerfile := Dockerfile
+	dockerfile_context := $(PWD)/..
+endif
+
+prep:
+	@git fetch --unshallow 2> /dev/null ||:
+	@git fetch origin 'refs/tags/*:refs/tags/*'
+ifeq ($(SKIP_BUILD),true)
+	@echo "SKIP_BUILD is true, exiting with 1"
+	@exit 1
+endif
+
+lint:
+ifeq ($(hadolint_available),0)
+	@$(hadolint_command) r10k/$(dockerfile)
+else
+	@docker pull $(hadolint_container)
+	@docker run --rm -v $(PWD)/r10k/$(dockerfile):/Dockerfile -i $(hadolint_container) $(hadolint_command) Dockerfile
+endif
+
+build: prep
+	docker build \
+		${DOCKER_BUILD_FLAGS} \
+		--pull \
+		--build-arg vcs_ref=$(vcs_ref) \
+		--build-arg build_date=$(build_date) \
+		--build-arg version=$(VERSION) \
+		--build-arg pupperware_analytics_stream=$(PUPPERWARE_ANALYTICS_STREAM) \
+		--file r10k/$(dockerfile) \
+		--tag $(NAMESPACE)/r10k:$(VERSION) $(dockerfile_context)
+ifeq ($(IS_LATEST),true)
+	@docker tag $(NAMESPACE)/r10k:$(VERSION) puppet/r10k:$(LATEST_VERSION)
+endif
+
+test: prep
+	@bundle install --path $$BUNDLE_PATH --gemfile $$GEMFILE --with test
+	@bundle update
+	@PUPPET_TEST_DOCKER_IMAGE=$(NAMESPACE)/r10k:$(VERSION) \
+		bundle exec --gemfile $$GEMFILE \
+		rspec spec
+
+push-image: prep
+	@docker push $(NAMESPACE)/r10k:$(VERSION)
+ifeq ($(IS_LATEST),true)
+	@docker push $(NAMESPACE)/r10k:$(LATEST_VERSION)
+endif
+
+push-readme:
+	@docker pull sheogorath/readme-to-dockerhub
+	@docker run --rm \
+		-v $(PWD)/README.md:/data/README.md \
+		-e DOCKERHUB_USERNAME="$(DOCKERHUB_USERNAME)" \
+		-e DOCKERHUB_PASSWORD="$(DOCKERHUB_PASSWORD)" \
+		-e DOCKERHUB_REPO_PREFIX=puppet \
+		-e DOCKERHUB_REPO_NAME=r10k \
+		sheogorath/readme-to-dockerhub
+
+publish: push-image push-readme
+
+.PHONY: lint build test prep publish push-image push-readme

data/docker/README.md

@@ -0,0 +1,28 @@
+# [puppetlabs/r10k](https://github.com/puppetlabs/r10k)
+
+r10k on a Docker image. Based on Alpine 3.8.
+
+## Configuration
+
+The following environment variables are supported:
+
+- `PUPPERWARE_ANALYTICS_ENABLED`
+
+  Set to 'true' to enable Google Analytics metrics. Defaults to 'false'.
+
+## Analytics Data Collection
+
+The r10k container collects usage data. This is disabled by default. You can enable it by passing `--env PUPPERWARE_ANALYTICS_ENABLED=true`
+to your `docker run` command.
+
+### What data is collected?
+* Version of the r10k container.
+* Anonymized IP address is used by Google Analytics for Geolocation data, but the IP address is not collected.
+
+### Why does the r10k container collect data?
+
+We collect data to help us understand how the containers are used and make decisions about upcoming changes.
+
+### How can I opt out of r10k container data collection?
+
+This is disabled by default.

data/docker/r10k/Dockerfile

@@ -0,0 +1,67 @@
+FROM alpine:3.9 as build
+
+# hadolint ignore=DL3018
+RUN apk add --no-cache ruby git && \
+    mkdir /workspace
+WORKDIR /workspace
+COPY . /workspace
+RUN gem build r10k.gemspec && \
+    mv r10k*.gem r10k.gem
+
+FROM alpine:3.9
+
+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="/Dockerfile"
+
+COPY docker/r10k/adduser.sh docker/r10k/docker-entrypoint.sh /
+COPY docker/r10k/docker-entrypoint.d /docker-entrypoint.d
+
+ENTRYPOINT ["/docker-entrypoint.sh"]
+CMD ["help"]
+
+# dynamic 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"
+
+COPY --from=build /workspace/r10k.gem /
+SHELL ["/bin/ash", "-eo", "pipefail", "-c"]
+# ignore apk and gem pinning
+# hadolint ignore=DL3018,DL3028
+RUN chmod a+x /adduser.sh /docker-entrypoint.sh && \
+# Add a puppet user to run r10k as for consistency with puppetserver
+    /adduser.sh && \
+    chown -R puppet: /docker-entrypoint.d /docker-entrypoint.sh && \
+    apk add --no-cache ruby openssh-client git ruby-rugged curl ruby-json ruby-etc && \
+    gem install --no-doc /r10k.gem && \
+    rm -f /r10k.gem && \
+    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 docker/r10k/Dockerfile /

data/docker/r10k/adduser.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+getent_string="$(getent group | grep -e ':999$')"
+exit_code=$?
+
+if [ "$exit_code" = '0' ]; then
+  group="$(echo $getent_string | cut -d ':' -f1)"
+else
+  addgroup -g 999 puppet
+  group='puppet'
+fi
+
+adduser -G $group -D -u 999 puppet

data/docker/r10k/docker-entrypoint.d/10-analytics.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+
+if [ "${PUPPERWARE_ANALYTICS_ENABLED}" != "true" ]; then
+    # Don't print out any messages here since this is a CLI container
+    exit 0
+fi
+
+# See: https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
+# Tracking ID
+tid=UA-132486246-5
+# Application Name
+an=r10k
+# Application Version
+av=$(r10k version | cut -d ' ' -f 2)
+# Anonymous Client ID
+_file=/var/tmp/pwclientid
+cid=$(cat $_file 2>/dev/null || (cat /proc/sys/kernel/random/uuid | tee $_file))
+# Event Category
+ec=${PUPPERWARE_ANALYTICS_STREAM:-dev}
+# Event Action
+ea=start
+# Anonymize ip
+aip=1
+
+_params="v=1&t=event&tid=${tid}&an=${an}&av=${av}&cid=${cid}&ec=${ec}&ea=${ea}&aip=${aip}"
+_url="http://www.google-analytics.com/collect?${_params}"
+
+# Don't print out any messages here since this is a CLI container
+curl --fail --silent --show-error --output /dev/null \
+    -X POST -H "Content-Length: 0" $_url

data/docker/r10k/docker-entrypoint.sh

@@ -0,0 +1,11 @@
+#! /bin/sh
+
+set -e
+
+for f in /docker-entrypoint.d/*.sh; do
+  # Don't print out any messages here since this is a CLI container
+  chmod +x "$f"
+  "$f"
+done
+
+exec /usr/bin/r10k "$@"

data/docker/r10k/release.Dockerfile

@@ -0,0 +1,54 @@
+FROM alpine:3.9
+
+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 && \
+    /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,43 @@
+require 'rspec/core'
+require 'fileutils'
+require 'open3'
+
+SPEC_DIRECTORY = File.dirname(__FILE__)
+
+describe 'r10k container' do
+  include Pupperware::SpecHelpers
+  def run_r10k(command)
+    run_command("docker run --detach \
+                   --volume #{File.join(SPEC_DIRECTORY, 'fixtures')}:/home/puppet/test \
+                   #{@image} #{command} \
+                   --verbose \
+                   --trace \
+                   --puppetfile test/Puppetfile")
+  end
+
+  before(:all) do
+    @image = require_test_image
+  end
+
+  after(:all) do
+    FileUtils.rm_rf(File.join(SPEC_DIRECTORY, 'fixtures', 'modules'))
+  end
+
+  it 'should validate the Puppetfile' do
+    result = run_r10k('puppetfile check')
+    container = result[:stdout].chomp
+    wait_on_container_exit(container)
+    expect(get_container_exit_code(container)).to eq(0)
+    emit_log(container)
+    teardown_container(container)
+  end
+
+  it 'should install the Puppetfile' do
+    result = run_r10k('puppetfile install')
+    container = result[:stdout].chomp
+    wait_on_container_exit(container)
+    expect(get_container_exit_code(container)).to eq(0)
+    emit_log(container)
+    teardown_container(container)
+  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,77 @@
+require 'rototiller'
+
+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?
+    t.add_command do |c|
+      c.name = 'beaker-hostgenerator'
+      c.argument = '> configs/generated'
+    end
+
+    # This is a hack :(
+    t.add_flag(:name => '', :default => 'centos6-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
+