Merge branch 'mc/bug/fix-k8s-docker-runner-setup' into 'master'

Make register_instructions optional in RunnerSetup

See merge request gitlab-org/gitlab!47123

app/graphql/resolvers/ci/runner_setup_resolver.rb

@@ -27,7 +27,7 @@ module Resolvers
         )
 
         {
-          install_instructions: instructions.install_script,
+          install_instructions: instructions.install_script || other_install_instructions(platform),
           register_instructions: instructions.register_command
         }
       ensure
@@ -36,6 +36,10 @@ module Resolvers
 
       private
 
+      def other_install_instructions(platform)
+        Gitlab::Ci::RunnerInstructions::OTHER_ENVIRONMENTS[platform.to_sym][:installation_instructions_url]
+      end
+
       def target_param(args)
         project_param(args[:project_id]) || group_param(args[:group_id]) || {}
       end

app/graphql/types/ci/runner_setup_type.rb

@@ -8,7 +8,7 @@ module Types
 
       field :install_instructions, GraphQL::STRING_TYPE, null: false,
         description: 'Instructions for installing the runner on the specified architecture'
-      field :register_instructions, GraphQL::STRING_TYPE, null: false,
+      field :register_instructions, GraphQL::STRING_TYPE, null: true,
         description: 'Instructions for registering the runner'
     end
   end

changelogs/unreleased/mc-bug-fix-k8s-docker-runner-setup.yml

+---
+title: Make register_instructions optional for RunnerSetup.
+merge_request: 47123
+author:
+type: fixed

doc/api/graphql/reference/gitlab_schema.graphql

@@ -18411,7 +18411,7 @@ type RunnerSetup {
   """
   Instructions for registering the runner
   """
-  registerInstructions: String!
+  registerInstructions: String
 }
 
 """

doc/api/graphql/reference/gitlab_schema.json

@@ -53211,13 +53211,9 @@
 
               ],
               "type": {
-                "kind": "NON_NULL",
-                "name": null,
-                "ofType": {
-                  "kind": "SCALAR",
-                  "name": "String",
-                  "ofType": null
-                }
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
               },
               "isDeprecated": false,
               "deprecationReason": null

doc/api/graphql/reference/index.md

@@ -2617,7 +2617,7 @@ Autogenerated return type of RunDASTScan.
 | Field | Type | Description |
 | ----- | ---- | ----------- |
 | `installInstructions` | String! | Instructions for installing the runner on the specified architecture |
-| `registerInstructions` | String! | Instructions for registering the runner |
+| `registerInstructions` | String | Instructions for registering the runner |
 
 ### SastCiConfiguration
 

spec/graphql/resolvers/ci/runner_setup_resolver_spec.rb

@@ -8,77 +8,95 @@ RSpec.describe Resolvers::Ci::RunnerSetupResolver do
   describe '#resolve' do
     let(:user) { create(:user) }
 
-    subject(:resolve_subject) { resolve(described_class, ctx: { current_user: user }, args: { platform: 'linux', architecture: 'amd64' }.merge(target_param)) }
+    subject(:resolve_subject) { resolve(described_class, ctx: { current_user: user }, args: { platform: platform, architecture: 'amd64' }.merge(target_param)) }
 
-    context 'without target parameter' do
-      let(:target_param) { {} }
+    context 'with container platforms' do
+      let(:platform) { 'docker' }
+      let(:project) { create(:project) }
+      let(:target_param) { { project_id: project.to_global_id } }
 
-      context 'when user is not admin' do
-        it 'returns access error' do
-          expect { resolve_subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
-        end
+      it 'returns install instructions' do
+        expect(resolve_subject[:install_instructions]).not_to eq(nil)
       end
 
-      context 'when user is admin' do
-        before do
-          user.update!(admin: true)
-        end
-
-        it 'returns install and register instructions' do
-          expect(resolve_subject.keys).to contain_exactly(:install_instructions, :register_instructions)
-          expect(resolve_subject.values).not_to include(nil)
-        end
+      it 'does not return register instructions' do
+        expect(resolve_subject[:register_instructions]).to eq(nil)
       end
     end
 
-    context 'with project target parameter' do
-      let(:project) { create(:project) }
-      let(:target_param) { { project_id: project.to_global_id } }
+    context 'with regular platforms' do
+      let(:platform) { 'linux' }
 
-      context 'when user has access to admin builds on project' do
-        before do
-          project.add_maintainer(user)
-        end
+      context 'without target parameter' do
+        let(:target_param) { {} }
 
-        it 'returns install and register instructions' do
-          expect(resolve_subject.keys).to contain_exactly(:install_instructions, :register_instructions)
-          expect(resolve_subject.values).not_to include(nil)
+        context 'when user is not admin' do
+          it 'returns access error' do
+            expect { resolve_subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+          end
         end
-      end
 
-      context 'when user does not have access to admin builds on project' do
-        before do
-          project.add_developer(user)
-        end
+        context 'when user is admin' do
+          before do
+            user.update!(admin: true)
+          end
 
-        it 'returns access error' do
-          expect { resolve_subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+          it 'returns install and register instructions' do
+            expect(resolve_subject.keys).to contain_exactly(:install_instructions, :register_instructions)
+            expect(resolve_subject.values).not_to include(nil)
+          end
         end
       end
-    end
 
-    context 'with group target parameter' do
-      let(:group) { create(:group) }
-      let(:target_param) { { group_id: group.to_global_id } }
+      context 'with project target parameter' do
+        let(:project) { create(:project) }
+        let(:target_param) { { project_id: project.to_global_id } }
+
+        context 'when user has access to admin builds on project' do
+          before do
+            project.add_maintainer(user)
+          end
 
-      context 'when user has access to admin builds on group' do
-        before do
-          group.add_owner(user)
+          it 'returns install and register instructions' do
+            expect(resolve_subject.keys).to contain_exactly(:install_instructions, :register_instructions)
+            expect(resolve_subject.values).not_to include(nil)
+          end
         end
 
-        it 'returns install and register instructions' do
-          expect(resolve_subject.keys).to contain_exactly(:install_instructions, :register_instructions)
-          expect(resolve_subject.values).not_to include(nil)
+        context 'when user does not have access to admin builds on project' do
+          before do
+            project.add_developer(user)
+          end
+
+          it 'returns access error' do
+            expect { resolve_subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+          end
         end
       end
 
-      context 'when user does not have access to admin builds on group' do
-        before do
-          group.add_developer(user)
+      context 'with group target parameter' do
+        let(:group) { create(:group) }
+        let(:target_param) { { group_id: group.to_global_id } }
+
+        context 'when user has access to admin builds on group' do
+          before do
+            group.add_owner(user)
+          end
+
+          it 'returns install and register instructions' do
+            expect(resolve_subject.keys).to contain_exactly(:install_instructions, :register_instructions)
+            expect(resolve_subject.values).not_to include(nil)
+          end
         end
 
-        it 'returns access error' do
-          expect { resolve_subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+        context 'when user does not have access to admin builds on group' do
+          before do
+            group.add_developer(user)
+          end
+
+          it 'returns access error' do
+            expect { resolve_subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+          end
         end
       end
     end