kitchen-terraform 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f03cf599dfe3f84c964a2ee046ee339fec308920
-  data.tar.gz: a796e35249231547ce68cef067bd1408f30295b7
+  metadata.gz: 6b4be9d9c79109cd8c7d27631d992c551f508051
+  data.tar.gz: a019d47c4806a39ae9ceb79c68cb6035434b9c54
 SHA512:
-  metadata.gz: fee5b34d17854a32f579363580050bd6406e3fa3e9628e88102d1b0c888e19546d2df7e259c4bdb4bfa3f133323304f4d3bf41daa5e6469ef61f44a9cbae38eb
-  data.tar.gz: 1c1cff573cf5973649ec40728443a78f7aaa147204ec09d10db9ffd21d6eeab99ccc89c33edf418bd67d49c0104691cec0884d41bcc440f9285f4ca4b5082e06
+  metadata.gz: 02d385543bf228d438f3b46f981f4f3e0e6a239c8d688985d4011aa8589d8ad97fbbfe9c3ce817e9e134285a4e4a4ab8146080374ddef29c54e28f6302829ebd
+  data.tar.gz: ceeedf1e2859eaea6528f825b96780a90bff9e7f6910b1784d11508b804e048800abcbe3384c3375f8a512f9d363f10b8e4f8c9fe0f42743bb0d26824a3a8419

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,284 @@
+# kitchen-terraform
+
+kitchen-terraform is a set of [Test Kitchen] plugins for testing
+[Terraform configuration].
+
+[Test Kitchen]: http://kitchen.ci/index.html
+
+[Terraform configuration]: https://www.terraform.io/docs/configuration/index.html
+
+## Requirements
+
+- [Ruby] **(~> 2.3)**
+
+- [Bundler] **(~> 1.12)**
+
+- [Terraform] **(~> 0.6)**
+
+[Ruby]: https://www.ruby-lang.org/en/index.html
+
+[Bundler]: https://bundler.io/index.html
+
+[Terraform]: https://www.terraform.io/index.html
+
+## Installation
+
+kitchen-terraform is packaged as a cryptographically signed [Ruby gem]
+which means it can be [installed with Bundler].
+
+### Adding kitchen-terraform to a Terraform project
+
+Once Bundler is installed, add kitchen-terraform to the project's Gemfile:
+
+```rb
+source 'https://rubygems.org'
+
+gem 'kitchen-terraform', '~> 0.1'
+```
+
+Before running `bundle`, the author's public key must be added as a trusted certificate:
+
+```sh
+gem cert --add <(curl --location --silent \
+https://raw.githubusercontent.com/newcontext/kitchen-terraform/master/certs/ncs-alane-public_cert.pem)
+```
+
+Then, install the bundle and verify all of the gems:
+
+```sh
+bundle install --trust-policy HighSecurity
+```
+
+[Ruby Gem]: http://guides.rubygems.org/what-is-a-gem/index.html
+
+[installed with Bundler]: https://bundler.io/index.html#getting-started
+
+## Usage
+
+The provided plugins must all be used together in the
+[Test Kitchen configuration] in order to successfully test the provided
+Terraform configuration.
+
+[Test Kitchen configuration]: https://docs.chef.io/config_yml_kitchen.html
+
+Refer to the [examples directory] for a detailed example project.
+
+[examples directory]: examples/
+
+## Plugins
+
+### Driver
+
+The [driver] is responsible for ensuring compatibility with Terraform and
+destroying existing [Terraform state].
+
+[driver]: lib/kitchen/driver/terraform.rb
+
+[Terraform state]: https://www.terraform.io/docs/state/index.html
+
+#### Actions
+
+##### kitchen create
+
+The driver validates the installed version of
+Terraform against the version supported by kitchen-terraform.
+
+##### kitchen destroy
+
+The driver applies a destructive [Terraform plan] to the
+Terraform state based on the Terraform configuration provided to the
+provisioner.
+
+[Terraform plan]: https://www.terraform.io/docs/commands/plan.html
+
+#### Configuration
+
+There are no configuration options for the driver.
+
+##### Example
+
+*.kitchen.yml*
+
+```yaml
+---
+driver:
+  name: terraform
+```
+
+### Provisioner
+
+The [provisioner] is responsible for creating Terraform state.
+
+[provisioner]: lib/kitchen/provisioner/terraform.rb
+
+#### Actions
+
+##### kitchen converge
+
+The provisioner applies a constructive Terraform plan to the
+Terraform state based on the provided Terraform configuration.
+
+#### Configuration
+
+##### directory
+
+The pathname of the directory containing the Terraform configuration
+to be tested; corresponds to the [directory specified] in several
+Terraform commands.
+
+[directory specified]: https://www.terraform.io/docs/configuration/load.html
+
+###### Example
+
+*.kitchen.yml*
+
+```yaml
+---
+provisioner:
+  name: terraform
+  directory: directory/containing/terraform/configuration
+```
+
+###### Default
+
+The default `directory` is the current working directory of Test Kitchen.
+
+##### variable_files
+
+A collection of pathnames of [Terraform variable files] to be evaluated
+for the configuration.
+
+[Terraform variable files]: https://www.terraform.io/docs/configuration/variables.html#variable-files
+
+###### Examples
+
+*.kitchen.yml*
+
+```yaml
+---
+provisioner:
+  name: terraform
+  variable_files:
+    - first/terraform/variable/file
+    - second/terraform/variable/file
+---
+provisioner:
+  name: terraform
+  variable_files: a/terraform/variable/file
+```
+
+###### Default
+
+The default `variable_files` collection is empty.
+
+##### variables
+
+A collection of [Terraform variables] to be set in the configuration;
+the syntax matches that of [assigning variables] with command-line
+flags.
+
+[Terraform variables]: https://www.terraform.io/docs/configuration/variables.html
+
+[assigning variables]: https://www.terraform.io/intro/getting-started/variables.html#assigning-variables
+
+###### Examples
+
+*.kitchen.yml*
+
+```yaml
+---
+provisioner:
+  name: terraform
+  variables:
+    - foo=bar
+    - biz=baz
+---
+provisioner:
+  name: terraform
+  variables: foo=bar
+```
+
+###### Default
+
+The default `variables` collection is empty.
+
+### Verifier
+
+The [verifier] is responsible for verifying the behaviour of any server
+instances in the Terraform state.
+
+[verifier]: lib/kitchen/verifier/terraform.rb
+
+#### Actions
+
+##### kitchen verify
+
+The verifier verifies the configured server instances in the Terraform
+state using [Inspec profiles].
+
+[Inspec profiles]: https://github.com/chef/inspec/blob/master/docs/profiles.rst
+
+#### Configuration
+
+The verifier inherits from [kitchen-inspec] and should support any
+configuration defined by that plugin with the exception of the `port` and
+`username` configuration which are specified under `groups`.
+
+[kitchen-inspec]: https://github.com/chef/kitchen-inspec/
+
+##### groups
+
+A collection of group mappings containing [Inspec control] and
+connection options for the different server instance groups in the
+Terraform configuration.
+
+[Inspec control]: https://github.com/chef/inspec/blob/master/docs/dsl_inspec.rst
+
+Each group consists of:
+
+- a name to use for logging purposes
+
+- a mapping of Inspec attribute names to Terraform output variable
+  names to define for the suite's Inspec profile
+
+- a collection of controls to include from the suite's Inspec profile
+
+- a hostnames output variable name to use for extracting hostnames from
+  the Terraform state; the output value is assumed to be in CSV format
+
+- the port to use when connecting to the group's hosts
+
+- the username to use when connecting to the group's hosts
+
+###### Example
+
+*.kitchen.yml*
+
+```yaml
+---
+verifier:
+  name: terraform
+  groups:
+    - name: arbitrary
+      attributes:
+        foo: bar
+      controls:
+        - biz
+      hostnames: hostnames_output
+      port: 123
+      username: test-user
+```
+
+###### Defaults
+
+The default `groups` collection is empty.
+
+For each group:
+
+- the default `attributes` mapping is empty
+
+- the default `controls` collection is empty
+
+- the default `port` is obtained from the transport
+
+- the default `username` is obtained from the transport