onceover-octocatalog-diff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 691c97a6f9063f49509f7c24f7e6a969ca77e59f
+  data.tar.gz: 393491acfe7f393c47222b2b170cd2e92e01cee2
+SHA512:
+  metadata.gz: 33dee3aa8d06df1571bce554905711bd3c67109d4a5d6a8c417a362344078090396fa303b0484f3e70765151e092fa07ad0d259c67327f4ba1a076aff3511739
+  data.tar.gz: 024e1ecb4bc1eaabd600e90b7749c12436b728ced60f98eb1ad970dcd29ab338b53f37b4308d33c57ce7f78dc9abf29082e239021e7eddc918576a28b977462c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dylan Ratcliffe
+
+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,36 @@
+# Octocatalog-diff Onceover plugin
+
+This plugin adds the `onceover run diff` command to onceover. Instead of testing that all if your catalogs compile, it compiles two versions of each catalog and returns you the differences. This is great for ensuring that changed that you were intending to make have had the desired effect and scope.
+
+Kudos to Kevin and the team at GitHub for actually building [octocatalog-diff](https://github.com/github/octocatalog-diff)!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'onceover-octocatalog-diff'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install onceover-octocatalog-diff
+
+## Usage
+
+`onceover run diff`
+
+All config follows the normal [onceover](https://github.com/dylanratcliffe/onceover) configuration.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dylanratcliffe/onceover-octocatalog-diff.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "onceover/octocatalog/diff"
+
+# 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

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/onceover/octocatalog/diff.rb

@@ -0,0 +1,17 @@
+require "onceover/octocatalog/diff/version"
+require "onceover/octocatalog/diff/cli"
+
+class Onceover
+  module Octocatalog
+    module Diff
+      def self.create_facts_yaml(repo,output_location)
+        require 'json'
+
+        repo.facts_files.each do |facts_file|
+          facts = JSON.load(File.read(facts_file))
+          File.open("#{output_location}/#{File.basename(facts_file,'.*')}.yaml", 'w') {|f| f.write facts.to_yaml }
+        end
+      end
+    end
+  end
+end

data/lib/onceover/octocatalog/diff/cli.rb

@@ -0,0 +1,108 @@
+class Onceover
+  class CLI
+    class Run
+      class Diff
+        def self.command
+          @cmd ||= Cri::Command.define do
+            name 'diff'
+            usage 'diff'
+            summary "Diff two versions of the controlrepo's compiled catalogs"
+            description <<-DESCRIPTION
+This uses octocatalog-diff to run diffs on all things in the test matrix
+instead of actually testing them. Requires two branches, tags or
+revisions to compare between.
+            DESCRIPTION
+
+            option :f,  :from, 'branch to compare from', argument: :required
+            option :t,  :to,   'branch to compare to', argument: :required
+
+            run do |opts, args, cmd|
+              require 'pry'
+              require 'facter'
+              require 'colored'
+
+              #TODO: Allow for custom arguments
+              repo        = Onceover::Controlrepo.new(opts)
+              test_config = Onceover::TestConfig.new(repo.onceover_yaml, opts)
+              num_threads = (Facter.value('processors')['count'] / 2)
+              #runner.prepare!
+              tests = test_config.run_filters(Onceover::Test.deduplicate(test_config.spec_tests))
+              @queue = tests.inject(Queue.new, :push)
+              @results = []
+
+              @threads = Array.new(num_threads) do
+                Thread.new do
+                  until @queue.empty?
+                    test = @queue.shift
+
+                    logger.info "Preparing environment for #{test.classes[0].name} on #{test.nodes[0].name}"
+                    logger.debug "Creating temp directory"
+                    tempdir = Dir.mktmpdir(test.to_s)
+                    logger.debug "Temp directory created at #{tempdir}"
+
+                    logger.debug "Copying controlrepo to #{tempdir}"
+                    FileUtils.copy_entry(repo.root,tempdir)
+
+                    logger.debug "Converting facts to yaml"
+                    Onceover::Octocatalog::Diff.create_facts_yaml(repo,"#{tempdir}/spec/factsets")
+
+                    logger.info "Deploying Puppetfile for #{test.classes[0].name} on #{test.nodes[0].name}"
+                    r10k_cmd = "r10k puppetfile install --verbose --color --puppetfile #{repo.puppetfile}"
+                    Open3.popen3(r10k_cmd) do |stdin, stdout, stderr, wait_thr|
+                      exit_status = wait_thr.value
+                      if exit_status.exitstatus != 0
+                        throw stderr
+                      end
+                    end
+
+                    # TODO: Improve the way this works so that it doesn't blat site.pp
+                    logger.debug "Creating before script that overwrites site.pp"
+                    class_name = test.classes[0].name
+                    template_dir = File.expand_path('../../../../templates',File.dirname(__FILE__))
+                    template = File.read(File.expand_path("./change_manifest.rb.erb",template_dir))
+                    File.write("#{tempdir}/bootstrap_script.rb",ERB.new(template, nil, '-').result(binding))
+                    FileUtils.chmod("u=rwx","#{tempdir}/bootstrap_script.rb")
+
+                    logger.debug "Getting Puppet binary"
+                    binary = `which puppet`.chomp
+
+                    logger.debug "Running Octocatalog diff"
+                    logger.debug "Command: octocatalog-diff --fact-file #{tempdir}/spec/factsets/#{test.nodes[0].name}.yaml -f #{opts[:from]} -t #{opts[:to]} --basedir #{tempdir} --puppet-binary #{binary} --bootstrap-script #{tempdir}/bootstrap_script.rb"
+                    logger.info "Compiling catalogs for #{test.classes[0].name} on #{test.nodes[0].name}"
+                    cmd = "octocatalog-diff --fact-file #{tempdir}/spec/factsets/#{test.nodes[0].name}.yaml -f #{opts[:from]} -t #{opts[:to]} --basedir #{tempdir} --puppet-binary #{binary} --bootstrap-script '#{tempdir}/bootstrap_script.rb'"
+                    Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+                      exit_status = wait_thr.value
+                      @results << {
+                        stdout: stdout.read,
+                        stderr: stderr.read,
+                        exit_status: exit_status.exitstatus,
+                        test: test
+                      }
+                    end
+                    logger.info "Storing results for #{test.classes[0].name} on #{test.nodes[0].name}"
+                    FileUtils.rm_r(tempdir)
+                  end
+                end
+              end
+
+              @threads.each(&:join)
+              @results.each do |result|
+                puts "#{"Test:".bold} #{result[:test].classes[0].name} on #{result[:test].nodes[0].name}"
+                puts "#{"Exit:".bold} #{result[:exit_status]}"
+                puts "#{"Status:".bold} #{"changes".yellow}" if result[:exit_status] == 2
+                puts "#{"Status:".bold} #{"no differences".green}" if result[:exit_status] == 0
+                puts "#{"Status:".bold} #{"failed".red}" if result[:exit_status] == 1
+                puts "#{"Results:".bold}\n#{result[:stdout]}\n" if result[:exit_status] == 2
+                puts "#{"Errors:".bold}\n#{result[:stderr]}\n" if result[:exit_status] == 1
+                puts ""
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# Register itself
+Onceover::CLI::Run.command.add_command(Onceover::CLI::Run::Diff.command)

data/lib/onceover/octocatalog/diff/version.rb

@@ -0,0 +1,7 @@
+class Onceover
+  module Octocatalog
+    module Diff
+      VERSION = "0.1.0"
+    end
+  end
+end

data/onceover-octocatalog-diff.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'onceover/octocatalog/diff/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "onceover-octocatalog-diff"
+  spec.version       = Onceover::Octocatalog::Diff::VERSION
+  spec.authors       = ["Dylan Ratcliffe"]
+  spec.email         = ["dylan.ratcliffe@puppet.com"]
+
+  spec.summary       = "Adds octocatalog-diff functionality to onceover"
+  spec.description   = "Allows Onceover users to use their existing factsets to check what affect given changes will have on a role's compiled catalog"
+  spec.homepage      = "https://github.com/dylanratcliffe/onceover-octocatalog-diff"
+  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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency 'octocatalog-diff', '~> 1.0'
+  spec.add_runtime_dependency 'onceover', '>= 3.2.0'
+end

data/templates/change_manifest.rb.erb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'onceover/controlrepo'
+
+repo = Onceover::Controlrepo.new()
+tempdir = Dir.pwd
+
+FileUtils.copy_entry("<%= tempdir %>/modules","#{tempdir}/modules")
+system("r10k puppetfile install --verbose --color --puppetfile '<%= repo.puppetfile %>'")
+
+
+if repo.config['manifest']
+  manifest_dir = "#{tempdir}/#{repo.config['manifest']}"
+else
+  manifest_dir = "#{tempdir}/manifests"
+end
+
+FileUtils.rm_r(Dir["#{manifest_dir}/*"])
+
+somefile = File.open("#{manifest_dir}/site.pp", "w")
+somefile.puts "include <%= class_name %>"
+somefile.close

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: onceover-octocatalog-diff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dylan Ratcliffe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: octocatalog-diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: onceover
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Allows Onceover users to use their existing factsets to check what affect
+  given changes will have on a role's compiled catalog
+email:
+- dylan.ratcliffe@puppet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/onceover/octocatalog/diff.rb
+- lib/onceover/octocatalog/diff/cli.rb
+- lib/onceover/octocatalog/diff/version.rb
+- onceover-octocatalog-diff.gemspec
+- templates/change_manifest.rb.erb
+homepage: https://github.com/dylanratcliffe/onceover-octocatalog-diff
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Adds octocatalog-diff functionality to onceover
+test_files: []