puppet_module_dependencies.md

Puppet module dependencies

To test your puppet code, PDQTest needs to configured to obtain any modules the code being tested depends on.

Specifying dependencies

Public modules (PuppetForge)

Dependencies on public forge modules must be specified in your module's metadata.json file. When tests are run, we will use this to generate a temporary Puppetfile at Puppetfile.pdqtest which we will then install into spec/fixtures/modules using R10K.

When RSpec tests are run using PDQtest a .fixtures.yml file will be generated for you based on the module metadata (with PDK standalone you must update this file manually). We will then execute pdk test unit on your behalf which will install any additional modules from git that can't be specified in metadata.json.

This means you get a complete set of modules in /spec/fixtures/modules by the time you come to run acceptance tests.

Private modules (from git)

If you need to download modules from git, then you must populate the fixtures section of .fixtures.yml, eg:

fixtures:
  repositories:
    camera_shy:
      repo: "git://git.megacorp.com/puppet/camera_shy"
      ref: "2.6.0"

It is an error to define the same module in both metadata.json and .fixtures.yml and the results of doing so are undefined:

• Always use metadata.json for public forge modules and we will update .fixtures.yml based on it
• Modules from git should only be defined in .fixtures.yml

pdk build

Note that running pdk build will remove any modules present under /spec/fixtures/modules. Run unit tests to restore them.