knife-changelog 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a5811fea619f544617e97994433350e5c0206b46902d435a4320f5ef057e4e8
-  data.tar.gz: 77d0091e020ba853008dec8b603f3ba3c7e4c4181532edfbf8456e0d76954a33
+  metadata.gz: 69172c86c7b7796d3ec52bc1738688d33dcef55ccdf98d4f171cff25b9ee03a1
+  data.tar.gz: 94329ddcd6763e6d6ab8d510ce5e06850f93798e026405bf3d114fd51e13a7cf
 SHA512:
-  metadata.gz: eabfd3352b56cf74f7e4c3a55b9acf7ac3b20786f837b9bb9cd228e6f343411bb1d976759969f26869044a030e2f86173152d6f8b7848d292ab4a1d4c2a1eb60
-  data.tar.gz: 8f7c33a094d3c964dfaf2e7102ba05569077e2a49658e8932bd4657d0e90c35a8e45e5b1c663529d935238b1761a0df40b5fba9f586504eb3cfa3bba2fd1275d
+  metadata.gz: 2eef04a07df70eae15e9d5b8158c5956fb7782e5ad678545d65164b027aacf17e80c17d2efd9100644b46aed638b85f6cdd437f0877a31d7041351d7a8b3f8f6
+  data.tar.gz: 43a215deba3fae621e9c156acfbc8a0ebb8101a94c15932e355fefbfba6532457fe31f25bd277c9e054bdcd8afcd868270e78ac8155780dee75220d06069bb9a

data/.rubocop.yml

@@ -27,7 +27,13 @@ Metrics/PerceivedComplexity:
 Metrics/CyclomaticComplexity:
   Max: 25
 
+Metrics/BlockLength:
+  Max: 20
+  Exclude:
+    - "spec/**/*"
+
 AllCops:
   Exclude:
   - bundle/**/*
+  - spec/data/Policyfile.rb
   TargetRubyVersion: 2.3

data/knife-changelog.gemspec

@@ -1,34 +1,36 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 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.name          = 'knife-changelog'
   spec.version       = Knife::Changelog::VERSION
-  spec.authors       = ["Gregoire Seux"]
-  spec.email         = ["kamaradclimber@gmail.com"]
-  spec.summary       = %q{Facilitate access to cookbooks changelog}
-  spec.description   = %q{}
-  spec.homepage      = "https://github.com/kamaradclimber/knife-changelog"
-  spec.license       = "MIT"
+  spec.authors       = ['Gregoire Seux']
+  spec.email         = ['kamaradclimber@gmail.com']
+  spec.summary       = 'Facilitate access to cookbooks changelog'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/kamaradclimber/knife-changelog'
+  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_development_dependency "rubocop"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "pry"
+  spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'webmock'
 
   spec.add_dependency  'berkshelf'
-  spec.add_dependency  'rest-client'
-  spec.add_dependency  'mixlib-shellout'
   spec.add_dependency  'chef'
   spec.add_dependency  'chef-dk'
+  spec.add_dependency  'deep_merge'
+  spec.add_dependency  'git'
+  spec.add_dependency  'mixlib-shellout'
+  spec.add_dependency  'rest-client'
 end

data/lib/chef/knife/changelog.rb

@@ -1,68 +1,68 @@
+# frozen_string_literal: true
+
 require 'chef/knife'
 require 'mixlib/shellout'
 
 class Chef
   class Knife
     class Changelog < Knife
-
       banner 'knife changelog COOKBOOK [COOKBOOK ...]'
 
       deps do
-        require "knife/changelog/version"
-        require "knife/changelog/changelog"
-        require "knife/changelog/policyfile"
-        require "knife/changelog/berksfile"
-        require "berkshelf"
+        require 'knife/changelog/version'
+        require 'knife/changelog/changelog'
+        require 'knife/changelog/berksfile'
+        require 'berkshelf'
+        require 'policyfile'
       end
 
       option :linkify,
-        :short => '-l',
-        :long  => '--linkify',
-        :description => 'add markdown links where relevant',
-        :boolean => true
+             short: '-l',
+             long: '--linkify',
+             description: 'add markdown links where relevant',
+             boolean: true
 
       option :markdown,
-        :short => '-m',
-        :long  => '--markdown',
-        :description => 'use markdown syntax',
-        :boolean => true
+             short: '-m',
+             long: '--markdown',
+             description: 'use markdown syntax',
+             boolean: true
 
       option :ignore_changelog_file,
-        :long => '--ignore-changelog-file',
-        :description => "Ignore changelog file presence, use git history instead",
-        :boolean => true
+             long: '--ignore-changelog-file',
+             description: 'Ignore changelog file presence, use git history instead',
+             boolean: true
 
       option :allow_update_all,
-        :long => '--allow-update-all',
-        :description => "If no cookbook given, check all Berksfile",
-        :boolean => true,
-        :default => true
+             long: '--allow-update-all',
+             description: 'If no cookbook given, check all Berksfile',
+             boolean: true,
+             default: true
 
       option :submodules,
-        :long => '--submodules SUBMODULE[,SUBMODULE]',
-        :description => 'Submoduless to check for changes as well (comma separated)'
+             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'
+             long: '--policyfile PATH',
+             description: 'Link to policyfile, defaults to "Policyfile.rb"',
+             default: 'Policyfile.rb'
 
       option :update,
-        :long => '--update',
-        :description => 'Update Berksfile'
+             long: '--update',
+             description: 'Update Berksfile'
 
       def run
         Log.info config
-        @changelog = if config[:policyfile] && File.exists?(config[:policyfile])
-                       KnifeChangelog::Changelog::Policyfile.new(config[:policyfile], config)
-                     else
-                       berksfile = Berkshelf::Berksfile.from_options({})
-                       KnifeChangelog::Changelog::Berksfile.new(berksfile, config)
-                     end
-        changelog_text = @changelog.run(@name_args)
-        puts changelog_text
+        if config[:policyfile] && File.exist?(config[:policyfile])
+          PolicyChangelog.new(@name_args, config[:policyfile]).generate_changelog
+        else
+          berksfile = Berkshelf::Berksfile.from_options({})
+          puts KnifeChangelog::Changelog::Berksfile
+            .new(berksfile, config)
+            .run(@name_args)
+        end
       end
     end
-
   end
 end

data/lib/knife/changelog/version.rb

@@ -1,5 +1,5 @@
 module Knife
   module Changelog
-    VERSION = '1.0.6'
+    VERSION = '1.0.7'.freeze
   end
 end

data/lib/policyfile.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require 'chef'
+require 'chef/knife'
+require 'chef-dk/command/update'
+require 'deep_merge'
+require 'git'
+require 'json'
+require 'rest-client'
+
+class PolicyChangelog
+  TMP_PREFIX = 'knife-changelog'
+
+  # Initialzes Helper class
+  #
+  # @param cookbooks [Array<String>] cookbooks to update (@name_args)
+  # @param policyfile [String] policyfile path
+  def initialize(cookbooks, policyfile)
+    @cookbooks_to_update = cookbooks
+    @policyfile_path = File.expand_path(policyfile)
+    @policyfile_dir = File.dirname(@policyfile_path)
+  end
+
+  # Updates the Policyfile.lock to get version differences.
+  #
+  # @return update_dir [String] tmp directory with updated Policyfile.lock
+  def update_policyfile_lock
+    update_dir = Dir.mktmpdir
+    %w[Policyfile.rb Policyfile.lock.json].each do |file|
+      FileUtils.cp(
+        File.join(@policyfile_dir, file),
+        update_dir
+      )
+    end
+    updater = ChefDK::Command::Update.new
+    updater.run([
+      File.join(update_dir, 'Policyfile.rb'),
+      @cookbooks_to_update
+    ].flatten)
+    update_dir
+  end
+
+  # Parses JSON in Policyfile.lock.
+  #
+  # @param dir [String] directory containing Policyfile.lock
+  # @return [Hash] contents of Policyfile.lock
+  def read_policyfile_lock(dir)
+    lock = File.join(dir, 'Policyfile.lock.json')
+    raise "File #{lock} does not exist" unless File.exist?(lock)
+    content = JSON.parse(File.read(lock))
+    raise 'Policyfile.lock empty' if content.empty?
+    content
+  end
+
+  # Extracts current or target versions from Policyfile.lock data depending
+  # on the type value provided.
+  #
+  # @param locks [Hash] cookbook data from Policyfile.lock
+  # @param type [String] version type - current or target
+  # @return [Hash] cookbooks with their versions
+  def versions(locks, type)
+    raise 'Use "current" or "target" as type' unless %w[current target].include?(type)
+    raise 'Cookbook locks empty or nil' if locks.nil? or locks.empty?
+    cookbooks = {}
+    locks.each do |name, data|
+      cookbooks[name] = { "#{type}_version" => data['version'] }
+    end
+    cookbooks
+  end
+
+  # Extracts Git source URL from cookbook 'source_options' data depending
+  # on the source type - Supermarket or Git
+  #
+  # @param s [Hash] source_options for a cookbook in the Policyfile.lock
+  # @return [String] Git source code URL
+  def get_source_url(s)
+    if s.keys.include?('artifactserver')
+      { 'source_url' => supermarket_source_url(s['artifactserver'][%r{(.+)\/versions\/.*}, 1]) }
+    else
+      { 'source_url' => s['git'] }
+    end
+  end
+
+  # Fetches cookbook metadata from Supermarket and extracts Git source URL
+  #
+  # @param url [String] Supermarket cookbook URL
+  # @return [String] Git source code URL
+  def supermarket_source_url(url)
+    source_url = JSON.parse(RestClient::Request.execute(
+                              url: url,
+                              method: :get,
+                              verify_ssl: false
+    ))['source_url']
+    source_url = "#{source_url}.git" unless source_url.end_with?('.git')
+    source_url
+  end
+
+  # Clones a Git repo in a temporary directory and generates a commit
+  # changelog between two version tags
+  #
+  # @param source_url [String] Git repository URL
+  # @param current [String] current cookbook version tag
+  # @param target [String] target cookbook version tag
+  # @return [String] changelog between tags for one cookbook
+  def git_changelog(source_url, current, target)
+    dir = Dir.mktmpdir(TMP_PREFIX)
+    repo = Git.clone(source_url, dir)
+    if tag_format(repo) == 'v'
+      c_tag, t_tag = correct_tags("v#{current}", "v#{target}", repo)
+      repo.log.between(c_tag, t_tag)
+    else
+      c_tag, t_tag = correct_tags(current, target, repo)
+      repo.log.between(c_tag, t_tag)
+    end.map do |commit|
+      "#{commit.sha[0, 7]} #{commit.message.lines.first.strip}"
+    end.join("\n")
+  end
+
+  # Used to make #git_changelog method more readable
+  #
+  # @param current [String] current cookbook version tag
+  # @param target [String] target cookbook version tag
+  # @param repo [Git::Base] Git repository object
+  # @return [true, false]
+  def correct_tags(current, target, repo)
+    [git_tag(current, repo), git_tag(target, repo)]
+  end
+
+  # Tries to convert a supermarket tag to a git tag
+  # if there is a difference in formatting between the two.
+  # This is issue is present for the 'java' cookbook.
+  # https://github.com/agileorbit-cookbooks/java/issues/450
+  #
+  # @param tag [String] version tag
+  # @param repo [Git::Base] Git repository object
+  # @return [String]
+  def git_tag(tag, repo)
+    return tag if repo.checkout(tag)
+  rescue ::Git::GitExecuteError
+    begin
+      rescue_tag = tag.chomp('.0') if tag[/\.0$/]
+      return rescue_tag if repo.checkout(rescue_tag)
+    rescue ::Git::GitExecuteError
+      raise 'Difference between Git and Supermarket tags'
+    end
+  end
+
+  # Detects the format of a Git tag - v1.0.0 or 1.0.0
+  #
+  # @param repo [Git::Base] Git repository object
+  # @return [String] Git tag versioning type
+  def tag_format(repo)
+    repo.tags.last.name[/^v/] ? 'v' : ''
+  end
+
+  # Prints out commit changelog in a nicely formatted way
+  #
+  # @param name [String] cookbook name
+  # @param data [Hash] cookbook versions and source url data
+  def print_commit_changelog(name, data)
+    output = "\nChangelog for #{name}: #{data['current_version']}->#{data['target_version']}"
+    puts output
+    puts '=' * output.size
+    puts git_changelog(data['source_url'], data['current_version'], data['target_version'])
+  end
+
+  # Filters out cookbooks which are not updated, are not used after update or
+  # are newly added as dependencies during update
+  #
+  # @param [Hash] cookbook versions and source url data
+  # @return [true, false]
+  def reject_version_filter(data)
+    raise 'Data containing versions is nil' if data.nil?
+    data['current_version'] == data['target_version'] ||
+      data['current_version'].nil? ||
+      data['target_version'].nil?
+  end
+
+  # Generates Policyfile changelog
+  def generate_changelog
+    lock_current = read_policyfile_lock(@policyfile_dir)
+    current = versions(lock_current['cookbook_locks'], 'current')
+
+    lock_target = read_policyfile_lock(update_policyfile_lock)
+    target = versions(lock_target['cookbook_locks'], 'target')
+
+    updated_cookbooks = current.deep_merge(target).reject { |_name, data| reject_version_filter(data) }
+    sources = {}
+    updated_cookbooks.each_key do |name|
+      sources[name] = get_source_url(lock_target['cookbook_locks'][name]['source_options'])
+    end
+    updated_cookbooks.deep_merge(sources).each { |name, data| print_commit_changelog(name, data) }
+  end
+end

data/spec/data/Policyfile.lock.json

@@ -1,41 +1,34 @@
 {
-  "revision_id": "61fc0aa9ad414968cced34e8cf88189559b9ce8ec69d1514714822e77b0a2449",
+  "revision_id": "ca956e1f3b6bcbb1bd98e6f2aa58d22ae73191e4960f4039b3dea7225915205c",
   "name": "test_policy",
   "run_list": [
-    "recipe[uptodate::default]"
+    "recipe[users::default]",
+    "recipe[sudo::default]"
+  ],
+  "included_policy_locks": [
+
   ],
   "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",
+    "sudo": {
+      "version": "3.5.0",
+      "identifier": "35c2f73f9f88d16c8556b80297c4c00fa104fdba",
+      "dotted_decimal_identifier": "15132540945795281.30545904985610180.211173358501306",
+      "cache_key": "sudo-3.5.0-supermarket.chef.io",
+      "origin": "https://supermarket.chef.io:443/api/v1/cookbooks/sudo/versions/3.5.0/download",
       "source_options": {
-        "artifactserver": "https://mysupermarket2.io:443/api/v1/cookbooks/outdated1/versions/1.0.0/download",
-        "version": "1.0.0"
+        "artifactserver": "https://supermarket.chef.io:443/api/v1/cookbooks/sudo/versions/3.5.0/download",
+        "version": "3.5.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",
+    "users": {
+      "version": "4.0.0",
+      "identifier": "5920ea9767ce2e71fb17b2107888abe89043ee53",
+      "dotted_decimal_identifier": "25087464861847086.32082751558547592.189015341133395",
+      "cache_key": "users-4.0.0-supermarket.chef.io",
+      "origin": "https://supermarket.chef.io:443/api/v1/cookbooks/users/versions/4.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"
+        "artifactserver": "https://supermarket.chef.io:443/api/v1/cookbooks/users/versions/4.0.0/download",
+        "version": "4.0.0"
       }
     }
   },
@@ -48,24 +41,20 @@
   "solution_dependencies": {
     "Policyfile": [
       [
-        "uptodate",
-        "= 1.0.0"
+        "sudo",
+        "= 3.5.0"
       ],
       [
-        "outdated1",
-        "= 1.0.0"
-      ],
-      [
-        "second_out_of_date",
-        "= 1.0.0"
+        "users",
+        "= 4.0.0"
       ]
     ],
     "dependencies": {
-      "uptodate (1.0.0)": [
-      ],
-      "outdated1 (1.0.0)": [
+      "sudo (3.5.0)": [
+
       ],
-      "second_out_of_date (1.0.0)": [
+      "users (4.0.0)": [
+
       ]
     }
   }

data/spec/data/Policyfile.rb

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

data/spec/data/tmp_dir/Policyfile.lock.json

@@ -0,0 +1,61 @@
+{
+  "revision_id": "3ec29adf59408f8bac3408f9e284bae035b470eccda904544c4d1f541018289d",
+  "name": "test_policy",
+  "run_list": [
+    "recipe[users::default]",
+    "recipe[sudo::default]"
+  ],
+  "included_policy_locks": [
+
+  ],
+  "cookbook_locks": {
+    "sudo": {
+      "version": "3.5.0",
+      "identifier": "35c2f73f9f88d16c8556b80297c4c00fa104fdba",
+      "dotted_decimal_identifier": "15132540945795281.30545904985610180.211173358501306",
+      "cache_key": "sudo-3.5.0-supermarket.chef.io",
+      "origin": "https://supermarket.chef.io:443/api/v1/cookbooks/sudo/versions/3.5.0/download",
+      "source_options": {
+        "artifactserver": "https://supermarket.chef.io:443/api/v1/cookbooks/sudo/versions/3.5.0/download",
+        "version": "3.5.0"
+      }
+    },
+    "users": {
+      "version": "5.3.1",
+      "identifier": "41c2bf84fe2476bbbe2dbe79362e6726a3ea47c7",
+      "dotted_decimal_identifier": "18510001311982710.52844924323313198.113415656458183",
+      "cache_key": "users-5.3.1-supermarket.chef.io",
+      "origin": "https://supermarket.chef.io:443/api/v1/cookbooks/users/versions/5.3.1/download",
+      "source_options": {
+        "artifactserver": "https://supermarket.chef.io:443/api/v1/cookbooks/users/versions/5.3.1/download",
+        "version": "5.3.1"
+      }
+    }
+  },
+  "default_attributes": {
+
+  },
+  "override_attributes": {
+
+  },
+  "solution_dependencies": {
+    "Policyfile": [
+      [
+        "sudo",
+        "= 3.5.0"
+      ],
+      [
+        "users",
+        "= 5.3.1"
+      ]
+    ],
+    "dependencies": {
+      "sudo (3.5.0)": [
+
+      ],
+      "users (5.3.1)": [
+
+      ]
+    }
+  }
+}

data/spec/spec_helper.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
-require_relative '../lib/knife/changelog/changelog.rb'
-require_relative '../lib/knife/changelog/berksfile'
-require_relative '../lib/knife/changelog/policyfile'
+require 'knife/changelog/changelog'
+require 'knife/changelog/berksfile'
+require 'policyfile'
+
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!(allow_localhost: true)
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

data/spec/unit/changelog_spec.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../spec_helper'
-require 'webmock/rspec'
 require 'berkshelf'
-
-WebMock.disable_net_connect!
+require 'spec_helper'
 
 RSpec.shared_examples 'changelog generation' do
   # this supposes that "changelog" is an instance of KnifeChangelog::Changelog
@@ -117,63 +114,6 @@ describe KnifeChangelog::Changelog do
       end
     end
   end
-
-  context 'in policyfile mode' do
-    let(:policyfile_path) { File.join(File.dirname(__FILE__), '../data/Policyfile.rb') }
-
-    let(:options) do
-      {}
-    end
-
-    let(:changelog) do
-      KnifeChangelog::Changelog::Policyfile.new(policyfile_path, options)
-    end
-
-    before(:each) do
-      allow(changelog.policy).to receive(:cache_fixed_version_cookbooks)
-    end
-
-    include_examples 'changelog generation'
-
-    context 'with --update' do
-      let(:options) do
-        { update: true }
-      end
-      it 'fails with not implemented error' do
-        mock_git('outdated1', <<-EOH)
-          aaaaaa commit in outdated1
-          bbbbbb bugfix in outdated1
-        EOH
-        expect { changelog.run(%w[outdated1]) }.to raise_error(NotImplementedError)
-      end
-    end
-
-    context 'whith --allow-update-all ' do
-      let(:options) do
-        { "allow_update_all": true }
-      end
-
-      it 'should compute the changelog of all dependencies' do
-        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', '')
-
-        expect(changelog).to receive(:supermarkets_for).with('outdated1')
-          .and_return(["https://mysupermarket2.io"])
-        expect(changelog).to receive(:supermarkets_for).with('second_out_of_date')
-          .and_return(["https://mysupermarket2.io"])
-        expect(changelog).to receive(:supermarkets_for).with('uptodate')
-          .and_return(["https://mysupermarket2.io"])
-        changelog.run([])
-      end
-    end
-  end
 end
 
 class Hash

data/spec/unit/policyfile_spec.rb

@@ -0,0 +1,260 @@
+# frozen_string_literal: true
+
+require 'git'
+require 'spec_helper'
+
+RSpec.describe PolicyChangelog do
+  let(:pf_dir) do
+    File.expand_path(File.join(File.dirname(__FILE__), '../data'))
+  end
+
+  let(:tmp_dir) do
+    File.join(pf_dir, 'tmp_dir')
+  end
+
+  let(:changelog) do
+    PolicyChangelog.new('users', File.join(pf_dir, 'Policyfile.rb'))
+  end
+
+  let(:lock_current) do
+    JSON.parse(File.read(File.join(pf_dir, 'Policyfile.lock.json')))
+  end
+
+  let(:lock_target) do
+    JSON.parse(File.read(File.join(tmp_dir, 'Policyfile.lock.json')))
+  end
+
+  let(:current_versions) do
+    {
+      'sudo' => { 'current_version' => '3.5.0' },
+      'users' => { 'current_version' => '4.0.0' }
+    }
+  end
+
+  let(:target_versions) do
+    {
+      'sudo' => { 'target_version' => '3.5.0' },
+      'users' => { 'target_version' => '5.3.1' }
+    }
+  end
+
+  let(:url) { 'https://supermarket.chef.io/api/v1/cookbooks/users' }
+
+  before(:each) do
+    stub_request(:get, 'https://supermarket.chef.io/api/v1/cookbooks/users').to_return(
+      status: 200,
+      body: '{
+        "name": "users",
+        "maintainer": "chef",
+        "description": "Creates users from a databag search",
+        "category": "Other",
+        "latest_version": "https://supermarket.chef.io/api/v1/cookbooks/users/versions/5.3.1",
+        "external_url": "https://github.com/chef-cookbooks/users",
+        "source_url": "https://github.com/chef-cookbooks/users",
+        "issues_url": "https://github.com/chef-cookbooks/users/issues",
+        "average_rating": null,
+        "created_at": "2010-07-27T05:34:01.000Z",
+        "updated_at": "2017-12-15T18:08:26.990Z",
+        "up_for_adoption": null,
+        "deprecated": false,
+        "versions": [],
+        "metrics": {}
+      }'
+    )
+  end
+
+  describe '#read_policyfile_lock' do
+    context 'when Policyfile.lock.json does not exist' do
+      it 'raises an exception' do
+        expect { changelog.read_policyfile_lock('/does/not/exist') }.to raise_error(RuntimeError)
+      end
+    end
+
+    context 'when Policyfile.lock.json is empty' do
+      it 'raises an exception' do
+        allow(File).to receive(:read).and_return('')
+        expect { changelog.read_policyfile_lock('') }.to raise_error(RuntimeError)
+      end
+    end
+  end
+
+  describe '#versions' do
+    context 'when type is current' do
+      it 'returns correct current versions' do
+        expect(changelog.versions(lock_current['cookbook_locks'], 'current')).to eq(current_versions)
+      end
+    end
+
+    context 'when type is target' do
+      it 'returns correct target versions' do
+        expect(changelog.versions(lock_target['cookbook_locks'], 'target')).to eq(target_versions)
+      end
+    end
+
+    context 'when type is not current nor target' do
+      it 'raises an exception' do
+        expect { changelog.versions(lock_current['cookbook_locks'], 'toto') }.to raise_error(RuntimeError)
+      end
+    end
+
+    context 'when cookbooks locks are empty or nil' do
+      it 'raises an exception' do
+        expect { changelog.versions({}, 'current') }.to raise_error(RuntimeError)
+        expect { changelog.versions(nil, 'current') }.to raise_error(RuntimeError)
+      end
+    end
+  end
+
+  describe '#get_source_url' do
+    context 'when extracting source url' do
+      it 'returns an http url for supermarket' do
+        supermarket_source = { 'artifactserver' => 'https://url.example/cookbook/name/versions/3.5.0/download' }
+        allow(changelog).to receive(:supermarket_source_url).and_return('https://url.example')
+        expect(changelog.get_source_url(supermarket_source)['source_url'])
+          .to match(%r{^(http|https):\/\/.+$})
+      end
+
+      it 'raises exception for invalid supermarket url' do
+        bad_supermarket_source = { 'artifactserver' => 'https://url.example' }
+        expect { changelog.get_source_url(bad_supermarket_source)['source_url'] }
+          .to raise_error(ArgumentError)
+      end
+
+      it 'returns a git repo url for git' do
+        git_source = { 'git' => 'https://url.example.git' }
+        expect(changelog.get_source_url(git_source)['source_url'])
+          .to match(%r{^(http|https):\/\/.+\.git$})
+      end
+    end
+  end
+
+  describe '#supermarket_source_url' do
+    context 'when response not empty' do
+      it 'returns valid git repository url' do
+        expect(changelog.supermarket_source_url(url)).to match(%r{^(http|https):\/\/.+\.git$})
+      end
+    end
+
+    context 'when cookbook does not exist' do
+      it 'raises an error' do
+        response = '{ "error_messages":["Resource does not exist."],"error_code":"NOT_FOUND" }'
+        stub_request(:get, url).to_return(status: 404, body: response)
+        expect { changelog.supermarket_source_url(url) }.to raise_error(RestClient::NotFound)
+      end
+    end
+  end
+
+  describe '#git_changelog' do
+    let(:git) { Git }
+
+    let(:git_repo) { double(Git::Base.new) }
+
+    let(:git_commit) do
+      double(
+        sha: 'e1b971a32f3a582766e4f62022ef7ed88e5eb8ba',
+        message: "Add test commit message\nThis line should not be shown"
+      )
+    end
+
+    context 'when given two tags' do
+      it 'generates a changelog between two tags' do
+        allow(changelog).to receive(:tag_format).and_return('v')
+        allow(git).to receive(:clone).and_return(git_repo)
+        allow(changelog).to receive(:correct_tags)
+          .and_return(['v1.0.0', 'v1.0.1'])
+        allow(git_repo).to receive_message_chain(:log, :between)
+          .with('v1.0.0', 'v1.0.1')
+          .and_return([git_commit])
+
+        expect(changelog.git_changelog('https://url.example.git', '1.0.0', '1.0.1'))
+          .to eq('e1b971a Add test commit message')
+      end
+    end
+  end
+
+  describe '#git_tag' do
+    let(:repo) { double('repo') }
+
+    context 'when tag valid' do
+      it 'returns correct git tag' do
+        allow(repo).to receive(:checkout).with('1.0.0').and_return(true)
+
+        expect(changelog.git_tag('1.0.0', repo)).to eq('1.0.0')
+      end
+    end
+
+    context 'when tag invalid and able to correct' do
+      it 'returns correct git tag' do
+        allow(repo).to receive(:checkout).with('1.0.0').and_raise(::Git::GitExecuteError)
+        allow(repo).to receive(:checkout).with('1.0').and_return(true)
+
+        expect(changelog.git_tag('1.0.0', repo)).to eq('1.0')
+      end
+    end
+
+    context 'when tags invalid and unable to correct' do
+      it 'raises exception' do
+        allow(repo).to receive(:checkout).with('1.0.0').and_raise(::Git::GitExecuteError)
+        allow(repo).to receive(:checkout).with('1.0').and_raise(::Git::GitExecuteError)
+
+        expect { changelog.git_tag('1.0.0', repo) }
+          .to raise_error(RuntimeError, 'Difference between Git and Supermarket tags')
+      end
+    end
+  end
+
+  describe '#tag_format' do
+    context 'when it receives a tag' do
+      let(:repo) { Git::Base }
+
+      it 'detects type for regular tag' do
+        allow(repo).to receive_message_chain(:tags, :last, :name).and_return('1.0.0')
+        expect(changelog.tag_format(repo)).to eq('')
+      end
+
+      it 'detects type for v-tag' do
+        allow(repo).to receive_message_chain(:tags, :last, :name).and_return('v1.0.0')
+        expect(changelog.tag_format(repo)).to eq('v')
+      end
+    end
+  end
+
+  describe '#reject_version_filter' do
+    context 'when current equal to target' do
+      it 'returns true' do
+        data = { 'current_version' => '1.0.0', 'target_version' => '1.0.0' }
+        expect(changelog.reject_version_filter(data)).to be true
+      end
+    end
+    context 'when current not equal to target' do
+      it 'returns false' do
+        data = { 'current_version' => '1.0.0', 'target_version' => '1.0.1' }
+        expect(changelog.reject_version_filter(data)).to be false
+      end
+    end
+    context 'when current or target do not exist' do
+      it 'returns true' do
+        expect(changelog.reject_version_filter('target_version' => '1.0.0')).to be true
+        expect(changelog.reject_version_filter('current_version' => '1.0.0')).to be true
+      end
+    end
+    context 'when data is nil' do
+      it 'raises an exception' do
+        expect { changelog.reject_version_filter(nil) }.to raise_error
+      end
+    end
+  end
+
+  describe '#generate_changelog' do
+    context 'when generating a changelog' do
+      it 'detects type for regular tag' do
+        allow(changelog).to receive(:update_policyfile_lock)
+          .and_return(tmp_dir)
+        allow(changelog).to receive(:git_changelog)
+          .and_return('e1b971a Add test commit message')
+
+        expect { changelog.generate_changelog }.not_to raise_error(RuntimeError)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-changelog
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Gregoire Seux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2018-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,13 +95,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: berkshelf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: berkshelf
+  name: chef
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: chef-dk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mixlib-shellout
+  name: deep_merge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: chef
+  name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +165,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: chef-dk
+  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: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -183,16 +211,18 @@ files:
 - 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
+- lib/policyfile.rb
 - resources/Berksfile
 - resources/Berksfile.lock
 - spec/data/Berksfile
 - spec/data/Berksfile.lock
 - spec/data/Policyfile.lock.json
 - spec/data/Policyfile.rb
+- spec/data/tmp_dir/Policyfile.lock.json
 - spec/spec_helper.rb
 - spec/unit/changelog_spec.rb
+- spec/unit/policyfile_spec.rb
 homepage: https://github.com/kamaradclimber/knife-changelog
 licenses:
 - MIT
@@ -213,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Facilitate access to cookbooks changelog
@@ -222,5 +252,7 @@ test_files:
 - spec/data/Berksfile.lock
 - spec/data/Policyfile.lock.json
 - spec/data/Policyfile.rb
+- spec/data/tmp_dir/Policyfile.lock.json
 - spec/spec_helper.rb
 - spec/unit/changelog_spec.rb
+- spec/unit/policyfile_spec.rb

data/lib/knife/changelog/policyfile.rb

@@ -1,69 +0,0 @@
-# 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.solution_dependencies.cookbook_deps_for_lock.map { |k, v| k.scan(/(.*) \(.*\)/).last.first }
-      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
-
-      def update(cookbooks)
-        raise NotImplementedError
-      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