modulesync 2.2.0 → 2.3.0

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

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+require 'modulesync/git_service/github'
+
+describe ModuleSync::GitService::GitHub do
+  context '::open_pull_request' do
+    before(:each) do
+      @client = double()
+      allow(Octokit::Client).to receive(:new).and_return(@client)
+      @it = ModuleSync::GitService::GitHub.new('test', 'https://api.github.com')
+    end
+
+    let(:args) do
+      {
+        repo_path: 'test/modulesync',
+        namespace: 'test',
+        title: 'Test PR is submitted',
+        message: 'Hello world',
+        source_branch: 'test',
+        target_branch: 'master',
+        labels: labels,
+        noop: false,
+      }
+    end
+
+    let(:labels) { [] }
+
+    it 'submits PR when --pr is set' do
+      allow(@client).to receive(:pull_requests)
+        .with(args[:repo_path],
+              :state => 'open',
+              :base => 'master',
+              :head => "#{args[:namespace]}:#{args[:source_branch]}"
+             ).and_return([])
+      expect(@client).to receive(:create_pull_request)
+        .with(args[:repo_path],
+              'master',
+              args[:source_branch],
+              args[:title],
+              args[:message]
+             ).and_return({"html_url" => "http://example.com/pulls/22"})
+      expect { @it.open_pull_request(**args) }.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(args[:repo_path],
+              :state => 'open',
+              :base => 'master',
+              :head => "#{args[:namespace]}:#{args[:source_branch]}"
+             ).and_return([pr])
+      expect { @it.open_pull_request(**args) }.to output("Skipped! 1 PRs found for branch 'test'\n").to_stdout
+    end
+
+    context 'when labels are set' do
+      let(:labels) { %w{HELLO WORLD} }
+
+      it 'adds labels to PR' do
+        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(args[:repo_path],
+                :state => 'open',
+                :base => 'master',
+                :head => "#{args[:namespace]}:#{args[:source_branch]}"
+               ).and_return([])
+        expect(@client).to receive(:add_labels_to_an_issue)
+          .with(args[:repo_path],
+                "44",
+                ["HELLO", "WORLD"]
+               )
+        expect { @it.open_pull_request(**args) }.to output(/Attaching the following labels to PR 44: HELLO, WORLD/).to_stdout
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+require 'modulesync/git_service/gitlab'
+
+describe ModuleSync::GitService::GitLab do
+  context '::open_pull_request' do
+    before(:each) do
+      @client = double()
+      allow(Gitlab::Client).to receive(:new).and_return(@client)
+      @it = ModuleSync::GitService::GitLab.new('test', 'https://gitlab.com/api/v4')
+    end
+
+    let(:args) do
+      {
+        repo_path: 'test/modulesync',
+        namespace: 'test',
+        title: 'Test MR is submitted',
+        message: 'Hello world',
+        source_branch: 'test',
+        target_branch: 'master',
+        labels: labels,
+        noop: false,
+      }
+    end
+
+    let(:labels) { [] }
+
+    it 'submits MR when --pr is set' do
+      allow(@client).to receive(:merge_requests)
+        .with(args[:repo_path],
+              :state => 'opened',
+              :source_branch => args[:source_branch],
+              :target_branch => 'master',
+             ).and_return([])
+
+      expect(@client).to receive(:create_merge_request)
+        .with(args[:repo_path],
+              args[:title],
+              :labels => [],
+              :source_branch => args[:source_branch],
+              :target_branch => 'master',
+             ).and_return({"html_url" => "http://example.com/pulls/22"})
+
+      expect { @it.open_pull_request(**args) }.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(args[:repo_path],
+              :state => 'opened',
+              :source_branch => args[:source_branch],
+              :target_branch => 'master',
+             ).and_return([mr])
+
+      expect { @it.open_pull_request(**args) }.to output("Skipped! 1 MRs found for branch 'test'\n").to_stdout
+    end
+
+    context 'when labels are set' do
+      let(:labels) { %w{HELLO WORLD} }
+
+      it 'adds labels to MR' do
+        mr = double()
+        allow(mr).to receive(:iid).and_return("42")
+
+        expect(@client).to receive(:create_merge_request)
+          .with(args[:repo_path],
+                args[:title],
+                :labels => ["HELLO", "WORLD"],
+                :source_branch => args[:source_branch],
+                :target_branch => 'master',
+               ).and_return(mr)
+
+        allow(@client).to receive(:merge_requests)
+          .with(args[:repo_path],
+                :state => 'opened',
+                :source_branch => args[:source_branch],
+                :target_branch => 'master',
+               ).and_return([])
+
+        expect { @it.open_pull_request(**args) }.to output(/Attached the following labels to MR 42: HELLO, WORLD/).to_stdout
+      end
+    end
+  end
+end

data/spec/unit/modulesync/git_service_spec.rb

@@ -0,0 +1,201 @@
+require 'modulesync'
+require 'modulesync/git_service'
+
+describe ModuleSync::GitService do
+  before do
+    options = ModuleSync.config_defaults.merge({
+      git_base: 'file:///tmp/dummy',
+    })
+    ModuleSync.instance_variable_set '@options', options
+  end
+
+  context 'when guessing the git service configuration' do
+    before do
+      allow(ENV).to receive(:[])
+        .and_return(nil)
+    end
+
+    let(:sourcecode) do
+      ModuleSync::SourceCode.new 'puppet-test', sourcecode_options
+    end
+
+    context 'when using a complete git service configuration entry' do
+      let(:sourcecode_options) do
+        {
+          gitlab: {
+            base_url: 'https://vcs.example.com/api/v4',
+            token: 'secret',
+          },
+        }
+      end
+
+      it 'build git service arguments from configuration entry' do
+        expect(ModuleSync::GitService.configuration_for(sourcecode: sourcecode)).to eq({
+          type: :gitlab,
+          endpoint: 'https://vcs.example.com/api/v4',
+          token: 'secret',
+        })
+      end
+    end
+
+    context 'when using a simple git service key entry' do
+      let(:sourcecode_options) do
+        {
+          gitlab: {},
+          remote: 'git@git.example.com:namespace/puppet-test',
+        }
+      end
+
+      context 'with GITLAB_BASE_URL and GITLAB_TOKEN environment variables sets' do
+        it 'build git service arguments from environment variables' do
+          allow(ENV).to receive(:[])
+            .with('GITLAB_BASE_URL')
+            .and_return('https://vcs.example.com/api/v4')
+          allow(ENV).to receive(:[])
+            .with('GITLAB_TOKEN')
+            .and_return('secret')
+
+          expect(ModuleSync::GitService.configuration_for(sourcecode: sourcecode)).to eq({
+            type: :gitlab,
+            endpoint: 'https://vcs.example.com/api/v4',
+            token: 'secret',
+          })
+        end
+      end
+
+      context 'with only GITLAB_TOKEN environment variable sets' do
+        it 'guesses the endpoint based on repository remote' do
+          allow(ENV).to receive(:[])
+            .with('GITLAB_TOKEN')
+            .and_return('secret')
+
+          expect(ModuleSync::GitService.configuration_for(sourcecode: sourcecode)).to eq({
+            type: :gitlab,
+            endpoint: 'https://git.example.com/api/v4',
+            token: 'secret',
+          })
+        end
+      end
+
+      context 'without any environment variable sets' do
+        it 'returns a nil token' do
+          expect(ModuleSync::GitService.configuration_for(sourcecode: sourcecode)).to eq({
+            type: :gitlab,
+            endpoint: 'https://git.example.com/api/v4',
+            token: nil,
+          })
+        end
+      end
+    end
+
+    context 'without git service configuration entry' do
+      context 'with a guessable endpoint based on repository remote' do
+        let(:sourcecode_options) do
+          {
+            remote: 'git@gitlab.example.com:namespace/puppet-test',
+          }
+        end
+
+        context 'with a GITLAB_TOKEN environment variable sets' do
+          it 'guesses git service configuration' do
+            allow(ENV).to receive(:[])
+              .with('GITLAB_TOKEN')
+              .and_return('secret')
+
+            expect(ModuleSync::GitService.configuration_for(sourcecode: sourcecode)).to eq({
+              type: :gitlab,
+              endpoint: 'https://gitlab.example.com/api/v4',
+              token: 'secret',
+            })
+          end
+        end
+
+        context 'without a GITLAB_TOKEN environment variable sets' do
+          it 'returns a nil token' do
+            expect(ModuleSync::GitService.configuration_for(sourcecode: sourcecode)).to eq({
+              type: :gitlab,
+              endpoint: 'https://gitlab.example.com/api/v4',
+              token: nil,
+            })
+          end
+        end
+      end
+
+      context 'with a unguessable endpoint' do
+        let(:sourcecode_options) do
+          {
+            remote: 'git@vcs.example.com:namespace/puppet-test',
+          }
+        end
+
+        context 'with GITHUB_TOKEN environments variable sets' do
+          it 'guesses git service configuration' do
+            allow(ENV).to receive(:[])
+              .with('GITHUB_TOKEN')
+              .and_return('secret')
+
+            expect(ModuleSync::GitService.configuration_for(sourcecode: sourcecode)).to eq({
+              type: :github,
+              endpoint: 'https://vcs.example.com',
+              token: 'secret',
+            })
+          end
+        end
+
+        context 'with GITLAB_TOKEN and GITHUB_TOKEN environments variables sets' do
+          it 'raises an error' do
+            allow(ENV).to receive(:[])
+              .with('GITHUB_TOKEN')
+              .and_return('secret')
+
+            allow(ENV).to receive(:[])
+              .with('GITLAB_TOKEN')
+              .and_return('secret')
+
+            expect{ModuleSync::GitService.configuration_for(sourcecode: sourcecode)}
+              .to raise_error ModuleSync::Error
+          end
+        end
+      end
+    end
+  end
+
+  RSpec.shared_examples 'hostname_extractor' do |url, hostname|
+    context "with '#{url}' URL" do
+      subject { ModuleSync::GitService::Base.extract_hostname(url) }
+      it "should extract #{hostname.nil? ? 'nil' : "'#{hostname}'"} as hostname" do
+        expect(subject).to eq(hostname)
+      end
+    end
+  end
+
+  context '#extract_hostname' do
+    [
+      %w[ssh://user@host.xz:4444/path/to/repo.git/ host.xz],
+      %w[ssh://user@host.xz:/path/to/repo.git/     host.xz],
+      %w[ssh://host.xz/path/to/repo.git/           host.xz],
+
+      %w[git://host.xz/path/to/repo.git/           host.xz],
+      %w[git://host.xz/path/to/repo/               host.xz],
+      %w[git://host.xz/path/to/repo                host.xz],
+
+      %w[user@host.xz:path/to/repo.git/            host.xz],
+      %w[user@host.xz:path/to/repo.git             host.xz],
+      %w[user@host.xz:path/to/repo                 host.xz],
+      %w[host.xz:path/to/repo.git/                 host.xz],
+
+      %w[https://host.xz:8443/path/to/repo.git/    host.xz],
+      %w[https://host.xz/path/to/repo.git/         host.xz],
+
+      %w[ftp://host.xz/path/to/repo/               host.xz],
+
+      ['/path/to/repo.git/',                       nil],
+
+      ['file:///path/to/repo.git/',                nil],
+
+      ['something-invalid',                        nil],
+    ].each do |url, hostname|
+      it_should_behave_like 'hostname_extractor', url, hostname
+    end
+  end
+end

data/spec/unit/modulesync/source_code_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe ModuleSync::SourceCode do
+  before do
+    options = ModuleSync.config_defaults.merge({
+      git_base: 'file:///tmp/dummy',
+    })
+    ModuleSync.instance_variable_set '@options', options
+  end
+
+  subject do
+    ModuleSync::SourceCode.new('namespace/name', nil)
+  end
+
+  it 'has a repository namespace sets to "namespace"' do
+    expect(subject.repository_namespace).to eq 'namespace'
+  end
+
+  it 'has a repository name sets to "name"' do
+    expect(subject.repository_name).to eq 'name'
+  end
+end

data/spec/unit/modulesync_spec.rb

@@ -11,16 +11,4 @@ describe ModuleSync do
       ModuleSync.update(options)
     end
   end
-
-  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(puppet_module) }.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: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-24 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -44,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -78,16 +92,44 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: rubocop-rake
+  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: rubocop-rspec
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -191,6 +233,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".simplecov"
 - CHANGELOG.md
 - Gemfile
 - HISTORY.md
@@ -200,19 +243,27 @@ files:
 - bin/msync
 - contrib/openstack-commit-msg-hook.sh
 - features/cli.feature
+- features/execute.feature
 - features/hook.feature
+- features/push.feature
+- features/reset.feature
 - features/step_definitions/git_steps.rb
 - features/support/env.rb
 - features/update.feature
 - features/update/bad_context.feature
 - features/update/bump_version.feature
+- features/update/dot_sync.feature
+- features/update/pull_request.feature
 - lib/modulesync.rb
 - lib/modulesync/cli.rb
 - lib/modulesync/cli/thor.rb
 - lib/modulesync/constants.rb
+- lib/modulesync/git_service.rb
+- lib/modulesync/git_service/base.rb
+- lib/modulesync/git_service/factory.rb
+- lib/modulesync/git_service/github.rb
+- lib/modulesync/git_service/gitlab.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
@@ -224,9 +275,12 @@ files:
 - 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/git_service/factory_spec.rb
+- spec/unit/modulesync/git_service/github_spec.rb
+- spec/unit/modulesync/git_service/gitlab_spec.rb
+- spec/unit/modulesync/git_service_spec.rb
 - spec/unit/modulesync/settings_spec.rb
+- spec/unit/modulesync/source_code_spec.rb
 - spec/unit/modulesync_spec.rb
 homepage: https://github.com/voxpupuli/modulesync
 licenses:
@@ -247,22 +301,30 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Puppet Module Synchronizer
 test_files:
 - features/cli.feature
+- features/execute.feature
 - features/hook.feature
+- features/push.feature
+- features/reset.feature
 - features/step_definitions/git_steps.rb
 - features/support/env.rb
 - features/update.feature
 - features/update/bad_context.feature
 - features/update/bump_version.feature
+- features/update/dot_sync.feature
+- features/update/pull_request.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/git_service/factory_spec.rb
+- spec/unit/modulesync/git_service/github_spec.rb
+- spec/unit/modulesync/git_service/gitlab_spec.rb
+- spec/unit/modulesync/git_service_spec.rb
 - spec/unit/modulesync/settings_spec.rb
+- spec/unit/modulesync/source_code_spec.rb
 - spec/unit/modulesync_spec.rb

data/lib/modulesync/pr/gitlab.rb

@@ -1,54 +0,0 @@
-require 'gitlab'
-require 'modulesync/util'
-
-module ModuleSync
-  module PR
-    # GitLab creates and manages merge requests on gitlab.com or private GitLab
-    # installations.
-    class GitLab
-      def initialize(token, endpoint)
-        @api = Gitlab::Client.new(
-          :endpoint => endpoint,
-          :private_token => token
-        )
-      end
-
-      def manage(namespace, module_name, options)
-        repo_path = File.join(namespace, module_name)
-        branch = options[:remote_branch] || options[:branch]
-        head = "#{namespace}:#{branch}"
-        target_branch = options[:pr_target_branch] || 'master'
-
-        if options[:noop]
-          $stdout.puts \
-            "Using no-op. Would submit MR '#{options[:pr_title]}' to #{repo_path} " \
-            "- merges #{branch} into #{target_branch}"
-          return
-        end
-
-        merge_requests = @api.merge_requests(repo_path,
-                                             :state => 'opened',
-                                             :source_branch => head,
-                                             :target_branch => target_branch)
-        unless merge_requests.empty?
-          # Skip creating the MR if it exists already.
-          $stdout.puts "Skipped! #{merge_requests.length} MRs found for branch #{branch}"
-          return
-        end
-
-        mr_labels = ModuleSync::Util.parse_list(options[:pr_labels])
-        mr = @api.create_merge_request(repo_path,
-                                       options[:pr_title],
-                                       :source_branch => branch,
-                                       :target_branch => target_branch,
-                                       :labels => mr_labels)
-        $stdout.puts \
-          "Submitted MR '#{options[:pr_title]}' to #{repo_path} " \
-          "- merges #{branch} into #{target_branch}"
-
-        return if mr_labels.empty?
-        $stdout.puts "Attached the following labels to MR #{mr.iid}: #{mr_labels.join(', ')}"
-      end
-    end
-  end
-end

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

@@ -1,49 +0,0 @@
-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