Merge branch 'pedropombeiro/331771/runner-graphql-delete-mutation' into 'master'

Implement GraphQL Mutation to delete runner

See merge request gitlab-org/gitlab!62765

app/graphql/mutations/ci/runner/delete.rb

+# frozen_string_literal: true
+
+module Mutations
+  module Ci
+    module Runner
+      class Delete < BaseMutation
+        graphql_name 'RunnerDelete'
+
+        authorize :delete_runner
+
+        RunnerID = ::Types::GlobalIDType[::Ci::Runner]
+
+        argument :id, RunnerID,
+                 required: true,
+                 description: 'ID of the runner to delete.'
+
+        def resolve(id:, **runner_attrs)
+          runner = authorized_find!(id)
+
+          error = authenticate_delete_runner!(runner)
+          return { errors: [error] } if error
+
+          runner.destroy!
+
+          { errors: runner.errors.full_messages }
+        end
+
+        def authenticate_delete_runner!(runner)
+          return if current_user.can_admin_all_resources?
+
+          "Runner #{runner.to_global_id} associated with more than one project" if runner.projects.count > 1
+        end
+
+        def find_object(id)
+          # TODO: remove this line when the compatibility layer is removed
+          # See: https://gitlab.com/gitlab-org/gitlab/-/issues/257883
+          id = RunnerID.coerce_isolated_input(id)
+
+          GitlabSchema.find_by_gid(id)
+        end
+      end
+    end
+  end
+end

app/graphql/types/mutation_type.rb

@@ -100,6 +100,7 @@ module Types
     mount_mutation Mutations::Ci::Job::Play
     mount_mutation Mutations::Ci::Job::Retry
     mount_mutation Mutations::Ci::Runner::Update, feature_flag: :runner_graphql_query
+    mount_mutation Mutations::Ci::Runner::Delete, feature_flag: :runner_graphql_query
     mount_mutation Mutations::Namespace::PackageSettings::Update
     mount_mutation Mutations::UserCallouts::Create
   end

doc/api/graphql/reference/index.md

@@ -3569,6 +3569,26 @@ Input type: `RunDASTScanInput`
 | <a id="mutationrundastscanerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
 | <a id="mutationrundastscanpipelineurl"></a>`pipelineUrl` | [`String`](#string) | URL of the pipeline that was created. |
 
+### `Mutation.runnerDelete`
+
+Available only when feature flag `runner_graphql_query` is enabled.
+
+Input type: `RunnerDeleteInput`
+
+#### Arguments
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| <a id="mutationrunnerdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
+| <a id="mutationrunnerdeleteid"></a>`id` | [`CiRunnerID!`](#cirunnerid) | ID of the runner to delete. |
+
+#### Fields
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| <a id="mutationrunnerdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
+| <a id="mutationrunnerdeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
+
 ### `Mutation.runnerUpdate`
 
 Available only when feature flag `runner_graphql_query` is enabled.

spec/graphql/mutations/ci/runner/delete_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Mutations::Ci::Runner::Delete do
+  include GraphqlHelpers
+
+  let_it_be(:user) { create(:user) }
+  let_it_be(:runner) { create(:ci_runner) }
+
+  let(:current_ctx) { { current_user: user } }
+
+  let(:mutation_params) do
+    {
+      id: runner.to_global_id
+    }
+  end
+
+  specify { expect(described_class).to require_graphql_authorizations(:delete_runner) }
+
+  describe '#resolve' do
+    subject do
+      sync(resolve(described_class, args: mutation_params, ctx: current_ctx))
+    end
+
+    context 'when the user cannot admin the runner' do
+      it 'raises an error' do
+        expect { subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+      end
+    end
+
+    context 'with invalid params' do
+      it 'raises an error' do
+        mutation_params[:id] = "invalid-id"
+
+        expect { subject }.to raise_error(::GraphQL::CoercionError)
+      end
+    end
+
+    context 'when required arguments are missing' do
+      let(:mutation_params) { {} }
+
+      it 'raises an error' do
+        expect { subject }.to raise_error(ArgumentError, "missing keyword: :id")
+      end
+    end
+
+    context 'when user can delete owned runner' do
+      let_it_be(:project) { create(:project, creator_id: user.id) }
+      let_it_be(:project_runner, reload: true) { create(:ci_runner, :project, description: 'Project runner', projects: [project]) }
+
+      before_all do
+        project.add_maintainer(user)
+      end
+
+      context 'with one associated project' do
+        it 'deletes runner' do
+          mutation_params[:id] = project_runner.to_global_id
+
+          expect { subject }.to change { Ci::Runner.count }.by(-1)
+          expect(subject[:errors]).to be_empty
+        end
+      end
+
+      context 'with more than one associated project' do
+        let_it_be(:project2) { create(:project, creator_id: user.id) }
+        let_it_be(:two_projects_runner) { create(:ci_runner, :project, description: 'Two projects runner', projects: [project, project2]) }
+
+        before_all do
+          project2.add_maintainer(user)
+        end
+
+        it 'does not delete project runner' do
+          mutation_params[:id] = two_projects_runner.to_global_id
+
+          expect { subject }.not_to change { Ci::Runner.count }
+          expect(subject[:errors]).to contain_exactly("Runner #{two_projects_runner.to_global_id} associated with more than one project")
+        end
+      end
+    end
+
+    context 'when admin can delete runner', :enable_admin_mode do
+      let(:admin_user) { create(:user, :admin) }
+      let(:current_ctx) { { current_user: admin_user } }
+
+      it 'deletes runner' do
+        expect { subject }.to change { Ci::Runner.count }.by(-1)
+        expect(subject[:errors]).to be_empty
+      end
+    end
+  end
+end