knife-changelog 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7bea4f6a0e0d4c2a2904c625fd38a6a19899510
+  data.tar.gz: 1a9133fcbbe9dfcb63df3211a866b2e14460920d
+SHA512:
+  metadata.gz: 221fd8ae1f49fc3c9125ce7752108a42334f9ec4ba9b7b1078f8157408cb435d0b08ad8d2ceb83712cb3298be60ce20df6b5b27d84bc28187eb2293f5c17088c
+  data.tar.gz: 61b5dc799fd99c8c141fb7634b036d606fd9c99455ae10d91589d723530765124bebf1aad67b1ce1c7e7db2cf1179d13924b3fb1de04415c0c3b4b1277fc31e2

data/.gitignore

@@ -0,0 +1 @@
+.bundle/

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+deploy:
+  provider: rubygems
+  api_key:
+    secure: LAM8qxTQa6oxzKiQpWrqRlcE1czmGFj16NSj1FVgZYJLZIfXKdvSpth+DfuCk8mxG1tvDXa3ckfERrzexG3lYGNPGyZH2sjnyt900Evd3Bn8vhv0LXE7cEZb3x/uJ3RHRvKpEDnMsy4gqoVByDLWXWnI9Q/8B4AtzFeTVsTr48g=
+  gem: knife-changelog
+  on:
+    tags: true
+    repo: kamaradclimber/knife-changelog

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,181 @@
+PATH
+  remote: .
+  specs:
+    knife-changelog (0.0.1)
+      berkshelf
+      chef (~> 11.16)
+      mixlib-shellout
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    berkshelf (3.2.1)
+      addressable (~> 2.3.4)
+      berkshelf-api-client (~> 1.2)
+      buff-config (~> 1.0)
+      buff-extensions (~> 1.0)
+      buff-shell_out (~> 0.1)
+      celluloid (~> 0.16.0)
+      celluloid-io (~> 0.16.1)
+      cleanroom (~> 1.0)
+      faraday (~> 0.9.0)
+      minitar (~> 0.5.4)
+      octokit (~> 3.0)
+      retryable (~> 1.3.3)
+      ridley (~> 4.0)
+      solve (~> 1.1)
+      thor (~> 0.19)
+    berkshelf-api-client (1.2.0)
+      faraday (~> 0.9.0)
+    buff-config (1.0.1)
+      buff-extensions (~> 1.0)
+      varia_model (~> 0.4)
+    buff-extensions (1.0.0)
+    buff-ignore (1.1.1)
+    buff-ruby_engine (0.1.0)
+    buff-shell_out (0.2.0)
+      buff-ruby_engine (~> 0.1.0)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    celluloid-io (0.16.1)
+      celluloid (>= 0.16.0)
+      nio4r (>= 1.0.0)
+    chef (11.16.4)
+      chef-zero (~> 2.1, >= 2.1.4)
+      diff-lcs (~> 1.2, >= 1.2.4)
+      erubis (~> 2.7)
+      ffi-yajl (~> 1.0)
+      highline (~> 1.6, >= 1.6.9)
+      mime-types (~> 1.16)
+      mixlib-authentication (~> 1.3)
+      mixlib-cli (~> 1.4)
+      mixlib-config (~> 2.0)
+      mixlib-log (~> 1.3)
+      mixlib-shellout (~> 1.4)
+      net-ssh (~> 2.6)
+      net-ssh-multi (~> 1.1)
+      ohai (~> 7.4)
+      plist (~> 3.1.0)
+      pry (~> 0.9)
+      rest-client (>= 1.0.4, <= 1.6.7)
+    chef-zero (2.2.1)
+      ffi-yajl (~> 1.1)
+      hashie (~> 2.0)
+      mixlib-log (~> 1.3)
+      rack
+    cleanroom (1.0.0)
+    coderay (1.1.0)
+    dep-selector-libgecode (1.0.2)
+    dep_selector (1.0.3)
+      dep-selector-libgecode (~> 1.0)
+      ffi (~> 1.9)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.6)
+    ffi-yajl (1.3.1)
+      ffi (~> 1.5)
+      libyajl2 (~> 1.2)
+    hashie (2.1.2)
+    highline (1.6.21)
+    hitimes (1.2.2)
+    ipaddress (0.8.0)
+    json (1.8.1)
+    libyajl2 (1.2.0)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    minitar (0.5.4)
+    mixlib-authentication (1.3.0)
+      mixlib-log
+    mixlib-cli (1.5.0)
+    mixlib-config (2.1.0)
+    mixlib-log (1.6.0)
+    mixlib-shellout (1.6.1)
+    multipart-post (2.0.0)
+    net-http-persistent (2.9.4)
+    net-ssh (2.9.1)
+    net-ssh-gateway (1.2.0)
+      net-ssh (>= 2.6.5)
+    net-ssh-multi (1.2.0)
+      net-ssh (>= 2.6.5)
+      net-ssh-gateway (>= 1.2.0)
+    nio4r (1.0.1)
+    octokit (3.7.0)
+      sawyer (~> 0.6.0, >= 0.5.3)
+    ohai (7.4.0)
+      ffi (~> 1.9)
+      ffi-yajl (~> 1.0)
+      ipaddress
+      mime-types (~> 1.16)
+      mixlib-cli
+      mixlib-config (~> 2.0)
+      mixlib-log
+      mixlib-shellout (~> 1.2)
+      systemu (~> 2.6.4)
+      wmi-lite (~> 1.0)
+    plist (3.1.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.4.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    retryable (1.3.6)
+    ridley (4.1.1)
+      addressable
+      buff-config (~> 1.0)
+      buff-extensions (~> 1.0)
+      buff-ignore (~> 1.1)
+      buff-shell_out (~> 0.1)
+      celluloid (~> 0.16.0)
+      celluloid-io (~> 0.16.1)
+      erubis
+      faraday (~> 0.9.0)
+      hashie (>= 2.0.2, < 3.0.0)
+      json (>= 1.7.7)
+      mixlib-authentication (>= 1.3.0)
+      net-http-persistent (>= 2.8)
+      retryable
+      semverse (~> 1.1)
+      varia_model (~> 0.4)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    sawyer (0.6.0)
+      addressable (~> 2.3.5)
+      faraday (~> 0.8, < 0.10)
+    semverse (1.2.1)
+    slop (3.6.0)
+    solve (1.2.1)
+      dep_selector (~> 1.0)
+      semverse (~> 1.1)
+    systemu (2.6.4)
+    thor (0.19.1)
+    timers (4.0.1)
+      hitimes
+    varia_model (0.4.0)
+      buff-extensions (~> 1.0)
+      hashie (>= 2.0.2, < 3.0.0)
+    wmi-lite (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  knife-changelog!
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gregoire Seux
+
+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,21 @@
+# Knife::Changelog
+
+knife-changelog aims to make find cookbook changelogs easily to help upgrades.
+
+Using it will create changelogs from your current version to most up-to-date version.
+
+Usage : `knife changelog COOKBOOK [COKKBOOK...]`
+
+Options: 
+- `--linkify` or `-l` outputs markdown with links to commits
+- `--ignore-changelog-file` allow to force the usage of raw git history instead of Changelog file
+
+## Features
+
+- generate changelogs for some supermarket hosted cookbooks
+- generate changelogs for all git located cookbooks
+
+## Todos
+
+- (optionaly) link commit ref to their web page to ease reviews
+- support more cookbook sources

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end

data/knife-changelog.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knife/changelog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "knife-changelog"
+  spec.version       = Knife::Changelog::VERSION
+  spec.version       = "#{spec.version}-alpha-#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS']
+  spec.authors       = ["Gregoire Seux"]
+  spec.email         = ["kamaradclimber@gmail.com"]
+  spec.summary       = %q{Facilitate access to cookbooks changelog}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+
+  spec.add_dependency  'berkshelf'
+  spec.add_dependency  'mixlib-shellout'
+  spec.add_dependency  'chef',  '~> 11.16'
+end

data/lib/chef/knife/changelog.rb

@@ -0,0 +1,164 @@
+require "knife/changelog/version"
+require "berkshelf"
+require 'chef/knife'
+require 'mixlib/shellout'
+
+class Chef
+  class Knife
+    class Changelog < Knife
+
+      banner 'knife changelog COOKBOOK [COOKBOOK ...]'
+
+      def initialize(options)
+        super
+        @tmp_prefix = 'knife-changelog'
+        @berksfile = Berkshelf::Berksfile.from_options({})
+        @tmp_dirs = []
+      end
+
+      option :linkify,
+        :short => '-l',
+        :long  => '--linkify',
+        :description => 'add markdown links where relevant',
+        :boolean => true
+
+      option :ignore_changelog_file,
+        :long => '--ignore-changelog-file',
+        :description => "Ignore changelog file presence, use git history instead",
+        :boolean => true
+
+      def run
+        begin
+          if @name_args.empty?
+            cks = @berksfile.cookbooks.collect {|c| c.name }
+          else
+            cks = @name_args
+          end
+          cks.each do |cookbook|
+            execute cookbook
+          end
+        ensure
+          clean
+        end
+      end
+
+      def clean
+        @tmp_dirs.each do |dir|
+          FileUtils.rm_r dir
+        end
+      end
+
+      def ck_dep(name)
+        @berksfile.lockfile.find(name)
+      end
+
+      def ck_location(name)
+       ck_dep(name).location
+      end
+
+      def version_for(name)
+        # FIXME uses public methods instead
+        @berksfile.lockfile.graph.instance_variable_get(:@graph)[name].version
+      end
+
+      def execute(name)
+        loc = ck_location(name)
+        changelog = case loc
+                    when NilClass
+                      handle_source name, ck_dep(name)
+                    when Berkshelf::GitLocation
+                      handle_git loc
+                    else
+                      raise "Cannot handle #{loc.class} yet"
+                    end
+        print_changelog(name, changelog)
+      end
+
+      def print_changelog(name, changelog)
+        unless changelog.empty?
+          puts "--- Changelog for #{name} ---"
+          puts changelog
+          puts "-----------------"
+        end
+      end
+
+      def handle_source(name, dep)
+        ck = noauth_rest.get_rest("https://supermarket.getchef.com/api/v1/cookbooks/#{name}")
+        url = ck['source_url'] || ck ['external_url']
+        case url
+        when nil
+          fail "No external url for #{name}, can't find any changelog source"
+        when /github.com\/(.*)(.git)?/
+          options = {
+            :github => $1,
+            :revision => 'v' + version_for(name), 
+          }
+          location = Berkshelf::GithubLocation.new dep, options
+          handle_git(location)
+        else
+          fail "External url #{url} points to unusable location!"
+        end
+      end
+
+      def handle_git(location)
+        tmp_dir = shallow_clone(@tmp_prefix,location.uri)
+
+        rev_parse = location.instance_variable_get(:@rev_parse)
+        cur_rev = location.revision.rstrip
+        ls_tree = Mixlib::ShellOut.new("git ls-tree -r #{rev_parse}", :cwd => tmp_dir)
+        ls_tree.run_command
+        changelog = ls_tree.stdout.lines.find { |line| line =~ /\s(changelog.*$)/i }
+        if changelog and not config[:ignore_changelog_file]
+          puts "Found changelog file : " + $1
+          generate_from_changelog_file($1, cur_rev, rev_parse, tmp_dir)
+        else
+          generate_from_git_history(tmp_dir, location, cur_rev, rev_parse)
+        end
+      end
+
+      def generate_from_changelog_file(filename, current_rev, rev_parse, tmp_dir)
+        diff = Mixlib::ShellOut.new("git diff #{current_rev}..#{rev_parse} -- #{filename}", :cwd => tmp_dir)
+        diff.run_command
+        diff.stdout.lines.collect {|line| $1 if line =~ /^\+([^+].*)/}.compact
+      end
+
+      def generate_from_git_history(tmp_dir, location, current_rev, rev_parse)
+        log = Mixlib::ShellOut.new("git log --no-merges --abbrev-commit --pretty=oneline #{current_rev}..#{rev_parse}", :cwd => tmp_dir)
+        log.run_command
+        c = log.stdout
+        n = https_url(location)
+        c = linkify(n, c) if config[:linkify] and n
+        c
+      end
+
+      def linkify(url, changelog)
+        changelog = changelog.lines.map { |line|
+          line.gsub(/^([a-f0-9]+) /, '[%s/commit/\1](\1) ' % [url])
+        }
+      end
+
+      def https_url(location)
+        if location.uri =~ /^\w+:\/\/(.*@)?(.*)(\.git?)/
+          "https://%s" % [ $2 ]
+        else
+          fail "Cannot guess http url from git remote url"
+        end
+      end
+
+      def short(location)
+        if location.uri =~ /([\w-]+)\/([\w-]+)(\.git)?$/
+          "%s/%s" % [$1,$2]
+        end
+      end
+
+      def shallow_clone(tmp_prefix, uri)
+        dir = Dir.mktmpdir(tmp_prefix)
+        @tmp_dirs << dir
+        clone = Mixlib::ShellOut.new("git clone --bare #{uri} bare-clone", :cwd => dir)
+        clone.run_command
+        ::File.join(dir, 'bare-clone')
+      end
+
+    end
+  end
+end

data/lib/knife/changelog/version.rb

@@ -0,0 +1,5 @@
+module Knife
+  module Changelog
+    VERSION = "0.0.1"
+  end
+end

data/resources/Berksfile

@@ -0,0 +1,4 @@
+source "https://supermarket.chef.io"
+
+cookbook 'ohai'
+cookbook 'ulimit', :github => 'bmhatfield/chef-ulimit'

data/resources/Berksfile.lock

@@ -0,0 +1,9 @@
+DEPENDENCIES
+  ohai
+  ulimit
+    git: git://github.com/bmhatfield/chef-ulimit.git
+    revision: c8bb9a486b9bfb7d91e51141e6352ea3703a1819 
+
+GRAPH
+  ohai (1.1.10)
+  ulimit (0.1.4)

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: knife-changelog
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gregoire Seux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: berkshelf
+  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: mixlib-shellout
+  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: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.16'
+description: ''
+email:
+- kamaradclimber@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- knife-changelog.gemspec
+- lib/chef/knife/changelog.rb
+- lib/knife/changelog/version.rb
+- resources/Berksfile
+- resources/Berksfile.lock
+homepage: ''
+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.2
+signing_key: 
+specification_version: 4
+summary: Facilitate access to cookbooks changelog
+test_files: []