modulesync 2.0.1 → 2.0.2

data/features/update/bad_context.feature

@@ -0,0 +1,26 @@
+Feature: Run `msync update` without a good context
+
+  Scenario: Run `msync update` without any module
+    Given a directory named "moduleroot"
+    When I run `msync update --message "In a bad context"`
+    Then the exit status should be 1
+    And the stderr should contain:
+      """
+      No modules found
+      """
+
+  Scenario: Run `msync update` without the "moduleroot" directory
+    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
+    When I run `msync update --message "In a bad context"`
+    Then the exit status should be 1
+    And the stderr should contain "moduleroot"
+
+  Scenario: Run `msync update` without commit message
+    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
+    And a directory named "moduleroot"
+    When I run `msync update`
+    Then the exit status should be 1
+    And the stderr should contain:
+      """
+      No value provided for required option "--message"
+      """

data/lib/modulesync.rb

@@ -39,10 +39,10 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
           .collect { |p| p.chomp('.erb') }
           .to_a
     else
-      $stdout.puts "#{local_template_dir} does not exist." \
+      $stderr.puts "#{local_template_dir} does not exist." \
         ' Check that you are working in your module configs directory or' \
         ' that you have passed in the correct directory with -c.'
-      exit
+      exit 1
     end
   end
 
@@ -53,9 +53,9 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
   def self.managed_modules(config_file, filter, negative_filter)
     managed_modules = Util.parse_config(config_file)
     if managed_modules.empty?
-      $stdout.puts "No modules found in #{config_file}." \
+      $stderr.puts "No modules found in #{config_file}." \
         ' Check that you specified the right :configs directory and :managed_modules_conf file.'
-      exit
+      exit 1
     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?

data/lib/modulesync/cli.rb

@@ -1,10 +1,12 @@
 require 'thor'
+
 require 'modulesync'
+require 'modulesync/cli/thor'
 require 'modulesync/constants'
 require 'modulesync/util'
 
 module ModuleSync
-  class CLI
+  module CLI
     def self.defaults
       @defaults ||= Util.symbolize_keys(Util.parse_config(Constants::MODULESYNC_CONF_FILE))
     end
@@ -36,15 +38,14 @@ module ModuleSync
     class Base < Thor
       class_option :project_root,
                    :aliases => '-c',
-                   :desc => 'Path used by git to clone modules into. Defaults to "modules"',
+                   :desc => 'Path used by git to clone modules into.',
                    :default => CLI.defaults[:project_root] || 'modules'
       class_option :git_base,
                    :desc => 'Specify the base part of a git URL to pull from',
                    :default => CLI.defaults[:git_base] || 'git@github.com:'
       class_option :namespace,
                    :aliases => '-n',
-                   :desc => 'Remote github namespace (user or organization) to clone from and push to.' \
-                              ' Defaults to puppetlabs',
+                   :desc => 'Remote github namespace (user or organization) to clone from and push to.',
                    :default => CLI.defaults[:namespace] || 'puppetlabs'
       class_option :filter,
                    :aliases => '-f',

data/lib/modulesync/cli/thor.rb

@@ -0,0 +1,24 @@
+require 'thor'
+require 'modulesync/cli'
+
+module ModuleSync
+  module CLI
+    # Workaround some, still unfixed, Thor behaviors
+    #
+    # This class extends ::Thor class to
+    # - exit with status code sets to `1` on Thor failure (e.g. missing required option)
+    # - exit with status code sets to `1` when user calls `msync` (or a subcommand) without required arguments
+    class Thor < ::Thor
+      desc '_invalid_command_call', 'Invalid command', hide: true
+      def _invalid_command_call
+        self.class.new.help
+        exit 1
+      end
+      default_task :_invalid_command_call
+
+      def self.exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/modulesync/git.rb

@@ -150,7 +150,7 @@ module ModuleSync
           tag(repo, new, options[:tag_pattern]) if options[:tag]
         end
       rescue ::Git::GitExecuteError => git_error
-        if git_error.message =~ /working (directory|tree) clean/
+        if git_error.message.match?(/working (directory|tree) clean/)
           puts "There were no files to update in #{name}. Not committing."
           return false
         else

data/lib/monkey_patches.rb

@@ -1,55 +1,16 @@
 module Git
-  class Diff
-    # Monkey patch process_full_diff until https://github.com/schacon/ruby-git/issues/326 is resolved
-    def process_full_diff
-      defaults = {
-        :mode => '',
-        :src => '',
-        :dst => '',
-        :type => 'modified'
-      }
-      final = {}
-      current_file = nil
-      full_diff_utf8_encoded = @full_diff.encode("UTF-8", "binary", {
-    :invalid => :replace,
-    :undef => :replace
-  })
-      full_diff_utf8_encoded.split("\n").each do |line|
-        if m = /^diff --git a\/(.*?) b\/(.*?)/.match(line)
-          current_file = m[1]
-          final[current_file] = defaults.merge({:patch => line, :path => current_file})
-        elsif !current_file.nil?
-          if m = /^index (.......)\.\.(.......)( ......)*/.match(line)
-            final[current_file][:src] = m[1]
-            final[current_file][:dst] = m[2]
-            final[current_file][:mode] = m[3].strip if m[3]
-          end
-          if m = /^([[:alpha:]]*?) file mode (......)/.match(line)
-            final[current_file][:type] = m[1]
-            final[current_file][:mode] = m[2]
-          end
-          if m = /^Binary files /.match(line)
-            final[current_file][:binary] = true
-          end
-          final[current_file][:patch] << "\n" + line
-        end
-      end
-      final.map { |e| [e[0], DiffFile.new(@base, e[1])] }
+  module LibMonkeyPatch
+    # Monkey patch set_custom_git_env_variables due to our ::Git::GitExecuteError handling.
+    #
+    # We rescue on the GitExecuteError and proceed differently based on the output of git.
+    # This way makes code language-dependent, so here we ensure that Git gem throw git commands with the "C" language
+    def set_custom_git_env_variables
+      super
+      ENV['LANG'] = 'C.UTF-8'
     end
   end
 
   class Lib
-    # Monkey patch ls_files until https://github.com/ruby-git/ruby-git/pull/320 is resolved
-    def ls_files(location=nil)
-      location ||= '.'
-      hsh = {}
-      command_lines('ls-files', ['--stage', location]).each do |line|
-        (info, file) = line.split("\t")
-        (mode, sha, stage) = info.split
-        file = eval(file) if file =~ /^\".*\"$/ # This takes care of quoted strings returned from git
-        hsh[file] = {:path => file, :mode_index => mode, :sha_index => sha, :stage => stage}
-      end
-      hsh
-    end
+    prepend LibMonkeyPatch
   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.1'
+  spec.version               = '2.0.2'
   spec.authors               = ['Vox Pupuli']
   spec.email                 = ['voxpupuli@groups.io']
   spec.summary               = 'Puppet Module Synchronizer'
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop', '~> 0.50.0'
 
-  spec.add_runtime_dependency 'git', '~>1.3'
+  spec.add_runtime_dependency 'git', '~>1.7'
   spec.add_runtime_dependency 'gitlab', '~>4.0'
   spec.add_runtime_dependency 'octokit', '~>4.0'
   spec.add_runtime_dependency 'puppet-blacksmith', '>= 3.0', '< 7'

data/spec/helpers/faker.rb

@@ -0,0 +1,14 @@
+module ModuleSync
+  # Faker is a top-level module to keep global faker config
+  module Faker
+    def self.working_directory=(path)
+      @working_directory = path
+    end
+
+    def self.working_directory
+      raise 'Working directory must be set' if @working_directory.nil?
+      FileUtils.mkdir_p @working_directory
+      @working_directory
+    end
+  end
+end

data/spec/helpers/faker/puppet_module_remote_repo.rb

@@ -0,0 +1,140 @@
+require 'open3'
+
+require_relative '../faker'
+
+module ModuleSync
+  # Fake a remote git repository that holds a puppet module
+  #
+  # This module allows to fake a remote repositiory using:
+  #  - a bare repo
+  #  - a temporary cloned repo to operate on the remote before exposing to modulesync
+  #
+  # Note: This module needs to have working_directory sets before using it
+  module Faker
+    class PuppetModuleRemoteRepo
+      class CommandExecutionError < StandardError; end
+
+      attr_reader :name, :namespace
+
+      def initialize(name, namespace)
+        @name = name
+        @namespace = namespace
+      end
+
+      def populate
+        FileUtils.chdir(Faker.working_directory) do
+          run %W[git init --bare #{bare_repo_dir}]
+          run %W[git clone #{bare_repo_dir} #{tmp_repo_dir}]
+
+          module_short_name = name.split('-').last
+
+          FileUtils.chdir(tmp_repo_dir) do
+            metadata = {
+              name: "modulesync-#{module_short_name}",
+              version: '0.4.2',
+              author: 'ModuleSync team',
+            }
+
+            File.write 'metadata.json', metadata.to_json
+            run %w[git add metadata.json]
+            run %w[git commit --message] << 'Initial commit'
+            run %w[git push]
+          end
+        end
+      end
+
+      def read_only=(value)
+        mode = value ? '0444' : '0644'
+        FileUtils.chdir(bare_repo_dir) do
+          run %W[git config core.sharedRepository #{mode}]
+        end
+      end
+
+      def default_branch
+        FileUtils.chdir(bare_repo_dir) do
+          stdout = run %w[git symbolic-ref --short HEAD]
+          return stdout.chomp
+        end
+      end
+
+      def default_branch=(value)
+        FileUtils.chdir(bare_repo_dir) do
+          run %W[git branch -M #{default_branch} #{value}]
+          run %W[git symbolic-ref HEAD refs/heads/#{value}]
+        end
+      end
+
+      def read_file(filename, branch = nil)
+        branch ||= default_branch
+        FileUtils.chdir(bare_repo_dir) do
+          return run %W[git show #{branch}:#{filename}]
+        rescue CommandExecutionError
+          return nil
+        end
+      end
+
+      def add_file(filename, content, branch = nil)
+        branch ||= default_branch
+        FileUtils.chdir(tmp_repo_dir) do
+          run %W[git checkout #{branch}]
+          File.write filename, content
+          run %W[git add #{filename}]
+          run %w[git commit --message] << "Add file: '#{filename}'"
+          run %w[git push]
+        end
+      end
+
+      def commit_count_between(commit1, commit2)
+        FileUtils.chdir(bare_repo_dir) do
+          stdout = run %W[git rev-list --count #{commit1}..#{commit2}]
+          return Integer(stdout)
+        end
+      end
+
+      def commit_count_by(author, commit = nil)
+        FileUtils.chdir(bare_repo_dir) do
+          commit ||= '--all'
+          stdout = run %W[git rev-list #{commit} --author #{author} --count]
+          return Integer(stdout)
+        end
+      end
+
+      def remote_url
+        "file://#{bare_repo_dir}"
+      end
+
+      def self.git_base
+        "file://#{Faker.working_directory}/bare/"
+      end
+
+      private
+
+      def tmp_repo_dir
+        File.join Faker.working_directory, 'tmp', namespace, name
+      end
+
+      def bare_repo_dir
+        File.join Faker.working_directory, 'bare', namespace, "#{name}.git"
+      end
+
+      GIT_ENV = {
+        'GIT_AUTHOR_NAME' => 'Faker',
+        'GIT_AUTHOR_EMAIL' => 'faker@example.com',
+        'GIT_COMMITTER_NAME' => 'Faker',
+        'GIT_COMMITTER_EMAIL' => 'faker@example.com',
+      }.freeze
+
+      def run(command)
+        stdout, stderr, status = Open3.capture3(GIT_ENV, *command)
+        return stdout if status.success?
+
+        warn "Command '#{command}' failed: #{status}"
+        warn '  STDOUT:'
+        warn stdout
+        warn '  STDERR:'
+        warn stderr
+        raise CommandExecutionError, "Command '#{command}' failed: #{status}"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2021-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: gitlab
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".config/cucumber.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -182,8 +183,10 @@ files:
 - features/step_definitions/git_steps.rb
 - features/support/env.rb
 - features/update.feature
+- features/update/bad_context.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
@@ -194,6 +197,8 @@ files:
 - lib/modulesync/util.rb
 - lib/monkey_patches.rb
 - modulesync.gemspec
+- spec/helpers/faker.rb
+- spec/helpers/faker/puppet_module_remote_repo.rb
 - spec/spec_helper.rb
 - spec/unit/modulesync/pr/github_spec.rb
 - spec/unit/modulesync/pr/gitlab_spec.rb
@@ -228,6 +233,9 @@ test_files:
 - features/step_definitions/git_steps.rb
 - features/support/env.rb
 - features/update.feature
+- features/update/bad_context.feature
+- spec/helpers/faker.rb
+- spec/helpers/faker/puppet_module_remote_repo.rb
 - spec/spec_helper.rb
 - spec/unit/modulesync/pr/github_spec.rb
 - spec/unit/modulesync/pr/gitlab_spec.rb