pdksync 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dcb6ea51b43a295e28ab7a3bb90ccf3d398ccdbd
-  data.tar.gz: f214afd41acd5fc6bba7557e3ce79230a8e1dde8
+SHA256:
+  metadata.gz: ab2ac9994044ffbddbbe2a6a18933d764477c2cdff17578abc2b203272c0bca0
+  data.tar.gz: da3644827bdad46868369dd0297ebae4dedfd15225ccf41def3aecdb5c0bfd73
 SHA512:
-  metadata.gz: 69ee152722be2fa9a862727de092981c1c9855a44c36e5b1033b22a4883585a0ef8596fa666ca8d65443ae2fec3244c16b590e7d034a479ba83e30baf3773ee5
-  data.tar.gz: 542e70e07027ad294e99d5d0933b36e586feed3bd55c3036edef2eb26832eea3cb8324d7ff50297be69eb01e78dd7dabd376679097e4a0686a83f45696c194d8
+  metadata.gz: 9d35e566ef6c5f29fdff5536721343d9c21aeedca3c3465afc4813183cc6b3ff6919687e43c63167649a6024fb711f420fbd9d604f402880eb99d32d0c1483f1
+  data.tar.gz: e5a4b656cc8a940d106a652b6a3818e3fc7106020b3581d192eb2d5706183a069edf59e1d6196c4aaf06c495f876bfe6c2591079abbb3e9b585196a863bf91ba

data/CHANGELOG.md

@@ -2,9 +2,23 @@
 
 All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
 
-## [0.3.0](https://github.com/puppetlabs/pdksync/tree/0.3.0) (2018-11-15)
+## [0.4.0](https://github.com/puppetlabs/pdksync/tree/0.4.0) (2019-02-04)
 
-[Full Changelog](https://github.com/puppetlabs/pdksync/compare/0.2.0...0.3.0)
+[Full Changelog](https://github.com/puppetlabs/pdksync/compare/v0.3.0...0.4.0)
+
+### Added
+
+- \(MODULES-8419\) Refactor to add support for GitLab [\#85](https://github.com/puppetlabs/pdksync/pull/85) ([antaflos](https://github.com/antaflos))
+- \(MODULES-7233\) - Add configurable file option [\#81](https://github.com/puppetlabs/pdksync/pull/81) ([eimlav](https://github.com/eimlav))
+
+### Fixed
+
+- \(MODULES-8283\) - Fix PR title overwritten in pdksync runs [\#84](https://github.com/puppetlabs/pdksync/pull/84) ([eimlav](https://github.com/eimlav))
+- \(MODULES-8382\) - Fix API rate limit false positive [\#83](https://github.com/puppetlabs/pdksync/pull/83) ([eimlav](https://github.com/eimlav))
+
+## [v0.3.0](https://github.com/puppetlabs/pdksync/tree/v0.3.0) (2018-11-15)
+
+[Full Changelog](https://github.com/puppetlabs/pdksync/compare/0.2.0...v0.3.0)
 
 ### Added
 

data/README.md

@@ -6,7 +6,7 @@ Table of Contents
 1. [Overview](#overview)
 2. [Usage](#usage)
 3. [How it works](#how-it-works)
-4. [Installing](#installing)
+4. [Configuration](#configuration)
 5. [Workflow](#workflow)
 6. [Migrating from modulesync to pdksync](#migrating-from-modulesync-to-pdksync)
 7. [Contributing](#contributing)
@@ -14,17 +14,26 @@ Table of Contents
 ### Overview
 --------
 
-Pdksync is an efficient way to run a `pdk update` command against the various repositories that we manage — keeping them up-to-date with the changes made to PDK. It is a solution for converted modules that no longer run with modulesync.
+Pdksync is an efficient way to run a `pdk update` command against the various Puppet module repositories that you manage — keeping them up-to-date with the changes made to PDK. It is a solution for converted modules that no longer run with modulesync.
+
+Pdksync by default expects that your Puppet module repositories live on GitHub and will behave accordingly. It also supports GitLab as an alternative Git hosting platform.
 
 ### Usage
 ----------
 
-> Note: This tool creates a 'live' pull request against the master branch of the module it is running against — defined in `managed_modules.yml`. Before running this tool, ensure this file  reflects the modules you wish it to run against, and that `constants.rb` is up-to-date with the correct namespace your modules reside in.
+> Note: This tool creates a 'live' pull (merge) request against the master branch of the module it is running against — defined in `managed_modules.yml`. Before running this tool, ensure this file reflects the modules you wish it to run against. Additionally make sure that the Pdksync configuration file `$HOME/.pdksync.yml` sets the correct namespace, Git platform and Git base URI for your modules. See section [Configuration](#configuration) for details.
 
 1. To use pdksync, clone the GitHub repo or install it as a gem. Set up the environment by exporting a GitHub token:
-```
-export GITHUB_TOKEN=<access_token>
-```
+
+   ```
+   export GITHUB_TOKEN=<access_token>
+   ```
+
+   If you use GitLab instead of GitHub export your GitLab access token:
+
+   ```
+   export GITLAB_TOKEN=<access_token>
+   ```
 2. Before the script will run, you need to install the gems:
 ```
 bundle install --path .bundle/gems/
@@ -41,9 +50,10 @@ Pdksync is a gem that works to clone, update, and push module repositories. It i
 
 The gem takes in a file, `managed_modules.yml`, stored within the gem that lists all the repositories that need to be updated. It then clones them, one after another, so that a local copy exists. The update command is ran against this local copy, with the subsequent changes being added into a commit on a unique branch. It is then pushed back to the remote master — where the local copy was originally cloned. The commit is merged to the master via a pull request, causing the gem to begin to clone the next repository.
 
-By default, pdksync will supply a label to a PR (default is 'maintenance'). This can be changed by opening `lib/pdksync/constants.rb` and modifying the `PDKSYNC_LABEL` constant. You must ensure that the label selected exists on the modules that you are applying pdksync to. Should you wish to disable this feature, simply change `PDKSYNC_LABEL` to an empty string i.e. ''. Similarly, when supplying a label using the `git:push_and_create_pr` rake task, the label must exist on each of the managed modules to run successfully.
+By default, pdksync will supply a label to a PR (default is 'maintenance'). This can be changed by creating `$HOME/.pdksync.yml` and setting the `pdksync_label` key. You must ensure that the label selected exists on the modules that you are applying pdksync to. Should you wish to disable this feature, simply change `pdksync_label` to an empty string i.e. `''`. Similarly, when supplying a label using the `git:push_and_create_pr` rake task, the label must exist on each of the managed modules to run successfully.
 
 The following rake tasks are available with pdksync:
+- `show_config` Display the current configuration of pdksync
 - `git:clone_managed_modules` Clone managed modules.
 - `git:create_commit[:branch_name, :commit_message]` Stage commits for modules, branchname and commit message eg rake 'git:create_commit[flippity, commit messagez]'.
 - `git:push_and_create_pr[:pr_title, :label]` Push commit, and create PR for modules. Label is optional eg rake 'git:push_and_create_pr[pr title goes here, optional label right here]'.
@@ -55,10 +65,80 @@ The following rake tasks are available with pdksync:
   - `rake 'pdksync[MODULES-8231]'` PR title outputs as `pdksync - MODULES-8231 - pdksync_heads/master-0-gabccfb1`
 - `run_a_command[:command]` Run a command against modules eg rake 'run_a_command[complex command here -f -gx]'
 
+### Configuration
+
+By default pdksync will use hardcoded values for configuring itself. However, if you wish to override these values, simply create `$HOME/.pdksync.yml` and use the following format:
+```
+---
+namespace: 'puppetlabs'
+pdksync_dir: 'modules_pdksync'
+push_file_destination: 'origin'
+create_pr_against: 'master'
+managed_modules: 'managed_modules.yml'
+pdksync_label: 'maintenance'
+git_platform: :github
+git_base_uri: 'https://github.com'
+# Only used when git_platform is set to :gitlab
+gitlab_api_endpoint: 'https://gitlab.com/api/v4'
+```
+
+You may override any property. Those that are not specified in your config file will use their corresponding default value from `lib/pdksync/constants.rb`.
+
+#### Git platform support
+
+By default pdksync assumes you are hosting your Puppet modules on GitHub, and GitHub is the only platform officially supported by Puppetlabs in pdksync.
+
+Pdksync also supports the GitLab platform, but without official support by Puppetlabs.
+
+##### GitHub
+
+To use GitHub you only need to export your GitHub access token as the
+environment variable `GITHUB_TOKEN` and configure the namespace in which your
+modules are hosted in `$HOME/.pdksync.yml` as described above.
+
+##### GitLab
+
+To use GitLab at `https://gitlab.com` you need to set `git_platform: :gitlab`
+and configure the namespace of your modules in `$HOME/.pdksync.yml`. You also
+need to export your GitLab access token as the environment variable
+`GITLAB_TOKEN`.
+
+Your `$HOME/.pdksync.yml` then looks like this:
+
+```
+# ~/pdksync.yml
+---
+namespace: 'acme'
+git_platform: :gitlab
+```
+
+Export your GitLab access token:
+
+```
+$ export GITLAB_TOKEN=<your GitLab access token here>
+```
+
+If you are running your own GitLab instance on premise or use a GitLab instance
+other than the official one at `https://gitlab.com` you also need to configure
+`git_base_uri` and `gitlab_api_endpoint` in `$HOME/.pdksync.yml` so that
+pdksync knows from where to clone your modules and where to access to GitLab
+API to create the live merge requests:
+
+```
+# ~/pdksync.yml
+---
+namespace: 'puppetmodules'
+git_platform: :gitlab
+git_base_uri: 'https://gitlab.example.com'
+# alternatively use SSH:
+#git_base_uri: 'ssh://git@gitlab.example.com:2222'
+gitlab_api_endpoint: 'https://gitlab.example.com/api/v4'
+```
+
 ### Workflow
 --------
 
-It currently runs without additional arguments. To alter how it runs, make alterations to either the `constants.rb` or `managed_modules.yml`.
+It currently runs without additional arguments. To alter how it runs, make alterations to either `HOME/.pdksync.yml` or `managed_modules.yml`.
 
 ### Managed modules
 ----------
@@ -71,7 +151,8 @@ This module runs through a pre-set array of modules, with this array set within
 - puppetlabs-stdlib
 - puppetlabs-mysql
 ```
-To add a module, add it to the list. To remove a module, remove it from the list.
+
+To add a module, add it to the list. To remove a module, remove it from the list. If you wish to specify a custom managed modules file, use the `managed_modules` property in your configuration file to specify the path to the file.
 
 ### Migrating from modulesync to pdksync
 --------

data/Rakefile

@@ -1,6 +1,24 @@
 require_relative 'lib/pdksync'
+require 'colorize'
 require 'github_changelog_generator/task'
 
+desc 'Display the current configuration of pdksync'
+task :show_config do
+  include PdkSync::Constants
+  puts 'PDKSync Configuration'.bold.yellow
+  puts '- Git hosting platform: '.bold + "#{PdkSync::Constants::GIT_PLATFORM}".cyan
+  puts '- Git base URI: '.bold + "#{PdkSync::Constants::GIT_BASE_URI}".cyan
+  if PdkSync::Constants::GIT_PLATFORM == :gitlab
+    puts '- Gitlab API endpoint: '.bold + "#{PdkSync::Constants::GITLAB_API_ENDPOINT}".cyan
+  end
+  puts '- Namespace: '.bold + "#{PdkSync::Constants::NAMESPACE}".cyan
+  puts '- PDKSync Dir: '.bold + "#{PdkSync::Constants::PDKSYNC_DIR}".cyan
+  puts '- Push File Destination: '.bold + "#{PdkSync::Constants::PUSH_FILE_DESTINATION}".cyan
+  puts '- Create PR Against: '.bold + "#{PdkSync::Constants::CREATE_PR_AGAINST}".cyan
+  puts '- Managed Modules: '.bold + "#{PdkSync::Constants::MANAGED_MODULES}".cyan
+  puts '- Default PDKSync Label: '.bold + "#{PdkSync::Constants::PDKSYNC_LABEL}".cyan
+end
+
 desc 'Run full pdksync process, clone repository, pdk update, create pr. Additional title information can be added to the title, which will be appended before the reference section.'
 task :pdksync, [:additional_title] do |task, args|
   args = {:branch_name    => "pdksync_{ref}",
@@ -10,7 +28,7 @@ task :pdksync, [:additional_title] do |task, args|
   PdkSync::main(steps: [:use_pdk_ref, :clone, :pdk_update, :create_commit, :push_and_create_pr], args: args)
 end
 
-namespace :pdk do 
+namespace :pdk do
   desc 'Runs PDK convert against modules'
   task :pdk_convert do
     PdkSync::main(steps: [:pdk_convert])
@@ -53,7 +71,7 @@ GitHubChangelogGenerator::RakeTask.new :changelog do |config|
   config.user = 'puppetlabs'
   config.project = 'pdksync'
   # config.since_tag = '1.1.1'
-  config.future_release = '0.3.0'
+  config.future_release = '0.4.0'
   config.exclude_labels = ['maintenance']
   config.header = "# Change log\n\nAll notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org)."
   config.add_pr_wo_labels = true

data/lib/pdksync.rb

@@ -4,8 +4,8 @@ require 'open3'
 require 'fileutils'
 require 'rake'
 require 'pdk'
-require 'octokit'
 require 'pdksync/constants'
+require 'pdksync/gitplatformclient'
 require 'json'
 require 'yaml'
 require 'colorize'
@@ -13,8 +13,6 @@ require 'bundler'
 
 # @summary
 #   This module set's out and controls the pdksync process
-# @param [String] @access_token
-#   The token used to access github, must be exported locally.
 # @param [String] @namspace
 #   The namespace of the repositories we are updating.
 # @param [String] @pdksync_dir
@@ -25,22 +23,37 @@ require 'bundler'
 #   The branch the the pull requests are to be made against.
 # @param [String] @managed_modules
 #   The file that the array of managed modules is to be retrieved from.
+# @param [Symbol] @git_platform
+#   The Git hosting platform to use for pull requests
+# @param [String] @git_base_uri
+#   The base URI for Git repository access, for example 'https://github.com' or
+#   'ssh://git@repo.example.com:2222'
+# @param [Hash] @git_platform_access_settings
+#   Hash of access settings required to access the configured Git hosting
+#   platform API. Must always contain the key :access_token set to the exported
+#   GITHUB_TOKEN or GITLAB_TOKEN. In case of Gitlab it also must contain the
+#   key :gitlab_api_endpoint with an appropriate value.
 module PdkSync
   include Constants
-  @access_token = Constants::ACCESS_TOKEN
   @namespace = Constants::NAMESPACE
   @pdksync_dir = Constants::PDKSYNC_DIR
   @push_file_destination = Constants::PUSH_FILE_DESTINATION
   @create_pr_against = Constants::CREATE_PR_AGAINST
   @managed_modules = Constants::MANAGED_MODULES
   @default_pdksync_label = Constants::PDKSYNC_LABEL
+  @git_platform = Constants::GIT_PLATFORM
+  @git_base_uri = Constants::GIT_BASE_URI
+  @git_platform_access_settings = {
+    access_token: Constants::ACCESS_TOKEN,
+    gitlab_api_endpoint: Constants::GITLAB_API_ENDPOINT
+  }
 
   def self.main(steps: [:clone], args: nil)
     create_filespace
     client = setup_client
     module_names = return_modules
     raise "No modules found in '#{@managed_modules}'" if module_names.nil?
-    validate_modules_exist(module_names)
+    validate_modules_exist(client, module_names)
     pr_list = []
 
     # The current directory is saved for cleanup purposes
@@ -59,7 +72,7 @@ module PdkSync
     # validation push_and_create_pr
     if steps.include?(:push_and_create_pr)
       raise 'Needs a pr_title' if args.nil? || args[:pr_title].nil?
-      puts "PR title =#{args[:pr_title]}"
+      puts "PR title =#{args[:additional_title]} #{args[:pr_title]}"
     end
     # validation clean_branches
     if steps.include?(:clean_branches)
@@ -69,6 +82,7 @@ module PdkSync
 
     abort "No modules listed in #{@managed_modules}" if module_names.nil?
     module_names.each do |module_name|
+      module_args = args.clone
       Dir.chdir(main_path) unless Dir.pwd == main_path
       print "#{module_name}, "
       repo_name = "#{@namespace}/#{module_name}"
@@ -98,7 +112,7 @@ module PdkSync
       if steps.include?(:run_a_command)
         Dir.chdir(main_path) unless Dir.pwd == main_path
         print 'run command, '
-        exit_status = run_command(output_path, args)
+        exit_status = run_command(output_path, module_args)
         next unless exit_status.zero?
       end
       if steps.include?(:pdk_update)
@@ -106,18 +120,18 @@ module PdkSync
         next unless pdk_update(output_path).zero?
         if steps.include?(:use_pdk_ref)
           ref = return_template_ref
-          pr_title = args[:additional_title] ? "#{args[:additional_title]} - pdksync_#{ref}" : "pdksync_#{ref}"
-          args = { branch_name: "pdksync_#{ref}",
-                   commit_message: "pdksync_#{ref}",
-                   pr_title: pr_title,
-                   pdksync_label: @default_pdksync_label }
+          pr_title = module_args[:additional_title] ? "#{module_args[:additional_title]} - pdksync_#{ref}" : "pdksync_#{ref}"
+          module_args = module_args.merge(branch_name: "pdksync_#{ref}",
+                                          commit_message: pr_title,
+                                          pr_title: pr_title,
+                                          pdksync_label: @default_pdksync_label)
         end
         print 'pdk update, '
       end
       if steps.include?(:create_commit)
         Dir.chdir(main_path) unless Dir.pwd == main_path
         git_instance = Git.open(output_path)
-        create_commit(git_instance, args[:branch_name], args[:commit_message])
+        create_commit(git_instance, module_args[:branch_name], module_args[:commit_message])
         print 'commit created, '
       end
       if steps.include?(:push_and_create_pr)
@@ -128,7 +142,7 @@ module PdkSync
         pdk_version = return_pdk_version("#{output_path}/metadata.json")
 
         # If a label is supplied, verify that it is available in the repo
-        label = args[:pdksync_label] ? args[:pdksync_label] : args[:label]
+        label = module_args[:pdksync_label] ? module_args[:pdksync_label] : module_args[:label]
         label_valid = (label.is_a?(String) && !label.to_str.empty?) ? check_for_label(client, repo_name, label) : nil
 
         # Exit current iteration if an error occured retrieving a label
@@ -137,7 +151,7 @@ module PdkSync
         end
 
         # Create the PR and add link to pr list
-        pr = create_pr(client, repo_name, git_instance.current_branch, pdk_version, args[:pr_title])
+        pr = create_pr(client, repo_name, git_instance.current_branch, pdk_version, module_args[:pr_title])
         if pr.nil?
           break
         end
@@ -153,7 +167,7 @@ module PdkSync
       end
       if steps.include?(:clean_branches)
         Dir.chdir(main_path) unless Dir.pwd == main_path
-        delete_branch(client, repo_name, args[:branch_name])
+        delete_branch(client, repo_name, module_args[:branch_name])
         print 'branch deleted, '
       end
       puts 'done.'.green
@@ -173,14 +187,12 @@ module PdkSync
 
   # @summary
   #   This method when called will create and return an octokit client with access to the upstream git repositories.
-  # @return [Octokit::Client] client
-  #   The octokit client that has been created.
+  # @return [PdkSync::GitPlatformClient] client
+  #   The Git platform client that has been created.
   def self.setup_client
-    client = Octokit::Client.new(access_token: @access_token.to_s)
-    client.user.login
-    client
-  rescue ArgumentError, Octokit::Unauthorized
-    raise "Access Token not set up correctly - Use export 'GITHUB_TOKEN=<put your token here>' to set it."
+    PdkSync::GitPlatformClient.new(@git_platform, @git_platform_access_settings)
+  rescue StandardError => error
+    raise "Git platform access not set up correctly: #{error}"
   end
 
   # @summary
@@ -193,14 +205,19 @@ module PdkSync
   end
 
   # @summary
-  #   This method when called will parse an array of module names and verify whether they are valid GitHub repo names
+  #   This method when called will parse an array of module names and verify
+  #   whether they are valid repo or project names on the configured Git
+  #   hosting platform.
+  # @param [PdkSync::GitPlatformClient] client
+  #   The Git platform client used to get a repository.
   # @param [Array] module_names
-  #   String array of the names of GitHub repos
-  def self.validate_modules_exist(module_names)
+  #   String array of the names of Git platform repos
+  def self.validate_modules_exist(client, module_names)
     invalid_names = []
+    raise "Error reading in modules. Check syntax of '#{@managed_modules}'." unless !module_names.nil? && module_names.is_a?(Array)
     module_names.each do |module_name|
       # If module name is invalid, push it to invalid names array
-      unless Octokit.repository?("#{@namespace}/#{module_name}")
+      unless client.repository?("#{@namespace}/#{module_name}")
         invalid_names.push(module_name)
         next
       end
@@ -250,7 +267,7 @@ module PdkSync
   # @return [Git::Base]
   #   A git object representing the local repository.
   def self.clone_directory(namespace, module_name, output_path)
-    Git.clone("https://github.com/#{namespace}/#{module_name}.git", output_path.to_s) # is returned
+    Git.clone("#{@git_base_uri}/#{namespace}/#{module_name}.git", output_path.to_s) # is returned
   rescue Git::GitExecuteError => error
     puts "(FAILURE) Cloning #{module_name} has failed. #{error}".red
   end
@@ -352,7 +369,7 @@ module PdkSync
   # @param [String] template_ref
   #   The unique template_ref that is used as part of the commit name.
   # @param [String] commit_message
-  #   If sepecified it will be the message for the commit.
+  #   If specified it will be the message for the commit.
   def self.commit_staged_files(git_repo, template_ref, commit_message = nil)
     message = if commit_message.nil?
                 "pdksync_#{template_ref}"
@@ -378,8 +395,8 @@ module PdkSync
 
   # @summary
   #   This method when called will create a pr on the given repository that will create a pr to merge the given commit into the master with the pdk version as an identifier.
-  # @param [Octokit::Client] client
-  #   The octokit client used to gain access to and manipulate the repository.
+  # @param [PdkSync::GitPlatformClient] client
+  #   The Git platform client used to gain access to and manipulate the repository.
   # @param [String] repo_name
   #   The name of the repository on which the commit is to be made.
   # @param [String] template_ref
@@ -407,8 +424,8 @@ module PdkSync
 
   # @summary
   #   This method when called will check on the given repository for the existence of the supplied label
-  # @param [Octokit::Client] client
-  #   The octokit client used to gain access to and manipulate the repository.
+  # @param [PdkSync::GitPlatformClient] client
+  #   The Git platform client used to gain access to and manipulate the repository.
   # @param [String] repo_name
   #   The name of the repository on which the commit is to be made.
   # @param [String] label
@@ -437,8 +454,8 @@ module PdkSync
 
   # @summary
   #   This method when called will add a given label to a given repository
-  # @param [Octokit::Client] client
-  #   The octokit client used to gain access to and manipulate the repository.
+  # @param [PdkSync::GitPlatformClient] client
+  #   The Git Platform client used to gain access to and manipulate the repository.
   # @param [String] repo_name
   #   The name of the repository on which the commit is to be made.
   # @param [Integer] issue_number
@@ -454,8 +471,8 @@ module PdkSync
 
   # @summary
   #   This method when called will delete any preexisting branch on the given repository that matches the given name.
-  # @param [Octokit::Client] client
-  #   The octokit client used to gain access to and manipulate the repository.
+  # @param [PdkSync::GitPlatformClient] client
+  #   The Git platform client used to gain access to and manipulate the repository.
   # @param [String] repo_name
   #   The name of the repository from which the branch is to be deleted.
   # @param [String] branch_name

data/lib/pdksync/constants.rb

@@ -1,14 +1,78 @@
+require 'yaml'
+
 # @summary
 #   A module used to contain a set of variables that are expected to remain constant across all iterations of the main pdksync module.
+# @note
+#   Configuration is loaded from `$HOME/.pdksync.yml`. If $HOME is not set, the config_path will use the current directory.
+#   Set PDKSYNC_LABEL to '' to disable adding a label during pdksync runs.
 module PdkSync # rubocop:disable Style/ClassAndModuleChildren
+  # Constants contains the configuration for pdksync to use
   module Constants
-    ACCESS_TOKEN = ENV['GITHUB_TOKEN'].freeze
-    NAMESPACE = 'puppetlabs'.freeze
-    PDKSYNC_DIR = 'modules_pdksync'.freeze
-    PUSH_FILE_DESTINATION = 'origin'.freeze
-    CREATE_PR_AGAINST = 'master'.freeze
-    MANAGED_MODULES = 'managed_modules.yml'.freeze
-    # Set PDKSYNC_LABEL to '' to disable adding a label during pdksync runs
-    PDKSYNC_LABEL = 'maintenance'.freeze
+    default_config = {
+      namespace: 'puppetlabs',
+      pdksync_dir: 'modules_pdksync',
+      push_file_destination: 'origin',
+      create_pr_against: 'master',
+      managed_modules: 'managed_modules.yml',
+      pdksync_label: 'maintenance',
+      git_platform: :github,
+      git_base_uri: 'https://github.com',
+      gitlab_api_endpoint: 'https://gitlab.com/api/v4'
+    }
+
+    supported_git_platforms = [:github, :gitlab]
+
+    config = {}
+
+    config_path = "#{ENV['HOME']}/.pdksync.yml"
+
+    # pdksync config file must exist, not be empty and not be an empty YAML file
+    if File.exist?(config_path) && YAML.load_file(config_path) && !YAML.load_file(config_path).nil?
+      custom_config = YAML.load_file(config_path)
+      config[:namespace] = custom_config['namespace'] ||= default_config[:namespace]
+      config[:pdksync_dir] = custom_config['pdksync_dir'] ||= default_config[:pdksync_dir]
+      config[:push_file_destination] = custom_config['push_file_destination'] ||= default_config[:push_file_destination]
+      config[:create_pr_against] = custom_config['create_pr_against'] ||= default_config[:create_pr_against]
+      config[:managed_modules] = custom_config['managed_modules'] ||= default_config[:managed_modules]
+      config[:pdksync_label] = custom_config['pdksync_label'] ||= default_config[:pdksync_label]
+      config[:git_platform] = custom_config['git_platform'] ||= default_config[:git_platform]
+      config[:git_base_uri] = custom_config['git_base_uri'] ||= case config[:git_platform]
+                                                                when :gitlab
+                                                                  'https://gitlab.com'
+                                                                else
+                                                                  default_config[:git_base_uri]
+                                                                end
+      config[:gitlab_api_endpoint] = custom_config['gitlab_api_endpoint'] ||= default_config[:gitlab_api_endpoint]
+    else
+      config = default_config
+    end
+
+    NAMESPACE = config[:namespace].freeze
+    PDKSYNC_DIR = config[:pdksync_dir].freeze
+    PUSH_FILE_DESTINATION = config[:push_file_destination].freeze
+    CREATE_PR_AGAINST = config[:create_pr_against].freeze
+    MANAGED_MODULES = config[:managed_modules].freeze
+    PDKSYNC_LABEL = config[:pdksync_label].freeze
+    GIT_PLATFORM = config[:git_platform].downcase.to_sym.freeze
+    GIT_BASE_URI = config[:git_base_uri].freeze
+    GITLAB_API_ENDPOINT = config[:gitlab_api_endpoint].freeze
+    ACCESS_TOKEN = case GIT_PLATFORM
+                   when :github
+                     ENV['GITHUB_TOKEN'].freeze
+                   when :gitlab
+                     ENV['GITLAB_TOKEN'].freeze
+                   end
+
+    # Sanity checks
+
+    unless supported_git_platforms.include?(GIT_PLATFORM)
+      raise "Unsupported Git hosting platform '#{GIT_PLATFORM}'."\
+        " Supported platforms are: #{supported_git_platforms.join(', ')}"
+    end
+
+    if ACCESS_TOKEN.nil?
+      raise "Git platform access token for #{GIT_PLATFORM.capitalize} not set"\
+        " - use 'export #{GIT_PLATFORM.upcase}_TOKEN=\"<your token>\"' to set"
+    end
   end
 end

data/lib/pdksync/githubclient.rb

@@ -0,0 +1,75 @@
+require 'octokit'
+
+# @summary
+#   This class wraps Octokit::Client and provides the method implementations
+#   required by pdksync main to access the Github API for creating pull
+#   requests, adding labels, and so forth.
+class PdkSync::GithubClient
+  # @summary
+  #   Creates a new Octokit::Client and logs in the user based on the
+  #   supplied access token
+  # @param access_token
+  #   The Github access token, required to access the Github API
+  def initialize(access_token)
+    @client = Octokit::Client.new(access_token: access_token.to_s)
+    @client.user.login
+  end
+
+  # @summary Checks if the supplied repository exists on the Git hosting platform
+  # @param [String] repository
+  #   The full repository name, i.e. "namespace/repo_name"
+  # @return [Boolean] true if the repository exists, false otherwise
+  def repository?(repository)
+    @client.repository?(repository)
+  end
+
+  # @summary Creates a new pull request against the Git hosting platform
+  # @param [String] repo_name
+  #   The full repository name, i.e. "namespace/repo_name" in which to create
+  #   the pull request
+  # @param [String] create_pr_against
+  #   The target branch against which to create the pull request
+  # @param [String] head
+  #   The source branch from which to create the pull request
+  # @param [String] title
+  #   The title/name of the pull request to create
+  # @param [String] message
+  #   The pull request message/body
+  # @return An Octokit pull request object for the newly created pull request
+  def create_pull_request(repo_name, create_pr_against, head, title, message)
+    @client.create_pull_request(repo_name, create_pr_against, head, title, message)
+  end
+
+  # @summary Gets the labels available in the repository
+  # @param [String] repo_name
+  #   The full repository name, i.e. "namespace/repo_name", from which to get
+  #   the available labels
+  # @return [Array] List of available labels in the repository
+  def labels(repo_name)
+    @client.labels(repo_name)
+  end
+
+  # @summary Updates an existing issue/pull request in the repository
+  # @param [String] repo_name
+  #   The full repository name, i.e. "namespace/repo_name" in which to update
+  #   the issue
+  # @param [Integer] issue_number
+  #   The id number of the issue/pull request to update
+  # @param [Hash] options
+  #   A hash of options definint the changes to the issue
+  # @return An Octokit issue object of the updated issue
+  def update_issue(repo_name, issue_number, options)
+    @client.update_issue(repo_name, issue_number, options)
+  end
+
+  # @summary Deletes a branch in the repository
+  # @param [String] repo_name
+  #   The full repository name, i.e. "namespace/repo_name" in which to delete
+  #   the branch
+  # @param [String] branch_name
+  #   The name of the branch to delete
+  # @return [Boolean] true on success, false on failure
+  def delete_branch(repo_name, branch_name)
+    @client.delete_branch(repo_name, branch_name)
+  end
+end

data/lib/pdksync/gitlabclient.rb

@@ -0,0 +1,91 @@
+require 'gitlab'
+
+# @summary
+#   This class wraps Gitlab::Client and provides the method implementations
+#   required by pdksync main to access the Gitlab API for creating merge
+#   requests, adding labels, and so forth.
+class PdkSync::GitlabClient
+  # @summary
+  #   Creates a new Gitlab::Client and logs in the user based on the
+  #   supplied access token and the Gitlab API endpoint URL
+  # @param [String] access_token
+  #   The Gitlab private access token, required to access the Gitlab API
+  # @param [String] gitlab_api_endpoint
+  #   URL to the Gitlab API endpoint against which to work
+  def initialize(access_token, gitlab_api_endpoint)
+    @client = Gitlab.client(endpoint: gitlab_api_endpoint, private_token: access_token)
+  end
+
+  # @summary Checks if the supplied project exists on the Git hosting platform
+  # @param [String] project
+  #   The full repository name, i.e. "namespace/project"
+  # @return [Boolean] true if the project exists, false otherwise
+  def repository?(project)
+    @client.project(project)
+
+    true
+  rescue Gitlab::Error::NotFound
+    false
+  end
+
+  # @summary
+  #   Creates a new merge request (i.e. pull request) against the Gitlab
+  #   platform
+  # @param [String] project
+  #   The full project name, i.e. "namespace/project" in which to create
+  #   the merge request
+  # @param [String] target_branch
+  #   The target branch against which to create the merge request
+  # @param [String] source_branch
+  #   The source branch from which to create the merge request
+  # @param [String] title
+  #   The title/name of the merge request to create
+  # @param [String] message
+  #   The pull request message/body
+  # @return
+  #   A Gitlab merge request object for the newly created merge request
+  def create_pull_request(project, target_branch, source_branch, title, message)
+    mr_options = {
+      source_branch: source_branch,
+      target_branch: target_branch,
+      description: message
+    }
+    @client.create_merge_request(project, title, mr_options)
+  end
+
+  # @summary Gets the labels available in the project
+  # @param [String] project
+  #   The full project name, i.e. "namespace/project", from which to get
+  #   the available labels
+  # @return [Array] List of available labels in the project
+  def labels(project)
+    @client.labels(project)
+  end
+
+  # @summary Updates an existing merge request in the repository
+  # @note This method is specifically used to set labels for a merge request
+  # @param [String] project
+  #   The full project name, i.e. "namespace/project" in which to update
+  #   the issue
+  # @param [Integer] id
+  #   The id number of the merge request to update
+  # @param [Hash] options
+  #   A hash of options defining the changes to the merge request
+  # @return A Gitlab merge request object of the updated merge request
+  def update_issue(project, id, options)
+    # Gitlab requires labels to be supplied as a comma-separated string
+    labels = options[:labels].join(',')
+    @client.update_merge_request(project, id, labels: labels)
+  end
+
+  # @summary Deletes a branch in the project
+  # @param [String] project
+  #   The full project name, i.e. "namespace/project" in which to delete
+  #   the branch
+  # @param [String] branch_name
+  #   The name of the branch to delete
+  # @return [Boolean] true on success, false on failure
+  def delete_branch(project, branch_name)
+    @client.delete_branch(project, branch_name)
+  end
+end

data/lib/pdksync/gitplatformclient.rb

@@ -0,0 +1,109 @@
+require 'pdksync/pullrequest'
+
+# @summary
+#   The GitPlatformClient class creates a PdkSync::GithubClient or
+#   PdkSync::GitlabClient and provides methods wrapping the client's
+#   corresponding methods
+class PdkSync::GitPlatformClient
+  # @summary
+  #   Creates a PdkSync::GithubClient or PdkSync::GitlabClient based on the
+  #   value of git_platform.
+  # @param [Symbol] git_platform
+  #   The symbol designating the Git hosting platform to use and thus which
+  #   client to create
+  # @param [Hash] git_platform_access_settings
+  #   Hash of Git platform access settings, such as access_token or
+  #   gitlab_api_endpoint. access_token is always required,
+  #   gitlab_api_endpoint only for Gitlab.
+  def initialize(git_platform, git_platform_access_settings)
+    @git_platform = git_platform
+
+    # TODO: raise exceptions when git_platform_access_settings hash is not
+    # set up correctly? Or let PdkSync::GithubClient or PdkSync::GitlabClient
+    # raise errors later and let them propagate upwards?
+    access_token = git_platform_access_settings[:access_token]
+    @client = case git_platform
+              when :github
+                require 'pdksync/githubclient'
+
+                PdkSync::GithubClient.new(access_token)
+              when :gitlab
+                require 'pdksync/gitlabclient'
+
+                gitlab_api_endpoint = git_platform_access_settings[:gitlab_api_endpoint]
+                PdkSync::GitlabClient.new(access_token, gitlab_api_endpoint)
+              end
+  end
+
+  # @summary Checks if the supplied project exists on the Git hosting platform
+  # @param [String] project
+  #   The full repository name, i.e. "namespace/project"
+  # @return [Boolean] true if the project exists, false otherwise
+  def repository?(project)
+    @client.repository?(project)
+  end
+
+  # @summary
+  #   Creates a new pull/merge request against the Git hosting platform and
+  #   wraps the Github or Gitlab result in a PdkSync::PullRequest object for
+  #   consumption by pdksync main
+  # @param [String] project
+  #   The full project name, i.e. "namespace/project" in which to create
+  #   the pull/merge request
+  # @param [String] target_branch
+  #   The target branch against which to create the pull/merge request
+  # @param [String] source_branch
+  #   The source branch from which to create the pull/merge request
+  # @param [String] title
+  #   The title/name of the pull/merge request to create
+  # @param [String] message
+  #   The pull/merge request message/body
+  # @return [PdkSync::PullRequest]
+  #   A pdksync pull request object for the newly created pull/merge request
+  #   for consumption by pdksync main
+  def create_pull_request(project, target_branch, source_branch, title, message)
+    client_pr = @client.create_pull_request(project, target_branch, source_branch, title, message)
+    pr = case @git_platform
+         when :github
+           PdkSync::PullRequest.github(client_pr)
+         when :gitlab
+           PdkSync::PullRequest.gitlab(client_pr)
+         end
+    pr
+  end
+
+  # @summary Gets the labels available in the project
+  # @param [String] project
+  #   The full project name, i.e. "namespace/project", from which to get
+  #   the available labels
+  # @return [Array] List of available labels in the project
+  def labels(project)
+    @client.labels(project)
+  end
+
+  # @summary Updates an existing pull/merge request in the repository
+  # @note
+  #   This method is specifically used to set labels for a pull/merge request
+  # @param [String] project
+  #   The full project name, i.e. "namespace/project" in which to update
+  #   the issue
+  # @param [Integer] id
+  #   The id number of the pull/merge request to update
+  # @param [Hash] options
+  #   A hash of options defining the changes to the pull/merge request
+  # @return A pull/merge request object of the updated pull/merge request
+  def update_issue(project, id, options)
+    @client.update_issue(project, id, options)
+  end
+
+  # @summary Deletes a branch in the project
+  # @param [String] project
+  #   The full project name, i.e. "namespace/project" in which to delete
+  #   the branch
+  # @param [String] branch_name
+  #   The name of the branch to delete
+  # @return [Boolean] true on success, false on failure
+  def delete_branch(project, branch_name)
+    @client.delete_branch(project, branch_name)
+  end
+end

data/lib/pdksync/pullrequest.rb

@@ -0,0 +1,35 @@
+# @summary A simple wrapper class around Github pull request and Gitlab merge
+#   request objects used to abstract the differences and provide a common
+#   interface to PR URL and number/id.
+class PdkSync::PullRequest
+  class << self
+    def github(pr_object)
+      new(pr_object)
+    end
+
+    def gitlab(pr_object)
+      new(pr_object, :gitlab)
+    end
+
+    private :new
+  end
+
+  attr_reader :html_url, :number
+
+  # Create a new PR wrapper object setting html_url and number
+  # @param pr_object
+  #   The pull request object to wrap as created by Octokit::Client or
+  #   Gitlab::Client
+  # @param [Symbol] git_platform
+  #   The Git hosting platform against which the pull request is made
+  def initialize(pr_object, git_platform = :github)
+    case git_platform
+    when :github
+      @html_url = pr_object.html_url
+      @number = pr_object.number
+    when :gitlab
+      @html_url = pr_object.web_url
+      @number = pr_object.iid
+    end
+  end
+end

data/pdksync.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name                  = 'pdksync'
-  spec.version               = '0.3.0'
+  spec.version               = '0.4.0'
   spec.authors               = ['Puppet']
   spec.email                 = ['']
   spec.summary               = 'Puppet Module PDK Synchronizer'
@@ -17,11 +17,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop', '~> 0.50.0'
   spec.add_development_dependency 'octokit'
+  spec.add_development_dependency 'gitlab'
   spec.add_development_dependency 'pry'
 
   spec.add_runtime_dependency 'git', '~>1.3'

data/spec/lib/pdksync_spec.rb

@@ -14,6 +14,7 @@ describe PdkSync do
 
   before(:each) do
     allow(PdkSync).to receive(:return_modules).and_return(@module_names)
+    allow(PdkSync).to receive(:validate_modules_exist).and_return(@module_names)
     Dir.chdir(@folder)
   end
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pdksync
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-15 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +155,10 @@ files:
 - Rakefile
 - lib/pdksync.rb
 - lib/pdksync/constants.rb
+- lib/pdksync/githubclient.rb
+- lib/pdksync/gitlabclient.rb
+- lib/pdksync/gitplatformclient.rb
+- lib/pdksync/pullrequest.rb
 - managed_modules.yml
 - pdksync.gemspec
 - spec/lib/pdksync_spec.rb
@@ -164,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Puppet Module PDK Synchronizer