Merge branch 'issue_218607_be' into 'master'

Allow to mark a requirement as satisfied

See merge request gitlab-org/gitlab!39371

doc/api/graphql/reference/gitlab_schema.graphql

@@ -14596,6 +14596,11 @@ type Requirement {
   """
   iid: ID!
 
+  """
+  Latest requirement test report state
+  """
+  lastTestReportState: TestReportState
+
   """
   Project to which the requirement belongs
   """
@@ -17656,6 +17661,11 @@ input UpdateRequirementInput {
   """
   iid: String!
 
+  """
+  Creates a test report for the requirement with the given state
+  """
+  lastTestReportState: TestReportState
+
   """
   The project full path the requirement is associated with
   """

doc/api/graphql/reference/gitlab_schema.json

@@ -42461,6 +42461,20 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "lastTestReportState",
+              "description": "Latest requirement test report state",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "ENUM",
+                "name": "TestReportState",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "project",
               "description": "Project to which the requirement belongs",
@@ -51680,6 +51694,16 @@
               },
               "defaultValue": null
             },
+            {
+              "name": "lastTestReportState",
+              "description": "Creates a test report for the requirement with the given state",
+              "type": {
+                "kind": "ENUM",
+                "name": "TestReportState",
+                "ofType": null
+              },
+              "defaultValue": null
+            },
             {
               "name": "clientMutationId",
               "description": "A unique identifier for the client performing the mutation.",

doc/api/graphql/reference/index.md

@@ -2009,6 +2009,7 @@ Represents a requirement
 | `createdAt` | Time! | Timestamp of when the requirement was created |
 | `id` | ID! | ID of the requirement |
 | `iid` | ID! | Internal ID of the requirement |
+| `lastTestReportState` | TestReportState | Latest requirement test report state |
 | `project` | Project! | Project to which the requirement belongs |
 | `state` | RequirementState! | State of the requirement |
 | `title` | String | Title of the requirement |

ee/app/graphql/mutations/requirements_management/update_requirement.rb

@@ -29,10 +29,14 @@ module Mutations
                required: true,
                description: 'The project full path the requirement is associated with'
 
+      argument :last_test_report_state, Types::RequirementsManagement::TestReportStateEnum,
+               required: false,
+               description: 'Creates a test report for the requirement with the given state'
+
       def ready?(**args)
-        if args.values_at(:title, :state).compact.blank?
+        if args.values_at(:title, :state, :last_test_report_state).compact.blank?
           raise Gitlab::Graphql::Errors::ArgumentError,
-            'title or state argument is required'
+            'title, state or last_test_report_state argument is required'
         end
 
         super

ee/app/graphql/types/requirements_management/requirement_type.rb

@@ -18,7 +18,8 @@ module Types
             description: 'Title of the requirement'
       field :state, RequirementsManagement::RequirementStateEnum, null: false,
             description: 'State of the requirement'
-
+      field :last_test_report_state, RequirementsManagement::TestReportStateEnum, null: true, complexity: 5,
+            description: 'Latest requirement test report state'
       field :project, ProjectType, null: false,
             description: 'Project to which the requirement belongs',
             resolve: -> (obj, _args, _ctx) { Gitlab::Graphql::Loaders::BatchModelLoader.new(Project, obj.project_id).find }

ee/app/models/requirements_management/requirement.rb

@@ -58,5 +58,13 @@ module RequirementsManagement
     def resource_parent
       project
     end
+
+    def last_test_report_state
+      test_reports.last&.state
+    end
+
+    def last_test_report_manually_created?
+      test_reports.last&.build.nil?
+    end
   end
 end

ee/app/models/requirements_management/test_report.rb

@@ -31,6 +31,16 @@ module RequirementsManagement
         bulk_insert!(reports)
       end
 
+      def build_report(author: nil, state:, requirement:, build: nil, timestamp: Time.current)
+        new(
+          requirement_id: requirement.id,
+          build_id: build&.id,
+          author_id: build&.user_id || author&.id,
+          created_at: timestamp,
+          state: state
+        )
+      end
+
       private
 
       def passed_reports_for_all_requirements(build, timestamp)
@@ -55,16 +65,6 @@ module RequirementsManagement
           end
         end
       end
-
-      def build_report(state:, requirement:, build:, timestamp:)
-        new(
-          requirement_id: requirement.id,
-          build_id: build.id,
-          author_id: build.user_id,
-          created_at: timestamp,
-          state: state
-        )
-      end
     end
   end
 end

ee/app/services/requirements_management/update_requirement_service.rb

@@ -8,11 +8,23 @@ module RequirementsManagement
       attrs = whitelisted_requirement_params
       requirement.update(attrs)
 
+      create_test_report_for(requirement) if manually_create_test_report?
+
       requirement
     end
 
     private
 
+    def manually_create_test_report?
+      params[:last_test_report_state].present?
+    end
+
+    def create_test_report_for(requirement)
+      return unless can?(current_user, :create_requirement_test_report, project)
+
+      TestReport.build_report(requirement: requirement, state: params[:last_test_report_state], author: current_user).save!
+    end
+
     def whitelisted_requirement_params
       params.slice(:title, :state)
     end

ee/changelogs/unreleased/issue_218607_be.yml

+---
+title: Allow requirement status to be updated with GraphQL
+merge_request: 39371
+author:
+type: added

ee/spec/graphql/mutations/requirements_management/update_requirement_spec.rb

@@ -21,13 +21,14 @@ RSpec.describe Mutations::RequirementsManagement::UpdateRequirement do
         project_path: project.full_path,
         iid: requirement.iid.to_s,
         title: 'foo',
-        state: 'archived'
+        state: 'archived',
+        last_test_report_state: 'passed'
       )
     end
 
     it_behaves_like 'requirements not available'
 
-    context 'when the user can update the epic' do
+    context 'when the user can update the requirement' do
       before do
         project.add_developer(user)
       end
@@ -40,7 +41,8 @@ RSpec.describe Mutations::RequirementsManagement::UpdateRequirement do
         it 'updates new requirement', :aggregate_failures do
           expect(subject[:requirement]).to have_attributes(
             title: 'foo',
-            state: 'archived'
+            state: 'archived',
+            last_test_report_state: 'passed'
           )
           expect(subject[:errors]).to be_empty
         end

ee/spec/graphql/types/requirements_management/requirement_type_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 RSpec.describe GitlabSchema.types['Requirement'] do
-  fields = %i[id iid title state project author created_at updated_at user_permissions test_reports]
+  fields = %i[id iid title state last_test_report_state project author created_at updated_at user_permissions test_reports]
 
   it { expect(described_class).to expose_permissions_using(Types::PermissionTypes::Requirement) }
 

ee/spec/models/requirements_management/requirement_spec.rb

@@ -77,4 +77,50 @@ RSpec.describe RequirementsManagement::Requirement do
       end
     end
   end
+
+  describe '#last_test_report_state' do
+    let_it_be(:requirement) { create(:requirement) }
+
+    context 'when latest test report is passing' do
+      it 'returns passing' do
+        create(:test_report, requirement: requirement, state: :passed, build: nil)
+
+        expect(requirement.last_test_report_state).to eq('passed')
+      end
+    end
+
+    context 'when latest test report is failing' do
+      it 'returns failing' do
+        create(:test_report, requirement: requirement, state: :failed, build: nil)
+
+        expect(requirement.last_test_report_state).to eq('failed')
+      end
+    end
+
+    context 'when there are no test reports' do
+      it 'returns nil' do
+        expect(requirement.last_test_report_state).to eq(nil)
+      end
+    end
+  end
+
+  describe '#status_manually_updated' do
+    let_it_be(:requirement) { create(:requirement) }
+
+    context 'when latest test report has a build' do
+      it 'returns false' do
+        create(:test_report, requirement: requirement, state: :passed)
+
+        expect(requirement.last_test_report_manually_created?).to eq(false)
+      end
+    end
+
+    context 'when latest test report does not have a build' do
+      it 'returns true' do
+        create(:test_report, requirement: requirement, state: :passed, build: nil)
+
+        expect(requirement.last_test_report_manually_created?).to eq(true)
+      end
+    end
+  end
 end

ee/spec/models/requirements_management/test_report_spec.rb

@@ -96,4 +96,36 @@ RSpec.describe RequirementsManagement::TestReport do
       end
     end
   end
+
+  describe '.build_report' do
+    let_it_be(:user) { create(:user) }
+    let_it_be(:build_author) { create(:user) }
+    let_it_be(:build) { create(:ci_build, author: build_author) }
+    let_it_be(:requirement) { create(:requirement, state: :opened) }
+    let(:now) { Time.current }
+
+    context 'when build is passed as argument' do
+      it 'builds test report with correct attributes' do
+        test_report = described_class.build_report(requirement: requirement, author: user, state: 'failed', build: build, timestamp: now)
+
+        expect(test_report.author).to eq(build.author)
+        expect(test_report.build).to eq(build)
+        expect(test_report.requirement).to eq(requirement)
+        expect(test_report.state).to eq('failed')
+        expect(test_report.created_at).to eq(now)
+      end
+    end
+
+    context 'when build is not passed as argument' do
+      it 'builds test report with correct attributes' do
+        test_report = described_class.build_report(requirement: requirement, author: user, state: 'passed', timestamp: now)
+
+        expect(test_report.author).to eq(user)
+        expect(test_report.build).to eq(nil)
+        expect(test_report.requirement).to eq(requirement)
+        expect(test_report.state).to eq('passed')
+        expect(test_report.created_at).to eq(now)
+      end
+    end
+  end
 end

ee/spec/requests/api/graphql/mutations/requirements_management/update_requirement_spec.rb

@@ -81,7 +81,7 @@ RSpec.describe 'Updating a Requirement' do
         let(:attributes) { {} }
 
         it_behaves_like 'a mutation that returns top-level errors',
-          errors: ['title or state argument is required']
+          errors: ['title, state or last_test_report_state argument is required']
       end
 
       context 'when requirements_management flag is disabled' do

ee/spec/services/requirements_management/update_requirement_service_spec.rb

@@ -38,6 +38,46 @@ RSpec.describe RequirementsManagement::UpdateRequirementService do
           author_id: params[:author_id]
         )
       end
+
+      context 'when updating last test report state' do
+        context 'as passing' do
+          it 'creates passing test report with null build_id' do
+            service = described_class.new(project, user, { last_test_report_state: 'passed' })
+
+            expect { service.execute(requirement) }.to change { RequirementsManagement::TestReport.count }.from(0).to(1)
+            test_report = requirement.test_reports.last
+            expect(requirement.last_test_report_state).to eq('passed')
+            expect(requirement.last_test_report_manually_created?).to eq(true)
+            expect(test_report.state).to eq('passed')
+            expect(test_report.build).to eq(nil)
+            expect(test_report.author).to eq(user)
+          end
+        end
+
+        context 'as failed' do
+          it 'creates failing test report with null build_id' do
+            service = described_class.new(project, user, { last_test_report_state: 'failed' })
+
+            expect { service.execute(requirement) }.to change { RequirementsManagement::TestReport.count }.from(0).to(1)
+            test_report = requirement.test_reports.last
+            expect(requirement.last_test_report_state).to eq('failed')
+            expect(requirement.last_test_report_manually_created?).to eq(true)
+            expect(test_report.state).to eq('failed')
+            expect(test_report.build).to eq(nil)
+            expect(test_report.author).to eq(user)
+          end
+        end
+
+        context 'when user cannot create test reports' do
+          it 'does not create test report' do
+            allow(Ability).to receive(:allowed?).and_call_original
+            allow(Ability).to receive(:allowed?).with(user, :create_requirement_test_report, project).and_return(false)
+            service = described_class.new(project, user, { last_test_report_state: 'failed' })
+
+            expect { service.execute(requirement) }.not_to change { RequirementsManagement::TestReport.count }
+          end
+        end
+      end
     end
 
     context 'when user is not allowed to update requirements' do