Merge branch '273592-add-state-version' into 'master'

Add additional fields to GraphQl terraform state version

See merge request gitlab-org/gitlab!48411

app/graphql/types/terraform/state_version_type.rb

@@ -3,6 +3,8 @@
 module Types
   module Terraform
     class StateVersionType < BaseObject
+      include ::API::Helpers::RelatedResourcesHelpers
+
       graphql_name 'TerraformStateVersion'
 
       authorize :read_terraform_state
@@ -16,11 +18,20 @@ module Types
             authorize: :read_user,
             description: 'The user that created this version'
 
+      field :download_path, GraphQL::STRING_TYPE,
+            null: true,
+            description: "URL for downloading the version's JSON file"
+
       field :job, Types::Ci::JobType,
             null: true,
             authorize: :read_build,
             description: 'The job that created this version'
 
+      field :serial, GraphQL::INT_TYPE,
+            null: true,
+            description: 'Serial number of the version',
+            method: :version
+
       field :created_at, Types::TimeType,
             null: false,
             description: 'Timestamp the version was created'
@@ -33,6 +44,14 @@ module Types
         Gitlab::Graphql::Loaders::BatchModelLoader.new(User, object.created_by_user_id).find
       end
 
+      def download_path
+        expose_path api_v4_projects_terraform_state_versions_path(
+          id: object.project_id,
+          name: object.terraform_state.name,
+          serial: object.version
+        )
+      end
+
       def job
         Gitlab::Graphql::Loaders::BatchModelLoader.new(::Ci::Build, object.ci_build_id).find
       end

changelogs/unreleased/273592-add-state-version.yml

+---
+title: Add additional fields to GraphQl terraform state version
+merge_request: 48411
+author:
+type: changed

doc/api/graphql/reference/gitlab_schema.graphql

@@ -21691,6 +21691,11 @@ type TerraformStateVersion {
   """
   createdByUser: User
 
+  """
+  URL for downloading the version's JSON file
+  """
+  downloadPath: String
+
   """
   ID of the Terraform state version
   """
@@ -21701,6 +21706,11 @@ type TerraformStateVersion {
   """
   job: CiJob
 
+  """
+  Serial number of the version
+  """
+  serial: Int
+
   """
   Timestamp the version was updated
   """

doc/api/graphql/reference/gitlab_schema.json

@@ -63178,6 +63178,20 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "downloadPath",
+              "description": "URL for downloading the version's JSON file",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "id",
               "description": "ID of the Terraform state version",
@@ -63210,6 +63224,20 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "serial",
+              "description": "Serial number of the version",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Int",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "updatedAt",
               "description": "Timestamp the version was updated",

doc/api/graphql/reference/index.md

@@ -3222,8 +3222,10 @@ Autogenerated return type of TerraformStateUnlock.
 | ----- | ---- | ----------- |
 | `createdAt` | Time! | Timestamp the version was created |
 | `createdByUser` | User | The user that created this version |
+| `downloadPath` | String | URL for downloading the version's JSON file |
 | `id` | ID! | ID of the Terraform state version |
 | `job` | CiJob | The job that created this version |
+| `serial` | Int | Serial number of the version |
 | `updatedAt` | Time! | Timestamp the version was updated |
 
 ### TerraformStateVersionRegistry

spec/graphql/types/terraform/state_version_type_spec.rb

@@ -7,13 +7,15 @@ RSpec.describe GitlabSchema.types['TerraformStateVersion'] do
   it { expect(described_class).to require_graphql_authorizations(:read_terraform_state) }
 
   describe 'fields' do
-    let(:fields) { %i[id created_by_user job created_at updated_at] }
+    let(:fields) { %i[id created_by_user job download_path serial created_at updated_at] }
 
     it { expect(described_class).to have_graphql_fields(fields) }
 
     it { expect(described_class.fields['id'].type).to be_non_null }
     it { expect(described_class.fields['createdByUser'].type).not_to be_non_null }
     it { expect(described_class.fields['job'].type).not_to be_non_null }
+    it { expect(described_class.fields['downloadPath'].type).not_to be_non_null }
+    it { expect(described_class.fields['serial'].type).not_to be_non_null }
     it { expect(described_class.fields['createdAt'].type).to be_non_null }
     it { expect(described_class.fields['updatedAt'].type).to be_non_null }
   end

spec/requests/api/graphql/project/terraform/states_spec.rb

@@ -4,6 +4,7 @@ require 'spec_helper'
 
 RSpec.describe 'query terraform states' do
   include GraphqlHelpers
+  include ::API::Helpers::RelatedResourcesHelpers
 
   let_it_be(:project) { create(:project) }
   let_it_be(:terraform_state) { create(:terraform_state, :with_version, :locked, project: project) }
@@ -23,6 +24,8 @@ RSpec.describe 'query terraform states' do
 
           latestVersion {
             id
+            downloadPath
+            serial
             createdAt
             updatedAt
 
@@ -62,6 +65,16 @@ RSpec.describe 'query terraform states' do
     expect(state.dig('lockedByUser', 'id')).to eq(terraform_state.locked_by_user.to_global_id.to_s)
 
     expect(version['id']).to eq(latest_version.to_global_id.to_s)
+    expect(version['serial']).to eq(latest_version.version)
+    expect(version['downloadPath']).to eq(
+      expose_path(
+        api_v4_projects_terraform_state_versions_path(
+          id: project.id,
+          name: terraform_state.name,
+          serial: latest_version.version
+        )
+      )
+    )
     expect(version['createdAt']).to eq(latest_version.created_at.iso8601)
     expect(version['updatedAt']).to eq(latest_version.updated_at.iso8601)
     expect(version.dig('createdByUser', 'id')).to eq(latest_version.created_by_user.to_global_id.to_s)