Skip to content
The shortest path to better modules: Puppet Development Kit; Download:
Branch: master
Clone or download
rodjek Merge pull request #658 from scotje/maint_fixup_acceptance
(MAINT) Fixup package acceptance tests for 'pdk-default' template URL
Latest commit 0d864af Apr 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
bin
exe
ext (SDK-218) Add task to bootstrap packaging Jun 6, 2017
lib
locales
package-testing
spec Merge pull request #652 from rodjek/pdk-1338 Apr 9, 2019
.dependency_decisions.yml
.gitignore (maint) Allow developers to add additional gems Apr 1, 2019
.rspec
.rubocop.yml (maint) Enforce line endings in Rubocop Mar 29, 2019
.rubocop_todo.yml
.travis.yml
CHANGELOG.md
CONTRIBUTING.md (PDK-1335) Add development note when on Windows Apr 1, 2019
Gemfile (FIXUP) Fix rubocop eval warning and pin Cri gem for Ruby 2.1.9 Apr 1, 2019
LICENSE Initial commit Jan 26, 2017
NOTICE Naming fix Jun 14, 2017
README.md
Rakefile (MAINT) Update to released version of GCG Dec 11, 2017
appveyor.yml (maint) Split acceptance:local into separate appveyor job Mar 11, 2019
pdk.gemspec (PDK-1338) Initial import of telemetry code from Bolt Apr 8, 2019

README.md

pdk Build Status Appveyor Build Status Coverage Status

The Puppet Development Kit (PDK) includes key Puppet code development and testing tools for Linux, Windows, and OS X workstations, so you can install one package with the tools you need to create and validate new modules.

PDK includes testing tools, a complete module skeleton, and command line tools to help you create, validate, and run tests on Puppet modules. PDK also includes all dependencies needed for its use.

PDK includes the following tools:

Tool Description
metadata-json-lint Validates and lints metadata.json files in modules against Puppet's module metadatastyle guidelines.
pdk Command line tool for generating and testing modules
puppet-lint Checks your Puppet code against the recommendations in the Puppet Language style guide.
puppet-syntax Checks for correct syntax in Puppet manifests, templates, and Hiera YAML.
puppetlabs_spec_helper Provides classes, methods, and Rake tasks to help with spec testing Puppet code.
rspec-puppet Tests the behavior of Puppet when it compiles your manifests into a catalog of Puppet resources.
rspec-puppet-facts Adds support for running rspec-puppet tests against the facts for your supported operating systems.

Installation

Download and install the newest package matching your platform from the download page. If you are using Windows, remember to close any open PowerShell windows.

For complete installation information, see the PDK documentation.

Basic usage

PDK can generate modules and classes, validate module metadata, style, and syntax, and run unit tests. This README contains very basic usage information---for complete usage information, see the PDK documentation.

Generate a module

Generates the basic components of a module and set up an infrastructure for testing it with PDK.

  1. Run the pdk new module command, specifying the name of the new module:
pdk new module my_module

This command asks a series of metadata questions and then generates the basic components of a new module.

Generate a class

To generate a class in your module, use the pdk new class command, specifying the name of your new class. To generate the main class of the module, which is defined in an init.pp file, give the class the same name as the module.

  1. From the command line, in your module's directory, run:
pdk new class class_name

PDK creates the new class manifest and a test file (as class_name_spec.rb) in your module's /spec/classes directory.

Generate a defined type

To generate a defined type in your module, use the pdk new defined_type command, specifying the name of your new defined type.

  1. From the command line, in your module's directory, run:
pdk new defined_type defined_type_name

PDK creates the new defined_type manifest and a test file (as defined_type_name_spec.rb) in your module's /spec/defines directory.

Generate a task

To generate a task in your module, use the pdk new task command, specifying the name of your new task.

  1. From the command line, in your module's directory, run:
pdk new task task_name

PDK creates the new task file and metadata.

Validating a module

PDK can validate the well-formedness of the module and style and syntax of its files.

  1. In the module's directory, run:
pdk validate

This command validates the metadata, Puppet code syntax and style, and Ruby syntax and style for the entire module.

Run unit tests

PDK's default template sets up rspec for Ruby-level unit testing, and rspec-puppet for catalog-level unit testing.

In the module's directory, run unit tests with:

pdk test unit

This command runs all available unit tests.

Experimental features

pdk bundle command

This command executes arbitrary commands in a bundler context within the module you're currently working on. Arguments to this command are passed straight through to bundler. This command is experimental and can lead to errors that can't be resolved by the pdk itself.

Note that for most uses, you must use the -- to separate bundler options from pdk options. Compare the following two commands:

Module Compatibility

PDK Version Compatibility: Modules created with PDK version validate against and run on all Puppet and Ruby version combinations currently under maintenance (see https://docs.puppet.com/puppet/latest/about_agent.html and https://puppet.com/misc/puppet-enterprise-lifecycle)

Contributing

PDK encourages community contributions. See the CONTRIBUTING.md file for development notes.

Contact Information

To contact us with questions: pdk-maintainers@puppet.com

You can’t perform that action at this time.