knife-runlist-compare 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2Q2YTIyZGIyZjMzNzI4ZDkyYmZhZGQ0Nzg1YWJhMTlkMDJiZGI3MQ==
+  data.tar.gz: !binary |-
+    MWM1NTBhNGEwOTBkZTc0ZWMxYzZhYzkwZWRkZTJjOTI4ZGM3NDE1NQ==
+SHA512:
+  metadata.gz: !binary |-
+    MmM2OWVlZDY1MDE3NzhhNjkxOWJjNzAyZTZmMzNmZGE2OTM4NTBhZDY2MWNl
+    YjIzZGQ5MTM1OGI5MTQ1ZGQxMTkyNWQ5NmI1MzY5YjI2N2NjZDNmMDAzNzRi
+    MDQ4MTM3ZTliZDdiNDhjYjI4NGM5NGI1YzhiYjI2MjRlNDUzZTM=
+  data.tar.gz: !binary |-
+    NjQwYzA0MDEzMTk4M2QxZWI1YmVlZTFkM2FhNDdiOGE4YzNmZTc1ZjRiMTcz
+    ZGQxNDk3OTM1ZTYyZWE5Zjk0NzUyNDUyNTlhMDNkZTRlMDk3NjNlYzM3ZWYy
+    ZTk0MTI2NzIxNzExOWY4NjhlODU5MWE2YWU1YTU1NDdjZjcyNWQ=

data/.gitignore

@@ -0,0 +1,2 @@
+.idea
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1 (July 18th, 2014)
+
+Initial version.

data/LICENSE.md

@@ -0,0 +1,25 @@
+Knife Runlist Compare
+----------
+* Author:: Jon Cowie (<jonlives@gmail.com>)
+* Copyright:: Copyright (c) 2014 Jon Cowie
+* License:: MIT
+
+The MIT License
+
+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,67 @@
+Knife Runlist Compare
+===========
+Knife Runlist Compare is is a Knife plugin which allows you, as the name suggests, to compare two Chef run_lists. It takes each run_list it is given, expands them into the list of recipes which would be executed on a node, and produces a diff of the differences between those recipe lists.
+
+[![Gem Version](https://badge.fury.io/rb/knife-runlist-compare.png)](http://badge.fury.io/rb/knife-runlist-compare)
+
+Installation
+------------
+
+### Gem Install
+`knife-runlist-compare` is available on rubygems. Add the following to your `Gemfile`:
+
+```ruby
+gem 'knife-runlist-compare'
+```
+
+or install the gem manually:
+
+```bash
+gem install knife-runlist-compare
+```
+
+### Usage
+```bash
+knife runlist compare RUNLIST_1 RUNLIST_2 (options)
+```
+
+### Supported Options
+
+#### Environment
+The `environment` option allows you to specify the Chef environment to be used in the run_list expansion process (defaults to `production`)
+
+```bash
+-e ENV_NAME
+--environment ENV_NAME
+```
+
+#### Data Source
+The `datasource` option allows you to specify whether to use the Chef Server (`server`) or local disk (`disk`) to load roles and recipes for run_list expansion
+
+```bash
+-d DATA_SOURCE
+--data-source DATA_SOURCE
+```
+
+#### Context Lines
+The `context_lines` option allows you to specify the number of lines of context to be shown around each item in the diff output (defaults to 10000)
+
+```bash
+-U CONTEXT_LINES
+--context-lines CONTEXT_LINES
+```
+
+### Usage Example
+
+```text
+$ knife runlist compare 'role[Base]' 'role[NewBase]' -U 3
+run_list role[Base] expands to the following recipes:
+["foo", "bar::baz"]
+
+run_list role[NewBase] expands to the following recipes:
+["foo"]
+
+The following is the diff of these run_lists:
+ foo
+-bar::baz
+```

data/Rakefile

@@ -0,0 +1,122 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :validate
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/knife-runlist-compare.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'knife-runlist-compare'
+  gem.version       = '0.0.1'
+  gem.authors       = ["Jon Cowie"]
+  gem.email         = 'jonlives@gmail.com'
+  gem.homepage      = 'https://github.com/jonlives/knife-runlist-compare'
+  gem.licenses      = ['MIT']
+  gem.summary       = "A knife plugin to compare two runlists, expand them to lists of recipes and display the diff"
+  gem.description   = "A knife plugin to compare two runlists, expand them to lists of recipes and display the diff"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "knife-runlist-compare"
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'chef', '>= 11.0.0'
+  gem.add_runtime_dependency 'diffy', '~> 3.0.5'
+end

data/lib/chef/knife/runlist-compare.rb

@@ -0,0 +1,66 @@
+## Based on https://gist.github.com/961827 by nstielau
+
+
+require 'chef/knife'
+
+module KnifeRunlistCompare
+  class RunlistCompare < Chef::Knife
+
+    deps do
+      require 'chef/run_list'
+      require 'diffy'
+    end
+
+    banner "knife runlist compare RUN_LIST1 RUN_LIST2 (options)"
+
+    option :environment,
+           :short => "-e ENVIRONMENT",
+           :long => "--environment ENVIRONMENT",
+           :description => "The environemnt to use for run_list expansion",
+           :default => "production"
+
+    option :data_source,
+           :short => "-d DATA_SOURCE",
+           :long => "--data-source DATA_SOURCE",
+           :description => "The data source to use (server/disk)",
+           :default => "server"
+
+    option :context_lines,
+           :short => "-U CONTEXT_LINES",
+           :long => "--context-lines CONTEXT_LINES",
+           :description => "The number of lines of context to give around a diff (default 10000)",
+           :default => 10000
+
+    def run
+
+      if @name_args.length != 2
+        ui.error "You must specify two run_lists to compare"
+        ui.msg opt_parser
+        exit 1
+      end
+
+
+      runlist1 = Chef::RunList.new
+      @name_args.first.split(",").each{|r|runlist1.add(r)}
+
+      runlist2 = Chef::RunList.new
+      @name_args.last.split(",").each{|r|runlist2.add(r)}
+
+      exp_runlist_1 = runlist1.expand(config[:environment],config[:data_source]).recipes
+      exp_runlist_2 = runlist2.expand(config[:environment],config[:data_source]).recipes
+
+      ui.info "run_list #{@name_args.first} expands to the following recipes:"
+      ui.info exp_runlist_1.inspect
+
+      ui.info "\nrun_list #{@name_args.last} expands to the following recipes:"
+      ui.info exp_runlist_2.inspect
+
+      ui.info "\nThe following is the diff of the expanded recipe lists:"
+      Diffy::Diff.default_format = :color
+
+      runlist_diff = Diffy::Diff.new(exp_runlist_1.join("\n"), exp_runlist_2.join("\n"),:diff=>"-U #{config[:context_lines]}")
+      puts runlist_diff
+
+    end
+  end
+end

data/lib/knife-runlist-compare.rb

@@ -0,0 +1,3 @@
+module KnifeRunlistCompare
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: knife-runlist-compare
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Cowie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 11.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 11.0.0
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+description: A knife plugin to compare two runlists, expand them to lists of recipes
+  and display the diff
+email: jonlives@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- Rakefile
+- knife-runlist-compare.gemspec
+- lib/chef/knife/runlist-compare.rb
+- lib/knife-runlist-compare.rb
+homepage: https://github.com/jonlives/knife-runlist-compare
+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.2.1
+signing_key: 
+specification_version: 4
+summary: A knife plugin to compare two runlists, expand them to lists of recipes and
+  display the diff
+test_files: []
+has_rdoc: