simp-module-repoclosure 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73d798d180fe91e00f71781a5d20b3ff75a5ec30
+  data.tar.gz: 4c5cc4893da773eb3a331b99a03d416272b3b615
+SHA512:
+  metadata.gz: 6f203f81cddcf040a734b305d57c96bae57cf38589685b731bb6f0c3eff920e76bbed5b5f33d4179f1e026c2938cad76161bcff2c5053ee8991f85ff9e2d9327
+  data.tar.gz: 76a876a0a6c5343ad80d1b3aeb8a4cd1409814a92ec0f3ab53c64b00a1b952fad39d2dc52840f8fc0c6cf1bb6282ebef613bf42cf41995f59cc4df829c15e92e

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+.*.sw?
+.bundle/
+/.bundle
+/.rspec_system
+/.vagrant
+/.yardoc
+/.yardoc/
+/Gemfile.lock
+/dist/
+/doc/
+/junit
+/log
+/pkg
+/pkg/
+/vendor
+/vendor/cache/*.gem
+Gemfile.lock
+/tmp
+pkg/

data/.rspec

@@ -0,0 +1,2 @@
+--colour --format documentation
+--fail-fast

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "simp-module-repoclosure Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2016-04-16
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'puppet'
+
+group :development do
+  gem 'kramdown'
+  gem 'guard'
+  gem 'guard-shell'
+  gem 'guard-rspec'
+  gem 'guard-rake'
+end

data/Guardfile

@@ -0,0 +1,78 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec feature)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Make Guard exit when config is changed so it can be restarted
+#
+## Note: if you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+#
+#  $ while bundle exec guard; do echo "Restarting Guard..."; done
+#
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), the you will want to move the Guardfile
+## to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+#
+watch 'Guardfile' do
+  UI.info 'Exiting because Guard must be restarted for changes to take effect'
+  exit 0
+end
+
+
+# shell commands
+guard :shell do
+  # test that the .gemspec still works
+  watch %r{^.*\.gemspec$} do |m|
+    cmd = "bundle exec gem build '#{m[0]}'"
+    p "== #{cmd}"
+    `#{cmd}`
+  end
+end
+
+
+# Run rspec tests when things change
+guard :rspec, cmd: 'bundle exec rspec ' do
+  watch(%r{^spec/lib/.+_spec\.rb$})
+
+  # when a file changes run the tests for that file
+  watch(%r{^lib/(.+)\.rb$}) do |m|
+    File.join( 'spec', 'lib', "#{m[1]}_spec.rb" )
+  end
+
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+
+# tmux 1.7+ can send rspec results to the TMUX status pane.
+notification( :tmux, {
+  display_message: true,
+  timeout: 5, # in seconds
+  default_message_format: '%s >> %s',
+  # the first %s will show the title, the second the message
+  # Alternately you can also configure *success_message_format*,
+  # *pending_message_format*, *failed_message_format*
+  line_separator: ' > ', # since we are single line we need a separator
+  color_location: 'status-left-bg', # to customize which tmux element will change color
+
+  # Other options:
+  default_message_color: 'black',
+  success: 'colour150',
+  failure: 'colour174',
+  pending: 'colour179',
+  # Notify on all tmux clients
+
+  display_on_all_clients: false
+}) if ( ENV.fetch( 'TMUX', false ) && (%x{tmux -V}.split(' ').last.split('.').last.to_i > 6 ))
+# vim:set syntax=ruby:
+

data/LICENSE

@@ -0,0 +1,27 @@
+simp-module-repoclosure - TODO: Summary
+
+--
+
+Per Section 105 of the Copyright Act of 1976, these works are not entitled to
+domestic copyright protection under US Federal law.
+
+The US Government retains the right to pursue copyright protections outside of
+the United States.
+
+The United States Government has unlimited rights in this software and all
+derivatives thereof, pursuant to the contracts under which it was developed and
+the License under which it falls.
+
+---
+
+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/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 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/NOTICE.txt

@@ -0,0 +1,5 @@
+simp-module-repoclosure
+Copyright 2016 Chris Tessmer
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,99 @@
+[![Build Status](https://secure.travis-ci.org/simp/rubygem-simp-module-repoclosure.svg?branch=master)](https://travis-ci.org/simp/rubygem-simp-module-repoclosure)
+[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
+# simp-module-repoclosure
+
+A ~~stupidly~~ admirably direct dependency validator for a Puppet module's `metadata.json`.  Use a tiny dedicated Puppet Forge to stage your modules' dependences with ` puppet module install`!
+
+#### Table of Contents
+1. [Overview](#overview)
+* [What this gem does](#what-this-gem-does)
+* [How it does that](#how-it-does-that)
+* [Module Dependency Closuresw it does that](#how-it-does-that)
+2. [Setup](#setup)
+* [Beginning with simp-module-repoclosure](#beginning-with-simp-module-repoclosure)
+3. [Methods](#methods)
+4. [Environment variables](#environment-variables)
+5. [Examples](#examples)
+6. [License](#license)
+
+## Overview
+
+### What this gem does
+For each **Module-under-test** (or **MUT**):
+
+- [x] Validate that the MUT will install from the Puppet Forge without breaking on dep-solving problems (such as version conflicts or missing dependencies).
+- [x]  Enable as much of this validation as possible **within network-isolated enclaves**.
+- [ ] **TODO**: Detect if dependencies are _missing_ from `metadata.json` by using the contents of `mods_dir/` as the fixture modules for `spec_standalone` tests.
+- [ ] **TODO**: Once missing dependencies are established, use the contents of `mods_dir/` to identify missing modules in the `.fixtures.yaml` file.
+
+
+### How it does that
+The MUT + dependencies are loaded into a local Puppet Forge and running `puppet module install <MUT>` against it.  If the installation succeeds, the dependencies  covered to publish on the live Puppet Forge.
+
+
+#### Basic flow
+![design](docs/img/simp-module-repoclosure design.png)
+
+
+1. _(optional)_ An upstream Puppet Forge can be used to install the dependencies for the MUT into a `mods_dir/` directory.
+  - The forge server can be changed with the environment variable [`TEST_FORGE_deps_forge`](#test_forge_deps_forge)
+  - With internet access and a single 
+2. _(optional, enclave-friendly)_ All modules in `mods_dir/` are built into `tar.gz` archives to be served by the test Forge.
+  - The `mods_dir` can be changed with the environment variable [`TEST_FORGE_mods_dir`](#test_forge_mods_dir)
+  - If the `mods_dir` is defined, the upsteam dependency forge will not be contacted.
+3. _(enclave-friendly)_ A temporary Puppet Forge is started on `localhost` and serves modules from `tars_dir/`.  In a separate process, `puppet module install` is run for each MUT against the localhost Puppet Forge (modules are installed into a temporary directory).  The test passes if all installs succeed.
+  - The `tars_dir` can be changed with the environment variable [`TEST_FORGE_tars_dir`](#test_forge_tars_dir)
+
+
+Each step of the process can be modified or skipped using [environment variables](#environment-variables) prefixed with `TEST_FORGE_` (noted in maroon text on the diagram above).
+### Module dependency scenarios
+
+
+![design](docs/img/simp-module-repoclosure tests.png)
+
+
+## Setup
+
+### Beginning with simp-module-repoclosure
+
+Add this to your project's `Gemfile`:
+
+```ruby
+gem 'simp-module-repoclosure'
+```
+
+
+
+## Environment variables
+You can set the environment variables `TEST_FORGE_tars_dir` and
+`TEST_FORGE_mods_dir` to use pre-existing diretories of modules
+for the local forge.
+
+### TEST_FORGE_deps_forge
+The upstream Puppet Forge to download MUT dependencies from.
+
+### TEST_FORGE_mods_dir
+_(enclave-friendly)_ Customize the path of the `mods_dir/` directory of unarchived module dependencies.
+- If `TEST_FORGE_mods_dir` is not set, `mods_dir/` is a temporary directory.
+- If `TEST_FORGE_mods_dir` is customized, deps Puppet forge is no longer used
+
+### TEST_FORGE_tars_dir
+_(enclave-friendly)_ Customize the path of the `tars_dir/` directory or archived `.tar.gz` modules.  By the time the test Forge starts, `tars_dir/` should include the MUT(s) and all dependencies.
+- If `TEST_FORGE_tars_dir` is not set, `tars_dir/` is a temporary directory.
+- If `TEST_FORGE_tars_dir` is customized, the Puppet Forge and `mod_path/` compilation steps will be skipped.
+
+### TEST_FORGE_port
+The TCP port on localhost or the temporary test Forge to use.  
+- If TEST_FORGE_port is no set the port will default to `8080`.
+
+
+## Examples
+```bash
+TEST_FORGE_port=8888 bundle exec rake spec
+```
+
+
+## License
+See [LICENSE](LICENSE)
+
+```