dependabot-common 0.244.0 → 0.246.0

data/lib/dependabot/pull_request_creator/bitbucket.rb

@@ -1,19 +1,70 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
+require "sorbet-runtime"
+
 require "dependabot/clients/bitbucket"
+require "dependabot/credential"
+require "dependabot/dependency_file"
 require "dependabot/pull_request_creator"
 
 module Dependabot
   class PullRequestCreator
     class Bitbucket
-      attr_reader :source, :branch_name, :base_commit, :credentials,
-                  :files, :commit_message, :pr_description, :pr_name,
-                  :author_details, :labeler, :work_item
+      extend T::Sig
+
+      sig { returns(Dependabot::Source) }
+      attr_reader :source
+
+      sig { returns(String) }
+      attr_reader :branch_name
+
+      sig { returns(String) }
+      attr_reader :base_commit
+
+      sig { returns(T::Array[Dependabot::Credential]) }
+      attr_reader :credentials
+
+      sig { returns(T::Array[Dependabot::DependencyFile]) }
+      attr_reader :files
+
+      sig { returns(String) }
+      attr_reader :commit_message
+
+      sig { returns(String) }
+      attr_reader :pr_description
+
+      sig { returns(String) }
+      attr_reader :pr_name
+
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :author_details
+
+      sig { returns(T.nilable(Dependabot::PullRequestCreator::Labeler)) }
+      attr_reader :labeler
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :work_item
 
       # BitBucket Cloud accepts > 1MB characters, but they display poorly in the UI, so limiting to 4x 65,536
       PR_DESCRIPTION_MAX_LENGTH = 262_143 # 0 based count
 
+      sig do
+        params(
+          source: Dependabot::Source,
+          branch_name: String,
+          base_commit: String,
+          credentials: T::Array[Dependabot::Credential],
+          files: T::Array[Dependabot::DependencyFile],
+          commit_message: String,
+          pr_description: String,
+          pr_name: String,
+          author_details: T.nilable(T::Hash[Symbol, String]),
+          labeler: T.nilable(Dependabot::PullRequestCreator::Labeler),
+          work_item: T.nilable(Integer)
+        )
+          .void
+      end
       def initialize(source:, branch_name:, base_commit:, credentials:,
                      files:, commit_message:, pr_description:, pr_name:,
                      author_details:, labeler: nil, work_item: nil)
@@ -30,6 +81,7 @@ module Dependabot
         @work_item      = work_item
       end
 
+      sig { void }
       def create
         return if branch_exists? && pull_request_exists?
 
@@ -43,20 +95,26 @@ module Dependabot
 
       private
 
+      sig { returns(Dependabot::Clients::Bitbucket) }
       def bitbucket_client_for_source
         @bitbucket_client_for_source ||=
-          Dependabot::Clients::Bitbucket.for_source(
-            source: source,
-            credentials: credentials
+          T.let(
+            Dependabot::Clients::Bitbucket.for_source(
+              source: source,
+              credentials: credentials
+            ),
+            T.nilable(Dependabot::Clients::Bitbucket)
           )
       end
 
+      sig { returns(T::Boolean) }
       def branch_exists?
-        bitbucket_client_for_source.branch(source.repo, branch_name)
+        !bitbucket_client_for_source.branch(source.repo, branch_name).nil?
       rescue Clients::Bitbucket::NotFound
         false
       end
 
+      sig { returns(T::Boolean) }
       def pull_request_exists?
         bitbucket_client_for_source.pull_requests(
           source.repo,
@@ -65,6 +123,7 @@ module Dependabot
         ).any?
       end
 
+      sig { void }
       def create_commit
         author = author_details&.slice(:name, :email)
         author = nil unless author&.any?
@@ -79,6 +138,7 @@ module Dependabot
         )
       end
 
+      sig { void }
       def create_pull_request
         bitbucket_client_for_source.create_pull_request(
           source.repo,
@@ -91,9 +151,13 @@ module Dependabot
         )
       end
 
+      sig { returns(String) }
       def default_branch
         @default_branch ||=
-          bitbucket_client_for_source.fetch_default_branch(source.repo)
+          T.let(
+            bitbucket_client_for_source.fetch_default_branch(source.repo),
+            T.nilable(String)
+          )
       end
     end
   end

data/lib/dependabot/pull_request_creator/codecommit.rb

@@ -1,20 +1,66 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
+require "sorbet-runtime"
+
 require "dependabot/clients/codecommit"
 require "dependabot/pull_request_creator"
 
 module Dependabot
   class PullRequestCreator
     class Codecommit
-      attr_reader :source, :branch_name, :base_commit, :credentials,
-                  :files, :commit_message, :pr_description, :pr_name,
-                  :author_details, :labeler
+      extend T::Sig
+
+      sig { returns(Dependabot::Source) }
+      attr_reader :source
+
+      sig { returns(String) }
+      attr_reader :branch_name
+
+      sig { returns(String) }
+      attr_reader :base_commit
+
+      sig { returns(T::Array[Dependabot::Credential]) }
+      attr_reader :credentials
+
+      sig { returns(T::Array[Dependabot::DependencyFile]) }
+      attr_reader :files
+
+      sig { returns(String) }
+      attr_reader :commit_message
+
+      sig { returns(String) }
+      attr_reader :pr_description
+
+      sig { returns(String) }
+      attr_reader :pr_name
+
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :author_details
+
+      sig { returns(T.nilable(Dependabot::PullRequestCreator::Labeler)) }
+      attr_reader :labeler
 
       # CodeCommit limits PR descriptions to a max length of 10,240 characters:
       # https://docs.aws.amazon.com/codecommit/latest/APIReference/API_PullRequest.html
       PR_DESCRIPTION_MAX_LENGTH = 10_239 # 0 based count
 
+      sig do
+        params(
+          source: Dependabot::Source,
+          branch_name: String,
+          base_commit: String,
+          credentials: T::Array[Dependabot::Credential],
+          files: T::Array[Dependabot::DependencyFile],
+          commit_message: String,
+          pr_description: String,
+          pr_name: String,
+          author_details: T.nilable(T::Hash[Symbol, String]),
+          labeler: T.nilable(Dependabot::PullRequestCreator::Labeler),
+          require_up_to_date_base: T::Boolean
+        )
+          .void
+      end
       def initialize(source:, branch_name:, base_commit:, credentials:,
                      files:, commit_message:, pr_description:, pr_name:,
                      author_details:, labeler:, require_up_to_date_base:)
@@ -31,6 +77,7 @@ module Dependabot
         @require_up_to_date_base = require_up_to_date_base
       end
 
+      sig { void }
       def create
         return if branch_exists?(branch_name) && unmerged_pull_request_exists?
         return if require_up_to_date_base? && !base_commit_is_up_to_date?
@@ -40,10 +87,12 @@ module Dependabot
 
       private
 
+      sig { returns(T::Boolean) }
       def require_up_to_date_base?
         @require_up_to_date_base
       end
 
+      sig { returns(T::Boolean) }
       def base_commit_is_up_to_date?
         codecommit_client_for_source.fetch_commit(
           source.repo,
@@ -51,6 +100,7 @@ module Dependabot
         ) == base_commit
       end
 
+      sig { returns(T.nilable(Aws::CodeCommit::Types::CreatePullRequestOutput)) }
       def create_pull_request
         branch = create_or_get_branch(base_commit)
         return unless branch
@@ -69,6 +119,7 @@ module Dependabot
         pull_request
       end
 
+      sig { params(commit: String).returns(T.nilable(String)) }
       def create_or_get_branch(commit)
         # returns the branch name
         if branch_exists?(branch_name)
@@ -78,6 +129,7 @@ module Dependabot
         end
       end
 
+      sig { params(commit: String).returns(String) }
       def create_branch(commit)
         # codecommit returns an empty response on create branch success
         codecommit_client_for_source.create_branch(source.repo, branch_name,
@@ -86,49 +138,64 @@ module Dependabot
         branch_name
       end
 
+      sig { returns(Dependabot::Clients::CodeCommit) }
       def codecommit_client_for_source
         @codecommit_client_for_source ||=
-          Dependabot::Clients::CodeCommit.for_source(
-            source: source,
-            credentials: credentials
+          T.let(
+            Dependabot::Clients::CodeCommit.for_source(
+              source: source,
+              credentials: credentials
+            ),
+            T.nilable(Dependabot::Clients::CodeCommit)
           )
       end
 
+      sig { params(branch_name: String).returns(T::Boolean) }
       def branch_exists?(branch_name)
-        @branch_ref ||= codecommit_client_for_source.branch(branch_name)
+        @branch_ref ||= T.let(
+          codecommit_client_for_source.branch(branch_name),
+          T.nilable(String)
+        )
+        !@branch_ref.nil?
         rescue Aws::CodeCommit::Errors::BranchDoesNotExistException
           false
       end
 
+      sig { returns(T::Boolean) }
       def unmerged_pull_request_exists?
         unmerged_prs = []
         pull_requests_for_branch.each do |pr|
-          unless pr.pull_request
-                   .pull_request_targets[0].merge_metadata.is_merged
+          unless T.unsafe(pr).pull_request
+                  .pull_request_targets[0].merge_metadata.is_merged
             unmerged_prs << pr
           end
         end
         unmerged_prs.any?
       end
 
+      sig { returns(T::Array[Aws::CodeCommit::Types::PullRequest]) }
       def pull_requests_for_branch
         @pull_requests_for_branch ||=
-          begin
-            open_prs = codecommit_client_for_source.pull_requests(
-              source.repo,
-              "open",
-              source.branch || default_branch
-            )
-            closed_prs = codecommit_client_for_source.pull_requests(
-              source.repo,
-              "closed",
-              source.branch || default_branch
-            )
-
-            [*open_prs, *closed_prs]
-          end
+          T.let(
+            begin
+              open_prs = codecommit_client_for_source.pull_requests(
+                source.repo,
+                "open",
+                source.branch || default_branch
+              )
+              closed_prs = codecommit_client_for_source.pull_requests(
+                source.repo,
+                "closed",
+                source.branch || default_branch
+              )
+
+              [*open_prs, *closed_prs]
+            end,
+            T.nilable(T::Array[Aws::CodeCommit::Types::PullRequest])
+          )
       end
 
+      sig { void }
       def create_commit
         author = author_details&.slice(:name, :email, :date)
         author = nil unless author&.any?
@@ -142,9 +209,13 @@ module Dependabot
         )
       end
 
+      sig { returns(String) }
       def default_branch
         @default_branch ||=
-          codecommit_client_for_source.fetch_default_branch(source.repo)
+          T.let(
+            codecommit_client_for_source.fetch_default_branch(source.repo),
+            T.nilable(String)
+          )
       end
     end
   end