r10k 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a60c1ccc9338827361ca4116b58d3619f6ff755b
-  data.tar.gz: 7e473d21e8fa5a96e64787191d721790d7403bbf
+  metadata.gz: 84930e8294eba7ee0bb6891b043c7b5c50adc06b
+  data.tar.gz: 941551e36b98e187c52afbbc1c20e98c4b869ae8
 SHA512:
-  metadata.gz: a48693802bbc801288990cebc451d088b70807dbb1b4e9eb3e9e83594ad096a0233c5f903f2cf454bb0873fa08e3aba51cdb54609b47bbfb1e981444ac14e6d4
-  data.tar.gz: 875ce9e183d4f5191b36d0ef45a271b308d891b88a27f994c10c6bd57a66486448b68c96704e1769a87717754505d8d6fdefa43bd52de007449e5e4152766806
+  metadata.gz: 9eef55519460f134d9e2a376e64cab9e04a63836c9a4aa7a46f3d220576b29beed54215fc9710057f6d932a9892b9abeb7e91cfe9f2caa29a2846fed951de662
+  data.tar.gz: 53f5d878d87b1db35402539a0ca21d97ab22f230f84b583885dd67fa4c162a0c6ec1b05c71e535f116015583e49b76c87fd6642e8e7311d16c7a7addd08e1343

data/.gitattributes

@@ -1 +1,2 @@
-docker/r10k/*               text  eol=lf
+docker/r10k/*                     text  eol=lf
+docker/r10k/docker-entrypoint.d/* text  eol=lf

data/.travis.yml

@@ -1,15 +1,26 @@
 ---
 language: ruby
+services:
+  - docker
 bundler_args: "--without system"
 script: "bundle exec rspec --color --format documentation spec/unit"
 notifications:
   email: false
 sudo: false
-before_install: gem update bundler
-rvm:
-  - "2.5"
-  - "2.4"
-  - "2.3"
-  - "jruby"
 jdk:
     - oraclejdk8
+before_install: gem install bundler -v '< 2' --no-document
+matrix:
+  include:
+    - stage: r10k tests
+      rvm: 2.5.0
+    - stage: r10k tests
+      rvm: 2.4.0
+    - stage: r10k tests
+      rvm: 2.3.0
+    - stage: r10k tests
+      rvm: jruby
+    - stage: r10k container tests
+      language: generic
+      script:
+        - cd docker && make lint && make build && make test

data/CHANGELOG.mkd

@@ -1,6 +1,13 @@
 CHANGELOG
 =========
 
+3.1.1
+-----
+
+## Bug Fixes
+
+(RK-335) Postrun `modifiedenvs` doesn't include environment prefixes
+
 3.1.0
 -----
 

data/azure-pipelines.yml

@@ -5,9 +5,11 @@ pool:
   name: Default
 
 variables:
-  BUILD_REPOSITORY: 127.0.0.1
+  NAMESPACE: puppet
 
 steps:
+- checkout: self
+  clean: true
 - powershell: |
     $line = '=' * 80
     Write-Host "$line`nWindows`n$line`n"
@@ -46,27 +48,27 @@ steps:
   name: hostinfo
 - powershell: |
     . ./docker/ci/build.ps1
-    Invoke-ContainerBuildSetup
-  displayName: Prepare Build Environment
-  name: build_prepare
+    Lint-Dockerfile -Path ./docker/r10k/Dockerfile
+  displayName: Lint r10k Dockerfile
+  name: lint_dockerfile
 - powershell: |
     . ./docker/ci/build.ps1
-    Build-Container -Name r10k -Repository $ENV:BUILD_REPOSITORY
-  displayName: Build r10k
-  name: build_r10k
+    Build-Container -Namespace $ENV:NAMESPACE
+  displayName: Build r10k Container
+  name: build_r10k_container
 - powershell: |
     . ./docker/ci/build.ps1
-    Invoke-ContainerTest -Name r10k -Repository $ENV:BUILD_REPOSITORY
+    Invoke-ContainerTest -Namespace $ENV:NAMESPACE
   displayName: Test r10k
   name: test_r10k
 - task: PublishTestResults@2
   displayName: Publish r10k test results
   inputs:
     testResultsFormat: 'JUnit'
-    testResultsFiles: 'docker/**/TEST-*.xml'
+    testResultsFiles: 'docker/TEST-*.xml'
     testRunTitle: r10k Test Results
 - powershell: |
     . ./docker/ci/build.ps1
-    Clear-ContainerBuilds
+    Clear-ContainerBuilds -Name r10k
   displayName: Container Cleanup
   condition: always()

data/docker/.gitignore

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

data/docker/Gemfile

@@ -10,5 +10,5 @@ def location_for(place, fake_version = nil)
   end
 end
 
-gem 'puppet_docker_tools', *location_for(ENV['PUPPET_DOCKER_LOCATION'] || '~> 0.2')
+gem 'rspec'
 gem 'rspec_junit_formatter'

data/docker/Makefile

@@ -1,3 +1,4 @@
+PUPPERWARE_ANALYTICS_STREAM ?= dev
 git_describe = $(shell git describe)
 vcs_ref := $(shell git rev-parse HEAD)
 build_date := $(shell date -u +%FT%T)
@@ -29,7 +30,15 @@ else
 endif
 
 build: prep
-	@docker build --pull --build-arg vcs_ref=$(vcs_ref) --build-arg build_date=$(build_date) --build-arg version=$(version) --file r10k/$(dockerfile) --tag puppet/r10k:$(version) r10k
+	@docker build \
+		--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 puppet/r10k:$(version) \
+		r10k
 ifeq ($(IS_LATEST),true)
 	@docker tag puppet/r10k:$(version) puppet/r10k:latest
 endif

data/docker/ci/build.ps1

@@ -19,33 +19,88 @@ function Get-ContainerVersion
   (git describe) -replace '-.*', ''
 }
 
-# installs gems for build and test and grabs base images
-function Invoke-ContainerBuildSetup
+function Lint-Dockerfile($Path)
 {
-  Push-Location (Get-CurrentDirectory)
-  bundle install --path '.bundle/gems'
-  bundle exec puppet-docker update-base-images ubuntu:16.04
-  Pop-Location
+  hadolint --ignore DL3008 --ignore DL3018 --ignore DL4000 --ignore DL4001 $Path
 }
 
-function Build-Container($Name, $Repository = '127.0.0.1', $Version = (Get-ContainerVersion))
+function Build-Container(
+  $Namespace = 'puppet',
+  $Version = (Get-ContainerVersion),
+  $Vcs_ref = $(git rev-parse HEAD))
 {
   Push-Location (Join-Path (Get-CurrentDirectory) '..')
-  bundle exec puppet-docker local-lint $Name
-  bundle exec puppet-docker build $Name --no-cache --repository $Repository --version $Version --no-latest --build-arg namespace=$Repository
+
+  $build_date = (Get-Date).ToUniversalTime().ToString('o')
+  $docker_args = @(
+    '--pull',
+    '--build-arg', "vcs_ref=$Vcs_ref",
+    '--build-arg', "build_date=$build_date",
+    '--build-arg', "version=$Version",
+    '--file', "r10k/Dockerfile",
+    '--tag', "$Namespace/r10k:$Version"
+  )
+
+  docker build $docker_args r10k
+
   Pop-Location
 }
 
-function Invoke-ContainerTest($Name, $Repository = '127.0.0.1', $Version = (Get-ContainerVersion))
+function Invoke-ContainerTest(
+  $Namespace = 'puppet',
+  $Version = (Get-ContainerVersion))
 {
   Push-Location (Join-Path (Get-CurrentDirectory) '..')
-  bundle exec puppet-docker spec $Name --image "$Repository/${Name}:$Version"
+
+  bundle install --path .bundle/gems
+  $ENV:PUPPET_TEST_DOCKER_IMAGE = "$Namespace/r10k:$Version"
+  bundle exec rspec r10k/spec
+
   Pop-Location
 }
 
-# removes any temporary containers / images used during builds
-function Clear-ContainerBuilds
+# removes temporary layers / containers / images used during builds
+# removes $Namespace/$Name images > 14 days old by default
+function Clear-ContainerBuilds(
+  $Namespace = 'puppet',
+  $Name,
+  $OlderThan = [DateTime]::Now.Subtract([TimeSpan]::FromDays(14))
+)
 {
+  Write-Output 'Pruning Containers'
   docker container prune --force
+
+  # this provides example data which ConvertFrom-String infers parsing structure with
+  $template = @'
+{Version*:1.2.3} {ID:5b84704c1d01} {[DateTime]Created:2019-02-07 18:24:51} +0000 GMT
+{Version*:latest} {ID:0123456789ab} {[DateTime]Created:2019-01-29 00:05:33} +0000 GMT
+'@
+  $output = docker images --filter=reference="$Namespace/${Name}" --format "{{.Tag}} {{.ID}} {{.CreatedAt}}"
+  Write-Output @"
+
+Found $Namespace/${Name} images:
+$($output | Out-String)
+
+"@
+
+  if ($output -eq $null) { return }
+
+  Write-Output "Filtering removal candidates..."
+  # docker image prune supports filter until= but not repository like 'puppetlabs/foo'
+  # must use label= style filtering which is a bit more inconvenient
+  # that output is also not user-friendly!
+  # engine doesn't maintain "last used" or "last pulled" metadata, which would be more useful
+  # https://github.com/moby/moby/issues/4237
+  $output |
+    ConvertFrom-String -TemplateContent $template |
+    ? { $_.Created -lt $OlderThan } |
+    # ensure 'latest' are listed first
+    Sort-Object -Property Version -Descending |
+    % {
+      Write-Output "Removing Old $Namespace/${Name} Image $($_.Version) ($($_.ID)) Created On $($_.Created)"
+      docker image rm $_.ID
+    }
+
+  Write-Output "`nPruning Dangling Images"
   docker image prune --filter "dangling=true" --force
 }

data/docker/distelli-manifest.yml

@@ -2,7 +2,7 @@ pe-and-platform/r10k:
   PreBuild:
     - make lint
   Build:
-    - make build
+    - make build PUPPERWARE_ANALYTICS_STREAM=production
     - make test
   AfterBuildSuccess:
     - docker login -u "$DISTELLI_DOCKER_USERNAME" -p "$DISTELLI_DOCKER_PW" "$DISTELLI_DOCKER_ENDPOINT"

data/docker/r10k/Dockerfile

@@ -2,7 +2,12 @@ FROM ubuntu:16.04
 
 ARG vcs_ref
 ARG build_date
-ARG version="2.6.4"
+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"
+ENV PUPPERWARE_ANALYTICS_STREAM="$pupperware_analytics_stream"
+
 ENV R10K_VERSION="$version"
 ENV UBUNTU_CODENAME="xenial"
 
@@ -33,9 +38,13 @@ RUN apt-get update && \
 
 RUN /opt/puppetlabs/puppet/bin/gem install r10k:"$R10K_VERSION"
 
+COPY docker-entrypoint.sh /
+RUN chmod +x /docker-entrypoint.sh
+COPY docker-entrypoint.d /docker-entrypoint.d
+
 ENV PATH=/opt/puppetlabs/server/bin:/opt/puppetlabs/puppet/bin:/opt/puppetlabs/bin:$PATH
 
-ENTRYPOINT ["/opt/puppetlabs/puppet/bin/r10k"]
+ENTRYPOINT ["/docker-entrypoint.sh"]
 CMD ["help"]
 
 COPY Dockerfile /

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

@@ -0,0 +1,28 @@
+#!/bin/sh
+
+if [ "${PUPPERWARE_DISABLE_ANALYTICS}" = "true" ]; then
+    echo "($0) Pupperware analytics disabled; skipping metric submission"
+    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
+# 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
+
+_params="v=1&t=event&tid=${tid}&an=${an}&av=${av}&cid=${cid}&ec=${ec}&ea=${ea}"
+_url="http://www.google-analytics.com/collect?${_params}"
+
+echo "($0) Sending metrics ${_url}"
+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
+  echo "Running $f"
+  chmod +x "$f"
+  "$f"
+done
+
+exec /opt/puppetlabs/puppet/bin/r10k "$@"

data/docker/r10k/spec/dockerfile_spec.rb

@@ -15,7 +15,13 @@ describe 'r10k container' do
       MSG
       fail error_message
     end
-    @container = %x(docker run --rm --detach --entrypoint /bin/bash --interactive --volume #{File.join(SPEC_DIRECTORY, 'fixtures')}:/test #{@image}).chomp
+    @container = %x(docker run --rm --detach \
+               --env PUPPERWARE_DISABLE_ANALYTICS=true \
+               --entrypoint /bin/bash \
+               --interactive \
+               --volume #{File.join(SPEC_DIRECTORY, 'fixtures')}:/test \
+               #{@image}).chomp
+
     %x(docker exec #{@container} cp test/Puppetfile /)
   end
 

data/integration/Gemfile

@@ -10,8 +10,8 @@ def location_for(place, fake_version = nil)
   end
 end
 
-gem 'beaker', *location_for(ENV['BEAKER_VERSION'] || '~> 3.33')
-gem 'beaker-pe', '~> 1.22'
+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')

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

@@ -1,4 +1,5 @@
 require 'beaker-pe'
+
 test_name 'CODEMGMT-20 - C48 - Install Puppet Enterprise'
 
 step 'Install PE'

data/integration/tests/basic_functionality/install_pe_only_module_with_puppetfile.rb

@@ -58,8 +58,8 @@ 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 'Download license file from int-resources'
-curl_on(master, 'http://int-resources.ops.puppetlabs.net/QA_resources/r10k/license.key -o /etc/puppetlabs/license.key')
+step 'Download license file from artifactory'
+curl_on(master, 'https://artifactory.delivery.puppetlabs.net/artifactory/generic/r10k_test_license.key -o /etc/puppetlabs/license.key')
 
 step 'Inject New "site.pp" to the "production" Environment'
 inject_site_pp(master, site_pp_path, site_pp)

data/integration/tests/basic_functionality/proxy_with_pe_only_module.rb

@@ -86,8 +86,8 @@ 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 'Download license file from int-resources'
-curl_on(master, 'http://int-resources.ops.puppetlabs.net/QA_resources/r10k/license.key -o /etc/puppetlabs/license.key')
+step 'Download license file from artifactory'
+curl_on(master, 'https://artifactory.delivery.puppetlabs.net/artifactory/generic/r10k_test_license.key -o /etc/puppetlabs/license.key')
 
 step 'Checkout "production" Branch'
 git_on(master, 'checkout production', git_environments_path)

data/lib/r10k/action/deploy/environment.rb

@@ -65,7 +65,7 @@ module R10K
         ensure
           if (postcmd = @settings[:postrun])
             if postcmd.grep('$modifiedenvs').any?
-              envs = deployment.environments.map { |e| e.name }
+              envs = deployment.environments.map { |e| e.dirname }
               envs.reject! { |e| !@argv.include?(e) } if @argv.any?
               postcmd = postcmd.map { |e| e.gsub('$modifiedenvs', envs.join(' ')) }
             end

data/lib/r10k/version.rb

@@ -1,3 +1,3 @@
 module R10K
-  VERSION = '3.1.0'
+  VERSION = '3.1.1'
 end

data/spec/r10k-mocks/mock_source.rb

@@ -5,6 +5,9 @@ class R10K::Source::Mock < R10K::Source::Base
   R10K::Source.register(:mock, self)
 
   def environments
-    @options[:environments].map { |n| R10K::Environment::Mock.new(n, @basedir, n) }
+    corrected_environment_names = @options[:environments].map do |env|
+      R10K::Environment::Name.new(env, :prefix => @prefix, :invalid => 'correct_and_warn')
+    end
+    corrected_environment_names.map { |env| R10K::Environment::Mock.new(env.name, @basedir, env.dirname) }
   end
 end

data/spec/unit/action/deploy/environment_spec.rb

@@ -33,7 +33,8 @@ describe R10K::Action::Deploy::Environment do
           :control => {
             :type => :mock,
             :basedir => '/some/nonexistent/path/control',
-            :environments => %w[first second third],
+            :environments => %w[first second third env-that/will-be-corrected],
+            :prefix => 'PREFIX'
           }
         }
       )
@@ -76,7 +77,7 @@ describe R10K::Action::Deploy::Environment do
 
         subject do
           described_class.new( {config: "/some/nonexistent/path" },
-                               %w[first],
+                               %w[PREFIX_first],
                                settings                             )
         end
 
@@ -104,7 +105,7 @@ describe R10K::Action::Deploy::Environment do
 
           subject do
             described_class.new( {config: "/some/nonexistent/path" },
-                                 %w[first],
+                                 %w[PREFIX_first],
                                  settings                             )
           end
 
@@ -114,7 +115,7 @@ describe R10K::Action::Deploy::Environment do
             expect(mock_subprocess).to receive(:execute)
 
             expect(R10K::Util::Subprocess).to receive(:new).
-              with(["/generate/types/wrapper", "first"]).
+              with(["/generate/types/wrapper", "PREFIX_first"]).
               and_return(mock_subprocess)
 
             subject.call
@@ -140,7 +141,7 @@ describe R10K::Action::Deploy::Environment do
             expect(mock_subprocess).to receive(:execute)
 
             expect(R10K::Util::Subprocess).to receive(:new).
-              with(["/generate/types/wrapper", "first second third"]).
+              with(["/generate/types/wrapper", "PREFIX_first PREFIX_second PREFIX_third PREFIX_env_that_will_be_corrected"]).
               and_return(mock_subprocess)
 
             subject.call
@@ -160,7 +161,7 @@ describe R10K::Action::Deploy::Environment do
         expect(R10K::Deployment).to receive(:new).and_return(deployment)
       end
 
-      subject { described_class.new({ config: "/some/nonexistent/path", puppetfile: true }, %w[first], settings) }
+      subject { described_class.new({ config: "/some/nonexistent/path", puppetfile: true }, %w[PREFIX_first], settings) }
 
       describe "deployment purge level" do
         let(:purge_levels) { [:deployment] }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r10k
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-07 00:00:00.000000000 Z
+date: 2019-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -187,12 +187,15 @@ files:
 - doc/git/providers.mkd
 - doc/puppetfile.mkd
 - doc/updating-your-puppetfile.mkd
+- docker/.gitignore
 - docker/.rspec
 - docker/Gemfile
 - docker/Makefile
 - docker/ci/build.ps1
 - docker/distelli-manifest.yml
 - docker/r10k/Dockerfile
+- docker/r10k/docker-entrypoint.d/10-analytics.sh
+- docker/r10k/docker-entrypoint.sh
 - docker/r10k/spec/dockerfile_spec.rb
 - docker/r10k/spec/fixtures/Puppetfile
 - integration/Gemfile