modulesync 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2442835e7b5da17cc633790e9e4a2a3fe38c0a1b4d3fbd75ee8f60b6948ddc75
-  data.tar.gz: 0f0c8f284f95824e469759582db8188b37c8c8d7247f463dc9877e973887fcac
+  metadata.gz: 7fb5357d0ecf1e4f620be302b55c9f1e88779c446021097172866c87a1e57d8f
+  data.tar.gz: be3975ae4dbe2a4e6a32cc5851bc0e9ce8ac8dd0b9560175380f492e43dabe27
 SHA512:
-  metadata.gz: 521392847ed7f191f9ef9bb6a0c26d80fb7c557b882f092bec29834311af6c10a2e0bd5db2d1be162996fbfbcccfd5f9ac1063268b6480aa95c867802e9b48b3
-  data.tar.gz: b3ddc00ba28e2d5043cb0e24d3448c35ca84f3d42a4263de4efa8513f7c38d02ca2324289a2b15d2a5c84435a3329de76acccfae8da2da6f1df31d60553cdc77
+  metadata.gz: 15051bcc97f904d9d886e67abf9e6ea99818410ec3f330f7d67ed9cc86451f322b79861801218f46b534a0f3241f3aa15dc16928360c471c0742e0b8f3c120f7
+  data.tar.gz: d527c5e7eeeccfabdbd5eb328759b826873aea33f12419179a89f84a1499af784788de9ca420eab8cbc5d2d83fdf1a9a8f6bbde1c536b25aca9c35b21c77c40b

data/.rubocop_todo.yml

@@ -19,7 +19,7 @@ Metrics/AbcSize:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 105
+  Max: 107
 
 # Offense count: 4
 Metrics/CyclomaticComplexity:

data/CHANGELOG.md

@@ -1,8 +1,17 @@
 # Changelog
 
+## 2020-07-03 - 1.3.0
+
+* Expose --managed_modules_conf [#184](https://github.com/voxpupuli/modulesync/pull/184)
+* Allow absolute path for config files [#183](https://github.com/voxpupuli/modulesync/pull/183)
+* Add pr_target_branch option [#182](https://github.com/voxpupuli/modulesync/pull/182)
+* Allow to specify namespace in module_options [#181](https://github.com/voxpupuli/modulesync/pull/181)
+* Allow to override PR parameters per module [#178](https://github.com/voxpupuli/modulesync/pull/178)
+* Include the gitlab library (if we interact with gitlab), not github [#179](https://github.com/voxpupuli/modulesync/pull/179)
+
 ## 2020-07-03 - 1.2.0
 
-Add support for GitLab merge requests (MRs) [#175](https://github.com/voxpupuli/modulesync/pull/175)
+* Add support for GitLab merge requests (MRs) [#175](https://github.com/voxpupuli/modulesync/pull/175)
 
 ## 2020-05-01 - 1.1.0
 

data/README.md

@@ -185,17 +185,38 @@ GitLab automatically with the `--pr` CLI option.
 msync update --pr
 ```
 
-You must set the `GITHUB_TOKEN` or `GITLAB_TOKEN` environment variable
-for GitHub PRs or GitLab MRs to work. Additional options:
+In order for GitHub PRs or GitLab MRs to work, you must either provide
+the `GITHUB_TOKEN` or `GITLAB_TOKEN` environment variables,
+or set them per repository in `managed_modules.yml`, using the `github` or
+`gitlab` keys respectively.
+
+For GitHub Enterprise and self-hosted GitLab instances you also need to set the
+`GITHUB_BASE_URL` or `GITLAB_BASE_URL` environment variables, or use the
+`base_url` parameter in `managed_modules.yml`:
+
+```yaml
+---
+repo1:
+  :github:
+    :token: 'EXAMPLE_TOKEN'
+    :base_url: 'https://api.github.com/'
+
+repo2:
+  :gitlab:
+    :token: 'EXAMPLE_TOKEN'
+    :base_url: 'https://git.example.com/api/v4'
+```
+
+Then:
 
 * Set the PR/MR title with `--pr-title` or in `modulesync.yml` with the
   `pr_title` attribute.
 * Assign labels to the PR/MR with `--pr-labels` or in `modulesync.yml` with
   the `pr_labels` attribute. **NOTE:** `pr_labels` should be a list. When
   using the `--pr-labels` CLI option, you should use a comma separated list.
+* Set the target branch with `--pr_target_branch` or in `modulesync.yml` with
+  the `pr_target_branch` attribute.
 
-For GitHub Enterprise and self-hosted GitLab instances you need to set the
-`GITHUB_BASE_URL` or `GITLAB_BASE_URL` environment variable in addition.
 More details for GitHub:
 
 * Octokit [`api_endpoint`](https://github.com/octokit/octokit.rb#interacting-with-the-githubcom-apis-in-github-enterprise)
@@ -255,7 +276,9 @@ msync update -m "Commit message"
 Available parameters for modulesync.yml
 
 * `git_base` : The default URL to git clone from (Default: 'git@github.com:')
-* `namespace` : Namespace of the projects to manage (Default: 'puppetlabs')
+* `namespace` : Namespace of the projects to manage (Default: 'puppetlabs').
+  This value can be overridden in the module name (e.g. 'namespace/mod') or by
+  using the `namespace` key for the module in `managed_modules.yml`.
 * `branch` : Branch to push to (Default: 'master')
 * `remote_branch` : Remote branch to push to (Default: Same value as branch)
 * `message` : Commit message to apply to updated modules.

data/lib/modulesync.rb

@@ -105,7 +105,11 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
   end
 
   def self.manage_module(puppet_module, module_files, module_options, defaults, options)
-    namespace, module_name = module_name(puppet_module, options[:namespace])
+    default_namespace = options[:namespace]
+    if module_options.is_a?(Hash) && module_options.key?(:namespace)
+      default_namespace = module_options[:namespace]
+    end
+    namespace, module_name = module_name(puppet_module, default_namespace)
     git_repo = File.join(namespace, module_name)
     unless options[:offline]
       Git.pull(options[:git_base], git_repo, options[:branch], options[:project_root], module_options || {})
@@ -130,13 +134,22 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
       Git.update_noop(git_repo, options)
     elsif !options[:offline]
       pushed = Git.update(git_repo, files_to_manage, options)
-      pushed && options[:pr] && @pr.manage(namespace, module_name, options)
+      pushed && options[:pr] && pr(module_options).manage(namespace, module_name, options)
     end
   end
 
+  def self.config_path(file, options)
+    return file if Pathname.new(file).absolute?
+    File.join(options[:configs], file)
+  end
+
+  def config_path(file, options)
+    self.class.config_path(file, options)
+  end
+
   def self.update(options)
     options = config_defaults.merge(options)
-    defaults = Util.parse_config(File.join(options[:configs], CONF_FILE))
+    defaults = Util.parse_config(config_path(CONF_FILE, options))
     if options[:pr]
       unless options[:branch]
         $stderr.puts 'A branch must be specified with --branch to use --pr!'
@@ -146,11 +159,11 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
       @pr = create_pr_manager if options[:pr]
     end
 
-    local_template_dir = File.join(options[:configs], MODULE_FILES_DIR)
+    local_template_dir = config_path(MODULE_FILES_DIR, options)
     local_files = find_template_files(local_template_dir)
     module_files = relative_names(local_files, local_template_dir)
 
-    managed_modules = self.managed_modules(File.join(options[:configs], options[:managed_modules_conf]),
+    managed_modules = self.managed_modules(config_path(options[:managed_modules_conf], options),
                                            options[:filter],
                                            options[:negative_filter])
 
@@ -169,6 +182,26 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
     exit 1 if errors && options[:fail_on_warnings]
   end
 
+  def self.pr(module_options)
+    github_conf = module_options[:github]
+    gitlab_conf = module_options[:gitlab]
+
+    if !github_conf.nil?
+      base_url = github_conf[:base_url] || ENV.fetch('GITHUB_BASE_URL', 'https://api.github.com')
+      require 'modulesync/pr/github'
+      ModuleSync::PR::GitHub.new(github_conf[:token], base_url)
+    elsif !gitlab_conf.nil?
+      base_url = gitlab_conf[:base_url] || ENV.fetch('GITLAB_BASE_URL', 'https://gitlab.com/api/v4')
+      require 'modulesync/pr/gitlab'
+      ModuleSync::PR::GitLab.new(gitlab_conf[:token], base_url)
+    elsif @pr.nil?
+      $stderr.puts 'No GitHub or GitLab token specified for --pr!'
+      raise
+    else
+      @pr
+    end
+  end
+
   def self.create_pr_manager
     github_token = ENV.fetch('GITHUB_TOKEN', '')
     gitlab_token = ENV.fetch('GITLAB_TOKEN', '')
@@ -177,11 +210,10 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
       require 'modulesync/pr/github'
       ModuleSync::PR::GitHub.new(github_token, ENV.fetch('GITHUB_BASE_URL', 'https://api.github.com'))
     elsif !gitlab_token.empty?
-      require 'modulesync/pr/github'
+      require 'modulesync/pr/gitlab'
       ModuleSync::PR::GitLab.new(gitlab_token, ENV.fetch('GITLAB_BASE_URL', 'https://gitlab.com/api/v4'))
     else
-      $stderr.puts 'Environment variables GITHUB_TOKEN or GITLAB_TOKEN must be set to use --pr!'
-      raise
+      warn '--pr specified without environment variables GITHUB_TOKEN or GITLAB_TOKEN'
     end
   end
 end

data/lib/modulesync/cli.rb

@@ -67,6 +67,8 @@ module ModuleSync
              :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.'
+      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.',
@@ -99,6 +101,9 @@ module ModuleSync
              :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.',

data/lib/modulesync/pr/github.rb

@@ -16,11 +16,17 @@ module ModuleSync
       def manage(namespace, module_name, options)
         repo_path = File.join(namespace, module_name)
         head = "#{namespace}:#{options[:branch]}"
+        target_branch = options[:pr_target_branch] || 'master'
 
-        pull_requests = @api.pull_requests(repo_path, :state => 'open', :base => 'master', :head => head)
+        pull_requests = @api.pull_requests(repo_path, :state => 'open', :base => target_branch, :head => head)
         if pull_requests.empty?
-          pr = @api.create_pull_request(repo_path, 'master', options[:branch], options[:pr_title], options[:message])
-          $stdout.puts "Submitted PR '#{options[:pr_title]}' to #{repo_path} - merges #{options[:branch]} into master"
+          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}"
         else
           # Skip creating the PR if it exists already.
           $stdout.puts "Skipped! #{pull_requests.length} PRs found for branch #{options[:branch]}"

data/lib/modulesync/pr/gitlab.rb

@@ -17,17 +17,19 @@ module ModuleSync
         repo_path = File.join(namespace, module_name)
 
         head = "#{namespace}:#{options[:branch]}"
+        target_branch = options[:pr_target_branch] || 'master'
         merge_requests = @api.merge_requests(repo_path,
                                              :state => 'opened',
                                              :source_branch => head,
-                                             :target_branch => 'master')
+                                             :target_branch => target_branch)
         if merge_requests.empty?
           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 => 'master',
+                                         :target_branch => target_branch,
                                          :labels => mr_labels)
-          $stdout.puts "Submitted MR '#{options[:pr_title]}' to #{repo_path} - merges #{options[:branch]} into master"
+          $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(', ')}"
         else

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               = '1.2.0'
+  spec.version               = '1.3.0'
   spec.authors               = ['Vox Pupuli']
   spec.email                 = ['voxpupuli@groups.io']
   spec.summary               = 'Puppet Module Synchronizer'

data/spec/unit/modulesync_spec.rb

@@ -12,10 +12,10 @@ describe ModuleSync do
     end
   end
 
-  context '::create_pr_manager' do
+  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.create_pr_manager() }.to raise_error(RuntimeError).and output(/GITHUB_TOKEN/).to_stderr
+        expect { ModuleSync.pr({}) }.to raise_error(RuntimeError).and output(/No GitHub or GitLab token specified for --pr/).to_stderr
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba