Merge branch 'add-complete-field-to-pipeline-and-job' into 'master'

Add complete field to indicate if a pipeline/job is completed

See merge request gitlab-org/gitlab!61209

app/graphql/queries/pipelines/get_pipeline_details.query.graphql

@@ -27,6 +27,7 @@ query getPipelineDetails($projectPath: ID!, $iid: ID!) {
       __typename
       id
       iid
+      complete
       usesNeeds
       downstream {
         __typename

app/graphql/types/ci/pipeline_type.rb

@@ -24,6 +24,9 @@ module Types
       field :before_sha, GraphQL::STRING_TYPE, null: true,
             description: 'Base SHA of the source branch.'
 
+      field :complete, GraphQL::BOOLEAN_TYPE, null: false, method: :complete?,
+            description: 'Indicates if a pipeline is complete.'
+
       field :status, PipelineStatusEnum, null: false,
             description: "Status of the pipeline (#{::Ci::Pipeline.all_state_names.compact.join(', ').upcase})"
 

app/serializers/job_entity.rb

@@ -7,6 +7,7 @@ class JobEntity < Grape::Entity
   expose :name
 
   expose :started?, as: :started
+  expose :complete?, as: :complete
   expose :archived?, as: :archived
 
   # bridge jobs don't have build detail pages

changelogs/unreleased/add-complete-field-to-pipeline-and-job.yml

+---
+title: Add complete field to indicate if a pipeline/job is complete
+merge_request: 61209
+author: Cong Chen @gentcys
+type: added

doc/api/graphql/reference/index.md

@@ -10625,6 +10625,7 @@ Information about pagination in a connection.
 | <a id="pipelinecodequalityreports"></a>`codeQualityReports` | [`CodeQualityDegradationConnection`](#codequalitydegradationconnection) | Code Quality degradations reported on the pipeline. (see [Connections](#connections)) |
 | <a id="pipelinecommitpath"></a>`commitPath` | [`String`](#string) | Path to the commit that triggered the pipeline. |
 | <a id="pipelinecommittedat"></a>`committedAt` | [`Time`](#time) | Timestamp of the pipeline's commit. |
+| <a id="pipelinecomplete"></a>`complete` | [`Boolean!`](#boolean) | Indicates if a pipeline is complete. |
 | <a id="pipelineconfigsource"></a>`configSource` | [`PipelineConfigSourceEnum`](#pipelineconfigsourceenum) | Configuration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE, COMPLIANCE_SOURCE). |
 | <a id="pipelinecoverage"></a>`coverage` | [`Float`](#float) | Coverage percentage. |
 | <a id="pipelinecreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of the pipeline's creation. |

spec/frontend/jobs/mock_data.js

@@ -920,6 +920,7 @@ export default {
   cancel_path: '/root/ci-mock/-/jobs/4757/cancel',
   new_issue_path: '/root/ci-mock/issues/new',
   playable: false,
+  complete: true,
   created_at: threeWeeksAgo.toISOString(),
   updated_at: threeWeeksAgo.toISOString(),
   finished_at: threeWeeksAgo.toISOString(),

spec/frontend/pipelines/graph/mock_data.js

@@ -8,6 +8,7 @@ export const mockPipelineResponse = {
         __typename: 'Pipeline',
         id: 163,
         iid: '22',
+        complete: true,
         usesNeeds: true,
         downstream: null,
         upstream: null,
@@ -570,6 +571,7 @@ export const wrappedPipelineReturn = {
         __typename: 'Pipeline',
         id: 'gid://gitlab/Ci::Pipeline/175',
         iid: '38',
+        complete: true,
         usesNeeds: true,
         downstream: {
           __typename: 'PipelineConnection',

spec/graphql/types/ci/pipeline_type_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Types::Ci::PipelineType do
 
   it 'contains attributes related to a pipeline' do
     expected_fields = %w[
-      id iid sha before_sha status detailed_status config_source
+      id iid sha before_sha complete status detailed_status config_source
       duration queued_duration
       coverage created_at updated_at started_at finished_at committed_at
       stages user retryable cancelable jobs source_job job downstream

spec/serializers/job_entity_spec.rb

@@ -21,6 +21,10 @@ RSpec.describe JobEntity do
 
   subject { entity.as_json }
 
+  it 'contains complete to indicate if a pipeline is completed' do
+    expect(subject).to include(:complete)
+  end
+
   it 'contains paths to job page action' do
     expect(subject).to include(:build_path)
   end