pdk 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b8385f5fba8083edb1654843d8880f2f3dccf61
-  data.tar.gz: 33b6c7c4b76e87d71ff0cb7e9f2abdc20abebc9f
+  metadata.gz: 6475b9cccfedb258b4accc3ce84b407f4f530480
+  data.tar.gz: 29aeb6521f3b3ee7bd41e2ade024e9a75a79692d
 SHA512:
-  metadata.gz: fdcca54d273721062f9d0cc52b1a7229e9dcf9f4b0ff6258e688d491ba91be2b18b4a8f1acbf5cc2f726f20b4e321fe53af794e10d3f997db4f6770005fe1bd7
-  data.tar.gz: 75aef45bbb2d901e09c1076be2c2153c3d5d792d105ce3d7a5dbd3380daa86fcc5a275e7273fe752c60e746491a66cb4057178462131296f62130465eecc312e
+  metadata.gz: bead00ff5d38bdf51ea0035b60a1d9a0f4ef111c982e14295dc4dbbe47a2bec0fd9d1d160c3267c98c73fde9ccd9beec9d3e95aae340b12ae9232649c3b27502
+  data.tar.gz: ac72b4f88da4a89fdda9377e430b040f0cb3dbba59aa4d7f6cfab3879abd3005ac00bdff70ee2b4bc7ea1e307da1b94eccaa62387e8b76fab79487cd563177ba

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,270 @@
+# pdk [![Travis Build Status](https://travis-ci.com/puppetlabs/pdk.svg?token=kFfyquZWxwxpgSetpypR&branch=master)](https://travis-ci.com/puppetlabs/pdk) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/x70e2fqllbaootpd?svg=true)](https://ci.appveyor.com/project/puppetlabs/pdk)
+
+
+A CLI to facilitate easy, unified development workflows for Puppet modules. pdk is a key part of the Puppet Development Kit, the shortest path to better modules.
+
+## Installation
+
+1. Until Puppet Development Kit packaging is available, install `pdk` into your Ruby installation with:
+
+```
+$ gem install pdk
+```
+
+## Usage
+
+### Generate a new module
+
+To get started, generate a new module from the default template.
+
+1. Run the `pdk new module` command, specifying the name of the new module:
+
+```
+pdk new module my_module
+```
+
+This generates the basic components of a new module and initializes Git for you. The `pdk new module` command sets some default values based on your environment. Check the `metadata.json` to make sure that these values are correct. The new module now contains all the infrastructure to use the other capabilities of `pdk`.
+
+### Add a new resource provider
+
+If you need to manage a specific resource that is not covered by either Puppet's basic resource types or an existing module, create a new resource provider.
+
+1. From within an existing module, run `pdk add provider`, specifying the new provider name as well as any attributes along with their data types.
+
+For example:
+
+```
+pdk add provider new_provider String:content 'Enum[absent, present]:ensure'
+```
+
+This creates all the files required to define a resource type, its provider, and the associated basic tests. In this example, the resource type has an `ensure` property with the expected values, and a `String` property named `content`. If your types use Bash special characters, such as 'Enum[absent, present]:ensure' above, you must quote to avoid issues with the shell.
+
+### Running validations
+
+The default template provides tools for running static validations of your new module. Validations run quickly, but they provide only a basic check of the well-formedness of the module and syntax of its files.
+
+```
+pdk validate
+```
+
+This displays results in the console:
+
+```
+Running validations on `new_module`:
+* ruby syntax: OK!
+* puppet syntax: OK!
+[...]
+```
+
+### Run unit tests
+
+The default template sets up [rspec](http://rspec.info/) for Ruby-level unit testing, and [rspec-puppet](https://github.com/rodjek/rspec-puppet/) for catalog-level unit testing.
+
+1. In the module's directory, run all unit tests with:
+
+```
+pdk test unit
+```
+
+<!-- // TODO: git hosting services (integration); code manager workflow integration; CI/CD Integration -->
+
+
+## Reference
+
+### `pdk new module` command
+
+Generates a new module.
+
+Usage:
+
+```
+pdk new module [--template-url=git_url] [--license=spdx_identifier] [--vcs=vcs_provider] module_name [target_dir]
+```
+
+The `pdk new module` command accepts the following arguments and options. Arguments are optional unless otherwise specified.
+
+#### `--template-url=git_url`
+
+Overrides the template to use for this module. If possible, please contribute your improvements back to the default template at [puppetlabs/pdk-module-template](https://github.com/puppetlabs/pdk-module-template).
+
+#### `--license=spdx_identifier`
+
+Specifies the license this module is written under. See https://spdx.org/licenses/ for a list of open source licenses, or use `proprietary`. Defaults to `Apache-2.0`.
+
+#### `--vcs=vcs_provider`
+
+Specifies the version control driver. Valid values: `git`, `none`. Default: `git`.
+
+#### `--skip-interview`
+
+Suppress interactive queries for initial values. All questions will use the default values.
+
+#### `module_name`
+
+**Required**. Specifies the name of the module being created, including the namespace. e.g.: `username-my_module`
+
+#### `target_dir`
+
+Specifies the directory that the new module will be created in. Defaults to creating a new directory with the given `module_name` inside the current directory.
+
+### `pdk new class` command
+
+Generates a new class and skeleton test for it in the current module.
+
+Usage:
+
+```
+pdk new class [--template-url=git_url] <class_name> [parameter_name[:parameter_type]] [parameter_name[:parameter_type]] ...
+```
+
+e.g.
+
+```
+cd my_module
+pdk new class my_class "ensure:Enum['absent', 'present']" version:String
+```
+
+#### `--template-url`
+
+Overrides the template to use when generating this class. If this is not
+specified, the template used to generate the module will be used instead. If
+that template is not available, the default template at
+[puppetlabs/pdk-module-template](https://github.com/puppetlabs/pdk-module-template)
+will be used.
+
+#### `class_name`
+
+The name of the class to generate. If the class name is not inside the module
+namespace (e.g. module name is `apt` and the class name is `source`, then the
+module name will automatically be prepended to the class name (e.g.
+`apt::source`).
+
+#### `parameter_name[:parameter_type]`
+
+If the class should take parameters, they can be specified on the command line
+to be added to the generated class. Optionally, the data type of the parameter
+can be specified along with the parameter name, separated by a colon. Any
+number of parameters can be provided on the command line.
+
+### `pdk add provider` command
+
+Adds a new resource provider to an existing module.
+
+Usage:
+
+```
+pdk add provider [--template-url=git_url] provider_name [data_type:attribute_name]*
+```
+
+The `pdk add provider` command accepts the following arguments. Arguments are optional unless specified.
+
+#### `--template-url=git_url`
+
+Overrides the template to use for this module. If possible please contribute your improvements back to the default template at [puppetlabs/pdk](https://github.com/puppetlabs/pdk).
+
+#### `provider_name`
+
+**Required**. Specifies the name of the resource provider being created.
+
+#### `data_type:attribute_name`
+
+Specifies a list of attributes with their expected data types, such as `'Enum[absent, present]:ensure'`. If not specified, the data type will have no attributes.
+
+### `pdk validate` command
+
+Runs all static validations. Any errors are reported to the console in the format requested. The exit code is non-zero when errors occur.
+
+Usage:
+
+```
+pdk validate --list
+```
+
+```
+pdk validate [--format=format[:target]] [validations] [targets*]
+```
+
+#### `--list`
+
+Displays a list of available validations and their descriptions. Using this option lists the tests without running them.
+
+#### `--format=format[:target]`
+
+Specifies the format of the output. Valid values: `junit`, `text`. Default: `text`.
+
+Optionally, you can specify a target file for the given output format with the syntax: `--format=junit:report.xml`
+
+Multiple `--format` options can be specified as long as they all have distinct output targets.
+
+#### `validations`
+
+Specifies a comma separated list of validations to run (or `all`). See the `--list` output for a list of available validations. Defaults to `all` if not supplied.
+
+#### `targets`
+
+Specifies a list of directories or individual files to validate. Validations which are not applicable to individual files will be skipped for those files. Defaults to validating everything.
+
+#### Additional Examples
+
+```
+$ pdk validate metadata
+Running 'metadata' validation on `new_module`: OK!
+```
+
+```
+$ pdk validate all lib/
+Running validations on `new_module/lib`:
+* ruby syntax: OK!
+* puppet syntax: (no puppet manifests found)
+```
+
+#### `pdk test unit` command
+
+Runs unit tests. Any errors are displayed to the console and reported in the report-file, if requested. The exitcode is non-zero when errors occur.
+
+Usage:
+
+```
+pdk test unit [--list] [--tests=test_list] [--format=format[:target]] [runner_options]
+```
+
+#### `--list`
+
+Displays a list of unit tests and their descriptions. Using this option lists the tests without running them.
+
+#### `--tests=test_list`
+
+A comma-separated list of tests to run. Use this during development to pinpoint a single failing test. See the `--list` output for allowed values.
+
+#### `--format=format[:target]`
+
+Specifies the format of the output. Valid values: `junit`, `text`. Default: `text`.
+
+Optionally, you can specify a target file for the given output format with the syntax: `--format=junit:report.xml`
+
+Multiple `--format` options can be specified as long as they all have distinct output targets.
+
+#### `runner_options`
+
+<!-- this is a cop-out; alternatives are surfacing the real runner to advanced users, or completely wrapping the runner's interface -->
+
+Specifies options to pass through to the actual test-runner. In the default template (and most commonly across modules), this is [rspec](https://relishapp.com/rspec/rspec-core/docs/command-line).
+
+## Contributing
+
+To run the `pdk` tool directly from the repository, set the environment variable `PDK_USE_SYSTEM_BINARIES` to `true`. This causes it to use the system installed binaries, instead of relying on the puppet-sdk-vanagon packaging. Currently required is a ruby (2.1, or later), and git.
+
+```
+PowerShell: $env:PDK_USE_SYSTEM_BINARIES = "true"
+cmd.exe:    set PDK_USE_SYSTEM_BINARIES=true
+bash:       export PDK_USE_SYSTEM_BINARIES=true
+```
+
+In cases where `pdk` needs to run in a working directory outside the cloned repository, either set `BUNDLE_GEMFILE` to the pdk's Gemfile location, or install and use the [binstubs of bundler](http://bundler.io/v1.15/bundle_binstubs.html), which are small proxy binaries, that set up the environment for running the tool.
+
+```
+# assuming ~/bin is already on your path:
+bundle binstubs pdk --path ~/bin
+```
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/puppetlabs/pdk.