Puppet Development Kit (PDK) provides tools to help you run unit tests on your module and validate your module's metadata, syntax, and style.

By default, the PDK module template includes tools that can:

  • Validate the metadata.json file.

  • Validate Puppet syntax.

  • Validate Puppet code style.

  • Validate Ruby code style.

  • Run unit tests.

If you are working behind a proxy, before you begin, ensure that you've added the correct environment variables. See Running PDK behind a proxy for details.

To ensure that your modules will work with different versions of Puppet, validate and unit test your modules against specific versions of Puppet and Puppet Enterprise. This allows you to find and fix module issues before you upgrade.

With command line options, you can specify major or minor versions, such as Puppet 5 or PE 2017.3.2. When you specify a major version, PDK tests against the most recent available release of the major version. PDK reports which PE or Puppet version it is running checks against. See the pdk validate and pdk test unit command references for usage details.

You can validate or test against any version of Puppet or PE that is currently under maintenance. See open source Puppet and Puppet Enterprise lifecycle pages for details.

Validating modules

Ensure that your module contains correct syntax and style by validating your module. PDK includes validations for module metadata, Puppet code syntax and style, and Ruby code syntax and style. 

When you run validations, PDK output tells you which validations it is running and notifies you of any errors or warnings it finds for each type of validation:

  • Syntax validations verify that your module code syntax works with specific versions of Puppet. If your module has syntax errors, correct them to ensure that your module will work correctly.

  • Code style validations verify that your code follows style guidelines and best practices. Such errors do not prevent your module from functioning; however, fixing them makes your code readable and maintainable.

  • Metadata validations verify that module metadata is present and properly formatted. PDK unit testing relies on metadata for important information, such as operating system compatibility. Some of this information is also required if you publish your module to the Forge. Correct metadata errors to provide this information.

By default, PDK runs all available validations. You can customize PDK validation with command line options. For example, you can pass options to have PDK automatically correct some common code style problems, to validate only specific directories or files, or to run only certain types of validation, such as metadata or Puppet code.

You can output module validation results to a file in either JUnit or text format. You can specify multiple output formats and targets in the same command, as long as each target is unique.

For detailed information about module validations, see:

Validate a module

By default, the validate command runs metadata validation first, then Puppet validation, then Ruby validation. Optionally, you can validate only certain files or directories, run a specific type of validations, such as metadata or Puppet validation, or run all validations simultaneously. Additionally, you can send your validation output to a file in either JUnit or text format.

  1. From the command line, change into the module's directory with cd <MODULE_NAME>
  2. Run all validations by running pdk validate  

    To change validation behavior, add option flags to the command. For example, to run all validations simultaneously on multiple threads, run pdk validate --parallel.

    To validate against a specific version of Puppet or PE, add a version option flag. For example, to validate against PE 2018.1, run pdk validate --pe-version "2018.1"

    For a complete list of command options and usage information, see the PDK command reference.

Unit testing modules

Run unit tests to verify that your Puppet code compiles on supported operating systems and includes all declared resources in the catalog.

PDK runs your unit tests to ensure that your code works as you expect it to, but it cannot test changes to the managed system or services.

When you generate a class, PDK creates a unit test file. This test file, located in your module's /spec/classes folder, includes a basic template for writing your unit tests. PDK includes tools for running unit tests, but it does not write unit tests itself. However, if you are testing an empty module that you generated with PDK, you can run the unit test command to verify that all dependencies are present and that the spec directory was created correctly.

After you've written your unit tests, you can use the pdk test unit command to run all of the tests you've included in your module.

Test and validate your module anytime you are going to modify or add code, to verify that you are starting out with clean code. Then, as you create classes and write other code in your module, continue to validate it, and to write and run unit tests.

For more information about RSpec and writing unit tests, see:

Unit test a module

The pdk test unit command runs all the unit tests in your module.

Before you begin

Ensure that you have written unit tests for your module, unless you are unit testing a newly generated module with no classes or other code in it.

  1. From the command line, change into the module's directory with cd <MODULE_NAME>
  2. Run pdk test unit

    To change unit test behavior, add option flags to the command. For example, to run only certain unit tests, run pdk test unit --tests=<TEST1>,<TEST2>

    To unit test against a specific version of Puppet or PE, add a version option flag. For example, to test against PE 2018.1, run pdk test unit --pe-version "2018.1"

    For a complete list of command options and usage information, see the PDK command reference.

If there are no errors, the command returns successfully with exit code 0, with no warnings. See the PDK reference for a complete list of unit test options.

Back to top