puppet_comply 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 849b938d75f400119b8f80bd9978bcb36d6c2587
+  data.tar.gz: 6a697a963d824a230175a07512734960db6924ab
+SHA512:
+  metadata.gz: aaa7bd6fcd3ad7c01fba4fcb73af1a45d2d48eb8400ec1a71cb57c9c713ca28c976a0decee1c28fd90dd48ecb1e41221289fc599b9c7e6417999711117744714
+  data.tar.gz: 762595e078ae5d859b132025be0a8751d03ee64433fcf800cc6c7c82ccde8e38fb0950305bb3d3e222a337cc45c08a4cbf2eecb1d99b4e9daa88a4e3dfda8649

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jesse@va.com.au. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puppet_comply.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jesse Reynolds
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# PuppetComply
+
+## WARNING
+
+This is a work in progress and will probably cause you to burst into flames. Use at your own risk.
+
+This gem seeks to provide a mechamism to test arbritrary Puppet modules for compliance against some security spec. The modules under test must contain rspec tests for this gem to inject the rspec shared examples into.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puppet_comply'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puppet_comply
+
+## Usage
+
+Initialise a new set of compliace tests:
+
+```
+puppet_comply init
+```
+
+Add that resulting directory to a git repo so that you can use it as follows:
+
+```
+# download your general purpose compliance tests
+git clone git://git.example/foo/compliance_tests.git
+
+# check any module for compliance with your tests
+cd compliance_tests
+puppet_comply check --forge-module puppetlabs/motd
+```
+
+Uses [librarian-puppet](https://github.com/voxpupuli/librarian-puppet) to resolve and install dependencies declared in metadata.json from the Puppet Forge.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jessereynolds/puppet_comply. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "puppet_comply"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/puppet_comply

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+require 'escort'
+require 'puppet_comply/check'
+
+# display help if nothing specified
+ARGV.push('-h') if ARGV.empty?
+
+Escort::App.create do |app|
+  app.version PuppetComply::VERSION
+  app.summary "Puppet Comply"
+  app.description "Test your puppet code complies with stuffs"
+
+  app.options do |opts|
+    # opts.opt(:keep_container,
+    #   'Leave container running?',
+    #   :long     => '--keep-container',
+    #   :type     => :boolean,
+    #   :default  => false,
+    # )
+  end
+
+  app.command :check do |command|
+    command.summary "Perform checks"
+    command.description "write more detail here"
+    command.options do |opts|
+      opts.opt(:forge_module,
+               'Specify a forge module to test, eg puppetlabs/apache',
+               :long => '--forge-module',
+               :type => :string,
+               :default => nil,
+              )
+    end
+    command.action do |options, arguments|
+      forge = options[:global][:commands][:check][:options][:forge_module]
+      PuppetComply::Check.run(forge_module: forge)
+
+      # PDQTest::Emoji.disable(options[:global][:options][:disable_emoji])
+      #
+      # PDQTest::Instance.set_keep_container(options[:global][:options][:keep_container])
+      # PDQTest::Core.run([
+      #   lambda {PDQTest::Syntax.puppet},
+      #   lambda {PDQTest::Lint.puppet},
+      #   lambda {PDQTest::Rspec.run},
+      #   lambda {PDQTest::Instance.run},
+      # ])
+    end
+  end
+
+
+end

data/lib/puppet_comply.rb

@@ -0,0 +1,5 @@
+require "puppet_comply/version"
+
+module PuppetComply
+  # Your code goes here...
+end

data/lib/puppet_comply/check.rb

@@ -0,0 +1,59 @@
+
+# download module
+#
+# download dependencies
+#
+# verify each class and defined type in the module has an associated rspec test - fail if no
+#
+# run rspec tests in the module, inserting our shared examples into their context
+#
+
+# this is amazingly ripe for refactoring
+#
+require 'puppet_forge'
+
+module PuppetComply
+  module Check
+    def self.run(forge_module:)
+      self.download_forge_module(forge_module)
+      self.execute_rspec(self.module_path(forge_module))
+    end
+
+    def self.download_forge_module(forge_module)
+      modules_dir = File.join(Dir.pwd, 'modules')
+      if File.exist?(modules_dir)
+        FileUtils.rm_rf(modules_dir)
+      end
+      Dir.mkdir(modules_dir)
+
+      system("bundle exec puppet module install #{forge_module} --target-dir #{modules_dir}")
+    end
+
+    def self.module_path(forge_module)
+      File.join(Dir.pwd, 'modules', forge_module.split(/[\/-]/, 2).last)
+    end
+
+    def self.execute_rspec(module_path)
+      Dir.chdir(module_path) do
+        Bundler.with_clean_env do
+          system('bundle install && bundle exec rake spec_prep')
+          if File.directory?('spec/fixtures/modules')
+            Dir.chdir('spec/fixtures/modules') do
+              Dir.glob('../../../../*').each do |path|
+                next if ['.', '..'].include?(path)
+                next if File.exist?(File.basename(path))
+                puts "symlinking #{path} to #{File.basename(path)}"
+                FileUtils.ln_s(path, File.basename(path))
+              end
+            end
+          else
+            raise 'oh no'
+          end
+          system('bundle exec rake spec')
+        end
+      end
+    end
+
+  end
+end
+

data/lib/puppet_comply/version.rb

@@ -0,0 +1,3 @@
+module PuppetComply
+  VERSION = "0.1.0"
+end

data/puppet_comply.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puppet_comply/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "puppet_comply"
+  spec.version       = PuppetComply::VERSION
+  spec.authors       = ["Jesse Reynolds"]
+  spec.email         = ["jesse@va.com.au"]
+
+  spec.summary       = %q{compliance test puppet code}
+  spec.homepage      = "https://github.com/jessereynolds/puppet_comply"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "escort", "0.4.0"
+  spec.add_runtime_dependency "puppet_forge"
+  spec.add_runtime_dependency "librarian-puppet"
+  spec.add_runtime_dependency "puppet"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: puppet_comply
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jesse Reynolds
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: escort
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: puppet_forge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: librarian-puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jesse@va.com.au
+executables:
+- puppet_comply
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/puppet_comply
+- lib/puppet_comply.rb
+- lib/puppet_comply/check.rb
+- lib/puppet_comply/version.rb
+- puppet_comply.gemspec
+homepage: https://github.com/jessereynolds/puppet_comply
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: compliance test puppet code
+test_files: []