modulesync 0.10.0 → 2.0.0

data/lib/modulesync/cli.rb

@@ -43,7 +43,8 @@ module ModuleSync
                    :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.' \
+                              ' Defaults to puppetlabs',
                    :default => CLI.defaults[:namespace] || 'puppetlabs'
       class_option :filter,
                    :aliases => '-f',
@@ -53,7 +54,8 @@ module ModuleSync
                    :desc => 'A regular expression to skip repositories.'
       class_option :branch,
                    :aliases => '-b',
-                   :desc => 'Branch name to make the changes in. Defaults to the default branch of the upstream repository, but falls back to "master".',
+                   :desc => 'Branch name to make the changes in.' \
+                              ' Defaults to the default branch of the upstream repository, but falls back to "master".',
                    :default => CLI.defaults[:branch]
 
       desc 'update', 'Update the modules in managed_modules.yml'
@@ -63,7 +65,10 @@ module ModuleSync
              :default => CLI.defaults[:message]
       option :configs,
              :aliases => '-c',
-             :desc => 'The local directory or remote repository to define the list of managed modules, the file templates, and the default values for template variables.'
+             :desc => 'The local directory or remote repository to define the list of managed modules,' \
+                        ' the file templates, and the default values for template variables.'
+      option :managed_modules_conf,
+             :desc => 'The file name to define the list of managed modules'
       option :remote_branch,
              :aliases => '-r',
              :desc => 'Remote branch name to push the changes to. Defaults to the branch name.',
@@ -87,14 +92,18 @@ module ModuleSync
              :default => false
       option :pr,
              :type => :boolean,
-             :desc => 'Submit GitHub PR',
+             :desc => 'Submit pull/merge request',
              :default => false
       option :pr_title,
-             :desc => 'Title of GitHub PR',
+             :desc => 'Title of pull/merge request',
              :default => CLI.defaults[:pr_title] || 'Update to module template files'
       option :pr_labels,
-             :desc => 'Labels to add to the GitHub PR',
+             :type => :array,
+             :desc => 'Labels to add to the pull/merge request',
              :default => CLI.defaults[:pr_labels] || []
+      option :pr_target_branch,
+             :desc => 'Target branch for the pull/merge request',
+             :default => CLI.defaults[:pr_target_branch] || 'master'
       option :offline,
              :type => :boolean,
              :desc => 'Do not run any Git commands. Allows the user to manage Git outside of ModuleSync.',
@@ -114,18 +123,21 @@ module ModuleSync
       option :tag_pattern,
              :desc => 'The pattern to use when tagging releases.'
       option :pre_commit_script,
-             :desc => 'A script to be run before commiting',
+             :desc => 'A script to be run before committing',
              :default => CLI.defaults[:pre_commit_script]
       option :fail_on_warnings,
              :type => :boolean,
              :aliases => '-F',
-             :desc => 'Produce a failure exit code when there are warnings (only has effect when --skip_broken is enabled)',
+             :desc => 'Produce a failure exit code when there are warnings' \
+                        ' (only has effect when --skip_broken is enabled)',
              :default => false
 
       def update
         config = { :command => 'update' }.merge(options)
         config = Util.symbolize_keys(config)
-        raise Thor::Error, 'No value provided for required option "--message"' unless config[:noop] || config[:message] || config[:offline]
+        raise Thor::Error, 'No value provided for required option "--message"' unless config[:noop] \
+                                                                                      || config[:message] \
+                                                                                      || config[:offline]
         config[:git_opts] = { 'amend' => config[:amend], 'force' => config[:force] }
         ModuleSync.update(config)
       end

data/lib/modulesync/git.rb

@@ -46,12 +46,13 @@ module ModuleSync
     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")
+        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)

data/lib/modulesync/pr/github.rb

@@ -0,0 +1,56 @@
+require 'octokit'
+require 'modulesync/util'
+
+module ModuleSync
+  module PR
+    # GitHub creates and manages pull requests on github.com or GitHub
+    # Enterprise installations.
+    class GitHub
+      def initialize(token, endpoint)
+        Octokit.configure do |c|
+          c.api_endpoint = endpoint
+        end
+        @api = Octokit::Client.new(:access_token => token)
+      end
+
+      def manage(namespace, module_name, options)
+        repo_path = File.join(namespace, module_name)
+        head = "#{namespace}:#{options[:branch]}"
+        target_branch = options[:pr_target_branch] || 'master'
+
+        if options[:noop]
+          $stdout.puts \
+            "Using no-op. Would submit PR '#{options[:pr_title]}' to #{repo_path} " \
+            "- merges #{options[:branch]} into #{target_branch}"
+          return
+        end
+
+        pull_requests = @api.pull_requests(repo_path,
+                                           :state => 'open',
+                                           :base => target_branch,
+                                           :head => head)
+        unless pull_requests.empty?
+          # Skip creating the PR if it exists already.
+          $stdout.puts "Skipped! #{pull_requests.length} PRs found for branch #{options[:branch]}"
+          return
+        end
+
+        pr_labels = ModuleSync::Util.parse_list(options[:pr_labels])
+        pr = @api.create_pull_request(repo_path,
+                                      target_branch,
+                                      options[:branch],
+                                      options[:pr_title],
+                                      options[:message])
+        $stdout.puts \
+          "Submitted PR '#{options[:pr_title]}' to #{repo_path} " \
+          "- merges #{options[:branch]} into #{target_branch}"
+
+        # We only assign labels to the PR if we've discovered a list > 1. The labels MUST
+        # already exist. We DO NOT create missing labels.
+        return if pr_labels.empty?
+        $stdout.puts "Attaching the following labels to PR #{pr['number']}: #{pr_labels.join(', ')}"
+        @api.add_labels_to_an_issue(repo_path, pr['number'], pr_labels)
+      end
+    end
+  end
+end

data/lib/modulesync/pr/gitlab.rb

@@ -0,0 +1,53 @@
+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)
+        head = "#{namespace}:#{options[: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 #{options[: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 #{options[:branch]}"
+          return
+        end
+
+        mr_labels = ModuleSync::Util.parse_list(options[:pr_labels])
+        mr = @api.create_merge_request(repo_path,
+                                       options[:pr_title],
+                                       :source_branch => options[:branch],
+                                       :target_branch => target_branch,
+                                       :labels => mr_labels)
+        $stdout.puts \
+          "Submitted MR '#{options[:pr_title]}' to #{repo_path} " \
+          "- merges #{options[: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/lib/modulesync/renderer.rb

@@ -4,8 +4,9 @@ require 'find'
 module ModuleSync
   module Renderer
     class ForgeModuleFile
-      def initialize(configs = {})
+      def initialize(configs = {}, metadata = {})
         @configs = configs
+        @metadata = metadata
       end
     end
 
@@ -26,8 +27,8 @@ module ModuleSync
       File.delete(file) if File.exist?(file)
     end
 
-    def self.render(_template, configs = {})
-      ForgeModuleFile.new(configs).render
+    def self.render(_template, configs = {}, metadata = {})
+      ForgeModuleFile.new(configs, metadata).render
     end
 
     def self.sync(template, target_name)

data/lib/modulesync/settings.rb

@@ -19,10 +19,9 @@ module ModuleSync
 
     def build_file_configs(target_name)
       file_def = lookup_config(defaults, target_name)
-      file_md  = lookup_config(module_defaults, target_name)
       file_mc  = lookup_config(module_configs, target_name)
 
-      global_defaults.merge(file_def).merge(file_md).merge(file_mc).merge(additional_settings)
+      global_defaults.merge(file_def).merge(module_defaults).merge(file_mc).merge(additional_settings)
     end
 
     def managed?(target_name)

data/lib/modulesync/util.rb

@@ -3,7 +3,10 @@ require 'yaml'
 module ModuleSync
   module Util
     def self.symbolize_keys(hash)
-      hash.inject({}) { |memo, (k, v)| memo[k.to_sym] = v; memo }
+      hash.inject({}) do |memo, (k, v)|
+        memo[k.to_sym] = v.is_a?(Hash) ? symbolize_keys(v) : v
+        memo
+      end
     end
 
     def self.parse_config(config_file)

data/modulesync.gemspec

@@ -3,27 +3,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name                  = 'modulesync'
-  spec.version               = '0.10.0'
+  spec.version               = '2.0.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.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) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'aruba', '~> 0.14'
   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_runtime_dependency 'git', '~>1.3'
+  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 'thor'

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

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe ModuleSync do
   context '::update' do
     it 'loads the managed modules from the specified :managed_modules_conf' do
-      allow(ModuleSync).to receive(:local_files).and_return([])
+      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([])
 
@@ -11,4 +11,12 @@ describe ModuleSync do
       ModuleSync.update(options)
     end
   end
+
+  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,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-27 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !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
@@ -151,6 +165,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- HISTORY.md
 - LICENSE
 - README.md
 - Rakefile
@@ -166,12 +181,16 @@ files:
 - 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/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,14 +205,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Puppet Module Synchronizer
@@ -204,5 +223,7 @@ test_files:
 - features/support/env.rb
 - features/update.feature
 - 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