dependabot-terraform 0.148.6 → 0.149.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae4366dea7cdc8902be7fc60c702dd4880f3eb061779da6b0dafee4ec81b0a30
-  data.tar.gz: 27006c4842926165444aba49096aae361c6dd8b84639546cb0fb800f9ac51f18
+  metadata.gz: 36c78f6a28ee4ff879140720e2ab9fa49a11fcec5d7c5312c18147051264e826
+  data.tar.gz: f7a0be0a203afd35b77a5e51b10bea90df77457caf15757640bc4e80d8bf108b
 SHA512:
-  metadata.gz: bf9ec46421f129b6c566bb489f0c0da2f6a95cb760f429f2f03e6be456356746bc538e17fce65f12b3da331451b7346600744888d36d0919e0a1b43a65d74d7c
-  data.tar.gz: 7a4c1512faf5c2f2be193fd71bacffbf598cd87418c8c9f00d8ae6b39b226f04782ae46c5a06dabcc7941f67b6dcba302247de9e59e52370df95f3edb3a0a938
+  metadata.gz: dad9fdb36c1eb15daf45f6a972c005a918f90e146c9349c191051ed83a469b7b92cf8e93b7418e93b4ed74aa19f6a2844bbdbc99cdd8f28bdc406902e3fb1ffc
+  data.tar.gz: 19601275314f1221d25009a6b732ec3a1b61f24c24579d1ad95fc5d83a5e8f2a3b54d6990c7b310e439364a9a68a45a3503329e9217eb5b0fa732d73c36dac1e

data/lib/dependabot/terraform/file_parser.rb

@@ -20,6 +20,10 @@ module Dependabot
       include FileSelector
 
       ARCHIVE_EXTENSIONS = %w(.zip .tbz2 .tgz .txz).freeze
+      DEFAULT_REGISTRY = "registry.terraform.io"
+      DEFAULT_NAMESPACE = "hashicorp"
+      # https://www.terraform.io/docs/language/providers/requirements.html#source-addresses
+      PROVIDER_SOURCE_ADDRESS = %r{\A((?<hostname>.+)/)?(?<namespace>.+)/(?<name>.+)\z}.freeze
 
       def parse
         dependency_set = DependencySet.new
@@ -27,14 +31,14 @@ module Dependabot
         terraform_files.each do |file|
           modules = parsed_file(file).fetch("module", {})
           modules.each do |name, details|
-            dependency_set << build_terraform_dependency(file, name, details, false)
+            dependency_set << build_terraform_dependency(file, name, details)
           end
 
           parsed_file(file).fetch("terraform", []).each do |terraform|
             required_providers = terraform.fetch("required_providers", {})
             required_providers.each do |provider|
               provider.each do |name, details|
-                dependency_set << build_terraform_dependency(file, name, details, true)
+                dependency_set << build_provider_dependency(file, name, details)
               end
             end
           end
@@ -54,10 +58,10 @@ module Dependabot
 
       private
 
-      def build_terraform_dependency(file, name, details, provider)
-        details = details.is_a?(Array) ? details.first : details
+      def build_terraform_dependency(file, name, details)
+        details = details.first
 
-        source = source_from(details, provider)
+        source = source_from(details)
         dep_name = case source[:type]
                    when "registry" then source[:module_identifier]
                    when "provider" then details["source"]
@@ -82,8 +86,31 @@ module Dependabot
         )
       end
 
+      def build_provider_dependency(file, name, details = {})
+        source_address = details.fetch("source", nil)
+        version_req = details["version"]&.strip
+        hostname, namespace, name = provider_source_from(source_address, name)
+        dependency_name = source_address ? "#{namespace}/#{name}" : name
+
+        Dependency.new(
+          name: dependency_name,
+          version: determine_version_for(hostname, namespace, name, version_req),
+          package_manager: "terraform",
+          requirements: [
+            requirement: version_req,
+            groups: [],
+            file: file.name,
+            source: {
+              type: "provider",
+              registry_hostname: hostname,
+              module_identifier: "#{namespace}/#{name}"
+            }
+          ]
+        )
+      end
+
       def build_terragrunt_dependency(file, details)
-        source = source_from(details, false)
+        source = source_from(details)
         dep_name =
           if Source.from_url(source[:url])
             Source.from_url(source[:url]).repo
@@ -107,7 +134,7 @@ module Dependabot
       end
 
       # Full docs at https://www.terraform.io/docs/modules/sources.html
-      def source_from(details_hash, provider)
+      def source_from(details_hash)
         raw_source = details_hash.fetch("source")
         bare_source = get_proxied_source(raw_source)
 
@@ -118,23 +145,28 @@ module Dependabot
           when :github, :bitbucket, :git
             git_source_details_from(bare_source)
           when :registry
-            registry_source_details_from(bare_source, provider)
+            registry_source_details_from(bare_source)
           end
 
         source_details[:proxy_url] = raw_source if raw_source != bare_source
         source_details
       end
 
-      def registry_source_details_from(source_string, provider)
+      def provider_source_from(source_address, name)
+        return [DEFAULT_REGISTRY, DEFAULT_NAMESPACE, name] unless source_address
+
+        matches = source_address.match(PROVIDER_SOURCE_ADDRESS)
+        [
+          matches[:hostname] || DEFAULT_REGISTRY,
+          matches[:namespace],
+          matches[:name] || name
+        ]
+      end
+
+      def registry_source_details_from(source_string)
         parts = source_string.split("//").first.split("/")
 
-        if provider && parts.count == 2
-          {
-            "type": "provider",
-            "registry_hostname": "registry.terraform.io",
-            "module_identifier": source_string
-          }
-        elsif parts.count == 3
+        if parts.count == 3
           {
             type: "registry",
             registry_hostname: "registry.terraform.io",
@@ -300,6 +332,23 @@ module Dependabot
 
         raise "No Terraform configuration file!"
       end
+
+      def determine_version_for(hostname, namespace, name, constraint)
+        return constraint if constraint&.match?(/\A\d/)
+
+        lock_file_content.
+          dig("provider", "#{hostname}/#{namespace}/#{name}", 0, "version")
+      end
+
+      def lock_file_content
+        @lock_file_content ||=
+          begin
+            lock_file = dependency_files.find do |file|
+              file.name == ".terraform.lock.hcl"
+            end
+            lock_file ? parsed_file(lock_file) : {}
+          end
+      end
     end
   end
 end

data/lib/dependabot/terraform/file_updater.rb

@@ -98,9 +98,9 @@ module Dependabot
       end
 
       def provider_declaration_regex
+        name = Regexp.escape(dependency.name)
         /
-          (?:required_providers\s\{)*
-          (source\s*=\s*["']#{Regexp.escape(dependency.name)}["']
+          ((source\s*=\s*["']#{name}["']|\s*#{name}\s*=\s*\{.*)
           (?:(?!^\}).)+)
         /mx
       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

@@ -11,8 +11,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
@@ -23,9 +26,6 @@ module Dependabot
       # @return [Array<Dependabot::Terraform::Version>]
       # @raise [RuntimeError] when the versions cannot be retrieved
       def all_provider_versions(identifier:)
-        # TODO: Implement service discovery for custom registries
-        return [] unless hostname == PUBLIC_HOSTNAME
-
         response = get(endpoint: "providers/#{identifier}/versions")
 
         JSON.parse(response).
@@ -41,9 +41,6 @@ module Dependabot
       # @return [Array<Dependabot::Terraform::Version>]
       # @raise [RuntimeError] 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")
 
         JSON.parse(response).
@@ -61,9 +58,6 @@ module Dependabot
       # @return Dependabot::Source
       # @raise [RuntimeError] 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}"
@@ -80,7 +74,7 @@ module Dependabot
 
       private
 
-      attr_reader :hostname
+      attr_reader :hostname, :tokens
 
       def get(endpoint:)
         url = "https://#{hostname}/v1/#{endpoint}"
@@ -88,7 +82,7 @@ module Dependabot
         response = Excon.get(
           url,
           idempotent: true,
-          **SharedHelpers.excon_defaults
+          **SharedHelpers.excon_defaults(headers: headers_for(hostname))
         )
 
         raise "Response from registry was #{response.status}" unless response.status == 200
@@ -99,6 +93,11 @@ module Dependabot
       def version_class
         Version
       end
+
+      def headers_for(hostname)
+        token = tokens[hostname]
+        token ? { "Authorization" => "Bearer #{token}" } : {}
+      end
     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.6
+  version: 0.149.0
 platform: ruby
 authors:
 - Dependabot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2021-05-26 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.6
+        version: 0.149.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.148.6
+        version: 0.149.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement