knife-changelog 1.2.5 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afbea7c14cdeabf23ea4f20db0af330eff3cad96f1239ded017e125182fb1ffb
-  data.tar.gz: 7cb891e33b24d3d99c0822d509af3f2c50ae9fb40cb6dde74bf83c1b21fc5075
+  metadata.gz: ac82fb7552ead5bf08e8d7340883adab40185d5098c60ab3944472b3d51555b8
+  data.tar.gz: 22f9713b7df19b7a332a1a275e3a69db6dfa0d9d59abd815d7728c22b6d7c006
 SHA512:
-  metadata.gz: 56b42d01d1246064e7d74812cbccb51be231aea9603a0364046a1dde153127d6ee0eb24bede748c6af660dc0131f4bd1b20858b3fc2b0057ac6e86206918c75f
-  data.tar.gz: 1840e41083d1167cb803590b9151b543ed6df478d89e12a8ca81e921359eb6383ac340a847d87f99d91a91e17e2eefc5fd0bca338e970cd86a45cf6834045d1a
+  metadata.gz: 64bed7f1436c1d8536d479673d92d7749e7a8e9d16c271f81bbeac380c24b1f305300ff77bd4e17f7698746b2545b7773897923c7cb27dd68f6266f50ae5888a
+  data.tar.gz: e7939f44aefd0b409a9e5d2a12f7bdf1cd4ad9671c6ec906b1a650f51aaddb3cd72985ec3f220a5b8f96f532ddd1735d3bf7c9948927ac3905fc2f6dfb8e97c3

data/.github/workflows/ci.yml

@@ -0,0 +1,15 @@
+name: Tests
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.7']
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - run: bundle exec rake

data/.github/workflows/release.yml

@@ -0,0 +1,18 @@
+name: Release
+on:
+  push:
+    tags: [ '*' ]
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - run: |
+        install -D -m 600 <(echo -e "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}") $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/Rakefile

@@ -1,9 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec)
 
-  task :default => :spec
-rescue LoadError
-end
+task default: :spec

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.5'
+  spec.version       = '1.5.0'
   spec.authors       = ['Gregoire Seux']
   spec.email         = ['kamaradclimber@gmail.com']
   spec.summary       = 'Facilitate access to cookbooks changelog'
@@ -18,7 +18,6 @@ Gem::Specification.new do |spec|
   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 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'

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

@@ -11,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
   #
@@ -104,14 +107,30 @@ class PolicyChangelog
   # @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)
+  def git_changelog(source_url, current, target, cookbook = nil)
     dir = Dir.mktmpdir(TMP_PREFIX)
     repo = Git.clone(source_url, dir)
-    repo.log.between(git_ref(current, repo), git_ref(target, repo)).map do |commit|
+    cookbook_path = cookbook ? git_cookbook_path(repo, cookbook) : '.'
+    repo.log.path(cookbook_path).between(git_ref(current, repo, cookbook), git_ref(target, repo, cookbook)).map do |commit|
       "#{commit.sha[0, 7]} #{commit.message.lines.first.strip}"
     end.join("\n")
   end
 
+  # Tries to find the location of a specific cookbook in the given repo
+  #
+  # @param repo [Git::Base] Git repository object
+  # @param cookbook [String] name of the cookbook to search the location
+  # @return [String] reative location of the cookbook in the repo
+  def git_cookbook_path(repo, cookbook)
+    metadata_files = ['metadata.rb', '*/metadata.rb'].flat_map { |location| repo.ls_files(location).keys }
+    metadata_path = metadata_files.find do |path|
+      path = ::File.join(repo.dir.to_s, path)
+      ::Chef::Cookbook::Metadata.new.tap { |m| m.from_file(path) }.name == cookbook
+    end
+    raise "Impossible to find matching metadata for #{cookbook} in #{repo.remote.url}" unless metadata_path
+    ::File.dirname(metadata_path)
+  end
+
   # Tries to convert a supermarket tag to a git reference
   # if there is a difference in formatting between the two.
   # This is issue is present for the 'java' cookbook.
@@ -119,9 +138,11 @@ class PolicyChangelog
   #
   # @param ref [String] version reference
   # @param repo [Git::Base] Git repository object
+  # @param cookbook [String] name of the cookbook to ref against
   # @return [String]
-  def git_ref(myref, repo)
+  def git_ref(myref, repo, cookbook_name = nil)
     possible_refs = ['v' + myref, myref]
+    possible_refs += possible_refs.map { |ref| "#{cookbook_name}-#{ref}" } if cookbook_name
     possible_refs += possible_refs.map { |ref| ref.chomp('.0') } if myref[/\.0$/]
     existing_ref = possible_refs.find do |ref|
       begin
@@ -159,7 +180,7 @@ class PolicyChangelog
     output = ["\nChangelog for #{name}: #{data['current_version']}->#{data['target_version']}"]
     output << '=' * output.first.size
     output << if data['current_version']
-                git_changelog(data['source_url'], data['current_version'], data['target_version'])
+                git_changelog(data['source_url'], data['current_version'], data['target_version'], name)
               else
                 'Cookbook was not in the Policyfile.lock.json'
               end
@@ -176,10 +197,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')
 
@@ -192,6 +227,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
@@ -185,7 +214,7 @@ RSpec.describe PolicyChangelog do
         allow(changelog).to receive(:git_ref).with('1.0.0', any_args).and_return('v1.0.0')
         allow(changelog).to receive(:git_ref).with('1.0.1', any_args).and_return('v1.0.1')
         allow(changelog).to receive(:correct_tags)
-        allow(git_repo).to receive_message_chain(:log, :between)
+        allow(git_repo).to receive_message_chain(:log, :path, :between)
           .with('v1.0.0', 'v1.0.1')
           .and_return([git_commit])
 
@@ -209,11 +238,16 @@ RSpec.describe PolicyChangelog do
 
     context 'when tag invalid and able to correct' do
       it 'returns correct git tag' do
-        allow(repo).to receive(:checkout).with(/v1.0/).and_raise(::Git::GitExecuteError)
         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_ref('1.0.0', repo)).to eq('1.0')
+        tags = %w[v1.0.0 1.0 v1.0 cookbook_name-1.0.0 cookbook_name-1.0 cookbook_name-v1.0.0 cookbook_name-v1.0]
+        tags.each do |valid_result|
+          allow(repo).to receive(:checkout).with(valid_result).and_return(true)
+          tags.reject { |v| v == valid_result }.each do |invalid_result|
+            allow(repo).to receive(:checkout).with(invalid_result).and_raise(::Git::GitExecuteError)
+          end
+          expect(changelog.git_ref('1.0.0', repo, 'cookbook_name')).to eq valid_result
+        end
       end
     end
 
@@ -279,7 +313,7 @@ RSpec.describe PolicyChangelog do
         }
 
         allow(changelog).to receive(:git_changelog)
-          .with(instance_of(String), '4.0.0', '5.0.0')
+          .with(instance_of(String), '4.0.0', '5.0.0', 'users')
           .and_return('e1b971a Add test commit message')
 
         output = <<~COMMIT.chomp

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: knife-changelog
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.5.0
 platform: ruby
 authors:
 - Gregoire Seux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-24 00:00:00.000000000 Z
+date: 2021-07-12 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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -199,9 +185,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -243,8 +230,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.1.6
 signing_key: 
 specification_version: 4
 summary: Facilitate access to cookbooks changelog

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
-  - 2.4
-deploy:
-  provider: rubygems
-  api_key:
-    secure: LAM8qxTQa6oxzKiQpWrqRlcE1czmGFj16NSj1FVgZYJLZIfXKdvSpth+DfuCk8mxG1tvDXa3ckfERrzexG3lYGNPGyZH2sjnyt900Evd3Bn8vhv0LXE7cEZb3x/uJ3RHRvKpEDnMsy4gqoVByDLWXWnI9Q/8B4AtzFeTVsTr48g=
-  gem: knife-changelog
-  on:
-    tags: true
-    repo: criteo/knife-changelog
-sudo: false # use docker based infra