modulesync 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb584b8ba14d3c54ae9cf5ca91f24e8d1a087e73e45d98e45e79a29f6bbf2578
-  data.tar.gz: c7fcf27f5bd05249da092a80a92b03430909a400b65c8be53671e2ae4a020459
+  metadata.gz: e8c67abecba12a55e8bf400dbdce4899d7ae3588ec7e297c4fe3ed46b7c9ce62
+  data.tar.gz: 0dfcfc208e51892329bab49da6dea0b33a04a5b90dd1769a898e9f82fd8d83eb
 SHA512:
-  metadata.gz: b41beb1d73df97a4e006749788f0c6415f8d87c8e7d69cb07a7f74d202bfda4cf238558060d04044080c9b83b71633d182db506820634b92f86887329169b212
-  data.tar.gz: 38f81a8fe37ff9b30f01f59299deb6de1d47ea03c89ea0d0d6df89b83b19f323b1ecaeab349ca7697bff37d9b9b4c7984c1f63083e22c2d721925a93c0d29559
+  metadata.gz: c113f5bb72bc8f77c0e07383f4ad13975915023ac865a68257eea3990fc888e193d5177d38003cf851d9ca1946ab13234c5642e75889f04cf9e52a3e3ef5f1fa
+  data.tar.gz: f12d610d26f07fc2ec75905a8d9637d88b063ff48f6367dbd04fdeab424052f551d28802300206b5f6ee73bda8ceeac9cf0f7bdb17b5d57f58203eaa6b6003d0

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+---
+name: CI
+on:
+  - pull_request
+  - push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+          - 3.0
+    env:
+      BUNDLE_WITHOUT: release
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake test

data/.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release
+
+on:
+  create:
+    ref_type: tag
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: github.repository == 'voxpupuli/modulesync'
+    env:
+      BUNDLE_WITHOUT: release
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Ruby 3.0
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0'
+      - name: Build gem
+        run: gem build *.gemspec
+      - name: Publish gem to rubygems.org
+        run: gem push *.gem
+        env:
+          GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_AUTH_TOKEN }}'
+      - name: Setup GitHub packages access
+        run: |
+          echo ":github: Bearer ${{ secrets.GITHUB_TOKEN }}" >> ~/.gem/credentials
+          chmod 0600 /home/runner/.gem/credentials
+      - name: Publish gem to GitHub packages
+        run: gem push --key github --host https://rubygems.pkg.github.com/voxpupuli *.gem

data/.rubocop_todo.yml

@@ -1,70 +1,51 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2015-10-07 12:25:07 -0700 using RuboCop version 0.34.2.
+# on 2021-04-22 16:30:35 +0200 using RuboCop version 0.50.0.
 # 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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
+# Offense count: 1
 Lint/UselessAssignment:
   Exclude:
     - 'lib/modulesync.rb'
-    - 'lib/modulesync/cli.rb'
 
-# Offense count: 6
+# Offense count: 10
 Metrics/AbcSize:
-  Max: 64
+  Max: 67
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 107
+  Max: 128
 
-# Offense count: 4
+# Offense count: 3
 Metrics/CyclomaticComplexity:
-  Max: 13
+  Max: 12
 
-# Offense count: 8
+# Offense count: 13
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 79
+  Max: 36
 
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ModuleLength:
-  Max: 140
-
-# Offense count: 4
+# Offense count: 3
 Metrics/PerceivedComplexity:
-  Max: 16
+  Max: 13
 
-# Offense count: 9
-# Configuration parameters: Exclude.
+# Offense count: 8
 Style/Documentation:
   Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
     - 'lib/modulesync.rb'
     - 'lib/modulesync/cli.rb'
-    - 'lib/modulesync/constants.rb'
-    - 'lib/modulesync/git.rb'
     - 'lib/modulesync/hook.rb'
     - 'lib/modulesync/renderer.rb'
     - 'lib/modulesync/util.rb'
 
-# Offense count: 1
-Style/EachWithObject:
-  Exclude:
-    - 'lib/modulesync/util.rb'
-
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    - 'lib/modulesync/cli.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
-# Configuration parameters: AllowAsExpressionSeparator.
-Style/Semicolon:
+Style/EachWithObject:
   Exclude:
     - 'lib/modulesync/util.rb'

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.1.0](https://github.com/voxpupuli/modulesync/tree/2.1.0) (2021-06-15)
+
+[Full Changelog](https://github.com/voxpupuli/modulesync/compare/2.0.2...2.1.0)
+
+**Merged pull requests:**
+
+- publish to github packages + test on ruby 3 [\#222](https://github.com/voxpupuli/modulesync/pull/222) ([bastelfreak](https://github.com/bastelfreak))
+- Rework exception handling [\#217](https://github.com/voxpupuli/modulesync/pull/217) ([neomilium](https://github.com/neomilium))
+- Split generic and specific code [\#215](https://github.com/voxpupuli/modulesync/pull/215) ([neomilium](https://github.com/neomilium))
+- Refactor repository related code [\#214](https://github.com/voxpupuli/modulesync/pull/214) ([neomilium](https://github.com/neomilium))
+- Tests: Add tests for bump feature [\#213](https://github.com/voxpupuli/modulesync/pull/213) ([neomilium](https://github.com/neomilium))
+- Refactor puppet modules properties [\#212](https://github.com/voxpupuli/modulesync/pull/212) ([neomilium](https://github.com/neomilium))
+- Switch from Travis CI to GitHub Actions [\#205](https://github.com/voxpupuli/modulesync/pull/205) ([neomilium](https://github.com/neomilium))
+
 ## [2.0.2](https://github.com/voxpupuli/modulesync/tree/2.0.2) (2021-04-03)
 
 [Full Changelog](https://github.com/voxpupuli/modulesync/compare/2.0.1...2.0.2)

data/features/cli.feature

@@ -35,6 +35,9 @@ Feature: CLI
       """
     And a git_base option appended to "modulesync.yml" for local tests
     And a directory named "moduleroot"
-    When I run `msync update --noop --namespace fakenamespace`
+    When I run `msync update --noop --namespace fakenamespace --branch command-line-branch`
     Then the exit status should be 0
-    And the output should match /Syncing fakenamespace/
+    And the output should contain:
+      """
+      Creating new branch command-line-branch
+      """

data/features/step_definitions/git_steps.rb

@@ -73,3 +73,13 @@ Given 'the puppet module {string} from {string} has the default branch named {st
   pmrr = ModuleSync::Faker::PuppetModuleRemoteRepo.new(name, namespace)
   pmrr.default_branch = default_branch
 end
+
+Then('the puppet module {string} from {string} should have a tag named {string}') do |name, namespace, tag|
+  pmrr = ModuleSync::Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  expect(pmrr.tags).to include(tag)
+end
+
+Then('the puppet module {string} from {string} should not have a tag named {string}') do |name, namespace, tag|
+  pmrr = ModuleSync::Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  expect(pmrr.tags).not_to include(tag)
+end

data/features/update.feature

@@ -300,7 +300,7 @@ Feature: update
       """
     And the output should match:
       """
-      Not managing Gemfile in puppet-test
+      Not managing 'Gemfile' in 'puppet-test'
       """
     And the exit status should be 0
     And the file named "modules/fakenamespace/puppet-test/Gemfile" should contain:
@@ -370,7 +370,7 @@ Feature: update
     When I run `msync update --offline`
     Then the output should contain:
       """
-      Not managing spec/spec_helper.rb in puppet-apache
+      Not managing 'spec/spec_helper.rb' in 'puppet-apache'
       """
     And the exit status should be 0
     And the file named "modules/puppetlabs/puppet-apache/spec/spec_helper.rb" should contain:
@@ -461,6 +461,7 @@ Feature: update
     And a directory named "moduleroot"
     When I run `msync update --message "Running without changes"`
     Then the exit status should be 0
+    And the stdout should contain "There were no changes in 'modules/fakenamespace/puppet-test'. Not committing."
     And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
 
   Scenario: When specifying configurations in managed_modules.yml
@@ -607,7 +608,7 @@ Feature: update
     Then the exit status should be 0
     And the output should match:
       """
-      Not managing spec/spec_helper.rb in puppet-test
+      Not managing 'spec/spec_helper.rb' in 'puppet-test'
       """
     And the file named "modules/fakenamespace/puppet-test/global-test.md" should contain:
       """

data/features/update/bump_version.feature

@@ -0,0 +1,87 @@
+Feature: Bump a new version after an update
+  Scenario: Bump the module version, update changelog and tag it after an update that produces changes
+    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
+    And the puppet module "puppet-test" from "fakenamespace" has a file named "CHANGELOG.md" with:
+      """
+      ## 1965-04-14 - Release 0.4.2
+      """
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      new-file:
+        content: aruba
+      """
+    And a directory named "moduleroot"
+    And a file named "moduleroot/new-file.erb" with:
+      """
+      <%= @configs['content'] %>
+      """
+    When I run `msync update --message "Add new-file" --bump --changelog --tag`
+    Then the exit status should be 0
+    And the file named "modules/fakenamespace/puppet-test/new-file" should contain "aruba"
+    And the stdout should contain:
+      """
+      Bumped to version 0.4.3
+      """
+    And the stdout should contain:
+      """
+      Tagging with 0.4.3
+      """
+    And the file named "modules/fakenamespace/puppet-test/CHANGELOG.md" should contain "0.4.3"
+    And the puppet module "puppet-test" from "fakenamespace" should have 2 commits made by "Aruba"
+    And the puppet module "puppet-test" from "fakenamespace" should have a tag named "0.4.3"
+
+  Scenario: Bump the module version after an update that produces changes
+    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      new-file:
+        content: aruba
+      """
+    And a directory named "moduleroot"
+    And a file named "moduleroot/new-file.erb" with:
+      """
+      <%= @configs['content'] %>
+      """
+    When I run `msync update --message "Add new-file" --bump`
+    Then the exit status should be 0
+    And the file named "modules/fakenamespace/puppet-test/new-file" should contain "aruba"
+    And the stdout should contain:
+      """
+      Bumped to version 0.4.3
+      """
+    And the puppet module "puppet-test" from "fakenamespace" should have 2 commits made by "Aruba"
+    And the puppet module "puppet-test" from "fakenamespace" should not have a tag named "0.4.3"
+
+  Scenario: Bump the module version with changelog update when no CHANGELOG.md is available
+    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      new-file:
+        content: aruba
+      """
+    And a directory named "moduleroot"
+    And a file named "moduleroot/new-file.erb" with:
+      """
+      <%= @configs['content'] %>
+      """
+    When I run `msync update --message "Add new-file" --bump --changelog`
+    Then the exit status should be 0
+    And the file named "modules/fakenamespace/puppet-test/new-file" should contain "aruba"
+    And the stdout should contain:
+      """
+      Bumped to version 0.4.3
+      No CHANGELOG.md file found, not updating.
+      """
+    And the file named "modules/fakenamespace/puppet-test/CHANGELOG.md" should not exist
+    And the puppet module "puppet-test" from "fakenamespace" should have 2 commits made by "Aruba"
+
+  Scenario: Dont bump the module version after an update that produces no changes
+    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
+    And a directory named "moduleroot"
+    When I run `msync update --message "Add new-file" --bump --tag`
+    Then the exit status should be 0
+    And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
+    And the puppet module "puppet-test" from "fakenamespace" should not have a tag named "0.4.3"

data/lib/modulesync.rb

@@ -1,15 +1,19 @@
 require 'fileutils'
 require 'pathname'
+
 require 'modulesync/cli'
 require 'modulesync/constants'
-require 'modulesync/git'
 require 'modulesync/hook'
+require 'modulesync/puppet_module'
 require 'modulesync/renderer'
 require 'modulesync/settings'
 require 'modulesync/util'
+
 require 'monkey_patches'
 
 module ModuleSync # rubocop:disable Metrics/ModuleLength
+  class Error < StandardError; end
+
   include Constants
 
   def self.config_defaults
@@ -21,12 +25,12 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
     }
   end
 
-  def self.local_file(config_path, file)
-    File.join(config_path, MODULE_FILES_DIR, file)
+  def self.options
+    @options
   end
 
-  def self.module_file(project_root, namespace, puppet_module, *parts)
-    File.join(project_root, namespace, puppet_module, *parts)
+  def self.local_file(config_path, file)
+    File.join(config_path, MODULE_FILES_DIR, file)
   end
 
   # List all template files.
@@ -50,7 +54,11 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
     file_list.map { |file| file.sub(/#{path}/, '') }
   end
 
-  def self.managed_modules(config_file, filter, negative_filter)
+  def self.managed_modules
+    config_file = config_path(options[:managed_modules_conf], options)
+    filter = options[:filter]
+    negative_filter = options[:negative_filter]
+
     managed_modules = Util.parse_config(config_file)
     if managed_modules.empty?
       $stderr.puts "No modules found in #{config_file}." \
@@ -59,12 +67,7 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
     end
     managed_modules.select! { |m| m =~ Regexp.new(filter) } unless filter.nil?
     managed_modules.reject! { |m| m =~ Regexp.new(negative_filter) } unless negative_filter.nil?
-    managed_modules
-  end
-
-  def self.module_name(module_name, default_namespace)
-    return [default_namespace, module_name] unless module_name.include?('/')
-    ns, mod = module_name.split('/')
+    managed_modules.map { |given_name, options| PuppetModule.new(given_name, options) }
   end
 
   def self.hook(options)
@@ -78,11 +81,11 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
     end
   end
 
-  def self.manage_file(filename, settings, options)
+  def self.manage_file(puppet_module, filename, settings, options)
     namespace = settings.additional_settings[:namespace]
     module_name = settings.additional_settings[:puppet_module]
     configs = settings.build_file_configs(filename)
-    target_file = module_file(options[:project_root], namespace, module_name, filename)
+    target_file = puppet_module.path(filename)
     if configs['delete']
       Renderer.remove(target_file)
     else
@@ -92,50 +95,52 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
         # Meta data passed to the template as @metadata[:name]
         metadata = {
           :module_name => module_name,
-          :workdir     => module_file(options[:project_root], namespace, module_name),
+          :workdir     => puppet_module.working_directory,
           :target_file => target_file,
         }
         template = Renderer.render(erb, configs, metadata)
         Renderer.sync(template, target_file)
-      rescue # rubocop:disable Lint/RescueWithoutErrorClass
-        $stderr.puts "Error while rendering #{filename}"
+      rescue StandardError => e
+        $stderr.puts "#{puppet_module.given_name}: Error while rendering file: '#{filename}'"
         raise
       end
     end
   end
 
-  def self.manage_module(puppet_module, module_files, module_options, defaults, options)
-    default_namespace = options[:namespace]
-    if module_options.is_a?(Hash) && module_options.key?(:namespace)
-      default_namespace = module_options[:namespace]
-    end
-    namespace, module_name = module_name(puppet_module, default_namespace)
-    git_repo = File.join(namespace, module_name)
-    unless options[:offline]
-      Git.pull(options[:git_base], git_repo, options[:branch], options[:project_root], module_options || {})
-    end
+  def self.manage_module(puppet_module, module_files, defaults)
+    puts "Syncing '#{puppet_module.given_name}'"
+    puppet_module.repository.prepare_workspace(options[:branch]) unless options[:offline]
 
-    module_configs = Util.parse_config(module_file(options[:project_root], namespace, module_name, MODULE_CONF_FILE))
+    module_configs = Util.parse_config puppet_module.path(MODULE_CONF_FILE)
     settings = Settings.new(defaults[GLOBAL_DEFAULTS_KEY] || {},
                             defaults,
                             module_configs[GLOBAL_DEFAULTS_KEY] || {},
                             module_configs,
-                            :puppet_module => module_name,
+                            :puppet_module => puppet_module.repository_name,
                             :git_base => options[:git_base],
-                            :namespace => namespace)
+                            :namespace => puppet_module.repository_namespace)
+
     settings.unmanaged_files(module_files).each do |filename|
-      $stdout.puts "Not managing #{filename} in #{module_name}"
+      $stdout.puts "Not managing '#{filename}' in '#{puppet_module.given_name}'"
     end
 
     files_to_manage = settings.managed_files(module_files)
-    files_to_manage.each { |filename| manage_file(filename, settings, options) }
+    files_to_manage.each { |filename| manage_file(puppet_module, filename, settings, options) }
 
     if options[:noop]
-      Git.update_noop(git_repo, options)
-      options[:pr] && pr(module_options).manage(namespace, module_name, options)
+      puts "Using no-op. Files in '#{puppet_module.given_name}' may be changed but will not be committed."
+      puppet_module.repository.show_changes(options)
+      options[:pr] && \
+        pr(puppet_module).manage(puppet_module.repository_namespace, puppet_module.repository_name, options)
     elsif !options[:offline]
-      pushed = Git.update(git_repo, files_to_manage, options)
-      pushed && options[:pr] && pr(module_options).manage(namespace, module_name, options)
+      pushed = puppet_module.repository.submit_changes(files_to_manage, options)
+      # Only bump/tag if pushing didn't fail (i.e. there were changes)
+      if pushed && options[:bump]
+        new = puppet_module.bump(options[:message], options[:changelog])
+        puppet_module.repository.tag(new, options[:tag_pattern]) if options[:tag]
+      end
+      pushed && options[:pr] && \
+        pr(puppet_module).manage(puppet_module.repository_namespace, puppet_module.repository_name, options)
     end
   end
 
@@ -148,9 +153,10 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
     self.class.config_path(file, options)
   end
 
-  def self.update(options)
-    options = config_defaults.merge(options)
+  def self.update(cli_options)
+    @options = config_defaults.merge(cli_options)
     defaults = Util.parse_config(config_path(CONF_FILE, options))
+
     if options[:pr]
       unless options[:branch]
         $stderr.puts 'A branch must be specified with --branch to use --pr!'
@@ -164,28 +170,28 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
     local_files = find_template_files(local_template_dir)
     module_files = relative_names(local_files, local_template_dir)
 
-    managed_modules = self.managed_modules(config_path(options[:managed_modules_conf], options),
-                                           options[:filter],
-                                           options[:negative_filter])
-
     errors = false
     # managed_modules is either an array or a hash
-    managed_modules.each do |puppet_module, module_options|
+    managed_modules.each do |puppet_module|
       begin
-        mod_options = module_options.nil? ? nil : Util.symbolize_keys(module_options)
-        manage_module(puppet_module, module_files, mod_options, defaults, options)
-      rescue # rubocop:disable Lint/RescueWithoutErrorClass
-        $stderr.puts "Error while updating #{puppet_module}"
+        manage_module(puppet_module, module_files, defaults)
+      rescue ModuleSync::Error, Git::GitExecuteError => e
+        message = e.message || "Error during '#{options[:command]}'"
+        $stderr.puts "#{puppet_module.given_name}: #{message}"
+        exit 1 unless options[:skip_broken]
+        errors = true
+        $stdout.puts "Skipping '#{puppet_module.given_name}' as update process failed"
+      rescue StandardError => e
         raise unless options[:skip_broken]
         errors = true
-        $stdout.puts "Skipping #{puppet_module} as update process failed"
+        $stdout.puts "Skipping '#{puppet_module.given_name}' as update process failed"
       end
     end
     exit 1 if errors && options[:fail_on_warnings]
   end
 
-  def self.pr(module_options)
-    module_options ||= {}
+  def self.pr(puppet_module)
+    module_options = puppet_module.options
     github_conf = module_options[:github]
     gitlab_conf = module_options[:gitlab]
 

data/lib/modulesync/puppet_module.rb

@@ -0,0 +1,37 @@
+require 'puppet_blacksmith'
+
+require 'modulesync/source_code'
+
+module ModuleSync
+  # Provide methods to manipulate puppet module code
+  class PuppetModule < SourceCode
+    def update_changelog(version, message)
+      changelog = path('CHANGELOG.md')
+      if File.exist?(changelog)
+        puts "Updating #{changelog} for version #{version}"
+        changes = File.readlines(changelog)
+        File.open(changelog, 'w') do |f|
+          date = Time.now.strftime('%Y-%m-%d')
+          f.puts "## #{date} - Release #{version}\n\n"
+          f.puts "#{message}\n\n"
+          # Add old lines again
+          f.puts changes
+        end
+        repository.git.add('CHANGELOG.md')
+      else
+        puts 'No CHANGELOG.md file found, not updating.'
+      end
+    end
+
+    def bump(message, changelog = false)
+      m = Blacksmith::Modulefile.new path('metadata.json')
+      new = m.bump!
+      puts "Bumped to version #{new}"
+      repository.git.add('metadata.json')
+      update_changelog(new, message) if changelog
+      repository.git.commit("Release version #{new}")
+      repository.git.push
+      new
+    end
+  end
+end

data/lib/modulesync/repository.rb

@@ -0,0 +1,158 @@
+require 'git'
+
+module ModuleSync
+  # Wrapper for Git in ModuleSync context
+  class Repository
+    def initialize(directory:, remote:)
+      @directory = directory
+      @remote = remote
+    end
+
+    def git
+      @git ||= Git.open @directory
+    end
+
+    # This is an alias to minimize code alteration
+    def repo
+      git
+    end
+
+    def remote_branch_exists?(branch)
+      repo.branches.remote.collect(&:name).include?(branch)
+    end
+
+    def local_branch_exists?(branch)
+      repo.branches.local.collect(&:name).include?(branch)
+    end
+
+    def remote_branch_differ?(local_branch, remote_branch)
+      !remote_branch_exists?(remote_branch) ||
+        repo.diff("#{local_branch}..origin/#{remote_branch}").any?
+    end
+
+    def default_branch
+      symbolic_ref = repo.branches.find { |b| b.full =~ %r{remotes/origin/HEAD} }
+      return unless symbolic_ref
+      %r{remotes/origin/HEAD\s+->\s+origin/(?<branch>.+?)$}.match(symbolic_ref.full)[:branch]
+    end
+
+    def switch_branch(branch)
+      unless branch
+        branch = default_branch
+        puts "Using repository's default branch: #{branch}"
+      end
+      return if repo.current_branch == branch
+
+      if local_branch_exists?(branch)
+        puts "Switching to branch #{branch}"
+        repo.checkout(branch)
+      elsif remote_branch_exists?(branch)
+        puts "Creating local branch #{branch} from origin/#{branch}"
+        repo.checkout("origin/#{branch}")
+        repo.branch(branch).checkout
+      else
+        repo.checkout('origin/master')
+        puts "Creating new branch #{branch}"
+        repo.branch(branch).checkout
+      end
+    end
+
+    def prepare_workspace(branch)
+      # Repo needs to be cloned in the cwd
+      if !Dir.exist?("#{@directory}/.git")
+        puts 'Cloning repository fresh'
+        puts "Cloning from '#{@remote}'"
+        @git = Git.clone(@remote, @directory)
+        switch_branch(branch)
+      # Repo already cloned, check out master and override local changes
+      else
+        # Some versions of git can't properly handle managing a repo from outside the repo directory
+        Dir.chdir(@directory) do
+          puts "Overriding any local changes to repository in '#{@directory}'"
+          @git = Git.open('.')
+          repo.fetch
+          repo.reset_hard
+          switch_branch(branch)
+          git.pull('origin', branch) if remote_branch_exists?(branch)
+        end
+      end
+    end
+
+    def tag(version, tag_pattern)
+      tag = tag_pattern % version
+      puts "Tagging with #{tag}"
+      repo.add_tag(tag)
+      repo.push('origin', tag)
+    end
+
+    def checkout_branch(branch)
+      selected_branch = branch || repo.current_branch || 'master'
+      repo.branch(selected_branch).checkout
+      selected_branch
+    end
+
+    # Git add/rm, git commit, git push
+    def submit_changes(files, options)
+      message = options[:message]
+      branch = checkout_branch(options[:branch])
+      files.each do |file|
+        if repo.status.deleted.include?(file)
+          repo.remove(file)
+        elsif File.exist?("#{@directory}/#{file}")
+          repo.add(file)
+        end
+      end
+      begin
+        opts_commit = {}
+        opts_push = {}
+        opts_commit = { :amend => true } if options[:amend]
+        opts_push = { :force => true } if options[:force]
+        if options[:pre_commit_script]
+          script = "#{File.dirname(File.dirname(__FILE__))}/../contrib/#{options[:pre_commit_script]}"
+          `#{script} #{@directory}`
+        end
+        repo.commit(message, opts_commit)
+        if options[:remote_branch]
+          if remote_branch_differ?(branch, options[:remote_branch])
+            repo.push('origin', "#{branch}:#{options[:remote_branch]}", opts_push)
+          end
+        else
+          repo.push('origin', branch, opts_push)
+        end
+      rescue Git::GitExecuteError => e
+        raise unless e.message.match?(/working (directory|tree) clean/)
+
+        puts "There were no changes in '#{@directory}'. Not committing."
+        return false
+      end
+
+      true
+    end
+
+    # Needed because of a bug in the git gem that lists ignored files as
+    # untracked under some circumstances
+    # https://github.com/schacon/ruby-git/issues/130
+    def untracked_unignored_files
+      ignore_path = "#{@directory}/.gitignore"
+      ignored = File.exist?(ignore_path) ? File.read(ignore_path).split : []
+      repo.status.untracked.keep_if { |f, _| ignored.none? { |i| File.fnmatch(i, f) } }
+    end
+
+    def show_changes(options)
+      checkout_branch(options[:branch])
+
+      puts 'Files changed:'
+      repo.diff('HEAD', '--').each do |diff|
+        puts diff.patch
+      end
+
+      puts 'Files added:'
+      untracked_unignored_files.each_key do |file|
+        puts file
+      end
+
+      puts "\n\n"
+      puts '--------------------------------'
+    end
+  end
+end

data/lib/modulesync/source_code.rb

@@ -0,0 +1,57 @@
+require 'modulesync'
+require 'modulesync/repository'
+require 'modulesync/util'
+
+module ModuleSync
+  # Provide methods to retrieve source code attributes
+  class SourceCode
+    attr_reader :given_name
+    attr_reader :options
+
+    def initialize(given_name, options)
+      @options = Util.symbolize_keys(options || {})
+
+      @given_name = given_name
+
+      return unless given_name.include?('/')
+
+      @repository_name = given_name.split('/').last
+      @repository_namespace = given_name.split('/')[0...-1].join('/')
+    end
+
+    def repository
+      @repository ||= Repository.new directory: working_directory, remote: repository_remote
+    end
+
+    def repository_name
+      @repository_name ||= given_name
+    end
+
+    def repository_namespace
+      @repository_namespace ||= @options[:namespace] || ModuleSync.options[:namespace]
+    end
+
+    def repository_path
+      @repository_path ||= "#{repository_namespace}/#{repository_name}"
+    end
+
+    def repository_remote
+      @repository_remote ||= @options[:remote] || _repository_remote
+    end
+
+    def working_directory
+      @working_directory ||= File.join(ModuleSync.options[:project_root], repository_path)
+    end
+
+    def path(*parts)
+      File.join(working_directory, *parts)
+    end
+
+    private
+
+    def _repository_remote
+      git_base = ModuleSync.options[:git_base]
+      git_base.start_with?('file://') ? "#{git_base}#{repository_path}" : "#{git_base}#{repository_path}.git"
+    end
+  end
+end

data/modulesync.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name                  = 'modulesync'
-  spec.version               = '2.0.2'
+  spec.version               = '2.1.0'
   spec.authors               = ['Vox Pupuli']
   spec.email                 = ['voxpupuli@groups.io']
   spec.summary               = 'Puppet Module Synchronizer'

data/spec/helpers/faker/puppet_module_remote_repo.rb

@@ -99,6 +99,12 @@ module ModuleSync
         end
       end
 
+      def tags
+        FileUtils.chdir(bare_repo_dir) do
+          return run %w{git tag --list}
+        end
+      end
+
       def remote_url
         "file://#{bare_repo_dir}"
       end

data/spec/unit/modulesync_spec.rb

@@ -5,7 +5,7 @@ describe ModuleSync do
     it 'loads the managed modules from the specified :managed_modules_conf' do
       allow(ModuleSync).to receive(:find_template_files).and_return([])
       allow(ModuleSync::Util).to receive(:parse_config).with('./config_defaults.yml').and_return({})
-      expect(ModuleSync).to receive(:managed_modules).with('./test_file.yml', nil, nil).and_return([])
+      expect(ModuleSync).to receive(:managed_modules).with(no_args).and_return([])
 
       options = { managed_modules_conf: 'test_file.yml' }
       ModuleSync.update(options)
@@ -14,8 +14,12 @@ describe ModuleSync do
 
   context '::pr' do
     describe "Raise Error" do
+      let(:puppet_module) do
+        ModuleSync::PuppetModule.new 'puppet-test', remote: 'dummy'
+      end
+
       it 'raises an error when neither GITHUB_TOKEN nor GITLAB_TOKEN are set for PRs' do
-        expect { ModuleSync.pr({}) }.to raise_error(RuntimeError).and output(/No GitHub or GitLab token specified for --pr/).to_stderr
+        expect { ModuleSync.pr(puppet_module) }.to raise_error(RuntimeError).and output(/No GitHub or GitLab token specified for --pr/).to_stderr
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-03 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -165,11 +165,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".config/cucumber.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - HISTORY.md
@@ -184,16 +185,19 @@ files:
 - features/support/env.rb
 - features/update.feature
 - features/update/bad_context.feature
+- features/update/bump_version.feature
 - lib/modulesync.rb
 - lib/modulesync/cli.rb
 - lib/modulesync/cli/thor.rb
 - lib/modulesync/constants.rb
-- lib/modulesync/git.rb
 - lib/modulesync/hook.rb
 - lib/modulesync/pr/github.rb
 - lib/modulesync/pr/gitlab.rb
+- lib/modulesync/puppet_module.rb
 - lib/modulesync/renderer.rb
+- lib/modulesync/repository.rb
 - lib/modulesync/settings.rb
+- lib/modulesync/source_code.rb
 - lib/modulesync/util.rb
 - lib/monkey_patches.rb
 - modulesync.gemspec
@@ -223,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Puppet Module Synchronizer
@@ -234,6 +238,7 @@ test_files:
 - features/support/env.rb
 - features/update.feature
 - features/update/bad_context.feature
+- features/update/bump_version.feature
 - spec/helpers/faker.rb
 - spec/helpers/faker/puppet_module_remote_repo.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1,28 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-dist: focal
-script: 'bundle exec rake test'
-bundler_args: --without release
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-notifications:
-  email: false
-  irc:
-    on_success: always
-    on_failure: always
-    channels:
-      - "chat.freenode.org#voxpupuli-notifications"
-deploy:
-  provider: rubygems
-  api_key:
-    secure: "Tbf1EbLEobIIox+fftJZADZsfQQ6kl0urcMNetK7NJzFo/negD/WyJIUj3kro/B7buyYADEjTui/JR4o8EPbugfM3ie5vYOd5k3AesSzbdr4BSwGe/cGbGOB7/PZuGfFLkb94/FiCU2mIwibkbh1rHWGlBoPj7ntL0+5ZtdvsM4="
-  gem: modulesync
-  on:
-    rvm: 2.7
-    tags: true
-    all_branches: true
-    repo: voxpupuli/modulesync

data/lib/modulesync/git.rb

@@ -1,194 +0,0 @@
-require 'git'
-require 'puppet_blacksmith'
-
-module ModuleSync
-  module Git # rubocop:disable Metrics/ModuleLength
-    include Constants
-
-    def self.remote_branch_exists?(repo, branch)
-      repo.branches.remote.collect(&:name).include?(branch)
-    end
-
-    def self.local_branch_exists?(repo, branch)
-      repo.branches.local.collect(&:name).include?(branch)
-    end
-
-    def self.remote_branch_differ?(repo, local_branch, remote_branch)
-      !remote_branch_exists?(repo, remote_branch) ||
-        repo.diff("#{local_branch}..origin/#{remote_branch}").any?
-    end
-
-    def self.default_branch(repo)
-      symbolic_ref = repo.branches.find { |b| b.full =~ %r{remotes/origin/HEAD} }
-      return unless symbolic_ref
-      %r{remotes/origin/HEAD\s+->\s+origin/(?<branch>.+?)$}.match(symbolic_ref.full)[:branch]
-    end
-
-    def self.switch_branch(repo, branch)
-      unless branch
-        branch = default_branch(repo)
-        puts "Using repository's default branch: #{branch}"
-      end
-      return if repo.current_branch == branch
-
-      if local_branch_exists?(repo, branch)
-        puts "Switching to branch #{branch}"
-        repo.checkout(branch)
-      elsif remote_branch_exists?(repo, branch)
-        puts "Creating local branch #{branch} from origin/#{branch}"
-        repo.checkout("origin/#{branch}")
-        repo.branch(branch).checkout
-      else
-        repo.checkout('origin/master')
-        puts "Creating new branch #{branch}"
-        repo.branch(branch).checkout
-      end
-    end
-
-    def self.pull(git_base, name, branch, project_root, opts)
-      puts "Syncing #{name}"
-      Dir.mkdir(project_root) unless Dir.exist?(project_root)
-
-      # Repo needs to be cloned in the cwd
-      if !Dir.exist?("#{project_root}/#{name}") || !Dir.exist?("#{project_root}/#{name}/.git")
-        puts 'Cloning repository fresh'
-        remote = opts[:remote] || (git_base.start_with?('file://') ? "#{git_base}#{name}" : "#{git_base}#{name}.git")
-        local = "#{project_root}/#{name}"
-        puts "Cloning from #{remote}"
-        repo = ::Git.clone(remote, local)
-        switch_branch(repo, branch)
-      # Repo already cloned, check out master and override local changes
-      else
-        # Some versions of git can't properly handle managing a repo from outside the repo directory
-        Dir.chdir("#{project_root}/#{name}") do
-          puts "Overriding any local changes to repositories in #{project_root}"
-          repo = ::Git.open('.')
-          repo.fetch
-          repo.reset_hard
-          switch_branch(repo, branch)
-          repo.pull('origin', branch) if remote_branch_exists?(repo, branch)
-        end
-      end
-    end
-
-    def self.update_changelog(repo, version, message, module_root)
-      changelog = "#{module_root}/CHANGELOG.md"
-      if File.exist?(changelog)
-        puts "Updating #{changelog} for version #{version}"
-        changes = File.readlines(changelog)
-        File.open(changelog, 'w') do |f|
-          date = Time.now.strftime('%Y-%m-%d')
-          f.puts "## #{date} - Release #{version}\n\n"
-          f.puts "#{message}\n\n"
-          # Add old lines again
-          f.puts changes
-        end
-        repo.add('CHANGELOG.md')
-      else
-        puts 'No CHANGELOG.md file found, not updating.'
-      end
-    end
-
-    def self.bump(repo, m, message, module_root, changelog = false)
-      new = m.bump!
-      puts "Bumped to version #{new}"
-      repo.add('metadata.json')
-      update_changelog(repo, new, message, module_root) if changelog
-      repo.commit("Release version #{new}")
-      repo.push
-      new
-    end
-
-    def self.tag(repo, version, tag_pattern)
-      tag = tag_pattern % version
-      puts "Tagging with #{tag}"
-      repo.add_tag(tag)
-      repo.push('origin', tag)
-    end
-
-    def self.checkout_branch(repo, branch)
-      selected_branch = branch || repo.current_branch || 'master'
-      repo.branch(selected_branch).checkout
-      selected_branch
-    end
-    private_class_method :checkout_branch
-
-    # Git add/rm, git commit, git push
-    def self.update(name, files, options)
-      module_root = "#{options[:project_root]}/#{name}"
-      message = options[:message]
-      repo = ::Git.open(module_root)
-      branch = checkout_branch(repo, options[:branch])
-      files.each do |file|
-        if repo.status.deleted.include?(file)
-          repo.remove(file)
-        elsif File.exist?("#{module_root}/#{file}")
-          repo.add(file)
-        end
-      end
-      begin
-        opts_commit = {}
-        opts_push = {}
-        opts_commit = { :amend => true } if options[:amend]
-        opts_push = { :force => true } if options[:force]
-        if options[:pre_commit_script]
-          script = "#{File.dirname(File.dirname(__FILE__))}/../contrib/#{options[:pre_commit_script]}"
-          `#{script} #{module_root}`
-        end
-        repo.commit(message, opts_commit)
-        if options[:remote_branch]
-          if remote_branch_differ?(repo, branch, options[:remote_branch])
-            repo.push('origin', "#{branch}:#{options[:remote_branch]}", opts_push)
-          end
-        else
-          repo.push('origin', branch, opts_push)
-        end
-        # Only bump/tag if pushing didn't fail (i.e. there were changes)
-        m = Blacksmith::Modulefile.new("#{module_root}/metadata.json")
-        if options[:bump]
-          new = bump(repo, m, message, module_root, options[:changelog])
-          tag(repo, new, options[:tag_pattern]) if options[:tag]
-        end
-      rescue ::Git::GitExecuteError => git_error
-        if git_error.message.match?(/working (directory|tree) clean/)
-          puts "There were no files to update in #{name}. Not committing."
-          return false
-        else
-          puts git_error
-          raise
-        end
-      end
-
-      true
-    end
-
-    # Needed because of a bug in the git gem that lists ignored files as
-    # untracked under some circumstances
-    # https://github.com/schacon/ruby-git/issues/130
-    def self.untracked_unignored_files(repo)
-      ignore_path = "#{repo.dir.path}/.gitignore"
-      ignored = File.exist?(ignore_path) ? File.read(ignore_path).split : []
-      repo.status.untracked.keep_if { |f, _| ignored.none? { |i| File.fnmatch(i, f) } }
-    end
-
-    def self.update_noop(name, options)
-      puts "Using no-op. Files in #{name} may be changed but will not be committed."
-
-      repo = ::Git.open("#{options[:project_root]}/#{name}")
-      checkout_branch(repo, options[:branch])
-
-      puts 'Files changed:'
-      repo.diff('HEAD', '--').each do |diff|
-        puts diff.patch
-      end
-
-      puts 'Files added:'
-      untracked_unignored_files(repo).each_key do |file|
-        puts file
-      end
-
-      puts "\n\n"
-      puts '--------------------------------'
-    end
-  end
-end