Added created_by_user to cluster agents

Updated Clusters::Agent model and database
to include created_by_user field.
Updated tests and docs.

app/models/clusters/agent.rb

@@ -4,6 +4,7 @@ module Clusters
   class Agent < ApplicationRecord
     self.table_name = 'cluster_agents'
+    belongs_to :created_by_user, class_name: 'User', optional: true
     belongs_to :project, class_name: '::Project' # Otherwise, it will load ::Clusters::Project
     has_many :agent_tokens, class_name: 'Clusters::AgentToken'

changelogs/unreleased/293720-agent-created-by.yml

+---
+title: Add created_by_user to cluster agents
+merge_request: 54011
+author:
+type: added

db/migrate/20210216135504_add_created_by_to_cluster_agent.rb

+# frozen_string_literal: true
+
+class AddCreatedByToClusterAgent < ActiveRecord::Migration[6.0]
+  include Gitlab::Database::MigrationHelpers
+
+  DOWNTIME = false
+  INDEX_NAME = 'index_cluster_agents_on_created_by_user_id'
+
+  disable_ddl_transaction!
+
+  def up
+    unless column_exists?(:cluster_agents, :created_by_user_id)
+      with_lock_retries do
+        add_column :cluster_agents, :created_by_user_id, :bigint
+      end
+    end
+
+    add_concurrent_index :cluster_agents, :created_by_user_id, name: INDEX_NAME
+    add_concurrent_foreign_key :cluster_agents, :users, column: :created_by_user_id, on_delete: :nullify
+  end
+
+  def down
+    with_lock_retries do
+      remove_column :cluster_agents, :created_by_user_id
+    end
+  end
+end

db/schema_migrations/20210216135504

+8c676b4142db828b1d2d5dc6bd891eb929d12ab13e9073693ab7d830bcea599a
\ No newline at end of file

db/structure.sql

@@ -11007,6 +11007,7 @@ CREATE TABLE cluster_agents (
     updated_at timestamp with time zone NOT NULL,
     project_id bigint NOT NULL,
     name text NOT NULL,
+    created_by_user_id bigint,
     CONSTRAINT check_3498369510 CHECK ((char_length(name) <= 255))
 );
@@ -21796,6 +21797,8 @@ CREATE INDEX index_cluster_agent_tokens_on_agent_id ON cluster_agent_tokens USIN
 CREATE UNIQUE INDEX index_cluster_agent_tokens_on_token_encrypted ON cluster_agent_tokens USING btree (token_encrypted);
+CREATE INDEX index_cluster_agents_on_created_by_user_id ON cluster_agents USING btree (created_by_user_id);
+
 CREATE UNIQUE INDEX index_cluster_agents_on_project_id_and_name ON cluster_agents USING btree (project_id, name);
 CREATE UNIQUE INDEX index_cluster_groups_on_cluster_id_and_group_id ON cluster_groups USING btree (cluster_id, group_id);
@@ -24722,6 +24725,9 @@ ALTER TABLE ONLY design_management_designs_versions
 ALTER TABLE ONLY analytics_devops_adoption_segments
     ADD CONSTRAINT fk_f5aa768998 FOREIGN KEY (namespace_id) REFERENCES namespaces(id) ON DELETE CASCADE;
+ALTER TABLE ONLY cluster_agents
+    ADD CONSTRAINT fk_f7d43dee13 FOREIGN KEY (created_by_user_id) REFERENCES users(id) ON DELETE SET NULL;
+
 ALTER TABLE ONLY protected_tag_create_access_levels
     ADD CONSTRAINT fk_f7dfda8c51 FOREIGN KEY (protected_tag_id) REFERENCES protected_tags(id) ON DELETE CASCADE;

doc/api/graphql/reference/gitlab_schema.graphql

@@ -3394,6 +3394,11 @@ type ClusterAgent {
   """
   createdAt: Time
+  """
+  User object, containing information about the person who created the agent.
+  """
+  createdByUser: User
+
   """
   ID of the cluster agent.
   """

doc/api/graphql/reference/gitlab_schema.json

@@ -9175,6 +9175,20 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "createdByUser",
+              "description": "User object, containing information about the person who created the agent.",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "OBJECT",
+                "name": "User",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "id",
               "description": "ID of the cluster agent.",

doc/api/graphql/reference/index.md

@@ -536,6 +536,7 @@ Autogenerated return type of CiCdSettingsUpdate.
 | Field | Type | Description |
 | ----- | ---- | ----------- |
 | `createdAt` | Time | Timestamp the cluster agent was created. |
+| `createdByUser` | User | User object, containing information about the person who created the agent. |
 | `id` | ID! | ID of the cluster agent. |
 | `name` | String | Name of the cluster agent. |
 | `project` | Project | The project this cluster agent is associated with. |

ee/app/graphql/types/clusters/agent_type.rb

@@ -14,6 +14,11 @@ class AgentType < BaseObject
             null: true,
             description: 'Timestamp the cluster agent was created.'
+      field :created_by_user,
+            Types::UserType,
+            null: true,
+            description: 'User object, containing information about the person who created the agent.'
+
       field :id, GraphQL::ID_TYPE,
             null: false,
             description: 'ID of the cluster agent.'

ee/app/services/clusters/agents/create_service.rb

@@ -8,7 +8,7 @@ def execute(name:)
         return error_not_premium_plan unless project.feature_available?(:cluster_agents)
         return error_no_permissions unless cluster_agent_permissions?
-        agent = ::Clusters::Agent.new(name: name, project: project)
+        agent = ::Clusters::Agent.new(name: name, project: project, created_by_user: current_user)
         if agent.save
           success.merge(cluster_agent: agent)

ee/spec/graphql/types/clusters/agent_type_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 RSpec.describe GitlabSchema.types['ClusterAgent'] do
-  let(:fields) { %i[created_at id name project updated_at tokens] }
+  let(:fields) { %i[created_at created_by_user id name project updated_at tokens] }
   it { expect(described_class.graphql_name).to eq('ClusterAgent') }

ee/spec/services/clusters/agents/create_service_spec.rb

@@ -53,6 +53,13 @@
         expect(result[:message]).to be_nil
       end
+      it 'returns agent values', :aggregate_failures do
+        new_agent = service.execute(name: 'new-agent')[:cluster_agent]
+
+        expect(new_agent.name).to eq('new-agent')
+        expect(new_agent.created_by_user).to eq(user)
+      end
+
       it 'generates an error message when name is invalid' do
         expect(service.execute(name: '@bad_agent_name!')).to eq({
           status: :error,

spec/models/clusters/agent_spec.rb

@@ -5,6 +5,7 @@
 RSpec.describe Clusters::Agent do
   subject { create(:cluster_agent) }
+  it { is_expected.to belong_to(:created_by_user).class_name('User').optional }
   it { is_expected.to belong_to(:project).class_name('::Project') }
   it { is_expected.to have_many(:agent_tokens).class_name('Clusters::AgentToken') }