pdksync 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 1ddb56d6bd4366f686243b4d773083709f966726caf0d2fd580aba1e9373c890
-  data.tar.gz: 34063f7b4a545f18f89c58b260061ffb93575b7f15ad932cb8ddeb9ed50ea209
+SHA1:
+  metadata.gz: dcb6ea51b43a295e28ab7a3bb90ccf3d398ccdbd
+  data.tar.gz: f214afd41acd5fc6bba7557e3ce79230a8e1dde8
 SHA512:
-  metadata.gz: 027c7bf9b6d2482631119390863bccc0295a4c8737ef3e741a793cf163f57a726be46a99fb116d43055deeab3f69420ee88065878e8d58df637d0536e57055a1
-  data.tar.gz: 25b0cec819fb71ee5030e3a357deacb8ce219bd81323bf33e861b3cd5b456bd9dacf2f6993e32e52fadcdcd298ea530d439eb1093aa9d21667a2a18b03abc66b
+  metadata.gz: 69ee152722be2fa9a862727de092981c1c9855a44c36e5b1033b22a4883585a0ef8596fa666ca8d65443ae2fec3244c16b590e7d034a479ba83e30baf3773ee5
+  data.tar.gz: 542e70e07027ad294e99d5d0933b36e586feed3bd55c3036edef2eb26832eea3cb8324d7ff50297be69eb01e78dd7dabd376679097e4a0686a83f45696c194d8

data/CHANGELOG.md

@@ -2,9 +2,22 @@
 
 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.2.0](https://github.com/puppetlabs/pdksync/tree/0.1.0) (2018-11-02)
+## [0.3.0](https://github.com/puppetlabs/pdksync/tree/0.3.0) (2018-11-15)
 
-[Full Changelog](https://github.com/puppetlabs/pdksync/compare/0.1.0...0.1.0)
+[Full Changelog](https://github.com/puppetlabs/pdksync/compare/0.2.0...0.3.0)
+
+### Added
+
+- \(MODULES-8231\) - Add additional title info for pdksync runs [\#76](https://github.com/puppetlabs/pdksync/pull/76) ([eimlav](https://github.com/eimlav))
+- \(MODULES-7695\) - Add maintenance labels for PRs [\#75](https://github.com/puppetlabs/pdksync/pull/75) ([eimlav](https://github.com/eimlav))
+
+### Fixed
+
+- \(MODULES-8002\) - Fix bundle commands not running in correct dir [\#79](https://github.com/puppetlabs/pdksync/pull/79) ([eimlav](https://github.com/eimlav))
+
+## [0.2.0](https://github.com/puppetlabs/pdksync/tree/0.2.0) (2018-11-02)
+
+[Full Changelog](https://github.com/puppetlabs/pdksync/compare/0.1.0...0.2.0)
 
 ### Added
 

data/README.md

@@ -41,6 +41,20 @@ 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.
+
+The following rake tasks are available with 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]'.
+- `git:clean[:branch_name]` Clean up origin branches, (branches must include pdksync in their name) eg rake 'git:clean[pdksync_origin_branch]'.
+- `pdk:pdk_convert` Runs PDK convert against modules.
+- `pdk:pdk_validate` Runs PDK validate against modules.
+- `pdksync[:additional_title]` Run full pdksync process, clone repository, pdk update, create pr. Additional information can be added to the title, which will be appended before the reference section.
+  - `rake pdksync` PR title outputs as `pdksync - pdksync_heads/master-0-gabccfb1`
+  - `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]'
+
 ### Workflow
 --------
 

data/Rakefile

@@ -1,11 +1,12 @@
 require_relative 'lib/pdksync'
 require 'github_changelog_generator/task'
 
-desc 'Run full pdksync process, clone repository, pdk update, create pr.'
-task :pdksync do
-  args = {:branch_name => "pdksync_{ref}",
-        :commit_message => "pdksync_{ref}",
-        :pr_title => "pdksync_{ref}"}
+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}",
+          :commit_message => "pdksync_{ref}",
+          :pr_title       => "pdksync_{ref}",
+          :additional_title => args[:additional_title]}
   PdkSync::main(steps: [:use_pdk_ref, :clone, :pdk_update, :create_commit, :push_and_create_pr], args: args)
 end
 
@@ -32,8 +33,8 @@ namespace :git do
     PdkSync::main(steps: [:create_commit], args: args)
   end
 
-  desc "Push commit, and create PR for modules eg rake 'git:push_and_create_pr[pr title goes here]'"
-  task :push_and_create_pr, [:pr_title]  do |task, args|
+  desc "Push commit, and create PR for modules eg rake 'git:push_and_create_pr[pr title goes here, optional label right here]'"
+  task :push_and_create_pr, [:pr_title, :label]  do |task, args|
     PdkSync::main(steps: [:push_and_create_pr], args: args)
   end
 
@@ -52,7 +53,7 @@ GitHubChangelogGenerator::RakeTask.new :changelog do |config|
   config.user = 'puppetlabs'
   config.project = 'pdksync'
   # config.since_tag = '1.1.1'
-  config.future_release = '0.1.0'
+  config.future_release = '0.3.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

@@ -9,6 +9,7 @@ require 'pdksync/constants'
 require 'json'
 require 'yaml'
 require 'colorize'
+require 'bundler'
 
 # @summary
 #   This module set's out and controls the pdksync process
@@ -32,12 +33,16 @@ module PdkSync
   @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
 
   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)
     pr_list = []
+
     # The current directory is saved for cleanup purposes
     main_path = Dir.pwd
 
@@ -101,9 +106,11 @@ 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: "pdksync_#{ref}" }
+                   pr_title: pr_title,
+                   pdksync_label: @default_pdksync_label }
         end
         print 'pdk update, '
       end
@@ -119,9 +126,30 @@ module PdkSync
         push_staged_files(git_instance, git_instance.current_branch, repo_name)
         print 'push, '
         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_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
+        if label_valid == false
+          raise 'Ensure label is valid'
+        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])
+        if pr.nil?
+          break
+        end
+
         pr_list.push(pr.html_url)
         print 'created pr, '
+
+        # If a valid label is supplied, add this to the PR
+        if label_valid == true
+          add_label(client, repo_name, pr.number, label)
+          print "added label '#{label}' "
+        end
       end
       if steps.include?(:clean_branches)
         Dir.chdir(main_path) unless Dir.pwd == main_path
@@ -160,9 +188,27 @@ module PdkSync
   # @return [Array]
   #   An array of different module names.
   def self.return_modules
+    raise "File '#{@managed_modules}' is empty/does not exist" if File.size?(@managed_modules).nil?
     YAML.safe_load(File.open(@managed_modules))
   end
 
+  # @summary
+  #   This method when called will parse an array of module names and verify whether they are valid GitHub repo names
+  # @param [Array] module_names
+  #   String array of the names of GitHub repos
+  def self.validate_modules_exist(module_names)
+    invalid_names = []
+    module_names.each do |module_name|
+      # If module name is invalid, push it to invalid names array
+      unless Octokit.repository?("#{@namespace}/#{module_name}")
+        invalid_names.push(module_name)
+        next
+      end
+    end
+    # Raise error if any invalid matches were found
+    raise "Could not find the following repositories: #{invalid_names}" unless invalid_names.empty?
+  end
+
   # @summary
   #   Try to use a fully installed pdk, otherwise fall back to the bundled pdk gem.
   # @return String
@@ -218,8 +264,21 @@ module PdkSync
   # @return [Integer]
   #   The status code of the command run.
   def self.run_command(output_path, command)
+    stdout = ''
+    stderr = ''
+    status = Process::Status
+
     Dir.chdir(output_path) unless Dir.pwd == output_path
-    stdout, stderr, status = Open3.capture3(command)
+
+    # Environment cleanup required due to Ruby subshells using current Bundler environment
+    if command =~ %r{^bundle}
+      Bundler.with_clean_env do
+        stdout, stderr, status = Open3.capture3(command)
+      end
+    else
+      stdout, stderr, status = Open3.capture3(command)
+    end
+
     puts "\n#{stdout}\n".yellow
     puts "(FAILURE) Unable to run command '#{command}': #{stderr}".red unless status.exitstatus.zero?
     status.exitstatus
@@ -346,6 +405,53 @@ module PdkSync
     puts "(FAILURE) PR creation for #{repo_name} has failed. #{error}".red
   end
 
+  # @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 [String] repo_name
+  #   The name of the repository on which the commit is to be made.
+  # @param [String] label
+  #   The label to check for.
+  # @return [Boolean]
+  #   A boolean stating whether the label was found.
+  def self.check_for_label(client, repo_name, label)
+    # Get labels from repository
+    repo_labels = client.labels(repo_name)
+
+    # Look for label in the repository's labels
+    match = false
+    repo_labels.each do |repo_label|
+      if repo_label.name == label
+        match = true
+        break
+      end
+    end
+
+    # Raise error if a match was not found else return true
+    (match == false) ? (raise StandardError, "Label '#{label}' not found in #{repo_name}") : (return true)
+  rescue StandardError => error
+    puts "(FAILURE) Retrieving labels for #{repo_name} has failed. #{error}".red
+    return false
+  end
+
+  # @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 [String] repo_name
+  #   The name of the repository on which the commit is to be made.
+  # @param [Integer] issue_number
+  #   The id of the issue (i.e. pull request) to add the label to.
+  # @param [String] label
+  #   The label to add.
+  def self.add_label(client, repo_name, issue_number, label)
+    client.update_issue(repo_name, issue_number, labels: [label])
+  rescue StandardError => error
+    puts "(FAILURE) Adding label to #{repo_name} issue #{issue_number} has failed. #{error}".red
+    return false
+  end
+
   # @summary
   #   This method when called will delete any preexisting branch on the given repository that matches the given name.
   # @param [Octokit::Client] client

data/lib/pdksync/constants.rb

@@ -8,5 +8,7 @@ module PdkSync # rubocop:disable Style/ClassAndModuleChildren
     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
   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.2.0'
+  spec.version               = '0.3.0'
   spec.authors               = ['Puppet']
   spec.email                 = ['']
   spec.summary               = 'Puppet Module PDK Synchronizer'

data/spec/lib/pdksync_spec.rb

@@ -47,6 +47,9 @@ describe PdkSync do
     it 'raise when push_and_create_pr with no arguments' do
       expect { PdkSync.main(steps: [:push_and_create_pr]) }.to raise_error(RuntimeError, %r{Needs a pr_title})
     end
+    it 'raise when push_and_create_pr with invalid label' do
+      expect { PdkSync.main(steps: [:push_and_create_pr], args: { pr_title: 'My amazing PR', label: 'doot doot' }) }.to raise_error(RuntimeError, %r{Ensure label is valid})
+    end
     it 'raise when clean_branches with no arguments' do
       expect { PdkSync.main(steps: [:clean_branches]) }.to raise_error(RuntimeError, %r{Needs a branch_name, and the branch name contains the string pdksync})
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdksync
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-02 00:00:00.000000000 Z
+date: 2018-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Puppet Module PDK Synchronizer