ra10ke 1.0.0 → 1.1.0

data/spec/ra10ke/dependencies_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'ra10ke/dependencies'
+RSpec::Mocks.configuration.allow_message_expectations_on_nil = true
+
+RSpec.describe 'Ra10ke::Dependencies::Verification' do
+  after(:each) do
+    # reset version formats
+    formats = Ra10ke::Dependencies.class_variable_get(:@@version_formats)
+    Ra10ke::Dependencies.class_variable_set(:@@version_formats, formats.select { |k, _v| k == :semver } )
+  end
+
+  context 'register_version_format' do
+    it 'default contains semver' do
+      expect(Ra10ke::Dependencies.class_variable_get(:@@version_formats)).to have_key(:semver)
+    end
+    it 'add new version format' do
+      Ra10ke::Dependencies.register_version_format(:test) do |tags|
+        nil
+      end
+      expect(Ra10ke::Dependencies.class_variable_get(:@@version_formats)).to have_key(:test)
+    end
+  end
+
+  context 'get_latest_ref' do
+    let(:instance) do
+      class DependencyDummy
+        include Ra10ke::Dependencies
+      end.new
+    end
+
+    context 'find latest semver tag' do
+      let(:latest_tag) do
+          'v1.1.0'
+      end
+      let(:test_tags) do
+        {
+          'v1.0.0'   => nil,
+          latest_tag => nil,
+        }
+      end
+
+      it do
+        expect(instance.get_latest_ref({
+          'tags' => test_tags,
+        })).to eq(latest_tag)
+      end
+    end
+
+    context 'find latest tag with custom version format' do
+      let(:latest_tag) do
+        'latest'
+      end
+      let(:test_tags) do
+        {
+          'dev'      => nil,
+          latest_tag => nil,
+        }
+      end
+
+      it do
+        Ra10ke::Dependencies.register_version_format(:number) do |tags|
+          tags.detect { |tag| tag == latest_tag }
+        end
+        expect(instance.get_latest_ref({
+          'tags' => test_tags,
+        })).to eq(latest_tag)
+      end
+    end
+  end
+end

data/spec/ra10ke/deprecation_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'ra10ke/deprecation'
+RSpec::Mocks.configuration.allow_message_expectations_on_nil = true
+
+RSpec.describe 'Ra10ke::Deprecation::Validation' do
+  let(:instance) do
+    Ra10ke::Deprecation::Validation.new(puppetfile)
+  end
+
+  let(:puppetfile) do
+    File.join(fixtures_dir, 'Puppetfile')
+  end
+
+  it 'only checks forge modules' do
+    expect(PuppetForge::Module).to_not receive(:find).with('puppet')
+    allow(PuppetForge::Module).to receive(:find).and_raise(Faraday::ResourceNotFound.new(nil))
+    expect(instance.deprecated_modules.count).to eq(0)
+  end
+
+  it 'handles deprecated modules' do
+    expect(PuppetForge::Module).to receive(:find).with('puppetlabs-ruby').and_return(double(slug: 'puppetlabs-ruby', deprecated_at: '2021-04-22 10:29:42 -0700'))
+    allow(PuppetForge::Module).to receive(:find).and_return(double(slug: 'module-module', deprecated_at: nil))
+
+    expect(instance.bad_mods?).to eq(true)
+    expect(instance.deprecated_modules.first).to eq(name: 'puppetlabs-ruby', deprecated_at: Time.parse('2021-04-22 10:29:42 -0700'))
+  end
+
+  it 'handles missing modules' do
+    expect(PuppetForge::Module).to receive(:find).with('choria-choria').and_return(double(slug: 'choria-choria', deprecated_at: nil))
+    expect(PuppetForge::Module).to receive(:find).with('puppetlabs-ruby').and_raise(Faraday::ResourceNotFound.new(nil))
+    allow(PuppetForge::Module).to receive(:find).and_return(double(slug: 'module-module', deprecated_at: nil))
+
+    expect(instance.bad_mods?).to eq(false)
+  end
+end

data/spec/ra10ke/git_repo_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'ra10ke/validate'
+
+RSpec.describe 'Ra10ke::GitRepo' do
+  let(:url) { 'https://github.com/vshn/puppet-gitlab' }
+
+  it '#new' do
+    expect(Ra10ke::GitRepo.new(url)).to be_a Ra10ke::GitRepo
+  end
+
+  it 'should not run_command more than once' do
+    i = Ra10ke::GitRepo.new(url)
+    expect(i).to receive(:run_command).with("git ls-remote --symref #{url}").once
+    i.valid_url?
+    i.all_refs
+  end
+
+  describe 'good url' do
+    let(:url) { 'https://github.com/vshn/puppet-gitlab' }
+
+    let(:instance) do
+      Ra10ke::GitRepo.new(url)
+    end
+
+    let(:reflist) { File.read(File.join(fixtures_dir, 'refs', 'gitlab.txt')) }
+
+    before(:each) do
+      allow(instance).to receive(:run_command).with("git ls-remote --symref #{url}").and_return([reflist, true])
+    end
+
+    it '#remote_refs is array' do
+      expect(instance.remote_refs).to be_a Array
+    end
+
+    it '#remote_refs contains refs' do
+      expect(instance.remote_refs.first).to eq("1b3322d525e96bf7d0565b08703e2a44c90e7b4a\tHEAD\n")
+    end
+
+    it '#valid_ref?' do
+      expect(instance.valid_ref?('master')).to be true
+    end
+
+    it '#valid_commit?' do
+      expect(instance.valid_commit?('master')).to be true
+    end
+
+    it '#valid_commit? and nil sha' do
+      expect(instance.valid_commit?(nil)).to be false
+    end
+
+    it '#valid_commit? but invalid sha' do
+      allow(instance).to receive(:run_command).with(/clone/, silent: true).and_return([nil, true])
+      allow(instance).to receive(:run_command).with(/git\sshow.*/, silent: true).and_return([nil, false])
+      expect(instance.valid_commit?('invalid')).to be false
+    end
+
+    it '#valid_url?' do
+      expect(instance.valid_url?).to be true
+    end
+
+    it '#all_refs is a Array of Hashes' do
+      refs = instance.all_refs
+      expect(refs).to be_a Array
+      expect(refs.last).to eq(
+        { name: 'v5.0.0^{}', ref: 'refs/tags/v5.0.0^{}', sha: '1febd15f90d32e6b3d6c242a70db386b2ef1942c', subtype: nil, type: :tag }
+      )
+    end
+  end
+
+  describe 'bad url' do
+    let(:url) { 'https://github.com/nwops/typo' }
+
+    before(:each) do
+      allow(instance).to receive(:run_command).with("git ls-remote --symref #{url}").and_return(['', false])
+    end
+
+    let(:instance) do
+      Ra10ke::GitRepo.new(url)
+    end
+
+    it '#all_refs' do
+      expect(instance.all_refs).to be_a Array
+      expect(instance.all_refs).to eq []
+    end
+  end
+end

data/spec/ra10ke/puppetfile_parser_spec.rb

@@ -9,7 +9,9 @@ RSpec.describe 'Ra10ke::PuppetfileParser' do
     end
 
     let(:puppetfile_modules) do
-        [{:args=>{:version=>"2.2.0"}, :name=>"inifile", :namespace=>"puppetlabs"},
+        [{:args=>{:version=>'0.26.2'}, :name=>'choria', :namespace=>nil},
+             {:args=>{:version=>"2.2.0"}, :name=>"inifile", :namespace=>"puppetlabs"},
+             {:args=>{:version=>"1.0.1"}, :name=>"ruby", :namespace=>"puppetlabs"},
              {:args=>{:version=>"4.24.0"}, :name=>"stdlib", :namespace=>"puppetlabs"},
              {:args=>{:version=>"4.0.0"}, :name=>"concat", :namespace=>"puppetlabs"},
              {:args=>{:version=>"6.4.1"}, :name=>"ntp", :namespace=>"puppetlabs"},

data/spec/ra10ke/validate_spec.rb

@@ -9,40 +9,101 @@ RSpec.describe 'Ra10ke::Validate::Validation' do
     Ra10ke::Validate::Validation.new(puppetfile)
   end
 
-  let(:result) do
-    double
-  end
-
-  before(:each) do
-    allow(result).to receive(:success?).and_return(true)
-    # allow(instance).to receive(:`).with(anything).and_return(result)
-    allow($CHILD_STATUS).to receive(:success?).and_return(true)
-    allow(instance).to receive(:`).with(anything)
-    .and_return(File.read(File.join(fixtures_dir, 'reflist.txt')))
-  end
-
   let(:puppetfile) do
     File.join(fixtures_dir, 'Puppetfile')
   end
 
-  it '#new' do
-    expect(instance).to be_a Ra10ke::Validate::Validation
+  before(:each) do
+    allow_any_instance_of(Ra10ke::GitRepo).to receive(:valid_ref?).and_return(true)
+    allow_any_instance_of(Ra10ke::GitRepo).to receive(:valid_url?).and_return(true)
   end
 
-  it '#valid_ref?' do
-    expect(instance.valid_ref?('https://www.example.com', 'master')).to be true
+  describe 'bad url' do
+    let(:instance) do
+      Ra10ke::Validate::Validation.new(puppetfile)
+    end
+
+    let(:puppetfile) do
+      File.join(fixtures_dir, 'Puppetfile_with_bad_refs')
+    end
+
+    before(:each) do
+      working = double('Ra1ke::GitRepo', url: 'https://github.com/vshn/puppet-gitlab')
+      expect(working).to receive(:valid_ref?).with('00397b86dfb3487d9df768cbd3698d362132b5bf').and_return(false)
+      expect(working).to receive(:valid_commit?).with('00397b86dfb3487d9df768cbd3698d362132b5bf').and_return(true)
+      expect(working).to receive(:valid_url?).and_return(true)
+      bad_tag = double('Ra1ke::GitRepo', url: 'https://github.com/acidprime/r10k')
+      expect(bad_tag).to receive(:valid_ref?).with('bad').and_return(false)
+      expect(bad_tag).to receive(:valid_commit?).with(nil).and_return(false)
+      expect(bad_tag).to receive(:valid_url?).and_return(true)
+      bad_url = double('Ra1ke::GitRepo', url: 'https://github.com/nwops/typo')
+      expect(bad_url).to receive(:valid_ref?).with(nil).and_return(false)
+      expect(bad_url).to receive(:valid_commit?).with(nil).and_return(false)
+      expect(bad_url).to receive(:valid_url?).and_return(false)
+
+      expect(Ra10ke::GitRepo).to receive(:new).and_return(working, bad_tag, bad_url)
+    end
+
+    it 'details mods that are bad' do
+      expect(instance.all_modules.find { |m| !m[:valid_url?] }).to be_a Hash
+      expect(instance.all_modules.find_all { |m| !m[:valid_ref?] }.count).to eq(2)
+    end
   end
 
-  it '#valid_commit?' do
-    expect(instance.valid_commit?('https://www.example.com', 'master')).to be true
+  describe 'control_branch' do
+    before(:each) do
+      ENV.delete 'CONTROL_BRANCH'
+      ENV.delete 'CONTROL_BRANCH_FALLBACK'
+    end
+
+    let(:instance) do
+      Ra10ke::Validate::Validation.new(puppetfile)
+    end
+
+    let(:puppetfile) do
+      File.join(fixtures_dir, 'Puppetfile_with_control_branch')
+    end
+
+    it 'correctly replaces control branch' do
+      ENV['CONTROL_BRANCH'] = 'env-control_branch'
+      expect(instance.all_modules.find { |m| m[:name] == 'hiera_control' }[:ref]).to eq('env-control_branch')
+    end
+
+    it 'correctly detects current branch' do
+      allow(Ra10ke::GitRepo).to receive(:current_branch).and_return('current_branch-control_branch')
+      expect(instance.all_modules.find { |m| m[:name] == 'hiera_control' }[:ref]).to eq('current_branch-control_branch')
+    end
+
+    it 'correctly falls back if no current branch' do
+      ENV['CONTROL_BRANCH_FALLBACK'] = 'env-control_branch_fallback'
+      allow(Ra10ke::GitRepo).to receive(:current_branch).and_return(nil)
+      expect(instance.all_modules.find { |m| m[:name] == 'hiera_control' }[:ref]).to eq('env-control_branch_fallback')
+    end
+
+    it 'correctly falls back to default_branch if no current branch' do
+      allow(Ra10ke::GitRepo).to receive(:current_branch).and_return(nil)
+      expect(instance.all_modules.find { |m| m[:name] == 'hiera_controlwithdefault' }[:ref]).to eq('master')
+    end
+
+    it 'correctly falls back to fallback if no current branch but default branch' do
+      ENV['CONTROL_BRANCH_FALLBACK'] = 'env-control_branch_fallback'
+      allow(Ra10ke::GitRepo).to receive(:current_branch).and_return(nil)
+      expect(instance.all_modules.find { |m| m[:name] == 'hiera_controlwithdefault' }[:ref]).to eq('env-control_branch_fallback')
+    end
+
+    it 'correctly falls back to default_branch if no current branch with override' do
+      allow(Ra10ke::GitRepo).to receive(:current_branch).and_return(nil)
+      expect(instance.all_modules.find { |m| m[:name] == 'hiera_controlwithdefaultoverride' }[:ref]).to eq('master')
+    end
+
+    it 'correctly falls back to main if no current branch and no fallback' do
+      allow(Ra10ke::GitRepo).to receive(:current_branch).and_return(nil)
+      expect(instance.all_modules.find { |m| m[:name] == 'hiera_control' }[:ref]).to eq('main')
+    end
   end
 
-  it '#bad_mods?' do
-    allow(instance).to receive(:`).with(anything)
-    .and_return(File.read(File.join(fixtures_dir, 'reflist.txt')))
-    # because we can't test every single module we return the same result set
-    # which only passes for a single module, while others fail.
-    expect(instance.bad_mods?).to be true
+  it '#new' do
+    expect(instance).to be_a Ra10ke::Validate::Validation
   end
 
   it '#all_modules is an array' do
@@ -59,22 +120,13 @@ RSpec.describe 'Ra10ke::Validate::Validation' do
 
   it '#data is a hash with keys' do
     keys = instance.all_modules.first.keys
-    expect(keys).to eq(%i[name url ref valid_ref? status])
+    expect(keys).to eq(%i[name url ref valid_url? valid_ref? status])
   end
 
   it '#data is a hash with values' do
     keys = instance.all_modules.first.values
 
     expect(keys).to eq(['gitlab', 'https://github.com/vshn/puppet-gitlab',
-                        '00397b86dfb3487d9df768cbd3698d362132b5bf', true, '👍'])
-  end
-
-  it '#all_refs' do
-    refs = instance.all_refs('https://www.example.com')
-    expect(refs).to be_a Array
-    expect(refs.first).to eq(
-      {:sha=>"0ec707e431367bbe2752966be8ab915b6f0da754",:name=>"74110ac", :ref=>"refs/heads/74110ac", :subtype=>nil, :type=>:branch}
-    )
-
+                        '00397b86dfb3487d9df768cbd3698d362132b5bf', true, true, '👍'])
   end
 end

data/spec/ra10ke_spec.rb

@@ -6,7 +6,7 @@ require 'spec_helper'
 RSpec.describe 'Ra10ke::RakeTask' do
   let(:instance) do
     Ra10ke::RakeTask.new do |t|
-        t.puppetfile_path = puppetfile
+      t.puppetfile_path = puppetfile
     end
   end
 
@@ -50,6 +50,9 @@ RSpec.describe 'Ra10ke::RakeTask' do
 
   describe 'run tasks with good refs' do
     it '#run_validate_task' do
+      allow_any_instance_of(Ra10ke::GitRepo).to receive(:valid_ref?).and_return(true)
+      allow_any_instance_of(Ra10ke::GitRepo).to receive(:valid_url?).and_return(true)
+
       task = instance.define_task_validate(args)
       expect(task.invoke).to be_a Array
     end
@@ -59,14 +62,13 @@ RSpec.describe 'Ra10ke::RakeTask' do
     let(:puppetfile) do
       File.join(fixtures_dir, 'Puppetfile_with_bad_refs')
     end
-    
+
     # I suspect rake is caching something here and the puppetfile is 
     # not being sent correctly as it is not using the file I specify. 
     # The output should be different.
     # Testing this by itself works
     it '#run_validate_task' do
-      t =  Ra10ke::RakeTask.new
-      task2 = t.define_task_validate(args)
+      task2 = instance.define_task_validate(args)
       expect(task2.invoke).to be nil
     end
   end

data/spec/spec_helper.rb

@@ -1,3 +1,31 @@
+# frozen_string_literal: true
+
+begin
+  require 'simplecov'
+  require 'simplecov-console'
+  require 'codecov'
+rescue LoadError
+else
+  SimpleCov.start do
+    track_files 'lib/**/*.rb'
+
+    add_filter '/spec'
+
+    enable_coverage :branch
+
+    # do not track vendored files
+    add_filter '/vendor'
+    add_filter '/.vendor'
+  end
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::Console,
+    SimpleCov::Formatter::Codecov,
+  ]
+end
+
+require 'rspec/core'
+
 def fixtures_dir
     File.join(__dir__, 'fixtures')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ra10ke
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Theo Chatzimichos
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-08 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -123,6 +123,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+- !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: 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'
 description: R10K and Puppetfile rake tasks
 email:
 - voxpupuli@groups.io
@@ -130,17 +158,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- HISTORY.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/ra10ke.rb
 - lib/ra10ke/dependencies.rb
+- lib/ra10ke/deprecation.rb
 - lib/ra10ke/duplicates.rb
+- lib/ra10ke/git_repo.rb
 - lib/ra10ke/install.rb
 - lib/ra10ke/monkey_patches.rb
 - lib/ra10ke/puppetfile_parser.rb
@@ -152,9 +186,16 @@ files:
 - spec/fixtures/Puppetfile
 - spec/fixtures/Puppetfile_test
 - spec/fixtures/Puppetfile_with_bad_refs
+- spec/fixtures/Puppetfile_with_control_branch
 - spec/fixtures/Puppetfile_with_duplicates
-- spec/fixtures/reflist.txt
+- spec/fixtures/refs/debug.txt
+- spec/fixtures/refs/gitlab.txt
+- spec/fixtures/refs/r10k.txt
+- spec/fixtures/refs/reflist.txt
+- spec/ra10ke/dependencies_spec.rb
+- spec/ra10ke/deprecation_spec.rb
 - spec/ra10ke/duplicates_spec.rb
+- spec/ra10ke/git_repo_spec.rb
 - spec/ra10ke/puppetfile_parser_spec.rb
 - spec/ra10ke/validate_spec.rb
 - spec/ra10ke_spec.rb
@@ -171,15 +212,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Syntax check for the Puppetfile, check for outdated installed puppet modules