Home

Awesome

Litmus

Code Owners ci Gem Version

<div name="logo"> <img src="resources/litmus-dark-RGB.png" style="display: block; margin-left: auto; margin-right: auto;" width="50%" alt="litmus logo"> </div>

Overview

Litmus is a command line tool that allows you to run acceptance tests against Puppet modules.

Litmus allows you to:

Litmus also facilitates parallel test runs and running tests in isolation. Each step is standalone, allowing other operations between test runs, such as debugging or configuration updates on the test targets.

Install Litmus as a gem by running gem install puppet_litmus.

matrix_from_metadata_v3

matrix_from_metadata_v3 tool generates a github action matrix from the supported operating systems listed in the module's metadata.json.

How to use it: in the project module root directory run bundle exec matrix_from_metadata_v3

Optional arguments

argumentvaluedefaultdescription
--matrixFILEbuilt-inFile containing possible collections and provisioners
--metadataFILEmetadata.jsonFile containing module metadata json
--debugEnable debug messages
--quietDisable notice messages
--outputTYPEautoType of output to generate; auto, github or stdout
--runnerNAMEubuntu-latestDefault Github action runner
--puppet-includeMAJORSelect puppet major version
--puppet-excludeMAJORFilter puppet major version
--platform-includeREGEXSelect platform
--platform-excludeREGEXFilter platform
--arch-includeREGEXSelect architecture
--arch-excludeREGEXFilter architecture
--provision-preferNAMEdockerPrefer provisioner
--provision-includeNAMEallSelect provisioner
--provision-excludeNAMEprovision_serviceFilter provisioner

Refer to the built-in matrix.json for a list of supported collection, provisioners, and platforms.

Examples

Documentation

For documentation, see our Litmus Docs Site.

License

This codebase is licensed under Apache 2.0. However, the open source dependencies included in this codebase might be subject to other software licenses such as AGPL, GPL2.0, and MIT.

Other Resources