dependabot-common 0.245.0 → 0.246.0

data/lib/dependabot/pull_request_creator/gitlab.rb

@@ -1,18 +1,78 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
+require "gitlab"
+require "sorbet-runtime"
+
 require "dependabot/clients/gitlab_with_retries"
 require "dependabot/pull_request_creator"
-require "gitlab"
 
 module Dependabot
   class PullRequestCreator
     class Gitlab
-      attr_reader :source, :branch_name, :base_commit, :credentials,
-                  :files, :pr_description, :pr_name, :commit_message,
-                  :author_details, :labeler, :approvers, :assignees,
-                  :milestone, :target_project_id
+      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 :pr_description
+
+      sig { returns(String) }
+      attr_reader :pr_name
+
+      sig { returns(String) }
+      attr_reader :commit_message
+
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :author_details
 
+      sig { returns(Dependabot::PullRequestCreator::Labeler) }
+      attr_reader :labeler
+
+      sig { returns(T.nilable(T::Hash[Symbol, T::Array[Integer]])) }
+      attr_reader :approvers
+
+      sig { returns(T.nilable(T::Array[Integer])) }
+      attr_reader :assignees
+
+      sig { returns(T.nilable(T.any(T::Array[String], Integer))) }
+      attr_reader :milestone
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :target_project_id
+
+      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: Dependabot::PullRequestCreator::Labeler,
+          approvers: T.nilable(T::Hash[Symbol, T::Array[Integer]]),
+          assignees: T.nilable(T::Array[Integer]),
+          milestone: T.nilable(T.any(T::Array[String], Integer)),
+          target_project_id: T.nilable(Integer)
+        )
+          .void
+      end
       def initialize(source:, branch_name:, base_commit:, credentials:,
                      files:, commit_message:, pr_description:, pr_name:,
                      author_details:, labeler:, approvers:, assignees:,
@@ -33,6 +93,7 @@ module Dependabot
         @target_project_id = target_project_id
       end
 
+      sig { returns(T.nilable(::Gitlab::ObjectifiedHash)) }
       def create
         return if branch_exists? && merge_request_exists?
 
@@ -54,30 +115,43 @@ module Dependabot
 
       private
 
+      sig { returns(Dependabot::Clients::GitlabWithRetries) }
       def gitlab_client_for_source
         @gitlab_client_for_source ||=
-          Dependabot::Clients::GitlabWithRetries.for_source(
-            source: source,
-            credentials: credentials
+          T.let(
+            Dependabot::Clients::GitlabWithRetries.for_source(
+              source: source,
+              credentials: credentials
+            ),
+            T.nilable(Dependabot::Clients::GitlabWithRetries)
           )
       end
 
+      sig { returns(T::Boolean) }
       def branch_exists?
         @branch_ref ||=
-          gitlab_client_for_source.branch(source.repo, branch_name)
+          T.let(
+            T.unsafe(gitlab_client_for_source).branch(source.repo, branch_name),
+            T.nilable(::Gitlab::ObjectifiedHash)
+          )
         true
       rescue ::Gitlab::Error::NotFound
         false
       end
 
+      sig { returns(T::Boolean) }
       def commit_exists?
         @commits ||=
-          gitlab_client_for_source.commits(source.repo, ref_name: branch_name)
+          T.let(
+            T.unsafe(gitlab_client_for_source).commits(source.repo, ref_name: branch_name),
+            T.nilable(::Gitlab::PaginatedResponse)
+          )
         @commits.first.message == commit_message
       end
 
+      sig { returns(T::Boolean) }
       def merge_request_exists?
-        gitlab_client_for_source.merge_requests(
+        T.unsafe(gitlab_client_for_source).merge_requests(
           target_project_id || source.repo,
           source_branch: branch_name,
           target_branch: source.branch || default_branch,
@@ -85,16 +159,18 @@ module Dependabot
         ).any?
       end
 
+      sig { returns(::Gitlab::ObjectifiedHash) }
       def create_branch
-        gitlab_client_for_source.create_branch(
+        T.unsafe(gitlab_client_for_source).create_branch(
           source.repo,
           branch_name,
           base_commit
         )
       end
 
+      sig { returns(::Gitlab::ObjectifiedHash) }
       def create_commit
-        return create_submodule_update_commit if files.count == 1 && files.first.type == "submodule"
+        return create_submodule_update_commit if files.count == 1 && T.must(files.first).type == "submodule"
 
         gitlab_client_for_source.create_commit(
           source.repo,
@@ -104,10 +180,11 @@ module Dependabot
         )
       end
 
+      sig { returns(::Gitlab::ObjectifiedHash) }
       def create_submodule_update_commit
-        file = files.first
+        file = T.must(files.first)
 
-        gitlab_client_for_source.edit_submodule(
+        T.unsafe(gitlab_client_for_source).edit_submodule(
           source.repo,
           file.path.gsub(%r{^/}, ""),
           branch: branch_name,
@@ -116,8 +193,9 @@ module Dependabot
         )
       end
 
+      sig { returns(T.nilable(::Gitlab::ObjectifiedHash)) }
       def create_merge_request
-        gitlab_client_for_source.create_merge_request(
+        T.unsafe(gitlab_client_for_source).create_merge_request(
           source.repo,
           pr_name,
           source_branch: branch_name,
@@ -132,16 +210,18 @@ module Dependabot
         )
       end
 
+      sig { params(merge_request: ::Gitlab::ObjectifiedHash).returns(T.nilable(::Gitlab::ObjectifiedHash)) }
       def annotate_merge_request(merge_request)
         add_approvers_to_merge_request(merge_request)
       end
 
+      sig { params(merge_request: ::Gitlab::ObjectifiedHash).returns(T.nilable(::Gitlab::ObjectifiedHash)) }
       def add_approvers_to_merge_request(merge_request)
         return unless approvers_hash[:approvers] || approvers_hash[:group_approvers]
 
-        gitlab_client_for_source.create_merge_request_level_rule(
+        T.unsafe(gitlab_client_for_source).create_merge_request_level_rule(
           target_project_id || source.repo,
-          merge_request.iid,
+          T.unsafe(merge_request).iid,
           name: "dependency-updates",
           approvals_required: 1,
           user_ids: approvers_hash[:approvers],
@@ -149,13 +229,21 @@ module Dependabot
         )
       end
 
+      sig { returns(T::Hash[Symbol, T::Array[Integer]]) }
       def approvers_hash
-        @approvers_hash ||= approvers || {}
+        @approvers_hash ||= T.let(
+          approvers || {},
+          T.nilable(T::Hash[Symbol, T::Array[Integer]])
+        )
       end
 
+      sig { returns(String) }
       def default_branch
         @default_branch ||=
-          gitlab_client_for_source.project(source.repo).default_branch
+          T.let(
+            T.unsafe(gitlab_client_for_source).project(source.repo).default_branch,
+            T.nilable(String)
+          )
       end
     end
   end