Merge branch '285467-package-registry-graphql-api' into 'master'

Add Maven to Package Graphql types

See merge request gitlab-org/gitlab!60808

app/graphql/types/packages/maven/metadatum_type.rb

+# frozen_string_literal: true
+
+module Types
+  module Packages
+    module Maven
+      class MetadatumType < BaseObject
+        graphql_name 'MavenMetadata'
+        description 'Maven metadata'
+
+        authorize :read_package
+
+        field :id, ::Types::GlobalIDType[::Packages::Maven::Metadatum], null: false, description: 'ID of the metadatum.'
+        field :created_at, Types::TimeType, null: false, description: 'Date of creation.'
+        field :updated_at, Types::TimeType, null: false, description: 'Date of most recent update.'
+        field :path, GraphQL::STRING_TYPE, null: false, description: 'Path of the Maven package.'
+        field :app_group, GraphQL::STRING_TYPE, null: false, description: 'App group of the Maven package.'
+        field :app_version, GraphQL::STRING_TYPE, null: true, description: 'App version of the Maven package.'
+        field :app_name, GraphQL::STRING_TYPE, null: false, description: 'App name of the Maven package.'
+      end
+    end
+  end
+end

app/graphql/types/packages/metadata_type.rb

@@ -6,7 +6,7 @@ module Types
       graphql_name 'PackageMetadata'
       description 'Represents metadata associated with a Package'
 
-      possible_types ::Types::Packages::Composer::MetadatumType, ::Types::Packages::Conan::MetadatumType
+      possible_types ::Types::Packages::Composer::MetadatumType, ::Types::Packages::Conan::MetadatumType, ::Types::Packages::Maven::MetadatumType
 
       def self.resolve_type(object, context)
         case object
@@ -14,6 +14,8 @@ module Types
           ::Types::Packages::Composer::MetadatumType
         when ::Packages::Conan::Metadatum
           ::Types::Packages::Conan::MetadatumType
+        when ::Packages::Maven::Metadatum
+          ::Types::Packages::Maven::MetadatumType
         else
           # NOTE: This method must be kept in sync with `PackageWithoutVersionsType#metadata`,
           # which must never produce data that this discriminator cannot handle.

app/graphql/types/packages/package_type.rb

@@ -44,6 +44,8 @@ module Types
           object.composer_metadatum
         when 'conan'
           object.conan_metadatum
+        when 'maven'
+          object.maven_metadatum
         else
           nil
         end

app/policies/packages/maven/metadatum_policy.rb

+# frozen_string_literal: true
+module Packages
+  module Maven
+    class MetadatumPolicy < BasePolicy
+      delegate { @subject.package }
+    end
+  end
+end

changelogs/unreleased/285467-package-registry-graphql-api.yml

+---
+title: Add Maven to Package Graphql types
+merge_request: 60808
+author:
+type: added

doc/api/graphql/reference/index.md

@@ -9551,6 +9551,22 @@ Represents an entry from the Cloud License history.
 | <a id="licensehistoryentrytype"></a>`type` | [`String!`](#string) | Type of the license. |
 | <a id="licensehistoryentryusersinlicensecount"></a>`usersInLicenseCount` | [`Int`](#int) | Number of paid users in the license. |
 
+### `MavenMetadata`
+
+Maven metadata.
+
+#### Fields
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| <a id="mavenmetadataappgroup"></a>`appGroup` | [`String!`](#string) | App group of the Maven package. |
+| <a id="mavenmetadataappname"></a>`appName` | [`String!`](#string) | App name of the Maven package. |
+| <a id="mavenmetadataappversion"></a>`appVersion` | [`String`](#string) | App version of the Maven package. |
+| <a id="mavenmetadatacreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. |
+| <a id="mavenmetadataid"></a>`id` | [`PackagesMavenMetadatumID!`](#packagesmavenmetadatumid) | ID of the metadatum. |
+| <a id="mavenmetadatapath"></a>`path` | [`String!`](#string) | Path of the Maven package. |
+| <a id="mavenmetadataupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. |
+
 ### `MergeRequest`
 
 #### Fields
@@ -14780,6 +14796,12 @@ A `PackagesConanMetadatumID` is a global ID. It is encoded as a string.
 
 An example `PackagesConanMetadatumID` is: `"gid://gitlab/Packages::Conan::Metadatum/1"`.
 
+### `PackagesMavenMetadatumID`
+
+A `PackagesMavenMetadatumID` is a global ID. It is encoded as a string.
+
+An example `PackagesMavenMetadatumID` is: `"gid://gitlab/Packages::Maven::Metadatum/1"`.
+
 ### `PackagesPackageFileID`
 
 A `PackagesPackageFileID` is a global ID. It is encoded as a string.
@@ -14915,6 +14937,7 @@ One of:
 
 - [`ComposerMetadata`](#composermetadata)
 - [`ConanMetadata`](#conanmetadata)
+- [`MavenMetadata`](#mavenmetadata)
 
 #### `VulnerabilityDetail`
 

spec/fixtures/api/schemas/graphql/packages/package_details.json

@@ -80,6 +80,7 @@
       "anyOf": [
         { "$ref": "./package_composer_metadata.json" },
         { "$ref": "./package_conan_metadata.json" },
+        { "$ref": "./package_maven_metadata.json" },
         { "type": "null" }
       ]
     },

spec/fixtures/api/schemas/graphql/packages/package_maven_metadata.json

+{
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["id", "createdAt", "updatedAt", "path", "appGroup", "appName"],
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "createdAt": {
+      "type": "string"
+    },
+    "updatedAt": {
+      "type": "string"
+    },
+    "path": {
+      "type": "string"
+    },
+    "appGroup": {
+      "type": "string"
+    },
+    "appVersion": {
+      "type": ["string", "null"]
+    },
+    "appName": {
+      "type": "string"
+    }
+  }
+}

spec/requests/api/graphql/packages/maven_spec.rb

+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe 'maven package details' do
+  include GraphqlHelpers
+
+  let_it_be(:project) { create(:project) }
+  let_it_be(:maven_package) { create(:maven_package, project: project) }
+
+  let(:package_global_id) { global_id_of(maven_package) }
+  let(:metadata) { query_graphql_fragment('MavenMetadata') }
+  let(:first_file) { maven_package.package_files.find { |f| global_id_of(f) == first_file_response['id'] } }
+
+  let(:depth) { 3 }
+  let(:excluded) { %w[metadata apiFuzzingCiConfiguration pipeline packageFiles] }
+  let(:package_files) { all_graphql_fields_for('PackageFile') }
+
+  let(:user) { project.owner }
+  let(:package_details) { graphql_data_at(:package) }
+  let(:metadata_response) { graphql_data_at(:package, :metadata) }
+  let(:package_files_response) { graphql_data_at(:package, :package_files, :nodes) }
+  let(:first_file_response) { graphql_data_at(:package, :package_files, :nodes, 0)}
+
+  let(:query) do
+    graphql_query_for(:package, { id: package_global_id }, <<~FIELDS)
+    #{all_graphql_fields_for('PackageDetailsType', max_depth: depth, excluded: excluded)}
+    metadata {
+      #{metadata}
+    }
+    packageFiles {
+      nodes {
+        #{package_files}
+      }
+    }
+    FIELDS
+  end
+
+  subject { post_graphql(query, current_user: user) }
+
+  shared_examples 'a working maven package' do
+    before do
+      subject
+    end
+
+    it_behaves_like 'a working graphql query' do
+      it 'matches the JSON schema' do
+        expect(package_details).to match_schema('graphql/packages/package_details')
+      end
+    end
+
+    it 'has the correct metadata' do
+      expect(metadata_response).to include(
+        'id' => global_id_of(maven_package.maven_metadatum),
+        'path' => maven_package.maven_metadatum.path,
+        'appGroup' => maven_package.maven_metadatum.app_group,
+        'appVersion' => maven_package.maven_metadatum.app_version,
+        'appName' => maven_package.maven_metadatum.app_name
+      )
+    end
+
+    it 'has the right amount of files' do
+      expect(package_files_response.length).to be(maven_package.package_files.length)
+    end
+
+    it 'has the basic package files data' do
+      expect(first_file_response).to include(
+        'id' => global_id_of(first_file),
+        'fileName' => first_file.file_name,
+        'size' => first_file.size.to_s,
+        'downloadPath' => first_file.download_path,
+        'fileSha1' => first_file.file_sha1,
+        'fileMd5' => first_file.file_md5,
+        'fileSha256' => first_file.file_sha256
+      )
+    end
+  end
+
+  context 'a maven package with version' do
+    it_behaves_like "a working maven package"
+  end
+
+  context 'a versionless maven package' do
+    let_it_be(:maven_metadatum) { create(:maven_metadatum, app_version: nil) }
+    let_it_be(:maven_package) { create(:maven_package, project: project, version: nil, maven_metadatum: maven_metadatum) }
+
+    it_behaves_like "a working maven package"
+
+    it "has an empty version" do
+      subject
+
+      expect(metadata_response['appVersion']).to eq(nil)
+    end
+  end
+end