kitchen-kubernetes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce9d583074708f5f29f30010010062540cde4999
+  data.tar.gz: 9b055d6ebdfb15e5c1fb9bbb9b0f31eab0430058
+SHA512:
+  metadata.gz: 4e21cd70c6f82a6f0b37f87ebdee03bcd2c885815a454315d184504435cf610116ebd0c11b2997975da04f653eb4112454a5f504c8fdb62a787f58a333dc0161
+  data.tar.gz: b75f0e328bc8fe7055be3082e94aac5aa3128dfe471c329f62da822e461bce541356b091d99b657addbed5a89cd01534b2d62325fd33f244684aeba1103ef7cd

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+.kitchen/

data/.travis.yml

@@ -0,0 +1,50 @@
+#
+# Copyright 2017, Noah Kantrowitz
+#
+# 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.
+#
+
+sudo: required
+language: ruby
+rvm: 2.4.3
+gemfile:
+  - Gemfile
+  - test/gemfiles/train-old.gemfile
+  - test/gemfiles/train-new.gemfile
+  - test/gemfiles/master.gemfile
+
+services:
+  - docker
+
+env:
+  - CHANGE_MINIKUBE_NONE_USER=true
+
+before_install:
+  - 'if [[ $BUNDLE_GEMFILE == *master.gemfile ]]; then gem update --system; fi'
+  - gem --version
+  - gem install bundler
+  - bundle --version
+  - 'bundle config --local path ${BUNDLE_PATH:-$(dirname $BUNDLE_GEMFILE)/vendor/bundle}'
+install: bundle update --jobs=3 --retry=3
+
+before_script:
+  - curl -Lo kubectl https://storage.googleapis.com/kubernetes-release/release/v1.7.0/bin/linux/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin
+  - curl -Lo minikube https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 && chmod +x minikube && sudo mv minikube /usr/local/bin
+  - sudo minikube start --vm-driver=none --kubernetes-version=v1.8.0
+  - minikube update-context
+  - JSONPATH='{range .items[*]}{@.metadata.name}:{range @.status.conditions[*]}{@.type}={@.status};{end}{end}'; until kubectl get nodes -o jsonpath="$JSONPATH" 2>&1 | grep -q "Ready=True"; do sleep 1; done
+
+script:
+  - bundle exec kitchen --version
+  - bundle exec inspec --version
+  - cd test/ && bundle exec kitchen test -d always

data/Gemfile

@@ -0,0 +1,21 @@
+#
+# Copyright 2017, Noah Kantrowitz
+#
+# 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.
+#
+
+source 'https://rubygems.org'
+
+gemspec path: File.expand_path('..', __FILE__)
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }

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,191 @@
+# Kitchen-Kubernetes
+
+[![Build Status](https://img.shields.io/travis/coderanger/kitchen-kubernetes.svg)](https://travis-ci.org/coderanger/kitchen-kubernetes)
+[![Gem Version](https://img.shields.io/gem/v/kitchen-kubernetes.svg)](https://rubygems.org/gems/kitchen-kubernetes)
+[![Gemnasium](https://img.shields.io/gemnasium/coderanger/kitchen-kubernetes.svg)](https://gemnasium.com/coderanger/kitchen-kubernetes)
+[![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+A [Test Kitchen](https://kitchen.ci/) driver for testing on top of a Kubernetes
+cluster. It is currently aimed at Chef cookbook testing, though see the [FAQ](#FAQ)
+for more information on other testing targets.
+
+## Quick Start
+
+First install the driver:
+
+```bash
+chef gem install kitchen-kubernetes
+```
+
+Then configure your `.kitchen.yml` to use the driver:
+
+```yaml
+driver:
+  name: kubernetes
+```
+
+No other options should be required for the default case but [see below](#options)
+for more information on available configuration options.
+
+## Options
+
+You can customize things by setting additional options in the `driver` section,
+for example:
+
+```yaml
+driver:
+  name: kubernetes
+  kubectl_command: ~/bin/kubectl
+  chef_version: 13.5.21
+```
+
+* `cache_path` - Host path for the Chef installation cache. See [below](#chef-install). *(default: /data/chef/%{chef_version})*
+* `cache_volume` - Kubernetes [volume](https://kubernetes.io/docs/api-reference/v1.8/#volume-v1-core) description for the Chef install volume. *(default: auto-generated)*
+* `chef_image` - Docker data image to get the Chef installation from. *(default: chef/chef)*
+* `chef_version` - Version of the Chef data image to use. *(default: latest)*
+* `context` - Kubectl configuration context to use. *(default: current-context)*
+* `image` - Docker image for the main container in the pod, where Chef is run. *(default: based on the platform name and version)*
+* `init_system` - Init system to activate in the default container. See #systemd. *(default: nil)*
+* `kubectl_command` - Path to the `kubectl` command to use. *(default: kubectl)*
+* `pod_name` - Name of the generated pod. *(default: auto-generate)*
+* `pod_template` - Path to the Erb template to create the pod. See [below](#pod). *(default: internal)*
+* `rsync_command` - Path to the `rsync` command to use. *(default: rsync)*
+* `rsync_image` - Docker image to use for the rsync container in the pod. *(default: kitchenkubernetes/rsync)*
+
+## Chef Install
+
+In a similar fashion to [`kitchen-dokken`](https://github.com/someara/kitchen-dokken/),
+this driver uses the `chef/chef` Docker Hub images instead of the normal Chef
+installers. Unfortunately Kubernetes doesn't support using Docker images as
+volumes directly, so there has to be some copying from the data container in to a
+volume shared between the data container and main container.
+
+So as to reduce the disk I/O from launching our test pods (a Chef install is
+about 50MB so this is ~100MB of file I/O each time) we use a hostPath volume to
+give the cache some persistence between test runs. You can control the location
+of this hostPath volume using the `cache_path` configuration option:
+
+```yaml
+driver:
+  name: kubernetes
+  cache_path: /home/k8s/chef_cache/%{chef_version}
+```
+
+You can also unset `cache_path` to totally disable the cache and use an
+`emptyDir` volume instead:
+
+```yaml
+driver:
+  name: kubernetes
+  cache_path: null
+```
+
+If you have another shared storage option available, you can also set
+`cache_volume` to a Kuberenetes [Volume object]((https://kubernetes.io/docs/api-reference/v1.8/#volume-v1-core))
+(minus the `name` field) and that will be used instead:
+
+```yaml
+driver:
+  name: kubernetes
+  cache_volume:
+    persistentVolumeClaim:
+      claimName: myclaim
+```
+
+## Pod
+
+The default pod created for testing involves three containers and two volumes.
+
+The `chef` volume is [discussed above](#chef-install) and contains the `/opt/chef`
+folder of the Chef installation. The `kitchen` volume is an `emptyDir` used for
+sending files in to the test container.
+
+The `chef` container is an initContainer (meaning it runs before the other two)
+which handles copying the Chef install from the data container to the `chef`
+volume (with some caching by default so most of the time it does nothing, as mentioned
+above). The `rsync` container runs a small image containing nothing but Rsync,
+used [as part of the file upload system](#transport). The `default` container is
+where Chef is run, as well as the eventual tests.
+
+If overriding the `pod_template` configuration option, make sure your pod template
+also includes containers named `default` and `rsync`.
+
+## Transport
+
+Careful observers will note that their `kitchen list` output shows that not just
+the driver is set to `Kubernetes`, but the transport is too:
+
+```bash
+$ kitchen list
+Instance                    Driver      Provisioner  Verifier  Transport   Last Action    Last Error
+default-centos-7            Kubernetes  ChefSolo     Busser    Kubernetes  <Not Created>  <None>
+```
+
+This transport plugin is configured automatically by the driver for your convenience
+and uses `kubectl exec` for running commands on the test container. For sending
+files, rsync is used. The rsync data is also sent over `kubectl exec` to avoid
+needing to configure any additional network login services. This uses the `rsync`
+container in the pod and the `kitchen` volume. This does require `rsync` is also
+installed on your workstation (or where ever `kitchen` is running from).
+
+## Systemd
+
+If you want to enable systemd inside the container, set `init_system: systemd`.
+For example:
+
+```yaml
+driver:
+  name: kubernetes
+
+platforms:
+- name: centos-7
+  driver:
+    init_system: systemd
+- name: ubuntu-16.04
+  driver:
+    init_system: systemd
+```
+
+As a word of warning, the default `debian` Docker images do not include systemd,
+so you will need to make your own that have it installed if you want to test on
+systemd and Debian.
+
+## FAQ
+
+### Can I use this for testing things other than Chef?
+
+Not currently, but it could definitely be added. If you're interested in a
+particular provisioner, open an issue so I know there is user demand.
+
+### Can I test Kubernetes objects like deployments and services?
+
+Not yet, though it is planned. If you have a specific use case in mind, please
+open an issue and let me know.
+
+### Will this work with GKE/AKE/etc?
+
+I think so but haven't tested it myself.
+
+### Will this work with minkube?
+
+Yes, just make sure you have the minikube config context activated.
+
+## Sponsors
+
+Development sponsored by [SAP](https://www.sap.com/).
+
+## License
+
+Copyright 2017, Noah Kantrowitz
+
+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.