kitchen-dsc 0.12.0 → 0.13.0

data/spec/spec_helper.rb

@@ -1,20 +1,74 @@
+# frozen_string_literal: true
+
 #
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2012, Fletcher Nichol
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
+# Copyright (C) 2014 Steven Murawski
 #
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+# Licensed under the Apache 2 License.
+# See LICENSE for more details
+
+# Coverage must be started before any library code is loaded, otherwise methods
+# defined at require-time are recorded as uncovered. Set COVERAGE=false to skip
+# it (useful when bisecting or profiling a single spec file).
+unless ENV["COVERAGE"] == "false"
+  require "simplecov"
+
+  SimpleCov.start do
+    enable_coverage :branch
+    add_filter "/spec/"
+    track_files "lib/**/*.rb"
+    # Deliberately no `minimum_coverage`: coverage is a diagnostic here, not a
+    # gate. CI must never fail because a percentage moved.
+  end
+end
+
+require "kitchen"
+require "kitchen/provisioner/dsc"
+require "kitchen-dsc/version"
+
+require "stringio"
+require "tmpdir"
+
+Dir[File.expand_path("support/**/*.rb", __dir__)].sort.each { |file| require file }
+
+RSpec.configure do |config|
+  config.include KitchenHelpers
+
+  # rspec-expectations
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    # The provisioner emits multi-kilobyte PowerShell scripts; truncating the
+    # diff on failure hides the one line that actually differs.
+    expectations.max_formatted_output_length = nil
+  end
+
+  # rspec-mocks
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.example_status_persistence_file_path = "spec/examples.txt"
+  config.disable_monkey_patching!
+  config.raise_errors_for_deprecations!
+
+  config.default_formatter = "doc" if config.files_to_run.one?
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  # Ruby warnings are opt-in: test-kitchen and its transitive dependencies emit
+  # enough of their own to drown out anything this gem causes.
+  config.warnings = ENV["RSPEC_WARNINGS"] == "true"
 
-gem "minitest"
+  # Keep Test Kitchen's global logger out of the spec output. Individual
+  # examples get their own logger via KitchenHelpers#kitchen_log.
+  config.before(:suite) do
+    Kitchen.logger = Kitchen::Logger.new(stdout: StringIO.new, level: :debug)
+  end
 
-require "minitest/autorun"
+  config.after do
+    cleanup_kitchen_tmpdirs
+  end
+end

data/spec/support/kitchen_helpers.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "stringio"
+require "tmpdir"
+
+require "kitchen/driver/dummy"
+require "kitchen/transport/dummy"
+require "kitchen/verifier/dummy"
+
+# Helpers for exercising {Kitchen::Provisioner::Dsc} against a genuine
+# {Kitchen::Instance}.
+#
+# The provisioner reads most of its behaviour out of `config`, and Test Kitchen
+# populates `config` in two passes: static `default_config` values, then lazy
+# `default_config` blocks that are only evaluated once an instance is attached
+# (`Kitchen::Provisioner::Dsc` uses one to derive `:configuration_name` from the
+# suite name). Building a real instance with the stock dummy driver, transport
+# and verifier gets both passes for free; a hand-rolled double would silently
+# skip the second.
+module KitchenHelpers
+  # Default `:root_path` used by the specs. Test Kitchen's Windows default,
+  # spelled out here so expectations can refer to it by name.
+  DEFAULT_ROOT_PATH = 'C:\\kitchen'
+
+  # Name of the suite the built instance runs. Override with `let(:suite_name)`
+  # to exercise the `:configuration_name` default, which is derived from it.
+  #
+  # @return [String] the suite name
+  def suite_name
+    "default"
+  end
+
+  # Name of the platform the built instance runs. Anything starting with `win`
+  # gives the instance a `powershell` shell type; override with
+  # `let(:platform_name)` to test the bourne path.
+  #
+  # @return [String] the platform name
+  def platform_name
+    "windows-2022"
+  end
+
+  # Builds a provisioner wired to a real instance.
+  #
+  # @param config [Hash] provisioner configuration, merged over the defaults
+  # @return [Kitchen::Provisioner::Dsc] a finalized provisioner
+  def build_provisioner(config = {})
+    defaults = { kitchen_root:, root_path: DEFAULT_ROOT_PATH }
+    provisioner = Kitchen::Provisioner::Dsc.new(defaults.merge(config))
+    build_instance(provisioner)
+    provisioner
+  end
+
+  # Builds the {Kitchen::Instance} that owns +provisioner+.
+  #
+  # Constructing the instance is what calls `Provisioner#finalize_config!`, so
+  # this is also what exercises the provisioner's LCM configuration merge.
+  #
+  # @param provisioner [Kitchen::Provisioner::Base] the provisioner under test
+  # @return [Kitchen::Instance] the built instance
+  def build_instance(provisioner)
+    state_file = Kitchen::StateFile.new(kitchen_root, "#{suite_name}-#{platform_name}")
+
+    Kitchen::Instance.new(
+      suite: Kitchen::Suite.new(name: suite_name),
+      platform: Kitchen::Platform.new(name: platform_name),
+      driver: Kitchen::Driver::Dummy.new,
+      provisioner:,
+      transport: Kitchen::Transport::Dummy.new,
+      verifier: Kitchen::Verifier::Dummy.new,
+      lifecycle_hooks: Kitchen::LifecycleHooks.new({}, state_file),
+      state_file:,
+      logger: kitchen_logger
+    )
+  end
+
+  # Creates the provisioner's sandbox and registers it for cleanup.
+  #
+  # {Kitchen::Provisioner::Base#create_sandbox} mints its own temporary
+  # directory, so it has to be tracked separately from {#kitchen_root}.
+  #
+  # @param provisioner [Kitchen::Provisioner::Dsc] the provisioner under test
+  # @return [String] absolute path to the created sandbox
+  def create_sandbox_for(provisioner)
+    provisioner.create_sandbox
+    register_tmpdir(provisioner.sandbox_path)
+  end
+
+  # The temporary directory standing in for the user's cookbook/module root.
+  #
+  # @return [String] absolute path to the kitchen root
+  def kitchen_root
+    @kitchen_root ||= register_tmpdir(Dir.mktmpdir("kitchen-dsc-root-"))
+  end
+
+  # Everything the provisioner has logged during the current example.
+  #
+  # @return [String] captured log output
+  def kitchen_log
+    log_device.string
+  end
+
+  # @return [Kitchen::Logger] a debug-level logger writing to {#log_device}
+  def kitchen_logger
+    @kitchen_logger ||= Kitchen::Logger.new(stdout: log_device, level: :debug)
+  end
+
+  # Writes a file beneath {#kitchen_root}, creating parent directories.
+  #
+  # @param relative_path [String] path relative to the kitchen root
+  # @param content [String] file contents
+  # @return [String] the absolute path written
+  def write_kitchen_file(relative_path, content = "# fixture\n")
+    path = File.join(kitchen_root, relative_path)
+    FileUtils.mkdir_p(File.dirname(path))
+    File.write(path, content)
+    path
+  end
+
+  # Lists every file under +dir+ as paths relative to it.
+  #
+  # @param dir [String] directory to walk
+  # @return [Array<String>] sorted relative paths of regular files
+  def files_under(dir)
+    Dir.glob(File.join(dir, "**/*"), File::FNM_DOTMATCH)
+      .reject { |path| File.directory?(path) }
+      .map { |path| path.sub("#{dir}/", "") }
+      .sort
+  end
+
+  # Registers a directory for removal at the end of the example.
+  #
+  # @param path [String] directory to remove later
+  # @return [String] +path+, for chaining
+  def register_tmpdir(path)
+    kitchen_tmpdirs << path
+    path
+  end
+
+  # Removes every directory registered during the example.
+  #
+  # @return [void]
+  def cleanup_kitchen_tmpdirs
+    kitchen_tmpdirs.each { |path| FileUtils.remove_entry(path, true) }
+    kitchen_tmpdirs.clear
+  end
+
+  private
+
+  # @return [StringIO] backing device for {#kitchen_logger}
+  def log_device
+    @log_device ||= StringIO.new
+  end
+
+  # @return [Array<String>] directories to clean up after the example
+  def kitchen_tmpdirs
+    @kitchen_tmpdirs ||= []
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-dsc
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Test Kitchen Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-28 00:00:00.000000000 Z
+date: 2026-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dsc_lcm_configuration
@@ -45,13 +45,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
 - ".github/dependabot.yml"
 - ".github/workflows/lint.yml"
 - ".github/workflows/publish.yaml"
 - ".gitignore"
 - ".markdownlint.yaml"
+- ".release-please-manifest.json"
+- ".rspec"
 - ".rubocop.yml"
+- ".yamllint"
+- ".yardopts"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -59,11 +65,12 @@ files:
 - kitchen-dsc.gemspec
 - lib/kitchen-dsc/version.rb
 - lib/kitchen/provisioner/dsc.rb
-- lib/kitchen/provisioner/dsc_lcm/lcm_base.rb
-- lib/kitchen/provisioner/dsc_lcm/lcm_v4.rb
-- lib/kitchen/provisioner/dsc_lcm/lcm_v5.rb
+- release-please-config.json
 - renovate.json
+- spec/kitchen/provisioner/dsc_spec.rb
+- spec/kitchen_dsc/version_spec.rb
 - spec/spec_helper.rb
+- spec/support/kitchen_helpers.rb
 homepage: https://github.com/test-kitchen/kitchen-dsc
 licenses:
 - Apache-2.0
@@ -76,16 +83,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: PowerShell DSC provisioner for test-kitchen
-test_files:
-- spec/spec_helper.rb
+test_files: []

data/lib/kitchen/provisioner/dsc_lcm/lcm_base.rb

@@ -1,86 +0,0 @@
-#
-# Author:: Steven Murawski (<steven.murawski@gmail.com>)
-#
-# Copyright (C) 2014 Steven Murawski
-#
-# Licensed under the Apache 2 License.
-# See LICENSE for more details
-
-require_relative "lcm_v4"
-require_relative "lcm_v5"
-
-module Kitchen
-  module Provisioner
-    module DscLcm
-      class LcmBase
-
-        def lcm_properties
-          {
-            allow_module_overwrite: false,
-            certificate_id: nil,
-            configuration_mode: "ApplyAndAutoCorrect",
-            configuration_mode_frequency_mins: 30,
-            reboot_if_needed: false,
-            refresh_mode: "PUSH",
-            refresh_frequency_mins: 15,
-          }
-        end
-
-        def initialize(config = {})
-          @certificate_id = nil
-          lcm_properties.each do |setting, value|
-            send(setting, value)
-          end
-
-          config.each do |setting, value|
-            send(setting, value)
-          end
-        end
-
-        def method_missing(name, *args)
-          return super unless lcm_properties.keys.include?(name)
-
-          if args.length == 1
-            instance_variable_set("@#{name}", args.first)
-          else
-            instance_variable_get("@#{name}")
-          end
-        end
-
-        def certificate_id(value = nil)
-          if value.nil?
-            @certificate_id.nil? ? "$null" : "'#{@certificate_id}'"
-          else
-            @certificate_id = value
-          end
-        end
-
-        def lcm_config
-          hash = {}
-          lcm_properties.keys.each do |key|
-            hash[key] = send(key)
-          end
-          hash
-        end
-
-        def lcm_configuration_script
-          <<-LCMSETUP
-            configuration SetupLCM
-            {
-              LocalConfigurationManager
-              {
-                AllowModuleOverwrite = [bool]::Parse('#{allow_module_overwrite}')
-                CertificateID = #{certificate_id}
-                ConfigurationMode = '#{configuration_mode}'
-                ConfigurationModeFrequencyMins = #{configuration_mode_frequency_mins}
-                RebootNodeIfNeeded = [bool]::Parse('#{reboot_if_needed}')
-                RefreshFrequencyMins = #{refresh_frequency_mins}
-                RefreshMode = '#{refresh_mode}'
-              }
-            }
-          LCMSETUP
-        end
-      end
-    end
-  end
-end

data/lib/kitchen/provisioner/dsc_lcm/lcm_v4.rb

@@ -1,52 +0,0 @@
-#
-# Author:: Steven Murawski (<steven.murawski@gmail.com>)
-#
-# Copyright (C) 2014 Steven Murawski
-#
-# Licensed under the Apache 2 License.
-# See LICENSE for more details
-
-require_relative "lcm_base"
-
-module Kitchen
-  module Provisioner
-    module DscLcm
-      class LcmV4 < LcmBase
-
-        def lcm_properties
-          {
-            action_after_reboot: "StopConfiguration",
-            allow_module_overwrite: false,
-            certificate_id: nil,
-            configuration_mode: "ApplyAndAutoCorrect",
-            configuration_mode_frequency_mins: 30,
-            debug_mode: "All",
-            reboot_if_needed: false,
-            refresh_mode: "PUSH",
-            refresh_frequency_mins: 15,
-          }
-        end
-
-        def lcm_configuration_script
-          <<-LCMSETUP
-            configuration SetupLCM
-            {
-              LocalConfigurationManager
-              {
-                ActionAfterReboot = '#{action_after_reboot}'
-                AllowModuleOverwrite = [bool]::Parse('#{allow_module_overwrite}')
-                CertificateID = #{certificate_id}
-                ConfigurationMode = '#{configuration_mode}'
-                ConfigurationModeFrequencyMins = #{configuration_mode_frequency_mins}
-                DebugMode = '#{debug_mode}'
-                RebootNodeIfNeeded = [bool]::Parse('#{reboot_if_needed}')
-                RefreshFrequencyMins = #{refresh_frequency_mins}
-                RefreshMode = '#{refresh_mode}'
-              }
-            }
-          LCMSETUP
-        end
-      end
-    end
-  end
-end

data/lib/kitchen/provisioner/dsc_lcm/lcm_v5.rb

@@ -1,53 +0,0 @@
-#
-# Author:: Steven Murawski (<steven.murawski@gmail.com>)
-#
-# Copyright (C) 2014 Steven Murawski
-#
-# Licensed under the Apache 2 License.
-# See LICENSE for more details
-
-require_relative "lcm_base"
-
-module Kitchen
-  module Provisioner
-    module DscLcm
-      class LcmV5 < LcmBase
-
-        def lcm_properties
-          {
-            action_after_reboot: "StopConfiguration",
-            allow_module_overwrite: false,
-            certificate_id: nil,
-            configuration_mode: "ApplyAndAutoCorrect",
-            configuration_mode_frequency_mins: 15,
-            debug_mode: "All",
-            reboot_if_needed: false,
-            refresh_mode: "PUSH",
-            refresh_frequency_mins: 30,
-          }
-        end
-
-        def lcm_configuration_script
-          <<-LCMSETUP
-            [DSCLocalConfigurationManager()]
-            configuration SetupLCM
-            {
-              Settings
-              {
-                ActionAfterReboot = '#{action_after_reboot}'
-                AllowModuleOverwrite = [bool]::Parse('#{allow_module_overwrite}')
-                CertificateID = #{certificate_id}
-                ConfigurationMode = '#{configuration_mode}'
-                ConfigurationModeFrequencyMins = #{configuration_mode_frequency_mins}
-                DebugMode = '#{debug_mode}'
-                RebootNodeIfNeeded = [bool]::Parse('#{reboot_if_needed}')
-                RefreshFrequencyMins = #{refresh_frequency_mins}
-                RefreshMode = '#{refresh_mode}'
-              }
-            }
-          LCMSETUP
-        end
-      end
-    end
-  end
-end