puppet-unit-tests 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db3e14f98dbe5bcd033b2f0967db022a10d59a4df551d1b2fd196e82c77c4592
+  data.tar.gz: 420e1254f3b4b1254bdf3bf2a40c21e6ff8407e29c2ee2a0b0bff0ca3b664aed
+SHA512:
+  metadata.gz: c13c1ffa6ea8d3b68851d82eb77bc5048f6bd332ccb22baf05ee935f50d002b7b7f6135b96fbd6b77bb79324e0a64c3283c06ad2210fdfa6d81dfe2549f000df
+  data.tar.gz: fd1b2728f3db290f0a5c55b41398b749b3b0702102e277c6733d603000c595f1322d8188c58b0cd0bc9f3120e136f86464f117e019798a5c9edfbbdbe01bc464

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-09-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/README.md

@@ -0,0 +1,45 @@
+# PuppetUnitTests
+
+Write Puppet unit tests in YAML.
+
+Describe environment (facts, Hiera data, etc.) and expected result (error,
+resource in catalog, or resource not in catalog). Use stubs that may be shared
+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
+```
+
+## Usage
+
+Create a "test" directory under your module root. Create subdir "class" for
+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
+TODO: example CI/CD with Laminar?
+
+## Development
+
+TODO: review these instructions, correct and complete them.
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://codeberg.org/arlol/puppet-unit-tests. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://codeberg.org/arlol/puppet-unit-tests/src/branch/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+TODO: review automatic bundler code-of-conduct more thoroughly.
+
+Everyone interacting in the Puppetunittests project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://codeberg.org/arlol/puppet-unit-tests/src/branch/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/puppet_unit_tests/fake_facter.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module PuppetUnitTests
+  # Pretend to be Facter just for tests.
+  class FakeFacter
+    def initialize
+      @facts = {}
+    end
+
+    def value(fact_name)
+      @facts.dig(*fact_name.to_s.split("."))
+    rescue TypeError
+      nil
+    end
+
+    def clear
+      @facts.clear
+    end
+
+    def to_hash
+      @facts
+    end
+
+    def add(name, _opts = {}, &block)
+      raise "Facter.add expects a block" unless block
+
+      @facts[name.to_s] = block.call
+    end
+
+    def debugging(arg); end
+
+    def reset; end
+
+    def search(*paths); end
+
+    def setup_logging; end
+  end
+end

data/lib/puppet_unit_tests/rake_task.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rake/tasklib'
+
+require_relative 'runner'
+
+module PuppetUnitTests
+  # Simple rake task to execute tests.
+  class RakeTask < ::Rake::TaskLib
+    def initialize(name = :test, *args, &task_block)
+      super()
+      @name = name
+
+      desc 'Run Puppet unit tests' unless ::Rake.application.last_description
+      task(name, *args) do |_, task_args|
+        yield(*[self, task_args].slice(0, task_block.arity)) if task_block
+        runner = Runner.new
+        errors = runner.run
+        unless errors.empty?
+          pp errors
+          abort("Puppet unit tests failed!")
+        end
+      end
+    end
+  end
+end

data/lib/puppet_unit_tests/resource_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module PuppetUnitTests
+  # A resource that could maybe be found in a Puppet catalog.
+  class ResourceSpec
+    attr_reader :type
+    attr_reader :title
+    attr_reader :parameters
+
+    def initialize(type, title)
+      @type = type
+      @title = title
+      @parameters = {}
+    end
+
+    class << self
+      def parse(res_data)
+        rs = new(res_data["type"], res_data["title"])
+        return rs unless res_data["parameters"]
+
+        res_data["parameters"].each do |k, v|
+          rs.parameters[k] = v
+        end
+
+        rs
+      end
+    end
+  end
+end

data/lib/puppet_unit_tests/runner.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "test_environment"
+require_relative "test_data"
+
+module PuppetUnitTests
+  # Test launcher.
+  class Runner
+    def initialize
+      @env = nil
+    end
+
+    def run
+      setup
+      all_errors = {}
+
+      Dir.glob("tests/class/*.yaml") do |yaml_test_file|
+        test_data = TestData.parse(yaml_test_file)
+        test_data.trusted_facts["certname"] ||= @env.nodename
+        errors = test_data.check(@env)
+        next if errors.empty?
+
+        all_errors[test_data.name] = errors
+      end
+      # TODO: test defines
+      # TODO: test functions
+      # TODO: test plans
+
+      teardown
+
+      all_errors
+    end
+
+    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 = TestEnvironment.new do |e|
+        e.environmentpath = "tests"
+        e.hiera_config = "tests/hiera.yaml"
+        e.modulepath = "tests/modules"
+      end
+    end
+
+    def teardown
+      # TODO: remove temporary environment directory
+    end
+  end
+end

data/lib/puppet_unit_tests/test_data.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+require_relative "test_environment"
+require_relative "test_usecase"
+require_relative "resource_spec"
+
+module PuppetUnitTests
+  # YAML test data.
+  class TestData
+    attr_reader :type
+    attr_reader :name
+    attr_reader :usecases
+
+    attr_accessor :facts
+    attr_accessor :server_facts
+    attr_accessor :trusted_facts
+    attr_accessor :hiera
+    attr_accessor :settings
+    attr_accessor :stubs
+
+    def initialize(type, name, usecases)
+      @type = type
+      @name = name
+      @usecases = usecases
+    end
+
+    class << self
+      def parse(path)
+        dir = File.dirname(path)
+        type = File.basename(dir)
+        name = File.basename(path, ".yaml")
+        data = YAML.load_file(path)
+        usecases = data["usecases"].map { |dn, du| TestUsecase.parse(dn, du) }
+        td = new(type, name, usecases)
+        td.facts = data["facts"] || {}
+        td.server_facts = data["server_facts"] || {}
+        td.trusted_facts = data["trusted_facts"] || {}
+        td.hiera = data["hiera"] || {}
+        td.settings = data["settings"] || {}
+        td.stubs = data["stubs"] || []
+
+        td
+      end
+    end
+
+    def check(env)
+      hiera_data = { "global" => @hiera }
+      errors = {}
+      @usecases.each do |uc|
+        Puppet.runtime[:facter].clear
+        hiera_data["usecase"] = uc.hiera
+        Thread.current[:hiera_data] = hiera_data
+
+        uc_errors = check_usecase(env, uc)
+        next if uc_errors.empty?
+
+        errors[uc.name] = uc_errors
+      end
+
+      errors
+    end
+
+    private
+
+    def check_usecase(env, uc)
+      if uc.error
+        catalog_error(env, uc, Regexp.new(uc.error))
+      else
+        catalog = catalog(env, uc)
+        errors = []
+        errors += uc.present.map { |rs| check_present(catalog, rs) }
+        errors += uc.absent.map { |rs| check_absent(catalog, rs) }
+
+        errors.flatten.compact
+      end
+    rescue Puppet::PreformattedError => e
+      [e.message]
+    end
+
+    def check_present(catalog, rs)
+      res_disp = "#{rs.type}[#{rs.title}]"
+      res = catalog.resource(rs.type, rs.title)
+      return ["missing resource #{res_disp}"] unless res
+      return [] if rs.parameters.empty?
+
+      rs.parameters.map do |k, v|
+        val = res[k]
+        if val == v
+          nil
+        else
+          "#{res_disp}##{k}: expected #{v}, got #{val}"
+        end
+      end
+    end
+
+    def check_absent(catalog, rs)
+      res_disp = "#{rs.type}[#{rs.title}]"
+      res = catalog.resource(rs.type, rs.title)
+      return [nil] unless res
+      return [nil] if rs.parameters.all? { |k, v| res[k] == v }
+
+      ["#{res_disp} should be absent"]
+    end
+
+    def catalog(env, usecase)
+      env.compile(
+        code(usecase),
+        facts: @facts.merge(usecase.facts),
+        server_facts: @server_facts.merge(usecase.server_facts),
+        trusted_facts: @trusted_facts.merge(usecase.trusted_facts)
+      )
+    end
+
+    def catalog_error(env, usecase, regexp)
+      catalog(env, usecase)
+    rescue Puppet::ParseError => e
+      if regexp.match?(e.message)
+        []
+      else
+        [e.message]
+      end
+    end
+
+    def code(uc)
+      case @type
+      when "class" then "include #{@name}"
+      when "define"
+        parameters = uc.parameters.map { |k, v| "#{k} => #{v.inspect}" }
+        <<~EOPP
+          #{@name} { #{uc.title}:
+            #{parameters.join(",\n  ")}
+          }
+        EOPP
+      else raise "#{@type} not implemented"
+      end
+    end
+  end
+end

data/lib/puppet_unit_tests/test_environment.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require "puppet"
+require_relative "fake_facter"
+
+module PuppetUnitTests
+  # Puppet environment for tests.
+  class TestEnvironment
+    SETTINGS_DEFAULT = {
+      confdir: "/dev/null",
+      vardir: "/dev/null",
+      logdir: "/dev/null",
+      publicdir: "/dev/null",
+      codedir: "/dev/null",
+      rundir: "/dev/null",
+      hiera_config: "/dev/null",
+      modulepath: "/dev/null",
+      basemodulepath: "/dev/null",
+      config: nil,
+      environmentpath: "/dev/null",
+      strict_variables: true,
+      vendormoduledir: "/dev/null"
+    }.freeze
+
+    attr_accessor :nodename
+    attr_accessor :stubs_dir
+
+    def initialize
+      @nodename = "testnode"
+      @stubsdir = Pathname.new("stubs")
+      @settings = SETTINGS_DEFAULT.dup
+      yield self if block_given?
+
+      @puppet_env = global_setup(@settings)
+      Puppet.push_context(
+        {
+          loaders: Puppet::Pops::Loaders.new(@puppet_env),
+          current_environment: @puppet_env
+        },
+        "Environment-level test context"
+      )
+    end
+
+    def hiera_config=(path)
+      @settings[:hiera_config] = Pathname.new(path).realpath
+    end
+
+    def modulepath=(path)
+      @settings[:modulepath] = Pathname.new(path).realpath
+    end
+
+    def environmentpath=(path)
+      @settings[:environmentpath] = Pathname.new(path).realpath
+    end
+
+    def compile(code, facts:, server_facts:, trusted_facts:, stubs: [])
+      # TODO: Puppet.features.add(:posix) { true } if facts match UNIX
+
+      code = stubs.map do |st|
+        stub_path = @stubsdir.join("#{st}.pp")
+        File.read(stub_path)
+      end.join($RS) + code
+
+      Puppet.runtime[:facter].clear
+      name = trusted_facts["certname"]
+      node_facts = Puppet::Node::Facts.new(name, facts)
+      node = Puppet::Node.new(name, parameters: {}, facts: node_facts)
+      trusted_info = ["remote", name, trusted_facts]
+      Puppet.push_context(
+        {
+          trusted_information: Puppet::Context::TrustedInformation.new(*trusted_info)
+        },
+        "Context for test code"
+      )
+      node.environment = @puppet_env
+      node.add_server_facts(server_facts)
+
+      Puppet[:code] = code
+      catalog = Puppet::Resource::Catalog.indirection.find(
+        node.name, use_node: node
+      )
+      Puppet::Pops::Evaluator::DeferredResolver.resolve_and_replace(
+        node.facts, catalog
+      )
+      Puppet.pop_context
+
+      catalog
+    end
+
+    private
+
+    def global_setup(settings)
+      Puppet.runtime[:facter] = FakeFacter.new
+      Puppet.settings.initialize_app_defaults(settings)
+
+      env = Puppet::Node::Environment.create(
+        :test_env,
+        [settings[:modulepath]],
+        Puppet::Node::Environment::NO_MANIFEST
+      )
+      loader = Puppet::Environments::Static.new(env)
+      Puppet.push_context(
+        {
+          environments: loader,
+          stringify_rich: false,
+          rich_data: false,
+          current_environment: env
+        },
+        "Top-level test context"
+      )
+
+      env
+    end
+  end
+end

data/lib/puppet_unit_tests/test_usecase.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "resource_spec"
+
+module PuppetUnitTests
+  # A test usecase.
+  class TestUsecase
+    attr_reader :name
+
+    attr_accessor :facts
+    attr_accessor :server_facts
+    attr_accessor :trusted_facts
+    attr_accessor :hiera
+    attr_accessor :settings
+
+    attr_accessor :present
+    attr_accessor :absent
+    attr_accessor :error
+
+    def initialize(name)
+      @name = name
+      @present = []
+      @absent = []
+      @error = nil
+    end
+
+    class << self
+      def parse(name, data_usecase)
+        uc = new(name)
+        uc.facts = data_usecase["facts"] || {}
+        uc.server_facts = data_usecase["server_facts"] || {}
+        uc.trusted_facts = data_usecase["trusted_facts"] || {}
+        uc.hiera = data_usecase["hiera"] || {}
+        uc.settings = data_usecase["settings"] || {}
+
+        uc.error = data_usecase["error"]
+        if data_usecase.key?("present")
+          uc.present = data_usecase["present"].map do |rs|
+            ResourceSpec.parse(rs)
+          end
+        end
+        if data_usecase.key?("absent")
+          uc.present = data_usecase["absent"].map do |rs|
+            ResourceSpec.parse(rs)
+          end
+        end
+
+        uc
+      end
+    end
+  end
+end

data/lib/puppet_unit_tests/version.rb

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

data/lib/puppet_unit_tests.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "puppet_unit_tests/version"
+
+module PuppetUnitTests
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: puppet-unit-tests
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arlo le Rouge
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: openvox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: |
+  Describe environment (facts, Hiera data, etc.) and expected result (error,
+  resource in catalog, or resource not in catalog). Use stubs that may be shared
+  with other modules.
+email:
+- jpi+puppetunittests@arlol.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- Rakefile
+- lib/puppet_unit_tests.rb
+- lib/puppet_unit_tests/fake_facter.rb
+- lib/puppet_unit_tests/rake_task.rb
+- lib/puppet_unit_tests/resource_spec.rb
+- lib/puppet_unit_tests/runner.rb
+- lib/puppet_unit_tests/test_data.rb
+- lib/puppet_unit_tests/test_environment.rb
+- lib/puppet_unit_tests/test_usecase.rb
+- lib/puppet_unit_tests/version.rb
+homepage: https://codeberg.org/arlol/puppet-unit-tests
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://codeberg.org/arlol/puppet-unit-tests
+  source_code_uri: https://codeberg.org/arlol/puppet-unit-tests.git
+  changelog_uri: https://codeberg.org/arlol/puppet-unit-tests/src/branch/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: Write Puppet unit tests in YAML.
+test_files: []