Project

pdk

0.21
A long-lived project that still receives updates
pdkpuppetlabs/pdkHomepageDocumentationSource CodeBug Tracker
A CLI to facilitate easy, unified development workflows for Puppet modules.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
509,929
Stars
225
Forks
105
Watchers
33
 Releases
Current version
3.4.0
Total releases
56
First release
2017-03-21
Latest release
2024-12-03
 Issues
Open Issues
22
Closed Issues
295
Total Issues
317
Issue Closure Rate
93%
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
129
Merged Pull Requests
899
Pull Request Acceptance Rate
87%
 Development
Primary Language
Ruby
Average date of last 50 commits
2024-11-11
Reverse Dependencies
1

 Dependencies

Runtime

puppet-modulebuilder
~> 1.0
puppet_forge
~> 5.0
bundler
>= 2.1.0, < 3.0.0
childprocess
~> 5.0
cri
~> 2.15.11
hitimes
= 2.0.0
json-schema
~> 5.0
minitar
~> 0.8
pathspec
~> 1.1
deep_merge
~> 1.2.2
diff-lcs
>= 1.5.0
ffi
>= 1.15.5, < 2.0.0
tty-prompt
~> 0.23
tty-spinner
~> 0.9
tty-which
~> 0.5
 Project Readme

pdk

Code Owners ci Gem Version

  • Installation
  • Basic usage
  • Experimental features
  • Module compatibility
  • Contributing
  • Contact Information

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 Owned by Puppet
facterdb A gem that contains facts for Operating Systems. N
metadata-json-lint Validates and lints metadata.json files in modules against Puppet module metadata style guidelines. N
pdk Tool to generate and test modules and module content, such as classes, from the command line. Y
puppet-lint Checks your Puppet code against the recommendations in the Puppet language style guide. Y
puppet-syntax Checks for correct syntax in Puppet manifests, templates, and Hiera YAML. N
puppetlabs_spec_helper Provides classes, methods, and Rake tasks to help with spec testing Puppet code. Y
rspec-puppet Tests the behavior of Puppet when it compiles your manifests into a catalog of Puppet resources. Y
rspec-puppet-facts Adds support for running rspec-puppet tests against the facts for your supported operating systems. N

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.

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.

License

This codebase is licensed under Apache 2.0. However, the open source dependencies included in this codebase might be subject to other software licenses such as AGPL, GPL2.0, and MIT.

Contact Information