voxpupuli-test 7.2.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fde66aa91dccfcc5c2ad44bd37a7939497665fe43398a71b65e39e901e6c556
-  data.tar.gz: 5b903362fe35bbd34b14b7653471fddf156986a1b698920e819f98048c2d35c4
+  metadata.gz: 4dd40401d3073603368776f98a93973f4a174469d47197de13fb0f767b37f3a4
+  data.tar.gz: 8ff8722876be3395a538da16ffdbcdd280275d703e2de43b8583e7e08c533632
 SHA512:
-  metadata.gz: e6dccd5602449c6671be221762e29daf581bccb96ea0088f626a5c293791a39d3608d9ead915096a332753efdf8574371831a2347718228ddaa35fc8fa462c63
-  data.tar.gz: 0b9faf634bdd7a40556d850f7f290d256d83223e1ae9fc6db562020c91ee2d9c4e24f266e90f8c24720fcb8083bdf2dbd52e0a1e7e0656956e8bfa20fe22564b
+  metadata.gz: 7d31264b414af6224887a14b0ff6772daaf9f88899f5e289d5b55133e422f7597bad2d2a10c18d65887d5d16ec5069e585e852ab5e5c0ff876474c06b74ecdd4
+  data.tar.gz: 8309011ea81518fd8704a6f36afe30278305ca77d3e4d9ce42c42f51a0566b66fd5c39eb1b310029b1ae8e9529d9e4d64f2486414f0881b20a1a85f24d18cd68

data/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,123 @@
+# Voxpupuli Test Gem
+
+[![License](https://img.shields.io/github/license/voxpupuli/voxpupuli-test.svg)](https://github.com/voxpupuli/voxpupuli-test/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/voxpupuli-test/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/voxpupuli-test/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/voxpupuli/voxpupuli-test/branch/master/graph/badge.svg?token=Mypkl78hvK)](https://codecov.io/gh/voxpupuli/voxpupuli-test)
+[![Release](https://github.com/voxpupuli/voxpupuli-test/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/voxpupuli-test/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/voxpupuli-test.svg)](https://rubygems.org/gems/voxpupuli-test)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/voxpupuli-test.svg)](https://rubygems.org/gems/voxpupuli-test)
+
+This is a helper Gem to test the various Vox Pupuli Puppet modules. This Gem provides common functionality for rspec-puppet based testing. The aim is to reduce the boiler plate and need for modulesync.
+
+## Usage
+
+Add the `voxpupuli-test` Gem to your `Gemfile`:
+
+```ruby
+gem 'voxpupuli-test'
+```
+
+Then, at the top of your `Rakefile`, add:
+
+```ruby
+require 'voxpupuli/test/rake'
+```
+
+In your `spec/spec_helper.rb`
+
+```ruby
+require 'voxpupuli/test/spec_helper'
+```
+
+In your `.rubocop.yml` (see [Rubocop's documentation](https://docs.rubocop.org/rubocop/configuration.html#inheriting-configuration-from-a-dependency-gem)).
+
+```yaml
+inherit_gem:
+  voxpupuli-test: rubocop.yml
+```
+
+## Rake tasks
+
+### `check:trailing_whitespace`
+
+The rake task `check:trailing_whitespace` checks for trailing whitespace in all markdown files in the repository.
+It has an exclude pattern for: `%r{^((modules|acceptance|\.?vendor|spec/fixtures|pkg)/|REFERENCE.md)}`
+
+We recommend using the GitHub style guide for markdown files, which includes no trailing whitespace.
+See [GitHub Markdown Style Guide](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
+
+## Fact handling
+
+The recommended method is using [rspec-puppet-facts](https://github.com/mcanevet/rspec-puppet-facts) and is set up by default. This means the tests are writting as follows:
+
+```ruby
+require 'spec_helper'
+
+describe 'myclass' do
+  on_supported_os.each do |os, os_facts|
+    context "on #{os}" do
+      let(:facts) { os_facts }
+
+      it { is_expected.to compile.with_all_deps }
+    end
+  end
+end
+```
+
+Now a common case is to override facts in tests. Let's take the example of SELinux with legacy facts.
+
+```ruby
+require 'spec_helper'
+
+describe 'mytool' do
+  on_supported_os.each do |os, os_facts|
+    context "on #{os}" do
+      let(:facts) { os_facts }
+
+      it { is_expected.to compile.with_all_deps }
+
+      describe 'with SELinux enabled' do
+        let(:facts) { super().merge(selinux: true) }
+
+        it { is_expected.to contain_package('mytool-selinux') }
+      end
+
+      describe 'with SELinux disabled' do
+        let(:facts) { super().merge(selinux: false) }
+
+        it { is_expected.not_to contain_package('mytool-selinux') }
+      end
+    end
+  end
+end
+```
+
+This is all fairly straight forward, but it gets more complex when using modern facts. Modern facts are nested which means you need to do deep merging. There is [deep_merge](https://rubygems.org/gems/deep_merge) but its results are not at all useful for spec testing. That's why voxpupuli-test has an `override_facts` helper.
+
+```ruby
+require 'spec_helper'
+
+describe 'mytool' do
+  on_supported_os.each do |os, os_facts|
+    context "on #{os}" do
+      let(:facts) { os_facts }
+
+      it { is_expected.to compile.with_all_deps }
+
+      describe 'with SELinux enabled' do
+        let(:facts) { override_facts(super(), os: {selinux: {enabled: true}}) }
+
+        it { is_expected.to contain_package('mytool-selinux') }
+      end
+
+      describe 'with SELinux disabled' do
+        let(:facts) { override_facts(super(), os: {selinux: {enabled: false}}) }
+
+        it { is_expected.not_to contain_package('mytool-selinux') }
+      end
+    end
+  end
+end
+```
+
+Note that this helper deals with symbols/strings for you as well.

data/lib/voxpupuli/test/facts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec-puppet-facts'
 include RspecPuppetFacts
 
@@ -51,7 +53,7 @@ def add_facts_for_metadata(metadata)
   metadata['dependencies'].each do |dependency|
     case normalize_module_name(dependency['name'])
     when 'camptocamp/systemd', 'puppet/systemd'
-      add_custom_fact :systemd, ->(_os, facts) { facts['service_provider'] == 'systemd' }
+      add_custom_fact :systemd, ->(_os, facts) { facts[:service_provider] == 'systemd' }
     when 'puppetlabs/stdlib'
       add_stdlib_facts
     end
@@ -60,6 +62,7 @@ end
 
 def normalize_module_name(name)
   return unless name
+
   name.sub('-', '/')
 end
 
@@ -70,29 +73,25 @@ def add_stdlib_facts
 
   # Rough conversion of grepping in the puppet source:
   # grep defaultfor lib/puppet/provider/service/*.rb
-  add_custom_fact :service_provider, ->(_os, facts) do
+  add_custom_fact :service_provider, lambda { |_os, facts|
     os = RSpec.configuration.facterdb_string_keys ? facts['os'] : facts[:os]
     case os['family'].downcase
-    when 'archlinux'
+    when 'archlinux', 'debian', 'redhat'
       'systemd'
     when 'darwin'
       'launchd'
-    when 'debian'
-      'systemd'
     when 'freebsd'
       'freebsd'
     when 'gentoo'
       'openrc'
     when 'openbsd'
       'openbsd'
-    when 'redhat'
-      os['release']['major'].to_i >= 7 ? 'systemd' : 'redhat'
     when 'suse'
-      os['release']['major'].to_i >= 12 ? 'systemd' : 'redhat'
+      (os['release']['major'].to_i >= 12) ? 'systemd' : 'redhat'
     when 'windows'
       'windows'
     else
       'init'
     end
-  end
+  }
 end

data/lib/voxpupuli/test/rake.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'puppetlabs_spec_helper/rake_tasks'
 
-PuppetLint.configuration.log_format = '%{path}:%{line}:%{check}:%{KIND}:%{message}'
+PuppetLint.configuration.log_format = '%<path>s:%<line>s:%<check>s:%<KIND>s:%<message>s'
 # without this, puppet-lint always gives an exit code of 0
 PuppetLint.configuration.fail_on_warnings = true
 
@@ -12,15 +14,23 @@ task default: [:release_checks]
 namespace :check do
   desc 'Check for trailing whitespace'
   task :trailing_whitespace do
+    errors = []
+
     Dir.glob('**/*.md', File::FNM_DOTMATCH).sort.each do |filename|
       next if filename =~ %r{^((modules|acceptance|\.?vendor|spec/fixtures|pkg)/|REFERENCE.md)}
+
       File.foreach(filename).each_with_index do |line, index|
-        if line =~ %r{\s\n$}
-          puts "#{filename} has trailing whitespace on line #{index + 1}"
-          exit 1
+        if line =~ /\s\n$/
+          errors << "#{filename} has trailing whitespace on line #{index + 1}"
         end
       end
     end
+
+    if errors.any?
+      errors.each { |error| puts error }
+      exit 1
+    end
   end
 end
+
 Rake::Task[:check].enhance ['check:trailing_whitespace']

data/lib/voxpupuli/test/spec_helper.rb

@@ -1,11 +1,4 @@
-RSpec.configure do |config|
-  # puppetlabs_spec_helper defaults to mocha but emits a deprecation warning
-  # Vox Pupuli prefers rspec to avoid the deprecation warning unless explicitly
-  # set
-  if config.instance_variable_get(:@mock_framework).nil?
-    config.mock_with :rspec
-  end
-end
+# frozen_string_literal: true
 
 require 'voxpupuli/test/facts'
 require 'puppetlabs_spec_helper/module_spec_helper'
@@ -17,6 +10,9 @@ RSpec.configure do |config|
   # and 7.12+ and requires rspec-puppet 2.11.0+.
   config.facter_implementation = 'rspec'
 
+  # In the next major release we will flip this to true
+  config.facterdb_string_keys = false
+
   config.after(:suite) do
     RSpec::Puppet::Coverage.report!
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voxpupuli-test
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-23 00:00:00.000000000 Z
+date: 2024-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -34,22 +34,16 @@ dependencies:
   name: facterdb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: metadata-json-lint
   requirement: !ruby/object:Gem::Requirement
@@ -126,20 +120,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec-puppet-utils
   requirement: !ruby/object:Gem::Requirement
@@ -169,33 +157,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.50.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.20.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.20.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-rake
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 2.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 2.20.0
 - !ruby/object:Gem::Dependency
   name: voxpupuli-puppet-lint-plugins
   requirement: !ruby/object:Gem::Requirement
@@ -232,7 +220,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/voxpupuli/test.rb
+- LICENSE
+- README.md
 - lib/voxpupuli/test/facts.rb
 - lib/voxpupuli/test/rake.rb
 - lib/voxpupuli/test/spec_helper.rb