pdksync 0.5.0 → 0.6.0

data/Rakefile

@@ -1,17 +1,23 @@
-require 'pdksync/rake_tasks'
-require 'github_changelog_generator/task'
-require 'rubocop/rake_task'
+require "pdksync/rake_tasks"
+require "github_changelog_generator/task"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+require "bundler/gem_tasks"
 
 RuboCop::RakeTask.new(:rubocop) do |t|
-  t.options = ['--display-cop-names']
+  t.options = ["--display-cop-names"]
 end
 
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
 GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-  config.user = 'puppetlabs'
-  config.project = 'pdksync'
+  config.user = "puppetlabs"
+  config.project = "pdksync"
   # config.since_tag = '1.1.1'
-  config.future_release = '0.5.0'
-  config.exclude_labels = ['maintenance']
+  config.future_release = "0.6.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
   config.issues = false

data/lib/pdksync.rb

@@ -4,59 +4,45 @@ require 'open3'
 require 'fileutils'
 require 'rake'
 require 'pdk'
-require 'pdksync/constants'
+require 'pdksync/configuration'
 require 'pdksync/gitplatformclient'
+
 require 'json'
 require 'yaml'
 require 'colorize'
 require 'bundler'
 require 'octokit'
+require 'pdk/util/template_uri'
+require 'pdksync/logger'
+require 'pdksync/utils'
+require 'terminal-table'
 
 # @summary
 #   This module set's out and controls the pdksync process
-# @param [String] @namspace
-#   The namespace of the repositories we are updating.
-# @param [String] @pdksync_dir
-#   The local directory the repositories are to be copied to.
-# @param [String] @push_file_destination
-#   The remote that the pull requests are to be made against.
-# @param [String] @create_pr_against
-#   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
-  @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.configuration
+    @configuration ||= PdkSync::Configuration.new
+  end
+
+  @main_path = Dir.pwd
+
+  def self.client
+    @client ||= Utils.setup_client
+  end
 
   def self.main(steps: [:clone], args: nil)
-    check_pdk_version
-    create_filespace
-    client = setup_client
-    module_names = return_modules
-    raise "No modules found in '#{@managed_modules}'" if module_names.nil?
-    validate_modules_exist(client, module_names)
+    Utils.check_pdk_version if ENV['PDKSYNC_VERSION_CHECK'].eql?('true')
+    Utils.create_filespace
+    Utils.create_filespace_gem
+    module_names = Utils.return_modules
+
+    unless steps.include?(:clone_gem) || steps.include?(:multi_gem_testing)
+      raise "No modules found in '#{Utils.configuration.managed_modules}'" if module_names.nil?
+    end
+
     pr_list = []
+    report_rows = []
+    table = Terminal::Table.new
 
     # The current directory is saved for cleanup purposes
     main_path = Dir.pwd
@@ -64,455 +50,330 @@ module PdkSync
     # 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}'"
+      PdkSync::Logger.info "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]}"
+      PdkSync::Logger.info "Commit branch_name=#{args[:branch_name]} commit_message=#{args[:commit_message]}"
     end
     # validation create_pr
     if steps.include?(:create_pr)
       raise 'Needs a pr_title' if args.nil? || args[:pr_title].nil?
-      puts "PR title =#{args[:additional_title]} #{args[:pr_title]}"
+      PdkSync::Logger.info "PR title =#{args[:additional_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]}"
+      PdkSync::Logger.info "Removing branch_name =#{args[:branch_name]}"
+    end
+    # validation clone_gem
+    if steps.include?(:clone_gem)
+      raise 'Needs a gem_name' if args.nil? || args[:gem_name].nil?
+      PdkSync::Logger.info "Command '#{args}'"
+    end
+    # validation multi_gem_testing
+    if steps.include?(:multi_gem_testing)
+      raise '"multi_gem_testing" requires arguments to run version_file and build_gem.' if args.nil? || args[:version_file].nil? || args[:build_gem].nil?
+      puts "Command '#{args}'"
+    end
+    # validation multi_gem_file_update
+    if steps.include?(:multigem_file_update)
+      raise 'multigem_file_update requires arguments gem_to_test, gemfury_username to run.' if args[:gem_name].nil? || args[:gemfury_username].nil?
+      puts "Command '#{args}'"
+    end
+    # validation gem_file_update
+    if steps.include?(:gem_file_update)
+      raise '"gem_file_update" requires arguments (gem_to_test) to run.' if args[:gem_to_test].nil?
+      puts "Command '#{args}'"
+    end
+    # validation run_tests_locally
+    if steps.include?(:run_tests_locally)
+      puts "Command '#{args}'"
+    end
+    # validation fetch_test_results_locally
+    if steps.include?(:fetch_test_results_locally)
+      puts "Command '#{args}'"
+    end
+    # validation run_tests_jenkins
+    if steps.include?(:run_tests_jenkins)
+      raise 'run_tests_jenkins requires arguments (jenkins_server_url, github_branch) to run.' if args[:github_branch].nil? || args[:jenkins_server_url].nil?
+      puts "Command '#{args}'"
+    end
+    # validation test_results_jenkins
+    if steps.include?(:test_results_jenkins)
+      raise 'test_results_jenkins requires argument jenkins_server_url to run.' if args[:jenkins_server_url].nil?
+      puts "Command '#{args}'"
     end
 
-    abort "No modules listed in #{@managed_modules}" if module_names.nil?
-    module_names.each do |module_name|
-      module_args = args.clone
+    unless steps.include?(:clone_gem) || steps.include?(:multi_gem_testing)
+      abort "No modules listed in #{Utils.configuration.managed_modules}" if module_names.nil?
+    end
+
+    if steps.include?(:clone_gem) || steps.include?(:multi_gem_testing)
+      gem_args = args.clone
       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?
+      PdkSync::Logger.info "#{gem_args[:gem_name]}, "
+      output_path = File.join(Utils.configuration.pdksync_gem_dir, gem_args[:gem_name])
+      if steps.include?(:clone_gem)
+        Utils.clean_env(output_path) if Dir.exist?(output_path)
+        PdkSync::Logger.info 'delete gem directory, '
+        @git_repo = Utils.clone_directory(Utils.configuration.namespace, gem_args[:gem_name], output_path)
+        PdkSync::Logger.info 'cloned'
+        PdkSync::Logger.error "Unable to clone repo for #{gem_args[:gem_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)
+      puts '(WARNING) @output_path does not exist, gem'.red unless File.directory?(output_path)
+      if steps.include?(:multi_gem_testing)
         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)
+        PdkSync::Logger.info 'Multi Gem Testing, '
+        current_gem_version = Utils.check_gem_latest_version(gem_args[:gem_name])
+        PdkSync::Logger.info current_gem_version
+        new_gem_version = Utils.update_gem_latest_version_by_one(current_gem_version)
+        PdkSync::Logger.info new_gem_version
         Dir.chdir(main_path) unless Dir.pwd == main_path
-        print 'run command, '
-        exit_status = run_command(output_path, module_args)
-        next unless exit_status.zero?
-      end
-      if steps.include?(:pdk_update)
+        exit_status = Utils.run_command(output_path, "sed s/#{current_gem_version}/#{new_gem_version}/g #{gem_args[:version_file]} >> test.yml", nil)
+        PdkSync::Logger.info 'Updated the version'
         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
-          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)
+        exit_status = Utils.run_command(output_path, "cp test.yml #{gem_args[:version_file]}", nil)
         Dir.chdir(main_path) unless Dir.pwd == main_path
-        git_instance = Git.open(output_path)
-        create_commit(git_instance, module_args[:branch_name], module_args[:commit_message])
-        print 'commit created, '
-      end
-      if steps.include?(:push)
+        exit_status = Utils.run_command(output_path, 'rm -rf test.yml', nil)
+        PdkSync::Logger.info 'bundle install'
+        Dir.chdir(main_path) unless Dir.pwd == main_path
+        exit_status = Utils.run_command(output_path, 'bundle install', nil)
+        PdkSync::Logger.info 'building gem'
+        Dir.chdir(main_path) unless Dir.pwd == main_path
+        exit_status = Utils.run_command(output_path, "bundle exec #{gem_args[:build_gem]}", nil)
+        PdkSync::Logger.info 'uploading packages'
         Dir.chdir(main_path) unless Dir.pwd == main_path
-        git_instance = Git.open(output_path)
-        if git_instance.diff(git_instance.current_branch, "#{@push_file_destination}/#{@create_pr_against}").size != 0 # Git::Diff doesn't have empty? # rubocop:disable Style/ZeroLengthPredicate
-          push_staged_files(git_instance, git_instance.current_branch, repo_name)
-          print 'push, '
-        else
-          print 'skipped push, '
+        Dir.chdir("#{output_path}/#{gem_args[:gem_path]}") unless Dir.pwd == output_path
+        gemfury_token = Utils.configuration.gemfury_access_settings
+        Dir.glob('*.gem') do |filename|
+          PdkSync::Logger.info filename
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          exit_status = Utils.run_command("#{output_path}/#{gem_args[:gem_path]}", "curl -F package=@#{filename} https://" + gemfury_token + "@push.fury.io/#{gem_args[:gemfury_username]}/", nil)
         end
       end
-      if steps.include?(:create_pr)
+    else
+      module_names.each do |module_name|
+        module_args = args.clone
         Dir.chdir(main_path) unless Dir.pwd == main_path
-        git_instance = Git.open(output_path)
-        if git_instance.diff(git_instance.current_branch, "#{@push_file_destination}/#{@create_pr_against}").size != 0 # Git::Diff doesn't have empty? # rubocop:disable Style/ZeroLengthPredicate
-          pdk_version = return_pdk_version("#{output_path}/metadata.json")
-
-          # If a label is supplied, verify that it is available in the repo
-          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
-          if label_valid == false
-            raise 'Ensure label is valid'
+        PdkSync::Logger.info "#{module_name}, "
+        repo_name = File.join(Utils.configuration.namespace, module_name)
+        output_path = File.join(Utils.configuration.pdksync_dir, module_name)
+        if steps.include?(:clone)
+          Utils.validate_modules_exist(client, module_names)
+          Utils.clean_env(output_path) if Dir.exist?(output_path)
+          PdkSync::Logger.info 'delete module directory'
+          @git_repo = Utils.clone_directory(Utils.configuration.namespace, module_name, output_path)
+          PdkSync::Logger.info 'cloned'
+          PdkSync::Logger.error "Unable to clone repo for #{module_name}" if @git_repo.nil?
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          next if @git_repo.nil?
+        end
+        PdkSync::Logger.warn "#{output_path} does not exist, skipping module" unless File.directory?(output_path)
+        next unless File.directory?(output_path)
+        if steps.include?(:pdk_convert)
+          exit_status = Utils.run_command(output_path, "#{Utils.return_pdk_path} convert --force #{configuration.templates}", nil)
+          PdkSync::Logger.info 'converted'
+          next unless exit_status.zero?
+        end
+        if steps.include?(:pdk_validate)
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          exit_status = Utils.run_command(output_path, "#{Utils.return_pdk_path} validate -a", nil)
+          PdkSync::Logger.info 'validated' if exit_status.zero?
+          next unless exit_status.zero?
+        end
+        if steps.include?(:run_a_command)
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          PdkSync::Logger.info 'run command'
+          if module_args[:option].nil?
+            pid = Utils.run_command(output_path, module_args[:command], module_args[:option])
+            next unless pid != 0 # rubocop:disable Metrics/BlockNesting
+          else
+            exit_status = Utils.run_command(output_path, module_args[:command], nil)
+            next unless exit_status.zero? # rubocop:disable Metrics/BlockNesting
           end
-
-          # Create the PR and add link to pr list
-          pr = create_pr(client, repo_name, git_instance.current_branch, pdk_version, module_args[:pr_title])
-          if pr.nil?
-            break
+        end
+        if steps.include?(:gem_file_update)
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          print 'gem file update, '
+          Utils.gem_file_update(output_path, module_args[:gem_to_test], module_args[:gem_line], module_args[:gem_sha_finder], module_args[:gem_sha_replacer], module_args[:gem_version_finder], module_args[:gem_version_replacer], module_args[:gem_branch_finder], module_args[:gem_branch_replacer], main_path) # rubocop:disable Metrics/LineLength
+          print 'gem file updated, '
+        end
+        if steps.include?(:run_tests_locally)
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          PdkSync::Logger.info 'Run tests '
+          module_type = Utils.module_type(output_path, module_name)
+          Utils.run_tests_locally(output_path, module_type, module_args[:provision_type], module_name, module_args[:puppet_collection])
+        end
+        if steps.include?(:fetch_test_results_locally)
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          PdkSync::Logger.info 'Fetch test results for local run '
+          module_type = Utils.module_type(output_path, module_name)
+          table = Utils.fetch_test_results_locally(output_path, module_type, module_name, report_rows)
+        end
+        if steps.include?(:pdk_update)
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          next unless Utils.pdk_update(output_path).zero?
+          if steps.include?(:use_pdk_ref)
+            ref = Utils.return_template_ref(File.join(output_path, 'metadata.json'))
+            pr_title = module_args[:additional_title] ? "#{module_args[:additional_title]} - pdksync_#{ref}" : "pdksync_#{ref}" # rubocop:disable Metrics/BlockNesting
+            module_args = module_args.merge(branch_name: "pdksync_#{ref}",
+                                            commit_message: pr_title,
+                                            pr_title: pr_title,
+                                            pdksync_label: Utils.configuration.default_pdksync_label)
           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}' "
+          PdkSync::Logger.info 'pdk update'
+        end
+        if steps.include?(:use_gem_ref)
+          pr_title = module_args[:additional_title] ? "#{module_args[:additional_title]} - pdksync_gem_testing" : 'pdksync_gem_testing'
+          module_args = module_args.merge(branch_name: "gem_testing_#{module_args[:gem_to_test]}",
+                                          commit_message: pr_title,
+                                          pr_title: pr_title,
+                                          pdksync_label: Utils.configuration.default_pdksync_label)
+        end
+        if steps.include?(:create_commit)
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          git_instance = Git.open(output_path)
+          Utils.create_commit(git_instance, module_args[:branch_name], module_args[:commit_message])
+          PdkSync::Logger.info 'commit created'
+        end
+        if steps.include?(:push)
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          git_instance = Git.open(output_path)
+          if git_instance.diff(git_instance.current_branch, "#{Utils.configuration.push_file_destination}/#{Utils.configuration.create_pr_against}").size != 0 # Git::Diff doesn't have empty? # rubocop:disable Style/ZeroLengthPredicate
+            PdkSync::Logger.info 'push'
+            Utils.push_staged_files(git_instance, git_instance.current_branch, repo_name)
+          else
+            PdkSync::Logger.info 'skipped push'
           end
-        else
-          print 'skipped pr, '
         end
-      end
-      if steps.include?(:clean_branches)
-        Dir.chdir(main_path) unless Dir.pwd == main_path
-        delete_branch(client, repo_name, module_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
-
-  # @summary
-  #   Check the local pdk version against the most recent tagged release on GitHub
-  def self.check_pdk_version
-    stdout, _stderr, status = Open3.capture3("#{return_pdk_path} --version")
-    raise "(FAILURE) Unable to find pdk at '#{return_pdk_path}'.".red unless status.exitstatus
-
-    local_version = stdout.strip
-    remote_version = Octokit.tags('puppetlabs/pdk').first[:name][1..-1]
-
-    unless Gem::Version.new(remote_version) <= Gem::Version.new(local_version)
-      puts "(WARNING) The current version of pdk is #{remote_version} however you are using #{local_version}".red
-    end
-  rescue StandardError => error
-    puts "(WARNING) Unable to check latest pdk version. #{error}".red
-  end
-
-  # @summary
-  #   This method when called will create a directory identified by the set global variable '@pdksync_dir', on the condition that it does not already exist.
-  def self.create_filespace
-    FileUtils.mkdir @pdksync_dir unless Dir.exist?(@pdksync_dir)
-  end
-
-  # @summary
-  #   This method when called will create and return an octokit client with access to the upstream git repositories.
-  # @return [PdkSync::GitPlatformClient] client
-  #   The Git platform client that has been created.
-  def self.setup_client
-    PdkSync::GitPlatformClient.new(@git_platform, @git_platform_access_settings)
-  rescue StandardError => error
-    raise "Git platform access not set up correctly: #{error}"
-  end
-
-  # @summary
-  #   This method when called will access a file set by the global variable '@managed_modules' and retrieve the information within as an array.
-  # @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 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 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 client.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
-  #   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
-
-  def self.create_commit(git_repo, branch_name, commit_message)
-    checkout_branch(git_repo, branch_name)
-    if add_staged_files(git_repo) # ignore rubocop for clarity on side effect ordering # rubocop:disable Style/GuardClause
-      commit_staged_files(git_repo, branch_name, commit_message)
-    end
-  end
-
-  # @summary
-  #   This method when called will call the delete function against the given repository if it exists.
-  # @param [String] output_path
-  #   The repository that is to be deleted.
-  def self.clean_env(output_path)
-    # If a local copy already exists it is removed
-    FileUtils.rm_rf(output_path)
-  end
-
-  # @summary
-  #   This method when called will clone a given repository into a local location that has also been set.
-  # @param [String] namespace
-  #   The namespace the repository is located in.
-  # @param [String] module_name
-  #   The name of the repository.
-  # @param [String] output_path
-  #   The location the repository is to be cloned to.
-  # @return [Git::Base]
-  #   A git object representing the local repository.
-  def self.clone_directory(namespace, module_name, output_path)
-    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
-
-  # @summary
-  #   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 command run.
-  def self.run_command(output_path, command)
-    stdout = ''
-    stderr = ''
-    status = Process::Status
-
-    Dir.chdir(output_path) unless Dir.pwd == output_path
-
-    # 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
-  end
+        if steps.include?(:create_pr)
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          git_instance = Git.open(output_path)
+          if git_instance.diff(git_instance.current_branch, "#{Utils.configuration.push_file_destination}/#{Utils.configuration.create_pr_against}").size != 0 # Git::Diff doesn't have empty? # rubocop:disable Style/ZeroLengthPredicate
+            pdk_version = Utils.return_pdk_version("#{output_path}/metadata.json")
+
+            # If a label is supplied, verify that it is available in the repo
+            label = module_args[:pdksync_label] ? module_args[:pdksync_label] : module_args[:label] # rubocop:disable Metrics/BlockNesting
+            label_valid = (label.is_a?(String) && !label.to_str.empty?) ? Utils.check_for_label(client, repo_name, label) : nil # rubocop:disable Metrics/BlockNesting
+
+            # Exit current iteration if an error occured retrieving a label
+            if label_valid == false # rubocop:disable Metrics/BlockNesting
+              raise 'Ensure label is valid'
+            end
+
+            # Create the PR and add link to pr list
+            pr = Utils.create_pr(client, repo_name, git_instance.current_branch, pdk_version, module_args[:pr_title])
+            break if pr.nil? # rubocop:disable Metrics/BlockNesting
+
+            pr_list.push(pr.html_url)
+            PdkSync::Logger.info 'created pr'
+
+            # If a valid label is supplied, add this to the PR
+            if label_valid == true # rubocop:disable Metrics/BlockNesting
+              Utils.add_label(client, repo_name, pr.number, label)
+              PdkSync::Logger.info "added label '#{label}' "
+            end
+          else
+            PdkSync::Logger.info 'skipped pr'
+          end
+        end
+        if steps.include?(:clean_branches)
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          Utils.delete_branch(client, repo_name, module_args[:branch_name])
+          PdkSync::Logger.info 'branch deleted'
+        end
+        if steps.include?(:run_tests_jenkins)
+          jenkins_client = Utils.setup_jenkins_client(module_args[:jenkins_server_url])
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          PdkSync::Logger.info 'Run tests in jenkins '
+          module_type = Utils.module_type(output_path, module_name)
+          if module_type == 'traditional'
+            github_user = 'puppetlabs' if module_args[:test_framework].nil? # rubocop:disable Metrics/BlockNesting
+            github_user = module_args[:github_user] unless module_args[:github_user].nil? # rubocop:disable Metrics/BlockNesting
+            if module_args[:test_framework] == 'jenkins' || module_args[:test_framework].nil? # rubocop:disable Metrics/BlockNesting
+              module_name = "puppetlabs-#{module_name}" if %w[cisco_ios device_manager].include?(module_name) # rubocop:disable Metrics/BlockNesting
+              job_name = "forge-module_#{module_name}_init-manual-parameters_adhoc"
+              job_name = "forge-windows_#{module_name}_init-manual-parameters_adhoc" if ['puppetlabs-reboot', 'puppetlabs-iis', 'puppetlabs-powershell', 'sqlserver'].include?(module_name) # rubocop:disable Metrics/BlockNesting, Metrics/LineLength
+              build_id = Utils.run_tests_jenkins(jenkins_client, module_name, module_args[:github_branch], github_user, job_name)
+              next if build_id.nil? # rubocop:disable Metrics/BlockNesting
+              PdkSync::Logger.info "New adhoc TEST EXECUTION has started. \nYou can check progress here: #{configuration['jenkins_server_url']}/job/#{job_name}/#{build_id}"
+              Utils.test_results_jenkins(module_args[:jenkins_server_url], build_id, job_name, module_name)
+            end
+          end
+          if module_type == 'litmus'
+            PdkSync::Logger.info '(Error) Module Type is Litmus please use the rake task run_tests_locally to run'.red
+          end
+        end
+        if steps.include?(:test_results_jenkins)
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          PdkSync::Logger.info 'Fetch test results from jenkins, '
+          module_type = Utils.module_type(output_path, module_name)
+          if module_type == 'litmus'
+            PdkSync::Logger.info '(Error) Module Type is Litmus please use the rake task run_tests_locally to run'.red
+            next
+          end
 
-  # @summary
-  #   This method when called will run the 'pdk update --force' 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 update run.
-  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("#{return_pdk_path} update --force")
-    puts "(FAILURE) Unable to run `pdk update`: #{stderr}".red unless status.exitstatus.zero?
-    status.exitstatus
-  end
+          module_name = "puppetlabs-#{module_name}" if %w[cisco_ios device_manager].include?(module_name)
+          File.open("results_#{module_name}.out", 'r') do |f|
+            f.each_line do |line|
+              if line.include?('BUILD_ID')
+                build_id = line.split('=')[1].strip
+              elsif line.include?('MODULE_NAME')
+                module_name = line.split('=')[1].strip
+              end
+            end
 
-  # @summary
-  #   This method when called will retrieve the template ref of the current module, i.e. the one that was navigated into in the 'pdk_update' method.
-  # @param [String] metadata_file
-  #   An optional input that can be used to set the location of the metadata file.
-  # @return [String]
-  #   A string value that represents the current pdk template.
-  def self.return_template_ref(metadata_file = 'metadata.json')
-    file = File.read(metadata_file)
-    data_hash = JSON.parse(file)
-    data_hash['template-ref']
-  end
+            job_name = "forge-module_#{module_name}_init-manual-parameters_adhoc" if module_args[:job_name].nil?
+            job_name = "forge-windows_#{module_name}_init-manual-parameters_adhoc" if ['puppetlabs-reboot', 'puppetlabs-iis', 'puppetlabs-powershell', 'sqlserver'].include?(module_name)
+            Utils.test_results_jenkins(module_args[:jenkins_server_url], build_id, job_name, module_name)
+          end
+        end
+        if steps.include?(:multigem_file_update)
+          Dir.chdir(main_path) unless Dir.pwd == main_path
+          gemfury_readonly_token = Utils.configuration.gemfury_access_settings
+          Utils.update_gemfile_multigem(output_path, module_args[:gem_name], gemfury_readonly_token, module_args[:gemfury_username])
+          PdkSync::Logger.info 'Updated with multigem, '
+        end
 
-  # @summary
-  #   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] 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
+        if steps.include?(:add_provision_list)
+          result = Utils.add_provision_list(output_path, module_args[:key], module_args[:provisioner], [module_args[:images], module_args.extras].flatten)
+          raise "#{output_path}/provision.yaml does not exist" unless result
+        end
 
-  # @summary
-  #   This method when called will retrieve the pdk_version of the current module, i.e. the one that was navigated into in the 'pdk_update' method.
-  # @param [String] metadata_file
-  #   An optional input that can be used to set the location of the metadata file.
-  # @return [String]
-  #   A string value that represents the current pdk version.
-  def self.return_pdk_version(metadata_file = 'metadata.json')
-    file = File.read(metadata_file)
-    data_hash = JSON.parse(file)
-    data_hash['pdk-version']
-  end
+        if steps.include?(:generate_vmpooler_release_checks)
+          Utils.generate_vmpooler_release_checks(output_path, module_args[:puppet_version].to_i)
+        end
 
-  # @summary
-  #   This method when called will stage all changed files within the given repository, conditional on them being managed via the pdk.
-  # @param [Git::Base] git_repo
-  #   A git object representing the local repository to be staged.
-  def self.add_staged_files(git_repo)
-    if git_repo.status.changed != {}
-      git_repo.add(all: true)
-      puts 'All files have been staged.'
-      true
-    else
-      puts 'Nothing to commit.'
-      false
-    end
-  end
+        if steps.include?(:update_os_support)
+          Utils.update_os_support(output_path)
+        end
 
-  # @summary
-  #   This method when called will create a commit containing all currently staged files, with the name of the commit containing the template ref as a unique identifier.
-  # @param [Git::Base] git_repo
-  #   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.
-  # @param [String] commit_message
-  #   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}"
-              else
-                commit_message
-              end
-    git_repo.commit(message)
-  end
+        if steps.include?(:remove_platform_from_metadata)
+          Utils.remove_platform_from_metadata(output_path, module_args[:os], module_args[:version])
+        end
 
-  # @summary
-  #   This method when called will push the given local commit to local repository's origin.
-  # @param [Git::Base] git_repo
-  #   A git object representing the local repository againt which the push is to be made.
-  # @param [String] template_ref
-  #   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, 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
+        if steps.include?(:add_platform_to_metadata)
+          Utils.add_platform_to_metadata(output_path, module_args[:os], module_args[:version])
+        end
 
-  # @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 [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
-  #   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, 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,
-                                    head,
-                                    title,
-                                    message)
-    pr
-  rescue StandardError => error
-    puts "(FAILURE) PR creation for #{repo_name} has failed. #{error}".red
-  end
+        if steps.include?(:update_requirements)
+          Utils.update_requirements(output_path, module_args[:name], module_args[:key], module_args[:value])
+        end
 
-  # @summary
-  #   This method when called will check on the given repository for the existence of the supplied label
-  # @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
-  #   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)
+        if steps.include?(:normalize_metadata_supported_platforms)
+          Utils.normalize_metadata_supported_platforms(output_path)
+        end
 
-    # Look for label in the repository's labels
-    match = false
-    repo_labels.each do |repo_label|
-      if repo_label.name == label
-        match = true
-        break
+        PdkSync::Logger.info 'done'
       end
+      table = Terminal::Table.new title: 'Module Test Results', headings: %w[Module Status Result From], rows: report_rows
+      puts table if steps.include?(:fetch_test_results_locally)
+      return if pr_list.size.zero?
+      PdkSync::Logger.info "\nPRs created:\n"
+      puts pr_list.join("\n")
     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 [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
-  #   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 [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
-  #   The name of the branch that is to be deleted.
-  def self.delete_branch(client, repo_name, branch_name)
-    client.delete_branch(repo_name, branch_name)
-  rescue StandardError => error
-    puts "(FAILURE) Deleting #{branch_name} in #{repo_name} failed. #{error}".red
   end
 end