modulesync 1.1.0 → 2.0.2

data/modulesync.gemspec

@@ -3,14 +3,14 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name                  = 'modulesync'
-  spec.version               = '1.1.0'
+  spec.version               = '2.0.2'
   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.license               = 'Apache-2.0'
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.5.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -23,8 +23,9 @@ 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'
+  spec.add_runtime_dependency 'puppet-blacksmith', '>= 3.0', '< 7'
   spec.add_runtime_dependency 'thor'
 end

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

data/spec/unit/modulesync/pr/github_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'modulesync/pr/github'
+
+describe ModuleSync::PR::GitHub do
+  context '::manage' do
+    before(:each) do
+      @git_repo = 'test/modulesync'
+      @namespace, @repo_name = @git_repo.split('/')
+      @options = {
+        :pr => true,
+        :pr_title => 'Test PR is submitted',
+        :branch => 'test',
+        :message => 'Hello world',
+        :pr_auto_merge => false,
+      }
+
+      @client = double()
+      allow(Octokit::Client).to receive(:new).and_return(@client)
+      @it = ModuleSync::PR::GitHub.new('test', 'https://api.github.com')
+    end
+
+    it 'submits PR when --pr is set' do
+      allow(@client).to receive(:pull_requests).with(@git_repo, :state => 'open', :base => 'master', :head => "#{@namespace}:#{@options[:branch]}").and_return([])
+      expect(@client).to receive(:create_pull_request).with(@git_repo, 'master', @options[:branch], @options[:pr_title], @options[:message]).and_return({"html_url" => "http://example.com/pulls/22"})
+      expect { @it.manage(@namespace, @repo_name, @options) }.to output(/Submitted PR/).to_stdout
+    end
+
+    it 'skips submitting PR if one has already been issued' do
+      pr = {
+        "title" => "Test title",
+        "html_url" => "https://example.com/pulls/44",
+        "number" => "44"
+      }
+
+      expect(@client).to receive(:pull_requests).with(@git_repo, :state => 'open', :base => 'master', :head => "#{@namespace}:#{@options[:branch]}").and_return([pr])
+      expect { @it.manage(@namespace, @repo_name, @options) }.to output(/Skipped! 1 PRs found for branch test/).to_stdout
+    end
+
+    it 'adds labels to PR when --pr-labels is set' do
+      @options[:pr_labels] = "HELLO,WORLD"
+
+      allow(@client).to receive(:create_pull_request).and_return({"html_url" => "http://example.com/pulls/22", "number" => "44"})
+      allow(@client).to receive(:pull_requests).with(@git_repo, :state => 'open', :base => 'master', :head => "#{@namespace}:#{@options[:branch]}").and_return([])
+
+      expect(@client).to receive(:add_labels_to_an_issue).with(@git_repo, "44", ["HELLO", "WORLD"])
+      expect { @it.manage(@namespace, @repo_name, @options) }.to output(/Attaching the following labels to PR 44: HELLO, WORLD/).to_stdout
+    end
+  end
+end

data/spec/unit/modulesync/pr/gitlab_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'modulesync/pr/gitlab'
+
+describe ModuleSync::PR::GitLab do
+  context '::manage' do
+    before(:each) do
+      @git_repo = 'test/modulesync'
+      @namespace, @repo_name = @git_repo.split('/')
+      @options = {
+        :pr => true,
+        :pr_title => 'Test PR is submitted',
+        :branch => 'test',
+        :message => 'Hello world',
+        :pr_auto_merge => false,
+      }
+
+      @client = double()
+      allow(Gitlab::Client).to receive(:new).and_return(@client)
+      @it = ModuleSync::PR::GitLab.new('test', 'https://gitlab.com/api/v4')
+    end
+
+    it 'submits MR when --pr is set' do
+      allow(@client).to receive(:merge_requests)
+        .with(@git_repo,
+              :state => 'opened',
+              :source_branch => "#{@namespace}:#{@options[:branch]}",
+              :target_branch => 'master',
+             ).and_return([])
+
+      expect(@client).to receive(:create_merge_request)
+        .with(@git_repo,
+              @options[:pr_title],
+              :labels => [],
+              :source_branch => @options[:branch],
+              :target_branch => 'master',
+             ).and_return({"html_url" => "http://example.com/pulls/22"})
+
+      expect { @it.manage(@namespace, @repo_name, @options) }.to output(/Submitted MR/).to_stdout
+    end
+
+    it 'skips submitting MR if one has already been issued' do
+      mr = {
+        "title" => "Test title",
+        "html_url" => "https://example.com/pulls/44",
+        "iid" => "44"
+      }
+
+      expect(@client).to receive(:merge_requests)
+        .with(@git_repo,
+              :state => 'opened',
+              :source_branch => "#{@namespace}:#{@options[:branch]}",
+              :target_branch => 'master',
+             ).and_return([mr])
+
+      expect { @it.manage(@namespace, @repo_name, @options) }.to output(/Skipped! 1 MRs found for branch test/).to_stdout
+    end
+
+    it 'adds labels to MR when --pr-labels is set' do
+      @options[:pr_labels] = "HELLO,WORLD"
+      mr = double()
+      allow(mr).to receive(:iid).and_return("42")
+
+      expect(@client).to receive(:create_merge_request)
+        .with(@git_repo,
+              @options[:pr_title],
+              :labels => ["HELLO", "WORLD"],
+              :source_branch => @options[:branch],
+              :target_branch => 'master',
+             ).and_return(mr)
+
+      allow(@client).to receive(:merge_requests)
+        .with(@git_repo,
+              :state => 'opened',
+              :source_branch => "#{@namespace}:#{@options[:branch]}",
+              :target_branch => 'master',
+             ).and_return([])
+
+      expect { @it.manage(@namespace, @repo_name, @options) }.to output(/Attached the following labels to MR 42: HELLO, WORLD/).to_stdout
+    end
+  end
+end

data/spec/unit/modulesync_spec.rb

@@ -12,58 +12,11 @@ describe ModuleSync do
     end
   end
 
-  context '::manage_pr' do
-    before(:each) do
-      stub_const('GITHUB_TOKEN', 'test')
-      @git_repo = 'test/modulesync'
-      @namespace, @repo_name = @git_repo.split('/')
-      @options = {
-        :pr => true,
-        :pr_title => 'Test PR is submitted',
-        :branch => 'test',
-        :message => 'Hello world',
-        :pr_auto_merge => false,
-      }
-
-      @client = double()
-    end
-
-    it 'rasies an error when GITHUB_TOKEN not set for PRs' do
-      stub_const('GITHUB_TOKEN', '')
-      options = {:pr => true, :skip_broken => false}
-
-      expect { ModuleSync.manage_pr(@namespace, @repo_name, options) }.to raise_error(RuntimeError).and output(/GITHUB_TOKEN/).to_stderr
-    end
-
-    it 'submits PR when --pr is set' do
-      allow(Octokit::Client).to receive(:new).and_return(@client)
-      allow(@client).to receive(:pull_requests).with(@git_repo, :state => 'open', :base => 'master', :head => "#{@namespace}:#{@options[:branch]}").and_return([])
-      expect(@client).to receive(:create_pull_request).with(@git_repo, 'master', @options[:branch], @options[:pr_title], @options[:message]).and_return({"html_url" => "http://example.com/pulls/22"})
-      expect { ModuleSync.manage_pr(@namespace, @repo_name, @options) }.to output(/Submitted PR/).to_stdout
-    end
-
-    it 'skips submitting PR if one has already been issued' do
-      allow(Octokit::Client).to receive(:new).and_return(@client)
-
-      pr = {
-        "title" => "Test title",
-        "html_url" => "https://example.com/pulls/44",
-        "number" => "44"
-      }
-
-      expect(@client).to receive(:pull_requests).with(@git_repo, :state => 'open', :base => 'master', :head => "#{@namespace}:#{@options[:branch]}").and_return([pr])
-      expect { ModuleSync.manage_pr(@namespace, @repo_name, @options) }.to output(/Skipped! 1 PRs found for branch test/).to_stdout
-    end
-
-    it 'adds labels to PR when --pr-labels is set' do
-      @options[:pr_labels] = "HELLO,WORLD"
-
-      allow(Octokit::Client).to receive(:new).and_return(@client)
-      allow(@client).to receive(:create_pull_request).and_return({"html_url" => "http://example.com/pulls/22", "number" => "44"})
-      allow(@client).to receive(:pull_requests).with(@git_repo, :state => 'open', :base => 'master', :head => "#{@namespace}:#{@options[:branch]}").and_return([])
-
-      expect(@client).to receive(:add_labels_to_an_issue).with(@git_repo, "44", ["HELLO", "WORLD"])
-      expect { ModuleSync.manage_pr(@namespace, @repo_name, @options) }.to output(/Attaching the following labels to PR 44: HELLO, WORLD/).to_stdout
+  context '::pr' do
+    describe "Raise Error" do
+      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
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2021-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -86,14 +86,28 @@ 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -112,16 +126,22 @@ dependencies:
   name: puppet-blacksmith
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -144,6 +164,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".config/cucumber.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -151,6 +172,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- HISTORY.md
 - LICENSE
 - README.md
 - Rakefile
@@ -161,17 +183,25 @@ 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
+- lib/modulesync/pr/github.rb
+- lib/modulesync/pr/gitlab.rb
 - lib/modulesync/renderer.rb
 - lib/modulesync/settings.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
@@ -186,7 +216,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -203,6 +233,11 @@ 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
 - spec/unit/modulesync/settings_spec.rb
 - spec/unit/modulesync_spec.rb