voxpupuli-acceptance 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5703585055ce98b5b167311675cef06877eca43a25d888f24c304f9dd3cc9e48
-  data.tar.gz: 998637dd8ed80052df9988eba800bd6601fe6b90512b1b29572b1aa8d6546925
+  metadata.gz: 2cca558c11482ae56a56730bfb6f7cf338832496721011e9ab0a632925c30ecf
+  data.tar.gz: 9e7d7bb02cea97d8a8e0c76d55f0ae206e63906485816aaaef9714b5ec583482
 SHA512:
-  metadata.gz: bc2449b163a0c21a8394242b4ddd6ca920573ebd13b4cad7d2e76a87a379272b8a68ca1f1cab75f53aa2d62335bbccb6b78d1ae5bfaf61eb66e471d14978ab98
-  data.tar.gz: f7ef10e75b2f31605e8ac942a1c917f0cc86ed080bb6dc0f6d1346013a2e4b05afb64706dc665fc03f4c52bc75f1c038b41bb810f5855a36aefa18e4dbf4e331
+  metadata.gz: a655542ad8013e3d68411fa0acc005be3355c92787ef710a78e0861ae68ade67b7e7cedc13073cb2cc1c0055897e7f5c22edff62bf25dcff7d18694198b81580
+  data.tar.gz: 7d634ac527d99123981ddd1a21be72e5cc588ed55e9445941c1e080aa701eaab845b6524d3fc1c0a097f39f92ba11359520249b84aac999100b64f9a1063c828

data/lib/voxpupuli/acceptance/fixtures.rb

@@ -0,0 +1,143 @@
+require 'tmpdir'
+require 'puppet/modulebuilder'
+
+module Voxpupupli
+  module Acceptance
+    class Fixtures
+      class << self
+        # Install fixture modules on the given hosts
+        #
+        # @param [Host, Array<Host>, String, Symbol] hosts
+        #   The beaker hosts to run on
+        # @param [Array<String>, String] modulepath
+        #   A modulepath as Puppet uses it. Typically spec/fixtures/modules
+        # @param [Logger, nil] logger
+        #   An optional logger
+        def install_fixture_modules_on(hosts, modulepath, logger = nil)
+          Dir.mktmpdir do |destination|
+            modules = build_modules(modulepath, destination, logger)
+
+            install_modules_on(hosts, modules, logger)
+          end
+
+          nil
+        end
+
+        # Build modules in the given sources.
+        #
+        # @param [Array<String>, String] modulepath
+        #   A modulepath as Puppet uses it
+        # @param [String] destination
+        #   The target directory to build modules into
+        # @param [Logger, nil] logger
+        #   An optional logger
+        #
+        # @return [Hash<String=>String>]
+        #   A mapping of module names and the path to their tarball
+        def build_modules(modulepath, destination, logger = nil)
+          modulepath = [modulepath] if modulepath.is_a?(String)
+
+          modules = {}
+
+          modulepath.each do |dir|
+            Dir[File.join(dir, '*', 'metadata.json')].each do |metadata|
+              path = File.dirname(metadata)
+              name = File.basename(path)
+              next if modules.include?(name)
+
+              builder = Puppet::Modulebuilder::Builder.new(File.realpath(path), destination, logger)
+
+              unless valid_directory_name?(name, builder.metadata['name'])
+                warning = "Directory name of #{path} doesn't match metadata name #{builder.metadata['name']}"
+                if logger
+                  logger.warn(warning)
+                else
+                  STDERR.puts(warning)
+                end
+              end
+
+              modules[name] = builder.build
+            end
+          end
+
+          modules
+        end
+
+        # Install modules on a number of hosts
+        #
+        # This is done by iterating over every host. On that host a temporary
+        # directory is created. Each module is copied there and installed by
+        # force.
+        #
+        # @param [Host, Array<Host>, String, Symbol] hosts
+        #   The beaker hosts to run on
+        # @param [Hash<String=>String>] modules
+        #   A mapping between module names and their tarball
+        # @param [Logger, nil] logger
+        #   An optional logger
+        def install_modules_on(hosts, modules, logger = nil)
+          hosts.each do |host|
+            logger.debug("Installing modules on #{host}") if logger
+
+            temp_dir_on(host) do |target_dir|
+              modules.each do |name, source_path|
+                target_file = File.join(target_dir, File.basename(source_path))
+                logger.debug("Copying module #{name} from #{source_path} to #{target_file}") if logger
+
+                scp_to(host, source_path, target_file)
+                on host, puppet("module install --force --ignore-dependencies '#{target_file}'")
+              end
+            end
+          end
+
+          nil
+        end
+
+        # Create a temporay directory on the host, similar to Dir.mktmpdir but
+        # on a remote host.
+        #
+        # @example
+        #   temp_dir_on(host) { |dir| puts dir }
+        #
+        # @param [Host, String, Symbol] host
+        #   The beaker host to run on
+        def temp_dir_on(host, &block)
+          result = on host, "mktemp -d"
+          raise "Could not create directory" unless result.success?
+
+          dir = result.stdout.strip
+
+          begin
+            yield dir
+          ensure
+            on host, "rm -rf #{dir}"
+          end
+
+          nil
+        end
+
+        # Validate a directory name matches its metadata name.
+        #
+        # This is useful to detect misconfigurations in fixture set ups.
+        #
+        # @example
+        #   assert valid_directory_name?('tftp', 'theforeman-tftp')
+        # @example
+        #   refute valid_directory_name?('puppet-tftp', 'theforeman-tftp')
+        #
+        # @param [String] directory_name
+        #   Name of the directory. Not the full path
+        # @param [String] metadata_name
+        #   Name as it shows up in the metadata. It is normalized and accepts
+        #   both / and - as separators.
+        #
+        # @return [Boolean] Wether the directory name is valid with the given
+        #   metadata name
+        def valid_directory_name?(directory_name, metadata_name)
+          normalized = metadata_name.tr('/', '-').split('-').last
+          normalized == directory_name
+        end
+      end
+    end
+  end
+end

data/lib/voxpupuli/acceptance/spec_helper_acceptance.rb

@@ -1,4 +1,4 @@
-def configure_beaker(&block)
+def configure_beaker(modules: :metadata, &block)
   ENV['PUPPET_INSTALL_TYPE'] ||= 'agent'
   ENV['BEAKER_PUPPET_COLLECTION'] ||= 'puppet6'
   ENV['BEAKER_debug'] ||= 'true'
@@ -7,8 +7,14 @@ def configure_beaker(&block)
   require 'beaker-rspec'
   require 'beaker-puppet'
   require 'beaker/puppet_install_helper'
-  require 'beaker/module_install_helper'
-  $module_source_dir = get_module_source_directory caller
+
+  case modules
+  when :metadata
+    require 'beaker/module_install_helper'
+    $module_source_dir = get_module_source_directory caller
+  when :fixtures
+    require_relative 'fixtures'
+  end
 
   run_puppet_install_helper unless ENV['BEAKER_provision'] == 'no'
 
@@ -18,8 +24,14 @@ def configure_beaker(&block)
 
     # Configure all nodes in nodeset
     c.before :suite do
-      install_module
-      install_module_dependencies
+      case modules
+      when :metadata
+        install_module
+        install_module_dependencies
+      when :fixtures
+        fixture_modules = File.join(Dir.pwd, 'spec', 'fixtures', 'modules')
+        Voxpupupli::Acceptance::Fixtures.install_fixture_modules_on(hosts, fixture_modules)
+      end
 
       if block
         hosts.each do |host|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voxpupuli-acceptance
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2020-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: puppet-modulebuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rbnacl
   requirement: !ruby/object:Gem::Requirement
@@ -215,6 +229,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/voxpupuli/acceptance.rb
+- lib/voxpupuli/acceptance/fixtures.rb
 - lib/voxpupuli/acceptance/spec_helper_acceptance.rb
 homepage: http://github.com/voxpupuli/voxpupuli-acceptance
 licenses:
@@ -235,8 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.10
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Helpers for acceptance testing Vox Pupuli modules