You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Switch osfamily to structured fact os['family']
- Update rspec-puppet docs link to puppetlabs.github.io
- Add note that puppetlabs-spec-helper is no longer needed for Vox Pupuli modules
- Fix indented serverspec code block to fenced style
- Fix non-descriptive 'here' link text
- Add puppetmodule.info to community resources
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/_openvox_8x/bgtm.md
+11-6Lines changed: 11 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -257,16 +257,18 @@ The `rspec-puppet` gem provides a unit-testing framework for Puppet. It extends
257
257
it { should contain_file('configuration') }
258
258
```
259
259
260
-
RSpec lets you provide facts, like `osfamily`, in order to test the module in various scenarios.
260
+
RSpec lets you provide facts, like `os['family']`, in order to test the module in various scenarios.
261
261
262
262
A typical use of RSpec is to iterate over a list of operating systems, asserting that the package and service should exist in the catalog for every operating system your module supports.
263
263
264
-
To learn more, see [https://rspec-puppet.com/](https://rspec-puppet.com/).
264
+
To learn more, see the [rspec-puppet documentation](https://puppetlabs.github.io/rspec-puppet/).
265
265
266
266
### puppetlabs-spec-helper
267
267
268
268
The [puppetlabs-spec-helper](https://github.com/puppetlabs/puppetlabs_spec_helper) gem automates some of the tasks required to test modules.
269
269
270
+
> **Note:** This gem is no longer needed for any Vox Pupuli modules.
271
+
270
272
This is especially useful in conjunction with `rspec-puppet`, as `puppetlabs-spec-helper` provides default Rake tasks that allow you to standardize testing across modules. It also provides some code to connect `rspec-puppet` with modules. Add it to the Gemfile of the project, and then add the following line to the Rakefile:
271
273
272
274
```ruby
@@ -283,9 +285,11 @@ It provisions one or more virtual machines on various hypervisors (such as [Vagr
283
285
284
286
[Serverspec](https://serverspec.org/) provides additional testing constructs (such as `be_running` and `be_installed`) for beaker-rspec. It allows you to abstract away details of the underlying distribution when testing. It lets you write tests like:
285
287
286
-
describe service('httpd') do
287
-
it { should be_running }
288
-
end
288
+
```ruby
289
+
describe service('httpd') do
290
+
it { should be_running }
291
+
end
292
+
```
289
293
290
294
It then knows how to translate `be_running` into shell commands for different distributions.
291
295
@@ -309,7 +313,7 @@ We encourage you to publish your modules on the [Puppet Forge](https://forge.pup
309
313
310
314
Sharing your modules allows other users to write improvements to the modules you make available and contribute them back to you, effectively giving you free improvements to your modules.
311
315
312
-
Additionally, publishing your modules to the Forge helps foster community among Puppet users, and allows other Puppet community members to download and use your module. If the Puppet community routinely releases and iterates on modules on the Forge, the quality of available modules increases dramatically and gives you access to more modules to download and modify for your own purposes. Details on how to publish modules to the Forge can be found [here](./modules_publishing.html).
316
+
Additionally, publishing your modules to the Forge helps foster community among Puppet users, and allows other Puppet community members to download and use your module. If the Puppet community routinely releases and iterates on modules on the Forge, the quality of available modules increases dramatically and gives you access to more modules to download and modify for your own purposes. Details on how to publish modules to the Forge can be found in the [module publishing guide](./modules_publishing.html).
313
317
314
318
## Community Resources
315
319
@@ -323,3 +327,4 @@ For beginning module authors, a variety of community resources are available.
323
327
324
328
[Vox Pupuli community channels](https://voxpupuli.org/connect/)
325
329
330
+
[puppetmodule.info](https://www.puppetmodule.info) — open source Puppet module documentation server, generating fresh docs for Puppet modules and popular Git repositories
0 commit comments