r10k 3.4.0 → 3.6.0

data/spec/unit/source/exec_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'r10k/source'
+require 'json'
+require 'yaml'
+
+describe R10K::Source::Exec do
+
+  let(:environments_hash) do
+    {
+      'production' => {
+        'remote'  => 'https://git.example.com/puppet/control-repo.git',
+        'ref'     => 'release-141',
+        'modules' => {
+          'puppetlabs-stdlib' => '6.1.0',
+          'puppetlabs-ntp' => '8.1.0',
+          'example-myapp1' => {
+            'git' => 'https://git.example.com/puppet/example-myapp1.git',
+            'ref' => 'v1.3.0'
+          }
+        }
+      },
+      'development' => {
+        'remote'  => 'https://git.example.com/puppet/control-repo.git',
+        'ref'     => 'master',
+        'modules' => {
+          'puppetlabs-stdlib' => '6.1.0',
+          'puppetlabs-ntp' => '8.1.0',
+          'example-myapp1' => {
+            'git' => 'https://git.example.com/puppet/example-myapp1.git',
+            'ref' => 'v1.3.1'
+          }
+        }
+      }
+    }
+  end
+
+  describe 'initialize' do
+    context 'with a valid command' do
+      context 'that produces valid output' do
+        it 'accepts json' do
+          allow_any_instance_of(R10K::Util::Subprocess)
+            .to receive(:execute)
+            .and_return(double('result', stdout: environments_hash.to_json))
+
+          source = described_class.new('execsource', '/some/nonexistent/dir', command: '/path/to/command')
+          expect(source.environments.map(&:name)).to contain_exactly('production', 'development')
+        end
+
+        it 'accepts yaml' do
+          allow_any_instance_of(R10K::Util::Subprocess)
+            .to receive(:execute)
+            .and_return(double('result', stdout: environments_hash.to_yaml))
+
+          source = described_class.new('execsource', '/some/nonexistent/dir', command: '/path/to/command')
+          expect(source.environments.map(&:name)).to contain_exactly('production', 'development')
+        end
+
+      end
+
+      context 'that produces invalid output' do
+        it 'raises an error for non-json, non-yaml data' do
+          allow_any_instance_of(R10K::Util::Subprocess)
+            .to receive(:execute)
+            .and_return(double('result', stdout: "one:\ntwo\n"))
+
+          source = described_class.new('execsource', '/some/nonexistent/dir', command: '/path/to/command')
+          expect { source.environments }.to raise_error(/Error parsing command output/)
+        end
+
+        it 'raises an error for yaml data that is not a hash' do
+          allow_any_instance_of(R10K::Util::Subprocess)
+            .to receive(:execute)
+            .and_return(double('result', stdout: "[one, two]"))
+
+          source = described_class.new('execsource', '/some/nonexistent/dir', command: '/path/to/command')
+          expect { source.environments }.to raise_error(R10K::Error, /Environment source execsource.*did not return valid environment data.*one.*two.*/m)
+        end
+      end
+    end
+  end
+end

data/spec/unit/source/git_spec.rb

@@ -93,9 +93,45 @@ describe R10K::Source::Git do
     let(:ignore_prefixes) { ['dev', 'test'] }
 
     it "filters branches" do
-      expect(subject.filter_branches(branches, ignore_prefixes)).to eq(['master', 'production', 'not_dev_test_me'])
+      expect(subject.filter_branches_by_regexp(branches, ignore_prefixes)).to eq(['master', 'production', 'not_dev_test_me'])
     end
   end
+
+  describe "filtering branches with command" do
+    let(:branches) { ['master', 'development', 'production'] }
+    let(:filter_command) { 'sh -c "[ $R10K_BRANCH != development ]"' }
+
+    it "filters branches" do
+      expect(subject.filter_branches_by_command(branches, filter_command)).to eq(['master', 'production'])
+    end
+  end
+
+  describe "generate_environments respects filter_command setting" do
+    before do
+      allow(subject.cache).to receive(:branches).and_return ['master', 'development', 'production']
+      subject.instance_variable_set(:@filter_command, '[ $R10K_BRANCH != master ]')
+    end
+
+    let(:environments) { subject.generate_environments }
+
+    it "creates an environment for each branch not filtered by filter_command" do
+      expect(subject.generate_environments.size).to eq(2)
+    end
+  end
+
+  describe "generate_environments respects filter_command setting and name" do
+    before do
+      allow(subject.cache).to receive(:branches).and_return ['master', 'development', 'production']
+      subject.instance_variable_set(:@filter_command, '[ $R10K_NAME = mysource ]')
+    end
+
+    let(:environments) { subject.generate_environments }
+
+    it "creates an environment for each branch not filtered by filter_command" do
+      expect(subject.generate_environments.size).to eq(3)
+    end
+  end
+
 end
 
 describe R10K::Source::Git, "handling invalid branch names" do

data/spec/unit/source/hash_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'r10k/source'
+
+describe R10K::Source::Hash do
+
+  describe '.valid_environments_hash?' do
+    it "rejects strings" do
+      expect(R10K::Source::Hash.valid_environments_hash?('200 OK'))
+        .to eq false
+    end
+  end
+
+  let(:environments_hash) do
+    {
+      'production' => {
+        'remote'  => 'https://git.example.com/puppet/control-repo.git',
+        'ref'     => 'release-141',
+        'modules' => {
+          'puppetlabs-stdlib' => '6.1.0',
+          'puppetlabs-ntp' => '8.1.0',
+          'example-myapp1' => {
+            'git' => 'https://git.example.com/puppet/example-myapp1.git',
+            'ref' => 'v1.3.0'
+          }
+        }
+      },
+      'development' => {
+        'remote'  => 'https://git.example.com/puppet/control-repo.git',
+        'ref'     => 'master',
+        'modules' => {
+          'puppetlabs-stdlib' => '6.1.0',
+          'puppetlabs-ntp' => '8.1.0',
+          'example-myapp1' => {
+            'git' => 'https://git.example.com/puppet/example-myapp1.git',
+            'ref' => 'v1.3.1'
+          }
+        }
+      }
+    }
+  end
+
+  describe "with a prefix" do
+    subject do
+      described_class.new('hashsource', '/some/nonexistent/dir',
+                          prefix: 'prefixed', environments: environments_hash)
+    end
+
+    it "prepends environment names with a prefix" do
+      environments = subject.environments
+      expect(environments[0].dirname).to eq 'prefixed_production'
+      expect(environments[1].dirname).to eq 'prefixed_development'
+    end
+  end
+end

data/spec/unit/source/yaml_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'r10k/source'
+
+describe R10K::Source::Yaml do
+
+  let(:environments_hash) do
+    {
+      'production' => {
+        'remote'  => 'https://git.example.com/puppet/control-repo.git',
+        'ref'     => 'release-141',
+        'modules' => {
+          'puppetlabs-stdlib' => '6.1.0',
+          'puppetlabs-ntp' => '8.1.0',
+          'example-myapp1' => {
+            'git' => 'https://git.example.com/puppet/example-myapp1.git',
+            'ref' => 'v1.3.0'
+          }
+        }
+      },
+      'development' => {
+        'remote'  => 'https://git.example.com/puppet/control-repo.git',
+        'ref'     => 'master',
+        'modules' => {
+          'puppetlabs-stdlib' => '6.1.0',
+          'puppetlabs-ntp' => '8.1.0',
+          'example-myapp1' => {
+            'git' => 'https://git.example.com/puppet/example-myapp1.git',
+            'ref' => 'v1.3.1'
+          }
+        }
+      }
+    }
+  end
+
+  describe "with valid yaml file" do
+    it "produces environments" do
+      allow(YAML).to receive(:load_file).with('/envs.yaml').and_return(environments_hash)
+      source = described_class.new('yamlsource', '/some/nonexistent/dir', config: '/envs.yaml')
+      expect(source.environments.map(&:name)).to contain_exactly('production', 'development')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r10k
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -28,16 +28,22 @@ dependencies:
   name: cri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.15.6
+        version: 2.15.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.15.10
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.15.6
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: log4r
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +100,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.24'
+- !ruby/object:Gem::Dependency
+  name: fast_gettext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: gettext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -161,7 +201,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitattributes"
+- ".github/pull_request_template.md"
 - ".github/workflows/docker.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.mkd
@@ -222,15 +264,6 @@ files:
 - integration/pre-suite/10_git_config.rb
 - integration/pre-suite/20_pe_r10k.rb
 - integration/pre-suite/README.mkd
-- integration/scripts/README.mkd
-- integration/scripts/setup_r10k_env_centos5.sh
-- integration/scripts/setup_r10k_env_centos6.sh
-- integration/scripts/setup_r10k_env_rhel7.sh
-- integration/scripts/setup_r10k_env_sles11.sh
-- integration/scripts/setup_r10k_env_sles12.sh
-- integration/scripts/setup_r10k_env_ubuntu1004.sh
-- integration/scripts/setup_r10k_env_ubuntu1204.sh
-- integration/scripts/setup_r10k_env_ubuntu1404.sh
 - integration/tests/Puppetfile/HTTP_PROXY_affects_forge_source.rb
 - integration/tests/Puppetfile/HTTP_PROXY_affects_git_source.rb
 - integration/tests/README.mkd
@@ -249,6 +282,7 @@ files:
 - integration/tests/command_line/negative/neg_invalid_cmd_line_arg.rb
 - integration/tests/git_source/HTTP_proxy_and_git_source.rb
 - integration/tests/git_source/git_source_git.rb
+- integration/tests/git_source/git_source_repeated_remote.rb
 - integration/tests/git_source/git_source_ssh.rb
 - integration/tests/git_source/git_source_submodule.rb
 - integration/tests/git_source/negative/neg_git_broken_remote.rb
@@ -375,6 +409,7 @@ files:
 - lib/r10k/settings/uri_definition.rb
 - lib/r10k/source.rb
 - lib/r10k/source/base.rb
+- lib/r10k/source/exec.rb
 - lib/r10k/source/git.rb
 - lib/r10k/source/hash.rb
 - lib/r10k/source/svn.rb
@@ -502,8 +537,11 @@ files:
 - spec/unit/settings/uri_definition_spec.rb
 - spec/unit/settings_spec.rb
 - spec/unit/source/base_spec.rb
+- spec/unit/source/exec_spec.rb
 - spec/unit/source/git_spec.rb
+- spec/unit/source/hash_spec.rb
 - spec/unit/source/svn_spec.rb
+- spec/unit/source/yaml_spec.rb
 - spec/unit/source_spec.rb
 - spec/unit/svn/remote_spec.rb
 - spec/unit/svn/working_dir_spec.rb
@@ -538,7 +576,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Puppet environment and module deployment

data/integration/scripts/README.mkd

@@ -1,86 +0,0 @@
-Scripts
-=======
-
-This folder contains helper scripts for setting up manual testing environments
-using [Beaker](https://github.com/puppetlabs/beaker) configuration files. The
-environments created by these scripts have "r10k" fully configured along with
-a Git repository with a valid "production" environment.
-
-These scripts are specific to the Puppet Labs environment and will not work in
-other environments without alteration!
-
-## Prerequisites
-
-To utilize this test scripts you will need to have Ruby 1.9.3 or greater
-installed on your system along with Bundler. Also, the scripts utilize the
-"vmpooler" for virtual machine creation. Access to the "vmpooler" machines
-require having valid SSH private keys located on your local computer. Speak
-with a QA team member for more information on where to find the necessary
-SSH keys.
-
-## Usage
-
-The scripts are written in Bash and should run on any Linux or Mac system as
-long as the prerequisites mentioned above are satisfied.
-
-### Cloning
-
-First you will need to clone the "[r10k](https://github.com/puppetlabs/r10k)" repository on your local machine:
-
-```bash
-git clone git@github.com:puppetlabs/r10k.git
-```
-
-### Executing Script
-
-Navigate to the integration tests "scripts" folder of the "r10k" repository
-clone:
-
-```bash
-cd r10k/integration/scripts
-```
-
-There are separate scripts for each supported platform. Select a desired
-platform and execute the script:
-
-```bash
-bash setup_r10k_env_centos6.sh
-```
-
-## Connecting to Machines
-
-The setup process takes about 10 minutes to complete. Once finished Beaker
-will report that all tests have been run successfully. The output log will
-list the machines created. The Puppet master will have a name ending with
-"-master" which you can scrape from the Beaker console output. Example:
-
-```
-a9lrs93vnujsrrg.delivery.puppetlabs.net (centos-6-x86_64-master) executed in 1.26 seconds
-```
-
-The FQDN of the Puppet master ("a9lrs93vnujsrrg.delivery.puppetlabs.net" in the
-above example) will be printed to the left of the machine tag. The machine tag
-is a combination of the platform and role of the virtual machine.
-
-Now that you have the FQDN you can connect to the machine using SSH:
-
-```bash
-ssh -i private_key root@a9lrs93vnujsrrg.delivery.puppetlabs.net
-```
-
-*Note:* The correct SSH private key needs to be installed on your local machine
-first. Speak with a QA representative to get the correct key for "vmpooler"
-machines.
-
-## Configuration Details
-
-Now that you have successfully connected to the Puppet master you can begin
-manual testing. The script has configured Git on the Puppet master to provide
-a working "production" environment for "r10k" testing. The Git repository
-serving the Puppet environments is located at "/git_repos/environments.git".
-There is a Git clone of the remote repository located at "/root/environments".
-
-When performing manual "r10k" testing you should utilize the Git clone
-repository located at "/root/environments". The "r10k" configuration file
-"/etc/puppetlabs/r10k/r10k.yaml" is already configured to use the remote Git
-repository for deployments.