puppet-unit-tests 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db3e14f98dbe5bcd033b2f0967db022a10d59a4df551d1b2fd196e82c77c4592
-  data.tar.gz: 420e1254f3b4b1254bdf3bf2a40c21e6ff8407e29c2ee2a0b0bff0ca3b664aed
+  metadata.gz: 1d7ab89c77ec25cf0bcb946265debd9067ce1a30fc28b1ae42de86e482858056
+  data.tar.gz: 3e2040483fded2adbb3cce542dbe83b760c8d01bf6805e11265cfbabfa615cc5
 SHA512:
-  metadata.gz: c13c1ffa6ea8d3b68851d82eb77bc5048f6bd332ccb22baf05ee935f50d002b7b7f6135b96fbd6b77bb79324e0a64c3283c06ad2210fdfa6d81dfe2549f000df
-  data.tar.gz: fd1b2728f3db290f0a5c55b41398b749b3b0702102e277c6733d603000c595f1322d8188c58b0cd0bc9f3120e136f86464f117e019798a5c9edfbbdbe01bc464
+  metadata.gz: c9e3892eaa8f0ffd9a1f284466947ad0b1992a39f37ed4b5b52c02945f993ab0c5a8ed936cd4a80fb0ea608946a983b907968ab2e81402925ac0f91c78669bd0
+  data.tar.gz: 71bac823f2808ace6ea055e67a74e3c0248eb42c0068e1f65fd7a370981ee0907d1e18730e5c15ab0a8702215d31fda908d2dac6053912d6af55f42d92d10697

data/README.md

@@ -8,12 +8,10 @@ with other modules.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install this gem on your development and CI/CD hosts:
 
 ```bash
-/opt/puppetlabs/puppet/bin/gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+/opt/puppetlabs/puppet/bin/gem install puppet-unit-tests
 ```
 
 ## Usage
@@ -23,7 +21,22 @@ classes, "define" for defined types. Create YAML files inside this directories
 with usecases and expected results.
 
 TODO: write a minimal example here and create an "examples" directory.
-TODO: write rake task
+
+Add these lines to your Rakefile:
+
+```ruby
+require 'puppet_unit_tests/rake_task'
+PuppetUnitTests::RakeTask.new
+```
+
+TODO: how to customize task name
+
+Run tests with:
+
+```bash
+rake test
+```
+
 TODO: example CI/CD with Laminar?
 
 ## Development

data/assets/test-env/hiera.yaml

@@ -0,0 +1,12 @@
+---
+version: 5
+defaults:
+  datadir: 'data'
+  data_hash: 'test_data'
+#  data_hash: 'yaml_data'
+
+hierarchy:
+  - name: "test Hiera data"
+    uris:
+      - usecase
+      - global

data/assets/test-env/lib/puppet/functions/test_data.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+Puppet::Functions.create_function(:'test_data') do
+  dispatch :test_data do
+    param 'Struct[{uri=>String[1]}]', :options
+    param 'Puppet::LookupContext', :context
+  end
+
+  argument_mismatch :missing_uri do
+    param 'Hash', :options
+    param 'Puppet::LookupContext', :context
+  end
+
+  def test_data(options, _context)
+    uri = options['uri']
+    hiera_data = Thread.current[:hiera_data]
+    return {} unless hiera_data
+
+    hiera_data[uri] || {}
+  end
+
+  def missing_uri(_options, _context)
+    "one of 'uri' or 'uris' must be declared in hiera.yaml " \
+      'when using this data_hash function.'
+  end
+end

data/lib/puppet_unit_tests/runner.rb

@@ -6,8 +6,12 @@ require_relative "test_data"
 module PuppetUnitTests
   # Test launcher.
   class Runner
-    def initialize
+    def initialize(assets_dir = nil)
       @env = nil
+      @assets_dir = assets_dir || File.realpath(
+        File.join(__dir__, '..', '..', 'assets')
+      )
+      @env_dir = nil
     end
 
     def run
@@ -34,20 +38,22 @@ module PuppetUnitTests
     private
 
     def setup
-      # TODO: create temporary environment directory
-      # TODO: create modules directory
-      # TODO: create module with test Hiera provider
-      # TODO: create hiera config file
-      # TODO: create symlink to tested module
+      @env_dir = Dir.mktmpdir('puppet-test-env')
+      FileUtils.mkdir(File.join(@env_dir, 'modules'))
+      FileUtils.copy_entry(
+        File.join(@assets_dir, 'test-env'),
+        @env_dir
+      )
+      FileUtils.ln_s(Dir.pwd, File.join(@env_dir, 'modules'))
       @env = TestEnvironment.new do |e|
-        e.environmentpath = "tests"
-        e.hiera_config = "tests/hiera.yaml"
-        e.modulepath = "tests/modules"
+        e.environmentpath = @env_dir
+        e.hiera_config = File.join(@env_dir, "hiera.yaml")
+        e.modulepath = File.join(@env_dir, "modules")
       end
     end
 
     def teardown
-      # TODO: remove temporary environment directory
+      FileUtils.rmtree(@env_dir) if @env_dir
     end
   end
 end

data/lib/puppet_unit_tests/test_environment.rb

@@ -98,7 +98,9 @@ module PuppetUnitTests
         [settings[:modulepath]],
         Puppet::Node::Environment::NO_MANIFEST
       )
-      loader = Puppet::Environments::Static.new(env)
+      loader = Puppet::Environments::StaticDirectory.new(
+        env.name, settings[:environmentpath], env
+      )
       Puppet.push_context(
         {
           environments: loader,

data/lib/puppet_unit_tests/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PuppetUnitTests
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-unit-tests
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Arlo le Rouge
@@ -37,6 +37,8 @@ files:
 - CODE_OF_CONDUCT.md
 - README.md
 - Rakefile
+- assets/test-env/hiera.yaml
+- assets/test-env/lib/puppet/functions/test_data.rb
 - lib/puppet_unit_tests.rb
 - lib/puppet_unit_tests/fake_facter.rb
 - lib/puppet_unit_tests/rake_task.rb