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 JRuby 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.

Validating modules

The validations included in PDK provide a basic check of the well-formedness of the module, and the syntax and style of the module's files. You do not need to write any tests for this validation.

By default, the pdk validate command validates the module's metadata, Puppet code syntax and style, and Ruby code syntax and style.

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 specific directories or files only, 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.

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. For a complete list of command options and usage information, see the PDK command reference.

Unit testing modules

PDK can run your unit tests on a module's Puppet code to verify that it compiles on all supported operating systems and that the resources declared will be included in the catalog. PDK 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. In your module's directory, from the command line, 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 <TEST1>,<TEST2> . For a complete list of command options and usage information, see the PDK command reference.

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

Back to top