debian-mirror-gitlab/spec/requests/api/graphql/packages/package_spec.rb

# frozen_string_literal: true
require 'spec_helper'

RSpec.describe 'package details' do
  include GraphqlHelpers

  let_it_be(:project) { create(:project) }
  let_it_be(:composer_package) { create(:composer_package, project: project) }
  let_it_be(:composer_json) { { name: 'name', type: 'type', license: 'license', version: 1 } }
  let_it_be(:composer_metadatum) do
    # we are forced to manually create the metadatum, without using the factory to force the sha to be a string
    # and avoid an error where gitaly can't find the repository
    create(:composer_metadatum, package: composer_package, target_sha: 'foo_sha', composer_json: composer_json)
  end

  let(:depth) { 3 }
  let(:excluded) { %w[metadata apiFuzzingCiConfiguration pipeline packageFiles] }
  let(:metadata) { query_graphql_fragment('ComposerMetadata') }
  let(:package_files) {all_graphql_fields_for('PackageFile')}
  let(:package_files_metadata) {query_graphql_fragment('ConanFileMetadata')}

  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}
        fileMetadata {
          #{package_files_metadata}
        }
      }
    }
    FIELDS
  end

  let(:user) { project.owner }
  let(:package_global_id) { global_id_of(composer_package) }
  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(:first_file_response_metadata) { graphql_data_at(:package, :package_files, :nodes, 0, :file_metadata)}

  subject { post_graphql(query, current_user: user) }

  it_behaves_like 'a working graphql query' do
    before do
      subject
    end

    it 'matches the JSON schema' do
      expect(package_details).to match_schema('graphql/packages/package_details')
    end
  end

  describe 'Packages Metadata' do
    before do
      subject
    end

    describe 'Composer' do
      it 'has the correct metadata' do
        expect(metadata_response).to include(
          'targetSha' => 'foo_sha',
          'composerJson' => composer_json.transform_keys(&:to_s).transform_values(&:to_s)
        )
      end

      it 'does not have files' do
        expect(package_files_response).to be_empty
      end
    end

    describe 'Conan' do
      let_it_be(:conan_package) { create(:conan_package, project: project) }

      let(:package_global_id) { global_id_of(conan_package) }
      let(:metadata) { query_graphql_fragment('ConanMetadata') }
      let(:first_file) { conan_package.package_files.find { |f| global_id_of(f) == first_file_response['id'] } }

      it 'has the correct metadata' do
        expect(metadata_response).to include(
          'id' => global_id_of(conan_package.conan_metadatum),
          'recipe' => conan_package.conan_metadatum.recipe,
          'packageChannel' => conan_package.conan_metadatum.package_channel,
          'packageUsername' => conan_package.conan_metadatum.package_username,
          'recipePath' => conan_package.conan_metadatum.recipe_path
        )
      end

      it 'has the right amount of files' do
        expect(package_files_response.length).to be(conan_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

      it 'has the correct file metadata' do
        expect(first_file_response_metadata).to include(
          'id' =>  global_id_of(first_file.conan_file_metadatum),
          'packageRevision' => first_file.conan_file_metadatum.package_revision,
          'conanPackageReference' => first_file.conan_file_metadatum.conan_package_reference,
          'recipeRevision' => first_file.conan_file_metadatum.recipe_revision,
          'conanFileType' => first_file.conan_file_metadatum.conan_file_type.upcase
        )
      end
    end
  end

  context 'there are other versions of this package' do
    let(:depth) { 3 }
    let(:excluded) { %w[metadata project tags pipelines] } # to limit the query complexity

    let_it_be(:siblings) { create_list(:composer_package, 2, project: project, name: composer_package.name) }

    it 'includes the sibling versions' do
      subject

      expect(graphql_data_at(:package, :versions, :nodes)).to match_array(
        siblings.map { |p| a_hash_including('id' => global_id_of(p)) }
      )
    end

    context 'going deeper' do
      let(:depth) { 6 }

      it 'does not create a cycle of versions' do
        subject

        expect(graphql_data_at(:package, :versions, :nodes, :version)).to be_present
        expect(graphql_data_at(:package, :versions, :nodes, :versions, :nodes)).to be_empty
      end
    end
  end

  context 'with a batched query' do
    let_it_be(:conan_package) { create(:conan_package, project: project) }

    let(:batch_query) do
      <<~QUERY
      {
        a: package(id: "#{global_id_of(composer_package)}") { name }
        b: package(id: "#{global_id_of(conan_package)}") { name }
      }
      QUERY
    end

    let(:a_packages_names) { graphql_data_at(:a, :packages, :nodes, :name) }

    it 'returns an error for the second package and data for the first' do
      post_graphql(batch_query, current_user: user)

      expect(graphql_data_at(:a, :name)).to eq(composer_package.name)

      expect_graphql_errors_to_include [/Package details can be requested only for one package at a time/]
      expect(graphql_data_at(:b)).to be(nil)
    end
  end
end