knife-changelog 0.5.20 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f5cdeee5d1cffb63b524ec79a1bdcfcfb154a74
-  data.tar.gz: e68caccf393dab3d26ce0324b84cc7394fb38744
+  metadata.gz: 705a36f063f6249e387aa5d52cd1784cb38f1ac9
+  data.tar.gz: 521f2a3658ca50040b0f119437fb38d37111fefa
 SHA512:
-  metadata.gz: 0b79c827c13afa739ebfd008527155a93abf70aef63767802a8ce2ed391432e8127b4f8e2dbb096401757d671eba38d707c13f49fa7b5565781a33156668ff86
-  data.tar.gz: aae9c4b834f21b0d7879c225664aae9203348457456d34fa5f000a7e2aa54225c151d9670b7961297b01d22898e51f323413f63c2511bf5a009c25e36070e08a
+  metadata.gz: 6f32a1750c57c95b8dc9144c4783d95d0d6281bcd76bd2e0e77def896d0b6eaca27d88b4b0f2a5e1eb4dd4aa7ddd856f90f06a2a303b95944cb5c090f6c30898
+  data.tar.gz: 87ad561196aa635e2508eb0871f235d216fd66e5141bb12a10d334c4b72e807e349a68c88e48c24bdff0c519e4fa3d86d579792901b5ecf8c271aa2c53471056

data/.gitignore

@@ -1,2 +1,2 @@
 .bundle/
-*lock
+Gemfile.lock*

data/.rubocop.yml

@@ -1,5 +1,33 @@
-AllCops:
-  TargetRubyVersion: 2.1
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/ClassLength:
+  Max: 200
 
 Metrics/LineLength:
-  Max: 150
+  Max: 230
+
+Metrics/MethodLength:
+  Max: 30
+
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, ruby19_no_mixed_keys, hash_rockets
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 52
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Metrics/CyclomaticComplexity:
+  Max: 25
+
+AllCops:
+  Exclude:
+  - bundle/**/*
+  TargetRubyVersion: 2.3

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.2.2
+  - 2.4
 deploy:
   provider: rubygems
   api_key:
@@ -8,5 +8,5 @@ deploy:
   gem: knife-changelog
   on:
     tags: true
-    repo: kamaradclimber/knife-changelog
+    repo: criteo/knife-changelog
 sudo: false # use docker based infra

data/README.md

@@ -15,6 +15,8 @@ Options:
 - generate changelogs for some supermarket hosted cookbooks
 - generate changelogs for all git located cookbooks
 
+This plugin works in policyfile style repositories or classical repositories with a Berksfile
+
 ## Todos
 
 - (optionaly) link commit ref to their web page to ease reviews

data/knife-changelog.gemspec

@@ -22,10 +22,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
 
 
   spec.add_dependency  'berkshelf'
   spec.add_dependency  'rest-client'
   spec.add_dependency  'mixlib-shellout'
   spec.add_dependency  'chef'
+  spec.add_dependency  'chef-dk'
 end

data/lib/chef/knife/changelog.rb

@@ -10,13 +10,19 @@ class Chef
       deps do
         require "knife/changelog/version"
         require "knife/changelog/changelog"
+        require "knife/changelog/policyfile"
+        require "knife/changelog/berksfile"
         require "berkshelf"
       end
 
       def initialize(options)
         super
-        berksfile = Berkshelf::Berksfile.from_options({})
-        @changelog = KnifeChangelog::Changelog.new(berksfile.lockfile.locks, config, berksfile.sources)
+        @changelog = if File.exists?(config[:policyfile])
+                       KnifeChangelog::Changelog::Policyfile.new(config[:policyfile], config)
+                     else
+                       berksfile = Berkshelf::Berksfile.from_options({})
+                       KnifeChangelog::Changelog::Berksfile.new(berksfile.lockfile.locks, config, berksfile.sources)
+                     end
       end
 
       option :linkify,
@@ -46,6 +52,11 @@ class Chef
         :long => '--submodules SUBMODULE[,SUBMODULE]',
         :description => 'Submoduless to check for changes as well (comma separated)'
 
+      option :policyfile,
+        :long => '--policyfile PATH',
+        :description => 'Link to policyfile, defaults to Policyfile.rb',
+        :default => 'Policyfile.rb'
+
 
       def run
         Log.info config

data/lib/knife/changelog/berksfile.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative 'changelog'
+
+class KnifeChangelog
+  class Changelog
+    class Berksfile < Changelog
+      def initialize(locked_versions, config, sources)
+        require 'berkshelf'
+        @locked_versions = locked_versions
+        @sources = sources
+        super(config)
+      end
+
+      def all_cookbooks
+        @locked_versions.keys
+      end
+
+      def new_cookbook?(name)
+        ck_dep(name).nil?
+      end
+
+      # return true if cookbook is downloaded from supermarket
+      def supermarket?(name)
+        # here is berkshelf "expressive" way to say cookbook
+        # comes from supermarket
+        ck_dep(name).location.is_a?(NilClass)
+      end
+
+      # return true if cookbook is downloaded from git
+      def git?(name)
+        ck_dep(name).location.is_a?(Berkshelf::GitLocation)
+      end
+
+      # return true if cookbook is downloaded from local path
+      def local?(name)
+        ck_dep(name).location.is_a?(Berkshelf::PathLocation)
+      end
+
+      # return a Changelog::Location for this cookbook
+      def git_location(name)
+        raise "#{name} has not a git location" unless git?(name)
+        Location.from_berk_git_location(ck_dep(name).location)
+      end
+
+      # return a list of supermarket uri for a given cookbook
+      # example: [ 'https://supermarket.chef.io' ]
+      def supermarkets_for(_name)
+        @sources.map(&:uri)
+      end
+
+      def guess_version_for(name)
+        @locked_versions[name].locked_version.to_s
+      end
+
+      private
+
+      def ck_dep(name)
+        @locked_versions[name]
+      end
+    end
+  end
+end

data/lib/knife/changelog/changelog.rb

@@ -1,28 +1,77 @@
 # coding: utf-8
 require 'chef/log'
 require 'chef/knife'
+require 'chef/version_class'
 require 'rest-client'
 require 'json'
+require_relative 'git'
 
 class KnifeChangelog
   class Changelog
-    def initialize(locked_versions, config = {}, sources=[])
-      require 'berkshelf'
+
+    Location = Struct.new(:uri, :revision, :rev_parse) do
+      # todo move this method to Changelog::Berkshelf
+      def self.from_berk_git_location(location)
+        Location.new(location.uri,
+                     location.revision.strip,
+                     location.instance_variable_get(:@rev_parse))
+      end
+    end
+
+    def initialize(config)
       @tmp_prefix = 'knife-changelog'
-      @locked_versions = locked_versions
       @config   = config
       @tmp_dirs = []
-      @sources = sources
-      if sources.empty? # preserve api compat
-        @sources = [ Berkshelf::Source.new("https://supermarket.chef.io") ]
-      end
     end
 
+    # returns a list of all cookbooks names
+    def all_cookbooks
+      raise NotImplementedError
+    end
+
+    # return true if cookbook is not already listed as dependency
+    def new_cookbook?(name)
+      raise NotImplementedError
+    end
+
+    # return true if cookbook is downloaded from supermarket
+    def supermarket?(name)
+      raise NotImplementedError
+    end
+
+    # return true if cookbook is downloaded from git
+    def git?(name)
+      raise NotImplementedError
+    end
+
+    # return true if cookbook is downloaded from local path
+    def local?(name)
+      raise NotImplementedError
+    end
+
+    # return a Changelog::Location for a given cookbook
+    def git_location(name)
+      raise NotImplementedError
+    end
+
+    # return a list of supermarket uri for a given cookbook
+    # example: [ 'https://supermarket.chef.io' ]
+    def supermarkets_for(name)
+      raise NotImplementedError
+    end
+
+    # return current locked version for a given cookbook
+    def guess_version_for(name)
+      raise NotImplementedError
+    end
+
+
+
     def run(cookbooks)
       changelog = []
       begin
         if cookbooks.empty? and @config[:allow_update_all]
-          cks = @locked_versions.keys
+          cks = all_cookbooks
         else
           cks = cookbooks
         end
@@ -44,47 +93,29 @@ class KnifeChangelog
 
     def clean
       @tmp_dirs.each do |dir|
-        FileUtils.rm_r dir
+        FileUtils.rm_rf dir
       end
     end
 
-    def ck_dep(name)
-      @locked_versions[name]
-    end
-
-    def ck_location(name)
-      begin
-        ck_dep(name).location
-      rescue
-        puts "Failed to get location for cookbook: #{name}"
-        raise
-      end
-    end
-
-    def guess_version_for(name)
-      @locked_versions[name].locked_version.to_s
-    end
-
-    def handle_new_cookbook(name)
+    def handle_new_cookbook
       stars = '**' if @config[:markdown]
       ["#{stars}Cookbook was not in the berksfile#{stars}"]
     end
 
-    def execute(name, submodule=false)
+    def execute(name, submodule = false)
       version_change, changelog = if submodule
                                     handle_submodule(name)
-                                  elsif ck_dep(name).nil?
-                                    ["", handle_new_cookbook(name)]
+                                  elsif new_cookbook?(name)
+                                    ['', handle_new_cookbook]
                                   else
-                                    loc = ck_location(name)
-                                    case loc
-                                    when NilClass
-                                      handle_source name, ck_dep(name)
-                                    when Berkshelf::GitLocation
-                                      handle_git name, loc
-                                    when Berkshelf::PathLocation
+                                    case true
+                                    when supermarket?(name)
+                                      handle_source(name)
+                                    when git?(name)
+                                      handle_git(name, git_location(name))
+                                    when local?(name)
                                       Chef::Log.debug "path location are always at the last version"
-                                      ["", ""]
+                                      ['', '']
                                     else
                                       raise "Cannot handle #{loc.class} yet"
                                     end
@@ -105,12 +136,14 @@ class KnifeChangelog
     end
 
     def get_from_supermarket_sources(name)
-      @sources.map do |s|
+      supermarkets_for(name).map do |uri|
         begin
+          # TODO: we could call /universe endpoint once
+          # instead of calling /api/v1/cookbooks/ for each cookbook
           RestClient::Request.execute(
-            url: "#{s.uri}/api/v1/cookbooks/#{name}",
+            url: "#{uri}/api/v1/cookbooks/#{name}",
             method: :get,
-            verify_ssl: false # TODO make this configurable
+            verify_ssl: false # TODO make this configurable
           )
         rescue => e
           Chef::Log.debug "Error fetching package from supermarket #{e.class.name} #{e.message}"
@@ -134,35 +167,24 @@ class KnifeChangelog
         .last
     end
 
-    def handle_source(name, dep)
+    def handle_source(name)
       url = get_from_supermarket_sources(name)
       raise "No source found in supermarket for cookbook '#{name}'" unless url
       Chef::Log.debug("Using #{url} as source url")
       case url.strip
       when /(gitlab.*|github).com\/([^.]+)(.git)?/
         url = "https://#{$1}.com/#{$2.chomp('/')}.git"
-        options = {
-          :git => url,
-          :revision => guess_version_for(name),
-        }
-        location = Berkshelf::GitLocation.new dep, options
+        location = Location.new(url, guess_version_for(name), 'master')
         handle_git(name, location)
       else
         fail "External url #{url} points to unusable location! (cookbook: #{name})"
       end
     end
 
-    def revision_exists?(dir, revision)
-      Chef::Log.debug "Testing existence of #{revision}"
-      revlist = Mixlib::ShellOut.new("git rev-list --quiet #{revision}", :cwd => dir)
-      revlist.run_command
-      not revlist.error?
-    end
-
-    def detect_cur_revision(name, dir, rev)
-      unless revision_exists?(dir, rev)
+    def detect_cur_revision(name, rev, git)
+      unless git.revision_exists?(rev)
         prefixed_rev = 'v' + rev
-        return prefixed_rev if revision_exists?(dir, prefixed_rev)
+        return prefixed_rev if git.revision_exists?(prefixed_rev)
         fail "#{rev} is not an existing revision (#{name}), not a tag/commit/branch name."
       end
       rev
@@ -178,43 +200,38 @@ class KnifeChangelog
       subm_revision.error!
       revision = subm_revision.stdout.strip.split(' ').first
       revision.gsub!(/^\+/, '')
-      loc = Berkshelf::Location.init(nil, {git: url,revision: revision})
+      loc = Location.new(url, revision, 'master')
       handle_git(name, loc)
     end
 
+    # take cookbook name and Changelog::Location instance
     def handle_git(name, location)
-      tmp_dir = shallow_clone(@tmp_prefix,location.uri)
+      # todo: remove this compat check
+      raise "should be a location" unless location.is_a?(Changelog::Location)
+      git = Git.new(@tmp_prefix, location.uri)
+      @tmp_dirs << git.shallow_clone
 
-      rev_parse = location.instance_variable_get(:@rev_parse)
-      cur_rev = location.revision.rstrip
-      cur_rev = detect_cur_revision(name, tmp_dir, cur_rev)
-      ls_tree = Mixlib::ShellOut.new("git ls-tree -r #{rev_parse}", :cwd => tmp_dir)
-      ls_tree.run_command
-      changelog_file = ls_tree.stdout.lines.find { |line| line =~ /\s(changelog.*$)/i }
+      rev_parse = location.rev_parse
+      cur_rev = detect_cur_revision(name, location.revision, git)
+      changelog_file = git.files(rev_parse).find { |line| line =~ /\s(changelog.*$)/i }
       changelog = if changelog_file and !@config[:ignore_changelog_file]
                     Chef::Log.info "Found changelog file : " + $1
-                    generate_from_changelog_file($1, cur_rev, rev_parse, tmp_dir)
+                    generate_from_changelog_file($1, cur_rev, rev_parse, git)
                   end
-      changelog ||= generate_from_git_history(tmp_dir, location, cur_rev, rev_parse)
-      [ "#{cur_rev}->#{rev_parse}", changelog ]
+      changelog ||= generate_from_git_history(git, location, cur_rev, rev_parse)
+      ["#{cur_rev}->#{rev_parse}", changelog]
     end
 
-    def generate_from_changelog_file(filename, current_rev, rev_parse, tmp_dir)
-      diff = Mixlib::ShellOut.new("git diff #{current_rev}..#{rev_parse} --word-diff -- #{filename}", :cwd => tmp_dir)
-      diff.run_command
-      ch = diff.
-        stdout.
-        lines.
-        collect {|line| $1.strip if line =~ /^{\+(.*)\+}$/}.compact.
-        map { |line| line.gsub(/^#+(.*)$/, "\\1\n---")}. # replace section by smaller header
-        select { |line| !(line =~ /^===+/)}.compact # remove header lines
+    def generate_from_changelog_file(filename, current_rev, rev_parse, git)
+      ch = git.diff(filename, current_rev, rev_parse)
+              .collect { |line| $1.strip if line =~ /^{\+(.*)\+}$/ }.compact
+              .map { |line| line.gsub(/^#+(.*)$/, "\\1\n---")} # replace section by smaller header
+              .select { |line| !(line =~ /^===+/)}.compact # remove header lines
       ch.empty? ? nil : ch
     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.lines
+    def generate_from_git_history(git, location, current_rev, rev_parse)
+      c = git.log(current_rev, rev_parse)
       n = https_url(location)
       c = linkify(n, c) if @config[:linkify] and n
       c = c.map { |line| "* " + line } if @config[:markdown]
@@ -241,16 +258,5 @@ class KnifeChangelog
         "%s/%s" % [$1,$2]
       end
     end
-
-    def shallow_clone(tmp_prefix, uri)
-      Chef::Log.debug "Cloning #{uri} in #{tmp_prefix}"
-      dir = Dir.mktmpdir(tmp_prefix)
-      @tmp_dirs << dir
-      clone = Mixlib::ShellOut.new("git clone --bare #{uri} bare-clone", :cwd => dir)
-      clone.run_command
-      clone.error!
-      ::File.join(dir, 'bare-clone')
-    end
-
   end
 end

data/lib/knife/changelog/git.rb

@@ -0,0 +1,46 @@
+class KnifeChangelog
+  class Git
+    attr_accessor :tmp_prefix, :uri
+
+    def initialize(tmp_prefix, uri)
+      @tmp_prefix = tmp_prefix
+      @uri = uri
+    end
+
+    def shallow_clone
+      Chef::Log.debug "Cloning #{uri} in #{tmp_prefix}"
+      dir = Dir.mktmpdir(tmp_prefix)
+      clone = Mixlib::ShellOut.new("git clone --bare #{uri} bare-clone", cwd: dir)
+      clone.run_command
+      clone.error!
+      @clone_dir = ::File.join(dir, 'bare-clone')
+      @clone_dir
+    end
+
+    def files(rev_parse)
+      ls_tree = Mixlib::ShellOut.new("git ls-tree -r #{rev_parse}", cwd: @clone_dir)
+      ls_tree.run_command
+      ls_tree.error!
+      ls_tree.stdout.lines.map(&:strip)
+    end
+
+    def diff(filename, current_rev, rev_parse)
+      diff = Mixlib::ShellOut.new("git diff #{current_rev}..#{rev_parse} --word-diff -- #{filename}", cwd: @clone_dir)
+      diff.run_command
+      diff.stdout.lines
+    end
+
+    def log(current_rev, rev_parse)
+      log = Mixlib::ShellOut.new("git log --no-merges --abbrev-commit --pretty=oneline #{current_rev}..#{rev_parse}", cwd: @clone_dir)
+      log.run_command
+      log.stdout.lines
+    end
+
+    def revision_exists?(revision)
+      Chef::Log.debug "Testing existence of #{revision}"
+      revlist = Mixlib::ShellOut.new("git rev-list --quiet #{revision}", cwd: @clone_dir)
+      revlist.run_command
+      !revlist.error?
+    end
+  end
+end

data/lib/knife/changelog/policyfile.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative 'changelog'
+
+class KnifeChangelog
+  class Changelog
+    class Policyfile < Changelog
+      attr_reader :policy, :lock
+
+      def initialize(policyfile_path, config)
+        require 'chef-dk'
+        require 'chef-dk/policyfile_compiler'
+        lock_path = policyfile_path.gsub(/.rb$/, '.lock.json')
+        @policy = ChefDK::PolicyfileCompiler.evaluate(File.read(policyfile_path), policyfile_path)
+        @lock = ChefDK::PolicyfileLock.new(policy.storage_config).build_from_lock_data(JSON.parse(File.read(lock_path)))
+        super(config)
+      end
+
+      def all_cookbooks
+        policy.all_possible_dep_names
+      end
+
+      # return true if cookbook is not already listed as dependency
+      def new_cookbook?(name)
+        policy.send(:best_source_for, name).nil?
+      end
+
+      # return true if cookbook is downloaded from supermarket
+      def supermarket?(name)
+        # it's hard to get location_specs for supermarket cookbooks without having policy_compiler starting to download all cookbooks
+        # in the meantime, we procede by elimination
+        !(git?(name) || local?(name))
+      end
+
+      def guess_version_for(name)
+        lock.solution_dependencies.cookbook_dependencies.keys.find { |dep| dep.name == name }.version
+      end
+
+      # return true if cookbook is downloaded from git
+      def git?(name)
+        # cookbook_location_specs contains only cookbooks refered via git and path
+        policy.cookbook_location_specs[name] && policy.cookbook_location_specs[name].source_type == :git
+      end
+
+      # return true if cookbook is downloaded from local path
+      def local?(name)
+        # cookbook_location_specs contains only cookbooks refered via git and path
+        policy.cookbook_location_specs[name] && policy.cookbook_location_specs[name].source_type.nil?
+      end
+
+      # return a Changelog::Location for a given cookbook
+      def git_location(name)
+        return nil unless git?(name)
+        spec = lock.cookbook_locks[name].source_options
+        Location.new(spec[:git], spec[:revision], spec[:branch])
+      end
+
+      # return a list of supermarket uri for a given cookbook
+      # example: [ 'https://supermarket.chef.io' ]
+      def supermarkets_for(name)
+        [policy.send(:best_source_for, name).uri]
+      end
+    end
+  end
+end

data/lib/knife/changelog/version.rb

@@ -1,5 +1,5 @@
 module Knife
   module Changelog
-    VERSION = "0.5.20"
+    VERSION = "1.0.1"
   end
 end

data/spec/data/Berksfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://mysupermarket.io'
+source 'https://mysupermarket2.io'
+
+cookbook 'uptodate'
+cookbook 'outdated1'
+cookbook 'second_out_of_date'
+cookbook 'othercookbook'

data/spec/data/Berksfile.lock

@@ -0,0 +1,11 @@
+DEPENDENCIES
+  othercookbook
+  outdated1
+  second_out_of_date
+  uptodate
+
+GRAPH
+  othercookbook (1.0.0)
+  outdated1 (1.0.0)
+  second_out_of_date (1.0.0)
+  uptodate (1.0.0)

data/spec/data/Policyfile.lock.json

@@ -0,0 +1,72 @@
+{
+  "revision_id": "61fc0aa9ad414968cced34e8cf88189559b9ce8ec69d1514714822e77b0a2449",
+  "name": "test_policy",
+  "run_list": [
+    "recipe[uptodate::default]"
+  ],
+  "cookbook_locks": {
+    "uptodate": {
+      "version": "1.0.0",
+      "identifier": "c29076b3a9aae74c7edd9790343eb1502e2fa8f2",
+      "dotted_decimal_identifier": "54764984976648935.21531588425692222.194957930375410",
+      "cache_key": "uptodate-1.0.0-mysupermarket2.io",
+      "origin": "https://mysupermarket2.io:443/api/v1/cookbooks/uptodate/versions/1.0.0/download",
+      "source_options": {
+        "artifactserver": "https://mysupermarket2.io:443/api/v1/cookbooks/uptodate/versions/1.0.0/download",
+        "version": "1.0.0"
+      }
+    },
+    "outdated1": {
+      "version": "1.0.0",
+      "identifier": "c29076b3a9aae74c7edd9790343eb1502e2fa8f1",
+      "dotted_decimal_identifier": "54764984976648935.21531588425692222.194957930375411",
+      "cache_key": "outdated1-1.0.0-mysupermarket2.io",
+      "origin": "https://mysupermarket2.io:443/api/v1/cookbooks/outdated1/versions/1.0.0/download",
+      "source_options": {
+        "artifactserver": "https://mysupermarket2.io:443/api/v1/cookbooks/outdated1/versions/1.0.0/download",
+        "version": "1.0.0"
+      }
+    },
+    "second_out_of_date": {
+      "version": "1.0.0",
+      "identifier": "c29076b3a9aae74c7edd9790343eb1502e2fa8f1",
+      "dotted_decimal_identifier": "54764984976648935.21531588425692222.194957930375411",
+      "cache_key": "outdated1-1.0.0-mysupermarket2.io",
+      "origin": "https://mysupermarket2.io:443/api/v1/cookbooks/second_out_of_date/versions/1.0.0/download",
+      "source_options": {
+        "artifactserver": "https://mysupermarket2.io:443/api/v1/cookbooks/second_out_of_date/versions/1.0.0/download",
+        "version": "1.0.0"
+      }
+    }
+  },
+  "default_attributes": {
+
+  },
+  "override_attributes": {
+
+  },
+  "solution_dependencies": {
+    "Policyfile": [
+      [
+        "uptodate",
+        "= 1.0.0"
+      ],
+      [
+        "outdated1",
+        "= 1.0.0"
+      ],
+      [
+        "second_out_of_date",
+        "= 1.0.0"
+      ]
+    ],
+    "dependencies": {
+      "uptodate (1.0.0)": [
+      ],
+      "outdated1 (1.0.0)": [
+      ],
+      "second_out_of_date (1.0.0)": [
+      ]
+    }
+  }
+}

data/spec/data/Policyfile.rb

@@ -0,0 +1,10 @@
+name 'test_policy'
+
+run_list [
+  'recipe[uptodate]',
+  'recipe[second_out_of_date]',
+  'recipe[outdated1]'
+]
+
+default_source :supermarket, 'https://mysupermarket.io'
+default_source :supermarket, 'https://mysupermarket2.io'

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../lib/knife/changelog/changelog.rb'
+require_relative '../lib/knife/changelog/berksfile'
+require_relative '../lib/knife/changelog/policyfile'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/unit/changelog_spec.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require 'webmock/rspec'
+require 'berkshelf'
+
+WebMock.disable_net_connect!
+
+RSpec.shared_examples 'changelog generation' do
+  # this supposes that "changelog" is an instance of KnifeChangelog::Changelog
+  it 'detects basic changelog' do
+    changelog_txt = changelog.run(%w[new_cookbook uptodate outdated1 second_out_of_date])
+    expect(changelog_txt).to match(/commit in outdated1/)
+    expect(changelog_txt).to match(/commit in second_out_of_date/)
+    expect(changelog_txt).not_to match(/uptodate/)
+    expect(changelog_txt).to match(/new_cookbook: \n.*\nCookbook was not/)
+  end
+end
+
+describe KnifeChangelog::Changelog do
+  before(:each) do
+    stub_request(:get, %r{https://mysupermarket.io/api/v1/cookbooks/})
+      .to_return(status: 404, body: '{}')
+
+    mock_supermarket('uptodate', %w[1.0.0])
+    mock_supermarket('outdated1', %w[1.0.0 1.1.0])
+    # TODO: we should make second_out_of_date a git location
+    mock_supermarket('second_out_of_date', %w[1.0.0 1.2.0])
+
+    mock_universe('https://mysupermarket2.io', uptodate: %w[1.0.0], outdated1: %w[1.0.0 1.1.0], second_out_of_date: %w[1.0.0 1.2.0])
+    mock_universe('https://mysupermarket.io', {})
+
+    mock_git('second_out_of_date', <<-EOH)
+        aaaaaa commit in second_out_of_date
+        bbbbbb bugfix in second_out_of_date
+    EOH
+    mock_git('outdated1', <<-EOH)
+        aaaaaa commit in outdated1
+        bbbbbb bugfix in outdated1
+    EOH
+    mock_git('uptodate', '')
+  end
+
+  def mock_git(name, changelog)
+    expect(KnifeChangelog::Git).to receive(:new)
+      .with(anything, /#{name}(.git|$)/)
+      .and_return(double(name,
+    shallow_clone: '/tmp/randomdir12345',
+    revision_exists?: true,
+    files: [],
+    log: changelog.split("\n")))
+  end
+
+  def mock_supermarket(name, versions)
+    stub_request(:get, %r{https://mysupermarket2.io/api/v1/cookbooks/#{name}})
+      .to_return(status: 200, body: supermarket_versions(name, versions))
+  end
+
+  def supermarket_versions(name, versions)
+    {
+      name: name,
+      maintainer: 'Linus',
+      description: 'small project on the side',
+      category: 'Operating System',
+      source_url: "https://github.com/chef-cookbooks/#{name}",
+      versions: []
+    }.tap do |json|
+      versions.each do |v|
+        json[:versions] << "https://source.io/#{name}/#{v}"
+      end
+    end.to_json
+  end
+
+  def mock_universe(supermarket_url, cookbooks)
+    universe = cookbooks.transform_values do |versions|
+      versions.map do |v|
+        [v, {
+          location_type: 'opscode',
+          location_path: "#{supermarket_url}/api/v1",
+          download_url: "#{supermarket_url}/api/v1/cookbooks/insertnamehere/versions/#{v}/download",
+          dependencies: {}
+        }]
+      end.to_h
+    end
+    stub_request(:get, "#{supermarket_url}/universe")
+      .to_return(status: 200, body: universe.to_json)
+  end
+
+  context 'in Berksfile mode' do
+    let(:berksfile) do
+      Berkshelf::Berksfile.from_options(
+        berksfile: File.join(File.dirname(__FILE__), '../data/Berksfile')
+      )
+    end
+
+    let(:changelog) do
+      KnifeChangelog::Changelog::Berksfile.new(berksfile.lockfile.locks, {}, berksfile.sources)
+    end
+
+    include_examples 'changelog generation'
+  end
+
+  context 'in policyfile mode' do
+    let(:policyfile_path) { File.join(File.dirname(__FILE__), '../data/Policyfile.rb') }
+
+    let(:changelog) do
+      KnifeChangelog::Changelog::Policyfile.new(policyfile_path, {})
+    end
+
+    before(:each) do
+      allow(changelog.policy).to receive(:cache_fixed_version_cookbooks)
+    end
+
+    include_examples 'changelog generation'
+  end
+end
+
+class Hash
+  unless Chef::Version.new(RUBY_VERSION) >= Chef::Version.new('2.4')
+    def transform_values
+      map { |k, v| [k, (yield v)] }.to_h
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-changelog
 version: !ruby/object:Gem::Version
-  version: 0.5.20
+  version: 1.0.1
 platform: ruby
 authors:
 - Gregoire Seux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2017-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: pry
+  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
@@ -122,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: chef-dk
+  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'
 description: ''
 email:
 - kamaradclimber@gmail.com
@@ -138,10 +180,19 @@ files:
 - Rakefile
 - knife-changelog.gemspec
 - lib/chef/knife/changelog.rb
+- lib/knife/changelog/berksfile.rb
 - lib/knife/changelog/changelog.rb
+- lib/knife/changelog/git.rb
+- lib/knife/changelog/policyfile.rb
 - lib/knife/changelog/version.rb
 - resources/Berksfile
 - resources/Berksfile.lock
+- spec/data/Berksfile
+- spec/data/Berksfile.lock
+- spec/data/Policyfile.lock.json
+- spec/data/Policyfile.rb
+- spec/spec_helper.rb
+- spec/unit/changelog_spec.rb
 homepage: https://github.com/kamaradclimber/knife-changelog
 licenses:
 - MIT
@@ -166,4 +217,10 @@ rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Facilitate access to cookbooks changelog
-test_files: []
+test_files:
+- spec/data/Berksfile
+- spec/data/Berksfile.lock
+- spec/data/Policyfile.lock.json
+- spec/data/Policyfile.rb
+- spec/spec_helper.rb
+- spec/unit/changelog_spec.rb