r10kdiff 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0deb8c2c9bdcc5b28d0cf420f7f5c04bd2212acb
+  data.tar.gz: 8d728630df39ef6ca6aab098672d51a1ab58ec08
+SHA512:
+  metadata.gz: f9434954c64aa497c4a5fcfa31af68b7c816c30f7c5ad8f6412936e566508f7811294031c72af40cd0e2201d70dba464df93bd60d0f3c2f7cf0da46e5b2f94de
+  data.tar.gz: 0b2efcade52590742f3e6e64e08c6de712391314867717cf1569989a23629e1b30fa5d8e717c74cdb73aeff16019bb118671a56ed8519a7e9ac0b0239f14e50c

data/bin/r10kdiff

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby -w
+
+require 'r10kdiff'
+R10kDiff::Commandline.run

data/lib/r10kdiff.rb

@@ -0,0 +1,192 @@
+require 'optparse'
+require 'set'
+
+module R10kDiff
+  class PuppetfileDSL
+    def initialize(puppetfile_text)
+      @forge = 'forge.puppetlabs.com'
+      @modules = {}
+      eval(puppetfile_text)
+    end
+    attr_reader :modules
+
+    def forge(name)
+      @forge = name
+    end
+
+    def mod(name, args={})
+      args = {:ref => args} if args.is_a? String
+      args[:ref] = "master" unless args[:ref]
+      args[:forge] = "https://#{@forge}/#{name}"
+      @modules[name] = PuppetModule.new name, args
+    end
+  end
+
+  class PuppetModule
+    def initialize(name, ref:nil, git:nil, forge:nil)
+      @name = name
+      @ref = ref
+      @git = git
+      @forge = forge
+    end
+    attr_reader :name, :ref
+
+    def git?
+      !!@git
+    end
+
+    def different?(other_module)
+      # Note that forge & git r10k modules have different naming convention so
+      # we don't need to compare url (forge is user/modulename and git is just
+      # modulename with :git attr as the url of the module
+      @ref != other_module.ref
+    end
+
+    def pretty_version_diff(other_module, include_url)
+      basic_compare = "#{ref} -> #{other_module.ref}"
+
+      # special case for github - generate compate url
+      if git? && other_module.git? && include_url
+        return "#{name} #{git_https}/compare/#{ref}...#{other_module.ref}"
+
+      elsif include_url
+        return "#{name} #{basic_compare} (#{web_url})"
+      else
+        return "#{name} #{basic_compare}"
+      end
+    end
+
+    def pretty_version(include_url)
+      basic_string = "#{name} at #{ref}"
+      if include_url
+        return "#{basic_string} (#{web_url})"
+      else
+        return basic_string
+      end
+
+    end
+
+    def git_https
+      if @git.start_with? "https://"
+        return @git
+      elsif @git.start_with? "git://"
+        return @git.gsub(/^git:/, "https:")
+      elsif @git.start_with? "git@"
+        return @git.gsub(":", "/").gsub(/^git@/, "https://").gsub(/.git$/, "")
+      end
+    end
+
+    def web_url
+      return git? ? git_https : @forge
+    end
+  end
+
+  class PuppetfileDiff
+    # Represents the difference between the puppetfile from one commit to another
+    def initialize(oldfile, newfile)
+      @oldfile = oldfile
+      @newfile = newfile
+    end
+
+    def changes
+      changed_modules = []
+      modules_in_common = Set.new(@oldfile.modules.keys).intersection Set.new(@newfile.modules.keys)
+      modules_in_common.each do |name|
+        new_module = @newfile.modules[name]
+        old_module = @oldfile.modules[name]
+        changed_modules << [old_module, new_module] if new_module.different? old_module
+      end
+      changed_modules
+    end
+
+    def additions
+      additions = []
+      @newfile.modules.each do |name, new_module|
+        additions << new_module unless @oldfile.modules[name]
+      end
+      additions
+    end
+
+    def removals
+      removals = []
+      @oldfile.modules.each do |name, old_module|
+        removals << old_module unless @newfile.modules[name]
+      end
+      removals
+    end
+
+    def print_differences(include_url)
+      # Print the additions, removals, and changes
+      output = []
+      puppetfile_changes = false
+      if removals.length > 0
+        puppetfile_changes = true
+        output << "Remove:"
+      end
+      removals.each do |old|
+        output << "    #{old.pretty_version(include_url)}"
+      end
+
+      if additions.length > 0
+        puppetfile_changes = true
+        output << "Add:"
+      end
+      additions.each do |new|
+        output << "    #{new.pretty_version(include_url)}"
+      end
+
+      if changes.length > 0
+        puppetfile_changes = true
+        output << "Change:"
+      end
+      changes.each do |old, new|
+        output << "    #{new.pretty_version_diff(old, include_url)}"
+      end
+
+      if !puppetfile_changes
+        output << "No changes in Puppetfile"
+      end
+
+      output.each { |x| puts x }
+    end
+  end
+
+  class Commandline
+    def self.run
+      include_urls = false
+      opt_parser = OptionParser.new do |opt|
+
+      opt.banner = <<-EOF
+Usage: r10kdiff [previous-ref] [current-ref]
+
+Run from a git repository containing a Puppetfile.
+
+    previous-ref and current-ref are the git refs to compare
+        (optional, default to origin/BRANCH and BRANCH
+         where BRANCH is the currently checked-out git branch name)
+
+EOF
+        opt.on("-h", "--help", "show help dialogue") do
+          puts opt_parser
+          exit
+        end
+        opt.on("-u", "--urls", "Include urls and github compare links in output") do
+          include_urls = true
+        end
+      end
+      opt_parser.parse!
+
+      if ARGV.length >= 2
+        oldref = ARGV[0]
+        newref = ARGV[1]
+      else  # default to checked-out branch & its corresponding branch on origin
+        branch_name = File.basename `git symbolic-ref HEAD`.chomp
+        oldref = "origin/#{branch_name}"
+        newref = branch_name
+      end
+      oldfile_raw = PuppetfileDSL.new(`git show #{oldref}:Puppetfile`)
+      newfile_raw = PuppetfileDSL.new(`git --no-pager show #{newref}:Puppetfile`)
+      PuppetfileDiff.new(oldfile_raw, newfile_raw).print_differences(include_urls)
+    end
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: r10kdiff
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Danny Cosson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-15 00:00:00.000000000 Z
+dependencies: []
+description: A small script for comparing r10k Puppetfiles between different git refs.
+  It's helpful for a development workflow with puppet r10k and Github as the output
+  is slightly nicer than 'git diff' and it can generate github compare links for the
+  full changesets represented by a change to a Puppetfile.
+email: cosson@venmo.com
+executables:
+- r10kdiff
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/r10kdiff.rb
+- bin/r10kdiff
+homepage: https://github.com/dcosson/r10kdiff
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Compare r10k Puppetfiles
+test_files: []