pdksync 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5260a9b4d496039fb943d35a3505fd6491b67981
-  data.tar.gz: ae071b8c16b894de1afe41b9a972132fdee4471f
+SHA256:
+  metadata.gz: 1ddb56d6bd4366f686243b4d773083709f966726caf0d2fd580aba1e9373c890
+  data.tar.gz: 34063f7b4a545f18f89c58b260061ffb93575b7f15ad932cb8ddeb9ed50ea209
 SHA512:
-  metadata.gz: 429b87f768527fedfb9c9d72712995c61364c159c35a67f6639c7be1db497a8feebb79a87c7b2b8ffc3a5b8d1cc9eb3e91ddffb9358a6836fbb703d32b7315fb
-  data.tar.gz: c5c52a3fe2e4389cebcbc5ff314991cf47cbf003962d0b41451cb834039156ba1aae54520a843a22cf954c71c10748c1b966fccbbb843aad72d5bc5974ef508a
+  metadata.gz: 027c7bf9b6d2482631119390863bccc0295a4c8737ef3e741a793cf163f57a726be46a99fb116d43055deeab3f69420ee88065878e8d58df637d0536e57055a1
+  data.tar.gz: 25b0cec819fb71ee5030e3a357deacb8ce219bd81323bf33e861b3cd5b456bd9dacf2f6993e32e52fadcdcd298ea530d439eb1093aa9d21667a2a18b03abc66b

data/.gitignore

@@ -3,3 +3,4 @@ modules/
 *.gem
 Gemfile.lock
 .bundle/
+modules_pdksync/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -1,25 +1,27 @@
----
 sudo: false
 dist: trusty
 language: ruby
 cache: bundler
 before_install:
-  - bundle -v
-  - rm -f Gemfile.lock
-  - gem update --system
-  - gem --version
-  - bundle -v
+- bundle -v
+- rm -f Gemfile.lock
+- gem update --system
+- gem --version
+- bundle -v
 script:
-  - 'bundle exec $CHECK'
+- bundle exec $CHECK
 rvm:
-  - 2.4.1
+- 2.4.1
 matrix:
   fast_finish: true
   include:
-    - env: CHECK='rubocop'
-    - env: CHECK='rspec spec'
+  - env: CHECK='rubocop'
+  - env: CHECK='rspec spec'
 branches:
   only:
-    - master
-    - /^v\d/
-    - release
+  - master
+  - "/^v\\d/"
+  - release
+env:
+  global:
+    secure: Hk8cxtIHM6kyRBSmcWWUSXUV50E/yo3MGJf3mPphb3ORUfzqjB8FGZLSn1VCIP81y++U6pZAg8/AkvcDNME0at1wWh/ONiOwYKxAyyVfr0/5/i7a+dIj/9MX2kUT6MBKZXipbln/u5brdwBAHJccFHz7doq30Nd108KE5ucqf0ZbptJyDbpsrIturK9Hx+mde9sYd6MyNlzGJkQOhSL22Zd+ppBSf/GDpk2+yWN171oGwHDPWPE47q4nkIrWjnWy0kLCqxoM0zHIPxPES6lhudso4ofbumnRiHcr7DldReC8Rq1CUe/fhG7udGEdPN26JAREyUeD8MOwo2uQohQluHvjOMx9leF7Sbu+tk5E2bqVz5ofm0bksZUIBahUtGP+REvwVruFOH8RsvO3pQBndDKG11691UY55L9qZNaQ82cNOWbfG1nNuglH0GIpJgdhjvWuGw1he4c18u1fgQGM01xO7JEDIpYHrrjBboD3mL/iXMmvxwg35eIrlkfdgl9DTBWqKOoLi79WpkDajI+2B/ABXW4L/WKWlM041UjAs5/r3jgkbcZz1nZVbU4Wa5r/6RvIfrM/FXnaGuZcwx7VdPBmfyhV4rgM4siyJDdhqudTRsq1+Al9q3MhZcyKQLmad8ShEx+dfG9WRBoayE+piD/9xkfriqdMk5YEjH02grE=

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 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)
+
+[Full Changelog](https://github.com/puppetlabs/pdksync/compare/0.1.0...0.1.0)
+
+### Added
+
+- \(feat\) add colourised output, fix pdk path [\#68](https://github.com/puppetlabs/pdksync/pull/68) ([tphoney](https://github.com/tphoney))
+- \(CLOUD-2094\) adding container modules to the list [\#67](https://github.com/puppetlabs/pdksync/pull/67) ([sheenaajay](https://github.com/sheenaajay))
+- \(feat\) adding git commit rake task [\#63](https://github.com/puppetlabs/pdksync/pull/63) ([tphoney](https://github.com/tphoney))
+- \(FEAT\) add clone\_managed\_modules task [\#58](https://github.com/puppetlabs/pdksync/pull/58) ([tphoney](https://github.com/tphoney))
+
+### Fixed
+
+- Use https instead of ssh for the clone [\#72](https://github.com/puppetlabs/pdksync/pull/72) ([HelenCampbell](https://github.com/HelenCampbell))
+
 ## [0.1.0](https://github.com/puppetlabs/pdksync/tree/0.1.0) (2018-05-23)
 
 [Full Changelog](https://github.com/puppetlabs/pdksync/compare/73bf282b297781bc26562bfb51b91b4f7b1632d1...0.1.0)
@@ -30,4 +45,4 @@ All notable changes to this project will be documented in this file. The format
 
 
 
-\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -6,3 +6,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 gem 'github_changelog_generator', git: 'https://github.com/skywinder/github-changelog-generator', ref: 'master'
+gem 'travis'
+gem 'colorize'

data/README.md

@@ -140,7 +140,7 @@ This tool has been developed and tested on OSX and Linux. **It currently does no
 --------
 
 1. Fork the repo
-2. Create your feature branch: 
+2. Create your feature branch:
 ```
 git checkout -b my-new-feature
 ```

data/Rakefile

@@ -1,17 +1,51 @@
 require_relative 'lib/pdksync'
 require 'github_changelog_generator/task'
 
-
-desc 'Run pdk update'
+desc 'Run full pdksync process, clone repository, pdk update, create pr.'
 task :pdksync do
-  PdkSync::run_pdksync
-  puts "The script has run."
+  args = {:branch_name => "pdksync_{ref}",
+        :commit_message => "pdksync_{ref}",
+        :pr_title => "pdksync_{ref}"}
+  PdkSync::main(steps: [:use_pdk_ref, :clone, :pdk_update, :create_commit, :push_and_create_pr], args: args)
+end
+
+namespace :pdk do 
+  desc 'Runs PDK convert against modules'
+  task :pdk_convert do
+    PdkSync::main(steps: [:pdk_convert])
+  end
+
+  desc 'Runs PDK validate against modules'
+  task :pdk_validate do
+    PdkSync::main(steps: [:pdk_validate])
+  end
+end
+
+namespace :git do
+  desc 'Clone managed modules'
+  task :clone_managed_modules do
+    PdkSync::main(steps: [:clone])
+  end
+
+  desc "Stage commits for modules, branchname and commit message eg rake 'git:create_commit[flippity, commit messagez]'"
+  task :create_commit, [:branch_name, :commit_message] do |task, args|
+    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|
+    PdkSync::main(steps: [:push_and_create_pr], args: args)
+  end
+
+  desc "Clean up origin branches, (branches must include pdksync in their name) eg rake 'git:clean[pdksync_origin_branch]'"
+  task :clean_branches, [:branch_name]  do |task, args|
+    PdkSync::main(steps: [:clean_branches], args: args)
+  end
 end
 
-desc 'Run pdksync cleanup'
-task :pdksync_cleanup do
-  PdkSync::clean_branches
-  puts "The script has run."
+desc "Run a command against modules eg rake 'run_a_command[complex command here -f -gx]'"
+task :run_a_command, [:command] do |task, args|
+  PdkSync::main(steps: [:run_a_command], args: args[:command])
 end
 
 GitHubChangelogGenerator::RakeTask.new :changelog do |config|

data/lib/pdksync.rb

@@ -8,6 +8,7 @@ require 'octokit'
 require 'pdksync/constants'
 require 'json'
 require 'yaml'
+require 'colorize'
 
 # @summary
 #   This module set's out and controls the pdksync process
@@ -32,23 +33,107 @@ module PdkSync
   @create_pr_against = Constants::CREATE_PR_AGAINST
   @managed_modules = Constants::MANAGED_MODULES
 
-  # @summary
-  #   When a new instance of this module is called, this method will be run in order to start the pdksync process.
-  def self.run_pdksync
-    puts 'Beginning pdksync run'
+  def self.main(steps: [:clone], args: nil)
     create_filespace
-    @client = setup_client
-    @module_names = return_modules
+    client = setup_client
+    module_names = return_modules
+    pr_list = []
     # The current directory is saved for cleanup purposes
-    @main_path = Dir.pwd
+    main_path = Dir.pwd
 
-    # Run an iterative loop for each @module_name
-    @module_names.each do |module_name|
-      puts '*************************************'
-      puts "Syncing #{module_name}"
-      sync(module_name, @client)
-      # Cleanup used to ensure that the current directory is reset after each run.
-      Dir.chdir(@main_path) unless Dir.pwd == @main_path
+    # validation run_a_command
+    if steps.include?(:run_a_command)
+      raise '"run_a_command" requires an argument to run.' if args.nil?
+      puts "Command '#{args}'"
+    end
+    # validation create_commit
+    if steps.include?(:create_commit)
+      raise 'Needs a branch_name and commit_message' if args.nil? || args[:commit_message].nil? || args[:branch_name].nil?
+      puts "Commit branch_name=#{args[:branch_name]} commit_message=#{args[:commit_message]}"
+    end
+    # 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]}"
+    end
+    # validation clean_branches
+    if steps.include?(:clean_branches)
+      raise 'Needs a branch_name, and the branch name contains the string pdksync' if args.nil? || args[:branch_name].nil? || !args[:branch_name].include?('pdksync')
+      puts "Removing branch_name =#{args[:branch_name]}"
+    end
+
+    abort "No modules listed in #{@managed_modules}" if module_names.nil?
+    module_names.each do |module_name|
+      Dir.chdir(main_path) unless Dir.pwd == main_path
+      print "#{module_name}, "
+      repo_name = "#{@namespace}/#{module_name}"
+      output_path = "#{@pdksync_dir}/#{module_name}"
+      if steps.include?(:clone)
+        clean_env(output_path) if Dir.exist?(output_path)
+        print 'delete module directory, '
+        @git_repo = clone_directory(@namespace, module_name, output_path)
+        print 'cloned, '
+        puts "(WARNING) Unable to clone repo for #{module_name}".red if @git_repo.nil?
+        Dir.chdir(main_path) unless Dir.pwd == main_path
+        next if @git_repo.nil?
+      end
+      puts '(WARNING) @output_path does not exist, skipping module'.red unless File.directory?(output_path)
+      next unless File.directory?(output_path)
+      if steps.include?(:pdk_convert)
+        exit_status = run_command(output_path, "#{return_pdk_path} convert --force --template-url https://github.com/puppetlabs/pdk-templates")
+        print 'converted, '
+        next unless exit_status.zero?
+      end
+      if steps.include?(:pdk_validate)
+        Dir.chdir(main_path) unless Dir.pwd == main_path
+        exit_status = run_command(output_path, "#{return_pdk_path} validate -a")
+        print 'validated, '
+        next unless exit_status.zero?
+      end
+      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)
+        next unless exit_status.zero?
+      end
+      if steps.include?(:pdk_update)
+        Dir.chdir(main_path) unless Dir.pwd == main_path
+        next unless pdk_update(output_path).zero?
+        if steps.include?(:use_pdk_ref)
+          ref = return_template_ref
+          args = { branch_name: "pdksync_#{ref}",
+                   commit_message: "pdksync_#{ref}",
+                   pr_title: "pdksync_#{ref}" }
+        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])
+        print 'commit created, '
+      end
+      if steps.include?(:push_and_create_pr)
+        Dir.chdir(main_path) unless Dir.pwd == main_path
+        git_instance = Git.open(output_path)
+        push_staged_files(git_instance, git_instance.current_branch, repo_name)
+        print 'push, '
+        pdk_version = return_pdk_version("#{output_path}/metadata.json")
+        pr = create_pr(client, repo_name, git_instance.current_branch, pdk_version, args[:pr_title])
+        pr_list.push(pr.html_url)
+        print 'created pr, '
+      end
+      if steps.include?(:clean_branches)
+        Dir.chdir(main_path) unless Dir.pwd == main_path
+        delete_branch(client, repo_name, args[:branch_name])
+        print 'branch deleted, '
+      end
+      puts 'done.'.green
+    end
+    return if pr_list.size.zero?
+    puts "\nPRs created:\n".blue
+    pr_list.each do |pr|
+      puts pr
     end
   end
 
@@ -65,9 +150,8 @@ module PdkSync
   def self.setup_client
     client = Octokit::Client.new(access_token: @access_token.to_s)
     client.user.login
-    puts 'Client login has been successful.'
     client
-  rescue ArgumentError
+  rescue ArgumentError, Octokit::Unauthorized
     raise "Access Token not set up correctly - Use export 'GITHUB_TOKEN=<put your token here>' to set it."
   end
 
@@ -80,29 +164,24 @@ module PdkSync
   end
 
   # @summary
-  #   This method when called will take in a module name and an octokit client and use them to run the pdksync process on the given module.
-  #   If @git_repo is not set the clone will have failed, in which case we avoid further action. If the pdk update fails it will move to the
-  #   next module.
-  # @param [String] module_name
-  #   The name of the module to be put through the process
-  # @param [Octokit::Client] client
-  #   The client used to access github.
-  def self.sync(module_name, client)
-    @repo_name = "#{@namespace}/#{module_name}"
-    @output_path = "#{@pdksync_dir}/#{module_name}"
-    clean_env(@output_path) if Dir.exist?(@output_path)
-    @git_repo = clone_directory(@namespace, module_name, @output_path)
-
-    return if @git_repo.nil?
-    return unless pdk_update(@output_path) == 0 # rubocop:disable Style/NumericPredicate
+  #   Try to use a fully installed pdk, otherwise fall back to the bundled pdk gem.
+  # @return String
+  #   Path to the pdk executable
+  def self.return_pdk_path
+    full_path = '/opt/puppetlabs/pdk/bin/pdk'
+    path = if File.executable?(full_path)
+             full_path
+           else
+             puts "(WARNING) Using pdk on PATH not '#{full_path}'".red
+             'pdk'
+           end
+    path
+  end
 
-    @template_ref = return_template_ref
-    checkout_branch(@git_repo, @template_ref)
-    @pdk_version = return_pdk_version
-    add_staged_files(@git_repo)
-    commit_staged_files(@git_repo, @template_ref)
-    push_staged_files(@git_repo, @template_ref, @repo_name)
-    create_pr(client, @repo_name, @template_ref, @pdk_version)
+  def self.create_commit(git_repo, branch_name, commit_message)
+    checkout_branch(git_repo, branch_name)
+    add_staged_files(git_repo)
+    commit_staged_files(git_repo, branch_name, commit_message)
   end
 
   # @summary
@@ -110,7 +189,6 @@ module PdkSync
   # @param [String] output_path
   #   The repository that is to be deleted.
   def self.clean_env(output_path)
-    puts 'Cleaning your environment.'
     # If a local copy already exists it is removed
     FileUtils.rm_rf(output_path)
   end
@@ -126,27 +204,25 @@ module PdkSync
   # @return [Git::Base]
   #   A git object representing the local repository.
   def self.clone_directory(namespace, module_name, output_path)
-    puts "Cloning #{module_name} to #{output_path}."
     Git.clone("https://github.com/#{namespace}/#{module_name}.git", output_path.to_s) # is returned
-  rescue Git::GitExecuteError
-    puts "(FAILURE) Cloning #{module_name} has failed - check the module name and namespace are correct."
+  rescue Git::GitExecuteError => error
+    puts "(FAILURE) Cloning #{module_name} has failed. #{error}".red
   end
 
   # @summary
-  #   This method when called will run the 'pdk convert' command at the given location, with an error message being thrown if it is not successful.
+  #   This method when called will run a command command at the given location, with an error message being thrown if it is not successful.
   # @param [String] output_path
   #   The location that the command is to be run from.
+  # @param [String] command
+  #   The command to be run.
   # @return [Integer]
-  #   The status code of the pdk converty run.
-  def self.pdk_convert(output_path)
+  #   The status code of the command run.
+  def self.run_command(output_path, command)
     Dir.chdir(output_path) unless Dir.pwd == output_path
-    _stdout, stderr, status = Open3.capture3('pdk convert --force --template-url https://github.com/puppetlabs/pdk-templates')
-    if status != 0
-      puts "(FAILURE) Unable to run `pdk convert`: #{stderr}"
-    else
-      puts 'PDK convert has run.'
-    end
-    status
+    stdout, stderr, status = Open3.capture3(command)
+    puts "\n#{stdout}\n".yellow
+    puts "(FAILURE) Unable to run command '#{command}': #{stderr}".red unless status.exitstatus.zero?
+    status.exitstatus
   end
 
   # @summary
@@ -158,31 +234,9 @@ module PdkSync
   def self.pdk_update(output_path)
     # Runs the pdk update command
     Dir.chdir(output_path) unless Dir.pwd == output_path
-    stdout, stderr, status = Open3.capture3('pdk update --force')
-    if status != 0
-      puts "(FAILURE) Unable to run `pdk update`: #{stderr}"
-    else
-      puts 'PDK update has run.'
-    end
-    return status unless status == 0 && stdout.include?('No changes required.') # rubocop:disable Style/NumericPredicate
-    puts 'No commits since last run.'
-  end
-
-  # @summary
-  #   This method when called will run the 'pdk validate -a' command at the given location, with an error message being thrown if it is not successful.
-  # @param [String] output_path
-  #   The location that the command is to be run from.
-  # @return [Integer]
-  #   The status code of the pdk validate run.
-  def self.validate_autofix
-    # Runs the pdk validate command
-    _stdout, stderr, status = Open3.capture3('pdk validate -a')
-    if status != 0
-      puts "(FAILURE) Something went wrong with the validate: #{stderr}"
-    else
-      puts 'Validate has run successfully.'
-    end
-    status
+    _stdout, stderr, status = Open3.capture3("#{return_pdk_path} update --force")
+    puts "(FAILURE) Unable to run `pdk update`: #{stderr}".red unless status.exitstatus.zero?
+    status.exitstatus
   end
 
   # @summary
@@ -201,11 +255,10 @@ module PdkSync
   #   This method when called will checkout a new local branch of the given repository.
   # @param [Git::Base] git_repo
   #   A git object representing the local repository to be branched.
-  # @param [String] template_ref
-  #   The unique template_ref that is used as part of the branch name.
-  def self.checkout_branch(git_repo, template_ref)
-    puts "Creating the following branch: pdksync_#{template_ref}."
-    git_repo.branch("pdksync_#{template_ref}".to_s).checkout
+  # @param [String] branch_suffix
+  #   The string that is appended on the branch name. eg template_ref or a friendly name
+  def self.checkout_branch(git_repo, branch_suffix)
+    git_repo.branch("pdksync_#{branch_suffix}").checkout
   end
 
   # @summary
@@ -225,8 +278,12 @@ module PdkSync
   # @param [Git::Base] git_repo
   #   A git object representing the local repository to be staged.
   def self.add_staged_files(git_repo)
-    git_repo.add(all: true)
-    puts 'All files have been staged.'
+    if git_repo.status.changed != {}
+      git_repo.add(all: true)
+      puts 'All files have been staged.'
+    else
+      puts 'Nothing to commit.'
+    end
   end
 
   # @summary
@@ -235,9 +292,15 @@ module PdkSync
   #   A git object representing the local repository against which the commit is to be made.
   # @param [String] template_ref
   #   The unique template_ref that is used as part of the commit name.
-  def self.commit_staged_files(git_repo, template_ref)
-    git_repo.commit("pdksync_#{template_ref}")
-    puts "Creating the following commit: pdksync_#{template_ref}."
+  # @param [String] commit_message
+  #   If sepecified 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}"
+              else
+                commit_message
+              end
+    git_repo.commit(message)
   end
 
   # @summary
@@ -248,11 +311,10 @@ module PdkSync
   #   The unique reference that that represents the template the update has ran against.
   # @param [String] repo_name
   #   The name of the repository on which the commit is to be made.
-  def self.push_staged_files(git_repo, template_ref, repo_name)
-    git_repo.push(@push_file_destination, "pdksync_#{template_ref}")
-    puts 'All staged files have been pushed to the repo, bon voyage!'
-  rescue StandardError
-    puts "(FAILURE) Pushing to #{@push_file_destination} for #{repo_name} has failed."
+  def self.push_staged_files(git_repo, current_branch, repo_name)
+    git_repo.push(@push_file_destination, current_branch)
+  rescue StandardError => error
+    puts "(FAILURE) Pushing to #{@push_file_destination} for #{repo_name} has failed. #{error}".red
   end
 
   # @summary
@@ -265,46 +327,23 @@ module PdkSync
   #   The unique reference that that represents the template the update has ran against.
   # @param [String] pdk_version
   #   The current version of the pdk on which the update is run.
-  def self.create_pr(client, repo_name, template_ref, pdk_version)
+  def self.create_pr(client, repo_name, template_ref, pdk_version, pr_title = nil)
+    if pr_title.nil?
+      title = "pdksync - Update using #{pdk_version}"
+      message = "pdk version: `#{pdk_version}` \n pdk template ref: `#{template_ref}`"
+      head = "pdksync_#{template_ref}"
+    else
+      title = "pdksync - #{pr_title}"
+      message = "#{pr_title}\npdk version: `#{pdk_version}` \n"
+      head = template_ref
+    end
     pr = client.create_pull_request(repo_name, @create_pr_against,
-                                    "pdksync_#{template_ref}".to_s,
-                                    "pdksync - Update using #{pdk_version}",
-                                    "pdk version: `#{pdk_version}` \n pdk template ref: `#{template_ref}`")
-    puts 'The PR has been created.'
+                                    head,
+                                    title,
+                                    message)
     pr
-  rescue StandardError
-    puts "(FAILURE) PR creation for #{repo_name} has failed."
-  end
-
-  # @summary
-  #   This method when called will retrieve a list of module names and then proceed to iterate
-  #     through them, removing any branch that contains the word 'pdksync'.
-  def self.clean_branches
-    puts 'Beginning pdksync cleanup run'
-    @client = setup_client
-    @module_names = return_modules
-
-    @module_names.each do |module_name|
-      puts '*************************************'
-      puts "Cleaning #{module_name}"
-      @repo_name = "#{@namespace}/#{module_name}"
-      retrieve_branches(@client, @repo_name).each do |branch|
-        delete_branch(@client, @repo_name, branch.name) if branch.name.include? 'pdksync'
-      end
-    end
-  end
-
-  # @summary
-  #   This method when called will retrieve any and all branches from the 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 from which the branches are to be retrieved.
-  # @return [Array]
-  #   An array containing all existing branches
-  def self.retrieve_branches(client, repo_name)
-    puts "Retrieving branches from #{repo_name}"
-    client.branches(repo_name)
+  rescue StandardError => error
+    puts "(FAILURE) PR creation for #{repo_name} has failed. #{error}".red
   end
 
   # @summary
@@ -316,7 +355,8 @@ module PdkSync
   # @param [String] branch_name
   #   The name of the branch that is to be deleted.
   def self.delete_branch(client, repo_name, branch_name)
-    puts "Removing '#{branch_name}' from '#{repo_name}'"
     client.delete_branch(repo_name, branch_name)
+  rescue StandardError => error
+    puts "(FAILURE) Deleting #{branch_name} in #{repo_name} failed. #{error}".red
   end
 end

data/managed_modules.yml

@@ -1,30 +1,55 @@
 ---
-- puppetlabs-accounts
-- puppetlabs-apache
-- puppetlabs-apt
-- puppetlabs-firewall
-- puppetlabs-haproxy
-- puppetlabs-ibm_installation_manager
-- puppetlabs-java
-- puppetlabs-mysql
-- puppetlabs-ntp
-- puppetlabs-postgresql
-# - puppetlabs-satellite_pe_tools
-- puppetlabs-tagmail
-- puppetlabs-tomcat
-- puppetlabs-translate
-# - puppetlabs-vcsrepo
-- puppetlabs-websphere_application_server
-- puppetlabs-bootstrap
-- puppetlabs-concat
-- puppetlabs-exec
-- puppetlabs-facter_task
-- puppetlabs-hocon
-- puppetlabs-inifile
-# - puppetlabs-java_ks
-- puppetlabs-motd
-- puppetlabs-package
-- puppetlabs-puppet_conf
-- puppetlabs-resource
-- puppetlabs-service
-- puppetlabs-stdlib
+## windows team
+#- puppetlabs-acl
+#- puppetlabs-chocolatey
+#- puppetlabs-dsc
+#- puppetlabs-dsc_lite
+#- puppetlabs-iis
+#- puppetlabs-powershell
+#- puppetlabs-registry
+#- puppetlabs-reboot
+#- puppetlabs-scheduled_task
+#- puppetlabs-sqlserver
+#- puppetlabs-windows
+#- puppetlabs-wsus_client
+## modules team
+#- puppetlabs-accounts
+#- puppetlabs-apache
+#- puppetlabs-apt
+#- puppetlabs-bootstrap
+#- puppetlabs-concat
+#- puppetlabs-exec
+#- puppetlabs-facter_task
+#- puppetlabs-firewall
+#- puppetlabs-haproxy
+#- puppetlabs-ibm_installation_manager
+#- puppetlabs-inifile
+#- puppetlabs-java
+#- puppetlabs-java_ks
+#- puppetlabs-motd
+#- puppetlabs-mysql
+#- puppetlabs-ntp
+#- puppetlabs-package
+#- puppetlabs-postgresql
+#- puppetlabs-puppet_conf
+#- puppetlabs-resource
+#- puppetlabs-satellite_pe_tools
+#- puppetlabs-service
+#- puppetlabs-stdlib
+#- puppetlabs-tagmail
+#- puppetlabs-tomcat
+#- puppetlabs-translate
+#- puppetlabs-vcsrepo
+#- puppetlabs-websphere_application_server
+# networking team
+#- cisco_ios
+#- device_manager
+#- puppetlabs-panos
+#- puppetlabs-resource_api
+## testing only
+# - puppetlabs-testing
+# - puppetlabs-testing1
+# - puppetlabs-testing2
+## cloud and containers team
+# - puppetlabs-kubernetes
+# - puppetlabs-rook

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.1.0'
+  spec.version               = '0.2.0'
   spec.authors               = ['Puppet']
   spec.email                 = ['']
   spec.summary               = 'Puppet Module PDK Synchronizer'

data/spec/lib/pdksync_spec.rb

@@ -5,64 +5,50 @@ require 'octokit'
 
 describe PdkSync do
   before(:all) do
-    @timestamp = Time.now.to_i
-    @namespace = 'puppetlabs'
     @pdksync_dir = './modules_pdksync'
-    @module_name = 'puppetlabs-testing'
-    @output_path = "#{@pdksync_dir}/#{@module_name}"
-    @access_token = ENV['GITHUB_TOKEN']
-    @repo_name = "#{@namespace}/#{@module_name}"
+    module_name = 'puppetlabs-testing'
+    @module_names = ['puppetlabs-testing']
+    @output_path = "#{@pdksync_dir}/#{module_name}"
+    @folder = Dir.pwd
   end
 
-  context 'env' do
-    it 'has a filespace' do
+  before(:each) do
+    allow(PdkSync).to receive(:return_modules).and_return(@module_names)
+    Dir.chdir(@folder)
+  end
+
+  context 'main method' do
+    it 'runs clone sucessfully' do
       FileUtils.rm_rf(@pdksync_dir)
       PdkSync.create_filespace
+      PdkSync.main(steps: [:clone])
       expect(Dir.exist?(@pdksync_dir)).to be(true)
-    end
-
-    it 'has cloned the repo' do
-      PdkSync.clone_directory(@namespace, @module_name, @output_path)
       expect(Dir.exist?(@output_path)).to be(true)
     end
-  end
-
-  context 'run' do
-    before(:all) do
-      @git_repo = Git.open(@output_path)
+    it 'runs pdk convert, and files have changed' do
+      PdkSync.main(steps: [:pdk_convert])
+      File.exist?("#{@output_path}/convert_report.txt")
     end
-
-    it 'has created a branch' do
-      PdkSync.checkout_branch(@git_repo, @timestamp)
-      expect(@git_repo.current_branch).to include(@timestamp.to_s)
+    it 'raise when running a command with no argument' do
+      expect { PdkSync.main(steps: [:run_a_command]) }.to raise_error(RuntimeError, %r{"run_a_command" requires an argument to run.})
     end
-
-    it 'has created a report' do
-      FileUtils.rm_rf('update_report.txt')
-      PdkSync.pdk_update(@output_path)
-      expect(File.exist?('update_report.txt')).to be(true)
+    it 'runs a command "touch cat.meow"' do
+      PdkSync.main(steps: [:run_a_command], args: 'touch cat.meow')
+      expect File.exist?("#{@output_path}/cat.meow")
     end
-
-    it 'has staged files' do
-      PdkSync.add_staged_files(@git_repo)
-      result = Open3.capture3('git status')
-      expect(result).to include(%r{Changes to be committed})
+    it 'raise when create_commit with no arguments' do
+      expect { PdkSync.main(steps: [:create_commit]) }.to raise_error(RuntimeError, %r{Needs a branch_name and commit_message})
     end
-
-    it 'has committed files' do
-      pre_commit = @git_repo.log.last
-      PdkSync.commit_staged_files(@git_repo, @timestamp)
-      post_commit = @git_repo.log.last
-      expect(pre_commit).not_to eq(post_commit)
+    it 'create_commit runs, and contains the "kittens in mittens"' do
+      PdkSync.main(steps: [:create_commit], args: { branch_name: 'temp_branch', commit_message: 'kittens in mittens' })
+      git_repo = Git.open(@output_path)
+      expect(git_repo.show).to include('kittens in mittens')
+    end
+    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 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
   end
-  # # Test fails if ran from travis due to lack of proper credentials
-  # it 'The committed files should be pushed and the PR created', unless: @access_token == '' do
-  #   @client = PdkSync.setup_client
-  #   PdkSync.push_staged_files(@git_repo, @timestamp, @repo_name)
-  #   pr = PdkSync.create_pr(@client, @repo_name, @timestamp, @timstamp)
-  #   expect(pr.title).to eq("pdksync - pdksync_#{@timestamp}")
-  #   #Branch is now cleaned
-  #   PdkSync.delete_branch(@client, @repo_name, "pdksync_#{@timestamp}".to_s)
-  # end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdksync
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2018-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
@@ -163,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Puppet Module PDK Synchronizer