puppetfile-resolver 0.5.0 → 0.6.0

data/lib/puppetfile-resolver/spec_searchers/git/gclone.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'English'
+require 'puppetfile-resolver/util'
+require 'puppetfile-resolver/spec_searchers/common'
+require 'puppetfile-resolver/spec_searchers/git_configuration'
+require 'puppetfile-resolver/util'
+require 'uri'
+
+module PuppetfileResolver
+  module SpecSearchers
+    module Git
+      module GClone
+        # @summary clones the remote url and reads the metadata file
+        # @returns [String] the content of the metadata file
+        def self.metadata(puppetfile_module, resolver_ui, config)
+          repo_url = puppetfile_module.remote
+
+          unless PuppetfileResolver::Util.git?
+            resolver_ui.debug { 'Git executible not found, unable to use git clone resolution' }
+
+            return nil
+          end
+          return nil if repo_url.nil?
+          return nil unless valid_http_url?(repo_url)
+
+          metadata_file = 'metadata.json'
+
+          ref = puppetfile_module.ref ||
+                puppetfile_module.tag ||
+                puppetfile_module.commit ||
+                puppetfile_module.branch ||
+                'HEAD'
+
+          resolver_ui.debug { "Querying git repository #{repo_url}" }
+
+          clone_and_read_file(repo_url, ref, metadata_file, config)
+        end
+
+        # @summary clones the git url and reads the file at the given ref
+        #          a temp directory will be created and then destroyed during
+        #          the cloning and reading process
+        # @param ref [String] the git ref, branch, commit, tag
+        # @param file [String] the file you wish to read
+        # @returns [String] the content of the file
+        def self.clone_and_read_file(url, ref, file, config)
+          clone_cmd = ['git', 'clone', '--bare', '--depth=1', '--single-branch']
+          err_msg = ''
+          if config.git.proxy
+            err_msg += " with proxy #{config.git.proxy}: "
+            proxy = "--config \"http.proxy=#{config.git.proxy}\" --config \"https.proxy=#{config.proxy}\""
+            clone_cmd.push(proxy)
+          end
+
+          Dir.mktmpdir(nil, config.git.clone_dir) do |dir|
+            clone_cmd.push("--branch=#{ref}") if ref != 'HEAD'
+            clone_cmd.push(url, dir)
+            out, err_out, process = ::PuppetfileResolver::Util.run_command(clone_cmd)
+            err_msg += out
+            raise err_msg unless process.success?
+            Dir.chdir(dir) do
+              content, err_out, process = ::PuppetfileResolver::Util.run_command(['git', 'show', "#{ref}:#{file}"])
+              raise 'InvalidContent' unless process.success? && content.length > 2
+              return content
+            end
+          end
+        end
+
+        def self.valid_http_url?(url)
+          # uri does not work with git urls, return true
+          return true if url.start_with?('git@')
+
+          uri = URI.parse(url)
+          uri.is_a?(URI::HTTP) && !uri.host.nil?
+        rescue URI::InvalidURIError
+          false
+        end
+      end
+    end
+  end
+end

data/lib/puppetfile-resolver/spec_searchers/git/github.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'puppetfile-resolver/util'
+require 'puppetfile-resolver/spec_searchers/common'
+require 'puppetfile-resolver/spec_searchers/git_configuration'
+
+module PuppetfileResolver
+  module SpecSearchers
+    module Git
+      module GitHub
+        def self.metadata(puppetfile_module, resolver_ui, config)
+          repo_url = nil
+          if puppetfile_module.remote.start_with?('git@github.com:')
+            repo_url = puppetfile_module.remote.slice(15..-1)
+            repo_url = repo_url.slice(0..-5) if repo_url.end_with?('.git')
+          elsif puppetfile_module.remote.start_with?('https://github.com/')
+            repo_url = puppetfile_module.remote.slice(19..-1)
+            repo_url = repo_url.slice(0..-5) if repo_url.end_with?('.git')
+          end
+          return nil if repo_url.nil?
+
+          metadata_url = 'https://raw.githubusercontent.com/' + repo_url + '/'
+          if puppetfile_module.ref
+            metadata_url += puppetfile_module.ref + '/'
+          elsif puppetfile_module.tag
+            metadata_url += puppetfile_module.tag + '/'
+          else
+            # Default to master. Should it raise?
+            metadata_url += 'master/'
+          end
+          metadata_url += 'metadata.json'
+
+          resolver_ui.debug { "Querying GitHub with #{metadata_url}" }
+          err_msg = "Unable to find module at #{puppetfile_module.remote}"
+          err_msg += config.proxy ? " with proxy #{config.proxy}: " : ': '
+          response = nil
+
+          begin
+            response = ::PuppetfileResolver::Util.net_http_get(metadata_url, config.proxy)
+          rescue ::StandardError => e
+            raise err_msg + e.message
+          end
+
+          if response.code != '200'
+            resolver_ui.debug(err_msg + "Expected HTTP Code 200, but received #{response.code}")
+            return ''
+          end
+          response.body
+        end
+      end
+    end
+  end
+end

data/lib/puppetfile-resolver/spec_searchers/git/gitlab.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'puppetfile-resolver/util'
+require 'puppetfile-resolver/spec_searchers/common'
+require 'puppetfile-resolver/spec_searchers/git_configuration'
+
+module PuppetfileResolver
+  module SpecSearchers
+    module Git
+      module GitLab
+        def self.metadata(puppetfile_module, resolver_ui, config)
+          repo_url = nil
+          if puppetfile_module.remote.start_with?('git@gitlab.com:')
+            repo_url = puppetfile_module.remote.slice(15..-1)
+            repo_url = repo_url.slice(0..-5) if repo_url.end_with?('.git')
+          elsif puppetfile_module.remote.start_with?('https://gitlab.com/')
+            repo_url = puppetfile_module.remote.slice(19..-1)
+            repo_url = repo_url.slice(0..-5) if repo_url.end_with?('.git')
+          end
+          return nil if repo_url.nil?
+
+          # Example URL
+          # https://gitlab.com/simp/pupmod-simp-crypto_policy/-/raw/0.1.4/metadata.json
+          metadata_url = 'https://gitlab.com/' + repo_url + '/-/raw/'
+          if puppetfile_module.ref
+            metadata_url += puppetfile_module.ref + '/'
+          elsif puppetfile_module.tag
+            metadata_url += puppetfile_module.tag + '/'
+          else
+            # Default to master. Should it raise?
+            metadata_url += 'master/'
+          end
+          metadata_url += 'metadata.json'
+
+          resolver_ui.debug { "Querying GitLab with #{metadata_url}" }
+          err_msg = "Unable to find module at #{puppetfile_module.remote}"
+          err_msg += config.proxy ? " with proxy #{config.proxy}: " : ': '
+          response = nil
+
+          begin
+            response = ::PuppetfileResolver::Util.net_http_get(metadata_url, config.proxy)
+          rescue ::StandardError => e
+            raise err_msg + e.message
+          end
+
+          if response.code != '200'
+            resolver_ui.debug(err_msg + "Expected HTTP Code 200, but received #{response.code}")
+            return ''
+          end
+          response.body
+        end
+      end
+    end
+  end
+end

data/lib/puppetfile-resolver/spec_searchers/git.rb

@@ -3,6 +3,9 @@
 require 'puppetfile-resolver/util'
 require 'puppetfile-resolver/spec_searchers/common'
 require 'puppetfile-resolver/spec_searchers/git_configuration'
+require 'puppetfile-resolver/spec_searchers/git/github'
+require 'puppetfile-resolver/spec_searchers/git/gitlab'
+require 'puppetfile-resolver/spec_searchers/git/gclone'
 
 module PuppetfileResolver
   module SpecSearchers
@@ -12,54 +15,21 @@ module PuppetfileResolver
         # Has the information been cached?
         return cache.load(dep_id) if cache.exist?(dep_id)
 
-        # We _could_ git clone this, but it'll take too long. So for now, just
-        # try and resolve github based repositories by crafting a URL
+        # The git clone method takes around (1s) depending on repo size.  Not sure if the
+        # other methods take longer or shorter but I preserved the legacy code for now.
+        # Technically, the gclone class could replace the other classes and speed up
+        # this process here.
+        metadata = GitHub.metadata(puppetfile_module, resolver_ui, config) ||
+                   GitLab.metadata(puppetfile_module, resolver_ui, config) ||
+                   GClone.metadata(puppetfile_module, resolver_ui, config)
 
-        repo_url = nil
-        if puppetfile_module.remote.start_with?('git@github.com:')
-          repo_url = puppetfile_module.remote.slice(15..-1)
-          repo_url = repo_url.slice(0..-5) if repo_url.end_with?('.git')
-        end
-        if puppetfile_module.remote.start_with?('https://github.com/')
-          repo_url = puppetfile_module.remote.slice(19..-1)
-          repo_url = repo_url.slice(0..-5) if repo_url.end_with?('.git')
-        end
-
-        return [] if repo_url.nil?
-
-        metadata_url = 'https://raw.githubusercontent.com/' + repo_url + '/'
-        if puppetfile_module.ref
-          metadata_url += puppetfile_module.ref + '/'
-        elsif puppetfile_module.tag
-          metadata_url += puppetfile_module.tag + '/'
-        else
-          # Default to master.  Should it raise?
-          metadata_url += 'master/'
-        end
-        metadata_url += 'metadata.json'
-
-        require 'net/http'
-        require 'uri'
-
-        resolver_ui.debug { "Querying GitHub with #{metadata_url}" }
-        err_msg = "Unable to find module at #{puppetfile_module.remote}"
-        err_msg += config.proxy ? " with proxy #{config.proxy}: " : ': '
-        response = nil
-
-        begin
-          response = ::PuppetfileResolver::Util.net_http_get(metadata_url, config.proxy)
-        rescue ::StandardError => e
-          raise err_msg + e.message
-        end
-
-        if response.code != '200'
-          resolver_ui.debug(err_msg + "Expected HTTP Code 200, but received #{response.code}")
+        if metadata.nil? || metadata.empty?
+          # Cache that we couldn't find the metadata
           cache.save(dep_id, [])
           return []
         end
 
-        # TODO: symbolise_object should be in a Util namespace
-        metadata = ::PuppetfileResolver::Util.symbolise_object(::JSON.parse(response.body))
+        metadata = ::PuppetfileResolver::Util.symbolise_object(::JSON.parse(metadata))
         result = [Models::ModuleSpecification.new(
           name: metadata[:name],
           origin: :git,

data/lib/puppetfile-resolver/spec_searchers/git_configuration.rb

@@ -3,7 +3,7 @@
 module PuppetfileResolver
   module SpecSearchers
     class GitConfiguration
-      attr_accessor :proxy
+      attr_accessor :proxy, :clone_dir
     end
   end
 end

data/lib/puppetfile-resolver/util.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'open3'
+
 module PuppetfileResolver
   module Util
     def self.symbolise_object(object)
@@ -43,5 +45,22 @@ module PuppetfileResolver
       Net::HTTP.start(*start_args, http_options) { |http| return http.request(Net::HTTP::Get.new(uri)) }
       nil
     end
+
+    # @summary runs the command on the shell
+    # @param cmd [Array] an array of command and args
+    # @returns [Array] the result of running the comand and the process
+    # @example run_command(['git', '--version'])
+    def self.run_command(cmd)
+      Open3.capture3(*cmd)
+    end
+
+    # @summary checks if git is installed and on the path
+    # @returns [Boolean] true if git is found in the path
+    def self.git?
+      Open3.capture3('git', '--version')
+      true
+    rescue Errno::ENOENT
+      false
+    end
   end
 end

data/lib/puppetfile-resolver/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PuppetfileResolver
-  VERSION ||= '0.5.0'
+  VERSION ||= '0.6.0'
 end

data/spec/integration/kitchensink_spec.rb

@@ -3,10 +3,8 @@ 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'
 
@@ -14,6 +12,10 @@ describe 'KitchenSink Tests' do
       :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
@@ -35,6 +37,9 @@ describe 'KitchenSink Tests' do
     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')
 

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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Glenn Sarti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-16 00:00:00.000000000 Z
+date: 2022-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: molinillo
@@ -85,6 +85,9 @@ files:
 - 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
@@ -103,6 +106,7 @@ files:
 - 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
@@ -137,3 +141,4 @@ test_files:
 - 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