modulesync 4.1.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e2ed989c9e8e1837a6839019ab67c2defd8c61c2c724e2f0b9691a51012258e
-  data.tar.gz: 94f5d3040444e96ed1f22a4860d9e2d1c15aace660300cc5f0e4ee2194eb4bfe
+  metadata.gz: f9495a02958b177ad86c12e69ee471e77e03058d0067c8e814c991607f730e29
+  data.tar.gz: 7c349b62e686857b15d423bbf5a584e0a7e4e12a2359e2bb6c5b226e87dcb78c
 SHA512:
-  metadata.gz: 1b2b04b08c73b482e4f33f6b06ee038c95b334480b55a61751dc2360484157b8007f30378bf6d1e134ac1448e20930473f2e139fe86d62ef5f34897c6b59c771
-  data.tar.gz: 18d9cc8cff9cfbf5e68fa2c1818802701387f768d0a293cd6a950cf2bad297cd9dc7e8822858bc0d427c1a143d4b7bef72d7ce28889c61841dbc3b5d40a56507
+  metadata.gz: 15b92a3cfc0a9681bb879d0a86eec2a04e1649b7799b4762cf58617b770cfada67041689630cb05f843b317565dee11626b35761fe0e8362c991c73a3f37e5c8
+  data.tar.gz: 073b867ed92cf55d1f61fde7fea9bdf46f28b161ceda6f0e4f84c05433c4cdd6fc634eec9fb85af2a13ea684474b86fef5ca16dabebf012fe3967c0ac69d27e4

data/.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
     outputs:
       ruby: ${{ steps.ruby.outputs.versions }}
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v7
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -25,7 +25,7 @@ jobs:
       - name: Run linter
         run: bundle exec rake rubocop
       - id: ruby
-        uses: voxpupuli/ruby-version@v1
+        uses: voxpupuli/ruby-version@v2
 
   test:
     name: "Ruby ${{ matrix.ruby }}"
@@ -36,7 +36,7 @@ jobs:
       matrix:
         ruby: ${{ fromJSON(needs.rubocop_and_matrix.outputs.ruby) }}
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v7
       - name: Install Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/release.yml

@@ -15,7 +15,7 @@ jobs:
     name: Build the gem
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v7
       - name: Install Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -24,7 +24,7 @@ jobs:
         shell: bash
         run: gem build --verbose *.gemspec
       - name: Upload gem to GitHub cache
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: gem-artifact
           path: '*.gem'
@@ -39,7 +39,7 @@ jobs:
       contents: write # clone repo and create release
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v8
         with:
           name: gem-artifact
       - name: Create Release
@@ -56,7 +56,7 @@ jobs:
       packages: write # publish to rubygems.pkg.github.com
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v8
         with:
           name: gem-artifact
       - name: Publish gem to GitHub packages
@@ -73,10 +73,10 @@ jobs:
       id-token: write # rubygems.org authentication
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v8
         with:
           name: gem-artifact
-      - uses: rubygems/configure-rubygems-credentials@v1.0.0
+      - uses: rubygems/configure-rubygems-credentials@v2.1.0
       - name: Publish gem to rubygems.org
         shell: bash
         run: gem push *.gem
@@ -92,7 +92,7 @@ jobs:
       - release-to-rubygems
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v8
         with:
           name: gem-artifact
       - name: Install Ruby

data/.rubocop.yml

@@ -3,6 +3,3 @@ inherit_from: .rubocop_todo.yml
 
 inherit_gem:
   voxpupuli-rubocop: rubocop.yml
-
-AllCops:
-  TargetRubyVersion: 3.2

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --no-auto-gen-timestamp`
-# using RuboCop version 1.79.2.
+# using RuboCop version 1.81.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -66,8 +66,7 @@ RSpec/NestedGroups:
   Max: 5
 
 # Offense count: 2
-# Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
-# Include: **/*_spec.rb
+# Configuration parameters: CustomTransform, IgnoreMethods, IgnoreMetadata.
 RSpec/SpecFilePathFormat:
   Exclude:
     - '**/spec/routing/**/*'
@@ -108,7 +107,7 @@ Style/OptionalBooleanParameter:
   Exclude:
     - 'lib/modulesync/puppet_module.rb'
 
-# Offense count: 6
+# Offense count: 7
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https

data/CHANGELOG.md

@@ -2,6 +2,40 @@
 
 All notable changes to this project will be documented in this file.
 
+## [4.3.0](https://github.com/voxpupuli/modulesync/tree/4.3.0) (2026-07-09)
+
+[Full Changelog](https://github.com/voxpupuli/modulesync/compare/4.2.0...4.3.0)
+
+**Implemented enhancements:**
+
+- Add Ruby 4.0 support [\#338](https://github.com/voxpupuli/modulesync/pull/338) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+**Fixed bugs:**
+
+- fix: validate PR credentials and retry PR creation [\#347](https://github.com/voxpupuli/modulesync/pull/347) ([rwaffen](https://github.com/rwaffen))
+
+**Merged pull requests:**
+
+- Update cucumber requirement from ~\> 10.1 to ~\> 11.0 [\#344](https://github.com/voxpupuli/modulesync/pull/344) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update voxpupuli-rubocop requirement from ~\> 5.1.0 to ~\> 5.2.0 [\#341](https://github.com/voxpupuli/modulesync/pull/341) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update voxpupuli-rubocop requirement from ~\> 5.0.0 to ~\> 5.1.0 [\#334](https://github.com/voxpupuli/modulesync/pull/334) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+## [4.2.0](https://github.com/voxpupuli/modulesync/tree/4.2.0) (2025-10-16)
+
+[Full Changelog](https://github.com/voxpupuli/modulesync/compare/4.1.0...4.2.0)
+
+**Implemented enhancements:**
+
+- git: Allow 4.x [\#327](https://github.com/voxpupuli/modulesync/pull/327) ([bastelfreak](https://github.com/bastelfreak))
+- puppet-blacksmith: Allow 9.x [\#325](https://github.com/voxpupuli/modulesync/pull/325) ([bastelfreak](https://github.com/bastelfreak))
+
+**Merged pull requests:**
+
+- Update gitlab requirement from \>= 4, \< 6 to \>= 4, \< 7 [\#330](https://github.com/voxpupuli/modulesync/pull/330) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update octokit requirement from \>= 4, \< 10 to \>= 4, \< 11 [\#329](https://github.com/voxpupuli/modulesync/pull/329) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update cucumber requirement from ~\> 9.2 to ~\> 10.1 [\#328](https://github.com/voxpupuli/modulesync/pull/328) ([dependabot[bot]](https://github.com/apps/dependabot))
+- voxpupuli-rubocop: Update 4.2.0-\>5.0.0 [\#324](https://github.com/voxpupuli/modulesync/pull/324) ([bastelfreak](https://github.com/bastelfreak))
+
 ## [4.1.0](https://github.com/voxpupuli/modulesync/tree/4.1.0) (2025-10-16)
 
 [Full Changelog](https://github.com/voxpupuli/modulesync/compare/4.0.1...4.1.0)

data/features/update/pull_request.feature

@@ -88,7 +88,7 @@ Feature: Create a pull-request/merge-request after update
       """
       <%= @configs['name'] %>
       """
-    When I run `msync update --noop --pr`
+    When I run `msync update --message "Update test" --pr`
     Then the stderr should contain "A token is required to use services from gitlab"
     And the exit status should be 1
     And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"

data/lib/modulesync/repository.rb

@@ -32,6 +32,16 @@ module ModuleSync
         repo.diff("#{local_branch}..origin/#{remote_branch}").any?
     end
 
+    # This method checks if the source branch is ahead of the target branch in the remote repository.
+    # It does this by checking if there are any commits in the source branch that are not in the target branch.
+    def remote_branch_ahead?(source_branch, target_branch)
+      return false unless remote_branch_exists?(source_branch) && remote_branch_exists?(target_branch)
+
+      log = repo.log(1).between("origin/#{target_branch}", "origin/#{source_branch}")
+      commits = log.respond_to?(:execute) ? log.execute : log
+      commits.any?
+    end
+
     def default_branch
       # `Git.default_branch` requires ruby-git >= 1.17.0
       return Git.default_branch(repo.dir) if Git.respond_to? :default_branch

data/lib/modulesync/source_code.rb

@@ -68,13 +68,31 @@ module ModuleSync
         namespace: repository_namespace,
         title: ModuleSync.options[:pr_title],
         message: ModuleSync.options[:message],
-        source_branch: ModuleSync.options[:remote_branch] || ModuleSync.options[:branch] || repository.default_branch,
-        target_branch: ModuleSync.options[:pr_target_branch] || repository.default_branch,
+        source_branch: pull_request_source_branch,
+        target_branch: pull_request_target_branch,
         labels: ModuleSync::Util.parse_list(ModuleSync.options[:pr_labels]),
         noop: ModuleSync.options[:noop],
       )
     end
 
+    # This method checks if the pull request branch is ready to be opened.
+    # It does this by checking if the source branch is ahead of the target branch in the remote repository.
+    def pull_request_branch_ready?
+      repository.remote_branch_ahead?(pull_request_source_branch, pull_request_target_branch)
+    end
+
+    # This method returns the source branch for the pull request.
+    # It first checks if the `remote_branch` option is set, then checks if the `branch` option is set, and finally defaults to the repository's default branch.
+    def pull_request_source_branch
+      ModuleSync.options[:remote_branch] || ModuleSync.options[:branch] || repository.default_branch
+    end
+
+    # This method returns the target branch for the pull request.
+    # It first checks if the `pr_target_branch` option is set, and if not, it defaults to the repository's default branch.
+    def pull_request_target_branch
+      ModuleSync.options[:pr_target_branch] || repository.default_branch
+    end
+
     private
 
     def _repository_remote

data/lib/modulesync.rb

@@ -49,8 +49,8 @@ module ModuleSync
   def self.find_template_files(local_template_dir)
     if File.exist?(local_template_dir)
       Find.find(local_template_dir).find_all { |p| p =~ /.erb$/ && !File.directory?(p) }
-          .collect { |p| p.chomp('.erb') }
-          .to_a
+                                   .collect { |p| p.chomp('.erb') }
+                                   .to_a
     else
       warn "#{local_template_dir} does not exist. " \
            'Check that you are working in your module configs directory or ' \
@@ -152,7 +152,7 @@ module ModuleSync
         new = puppet_module.bump(options[:message], options[:changelog])
         puppet_module.repository.tag(new, options[:tag_pattern]) if options[:tag]
       end
-      pushed && options[:pr] && puppet_module.open_pull_request
+      options[:pr] && (pushed || puppet_module.pull_request_branch_ready?) && puppet_module.open_pull_request
     end
   end
 
@@ -174,9 +174,13 @@ module ModuleSync
     local_files = find_template_files(local_template_dir)
     module_files = relative_names(local_files, local_template_dir)
 
+    # Initialize every Git service before updating any repository.
+    # This validates PR credentials before an update can commit or push changes.
+    initialized_modules = managed_modules
+    initialized_modules.each(&:git_service) if options[:pr]
+
     errors = false
-    # managed_modules is either an array or a hash
-    managed_modules.each do |puppet_module|
+    initialized_modules.each do |puppet_module|
       manage_module(puppet_module, module_files, defaults)
     rescue ModuleSync::Error, Git::Error => e
       message = e.message || 'Error during `update`'

data/modulesync.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name                  = 'modulesync'
-  spec.version               = '4.1.0'
+  spec.version               = '4.3.0'
   spec.authors               = ['Vox Pupuli']
   spec.email                 = ['voxpupuli@groups.io']
   spec.summary               = 'Puppet Module Synchronizer'
@@ -19,14 +19,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'aruba', '~>2.0'
-  spec.add_development_dependency 'cucumber', '~> 9.2'
+  spec.add_development_dependency 'cucumber', '~> 11.0'
   spec.add_development_dependency 'rake', '~> 13.2', '>= 13.2.1'
   spec.add_development_dependency 'rspec', '~> 3.13'
-  spec.add_development_dependency 'voxpupuli-rubocop', '~> 4.2.0'
+  spec.add_development_dependency 'voxpupuli-rubocop', '~> 5.2.0'
 
-  spec.add_dependency 'git', '~> 3.0'
-  spec.add_dependency 'gitlab', '>=4', '<6'
-  spec.add_dependency 'octokit', '>=4', '<10'
-  spec.add_dependency 'puppet-blacksmith', '>= 3.0', '< 9'
+  spec.add_dependency 'git', '>= 3.0', '< 5'
+  spec.add_dependency 'gitlab', '>=4', '<7'
+  spec.add_dependency 'octokit', '>=4', '<11'
+  spec.add_dependency 'puppet-blacksmith', '>= 3.0', '< 10'
   spec.add_dependency 'thor', '~> 1.4'
 end

data/spec/unit/module_sync/repository_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe ModuleSync::Repository do
+  subject(:repository) do
+    described_class.new(directory: '/tmp/example', remote: 'https://github.com/example/repository.git')
+  end
+
+  let(:remote_branches) do
+    [
+      instance_double(Git::Branch, name: 'main'),
+      instance_double(Git::Branch, name: 'modulesync'),
+    ]
+  end
+  let(:branches) { instance_double(Git::Branches, remote: remote_branches) }
+  let(:log) { instance_double(Git::Log) }
+  let(:git) { instance_double(Git::Base, branches: branches, log: log) }
+
+  before do
+    repository.instance_variable_set(:@git, git)
+  end
+
+  it 'detects commits on a remote source branch that are missing from the target branch' do
+    allow(log).to receive(:between).with('origin/main', 'origin/modulesync').and_return(log)
+    allow(log).to receive(:execute).and_return([instance_double(Git::Object::Commit)])
+
+    expect(repository.remote_branch_ahead?('modulesync', 'main')).to be true
+  end
+
+  it 'rejects a source branch that does not exist remotely' do
+    remote_branches.pop
+
+    expect(repository.remote_branch_ahead?('modulesync', 'main')).to be false
+  end
+end

data/spec/unit/module_sync/source_code_spec.rb

@@ -7,9 +7,12 @@ describe ModuleSync::SourceCode do
     described_class.new('namespace/name', nil)
   end
 
+  let(:repository) { instance_double(ModuleSync::Repository, default_branch: 'main') }
+
   before do
     options = ModuleSync.config_defaults.merge({ git_base: 'file:///tmp/dummy' })
     ModuleSync.instance_variable_set :@options, options
+    allow(ModuleSync::Repository).to receive(:new).and_return(repository)
   end
 
   it 'has a repository namespace sets to "namespace"' do
@@ -19,4 +22,11 @@ describe ModuleSync::SourceCode do
   it 'has a repository name sets to "name"' do
     expect(subject.repository_name).to eq 'name'
   end
+
+  it 'reports a remote source branch ahead of the PR target as ready' do
+    ModuleSync.options[:branch] = 'modulesync'
+    allow(repository).to receive(:remote_branch_ahead?).with('modulesync', 'main').and_return(true)
+
+    expect(subject.pull_request_branch_ready?).to be true
+  end
 end

data/spec/unit/module_sync_spec.rb

@@ -12,5 +12,56 @@ describe ModuleSync do
       options = { managed_modules_conf: 'test_file.yml' }
       described_class.update(options)
     end
+
+    it 'validates PR credentials for every module before managing any module' do
+      allow(ModuleSync::Util).to receive(:parse_config).with('./config_defaults.yml').and_return({})
+      puppet_module = double
+      allow(described_class).to receive_messages(find_template_files: [], managed_modules: [puppet_module])
+
+      expect(puppet_module).to receive(:git_service).ordered
+      expect(described_class).to receive(:manage_module).with(puppet_module, [], {}).ordered
+
+      described_class.update(pr: true)
+    end
+
+    it 'does not manage modules when PR credentials are missing' do
+      allow(ModuleSync::Util).to receive(:parse_config).with('./config_defaults.yml').and_return({})
+      puppet_module = double
+      allow(described_class).to receive_messages(find_template_files: [], managed_modules: [puppet_module])
+      allow(puppet_module).to receive(:git_service)
+        .and_raise(ModuleSync::GitService::MissingCredentialsError, 'missing token')
+      expect(described_class).not_to receive(:manage_module)
+
+      expect { described_class.update(pr: true) }
+        .to raise_error(ModuleSync::GitService::MissingCredentialsError, 'missing token')
+    end
+  end
+
+  context '::manage_module' do
+    let(:repository) { instance_double(ModuleSync::Repository) }
+    let(:settings) { instance_double(ModuleSync::Settings) }
+    let(:puppet_module) do
+      instance_double(ModuleSync::PuppetModule,
+                      given_name: 'puppet-test',
+                      repository: repository,
+                      repository_name: 'puppet-test',
+                      repository_namespace: 'example')
+    end
+
+    before do
+      described_class.instance_variable_set(:@options, described_class.config_defaults.merge(pr: true))
+      allow(repository).to receive_messages(prepare_workspace: nil, submit_changes: false)
+      allow(puppet_module).to receive(:path).with(ModuleSync::MODULE_CONF_FILE).and_return('module-config.yml')
+      allow(ModuleSync::Util).to receive(:parse_config).with('module-config.yml').and_return({})
+      allow(ModuleSync::Settings).to receive(:new).and_return(settings)
+      allow(settings).to receive_messages(unmanaged_files: [], managed_files: [])
+      allow(puppet_module).to receive(:pull_request_branch_ready?).and_return(true)
+    end
+
+    it 'opens a requested PR for an unchanged branch that is ahead of its target' do
+      expect(puppet_module).to receive(:open_pull_request)
+
+      described_class.manage_module(puppet_module, [], {})
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Vox Pupuli
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.2'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.2'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -77,28 +77,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: gitlab
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +114,7 @@ dependencies:
         version: '4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -118,7 +124,7 @@ dependencies:
         version: '4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +134,7 @@ dependencies:
         version: '4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -138,7 +144,7 @@ dependencies:
         version: '4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: puppet-blacksmith
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +154,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '9'
+        version: '10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -158,7 +164,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '9'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -235,6 +241,7 @@ files:
 - spec/unit/module_sync/git_service/github_spec.rb
 - spec/unit/module_sync/git_service/gitlab_spec.rb
 - spec/unit/module_sync/git_service_spec.rb
+- spec/unit/module_sync/repository_spec.rb
 - spec/unit/module_sync/settings_spec.rb
 - spec/unit/module_sync/source_code_spec.rb
 - spec/unit/module_sync_spec.rb
@@ -256,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Puppet Module Synchronizer
 test_files: []