dependabot-docker 0.373.0 → 0.375.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54f144f7445cf79bb3f1804bbe9cd1f008593c681ef1f139ff1798fd58b46ad5
-  data.tar.gz: 63b1fcfbe7c53feb41add6476b7cd4976207a9f3d340e81d2eeaf92f66b16afe
+  metadata.gz: c96d22e472c0f652a516da01e24d096a53d1d3c14b52d8b47469a7ec1a3510d8
+  data.tar.gz: '092e3dc1b669bd7a17eb6573392c85fb185a39d3ba72dbfd5cfe2a46e8e6bcb9'
 SHA512:
-  metadata.gz: 01df280f592623677d7a3994e219f946329b1a4936ef8ee1e053247518dc3ed364e08729a2390c6eaa91fa9e073fce67340a518b3b42164c05ea721d7f5c94e3
-  data.tar.gz: '079e53c368372617361184e05c525320a7d6cbbb9455d4e2db951544c78f2684344f9ee2b24156db578f51f2728f8e83a86761eb01d927e8f060acaccbda9dde'
+  metadata.gz: d7cbdbf09e1008b3c4e702fe656c4f62bb777aebd8f189fa174988c4e013e263f535baa63f4f424d5c43fea1ad64306e588a09cdeb741acc45af20150598fb62
+  data.tar.gz: c869c073d99e811cf82d55f30d51d194928c76071ae3b39b9a00079ea7e87e560fa135da10c3ead2618d722afc01b796c3dcab683705f14445d378a9276ee88b

data/lib/dependabot/docker_compose/file_fetcher.rb

@@ -0,0 +1,70 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "dependabot/shared/shared_file_fetcher"
+
+module Dependabot
+  module DockerCompose
+    class FileFetcher < Dependabot::Shared::SharedFileFetcher
+      FILENAME_REGEX = /(docker-)?compose(-[\w]+)?(?>\.[\w-]+)?\.ya?ml/i
+
+      sig { override.returns(T::Array[DependencyFile]) }
+      def fetch_files
+        fetched_files = []
+        fetched_files += correctly_encoded_docker_compose_files
+
+        return fetched_files if fetched_files.any?
+
+        raise_appropriate_error
+      end
+
+      sig { override.returns(Regexp) }
+      def self.filename_regex
+        FILENAME_REGEX
+      end
+
+      sig { returns(T::Array[Dependabot::DependencyFile]) }
+      def docker_compose_files
+        @docker_compose_files ||=
+          T.let(
+            repo_contents(raise_errors: false)
+                      .select { |f| f.type == "file" && f.name.match?(FILENAME_REGEX) }
+                      .map { |f| fetch_file_from_host(f.name) },
+            T.nilable(T::Array[DependencyFile])
+          )
+      end
+
+      sig { returns(T::Array[Dependabot::DependencyFile]) }
+      def correctly_encoded_docker_compose_files
+        docker_compose_files.select { |f| T.must(f.content).valid_encoding? }
+      end
+
+      sig { returns(T::Array[Dependabot::DependencyFile]) }
+      def incorrectly_encoded_docker_compose_files
+        docker_compose_files.reject { |f| T.must(f.content).valid_encoding? }
+      end
+
+      sig { override.returns(String) }
+      def self.required_files_message
+        "Repo must contain a docker-compose.yaml file."
+      end
+
+      private
+
+      sig { override.returns(String) }
+      def default_file_name
+        "docker-compose.yml"
+      end
+
+      sig { override.returns(String) }
+      def file_type
+        "Docker Compose"
+      end
+    end
+  end
+end
+
+Dependabot::FileFetchers.register(
+  "docker_compose",
+  Dependabot::DockerCompose::FileFetcher
+)

data/lib/dependabot/docker_compose/file_parser.rb

@@ -0,0 +1,128 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "yaml"
+require "dependabot/shared/shared_file_parser"
+require "dependabot/docker_compose/package_manager"
+
+module Dependabot
+  module DockerCompose
+    class FileParser < Dependabot::Shared::SharedFileParser
+      extend T::Sig
+
+      ENV_VAR = /\${(?<variable_name>[^}:]+)(?:\:-(?<default_value>[^}]+))?}/
+      DIGEST = /(?<digest>[0-9a-f]{64})/
+      IMAGE_REGEX = %r{^(#{REGISTRY}/)?#{IMAGE}#{TAG}?(?:@sha256:#{DIGEST})?#{NAME}?}x
+
+      FROM = /FROM/i
+      PLATFORM = /--platform\=(?<platform>\S+)/
+
+      FROM_LINE =
+        %r{^#{FROM}\s+(#{PLATFORM}\s+)?(#{REGISTRY}/)?
+          #{IMAGE}#{TAG}?(?:@sha256:#{DIGEST})?#{NAME}?}x
+
+      sig { returns(Ecosystem) }
+      def ecosystem
+        @ecosystem ||= T.let(
+          Ecosystem.new(
+            name: ECOSYSTEM,
+            package_manager: DockerPackageManager.new
+          ),
+          T.nilable(Ecosystem)
+        )
+      end
+
+      sig { override.returns(T::Array[Dependabot::Dependency]) }
+      def parse
+        dependency_set = DependencySet.new
+
+        composefiles.each do |composefile|
+          yaml = YAML.safe_load(T.must(composefile.content), aliases: true)
+          next unless yaml["services"].is_a?(Hash)
+
+          yaml["services"].each do |_, service|
+            next unless service.is_a?(Hash)
+
+            parsed_from_image = parse_image_spec(service)
+            next unless parsed_from_image
+
+            parsed_from_image["registry"] = nil if parsed_from_image["registry"] == "docker.io"
+
+            version = version_from(parsed_from_image)
+            next unless version
+
+            dependency_set << build_dependency(composefile, parsed_from_image, version)
+          end
+        end
+
+        dependency_set.dependencies
+      end
+
+      private
+
+      sig { params(service: T.untyped).returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+      def parse_image_spec(service)
+        return nil unless service
+
+        if service["image"]
+          return service_image(service["image"])
+        elsif service["build"].is_a?(Hash) && service["build"]["dockerfile_inline"]
+          return nil if service["build"]["dockerfile_inline"].match?(/^FROM\s+\${[^}]+}$/)
+
+          match = FROM_LINE.match(service["build"]["dockerfile_inline"])
+          return match&.named_captures
+        end
+
+        nil
+      end
+
+      sig { params(image: String).returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+      def service_image(image)
+        docker_image = image
+
+        if image.match?(/^#{ENV_VAR}/o)
+          default_value = ENV_VAR.match(image)&.named_captures&.fetch("default_value")
+          return unless default_value
+
+          docker_image = default_value
+        end
+
+        IMAGE_REGEX.match(docker_image)&.named_captures
+      end
+
+      sig { params(parsed_image: T::Hash[String, T.nilable(String)]).returns(T.nilable(String)) }
+      def version_from(parsed_image)
+        return nil if parsed_image["tag"]&.match?(ENV_VAR)
+
+        super
+      end
+
+      sig { override.returns(String) }
+      def package_manager
+        "docker_compose"
+      end
+
+      sig { override.returns(String) }
+      def file_type
+        "docker-compose.yml"
+      end
+
+      sig { returns(T::Array[Dependabot::DependencyFile]) }
+      def composefiles
+        dependency_files
+      end
+
+      sig { override.void }
+      def check_required_files
+        return if dependency_files.any?
+
+        raise "No #{file_type}!"
+      end
+    end
+  end
+end
+
+Dependabot::FileParsers.register(
+  "docker_compose",
+  Dependabot::DockerCompose::FileParser
+)

data/lib/dependabot/docker_compose/file_updater.rb

@@ -0,0 +1,59 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "dependabot/shared/shared_file_updater"
+
+module Dependabot
+  module DockerCompose
+    class FileUpdater < Dependabot::Shared::SharedFileUpdater
+      extend T::Sig
+      extend T::Helpers
+
+      YAML_REGEXP = /(docker-)?compose(?>\.[\w-]+)?\.ya?ml/i
+      IMAGE_REGEX = /(?:from|image:\s*)/i
+
+      sig { override.returns(String) }
+      def file_type
+        "Docker compose"
+      end
+
+      sig { override.returns(Regexp) }
+      def yaml_file_pattern
+        YAML_REGEXP
+      end
+
+      sig { override.returns(Regexp) }
+      def container_image_regex
+        IMAGE_REGEX
+      end
+
+      sig { override.params(escaped_declaration: String).returns(Regexp) }
+      def build_old_declaration_regex(escaped_declaration)
+        %r{#{IMAGE_REGEX}\s+["']?(?:\$\{[^\}:]+:-)?(docker\.io/)?#{escaped_declaration}(?:\})?["']?(?=\s|$)}
+      end
+
+      sig { override.returns(T::Array[Dependabot::DependencyFile]) }
+      def updated_dependency_files
+        updated_files = []
+        dependency_files.each do |file|
+          next unless requirement_changed?(file, T.must(dependency))
+
+          updated_files << updated_file(
+            file: file,
+            content: T.must(updated_dockerfile_content(file))
+          )
+        end
+
+        updated_files.reject! { |f| dependency_files.include?(f) }
+        raise "No files changed!" if updated_files.none?
+
+        updated_files
+      end
+    end
+  end
+end
+
+Dependabot::FileUpdaters.register(
+  "docker_compose",
+  Dependabot::DockerCompose::FileUpdater
+)

data/lib/dependabot/docker_compose/package_manager.rb

@@ -0,0 +1,51 @@
+# typed: strong
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+require "dependabot/ecosystem"
+
+module Dependabot
+  module DockerCompose
+    ECOSYSTEM = "docker_compose"
+
+    SUPPORTED_VERSIONS = T.let([].freeze, T::Array[Dependabot::Version])
+
+    DEPRECATED_VERSIONS = T.let([].freeze, T::Array[Dependabot::Version])
+
+    class DockerPackageManager < Dependabot::Ecosystem::VersionManager
+      extend T::Sig
+
+      NAME = "docker_compose"
+
+      # As docker_compose updater is an in house custom utility, We use a placeholder
+      # version number for docker_compose updater
+      VERSION = "1.0.0"
+
+      SUPPORTED_VERSIONS = T.let([].freeze, T::Array[Dependabot::Version])
+
+      DEPRECATED_VERSIONS = T.let([].freeze, T::Array[Dependabot::Version])
+
+      sig do
+        void
+      end
+      def initialize
+        super(
+          name: NAME,
+          version: Version.new(VERSION),
+          deprecated_versions: DEPRECATED_VERSIONS,
+          supported_versions: SUPPORTED_VERSIONS
+       )
+      end
+
+      sig { override.returns(T::Boolean) }
+      def deprecated?
+        false
+      end
+
+      sig { override.returns(T::Boolean) }
+      def unsupported?
+        false
+      end
+    end
+  end
+end

data/lib/dependabot/docker_compose.rb

@@ -0,0 +1,23 @@
+# typed: strong
+# frozen_string_literal: true
+
+# These all need to be required so the various classes can be registered in a
+# lookup table of package manager names to concrete classes.
+
+require "dependabot/docker"
+
+require "dependabot/docker_compose/file_fetcher"
+require "dependabot/docker_compose/file_parser"
+require "dependabot/docker_compose/file_updater"
+
+Dependabot::Utils.register_version_class("docker_compose", Dependabot::Docker::Version)
+Dependabot::UpdateCheckers.register("docker_compose", Dependabot::Docker::UpdateChecker)
+Dependabot::Utils.register_requirement_class("docker_compose", Dependabot::Docker::Requirement)
+Dependabot::MetadataFinders.register("docker_compose", Dependabot::Docker::MetadataFinder)
+
+require "dependabot/pull_request_creator/labeler"
+Dependabot::PullRequestCreator::Labeler
+  .register_label_details("docker_compose", name: "docker_compose", colour: "E5F2FC")
+
+require "dependabot/dependency"
+Dependabot::Dependency.register_production_check("docker_compose", ->(_) { true })

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dependabot-docker
 version: !ruby/object:Gem::Version
-  version: 0.373.0
+  version: 0.375.0
 platform: ruby
 authors:
 - Dependabot
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.373.0
+        version: 0.375.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.373.0
+        version: 0.375.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -251,6 +251,11 @@ files:
 - lib/dependabot/docker/tag.rb
 - lib/dependabot/docker/update_checker.rb
 - lib/dependabot/docker/version.rb
+- lib/dependabot/docker_compose.rb
+- lib/dependabot/docker_compose/file_fetcher.rb
+- lib/dependabot/docker_compose/file_parser.rb
+- lib/dependabot/docker_compose/file_updater.rb
+- lib/dependabot/docker_compose/package_manager.rb
 - lib/dependabot/shared/shared_file_fetcher.rb
 - lib/dependabot/shared/shared_file_parser.rb
 - lib/dependabot/shared/shared_file_updater.rb
@@ -261,7 +266,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/dependabot/dependabot-core/issues
-  changelog_uri: https://github.com/dependabot/dependabot-core/releases/tag/v0.373.0
+  changelog_uri: https://github.com/dependabot/dependabot-core/releases/tag/v0.375.0
 rdoc_options: []
 require_paths:
 - lib