pdksync 0.5.0 → 0.6.0

data/spec/utils_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+require 'pdksync/utils'
+require 'tempfile'
+describe 'PdkSync::Utils' do
+  before(:all) do
+    @tmp_dir = Dir.mktmpdir('testing')
+  end
+
+  let(:cloned_module) do
+    begin
+      Git.open(@tmp_dir)
+    rescue ArgumentError
+      PdkSync::Utils.clone_directory('puppetlabs',
+                                     'puppetlabs-testing', @tmp_dir)
+    end
+  end
+
+  let(:metadata_file) do
+    File.join(@tmp_dir, 'metadata.json')
+  end
+
+  before(:each) do
+    cloned_module
+  end
+
+  after(:all) do
+    FileUtils.remove_entry @tmp_dir
+  end
+
+  it '#self.clone_directory' do
+    Dir.mktmpdir do |dir|
+      PdkSync::Utils.clone_directory('puppetlabs',
+                                     'puppetlabs-testing', dir)
+      expect(cloned_module).to be_a Git::Base
+    end
+  end
+
+  it '#self.create_commit' do
+    File.write(File.join(@tmp_dir, 'README.md'), rand(32_332))
+    expect(PdkSync::Utils.create_commit(cloned_module, 'main', 'boom')).to match(%r{README})
+  end
+
+  it '#self.run_command' do
+    expect(PdkSync::Utils.run_command('./', 'pwd', nil)).to eq(0)
+  end
+
+  it '#self.pdk_update' do
+    expect(PdkSync::Utils.pdk_update(@tmp_dir)).to eq(0)
+  end
+
+  it '#self.return_template_ref' do
+    expect(PdkSync::Utils.return_template_ref(metadata_file)).to match(%r{^heads\/main\S+$})
+  end
+
+  it '#self.module_templates_url' do
+    allow(Octokit).to receive(:tags).with('puppetlabs/pdk').and_return([{ name: 'v1.14.1' }])
+    url, version = PdkSync::Utils.module_templates_url(metadata_file).split('#')
+    expect(url).to eq('https://github.com/puppetlabs/pdk-templates')
+    expect(version).to match(%r{main})
+  end
+
+  it '#self.change_module_template_url' do
+    url = 'https://github.com/nwops/pdk-templates'
+    ref = 'special'
+    expect(PdkSync::Utils.change_module_template_url(url, ref, metadata_file)).to eq('https://github.com/nwops/pdk-templates#special')
+  end
+
+  it '#self.checkout_branch' do
+    PdkSync::Utils.checkout_branch(cloned_module, 'sync1234')
+    branch = cloned_module.branches.find { |b| b.name.eql?('pdksync_sync1234') }
+    expect(branch).to be_a Git::Branch
+  end
+
+  it '#self.check_pdk_version is false' do
+    process = double
+    allow(process).to receive(:exitstatus).and_return(true)
+    allow(Octokit).to receive(:tags).with('puppetlabs/pdk').and_return([{ name: 'v1.14.1' }])
+    allow(PdkSync::Utils).to receive(:return_pdk_path).and_return('/opt/puppetlabs/pdk/bin/pdk')
+    allow(Open3).to receive(:capture3).with('/opt/puppetlabs/pdk/bin/pdk --version').and_return(['1.14.0', nil, process])
+    expect(PdkSync::Utils.check_pdk_version).to be false
+  end
+
+  it '#self.check_pdk_version is true' do
+    process = double
+    allow(process).to receive(:exitstatus).and_return(true)
+    allow(PdkSync::Utils).to receive(:return_pdk_path).and_return('/opt/puppetlabs/pdk/bin/pdk')
+    allow(Open3).to receive(:capture3).with('/opt/puppetlabs/pdk/bin/pdk --version').and_return(['1.14.0', nil, process])
+    allow(Octokit).to receive(:tags).with('puppetlabs/pdk').and_return([{ name: 'v1.14.0' }])
+    expect(PdkSync::Utils.check_pdk_version).to be true
+  end
+
+  it '#self.check_gem_latest_version' do
+    process = double
+    allow(process).to receive(:exitstatus).and_return(true)
+    allow(Octokit).to receive(:tags).with('puppetlabs/puppet_module_gems').and_return([{ name: '0.4.0' }])
+    expect(PdkSync::Utils.check_gem_latest_version('puppet_module_gems')).to eq '0.4.0'
+  end
+
+  it '#self.update_gem_latest_version_by_one' do
+    expect(PdkSync::Utils.update_gem_latest_version_by_one('0.4.0')).to eq Gem::Version.new('0.5')
+  end
+
+  it '#self.create_filespace' do
+    expect(PdkSync::Utils.create_filespace).to eq('modules_pdksync')
+  end
+
+  it '#self.setup_client' do
+    g = double(PdkSync::GitPlatformClient)
+    expect(PdkSync::GitPlatformClient).to receive(:new).with(:github,
+                                                             access_token: 'github-token',
+                                                             api_endpoint: nil,
+                                                             gitlab_api_endpoint: 'https://gitlab.com/api/v4').and_return(g)
+    expect(PdkSync::Utils.setup_client).to eq(g)
+  end
+
+  it '#self.return_modules' do
+    allow_any_instance_of(PdkSync::Configuration).to receive(:managed_modules).and_return(File.join(fixtures_dir, 'fake_managed_modules.yaml'))
+    expect(PdkSync::Utils.return_modules).to eq(['puppetlabs/puppetlabs-testing'])
+  end
+
+  it '#self.validate_modules_exist' do
+    client = double
+    allow_any_instance_of(PdkSync::Configuration).to receive(:managed_modules).and_return(File.join(fixtures_dir, 'fake_managed_modules.yaml'))
+    allow(client).to receive(:repository?).with('puppetlabs/puppetlabs-testing').and_return(true)
+    expect(PdkSync::Utils.validate_modules_exist(client, ['puppetlabs-testing'])).to be true
+  end
+
+  it '#self.create_filespace_gem' do
+    expect(PdkSync::Utils.create_filespace_gem).to eq('gems_pdksync')
+  end
+end

metadata

@@ -1,29 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: pdksync
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Puppet
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-21 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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
+    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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.50.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: simplecov
+  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: simplecov-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.1
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -81,21 +137,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: pdk
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: gitlab
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: gitlab
+  name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: octokit
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: jenkins_api_client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -163,25 +219,36 @@ files:
 - ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CODEOWNERS
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/pdksync.rb
-- lib/pdksync/constants.rb
+- lib/pdksync/conf/puppet_abs_supported_platforms.yaml
+- lib/pdksync/configuration.rb
 - lib/pdksync/githubclient.rb
 - lib/pdksync/gitlabclient.rb
 - lib/pdksync/gitplatformclient.rb
+- lib/pdksync/jenkinsclient.rb
+- lib/pdksync/logger.rb
 - lib/pdksync/pullrequest.rb
 - lib/pdksync/rake_tasks.rb
+- lib/pdksync/utils.rb
 - managed_modules.yml
 - pdksync.gemspec
-- spec/lib/pdksync_spec.rb
+- spec/configuration_spec.rb
+- spec/fixtures/fake_managed_modules.yaml
+- spec/fixtures/pdksync.yml
+- spec/logger_spec.rb
+- spec/pdksync_spec.rb
+- spec/spec_helper.rb
+- spec/utils_spec.rb
 homepage: http://github.com/puppetlabs/pdksync
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -196,9 +263,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Puppet Module PDK Synchronizer
 test_files:
-- spec/lib/pdksync_spec.rb
+- spec/configuration_spec.rb
+- spec/fixtures/fake_managed_modules.yaml
+- spec/fixtures/pdksync.yml
+- spec/logger_spec.rb
+- spec/pdksync_spec.rb
+- spec/spec_helper.rb
+- spec/utils_spec.rb

data/lib/pdksync/constants.rb

@@ -1,78 +0,0 @@
-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
-    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 = File.exist?('pdksync.yml') ? 'pdksync.yml' : "#{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/spec/lib/pdksync_spec.rb

@@ -1,58 +0,0 @@
-require_relative '../../lib/pdksync'
-require 'git'
-require 'fileutils'
-require 'octokit'
-
-describe PdkSync do
-  before(:all) do
-    @pdksync_dir = './modules_pdksync'
-    module_name = 'puppetlabs-testing'
-    @module_names = ['puppetlabs-testing']
-    @output_path = "#{@pdksync_dir}/#{module_name}"
-    @folder = Dir.pwd
-  end
-
-  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
-
-  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)
-      expect(Dir.exist?(@output_path)).to be(true)
-    end
-    it 'runs pdk convert, and files have changed' do
-      PdkSync.main(steps: [:pdk_convert])
-      File.exist?("#{@output_path}/convert_report.txt")
-    end
-    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 '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 '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 '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 create_pr with no arguments' do
-      expect { PdkSync.main(steps: [:create_pr]) }.to raise_error(RuntimeError, %r{Needs a pr_title})
-    end
-    it 'raise when create_pr with invalid label' do
-      expect { PdkSync.main(steps: [: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
-  end
-end