simp-rake-helpers 5.4.3 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c6ce6418a9a5502135d802a6a96f42ee4b3660f
-  data.tar.gz: 2b18c76399ef02e72ca986723cb24f41d2b69267
+  metadata.gz: 834fc98fb63f04a0f5e9bb98c275ffd42738123c
+  data.tar.gz: c0d3fc5372f4e3c99893e33d3e345886d41c069c
 SHA512:
-  metadata.gz: a66462436bec15a83457fa138effaa890773b7b8a681c1bee75d7c2901bc0426e1d0b37e64d417807072a62572d59de7450a82a51c69ca57b620315eac95d6a6
-  data.tar.gz: d45a422e9781164aa8df97f6542ff404a1d85284abecc1feff1c1d8f650d18bad155ba9289d8fc0b36ae6ab397c01847e30c6fa35c9feb3c00cbdf9141a97f19
+  metadata.gz: efee59c86535eaa39046ea0c06133a57e8b4a1bf4a3f4419983741a516493aaf17f590764630b44c3d2bbaeb0a0f0d6d55d4b758595e341a616b9d39f75f61b0
+  data.tar.gz: 3f70e19f9587f9aa5124255f3bb9305d976c107879a0f348c8cb44aff119504e98d010c7755d0a046e4156777a05956100505cfc12bb9321dfc65cb51cae6b22

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 5.5.0 / 2018-06-22
+* Pin fog-openstack to 0.1.25 if Ruby is prior to 2.2.0 due to a deprecation
+* Fix regression that broke env var `SIMP_BUILD_distro`
+* Add support for setting SIMP_RSPEC_PUPPETFILE and/or SIMP_RSPEC_MODULEPATH to
+  create a custom fixtures.yml based on a Puppetfile, the modules in a
+  directory, or the combination of both.
+  
 ### 5.4.3 / 2018-03-29
 * Fix RPM release processing when generating 'Obsoletes' metadata
 

data/README.md

@@ -16,6 +16,7 @@
   * [Gemfile](#gemfile)
 * [Usage](#usage)
   * [In a Puppet module](#in-a-puppet-module)
+  * [Environment Variables](#environment-variables)
   * [In a Ruby Gem](#in-a-ruby-gem)
   * [Generating RPMs](#generating-rpms)
     * [RPM Changelog](#rpm-changelog)
@@ -99,6 +100,32 @@ require 'simp/rake/pupmod/helpers'
 Simp::Rake::Pupmod::Helpers.new(File.dirname(__FILE__))
 ```
 
+### Environment Variables
+
+Some environment variables have been added to help you work with different
+types of testing scenarios and are documented below.
+
+By default, only the modules found in the local `.fixtures.yml` file will be
+included.
+
+* `SIMP_RSPEC_PUPPETFILE`
+  * Ignore the local `.fixtures.yml` and use the modules listed in the specified Puppetfile
+  * Downloaded items that are not Puppet modules will be removed from the
+    downloaded fixtures prior to testing
+  * Set this to a valid URL to download a remote Puppetfile for use
+
+* `SIMP_RSPEC_MODULEPATH`
+  * Will ignore the local `.fixtures.yml` file and create one entirely of
+    symlinks that point to the modules present at the specified path.
+  * If specified with `SIMP_RSPEC_PUPPETFILE` then will use the
+    matching modules from the target directory instead of downloading them.
+    Modules not present in the target directory will still be downloaded.
+
+* `SIMP_RSPEC_FIXTURES_OVERRIDE`
+  * Set to `yes` to ignore the local `.fixtures.yml` file
+  * This will cause the generated file to include **all** modules from the
+    Puppetfile or Module Path
+
 ### In a Ruby Gem
 
 Within the project's Rakefile:
@@ -108,7 +135,7 @@ require 'simp/rake/rubygem'
 
 # e.g., "simp-rake-helpers"
 package = 'name-of-rubygem'
-Simp::Rake::Rubygem.new(package, File.direname(__FILE__)
+Simp::Rake::Rubygem.new(package, File.dirname(__FILE__)
 
 ```
 
@@ -136,7 +163,7 @@ directory .  The full list of files considered are:
 ├── metadata.json     # REQUIRED keys: name, version, license, summary, source
 ├── CHANGELOG         # OPTIONAL written in RPM's CHANGELOG format
 └── build/            # OPTIONAL
-    └── rpm_metadata/ # OPTIONAL
+    └── rpm_metadata/ # OPTIONAL
         ├── release   # OPTIONAL defines the RPM's "-0" release number
         ├── requires  # OPTIONAL supplementary 'Requires','Provides','Obsoletes'
         └── custom/   # OPTIONAL
@@ -204,8 +231,8 @@ Build the tar package for the current SIMP project
 
 This is a limitation of Bundler, not the gem.
 
-If you are running on a FIPS-enabled system, you will need to use `bundler '~> 1.14.0'`
-until the FIPS support can be corrected.
+If you are running on a FIPS-enabled system, you will need to use
+`bundler '~> 1.14.0'` or `bundler '~> 1.16'`
 
 If you are using RVM, the appropriate steps are as follows:
 

data/lib/simp/rake/build/constants.rb

@@ -11,9 +11,13 @@ module Simp::Rake::Build::Constants
     $simp6 = true
     $simp6_clean_dirs = []
 
-    @build_distro = Facter.fact('operatingsystem').value
-    @build_version = Facter.fact('operatingsystemmajrelease').value
-    @build_arch = Facter.fact('architecture').value
+    if ENV['SIMP_BUILD_distro']
+      distro, version, arch = ENV['SIMP_BUILD_distro'].split(/,|\//)
+    end
+
+    @build_distro = distro || Facter.fact('operatingsystem').value
+    @build_version = version || Facter.fact('operatingsystemmajrelease').value
+    @build_arch = arch || Facter.fact('architecture').value
 
     @run_dir           = Dir.pwd
     @base_dir          = base_dir

data/lib/simp/rake/build/deps.rb

@@ -85,6 +85,8 @@ class R10KHelper
         mod = {
           :name        => mod.name,
           :path        => mod.path.to_s,
+          :remote      => mod.repo.instance_variable_get('@remote'),
+          :desired_ref => mod.desired_ref,
           :git_source  => mod.repo.repo.origin,
           :git_ref     => mod.repo.head,
           :module_dir  => mod.basedir,

data/lib/simp/rake/helpers/version.rb

@@ -2,5 +2,5 @@ module Simp; end
 module Simp::Rake; end
 
 class Simp::Rake::Helpers
-  VERSION = '5.4.3'
+  VERSION = '5.5.0'
 end

data/lib/simp/rake/pupmod/helpers.rb

@@ -17,6 +17,19 @@ module Simp; end
 module Simp::Rake; end
 module Simp::Rake::Pupmod; end
 
+# From http://dan.doezema.com/2012/04/recursively-sort-ruby-hash-by-key/
+class Hash
+  def sort_by_key(recursive = false, &block)
+    self.keys.sort(&block).reduce({}) do |seed, key|
+      seed[key] = self[key]
+      if recursive && seed[key].is_a?(Hash)
+        seed[key] = seed[key].sort_by_key(true, &block)
+      end
+      seed
+    end
+  end
+end
+
 # Rake tasks for SIMP Puppet modules
 class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
   # See https://fedoraproject.org/wiki/Packaging:Guidelines?rd=Packaging/Guidelines#Changelogs
@@ -24,11 +37,16 @@ class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
 
   def initialize( base_dir = Dir.pwd )
     @base_dir = base_dir
+    @temp_fixtures_path = File.join(base_dir,'spec','fixtures','simp_rspec')
+
+    FileUtils.mkdir_p(@temp_fixtures_path)
+
     Dir[ File.join(File.dirname(__FILE__),'*.rb') ].each do |rake_file|
       next if rake_file == __FILE__
       require rake_file
     end
     define_tasks
+
   end
 
   def define_tasks
@@ -63,6 +81,7 @@ class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
 
     Simp::Rake::Pkg.new( @base_dir ) do | t |
       t.clean_list << "#{t.base_dir}/spec/fixtures/hieradata/hiera.yaml"
+      t.clean_list << @temp_fixtures_path
     end
 
     Simp::Rake::Beaker.new( @base_dir )
@@ -133,6 +152,115 @@ class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
       result += changelogs[module_version].join
     end
 
+    def custom_fixtures_hook(opts = {
+      :short_name          => nil,
+      :puppetfile          => nil,
+      :modulepath          => nil,
+      :local_fixtures_mods => nil,
+    })
+      short_name          = opts[:short_name]
+      puppetfile          = opts[:puppetfile]
+      modulepath          = opts[:modulepath]
+      local_fixtures_mods = opts[:local_fixtures_mods] || []
+
+      fail('You must pass a short module name') unless short_name
+
+      fixtures_hash = {
+        'fixtures' => {
+          'symlinks' => {
+            short_name => '#{source_dir}'
+          }
+        }
+      }
+
+      local_modules = {}
+
+      if modulepath
+        unless File.directory?(modulepath)
+          fail("Could not find a module directory at #{modulepath}")
+        end
+
+        # Grab all of the local modules and convert them into something
+        # that can be turned into a Hash easily
+        local_modules = Hash[Dir.glob(File.join(modulepath, '*', 'metadata.json')).map do |m|
+          [File.basename(File.dirname(m)), File.absolute_path(File.dirname(m))]
+        end]
+
+        local_modules.delete(short_name)
+      end
+
+      if puppetfile
+        fail("Could not find Puppetfile at #{puppetfile}") unless File.exist?(puppetfile)
+
+        require 'simp/rake/build/deps'
+
+        puppetfile = R10KHelper.new(puppetfile)
+
+        puppetfile.modules.each do |pupmod|
+          next unless pupmod[:name]
+          next if pupmod[:status] == :unknown
+
+          if local_modules[pupmod[:name]]
+            unless local_fixtures_mods.empty?
+              local_fixtures_mod = local_fixtures_mods.delete(pupmod[:name])
+              next unless local_fixtures_mod
+            end
+
+            fixtures_hash['fixtures']['symlinks'][pupmod[:name]] = local_modules[pupmod[:name]]
+          else
+            fixtures_hash['fixtures']['repositories'] ||= {}
+
+            unless local_fixtures_mods.empty?
+              local_fixtures_mod = local_fixtures_mods.delete(pupmod[:name])
+              next unless local_fixtures_mod
+            end
+
+            next unless pupmod[:remote] && pupmod[:desired_ref]
+            next if pupmod[:name] == short_name
+
+            fixtures_hash['fixtures']['repositories'][pupmod[:name]] = {
+              'repo' => pupmod[:remote],
+              'ref'  => pupmod[:desired_ref]
+            }
+          end
+        end
+      elsif modulepath
+        local_modules.each_pair do |pupmod, path|
+          unless local_fixtures_mods.empty?
+            local_fixtures_mod = local_fixtures_mods.delete(pupmod)
+            next unless local_fixtures_mod
+          end
+
+          fixtures_hash['fixtures']['symlinks'][pupmod] = path
+        end
+      end
+
+      if local_fixtures_mods.empty?
+        custom_fixtures_path = File.join(@temp_fixtures_path, 'fixtures.yml')
+      else
+        custom_fixtures_path = File.join(@temp_fixtures_path, 'fixtures_tmp.yml')
+      end
+
+      if puppetfile || modulepath
+        File.open(custom_fixtures_path, 'w') do |fh|
+          fh.puts(fixtures_hash.sort_by_key(true).to_yaml)
+        end
+      end
+
+      unless local_fixtures_mods.empty?
+        errmsg = [
+          '===',
+          'The following modules in .fixtures.yml were not found in the Puppetfile:',
+          %{  * #{local_fixtures_mods.join("\n  * ")}},
+          %{A temporary fixtures file has been written to #{custom_fixtures_path}},
+          '==='
+        ]
+
+        fail(errmsg.join("\n"))
+      end
+
+      return custom_fixtures_path
+    end
 
     desc <<-EOM
       Generate an appropriate annotated tag entry from a CHANGELOG.
@@ -287,5 +415,81 @@ class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
         Rake::Task[:spec_clean].invoke
       end
     end
+
+    # This hidden task provides a way to create and use a fixtures.yml file
+    # based on an externally specified Puppetfile
+    #
+    # The resulting fixtures.yml will contain only those modules that are
+    # in the local fixtures.yml but with the version specified in the
+    # Puppetfile.
+    #
+    # Downloaded repos that do not contain a metadata.json will be removed
+    #
+    # Set the environment variable SIMP_RSPEC_PUPPETFILE to point to a remote Puppetfile
+    #
+    # Set the environment variable SIMP_RSPEC_FIXTURES_OVERRIDE to 'yes' to
+    # ignore the local fixtures.yml file.
+    #
+    # Set the environment variable SIMP_RSPEC_MODULEPATH to symlink named
+    # modules from the designated directory instead of downloading them.
+    #
+    # If both SIMP_RSPEC_PUPPETFILE and SIMP_RSPEC_MODULEPATH are specified,
+    # the Puppetfile will win.
+    task :custom_fixtures_hook do
+      # Don't do anything if the user has already set a path to their fixtures
+      unless ENV['FIXTURES_YML']
+        @custom_fixtures_hook_override_fixtures = (ENV.fetch('SIMP_RSPEC_FIXTURES_OVERRIDE', 'no') == 'yes')
+
+        opts = { :short_name => metadata['name'].split('-').last }
+
+        if ENV['SIMP_RSPEC_PUPPETFILE']
+          puppetfile = ENV['SIMP_RSPEC_PUPPETFILE']
+
+          puppetfile_tgt = File.join(@temp_fixtures_path, 'Puppetfile')
+
+          if puppetfile =~ %r{://}
+            %x{curl -k -s -o #{puppetfile_tgt} #{puppetfile}}
+          else
+            FileUtils.cp(File.absolute_path(puppetfile), puppetfile_tgt)
+          end
+
+          opts[:puppetfile] = puppetfile_tgt
+        end
+
+        if ENV['SIMP_RSPEC_MODULEPATH']
+          opts[:modulepath] = File.absolute_path(ENV['SIMP_RSPEC_MODULEPATH'])
+        end
+
+        if opts[:puppetfile] || opts[:modulepath]
+          unless @custom_fixtures_hook_override_fixtures
+            fail("Could not find '.fixtures.yml' at #{Dir.pwd}") unless File.exist?('.fixtures.yml')
+
+            opts[:local_fixtures_mods] = []
+
+            require 'yaml'
+            _fixtures = YAML.load_file('.fixtures.yml')['fixtures']
+            _fixtures.keys.each do |subset|
+              _fixtures[subset].each_pair do |_mod, _extra|
+                opts[:local_fixtures_mods] << _mod
+              end
+            end
+          end
+
+          fixtures_yml_path = custom_fixtures_hook(opts)
+
+          if fixtures_yml_path
+            ENV['FIXTURES_YML'] = fixtures_yml_path
+          end
+        end
+      end
+    end
+
+    Rake::Task['spec_prep'].enhance [:custom_fixtures_hook] do
+      Dir.glob(File.join('spec','fixtures','modules','*')).each do |dir|
+        if @custom_fixtures_hook_override_fixtures
+          FileUtils.remove_entry_secure(dir) unless File.exist?(File.join(dir, 'metadata.json'))
+        end
+      end
+    end
   end
 end

data/spec/lib/simp/rpm_spec.rb

@@ -3,7 +3,6 @@ require 'spec_helper'
 
 describe Simp::RPM do
   before :all do
-    Simp::RPM.stubs(:system_dist).returns('.testdist')
 
     dir          = File.expand_path( 'files', File.dirname( __FILE__ ) )
     @spec_file   = File.join( dir, 'testpackage.spec' )
@@ -225,10 +224,16 @@ describe Simp::RPM do
 
     context '#dist' do
       it 'returns dist' do
-        expect( @rpm_obj.dist ).to eq '.testdist'
-        expect( @d_rpm_obj.dist ).to eq '.el7'
-        expect( @spec_obj.dist ).to eq '.testdist'
-        expect( @d_spec_obj.dist ).to eq '.testdist'
+        Simp::RPM.stubs(:system_dist).returns('.testdist')
+        rpm_obj    = Simp::RPM.new( @rpm_file )
+        d_rpm_obj  = Simp::RPM.new( @d_rpm_file )
+        spec_obj   = Simp::RPM.new( @spec_file )
+        d_spec_obj = Simp::RPM.new( @d_spec_file )
+
+        expect( rpm_obj.dist ).to eq '.testdist'
+        expect( d_rpm_obj.dist ).to eq '.el7'
+        expect( spec_obj.dist ).to eq '.testdist'
+        expect( d_spec_obj.dist ).to eq '.testdist'
       end
 
       it 'fails when invalid package specified' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simp-rake-helpers
 version: !ruby/object:Gem::Version
-  version: 5.4.3
+  version: 5.5.0
 platform: ruby
 authors:
 - Chris Tessmer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2018-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -267,20 +267,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: listen
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.6
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.6
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -329,48 +315,6 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 1.6.1
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: guard-shell
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 description: '    "simp-rake-helpers provides common methods for SIMP Rake Tasks"
 
 '