r10k 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86a62176969a42b8de330d9f940f8a70b2ddde34
-  data.tar.gz: 630a698650dd7633ea5af47c01d2da9e3b4bbce9
+  metadata.gz: 8cc458f9c6f5fc825c4a915db8ba1f4c62d9f9e3
+  data.tar.gz: f1bcb084a79e0fc0bcf17352a98b2cd162fc1fa5
 SHA512:
-  metadata.gz: 88539ba2554f8a4cd81e768598aa242907d59ac1a1cfffcf5a192f9e4b8e2458beece89673615be5336f3d02478cf0ebd2d55d2f372f4bfe864a070cf598f20c
-  data.tar.gz: cac1fc4ca0ac0b9c8b9ec6aabcb8a1d3596ddfad2e551649895144bcf9458469850641ed9e42a441138c429ba0072482365d8fde2d425b349f136d0af003db38
+  metadata.gz: aa362d85081c4378839c4027f9feffd8411606d55c88f4101c6fe334eb872b0a470bac76a90ec070532f802310588fd3ff66a63b7164f3e986fd7af0ba1dddc7
+  data.tar.gz: 77b14cd6661fcf9c70d73aec1ad11faccf65ac30479872b08e86055436b0f64fb40ec764e5b5d9174d0ea036ac9430052555057de769d475cee6d07b1f6596f9

data/.gitignore

@@ -4,7 +4,6 @@ Gemfile.lock
 .bundle
 bundle
 coverage
-locales/r10k.pot
 integration/log
 integration/junit
 integration/configs

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,52 +1,60 @@
 CHANGELOG
 =========
 
+3.0.4
+----
+
+### Changes
+ - Flag for overriding default branch configuration in Puppetfile
+ - Plumbing for internationalization
+ - Numerous test fixes and legacy docker work
+
 3.0.3
 ----
 
-## Bug Fixes
+### Changes
 
-(RK-324) Fix Ruby pipe bug affecting Ubuntu
+  - (RK-324) Fix Ruby pipe bug affecting Ubuntu
 
 3.0.2
 ----
 
-## Changes
+### Changes
 
-Minor test fixes.
+  - Minor test fixes.
 
 3.0.1
 ----
 
-## Changes
+### Changes
 
 Because of dependency issues R10K 3.0.0 required Ruby >= 2.3
 rather than the reported 2.0. This release makes the requirement of
 Ruby >= 2.3 official and documented.
 
-(#853) ([RK-327](https://tickets.puppetlabs.com/browse/RK-327) Uninitialized Constant Cri::Error
-  When resolving the Cri dependency >= 2.13 R10K would fail with an
-  uninitialized constant error. Thanks to @ostavnaas for the bug report,
-  @ddfreyne for the fix, and @baurmatt for the review.
+  - (#853) ([RK-327](https://tickets.puppetlabs.com/browse/RK-327) Uninitialized Constant Cri::Error
+    When resolving the Cri dependency >= 2.13 R10K would fail with an
+    uninitialized constant error. Thanks to @ostavnaas for the bug report,
+    @ddfreyne for the fix, and @baurmatt for the review.
 
 
 3.0.0
 ----
 
-## Changes
+### Changes
 
-### Known issues
+#### Known issues
   - Child processes may die unexpectedly when deploying many environments
     on Ubuntu Bionic. See
     [RK-324](https://tickets.puppetlabs.com/browse/RK-324).
 
-### Backwards breaking changes
+#### Backwards breaking changes
   - Drop support for Ruby < 2.0
   - Remove support for PUPPETFILE and PUPPETFILE_DIR environment variables
     when running the `puppetfile` action, please use flags instead.
   - Fail when duplicate module definitions in Puppetfile
 
-### Bug fixes
+#### Bug fixes
   - More reliable pruning of refs on fetch
   - Improved error messaging when:
     - Unable to connect to a proxy
@@ -54,24 +62,32 @@ Ruby >= 2.3 official and documented.
     - Unable to parse Puppetfile
   - Various perfomance improvements
 
+2.6.6
+----
+
+### Changes
+  - Flag for overriding default branch configuration in Puppetfile
+  - Plumbing for internationalization
+  - Numerous test fixes and legacy docker work
 
 2.6.5
 ----
 
-## Bug Fix
+### Bug Fix
 
 (RK-324) Fix Ruby pipe bug affecting Ubuntu
 
 2.6.4
 ----
 
-## Changes
+### Changes
 
 Numerous test fixes.
 
 2.6.3
 ----
-## Changes
+
+### Changes
 
 Update specs with new error string.
 
@@ -80,6 +96,7 @@ when a release is made on that branch.
 
 2.6.2
 -----
+
 ### Changes
 
 (RK-311) Yard dependency updated for security fix.

data/azure-pipelines.yml

@@ -5,9 +5,15 @@ pool:
   name: Default
 
 variables:
-  BUILD_REPOSITORY: 127.0.0.1
+  NAMESPACE: puppet
+
+# completely disables the pipeline
+trigger: none
+pr: none
 
 steps:
+- checkout: self
+  clean: true
 - powershell: |
     $line = '=' * 80
     Write-Host "$line`nWindows`n$line`n"
@@ -46,27 +52,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/doc/dynamic-environments/usage.mkd

@@ -60,6 +60,18 @@ Update a single environment and force an update of modules:
 This will update the given environment and update all contained modules. This is
 useful if you want to make sure that a given environment is fully up to date.
 
+- - -
+
+Update a single environment and specify a default branch override:
+
+    r10k deploy environment my_working_environment --puppetfile --default-branch-override default_branch_override
+
+This will update the given environment and update all contained modules, overrideing 
+the :default_branch entry in the Puppetfile of each module. This is used primarily to allow
+automated r10k solutions using the control_branch pattern with a temporary branch deployment to 
+ensure the deployment is pushed to the correct module repository branch. Note that the :default_branch
+is only ever utilized if the desired ref cannot be located.
+
 ### Deploying modules
 
 Update a single module across all environments:

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

@@ -0,0 +1,47 @@
+git_describe = $(shell git describe)
+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 --ignore DL3008 --ignore DL3018 --ignore DL4000 --ignore DL4001
+hadolint_container := hadolint/hadolint:latest
+
+ifeq ($(IS_NIGHTLY),true)
+	dockerfile := Dockerfile.nightly
+	version := puppet6-nightly
+else
+	version = $(shell echo $(git_describe) | sed 's/-.*//')
+	dockerfile := Dockerfile
+endif
+
+
+prep:
+ifneq ($(IS_NIGHTLY),true)
+	@git fetch --unshallow ||:
+	@git fetch origin 'refs/tags/*:refs/tags/*'
+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 --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
+ifeq ($(IS_LATEST),true)
+	@docker tag puppet/r10k:$(version) puppet/r10k:latest
+endif
+
+test: prep
+	@bundle install --path .bundle/gems
+	@PUPPET_TEST_DOCKER_IMAGE=puppet/r10k:$(version) bundle exec rspec r10k/spec
+
+publish: prep
+	@docker push puppet/r10k:$(version)
+ifeq ($(IS_LATEST),true)
+	@docker push puppet/r10k:latest
+endif
+
+.PHONY: lint build test publish

data/docker/ci/build.ps1

@@ -6,33 +6,101 @@ function Get-CurrentDirectory
   [IO.Path]::GetDirectoryName((Get-Content function:$thisName).File)
 }
 
-# installs gems for build and test and grabs base images
-function Invoke-ContainerBuildSetup
+function Get-ContainerVersion
 {
-  Push-Location (Get-CurrentDirectory)
-  bundle install --path '.bundle/gems'
-  bundle exec puppet-docker update-base-images ubuntu:16.04
-  Pop-Location
+  # shallow repositories need to pull remaining code to `git describe` correctly
+  if (Test-Path "$(git rev-parse --git-dir)/shallow")
+  {
+    git pull --unshallow
+  }
+
+  # tags required for versioning
+  git fetch origin 'refs/tags/*:refs/tags/*'
+  (git describe) -replace '-.*', ''
+}
+
+function Lint-Dockerfile($Path)
+{
+  hadolint --ignore DL3008 --ignore DL3018 --ignore DL4000 --ignore DL4001 $Path
 }
 
-function Build-Container($Name, $Repository = '127.0.0.1')
+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 --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')
+function Invoke-ContainerTest(
+  $Namespace = 'puppet',
+  $Version = (Get-ContainerVersion))
 {
   Push-Location (Join-Path (Get-CurrentDirectory) '..')
-  bundle exec puppet-docker spec $Name --image $Repository/$Name
+
+  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

@@ -1,4 +1,9 @@
 pe-and-platform/r10k:
+  PreBuild:
+    - make lint
   Build:
+    - make build
+    - make test
+  AfterBuildSuccess:
     - docker login -u "$DISTELLI_DOCKER_USERNAME" -p "$DISTELLI_DOCKER_PW" "$DISTELLI_DOCKER_ENDPOINT"
-    - /bin/bash -x ./ci/build
+    - make publish

data/docker/r10k/spec/dockerfile_spec.rb

@@ -1,24 +1,39 @@
-require 'puppet_docker_tools/spec_helper'
+require 'rspec/core'
+require 'fileutils'
 
-CURRENT_DIRECTORY = File.dirname(File.dirname(__FILE__))
+SPEC_DIRECTORY = File.dirname(__FILE__)
 
-describe 'Dockerfile' do
-  include_context 'with a docker image'
-  include_context 'with a docker container' do
-    def docker_run_options
-      '--entrypoint /bin/bash'
+describe 'r10k container' do
+  before(:all) do
+    @image = ENV['PUPPET_TEST_DOCKER_IMAGE']
+    if @image.nil?
+      error_message = <<-MSG
+* * * * *
+  PUPPET_TEST_DOCKER_IMAGE environment variable must be set so we
+  know which image to test against!
+* * * * *
+      MSG
+      fail error_message
     end
+    @container = %x(docker run --rm --detach --entrypoint /bin/bash --interactive --volume #{File.join(SPEC_DIRECTORY, 'fixtures')}:/test #{@image}).chomp
+    %x(docker exec #{@container} cp test/Puppetfile /)
   end
 
-  describe 'uses the correct version of Ubuntu' do
-    it_should_behave_like 'a running container', 'cat /etc/lsb-release', nil, 'Ubuntu 16.04'
+  after(:all) do
+    %x(docker container kill #{@container})
+    FileUtils.rm_rf(File.join(SPEC_DIRECTORY, 'fixtures', 'modules'))
   end
 
-  describe 'has puppet-agent installed' do
-    it_should_behave_like 'a running container', 'dpkg -l puppet-agent', 0
+  it 'should validate the Puppetfile' do
+    %x(docker exec #{@container} r10k puppetfile check)
+    status = $?
+    expect(status).to eq(0)
   end
 
-  describe 'has /opt/puppetlabs/puppet/bin/r10k' do
-    it_should_behave_like 'a running container', 'stat -L /opt/puppetlabs/puppet/bin/r10k', 0, 'Access: \(0755\/\-rwxr\-xr\-x\)'
+  it 'should install the Puppetfile' do
+    %x(docker exec #{@container} r10k puppetfile install)
+    status = $?
+    expect(status).to eq(0)
+    expect(Dir.exist?(File.join(SPEC_DIRECTORY, 'fixtures', 'modules', 'ntp'))).to eq(true)
   end
 end