knife-changelog 1.2.4 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f1c7e863b74d109a6621879de1419046bbc5a2afb08ce618772f349d6aea0da
-  data.tar.gz: 5c6014713f79e60f1f517073166e114936d75f57db163f51e8f3aee6880e4614
+  metadata.gz: cd73707c23a179823ac967479e0ec8de3780d759fb05689e229854281e33a0a8
+  data.tar.gz: 80bc4745a9c0f39426a6f259d81a46ec13b17680a6601ed5cba2543fb01ed45a
 SHA512:
-  metadata.gz: bff9ad82bfe2d79b1b0d5094ee5b88e396b61013fb453aed9f57a584b48458428a7ec15dd88e63b6affb2e5b1c6e441112847b269312578d3d6f1505382d5660
-  data.tar.gz: c8e4d5741503d05cea8eaf23f1b8a120292733b8b7d723ac56c9b9f13977d0a501ffce943b6203f86d40e5f5cf16047d7b5a088b412e5a46c235c5a212419bee
+  metadata.gz: f86532a7c3005c3ec488fe090f66d7c779d148b9fed9eccd90a546bb9c465cc09e23df145618771b994171703576235494c81a4b207b4b6de027799b4bd897a1
+  data.tar.gz: 0f12940e801842989f715b5b0b5be67a6abaaac1d01abfaf3808af42d750beaa7a726fd5d075871094ebda5f044eb6784dd57d68d12c818093130d6b03bb5ab9

data/knife-changelog.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'knife-changelog'
-  spec.version       = '1.2.4'
+  spec.version       = '1.4.2'
   spec.authors       = ['Gregoire Seux']
   spec.email         = ['kamaradclimber@gmail.com']
   spec.summary       = 'Facilitate access to cookbooks changelog'

data/lib/chef/knife/changelog.rb

@@ -42,6 +42,12 @@ class Chef
              long: '--submodules SUBMODULE[,SUBMODULE]',
              description: 'Submoduless to check for changes as well (comma separated)'
 
+      option :prevent_downgrade,
+             long: '--prevent-downgrade',
+             description: 'Fail if knife-changelog detect a cookbook downgrade',
+             boolean: true,
+             default: false
+
       option :policyfile,
              long: '--policyfile PATH',
              description: 'Link to policyfile, defaults to "Policyfile.rb"',
@@ -58,7 +64,7 @@ class Chef
              description: 'Update Berksfile'
 
       def run
-        Log.info config
+        Log.info config.to_s
         if config[:policyfile] && File.exist?(config[:policyfile])
           puts PolicyChangelog.new(
             @name_args,

data/lib/knife/changelog/changelog.rb

@@ -239,10 +239,15 @@ class KnifeChangelog
       c
     end
 
+    GERRIT_REGEXP = %r{^(.*)/[^/]+/[^/]+(?:\.git)$}
     def linkify(url, changelog)
-      changelog.map do |line|
-        line.gsub(/^([a-f0-9]+) (.*)$/, '\2 (%s/commit/\1) ' % [url.chomp('.git')])
-      end
+      format = case url
+               when /gitlab/, /github/
+                 "\\2 (#{url.chomp('.git')}/commit/\\1)"
+               when GERRIT_REGEXP
+                 "\\2 (#{::Regexp.last_match(1)}/#/q/\\1)"
+               end
+      format ? changelog.map { |line| line.sub(/^([a-f0-9]+) (.*)$/, format) } : changelog
     end
 
     def https_url(location)

data/lib/knife/changelog/policyfile.rb

@@ -3,6 +3,7 @@
 require 'chef'
 require 'chef/knife'
 require 'chef-dk/command/update'
+require 'chef-dk/command/install'
 require 'deep_merge'
 require 'git'
 require 'json'
@@ -10,6 +11,9 @@ require 'rest-client'
 
 class PolicyChangelog
   TMP_PREFIX = 'knife-changelog'
+  # Regex matching Chef cookbook version syntax
+  # See https://docs.chef.io/cookbook_versioning.html#syntax
+  VERSION_REGEX = /^[1-9]*[0-9](\.[0-9]+){1,2}$/
 
   # Initialzes Helper class
   #
@@ -28,6 +32,8 @@ class PolicyChangelog
   def update_policyfile_lock
     backup_dir = Dir.mktmpdir
     FileUtils.cp(File.join(@policyfile_dir, 'Policyfile.lock.json'), backup_dir)
+    installer = ChefDK::Command::Install.new
+    raise "Cannot install Policyfile lock #{@policyfile_path}" unless installer.run([@policyfile_relative_path]).zero?
     updater = ChefDK::Command::Update.new
     raise "Error updating Policyfile lock #{@policyfile_path}" unless updater.run([@policyfile_path, @cookbooks_to_update].flatten).zero?
     updated_policyfile_lock = read_policyfile_lock(@policyfile_dir)
@@ -173,10 +179,24 @@ class PolicyChangelog
     data['current_version'] == data['target_version'] || data['target_version'].nil?
   end
 
+  # Search for cookbook downgrade and raise an error if any
+  def validate_downgrade!(data)
+    downgrade = data.select do |_, ck|
+      # Do not try to validate downgrade on non-sementic versions (e.g. git revision)
+      ck['target_version'] =~ VERSION_REGEX && ck['current_version'] =~ VERSION_REGEX &&
+        ::Gem::Version.new(ck['target_version']) < ::Gem::Version.new(ck['current_version'])
+    end
+
+    return if downgrade.empty?
+
+    details = downgrade.map { |name, data| "#{name} (#{data['current_version']} -> #{data['target_version']})" }
+    raise "Trying to downgrade following cookbooks: #{details.join(', ')}"
+  end
+
   # Generates Policyfile changelog
   #
   # @return [String] formatted version changelog
-  def generate_changelog
+  def generate_changelog(prevent_downgrade: false)
     lock_current = read_policyfile_lock(@policyfile_dir)
     current = versions(lock_current['cookbook_locks'], 'current')
 
@@ -189,6 +209,9 @@ class PolicyChangelog
                           else
                             updated_cookbooks.select { |name, _data| @cookbooks_to_update.include?(name) }
                           end
+
+    validate_downgrade!(updated_cookbooks) if prevent_downgrade
+
     generate_changelog_from_versions(changelog_cookbooks)
   end
 

data/spec/unit/policyfile_spec.rb

@@ -92,6 +92,35 @@ RSpec.describe PolicyChangelog do
     end
   end
 
+  describe '#linkify' do
+    subject { KnifeChangelog::Changelog.new(config) }
+    let(:config) { double('config') }
+    let(:changelog) do
+      ['9363423 Leverage criteo-flavor 3.11 to benefit from labels']
+    end
+    context 'when url is gitlab style' do
+      let(:url) { 'https://gitlab.com/chef-cookbooks/criteo-rackguru.git' }
+
+      it 'creates a gitlab style link' do
+        expect(subject.linkify(url, changelog).first).to match(%r{https://gitlab.com/chef-cookbooks/criteo-rackguru/commit/9363423})
+      end
+    end
+
+    context 'when url is github style' do
+      let(:url) { 'https://github.com/chef-cookbooks/criteo-rackguru.git' }
+      it 'creates a github style link' do
+        expect(subject.linkify(url, changelog).first).to match(%r{https://github.com/chef-cookbooks/criteo-rackguru/commit/9363423})
+      end
+    end
+
+    context 'when url has no known style' do
+      let(:url) { 'https://review.mycompany.com/chef-cookbooks/criteo-rackguru.git' }
+      it 'creates a gerrit style link' do
+        expect(subject.linkify(url, changelog).first).to match(%r{https://review.mycompany.com/#/q/9363423})
+      end
+    end
+  end
+
   describe '#versions' do
     context 'when type is current' do
       it 'returns correct current versions' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-changelog
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.4.2
 platform: ruby
 authors:
 - Gregoire Seux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-24 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -243,8 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Facilitate access to cookbooks changelog