dependabot-terraform 0.148.10 → 0.149.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ed478756c01d88049afd53fc85a20ad7ed9063791ab30058d0f917e26dc47e5
-  data.tar.gz: 72510b0297858ce6b4d417542100a6697d546a4e0e4d0d405e55a1e51796fb43
+  metadata.gz: e9de51bfa366e94b80943405b7083988d76080444dc177b57d9a8fd425e9292f
+  data.tar.gz: 1d4794c8175cac535813c12a8e017e3b8e3c4f96068a91e5db3c75db5945ceba
 SHA512:
-  metadata.gz: 8c2c0a8a731d1ff0baf8ce05af819e819702be48302173d12e6973b84af8e304fe75cdb323198f28d4a20358c836a8edb699659bf5db3232944334cd76f7e735
-  data.tar.gz: 4a651ed95e4d097100595c457146faba5e097ea12b1f7ebecbd38156bd55c7f51ec07fdb84c0a07ff8defdcd4546c92376571ffc5b3e322bfd68402e33ddeec0
+  metadata.gz: 74431e13c158375f439e50127078fd7db31b56387cf3a2ff5d013ebff91427642c2b67874dd94a22e83d336f58efddcb6ec9edeb4181d7cadc25fe759fe12fcc
+  data.tar.gz: 384487d5ad087fee58324485f1c288ae7803f550e6b763128efadc883999931dd233182f56afc8c26ec2030d20179b234d32b0c96b535722c72fedf4cfa0e49e

data/lib/dependabot/terraform/file_updater.rb

@@ -99,19 +99,19 @@ module Dependabot
 
       def provider_declaration_regex
         name = Regexp.escape(dependency.name)
-        /
-          ((source\s*=\s*["']#{name}["']|\s*#{name}\s*=\s*\{.*)
+        %r{
+          ((source\s*=\s*["'](#{Regexp.escape(registry_host_for(dependency))}/)?#{name}["']|\s*#{name}\s*=\s*\{.*)
           (?:(?!^\}).)+)
-        /mx
+        }mx
       end
 
       def registry_declaration_regex
-        /
+        %r{
           (?<=\{)
           (?:(?!^\}).)*
-          source\s*=\s*["']#{Regexp.escape(dependency.name)}["']
+          source\s*=\s*["'](#{Regexp.escape(registry_host_for(dependency))}/)?#{Regexp.escape(dependency.name)}["']
           (?:(?!^\}).)*
-        /mx
+        }mx
       end
 
       def git_declaration_regex(filename)
@@ -126,6 +126,11 @@ module Dependabot
           (?:(?!^\}).)*
         /mx
       end
+
+      def registry_host_for(dependency)
+        source = dependency.requirements.map { |r| r[:source] }.compact.first
+        source[:registry_hostname] || source["registry_hostname"] || "registry.terraform.io"
+      end
     end
   end
 end

data/lib/dependabot/terraform/metadata_finder.rb

@@ -4,6 +4,7 @@ require "excon"
 require "json"
 require "dependabot/metadata_finders"
 require "dependabot/metadata_finders/base"
+require "dependabot/terraform/registry_client"
 require "dependabot/shared_helpers"
 
 module Dependabot
@@ -40,7 +41,9 @@ module Dependabot
         info = dependency.requirements.map { |r| r[:source] }.compact.first
         hostname = info[:registry_hostname] || info["registry_hostname"]
 
-        RegistryClient.new(hostname: hostname).source(dependency: dependency)
+        RegistryClient.
+          new(hostname: hostname, credentials: credentials).
+          source(dependency: dependency)
       end
     end
   end

data/lib/dependabot/terraform/registry_client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "dependabot/dependency"
+require "dependabot/errors"
 require "dependabot/source"
 require "dependabot/terraform/version"
 
@@ -11,8 +12,11 @@ module Dependabot
     class RegistryClient
       PUBLIC_HOSTNAME = "registry.terraform.io"
 
-      def initialize(hostname:)
+      def initialize(hostname: PUBLIC_HOSTNAME, credentials: [])
         @hostname = hostname
+        @tokens = credentials.each_with_object({}) do |item, memo|
+          memo[item["host"]] = item["token"] if item["type"] == "terraform_registry"
+        end
       end
 
       # Fetch all the versions of a provider, and return a Version
@@ -21,14 +25,12 @@ module Dependabot
       # @param identifier [String] the identifier for the dependency, i.e:
       # "hashicorp/aws"
       # @return [Array<Dependabot::Terraform::Version>]
-      # @raise [RuntimeError] when the versions cannot be retrieved
+      # @raise [Dependabot::DependabotError] when the versions cannot be retrieved
       def all_provider_versions(identifier:)
-        # TODO: Implement service discovery for custom registries
-        return [] unless hostname == PUBLIC_HOSTNAME
+        base_url = service_url_for("providers.v1")
+        response = http_get!(URI.join(base_url, "#{identifier}/versions"))
 
-        response = get(endpoint: "providers/#{identifier}/versions")
-
-        JSON.parse(response).
+        JSON.parse(response.body).
           fetch("versions").
           map { |release| version_class.new(release.fetch("version")) }
       end
@@ -39,14 +41,12 @@ module Dependabot
       # @param identifier [String] the identifier for the dependency, i.e:
       # "hashicorp/consul/aws"
       # @return [Array<Dependabot::Terraform::Version>]
-      # @raise [RuntimeError] when the versions cannot be retrieved
+      # @raise [Dependabot::DependabotError] when the versions cannot be retrieved
       def all_module_versions(identifier:)
-        # TODO: Implement service discovery for custom registries
-        return [] unless hostname == PUBLIC_HOSTNAME
-
-        response = get(endpoint: "modules/#{identifier}/versions")
+        base_url = service_url_for("modules.v1")
+        response = http_get!(URI.join(base_url, "#{identifier}/versions"))
 
-        JSON.parse(response).
+        JSON.parse(response.body).
           fetch("modules").first.fetch("versions").
           map { |release| version_class.new(release.fetch("version")) }
       end
@@ -59,45 +59,85 @@ module Dependabot
       # @param dependency [Dependabot::Dependency] the dependency who's source
       # we're attempting to find
       # @return Dependabot::Source
-      # @raise [RuntimeError] when the source cannot be retrieved
+      # @raise [Dependabot::DependabotError] when the source cannot be retrieved
       def source(dependency:)
-        # TODO: Implement service discovery for custom registries
-        return unless hostname == PUBLIC_HOSTNAME
-
         type = dependency.requirements.first[:source][:type]
-        endpoint = if type == "registry"
-                     "modules/#{dependency.name}/#{dependency.version}"
-                   elsif type == "provider"
-                     "providers/#{dependency.name}/#{dependency.version}"
-                   else
-                     raise "Invalid source type"
-                   end
-        response = get(endpoint: endpoint)
-
-        source_url = JSON.parse(response).fetch("source")
+        base_url = service_url_for(service_key_for(type))
+        response = http_get!(URI.join(base_url, "#{dependency.name}/#{dependency.version}"))
+
+        source_url = JSON.parse(response.body).fetch("source")
         Source.from_url(source_url) if source_url
       end
 
+      # Perform service discovery and return the absolute URL for
+      # the requested service.
+      # https://www.terraform.io/docs/internals/remote-service-discovery.html
+      #
+      # @param service_key [String] the service type described in https://www.terraform.io/docs/internals/remote-service-discovery.html#supported-services
+      # @param return String
+      # @raise [Dependabot::DependabotError] when the service is not available
+      def service_url_for(service_key)
+        url_for(services.fetch(service_key))
+      rescue KeyError
+        raise error("Host does not support required Terraform-native service")
+      end
+
       private
 
-      attr_reader :hostname
+      attr_reader :hostname, :tokens
 
-      def get(endpoint:)
-        url = "https://#{hostname}/v1/#{endpoint}"
+      def version_class
+        Version
+      end
 
-        response = Excon.get(
-          url,
-          idempotent: true,
-          **SharedHelpers.excon_defaults
-        )
+      def headers_for(hostname)
+        token = tokens[hostname]
+        token ? { "Authorization" => "Bearer #{token}" } : {}
+      end
 
-        raise "Response from registry was #{response.status}" unless response.status == 200
+      def services
+        @services ||=
+          begin
+            response = http_get(url_for("/.well-known/terraform.json"))
+            response.status == 200 ? JSON.parse(response.body) : {}
+          end
+      end
 
-        response.body
+      def service_key_for(type)
+        case type
+        when "module", "modules", "registry"
+          "modules.v1"
+        when "provider", "providers"
+          "providers.v1"
+        else
+          raise error("Invalid source type")
+        end
       end
 
-      def version_class
-        Version
+      def http_get(url)
+        Excon.get(url.to_s, idempotent: true, **SharedHelpers.excon_defaults(headers: headers_for(hostname)))
+      end
+
+      def http_get!(url)
+        response = http_get(url)
+
+        raise error("Response from registry was #{response.status}") unless response.status == 200
+
+        response
+      end
+
+      def url_for(path)
+        uri = URI.parse(path)
+        return uri.to_s if uri.scheme == "https"
+        raise error("Unsupported scheme provided") if uri.host && uri.scheme
+
+        uri.host = hostname
+        uri.scheme = "https"
+        uri.to_s
+      end
+
+      def error(message)
+        Dependabot::DependabotError.new(message)
       end
     end
   end

data/lib/dependabot/terraform/update_checker.rb

@@ -87,7 +87,7 @@ module Dependabot
       def registry_client
         @registry_client ||= begin
           hostname = dependency_source_details.fetch(:registry_hostname)
-          RegistryClient.new(hostname: hostname)
+          RegistryClient.new(hostname: hostname, credentials: credentials)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dependabot-terraform
 version: !ruby/object:Gem::Version
-  version: 0.148.10
+  version: 0.149.4
 platform: ruby
 authors:
 - Dependabot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dependabot-common
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.148.10
+        version: 0.149.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.148.10
+        version: 0.149.4
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement