knife-changelog 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 411909df80e256eb6bd9e979757fec2380c12af929364ab6c5dc950e0ae1ad4c
-  data.tar.gz: acd53e149eed37830e7a8f1ab43f6ce43f457bce96ec0a721797a08626365dcd
+  metadata.gz: d0b9795c192f99c99cdab392807817812147b4d9482d6b1f5190c8adbac732cd
+  data.tar.gz: bf4fd4b3232690bf0b2f2fb7fd63fd1d829f3f5846a78a0a0c0e9a87b7971cb6
 SHA512:
-  metadata.gz: 83f46649c2d333d411f6d0f6207fabd62c6c591253288df58473cd1e70f16d96f280b6693c70bc512f77d5aa1971a942cb961c9d4721b6dafefd61829ac67d7e
-  data.tar.gz: e5f843bfd021fd395c882f306caf9f716a9f1c11b95375a85fc399fb6f6a48114a2b7e75c22a6a7ca5080b2ffd9d76cf04a2ef863553f96e8fe8cced18e9c147
+  metadata.gz: 00ab22310ec4ec7f07b53e8070450b1c86d5893315f9eaf9c65dc5dc74b568419feef48d3762d4df8c839cea8e3871f862ef9a6f659bbe304d64ee180b21e2e1
+  data.tar.gz: 0e24cc98ac6f6c8681a966cb25d92be0a027209cd1498d086788bd9e488a49134b6fc5db7ab3b5606fc3f6668c10755c12f9c914e3d6e679dfc7eab060d2cd7c

data/knife-changelog.gemspec

@@ -5,12 +5,12 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'knife-changelog'
-  spec.version       = '4.0.0'
+  spec.version       = '4.1.0'
   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.homepage      = 'https://github.com/criteo/knife-changelog'
   spec.license       = 'MIT'
 
   spec.required_ruby_version = '>= 3.0'
@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'webmock'
 
-  spec.add_dependency  'chef'
   spec.add_dependency  'chef-cli'
   spec.add_dependency  'deep_merge'
   spec.add_dependency  'git'

data/lib/knife/changelog/policyfile.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'chef'
 require 'chef/knife'
 require 'chef-cli/command/update'
 require 'chef-cli/command/install'
@@ -29,15 +28,15 @@ class PolicyChangelog
   # Updates the Policyfile.lock to get version differences.
   #
   # @return update_dir [String] tmp directory with updated Policyfile.lock
-  def update_policyfile_lock
-    backup_dir = Dir.mktmpdir
-    FileUtils.cp(File.join(@policyfile_dir, 'Policyfile.lock.json'), backup_dir)
+  def update_policyfile_lock(work_dir: nil)
+    work_dir ||= ::Dir.mktmpdir(TMP_PREFIX)
+    FileUtils.cp(File.join(@policyfile_dir, 'Policyfile.lock.json'), work_dir)
     installer = ChefCLI::Command::Install.new
     raise "Cannot install Policyfile lock #{@policyfile_path}" unless installer.run([@policyfile_relative_path]).zero?
     updater = ChefCLI::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)
-    FileUtils.cp(File.join(backup_dir, 'Policyfile.lock.json'), @policyfile_dir)
+    FileUtils.cp(File.join(work_dir, 'Policyfile.lock.json'), @policyfile_dir)
     updated_policyfile_lock
   end
 
@@ -107,9 +106,9 @@ 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, cookbook = nil)
-    dir = Dir.mktmpdir(TMP_PREFIX)
-    repo = Git.clone(source_url, dir)
+  def git_changelog(source_url, current, target, cookbook = nil, work_dir: nil)
+    repo_dir = ::File.join(work_dir || Dir.mktmpdir(TMP_PREFIX), "git-#{source_url.gsub(/[\/:]+/, '-')}")
+    repo = ::Dir.exist?(repo_dir) ? ::Git.open(repo_dir) : ::Git.clone(source_url, repo_dir)
     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}"
@@ -176,11 +175,11 @@ class PolicyChangelog
   # @param name [String] cookbook name
   # @param data [Hash] cookbook versions and source url data
   # @return [String] formatted changelog
-  def format_output(name, data)
+  def format_output(name, data, work_dir: nil)
     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'], name)
+                git_changelog(data['source_url'], data['current_version'], data['target_version'], name, work_dir: work_dir)
               else
                 'Cookbook was not in the Policyfile.lock.json'
               end
@@ -215,33 +214,31 @@ class PolicyChangelog
   #
   # @return [String] formatted version changelog
   def generate_changelog(prevent_downgrade: false)
-    lock_current = read_policyfile_lock(@policyfile_dir)
-    current = versions(lock_current['cookbook_locks'], 'current')
-
-    lock_target = update_policyfile_lock
-    target = versions(lock_target['cookbook_locks'], 'target')
-
-    updated_cookbooks = current.deep_merge(target).reject { |_name, data| reject_version_filter(data) }
-    changelog_cookbooks = if @with_dependencies || @cookbooks_to_update.nil?
-                            updated_cookbooks
-                          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)
+    ::Dir.mktmpdir(TMP_PREFIX) do |dir|
+      lock_current = read_policyfile_lock(@policyfile_dir)
+      current = versions(lock_current['cookbook_locks'], 'current')
+      lock_target = update_policyfile_lock(work_dir: dir)
+      target = versions(lock_target['cookbook_locks'], 'target')
+      updated_cookbooks = current.deep_merge(target).reject { |_name, data| reject_version_filter(data) }
+      changelog_cookbooks = if @with_dependencies || @cookbooks_to_update.nil?
+                              updated_cookbooks
+                            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, work_dir: dir)
+    end
   end
 
   # Generates Policyfile changelog
   #
   # @param cookbook_versions. Format is { 'NAME'  => { 'current_version' => 'VERSION', 'target_version' => 'VERSION' }
   # @return [String] formatted version changelog
-  def generate_changelog_from_versions(cookbook_versions)
+  def generate_changelog_from_versions(cookbook_versions, work_dir: nil)
     lock_current = read_policyfile_lock(@policyfile_dir)
     sources = cookbook_versions.map do |name, data|
       [name, get_source_url(lock_current['cookbook_locks'][name]['source_options'])] if data['current_version']
     end.compact.to_h
-    cookbook_versions.deep_merge(sources).map { |name, data| format_output(name, data) }.join("\n")
+    cookbook_versions.deep_merge(sources).map { |name, data| format_output(name, data, work_dir: work_dir) }.join("\n")
   end
 end

data/spec/unit/policyfile_spec.rb

@@ -284,7 +284,7 @@ RSpec.describe PolicyChangelog do
         }
 
         allow(changelog).to receive(:git_changelog)
-          .with(instance_of(String), '4.0.0', '5.0.0', 'users')
+          .with(instance_of(String), '4.0.0', '5.0.0', 'users', work_dir: nil)
           .and_return('e1b971a Add test commit message')
 
         output = <<~COMMIT.chomp

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-changelog
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Gregoire Seux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: chef
-  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-cli
   requirement: !ruby/object:Gem::Requirement
@@ -196,8 +182,6 @@ files:
 - knife-changelog.gemspec
 - lib/chef/knife/changelog.rb
 - lib/knife/changelog/policyfile.rb
-- resources/Berksfile
-- resources/Berksfile.lock
 - spec/data/Policyfile.lock.json
 - spec/data/Policyfile.rb
 - spec/data/Policyfile_git.lock.json
@@ -205,7 +189,7 @@ files:
 - spec/data/updated/Policyfile.lock.json
 - spec/spec_helper.rb
 - spec/unit/policyfile_spec.rb
-homepage: https://github.com/kamaradclimber/knife-changelog
+homepage: https://github.com/criteo/knife-changelog
 licenses:
 - MIT
 metadata: {}

data/resources/Berksfile

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

data/resources/Berksfile.lock

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