voxpupuli-test 7.2.0 → 8.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1fde66aa91dccfcc5c2ad44bd37a7939497665fe43398a71b65e39e901e6c556
4
- data.tar.gz: 5b903362fe35bbd34b14b7653471fddf156986a1b698920e819f98048c2d35c4
3
+ metadata.gz: 346b627b7545574730d917660e968df59460018ce2334d2301be061d1b1aabca
4
+ data.tar.gz: 7cd65cb60f03e97283bd7ed532b4255720df4f74ab0294309c2667707d35a94a
5
5
  SHA512:
6
- metadata.gz: e6dccd5602449c6671be221762e29daf581bccb96ea0088f626a5c293791a39d3608d9ead915096a332753efdf8574371831a2347718228ddaa35fc8fa462c63
7
- data.tar.gz: 0b9faf634bdd7a40556d850f7f290d256d83223e1ae9fc6db562020c91ee2d9c4e24f266e90f8c24720fcb8083bdf2dbd52e0a1e7e0656956e8bfa20fe22564b
6
+ metadata.gz: 343acd06af0a11767fda3ddce8a4fd247545b2f04b1c85a6238c9c4d135ebe9f1079174abc135a9f33c2345fa9036fec831fbe58a4a971489322e5eec23c808e
7
+ data.tar.gz: ed0d6b115b358c3d5a8b8ef6596428e633b7ae971d2fba7dd5f621787293c92adc1d9781f7c0f654d27bcf38399b0a3cb0b28da80a674e152e96b078d5c56349
data/LICENSE ADDED
@@ -0,0 +1,176 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
data/README.md ADDED
@@ -0,0 +1,112 @@
1
+ # Voxpupuli Test Gem
2
+
3
+ [![License](https://img.shields.io/github/license/voxpupuli/voxpupuli-test.svg)](https://github.com/voxpupuli/voxpupuli-test/blob/master/LICENSE)
4
+ [![Test](https://github.com/voxpupuli/voxpupuli-test/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/voxpupuli-test/actions/workflows/test.yml)
5
+ [![codecov](https://codecov.io/gh/voxpupuli/voxpupuli-test/branch/master/graph/badge.svg?token=Mypkl78hvK)](https://codecov.io/gh/voxpupuli/voxpupuli-test)
6
+ [![Release](https://github.com/voxpupuli/voxpupuli-test/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/voxpupuli-test/actions/workflows/release.yml)
7
+ [![RubyGem Version](https://img.shields.io/gem/v/voxpupuli-test.svg)](https://rubygems.org/gems/voxpupuli-test)
8
+ [![RubyGem Downloads](https://img.shields.io/gem/dt/voxpupuli-test.svg)](https://rubygems.org/gems/voxpupuli-test)
9
+
10
+ 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.
11
+
12
+ # Usage
13
+ Add the `voxpupuli-test` Gem to your `Gemfile`:
14
+
15
+ ```ruby
16
+ gem 'voxpupuli-test'
17
+ ```
18
+
19
+ Then, at the top of your `Rakefile`, add:
20
+
21
+ ```ruby
22
+ require 'voxpupuli/test/rake'
23
+ ```
24
+
25
+ In your `spec/spec_helper.rb`
26
+
27
+ ```ruby
28
+ require 'voxpupuli/test/spec_helper'
29
+ ```
30
+
31
+ In your `.rubocop.yml` (see [Rubocop's documentation](https://docs.rubocop.org/rubocop/configuration.html#inheriting-configuration-from-a-dependency-gem)).
32
+
33
+ ```yaml
34
+ inherit_gem:
35
+ voxpupuli-test: rubocop.yml
36
+ ```
37
+
38
+ # Fact handling
39
+
40
+ 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:
41
+
42
+ ```ruby
43
+ require 'spec_helper'
44
+
45
+ describe 'myclass' do
46
+ on_supported_os.each do |os, os_facts|
47
+ context "on #{os}" do
48
+ let(:facts) { os_facts }
49
+
50
+ it { is_expected.to compile.with_all_deps }
51
+ end
52
+ end
53
+ end
54
+ ```
55
+
56
+ Now a common case is to override facts in tests. Let's take the example of SELinux with legacy facts.
57
+
58
+ ```ruby
59
+ require 'spec_helper'
60
+
61
+ describe 'mytool' do
62
+ on_supported_os.each do |os, os_facts|
63
+ context "on #{os}" do
64
+ let(:facts) { os_facts }
65
+
66
+ it { is_expected.to compile.with_all_deps }
67
+
68
+ describe 'with SELinux enabled' do
69
+ let(:facts) { super().merge(selinux: true) }
70
+
71
+ it { is_expected.to contain_package('mytool-selinux') }
72
+ end
73
+
74
+ describe 'with SELinux disabled' do
75
+ let(:facts) { super().merge(selinux: false) }
76
+
77
+ it { is_expected.not_to contain_package('mytool-selinux') }
78
+ end
79
+ end
80
+ end
81
+ end
82
+ ```
83
+
84
+ 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.
85
+
86
+ ```ruby
87
+ require 'spec_helper'
88
+
89
+ describe 'mytool' do
90
+ on_supported_os.each do |os, os_facts|
91
+ context "on #{os}" do
92
+ let(:facts) { os_facts }
93
+
94
+ it { is_expected.to compile.with_all_deps }
95
+
96
+ describe 'with SELinux enabled' do
97
+ let(:facts) { override_facts(super(), os: {selinux: {enabled: true}}) }
98
+
99
+ it { is_expected.to contain_package('mytool-selinux') }
100
+ end
101
+
102
+ describe 'with SELinux disabled' do
103
+ let(:facts) { override_facts(super(), os: {selinux: {enabled: false}}) }
104
+
105
+ it { is_expected.not_to contain_package('mytool-selinux') }
106
+ end
107
+ end
108
+ end
109
+ end
110
+ ```
111
+
112
+ Note that this helper deals with symbols/strings for you as well.
@@ -51,7 +51,7 @@ def add_facts_for_metadata(metadata)
51
51
  metadata['dependencies'].each do |dependency|
52
52
  case normalize_module_name(dependency['name'])
53
53
  when 'camptocamp/systemd', 'puppet/systemd'
54
- add_custom_fact :systemd, ->(_os, facts) { facts['service_provider'] == 'systemd' }
54
+ add_custom_fact :systemd, ->(_os, facts) { facts[:service_provider] == 'systemd' }
55
55
  when 'puppetlabs/stdlib'
56
56
  add_stdlib_facts
57
57
  end
@@ -86,7 +86,7 @@ def add_stdlib_facts
86
86
  when 'openbsd'
87
87
  'openbsd'
88
88
  when 'redhat'
89
- os['release']['major'].to_i >= 7 ? 'systemd' : 'redhat'
89
+ 'systemd'
90
90
  when 'suse'
91
91
  os['release']['major'].to_i >= 12 ? 'systemd' : 'redhat'
92
92
  when 'windows'
@@ -17,6 +17,9 @@ RSpec.configure do |config|
17
17
  # and 7.12+ and requires rspec-puppet 2.11.0+.
18
18
  config.facter_implementation = 'rspec'
19
19
 
20
+ # In the next major release we will flip this to true
21
+ config.facterdb_string_keys = false
22
+
20
23
  config.after(:suite) do
21
24
  RSpec::Puppet::Coverage.report!
22
25
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: voxpupuli-test
3
3
  version: !ruby/object:Gem::Version
4
- version: 7.2.0
4
+ version: 8.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Vox Pupuli
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-05-23 00:00:00.000000000 Z
11
+ date: 2024-06-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake
@@ -34,22 +34,16 @@ dependencies:
34
34
  name: facterdb
35
35
  requirement: !ruby/object:Gem::Requirement
36
36
  requirements:
37
- - - ">="
38
- - !ruby/object:Gem::Version
39
- version: 1.4.0
40
- - - "<"
37
+ - - "~>"
41
38
  - !ruby/object:Gem::Version
42
- version: '2'
39
+ version: '2.1'
43
40
  type: :runtime
44
41
  prerelease: false
45
42
  version_requirements: !ruby/object:Gem::Requirement
46
43
  requirements:
47
- - - ">="
48
- - !ruby/object:Gem::Version
49
- version: 1.4.0
50
- - - "<"
44
+ - - "~>"
51
45
  - !ruby/object:Gem::Version
52
- version: '2'
46
+ version: '2.1'
53
47
  - !ruby/object:Gem::Dependency
54
48
  name: metadata-json-lint
55
49
  requirement: !ruby/object:Gem::Requirement
@@ -126,20 +120,14 @@ dependencies:
126
120
  requirements:
127
121
  - - "~>"
128
122
  - !ruby/object:Gem::Version
129
- version: '2.0'
130
- - - ">="
131
- - !ruby/object:Gem::Version
132
- version: 2.0.5
123
+ version: '4.0'
133
124
  type: :runtime
134
125
  prerelease: false
135
126
  version_requirements: !ruby/object:Gem::Requirement
136
127
  requirements:
137
128
  - - "~>"
138
129
  - !ruby/object:Gem::Version
139
- version: '2.0'
140
- - - ">="
141
- - !ruby/object:Gem::Version
142
- version: 2.0.5
130
+ version: '4.0'
143
131
  - !ruby/object:Gem::Dependency
144
132
  name: rspec-puppet-utils
145
133
  requirement: !ruby/object:Gem::Requirement
@@ -232,6 +220,8 @@ executables: []
232
220
  extensions: []
233
221
  extra_rdoc_files: []
234
222
  files:
223
+ - LICENSE
224
+ - README.md
235
225
  - lib/voxpupuli/test.rb
236
226
  - lib/voxpupuli/test/facts.rb
237
227
  - lib/voxpupuli/test/rake.rb