puppet-catalog_rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 558cd4aaa0908ae662b6a575183008bf515dd89b
+  data.tar.gz: a3f08e37122919e221370700954a0244e9fb19ab
+SHA512:
+  metadata.gz: 25d33565079fde577eb66deb66b72f0a75979c0dd928394673d485bfcb22e3c9fcb0c2f739e206f26d1738fe8b096e41373579ee844102882a257e28ad6a4c96
+  data.tar.gz: 0cbedcd56cf450c02584c325e5b8121833cfc6df43e3b949e31357848e429de07127f86b78b74c7f0f2a939ab70c526029644761bf1e6701c1857b4cfa812e4e

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in puppet-catalog_rspec.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    puppet-catalog_rspec (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-17
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  puppet-catalog_rspec!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Bert Hajee
+
+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,85 @@
+# Create Specs from your existing Puppet Catalog
+
+[![Enterprise Modules](https://raw.githubusercontent.com/enterprisemodules/public_images/master/banner1.jpg)](https://www.enterprisemodules.com)
+
+Writing tests greatly enhances the quality and stability of your code in general. The same also goes for Puppet code. Puppet has a great tool for writing unit tests for Puppet code [rspec-puppet](http://rspec-puppet.com/). 
+
+But writing unit tests is not always easy. Sometimes it is hard to get visualize what your catalog looks like when a certain combination of facts and properties is passed to your code.
+
+This Gem can help you. It allows you to dump the Puppet catalog as `puppet-rspec` code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puppet-catalog_rspec'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install puppet-catalog_rspec
+```
+## Usage
+
+To use the gem, put the next line in your `spec_helper.rb`:
+
+```
+require 'puppet-catalog_rspec'
+```
+
+Now we are ready to roll.
+
+## Workflow
+
+There is no one single workflow that works, but this is what we use. In your spec file create the state you want to build the test code for by using the correct facts and params. Then use the next statement in your spec file:
+
+```
+it { dump_catalog }
+```
+
+This will dump the full current catalog as rspec-code. Here is an example:
+
+```
+it { is_expected.to contain_archive('/install/p17572726_1036_Generic.zip')
+  .with('path'    => '/install/p17572726_1036_Generic.zip')
+  .with('ensure'  => 'present')
+  .with('cleanup' => 'false')
+  .with('extract' => 'false')
+  .with('source'  => 'puppet:///middleware/p17572726_1036_Generic.zip')
+  .with('user'    => 'oracle')
+  .with('group'   => 'dba')
+  .that_requires('File[/opt/oracle/middleware/utils/bsu/cache_dir]')
+}
+
+it { is_expected.to contain_exec('patch policy for p17572726_1036_Generic.zip')
+  .with('command'   => 'bash -c "{ echo 'grant codeBase \"file:/opt/oracle/middleware/patch_wls1036/patch_jars/-\" {'; echo '      permission java.security.AllPermission;'; echo '};'; } >> /opt/oracle/middleware/wlserver/server/lib/weblogic.policy"')
+  .with('unless'    => 'grep 'file:/opt/oracle/middleware/patch_wls1036/patch_jars/-' /opt/oracle/middleware/wlserver/server/lib/weblogic.policy')
+  .with('path'      => '/usr/local/bin:/bin:/usr/bin:/usr/local/sbin:/usr/sbin:/sbin:/usr/java/jdk1.7.0_45/bin')
+  .with('user'      => 'oracle')
+  .with('group'     => 'dba')
+  .with('logoutput' => 'on_failure')
+  .that_requires('Bsu_patch[FCX7]')
+}
+```
+
+Now copy and paste the parts that you want to check in your manifest into your rspec-code and voila.
+## Development
+
+
+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/enterprisemodules/puppet-catalog_rspec.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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/catalog_rspec"
+
+# 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/lib/puppet-catalog_rspec/catalog.rb

@@ -0,0 +1,18 @@
+require 'puppet/resource/catalog'
+
+# Monky patch Puppet
+class Puppet::Resource::Catalog
+  def to_rspec
+    resources.each do |resource|
+      next if filtered?(resource.to_s)
+      resource.to_rspec
+    end
+  end
+
+  private
+
+  def filtered?(klass)
+    ['Class[main]', 'Stage[main]'].include?(klass)
+  end
+
+end

data/lib/puppet-catalog_rspec/resource.rb

@@ -0,0 +1,37 @@
+require 'puppet/resource'
+
+# Monky patch Puppet
+class Puppet::Resource
+  def to_rspec
+    type = self.type.downcase.tr(':', '_')
+    puts "it { is_expected.to contain_#{type}('#{title}')"
+    properties
+    puts '}'
+    puts ''
+  end
+
+  private
+
+  def properties
+    hash = to_hash
+    keys = hash.keys
+    max_length = keys.map(&:length).max
+    hash.each do |k, v|
+      case k
+      when :name
+        # Skip name
+        next
+      when :require
+        [v].flatten.each { |r| puts "  .that_requires('#{r}')" }
+      when :before
+        [v].flatten.each { |r| puts "  .that_comes_before('#{r}')" }
+      when :notify
+        [v].flatten.each { |r| puts "  .that_notifies('#{r}')" }
+      when :subscribe
+        [v].flatten.each { |r| puts "  .that_subscribes_to('#{v}')" }
+      else
+        puts "  .with(#{("'#{k}'").ljust(max_length + 2)} => '#{v}')"
+      end
+    end
+  end
+end

data/lib/puppet-catalog_rspec/rspec.rb

@@ -0,0 +1,3 @@
+def dump_catalog
+  catalogue.to_rspec
+end

data/lib/puppet-catalog_rspec/version.rb

@@ -0,0 +1,5 @@
+module Puppet
+  module CatalogRspec
+    VERSION = "0.1.0"
+  end
+end

data/lib/puppet-catalog_rspec.rb

@@ -0,0 +1,4 @@
+require 'puppet-catalog_rspec/version'
+require 'puppet-catalog_rspec/resource'
+require 'puppet-catalog_rspec/catalog'
+require 'puppet-catalog_rspec/rspec'

data/puppet-catalog_rspec.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "puppet-catalog_rspec/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "puppet-catalog_rspec"
+  spec.version       = Puppet::CatalogRspec::VERSION
+  spec.authors       = ["Bert Hajee"]
+  spec.email         = ["bert.hajee@enterprisemodules.com"]
+
+  spec.summary       = %q{Dump the Puppet catalog in rspec format}
+  spec.description   = %q{As an aid when writing Puppet RSpec tests, you can dump the Puppet catalog in RSpec format}
+  spec.homepage      = "https://github.com/enterprisemodules/puppet-catalog_rspec"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: puppet-catalog_rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bert Hajee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: As an aid when writing Puppet RSpec tests, you can dump the Puppet catalog
+  in RSpec format
+email:
+- bert.hajee@enterprisemodules.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/puppet-catalog_rspec.rb
+- lib/puppet-catalog_rspec/catalog.rb
+- lib/puppet-catalog_rspec/resource.rb
+- lib/puppet-catalog_rspec/rspec.rb
+- lib/puppet-catalog_rspec/version.rb
+- puppet-catalog_rspec.gemspec
+homepage: https://github.com/enterprisemodules/puppet-catalog_rspec
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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.13
+signing_key: 
+specification_version: 4
+summary: Dump the Puppet catalog in rspec format
+test_files: []