beaker-module_install_helper 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ede48efbad22234618a4c29a6c867159ea71185
-  data.tar.gz: 4419511fba9522e71a5000fdce82c936ba4d58e6
+  metadata.gz: 823c0eb3935f314373fd6a2a69c48a4f00e3cbca
+  data.tar.gz: 7ce9f9efee93bacc80f76247359271992d84bddf
 SHA512:
-  metadata.gz: 6304cb076b5e74fb961e55f09153c9e21a8834c0a2ba1aead19c2edd95c856d1166b1e2be3f6b57ae2fbeedb0b82bf2ad30feb25b89b77f42ea0ea9840683b83
-  data.tar.gz: 674f7c0c5b9f90d0eca68f0faa6922ffec5e924adf6d6be68399b2d0133f38fc3bd9e360644b199d50ee1a2fecb3c497c93fc9b916d2ef77a3c0292b9867ebd2
+  metadata.gz: eae59a8d7a8bcd82382ec9d59a93d840b18a6e186199e2b92c7cb135a8b1af7a11460c11886bde8187293000adee2a7c96d355ef6694e307508f5dd80745bb87
+  data.tar.gz: fd2afeff327e32091ac6600c53090edc763f5f73e0b7c81dc7968fbdfea75642e96aab45ab8998c551fb5db70b27140fdd8932f13acc4b163151f41e4c7bedb7

data/.rubocop.yml

@@ -3,6 +3,9 @@ require: rubocop-rspec
 AllCops:
   TargetRubyVersion: 2.1
 
+Bundler/OrderedGems:
+  Enabled: false
+
 RSpec/AnyInstance:
   Enabled: false
 
@@ -21,14 +24,23 @@ Style/ClassAndModuleChildren:
 Style/GlobalVars:
   Enabled: false
 
+Style/RegexpLiteral:
+  Enabled: false
+
 Bundler/DuplicatedGem:
   Enabled: false
 
 Metrics/AbcSize:
   Enabled: false
 
+Metrics/BlockLength:
+  Enabled: false
+
 Metrics/LineLength:
   Max: 100
 
 Metrics/MethodLength:
   Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false

data/README.md

@@ -8,6 +8,9 @@ The below example will install the module from source on the host with role 'mas
 require 'beaker/module_install_helper'
 install_module_dependencies
 install_module
+
+# Install a testing only dependency, not specified in metadata
+install_module_from_forge('puppetlabs-inifile', '>= 1.0.0 <= 50.0.0')
 ```
 
 The below example will install the module from source on the specified host and install module dependencies specified in metadata.json on the host
@@ -32,5 +35,23 @@ This will call `install_module_dependencies_on` on the hosts with role 'master'.
 ### `install_module_dependencies_on`
 This will install a list of dependencies on the specified host from the forge, using the dependencies list specified in the metadata.json file, taking into consideration the version constraints if specified.
 
+**See: ** [Alternative Forge Instances](#alternative-forge-instances)
+
+### `install_module_from_forge(module_name, version_requirement)`
+This will call `install_module_from_forge_on` on the hosts with role 'master'. If there are none, the module will be install on all hosts with the role 'agent', again, if there are none, the module will be installed on all hosts.
+
+### `install_module_from_forge_on(hosts, module_name, version_requirement)`
+This will install a module from the forge on the given host(s). Module name must be specified in the {author}-{module_name} or {author}/{module_name} format. Version requirement must be specified to meet [this](https://docs.puppet.com/puppet/latest/modules_metadata.html#version-specifiers) criteria.
+ 
+**See: ** [Alternative Forge Instances](#alternative-forge-instances)
+
+### Alternative Forge Instances
+It is possible to use alternative forge instances rather than the production forge instance to install module dependencies by specifiying 2 environment variables, `BEAKER_FORGE_HOST` and `BEAKER_FORGE_API`. Both of these are required as the forge API is used under the hood to resolve version requirement boundary strings.
+
+**Example Using Staging Forge**
+```
+BEAKER_FORGE_HOST=https://module-staging.puppetlabs.com BEAKER_FORGE_API=https://api-module-staging.puppetlabs.com BEAKER_debug=true bundle exec rspec spec/acceptance
+```
+
 ### Support
 No support is supplied or implied. Use at your own risk.

data/beaker-module_install_helper.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'beaker-module_install_helper'
-  spec.version       = '0.1.1'
+  spec.version       = '0.1.2'
   spec.authors       = ['Puppet']
   spec.email         = ['wilson@puppet.com']
 

data/lib/beaker/module_install_helper.rb

@@ -21,22 +21,45 @@ module Beaker::ModuleInstallHelper
 
   # This method calls the install_module_dependencies_on method for each
   # host which is a master, or if no master is present, on all agent nodes.
-  def install_module_dependencies
-    install_module_dependencies_on(host)
+  def install_module_dependencies(deps = nil)
+    install_module_dependencies_on(hosts_to_install_module_on, deps)
   end
 
   # This method will install the module under tests module dependencies on the
-  # specified host from the dependencies list in metadata.json
-  def install_module_dependencies_on(host)
-    host = [host] if host.is_a?(Hash)
-    deps = module_dependencies_from_metadata
-    host.each do |hst|
+  # specified host(s) from the dependencies list in metadata.json
+  def install_module_dependencies_on(hsts, deps = nil)
+    hsts = [hsts] if hsts.is_a?(Hash)
+    deps = deps.nil? ? module_dependencies_from_metadata : deps
+
+    fh = ENV['BEAKER_FORGE_HOST']
+
+    hsts.each do |host|
       deps.each do |dep|
-        install_puppet_module_via_pmt_on(hst, dep)
+        if fh.nil?
+          install_puppet_module_via_pmt_on(host, dep)
+        else
+          with_forge_stubbed_on(host) do
+            install_puppet_module_via_pmt_on(host, dep)
+          end
+        end
       end
     end
   end
 
+  def install_module_from_forge(mod_name, ver_req)
+    install_module_from_forge_on(hosts_to_install_module_on, mod_name, ver_req)
+  end
+
+  def install_module_from_forge_on(hsts, mod_name, ver_req)
+    mod_name.sub!('/', '-')
+    dependency = {
+      module_name: mod_name,
+      version: module_version_from_requirement(mod_name, ver_req)
+    }
+
+    install_module_dependencies_on(hsts, [dependency])
+  end
+
   # This method returns an array of dependencies from the metadata.json file
   # in the format of an array of hashes, containing :module_name and optionally
   # :version elements. If no dependencies are specified, empty array is returned
@@ -63,7 +86,7 @@ module Beaker::ModuleInstallHelper
   # and upper bounds. The function then uses the forge rest endpoint to find
   # the most recent release of the given module matching the version requirement
   def module_version_from_requirement(mod_name, vr_str)
-    uri = URI("https://forgeapi.puppetlabs.com/v3/modules/#{mod_name}")
+    uri = URI("#{forge_api}/v3/modules/#{mod_name}")
     response = Net::HTTP.get(uri)
     forge_data = JSON.parse(response)
 
@@ -75,7 +98,7 @@ module Beaker::ModuleInstallHelper
       return rel['version'] if vrs.all? { |vr| vr.match?('', rel['version']) }
     end
 
-    raise "No release version found matching '#{vr}'"
+    raise "No release version found matching '#{vr_str}'"
   end
 
   # This method takes a version requirement string as specified in the link
@@ -144,6 +167,22 @@ module Beaker::ModuleInstallHelper
     end
     module_source_dir
   end
+
+  def forge_host
+    fh = ENV['BEAKER_FORGE_HOST']
+    return fh unless fh.nil?
+    'https://forge.puppet.com/'
+  end
+
+  def forge_api
+    fh = forge_host
+    return 'https://forgeapi.puppetlabs.com' if fh == 'https://forge.puppet.com/'
+
+    fa = ENV['BEAKER_FORGE_API']
+    return fa.gsub(/\/$/, '') unless fa.nil?
+
+    raise 'Must specify BEAKER_FORGE_API env variable when specifying custom forge host'
+  end
 end
 
 include Beaker::ModuleInstallHelper

data/spec/unit/beaker/module_install_helper_spec.rb

@@ -218,6 +218,55 @@ describe Beaker::ModuleInstallHelper do
     end
   end
 
+  context 'forge_host' do
+    context 'without env variables specified' do
+      it 'returns production forge host' do
+        allow(ENV).to receive(:[]).with('BEAKER_FORGE_HOST').and_return(nil)
+
+        expect(forge_host).to eq('https://forge.puppet.com/')
+      end
+    end
+
+    context 'with BEAKER_FORGE_HOST env variable specified' do
+      it 'returns specified forge host' do
+        allow(ENV).to receive(:[]).with('BEAKER_FORGE_HOST').and_return('http://anotherhost1.com')
+
+        expect(forge_host).to eq('http://anotherhost1.com')
+      end
+    end
+  end
+
+  context 'forge_api' do
+    context 'without env variables specified' do
+      it 'returns production forge api' do
+        allow(ENV).to receive(:[]).with('BEAKER_FORGE_HOST').and_return(nil)
+        allow(ENV).to receive(:[]).with('BEAKER_FORGE_API').and_return(nil)
+
+        expect(forge_api).to eq('https://forgeapi.puppetlabs.com')
+      end
+    end
+
+    context 'with BEAKER_FORGE_HOST and BEAKER_FORGE_API env variables specified' do
+      context 'without trailing slash' do
+        it 'returns specified forge api' do
+          allow(ENV).to receive(:[]).with('BEAKER_FORGE_HOST').and_return('custom')
+          allow(ENV).to receive(:[]).with('BEAKER_FORGE_API').and_return('an-api-url')
+
+          expect(forge_api).to eq('an-api-url')
+        end
+      end
+
+      context 'with trailing slash' do
+        it 'returns specified forge api without trailing slash' do
+          allow(ENV).to receive(:[]).with('BEAKER_FORGE_HOST').and_return('custom')
+          allow(ENV).to receive(:[]).with('BEAKER_FORGE_API').and_return('an-api-url/')
+
+          expect(forge_api).to eq('an-api-url')
+        end
+      end
+    end
+  end
+
   context 'install_module_dependencies_on' do
     before do
       allow_any_instance_of(described_class)
@@ -285,4 +334,22 @@ describe Beaker::ModuleInstallHelper do
       end
     end
   end
+
+  context 'install_module_from_forge_on' do
+    let(:a_host) { { name: 'a_host' } }
+    let(:dependency) { { module_name: 'puppetlabs-stdlib', version: '4.14.0' } }
+    let(:input_module_name) { 'puppetlabs/stdlib' }
+    let(:input_module_version_requirement) { '>= 4.13.1 <= 4.14.0' }
+
+    before do
+      expect_any_instance_of(Beaker::DSL::InstallUtils::ModuleUtils)
+        .to receive(:install_puppet_module_via_pmt_on)
+        .with(a_host, dependency)
+        .exactly(1)
+    end
+
+    it 'installs the module' do
+      install_module_from_forge_on(a_host, input_module_name, input_module_version_requirement)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker-module_install_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A helper gem for use in a Puppet Modules spec_helper_acceptance.rb file