dependabot-github_actions 0.212.0 → 0.214.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b99470ea707631aca82d807b49067151dfcae50d66c60edc46d745c9616a0d74
-  data.tar.gz: 199d27e6b67a81fe6f6728ab6a88800851788388b419b0b2df1ca6568c38b71b
+  metadata.gz: b3804334c168c6ac968941c3fd695443875744a48e66825e0247a10089003b77
+  data.tar.gz: 92571e11e014c22477a152c8035d77022df7faad94b303677788e937d31d6231
 SHA512:
-  metadata.gz: 3a39a5301c8164912dca155d1f76237ee7023c332dd39d1aee61f9d57bfb222e8b67f41604a25806f9aca6bd8862bcbeff21243e54a3afac416e9027afd42ae1
-  data.tar.gz: 9ea44575276134e6b20f23ac77db0d91b6e2b7d5bba7f52006ed7715cd6864825e53933ae9559bfeb3d2e317c2e8b652d3709247ea203f14e635fc047fdb939f
+  metadata.gz: 6397641d12b9fb86fbc34fec837b05c3669f9ebb3a96dd27fa2912098ac1f158dcf6f39995065a417013ba22e169931a4886c2e15109bcf446a4f83191ec03a4
+  data.tar.gz: d706bb33be9d40cd470c6977a6268887fddacbf799ea30b604a5569ac50347589b8acf25ad6f9d924ccd78c9ce31b515fe8564118dc1705825e6c73055265e6d

data/lib/dependabot/github_actions/file_fetcher.rb

@@ -6,7 +6,7 @@ require "dependabot/file_fetchers/base"
 module Dependabot
   module GithubActions
     class FileFetcher < Dependabot::FileFetchers::Base
-      FILENAME_PATTERN = /^(\.github|action.ya?ml)$/.freeze
+      FILENAME_PATTERN = /^(\.github|action.ya?ml)$/
 
       def self.required_files_in?(filenames)
         filenames.any? { |f| f.match?(FILENAME_PATTERN) }
@@ -26,9 +26,16 @@ module Dependabot
         return fetched_files if fetched_files.any?
 
         if incorrectly_encoded_workflow_files.none?
+          expected_paths =
+            if directory == "/"
+              File.join(directory, "action.yml") + " or /.github/workflows/<anything>.yml"
+            else
+              File.join(directory, "<anything>.yml")
+            end
+
           raise(
             Dependabot::DependencyFileNotFound,
-            File.join(directory, "action.yml") + " or /.github/workflows/<anything>.yml"
+            expected_paths
           )
         else
           raise(
@@ -41,16 +48,22 @@ module Dependabot
       def workflow_files
         return @workflow_files if defined? @workflow_files
 
-        @workflow_files = [fetch_file_if_present("action.yml"), fetch_file_if_present("action.yaml")].compact
+        @workflow_files = []
 
         # In the special case where the root directory is defined we also scan
         # the .github/workflows/ folder.
-        return @workflow_files unless directory == "/"
+        if directory == "/"
+          @workflow_files += [fetch_file_if_present("action.yml"), fetch_file_if_present("action.yaml")].compact
+
+          workflows_dir = ".github/workflows"
+        else
+          workflows_dir = "."
+        end
 
         @workflow_files +=
-          repo_contents(dir: ".github/workflows", raise_errors: false).
+          repo_contents(dir: workflows_dir, raise_errors: false).
           select { |f| f.type == "file" && f.name.match?(/\.ya?ml$/) }.
-          map { |f| fetch_file_from_host(".github/workflows/#{f.name}") }
+          map { |f| fetch_file_from_host("#{workflows_dir}/#{f.name}") }
       end
 
       def referenced_local_workflow_files

data/lib/dependabot/github_actions/file_parser.rb

@@ -21,7 +21,7 @@ module Dependabot
         (?<repo>[\w.-]+)
         (?<path>/[^\@]+)?
         @(?<ref>.+)
-      }x.freeze
+      }x
 
       def parse
         dependency_set = DependencySet.new
@@ -94,7 +94,7 @@ module Dependabot
           git_checker = Dependabot::GitCommitChecker.new(dependency: dep, credentials: credentials)
           next unless git_checker.pinned_ref_looks_like_commit_sha?
 
-          resolved = git_checker.local_tag_for_pinned_version
+          resolved = git_checker.local_tag_for_pinned_sha
           next if resolved.nil? || !version_class.correct?(resolved)
 
           # Build a Dependency with the resolved version, and rely on DependencySet's merge

data/lib/dependabot/github_actions/file_updater.rb

@@ -65,17 +65,41 @@ module Dependabot
             gsub(/@.*+/, "@#{new_req.fetch(:source).fetch(:ref)}")
 
           # Replace the old declaration that's preceded by a non-word character
-          # and followed by a whitespace character (comments) or EOL
+          # and followed by a whitespace character (comments) or EOL.
+          # If the declaration is followed by a comment that lists the version associated
+          # with the SHA source ref, then update the comment to the human-readable new version.
+          # However, if the comment includes additional text beyond the version, for safety
+          # we skip updating the comment in case it's a custom note, todo, warning etc of some kind.
+          # See the related unit tests for examples.
           updated_content =
             updated_content.
             gsub(
-              /(?<=\W|"|')#{Regexp.escape(old_declaration)}(?=\s|"|'|$)/,
-              new_declaration
-            )
+              /(?<=\W|"|')#{Regexp.escape(old_declaration)}(?<comment>\s+#.*)?(?=\s|"|'|$)/
+            ) do |match|
+              comment = Regexp.last_match(:comment)
+              match.gsub!(old_declaration, new_declaration)
+              if comment && (updated_comment = updated_version_comment(comment, new_req))
+                match.gsub!(comment, updated_comment)
+              end
+              match
+            end
         end
 
         updated_content
       end
+
+      def updated_version_comment(comment, new_req)
+        raise "No comment!" unless comment
+
+        comment = comment.rstrip
+        return unless dependency.previous_version && dependency.version
+        return unless comment.end_with? dependency.previous_version
+
+        git_checker = Dependabot::GitCommitChecker.new(dependency: dependency, credentials: credentials)
+        return unless git_checker.ref_looks_like_commit_sha?(new_req.fetch(:source).fetch(:ref))
+
+        comment.gsub(dependency.previous_version, dependency.version)
+      end
     end
   end
 end

data/lib/dependabot/github_actions/requirement.rb

@@ -7,7 +7,7 @@ module Dependabot
   module GithubActions
     # Lifted from the bundler package manager
     class Requirement < Gem::Requirement
-      # For consistency with other langauges, we define a requirements array.
+      # For consistency with other languages, we define a requirements array.
       # Ruby doesn't have an `OR` separator for requirements, so it always
       # contains a single element.
       def self.requirements_array(requirement_string)

data/lib/dependabot/github_actions/update_checker.rb

@@ -2,6 +2,7 @@
 
 require "dependabot/update_checkers"
 require "dependabot/update_checkers/base"
+require "dependabot/update_checkers/version_filters"
 require "dependabot/errors"
 require "dependabot/github_actions/version"
 require "dependabot/github_actions/requirement"
@@ -23,6 +24,15 @@ module Dependabot
         dependency.version
       end
 
+      def lowest_security_fix_version
+        @lowest_security_fix_version ||= fetch_lowest_security_fix_version
+      end
+
+      def lowest_resolvable_security_fix_version
+        # Resolvability isn't an issue for GitHub Actions.
+        lowest_security_fix_version
+      end
+
       def updated_requirements # rubocop:disable Metrics/PerceivedComplexity
         previous = dependency_source_details
         updated = updated_source
@@ -42,6 +52,12 @@ module Dependabot
 
       private
 
+      def active_advisories
+        security_advisories.select do |advisory|
+          advisory.vulnerable?(version_class.new(git_commit_checker.most_specific_tag_equivalent_to_pinned_ref))
+        end
+      end
+
       def latest_version_resolvable_with_full_unlock?
         # Full unlock checks aren't relevant for GitHub Actions
         false
@@ -65,7 +81,7 @@ module Dependabot
         # we want to update that tag.
         if git_commit_checker.pinned_ref_looks_like_version? && latest_version_tag
           latest_version = latest_version_tag.fetch(:version)
-          return version_class.new(dependency.version) if shortened_semver_eq?(dependency.version, latest_version.to_s)
+          return current_version if shortened_semver_eq?(dependency.version, latest_version.to_s)
 
           return latest_version
         end
@@ -82,45 +98,85 @@ module Dependabot
         nil
       end
 
-      def latest_commit_for_pinned_ref
-        @latest_commit_for_pinned_ref ||=
-          SharedHelpers.in_a_temporary_repo_directory("/", repo_contents_path) do
-            ref_branch = find_container_branch(current_commit)
+      def fetch_lowest_security_fix_version
+        # TODO: Support Docker sources
+        return unless git_dependency?
+
+        fetch_lowest_security_fix_version_for_git_dependency
+      end
+
+      def fetch_lowest_security_fix_version_for_git_dependency
+        lowest_security_fix_version_tag.fetch(:version)
+      end
 
-            git_commit_checker.head_commit_for_local_branch(ref_branch)
+      def lowest_security_fix_version_tag
+        @lowest_security_fix_version_tag ||= begin
+          tags_matching_precision = git_commit_checker.local_tags_for_allowed_versions_matching_existing_precision
+          lowest_fixed_version = find_lowest_secure_version(tags_matching_precision)
+          if lowest_fixed_version
+            lowest_fixed_version
+          else
+            tags = git_commit_checker.local_tags_for_allowed_versions
+            find_lowest_secure_version(tags)
           end
+        end
       end
 
-      def latest_version_tag
-        @latest_version_tag ||= begin
-          return git_commit_checker.local_tag_for_latest_version if dependency.version.nil?
+      def find_lowest_secure_version(tags)
+        relevant_tags = Dependabot::UpdateCheckers::VersionFilters.filter_vulnerable_versions(tags, security_advisories)
+        relevant_tags = filter_lower_tags(relevant_tags)
 
-          latest_tags = git_commit_checker.local_tags_for_latest_version_commit_sha
+        relevant_tags.min_by { |tag| tag.fetch(:version) }
+      end
 
-          # Find the latest version with the same precision as the pinned version.
-          # Falls back to a version with the closest precision if no exact match.
-          current_dots = dependency.version.split(".").length
-          latest_tags.max do |a, b|
-            next a[:version] <=> b[:version] unless shortened_semver_version_eq?(a[:version], b[:version])
+      def latest_commit_for_pinned_ref
+        @latest_commit_for_pinned_ref ||= begin
+          head_commit_for_ref_sha = git_commit_checker.head_commit_for_pinned_ref
+          if head_commit_for_ref_sha
+            head_commit_for_ref_sha
+          else
+            url = dependency_source_details[:url]
+            source = Source.from_url(url)
+
+            SharedHelpers.in_a_temporary_directory(File.dirname(source.repo)) do |temp_dir|
+              repo_contents_path = File.join(temp_dir, File.basename(source.repo))
 
-            a_dots = a[:version].to_s.split(".").length
-            b_dots = b[:version].to_s.split(".").length
-            a_diff = (a_dots - current_dots).abs
-            b_diff = (b_dots - current_dots).abs
-            next -(a_diff <=> b_diff) unless a_diff == b_diff
+              SharedHelpers.run_shell_command("git clone --no-recurse-submodules #{url} #{repo_contents_path}")
 
-            # preference to a less specific version if we have a tie
-            next 1 if a_dots < current_dots
+              Dir.chdir(repo_contents_path) do
+                ref_branch = find_container_branch(dependency_source_details[:ref])
 
-            -1
+                git_commit_checker.head_commit_for_local_branch(ref_branch)
+              end
+            end
           end
         end
       end
 
+      def latest_version_tag
+        @latest_version_tag ||= begin
+          return git_commit_checker.local_tag_for_latest_version if dependency.version.nil?
+
+          git_commit_checker.local_ref_for_latest_version_matching_existing_precision
+        end
+      end
+
+      def filter_lower_tags(tags_array)
+        return tags_array unless current_version
+
+        tags_array.
+          select { |tag| tag.fetch(:version) > current_version }
+      end
+
       def updated_source
         # TODO: Support Docker sources
         return dependency_source_details unless git_dependency?
 
+        if vulnerable? &&
+           (new_tag = lowest_security_fix_version_tag)
+          return dependency_source_details.merge(ref: new_tag.fetch(:tag))
+        end
+
         # Update the git tag if updating a pinned version
         if git_commit_checker.pinned_ref_looks_like_version? &&
            (new_tag = latest_version_tag) &&
@@ -179,7 +235,8 @@ module Dependabot
           dependency: dependency,
           credentials: credentials,
           ignored_versions: ignored_versions,
-          raise_on_ignored: raise_on_ignored
+          raise_on_ignored: raise_on_ignored,
+          consider_version_branches_pinned: true
         )
       end
 
@@ -193,25 +250,18 @@ module Dependabot
         other_split[0..base_split.length - 1] == base_split
       end
 
-      def shortened_semver_version_eq?(base_version, other_version)
-        base = base_version.to_s
-        other = other_version.to_s
-
-        shortened_semver_eq?(base, other) || shortened_semver_eq?(other, base)
-      end
-
       def find_container_branch(sha)
-        SharedHelpers.run_shell_command("git fetch #{current_commit}")
-
-        branches_including_ref = SharedHelpers.run_shell_command("git branch --contains #{sha}").split("\n")
+        branches_including_ref = SharedHelpers.run_shell_command(
+          "git branch --remotes --contains #{sha}"
+        ).split("\n").map { |branch| branch.strip.gsub("origin/", "") }
 
-        current_branch = branches_including_ref.find { |line| line.start_with?("* ") }
+        current_branch = branches_including_ref.find { |branch| branch.start_with?("HEAD -> ") }
 
         if current_branch
-          current_branch.delete_prefix("* ")
+          current_branch.delete_prefix("HEAD -> ")
         elsif branches_including_ref.size > 1
           # If there are multiple non default branches including the pinned SHA, then it's unclear how we should proceed
-          raise "Multiple ambiguous branches (#{branches_including_ref.join(', ')}) include #{current_commit}!"
+          raise "Multiple ambiguous branches (#{branches_including_ref.join(', ')}) include #{sha}!"
         else
           branches_including_ref.first
         end

data/lib/dependabot/github_actions.rb

@@ -22,6 +22,3 @@ Dependabot::PullRequestCreator::Labeler.
 require "dependabot/dependency"
 Dependabot::Dependency.
   register_production_check("github_actions", ->(_) { true })
-
-require "dependabot/utils"
-Dependabot::Utils.register_always_clone("github_actions")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dependabot-github_actions
 version: !ruby/object:Gem::Version
-  version: 0.212.0
+  version: 0.214.0
 platform: ruby
 authors:
 - Dependabot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dependabot-common
@@ -16,42 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.212.0
+        version: 0.214.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.212.0
-- !ruby/object:Gem::Dependency
-  name: debase
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.2.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.2.3
-- !ruby/object:Gem::Dependency
-  name: debase-ruby_core_source
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.10.16
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.10.16
+        version: 0.214.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.12.0
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.12.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -142,42 +114,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.39.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.39.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.14.2
-- !ruby/object:Gem::Dependency
-  name: ruby-debug-ide
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 1.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -275,14 +233,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: GitHub Actions support for dependabot-common