voxpupuli-test 13.2.0 → 15.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faeae0f342ac61d23fe3ce32cf98619b893412832ac3092a02d3f02b09a4a0dd
-  data.tar.gz: d269e93057980c6f8de427184af40f2b644553fc671126951b48b860d65696f7
+  metadata.gz: 9baef4ad6c44c840232ce31f3a50f1f9df2bcc74e6f5328e9326cb3e573b4d5d
+  data.tar.gz: '059f4f301334843412b89c5fae8661bd73391a054967fa242148c882f1fe6053'
 SHA512:
-  metadata.gz: aa94ef8506d9acdff6039fc6bc0106a094fea9b3508bd62089bd66b3463273597fb8057526fc747bf3d0522e0fb22ba1e10c666f560ac5fed8f2c17532bf4fb2
-  data.tar.gz: 4bf3580b0456dbb59b98a8cb7c0ecf7154efe83b13ac725bbf44a7c88efd06603ae0d1382536db6a52cd92e4aae4add7cd05354fd3c1fdde875621b8be73e726
+  metadata.gz: d6e97e07aa6c82ec706730423e21ab6e9ac2dd0b417fa0c438aa736e017f2f35d8d64a870c0a9776b93ed1b4c4f85f85ea932b7470fc9af18f38014a892c6bd3
+  data.tar.gz: 01365a55df6996d99bda1a08fa3d9ee6c2ab70c865a0f31ec515bf92f6c496387243f06c901761bece9d46f5e07ba52aa7bc1abe087fca4f1a852ba5cdbf86ee

data/README.md

@@ -74,6 +74,12 @@ To autocorrect Ruby files:
 bundle exec rake rubocop:autocorrect
 ```
 
+To generate or refresh a `.rubocop_todo.yml` file:
+
+```sh
+bundle exec rake rubocop:regenerate_todo
+```
+
 ## Rake tasks
 
 ### `check:trailing_whitespace`
@@ -107,6 +113,21 @@ The tasks that currently support this feature include `lint` and `rubocop`.
 
 Note that if multiple tasks all attempt to output CodeClimate reports in a single rake call, then only the final task will be able store its report.
 
+## Shared examples
+
+Shared examples are provided for things that are easy to get wrong in a custom type or provider.
+They are opt-in, so add the ones that apply to your type:
+
+```ruby
+require 'spec_helper'
+
+describe Puppet::Type.type(:mytool_config) do
+  it_behaves_like 'a type that works with `puppet generate types`'
+end
+```
+
+See [`lib/voxpupuli/test/shared_examples/`](lib/voxpupuli/test/shared_examples) for what is available.
+
 ## 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:

data/lib/voxpupuli/test/rake/rubocop.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rubocop/rake_task'
+
 RuboCop::RakeTask.new(:rubocop) do |task|
   # These make the rubocop experience maybe slightly less terrible
   task.options = ['--debug', '--display-style-guide', '--extra-details']
@@ -19,3 +20,15 @@ RuboCop::RakeTask.new(:rubocop) do |task|
     task.options += ['--format', 'CodeclimateFormatter', '--out', ENV['CODECLIMATE_REPORT_FILE']]
   end
 end
+
+namespace :rubocop do
+  # Do not use the `RuboCop::RakeTask` here, because it also adds the autocorrect tasks again.
+  desc 'Generate or refresh the RuboCop TODO file'
+  task :regenerate_todo do
+    require 'rubocop/cli'
+
+    status = RuboCop::CLI.new.run(%w[--regenerate-todo --no-auto-gen-timestamp])
+
+    abort "RuboCop failed with status #{status}" unless status.zero?
+  end
+end

data/lib/voxpupuli/test/shared_examples/providers.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Shared examples for the providers of custom types.
+#
+#   describe Puppet::Type.type(:my_type).provider(:my_provider) do
+#     it_behaves_like 'a documented provider'
+#   end
+
+# A provider's `desc` ends up in REFERENCE.md, like a type's.
+RSpec.shared_examples 'a documented provider' do
+  it 'has documentation' do
+    expect(described_class.doc.to_s.strip).not_to be_empty
+  end
+end

data/lib/voxpupuli/test/shared_examples/types.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'puppet/generate/models/type/type'
+
+# Shared examples for custom types.
+#
+#   describe Puppet::Type.type(:my_type) do
+#     it_behaves_like 'a type that works with `puppet generate types`'
+#     it_behaves_like 'a documented type'
+#     it_behaves_like 'an ensurable type'
+#   end
+
+# `puppet generate types` accepts less than `Puppet::Type` does, and a module
+# only finds out when an r10k deployment using `--generate-types` fails.
+RSpec.shared_examples 'a type that works with `puppet generate types`' do
+  it 'does not raise an error' do
+    expect { Puppet::Generate::Models::Type::Type.new(described_class) }.not_to raise_error
+  end
+end
+
+# Anything undocumented here is an empty entry in REFERENCE.md.
+RSpec.shared_examples 'a documented type' do
+  it 'has documentation' do
+    expect(described_class.doc.to_s.strip).not_to be_empty
+  end
+
+  it 'documents all parameters and properties' do
+    attributes = described_class.validproperties + described_class.parameters
+
+    undocumented = attributes.reject do |name|
+      klass = described_class.attrclass(name) || described_class.paramclass(name)
+      klass && !klass.doc.to_s.strip.empty?
+    end
+
+    expect(undocumented).to be_empty
+  end
+end
+
+# For types that manage a thing that can be created and removed. Types that use
+# `ensure` for something else, e.g. `[:purgable, :purged]`, don't want this.
+RSpec.shared_examples 'an ensurable type' do
+  it 'is ensurable' do
+    expect(described_class.propertybyname(:ensure)).not_to be_nil
+  end
+
+  it 'supports present and absent' do
+    values = described_class.propertybyname(:ensure)&.value_collection&.values
+
+    expect(values).to include(:present, :absent)
+  end
+end

data/lib/voxpupuli/test/shared_examples.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'shared_examples/types'
+require_relative 'shared_examples/providers'

data/lib/voxpupuli/test/spec_helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'voxpupuli/test/facts'
+require 'voxpupuli/test/shared_examples'
 require 'rspec-puppet'
 
 spec_path = File.expand_path(File.join(Dir.pwd, 'spec'))

data/rubocop.yml

@@ -1,6 +1,6 @@
 # This is a shared config for easy consumption in other modules, without having
 # to sync over a large file
-require:
+plugins:
   - rubocop-rspec
   - rubocop-rake
 
@@ -280,7 +280,7 @@ Style/PreferredHashMethods:
   Enabled: True
 
 Layout/DotPosition:
-  EnforcedStyle: trailing
+  EnforcedStyle: leading
 
 Style/DoubleNegation:
   Enabled: True
@@ -333,12 +333,14 @@ Style/StringLiterals:
 
 Style/TrailingCommaInArguments:
   Enabled: True
+  EnforcedStyleForMultiline: comma
 
 Style/TrailingCommaInArrayLiteral:
-  Enabled: False
+  Enabled: True
+  EnforcedStyleForMultiline: consistent_comma
 
 Style/TrailingCommaInHashLiteral:
-  Enabled: False
+  EnforcedStyleForMultiline: consistent_comma
 
 Style/GlobalVars:
   Enabled: True
@@ -445,10 +447,13 @@ Style/PercentLiteralDelimiters:
 Style/PerlBackrefs:
   Enabled: True
 
-Naming/PredicateName:
+Naming/PredicatePrefix:
   Enabled: True
   AllowedMethods: ['is_a?', 'is_to_s']
 
+Naming/PredicateMethod:
+  Enabled: false
+
 Style/RedundantException:
   Enabled: True
 
@@ -496,6 +501,9 @@ Style/Encoding:
 Style/BlockDelimiters:
   Enabled: True
 
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex
+
 Layout/MultilineBlockLayout:
   Enabled: True
 
@@ -557,9 +565,13 @@ Style/FormatStringToken:
 
 # This is useful, but sometimes a little too picky about where unit tests files
 # are located.
-RSpec/FilePath:
+# old cop: RSpec/FilePath
+RSpec/SpecFilePathFormat:
   Enabled: false
 
+RSpec/SpecFilePathSuffix:
+  Enabled: true
+
 # Leaving these enabled creates too much busy work
 RSpec/ContextWording:
   Enabled: false
@@ -662,8 +674,6 @@ RSpec/IdenticalEqualityAssertion: # new in 2.4
   Enabled: true
 RSpec/SubjectDeclaration: # new in 2.5
   Enabled: true
-RSpec/Rails/AvoidSetupHook: # new in 2.4
-  Enabled: true
 RSpec/ImplicitSubject:
   Enabled: false
 # new configurations since rubocop 1.50.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: voxpupuli-test
 version: !ruby/object:Gem::Version
-  version: 13.2.0
+  version: 15.0.0
 platform: ruby
 authors:
 - Vox Pupuli
@@ -78,7 +78,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -88,7 +88,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: parallel_tests
   requirement: !ruby/object:Gem::Requirement
@@ -173,16 +173,22 @@ dependencies:
   name: rspec-puppet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: rspec-puppet-facts
   requirement: !ruby/object:Gem::Requirement
@@ -207,58 +213,70 @@ dependencies:
   name: syslog
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.50.0
+        version: 1.91.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.50.0
+        version: 1.91.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.20.0
+        version: '3.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.20.0
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: voxpupuli-puppet-lint-plugins
   requirement: !ruby/object:Gem::Requirement
@@ -312,9 +330,12 @@ files:
 - lib/voxpupuli/test/rake/spec.rb
 - lib/voxpupuli/test/rake/validate.rb
 - lib/voxpupuli/test/rubocop_formatters/codeclimate.rb
+- lib/voxpupuli/test/shared_examples.rb
+- lib/voxpupuli/test/shared_examples/providers.rb
+- lib/voxpupuli/test/shared_examples/types.rb
 - lib/voxpupuli/test/spec_helper.rb
 - rubocop.yml
-homepage: http://github.com/voxpupuli/voxpupuli-test
+homepage: https://github.com/voxpupuli/voxpupuli-test
 licenses:
 - Apache-2.0
 metadata: {}
@@ -332,7 +353,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Helpers for testing Vox Pupuli modules
 test_files: []