modulesync 2.0.1 → 2.2.0

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/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,12 +3,12 @@ $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.2.0'
   spec.authors               = ['Vox Pupuli']
   spec.email                 = ['voxpupuli@groups.io']
   spec.summary               = 'Puppet Module Synchronizer'
   spec.description           = 'Utility to synchronize common files across puppet modules in Github.'
-  spec.homepage              = 'http://github.com/voxpupuli/modulesync'
+  spec.homepage              = 'https://github.com/voxpupuli/modulesync'
   spec.license               = 'Apache-2.0'
   spec.required_ruby_version = '>= 2.5.0'
 
@@ -17,13 +17,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'aruba', '~> 0.14'
+  spec.add_development_dependency 'aruba', '>= 0.14', '< 2'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop', '~> 0.50.0'
+  spec.add_development_dependency 'cucumber'
 
-  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,146 @@
+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 tags
+        FileUtils.chdir(bare_repo_dir) do
+          return run %w{git tag --list}
+        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

data/spec/spec_helper.rb

@@ -1 +1,25 @@
+begin
+  require 'simplecov'
+  require 'simplecov-console'
+  require 'codecov'
+rescue LoadError
+else
+  SimpleCov.start do
+    track_files 'lib/**/*.rb'
+
+    add_filter '/spec'
+
+    enable_coverage :branch
+
+    # do not track vendored files
+    add_filter '/vendor'
+    add_filter '/.vendor'
+  end
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::Console,
+    SimpleCov::Formatter::Codecov,
+  ]
+end
+
 require 'modulesync'

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,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2021-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +86,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
     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,11 +184,13 @@ executables:
 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
@@ -182,24 +204,31 @@ files:
 - features/step_definitions/git_steps.rb
 - 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
+- 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
 - spec/unit/modulesync/settings_spec.rb
 - spec/unit/modulesync_spec.rb
-homepage: http://github.com/voxpupuli/modulesync
+homepage: https://github.com/voxpupuli/modulesync
 licenses:
 - Apache-2.0
 metadata: {}
@@ -218,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Puppet Module Synchronizer
@@ -228,6 +257,10 @@ test_files:
 - features/step_definitions/git_steps.rb
 - 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
 - spec/unit/modulesync/pr/github_spec.rb
 - spec/unit/modulesync/pr/gitlab_spec.rb