You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
david22swan f00aaae34e
Merge pull request #916 from scotje/maint_switch_pdk_templates_to_main
2 weeks ago
.github (MAINT) Add "needs-triage" default labels to issue templates 1 year ago
bin (PDK-176) Rename Pick to PDK 3 years ago
docs update to Debian 10 in various places 2 months ago
exe (SDK-333) Rescue Interrupt cleanly 3 years ago
ext (maint) Add cop to detect smart quote use 11 months ago
lib (MAINT) Switch default pdk-templates branch to `main` 2 weeks ago
locales (MAINT) Release prep for 1.18.0 5 months ago
package-testing (FIXUP) Fix broken package test after changing validator output format 2 months ago
rakelib (maint) Rake task to test PDK components in isolation 1 year ago
spec (MAINT) Switch default pdk-templates branch to `main` 2 weeks ago
.dependency_decisions.yml (maint) Manually set facter license to Apache 2.0 1 year ago
.gitignore (PDK-1432) Autogenerate PowerShell modules from code 1 year ago
.rspec Initial `bundler gem` templates 3 years ago
.rubocop.yml (maint) Update for Ruby 2.3 8 months ago
.rubocop_todo.yml (feat) - Add console command 1 year ago
.travis.yml (maint) Use Ruby 2.5 on Travis for PDK as a library tests 8 months ago
CHANGELOG.md (MAINT) Release prep for 1.18.1 3 months ago
CODEOWNERS Revert "(MAINT) Add Heston as code owner for docs subdirectory" 3 months ago
CONTRIBUTING.md (PDK-1335) Add development note when on Windows 1 year ago
Gemfile (MAINT) Bump allowable range for ffi gem 6 months ago
LICENSE Initial commit 3 years ago
NOTICE Naming fix 3 years ago
README.md (feat) - Add console command 1 year ago
Rakefile (maint) Update methods for Bundler 2.x deprecations 10 months ago
appveyor.yml (maint) Update methods for Bundler 2.x deprecations 10 months ago
pdk.gemspec (MAINT) Update to latest version of tty-prompt 3 months ago

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.
puppet-debugger Provides a REPL based debugger console.

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 console command

The pdk console command executes a session of the puppet debugger when inside a module and allows for exploration of puppet code. See the official puppet debugger site for more info and the official docs site here.

To use, execute pdk console from inside your module directory. You can also supply the --puppet-version or --pe-version or --puppet-dev to swap out the puppet version when using the console.

Example (from within a module):

  • pdk console --puppet-version=5
  • pdk console --pe-version=2018.1

The pdk console command will also pass through any puppet debugger arguments you wish to use.

Example:

  • pdk console --no-facterdb
  • pdk console --play https://gist.github.com/logicminds/4f6bcfd723c92aad1f01f6a800319fa4
  • pdk console -e "md5('sdfasdfasdf')" --run-once --quiet

Use pdk console -h for a further explanation of pass through arguments.

If you receive the following error you do not have the puppet-debugger gem installed.

pdk console -h
Error: Unknown Puppet subcommand 'debugger'
See 'puppet help' for help on available puppet subcommands

To fix this you will need to add the following entry to your .sync.yml file and run pdk update:

Gemfile:
  required:
    ":development":
      - gem: puppet-debugger
        version: "~> 0.14"

NOTE: The puppet-debugger gem has been added to the puppet-module-* gems, so once you get the gem update you no longer need the .sync.yml entry.

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 PDK itself.

Module Compatibility

PDK Version Compatibility: Modules created with PDK 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