puppetfile-resolver 0.3.0 → 0.6.0

data/spec/fixtures/modulepath/test_module/metadata.json

@@ -0,0 +1,9 @@
+{
+  "name": "testfixture-test_module",
+  "version": "0.1.0",
+  "author": "testfixture",
+  "summary": "Skeleton module test fixture",
+  "license": "Apache-2.0",
+  "source": "http://localhost",
+  "dependencies": []
+}

data/spec/fixtures/proxy.rb

@@ -0,0 +1,9 @@
+require 'webrick'
+require 'webrick/httpproxy'
+
+proxy = WEBrick::HTTPProxyServer.new Port: (ARGV[0].nil? ? 32768 : ARGV[0])
+
+trap 'INT'  do proxy.shutdown end
+trap 'TERM' do proxy.shutdown end
+
+proxy.start

data/spec/integration/deprecation_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+require 'puppetfile-resolver/resolver'
+require 'puppetfile-resolver/puppetfile'
+
+
+describe 'Depreaction Tests' do
+  context 'With module_paths option' do
+    it 'should resolve a complete Puppetfile' do
+
+      content = <<-PUPFILE
+      forge 'https://forge.puppet.com'
+
+      # Local module path module
+      mod 'testfixture/test_module', :latest
+      PUPFILE
+
+      puppetfile = ::PuppetfileResolver::Puppetfile::Parser::R10KEval.parse(content)
+      resolver = PuppetfileResolver::Resolver.new(puppetfile)
+
+      expect(Warning).to receive(:warn).with(/module_paths/).and_return(nil)
+
+      result = resolver.resolve({
+        allow_missing_modules: false,
+        module_paths: [File.join(FIXTURES_DIR, 'modulepath')]
+      })
+
+      expect(result.specifications).to include('test_module')
+      expect(result.specifications['test_module'].version.to_s).to eq('0.1.0')
+    end
+  end
+end

data/spec/integration/kitchensink_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+require 'puppetfile-resolver/resolver'
+require 'puppetfile-resolver/puppetfile'
+
+describe 'KitchenSink Tests' do
+  it 'should resolve a complete Puppetfile' do
+    content = <<-PUPFILE
+    forge 'https://forge.puppet.com'
+
+    mod 'powershell',
+      :git => 'https://github.com/puppetlabs/puppetlabs-powershell',
+      :tag => 'v4.0.0'
+
+    mod 'simpkv',
+      :git => 'https://gitlab.com/simp/pupmod-simp-simpkv.git',
+      :tag => '0.7.1'
+
+    mod 'puppetlabs/stdlib', '6.3.0'
+
+    # Local module path module
+    mod 'testfixture/test_module', :latest
+
+    PUPFILE
+
+    puppetfile = ::PuppetfileResolver::Puppetfile::Parser::R10KEval.parse(content)
+
+    config = PuppetfileResolver::SpecSearchers::Configuration.new
+    config.local.puppet_module_paths = [File.join(FIXTURES_DIR, 'modulepath')]
+
+    resolver = PuppetfileResolver::Resolver.new(puppetfile)
+    result = resolver.resolve({
+      allow_missing_modules: false,
+      spec_searcher_configuration: config,
+    })
+
+    expect(result.specifications).to include('powershell')
+    expect(result.specifications['powershell'].version.to_s).to eq('4.0.0')
+
+    expect(result.specifications).to include('simpkv')
+    expect(result.specifications['simpkv'].version.to_s).to eq('0.7.1')
+
+    expect(result.specifications).to include('stdlib')
+    expect(result.specifications['stdlib'].version.to_s).to eq('6.3.0')
+
+    expect(result.specifications).to include('test_module')
+    expect(result.specifications['test_module'].version.to_s).to eq('0.1.0')
+  end
+end

data/spec/integration/proxy_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+require 'open3'
+require 'puppetfile-resolver/resolver'
+require 'puppetfile-resolver/puppetfile'
+
+describe 'Proxy Tests' do
+  let(:content) do <<-PUPFILE
+    forge 'https://forge.puppet.com'
+
+    mod 'powershell',
+      :git => 'https://github.com/puppetlabs/puppetlabs-powershell',
+      :tag => 'v4.0.0'
+
+    mod 'puppetlabs/stdlib', '6.3.0'
+    PUPFILE
+  end
+  let(:puppetfile) { ::PuppetfileResolver::Puppetfile::Parser::R10KEval.parse(content) }
+  let(:resolver_config) do
+    PuppetfileResolver::SpecSearchers::Configuration.new.tap do |obj|
+      obj.git.proxy = 'http://localhost:32768'
+      obj.forge.proxy = 'http://localhost:32768'
+    end
+  end
+
+  context 'with an invalid proxy server' do
+    it 'should not resolve a complete Puppetfile' do
+      resolver = PuppetfileResolver::Resolver.new(puppetfile)
+      result = resolver.resolve({
+        allow_missing_modules: true,
+        spec_searcher_configuration: resolver_config,
+      })
+
+      expect(result.specifications).to include('powershell')
+      expect(result.specifications['powershell']).to be_a(PuppetfileResolver::Models::MissingModuleSpecification)
+
+      expect(result.specifications).to include('stdlib')
+      expect(result.specifications['stdlib']).to be_a(PuppetfileResolver::Models::MissingModuleSpecification)
+    end
+  end
+
+  context 'with a valid proxy server' do
+    def start_proxy_server(start_options = ['--timeout=5'])
+      cmd = "ruby \"#{File.join(FIXTURES_DIR, 'proxy.rb')}\" 32768"
+
+      stdin, stdout, stderr, wait_thr = Open3.popen3(cmd)
+      # Wait for the Proxy server to indicate it started
+      line = nil
+      begin
+        line = stderr.readline
+      end until line =~ /#start/
+      stdout.close
+      stdin.close
+      [wait_thr, stderr]
+    end
+
+    before(:each) do
+      @server_thr, @server_pipe = start_proxy_server
+    end
+
+    after(:each) do
+      begin
+        Process.kill("KILL", @server_thr[:pid])
+        Process.wait(@server_thr[:pid])
+      rescue
+        # The server process may not exist and checking in a cross platform way in ruby is difficult
+        # Instead just swallow any errors
+      end
+
+      begin
+        @server_pipe.close
+      rescue
+        # The server process may not exist and checking in a cross platform way in ruby is difficult
+        # Instead just swallow any errors
+      end
+    end
+
+    it 'should resolve a complete Puppetfile' do
+      resolver = PuppetfileResolver::Resolver.new(puppetfile)
+      result = resolver.resolve({
+        allow_missing_modules: false,
+        spec_searcher_configuration: resolver_config,
+      })
+
+      expect(result.specifications).to include('powershell')
+      expect(result.specifications['powershell'].version.to_s).to eq('4.0.0')
+
+      expect(result.specifications).to include('stdlib')
+      expect(result.specifications['stdlib'].version.to_s).to eq('6.3.0')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,6 +4,8 @@ root = File.join(__dir__,'..',)
 # Add the language server into the load path
 $LOAD_PATH.unshift(File.join(root,'lib'))
 
+FIXTURES_DIR = File.join(__dir__,'fixtures')
+
 # A cache which we can preload for the purposes of testing, mimicing
 # Local modules
 require 'puppetfile-resolver/cache/base'

data/spec/unit/puppetfile-resolver/puppetfile/parser/r10k_eval_spec.rb

@@ -29,6 +29,8 @@ RSpec.shared_examples "a puppetfile parser with valid content" do
     mod 'local', :local => 'some/path'
 
     mod 'svn_min', :svn => 'some-svn-repo'
+
+    mod 'puppetlabs-forge_missing'
     EOT
   end
 
@@ -47,7 +49,7 @@ RSpec.shared_examples "a puppetfile parser with valid content" do
   end
 
   it "should detect all of the modules" do
-    expect(puppetfile.modules.count).to eq(8)
+    expect(puppetfile.modules.count).to eq(9)
   end
 
   it "should not set any resolver flags" do
@@ -62,7 +64,7 @@ RSpec.shared_examples "a puppetfile parser with valid content" do
       expect(mod.title).to eq('puppetlabs-forge_fixed_ver')
       expect(mod.owner).to eq('puppetlabs')
       expect(mod.name).to eq('forge_fixed_ver')
-      expect(mod.version).to eq('1.0.0')
+      expect(mod.version).to eq('=1.0.0')
       expect(mod.location.start_line).to eq(2)
       expect(mod.location.start_char).to be_nil
       expect(mod.location.end_line).to eq(2)
@@ -82,6 +84,20 @@ RSpec.shared_examples "a puppetfile parser with valid content" do
       expect(mod.location.end_line).to eq(3)
       expect(mod.location.end_char).to  be_nil
     end
+
+    it 'should detect missing latest version modules as latest' do
+      mod = get_module(puppetfile, 'puppetlabs-forge_missing')
+
+      expect(mod.module_type).to eq(PuppetfileResolver::Puppetfile::FORGE_MODULE)
+      expect(mod.title).to eq('puppetlabs-forge_missing')
+      expect(mod.owner).to eq('puppetlabs')
+      expect(mod.name).to eq('forge_missing')
+      expect(mod.version).to eq(:latest)
+      expect(mod.location.start_line).to eq(25)
+      expect(mod.location.start_char).to be_nil
+      expect(mod.location.end_line).to eq(25)
+      expect(mod.location.end_char).to  be_nil
+    end
   end
 
   context 'with Git modules' do
@@ -379,7 +395,6 @@ RSpec.shared_examples "a puppetfile parser with invalid content" do
     forge 'https://fake-forge.puppetlabs.com/'
 
     mod 'puppetlabs-bad_version', 'b.c.d'
-    mod 'puppetlabs-missing_version'
 
     mod 'bad_args',
       :gitx => 'git@github.com:puppetlabs/puppetlabs-git_ref.git'
@@ -393,7 +408,7 @@ RSpec.shared_examples "a puppetfile parser with invalid content" do
   end
 
   it "should detect all of the invalid modules" do
-    expect(puppetfile.modules.count).to eq(3)
+    expect(puppetfile.modules.count).to eq(2)
 
     puppetfile.modules.each do |mod|
       expect(mod).to have_attributes(:module_type => PuppetfileResolver::Puppetfile::INVALID_MODULE)

data/spec/unit/puppetfile-resolver/resolver_spec.rb

@@ -7,7 +7,7 @@ describe PuppetfileResolver::Resolver do
   let(:puppet_version) { nil }
   let(:subject) { PuppetfileResolver::Resolver.new(puppetfile_document, puppet_version) }
   let(:cache) { MockLocalModuleCache.new }
-  let(:default_resolve_options) { { cache: cache, module_paths: ['??does/not/exist'] } }
+  let(:default_resolve_options) { { cache: cache } }
   let(:resolve_options) { default_resolve_options }
 
   RSpec.shared_examples 'a resolver flag' do |flag|
@@ -245,6 +245,49 @@ describe PuppetfileResolver::Resolver do
       end
     end
 
+    context "Given a document with resolvable version range dependencies" do
+      [
+        { range: '> 1.0.0 < 3.0.0', expected_version: '2.0.0' },
+        { range: '< 2.5.0',         expected_version: '2.0.0' },
+        { range: '<= 2.0.0',        expected_version: '2.0.0' },
+        { range: '>= 2.0.0',        expected_version: '3.0.0' },
+        { range: '= 1.0.0',         expected_version: '1.0.0' },
+        { range: :latest,           expected_version: '3.0.0' },
+        { range: nil,               expected_version: '3.0.0' }
+      ].each do |range_testcase|
+        describe "With a range of '#{range_testcase[:range]}'" do
+          let(:puppetfile_document) do
+            doc = valid_document('foo')
+            doc.add_module(PuppetfileResolver::Puppetfile::LocalModule.new('module1').tap { |o| o.version = range_testcase[:range] })
+            doc
+          end
+
+          before(:each) do
+            cache.add_local_module_spec('module1', [], nil, '1.0.0')
+            cache.add_local_module_spec('module1', [], nil, '2.0.0')
+            cache.add_local_module_spec('module1', [], nil, '3.0.0')
+          end
+
+          [true, false].each do |testcase|
+            context "and Allow Missing Modules option is #{testcase}" do
+              let(:resolve_options) { default_resolve_options.merge(allow_missing_modules: testcase) }
+
+              it 'should resolve without error' do
+                expect{ subject.resolve(resolve_options) }.to_not raise_error
+              end
+
+              it 'should resolve with found module specifications' do
+                result = subject.resolve(resolve_options)
+
+                expect(result.specifications).to include('module1')
+                expect(result.specifications['module1'].version.to_s).to eq(range_testcase[:expected_version])
+              end
+            end
+          end
+        end
+      end
+    end
+
     context "Given a document with a resolvable Puppet requirement" do
       let(:puppet_version) { '3.0.0' }
       let(:puppetfile_document) do

data/spec/unit/puppetfile-resolver/spec_searchers/git/gclone_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'puppetfile-resolver/spec_searchers/git/gclone'
+require 'puppetfile-resolver/spec_searchers/git_configuration'
+require 'logger'
+require 'json'
+
+describe PuppetfileResolver::SpecSearchers::Git::GClone do
+  PuppetfileModule = Struct.new(:remote, :ref, :branch, :commit, :tag, keyword_init: true)
+  config = PuppetfileResolver::SpecSearchers::Configuration.new
+  config.local.puppet_module_paths = [File.join(FIXTURES_DIR, 'modulepath')]
+
+  let(:url) do
+    'https://github.com/puppetlabs/puppetlabs-powershell'
+  end
+
+  let(:puppetfile_module) do
+    PuppetfileModule.new(remote: url)
+  end
+
+
+  context 'valid url' do
+    it 'reads metadata' do
+      content = subject.metadata(puppetfile_module, Logger.new(STDERR), config)
+      expect(JSON.parse(content)['name']).to eq('puppetlabs-powershell')
+    end
+
+    context 'with ref' do
+
+      let(:puppetfile_module) do
+        PuppetfileModule.new(remote: url, ref: '2.1.2')
+      end
+
+      it 'reads metadata' do
+        content = subject.metadata(puppetfile_module, Logger.new(STDERR), config)
+        expect(JSON.parse(content)['name']).to eq('puppetlabs-powershell')
+      end
+    end
+  end
+
+  context 'invalid url' do
+    let(:url) do
+      'https://github.com/puppetlabs/puppetlabs-powershellbad'
+    end
+
+    it 'throws exception' do
+      expect{subject.metadata(puppetfile_module, Logger.new(STDERR), config)}
+      .to raise_exception(RuntimeError)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppetfile-resolver
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Glenn Sarti
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-11 00:00:00.000000000 Z
+date: 2022-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: molinillo
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 description: Resolves the Puppet Modules in a Puppetfile with a full dependency graph,
-  including Puppet version checkspec.
+  including Puppet version checks.
 email:
 - glennsarti@users.noreply.github.com
 executables: []
@@ -81,23 +81,37 @@ files:
 - lib/puppetfile-resolver/resolution_result.rb
 - lib/puppetfile-resolver/resolver.rb
 - lib/puppetfile-resolver/spec_searchers/common.rb
+- lib/puppetfile-resolver/spec_searchers/configuration.rb
 - lib/puppetfile-resolver/spec_searchers/forge.rb
+- lib/puppetfile-resolver/spec_searchers/forge_configuration.rb
 - lib/puppetfile-resolver/spec_searchers/git.rb
+- lib/puppetfile-resolver/spec_searchers/git/gclone.rb
+- lib/puppetfile-resolver/spec_searchers/git/github.rb
+- lib/puppetfile-resolver/spec_searchers/git/gitlab.rb
+- lib/puppetfile-resolver/spec_searchers/git_configuration.rb
 - lib/puppetfile-resolver/spec_searchers/local.rb
+- lib/puppetfile-resolver/spec_searchers/local_configuration.rb
 - lib/puppetfile-resolver/ui/debug_ui.rb
 - lib/puppetfile-resolver/ui/null_ui.rb
 - lib/puppetfile-resolver/util.rb
 - lib/puppetfile-resolver/version.rb
 - puppetfile-cli.rb
+- spec/fixtures/modulepath/test_module/README.md
+- spec/fixtures/modulepath/test_module/metadata.json
+- spec/fixtures/proxy.rb
+- spec/integration/deprecation_spec.rb
+- spec/integration/kitchensink_spec.rb
+- spec/integration/proxy_spec.rb
 - spec/spec_helper.rb
 - spec/unit/puppetfile-resolver/puppetfile/document_spec.rb
 - spec/unit/puppetfile-resolver/puppetfile/parser/r10k_eval_spec.rb
 - spec/unit/puppetfile-resolver/resolver_spec.rb
+- spec/unit/puppetfile-resolver/spec_searchers/git/gclone_spec.rb
 homepage: https://glennsarti.github.io/puppetfile-resolver/
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,19 +119,26 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.9
+      version: 2.5.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Dependency resolver for Puppetfiles
 test_files:
+- spec/fixtures/modulepath/test_module/metadata.json
+- spec/fixtures/modulepath/test_module/README.md
+- spec/fixtures/proxy.rb
+- spec/integration/deprecation_spec.rb
+- spec/integration/kitchensink_spec.rb
+- spec/integration/proxy_spec.rb
 - spec/spec_helper.rb
 - spec/unit/puppetfile-resolver/puppetfile/document_spec.rb
 - spec/unit/puppetfile-resolver/puppetfile/parser/r10k_eval_spec.rb
 - spec/unit/puppetfile-resolver/resolver_spec.rb
+- spec/unit/puppetfile-resolver/spec_searchers/git/gclone_spec.rb