Organize package models by package type

changelogs/unreleased/sk-organize-package-models.yml

+---
+title: Organize package models by package type
+merge_request: 31346
+author: Sashi Kumar
+type: other

doc/development/packages.md

@@ -196,8 +196,8 @@ information like the file `name`, `side`, `sha1`, etc.
 
 If there is specific data necessary to be stored for only one package system support,
 consider creating a separate metadata model. See `packages_maven_metadata` table
-and `Packages::MavenMetadatum` model as an example for package specific data, and `packages_conan_file_metadata` table
-and `Packages::ConanFileMetadatum` model as an example for package file specific data.
+and `Packages::Maven::Metadatum` model as an example for package specific data, and `packages_conan_file_metadata` table
+and `Packages::Conan::FileMetadatum` model as an example for package file specific data.
 
 If there is package specific behavior for a given package manager, add those methods to the metadata models and
 delegate from the package model.

ee/app/models/packages/conan.rb

+# frozen_string_literal: true
+module Packages
+  module Conan
+    def self.table_name_prefix
+      'packages_conan_'
+    end
+  end
+end

ee/app/models/packages/conan_file_metadatum.rb → ee/app/models/packages/conan/file_metadatum.rb

 # frozen_string_literal: true
 
-class Packages::ConanFileMetadatum < ApplicationRecord
+class Packages::Conan::FileMetadatum < ApplicationRecord
   belongs_to :package_file, inverse_of: :conan_file_metadatum
 
   validates :package_file, presence: true

ee/app/models/packages/conan_metadatum.rb → ee/app/models/packages/conan/metadatum.rb

 # frozen_string_literal: true
 
-class Packages::ConanMetadatum < ApplicationRecord
+class Packages::Conan::Metadatum < ApplicationRecord
   belongs_to :package, -> { where(package_type: :conan) }, inverse_of: :conan_metadatum
 
   validates :package, presence: true

ee/app/models/packages/dependency_link.rb

@@ -2,7 +2,7 @@
 class Packages::DependencyLink < ApplicationRecord
   belongs_to :package, inverse_of: :dependency_links
   belongs_to :dependency, inverse_of: :dependency_links, class_name: 'Packages::Dependency'
-  has_one :nuget_metadatum, inverse_of: :dependency_link, class_name: 'Packages::NugetDependencyLinkMetadatum'
+  has_one :nuget_metadatum, inverse_of: :dependency_link, class_name: 'Packages::Nuget::DependencyLinkMetadatum'
 
   validates :package, :dependency, presence: true
 

ee/app/models/packages/maven.rb

+# frozen_string_literal: true
+module Packages
+  module Maven
+    def self.table_name_prefix
+      'packages_maven_'
+    end
+  end
+end

ee/app/models/packages/maven_metadatum.rb → ee/app/models/packages/maven/metadatum.rb

 # frozen_string_literal: true
-class Packages::MavenMetadatum < ApplicationRecord
+class Packages::Maven::Metadatum < ApplicationRecord
   belongs_to :package, -> { where(package_type: :maven) }
 
   validates :package, presence: true

ee/app/models/packages/nuget.rb

+# frozen_string_literal: true
+module Packages
+  module Nuget
+    def self.table_name_prefix
+      'packages_nuget_'
+    end
+  end
+end

ee/app/models/packages/nuget_dependency_link_metadatum.rb → ee/app/models/packages/nuget/dependency_link_metadatum.rb

 # frozen_string_literal: true
 
-class Packages::NugetDependencyLinkMetadatum < ApplicationRecord
+class Packages::Nuget::DependencyLinkMetadatum < ApplicationRecord
   self.primary_key = :dependency_link_id
 
   belongs_to :dependency_link, inverse_of: :nuget_metadatum

ee/app/models/packages/package.rb

@@ -9,9 +9,9 @@ class Packages::Package < ApplicationRecord
   has_many :package_files, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
   has_many :dependency_links, inverse_of: :package, class_name: 'Packages::DependencyLink'
   has_many :tags, inverse_of: :package, class_name: 'Packages::Tag'
-  has_one :conan_metadatum, inverse_of: :package
-  has_one :pypi_metadatum, inverse_of: :package
-  has_one :maven_metadatum, inverse_of: :package
+  has_one :conan_metadatum, inverse_of: :package, class_name: 'Packages::Conan::Metadatum'
+  has_one :pypi_metadatum, inverse_of: :package, class_name: 'Packages::Pypi::Metadatum'
+  has_one :maven_metadatum, inverse_of: :package, class_name: 'Packages::Maven::Metadatum'
   has_one :build_info, inverse_of: :package
 
   accepts_nested_attributes_for :conan_metadatum

ee/app/models/packages/package_file.rb

@@ -8,7 +8,7 @@ class Packages::PackageFile < ApplicationRecord
 
   belongs_to :package
 
-  has_one :conan_file_metadatum, inverse_of: :package_file
+  has_one :conan_file_metadatum, inverse_of: :package_file, class_name: 'Packages::Conan::FileMetadatum'
 
   accepts_nested_attributes_for :conan_file_metadatum
 
@@ -24,7 +24,7 @@ class Packages::PackageFile < ApplicationRecord
 
   scope :with_conan_file_type, ->(file_type) do
     joins(:conan_file_metadatum)
-      .where(packages_conan_file_metadata: { conan_file_type: ::Packages::ConanFileMetadatum.conan_file_types[file_type] })
+      .where(packages_conan_file_metadata: { conan_file_type: ::Packages::Conan::FileMetadatum.conan_file_types[file_type] })
   end
 
   scope :with_conan_package_reference, ->(conan_package_reference) do

ee/app/models/packages/pypi.rb

+# frozen_string_literal: true
+module Packages
+  module Pypi
+    def self.table_name_prefix
+      'packages_pypi_'
+    end
+  end
+end

ee/app/models/packages/pypi_metadatum.rb → ee/app/models/packages/pypi/metadatum.rb

 # frozen_string_literal: true
 
-class Packages::PypiMetadatum < ApplicationRecord
+class Packages::Pypi::Metadatum < ApplicationRecord
   self.primary_key = :package_id
 
   belongs_to :package, -> { where(package_type: :pypi) }, inverse_of: :pypi_metadatum

ee/app/services/packages/conan/search_service.rb

@@ -42,7 +42,7 @@ module Packages
 
       def search_for_single_package(query)
         name, version, username, _ = query.split(/[@\/]/)
-        full_path = Packages::ConanMetadatum.full_path_from(package_username: username)
+        full_path = Packages::Conan::Metadatum.full_path_from(package_username: username)
         project = Project.find_by_full_path(full_path)
         return unless current_user.can?(:read_package, project)
 

ee/app/services/packages/nuget/create_dependency_service.rb

@@ -41,7 +41,7 @@ module Packages
           }
         end
 
-        ::Gitlab::Database.bulk_insert(::Packages::NugetDependencyLinkMetadatum.table_name, rows.compact)
+        ::Gitlab::Database.bulk_insert(::Packages::Nuget::DependencyLinkMetadatum.table_name, rows.compact)
       end
 
       def raw_dependency_for(dependency)

ee/app/services/packages/pypi/create_package_service.rb

@@ -7,7 +7,7 @@ module Packages
 
       def execute
         ::Packages::Package.transaction do
-          Packages::PypiMetadatum.upsert(
+          Packages::Pypi::Metadatum.upsert(
             package_id: created_package.id,
             required_python: params[:requires_python]
           )

ee/db/fixtures/development/26_packages.rb

@@ -64,7 +64,7 @@ class Gitlab::Seeder::Packages
       params = {
         package_name: name,
         package_version: version,
-        package_username: ::Packages::ConanMetadatum.package_username_from(full_path: project.full_path),
+        package_username: ::Packages::Conan::Metadatum.package_username_from(full_path: project.full_path),
         package_channel: 'stable'
       }
 

ee/lib/api/conan_packages.rb

@@ -193,7 +193,7 @@ module API
           authorize!(:read_package, project)
 
           status 200
-          upload_urls = package_upload_urls(::Packages::ConanFileMetadatum::PACKAGE_FILES)
+          upload_urls = package_upload_urls(::Packages::Conan::FileMetadatum::PACKAGE_FILES)
 
           present upload_urls, with: EE::API::Entities::ConanPackage::ConanUploadUrls
         end
@@ -206,7 +206,7 @@ module API
           authorize!(:read_package, project)
 
           status 200
-          upload_urls = recipe_upload_urls(::Packages::ConanFileMetadatum::RECIPE_FILES)
+          upload_urls = recipe_upload_urls(::Packages::Conan::FileMetadatum::RECIPE_FILES)
 
           present upload_urls, with: EE::API::Entities::ConanPackage::ConanUploadUrls
         end

ee/lib/api/helpers/packages/conan/api_helpers.rb

@@ -78,7 +78,7 @@ module API
 
           def project
             strong_memoize(:project) do
-              full_path = ::Packages::ConanMetadatum.full_path_from(package_username: params[:package_username])
+              full_path = ::Packages::Conan::Metadatum.full_path_from(package_username: params[:package_username])
               Project.find_by_full_path(full_path)
             end
           end
@@ -105,7 +105,7 @@ module API
                 conan_package_reference: params[:conan_package_reference]
               ).execute!
 
-            track_event('pull_package') if params[:file_name] == ::Packages::ConanFileMetadatum::PACKAGE_BINARY
+            track_event('pull_package') if params[:file_name] == ::Packages::Conan::FileMetadatum::PACKAGE_BINARY
 
             present_carrierwave_file!(package_file.file)
           end
@@ -115,7 +115,7 @@ module API
           end
 
           def track_push_package_event
-            if params[:file_name] == ::Packages::ConanFileMetadatum::PACKAGE_BINARY && params['file.size'].positive?
+            if params[:file_name] == ::Packages::Conan::FileMetadatum::PACKAGE_BINARY && params['file.size'].positive?
               track_event('push_package')
             end
           end

ee/lib/ee/gitlab/regex.rb

@@ -8,7 +8,7 @@ module EE
       class_methods do
         def conan_file_name_regex
           @conan_file_name_regex ||=
-            %r{\A#{(::Packages::ConanFileMetadatum::RECIPE_FILES + ::Packages::ConanFileMetadatum::PACKAGE_FILES).join("|")}\z}.freeze
+            %r{\A#{(::Packages::Conan::FileMetadatum::RECIPE_FILES + ::Packages::Conan::FileMetadatum::PACKAGE_FILES).join("|")}\z}.freeze
         end
 
         def conan_package_reference_regex

ee/spec/factories/packages.rb

@@ -71,7 +71,7 @@ FactoryBot.define do
       conan_metadatum
 
       after :build do |package|
-        package.conan_metadatum.package_username = Packages::ConanMetadatum.package_username_from(
+        package.conan_metadatum.package_username = Packages::Conan::Metadatum.package_username_from(
           full_path: package.project.full_path
         )
       end
@@ -223,7 +223,7 @@ FactoryBot.define do
     end
   end
 
-  factory :maven_metadatum, class: 'Packages::MavenMetadatum' do
+  factory :maven_metadatum, class: 'Packages::Maven::Metadatum' do
     association :package, package_type: :maven
     path { 'my/company/app/my-app/1.0-SNAPSHOT' }
     app_group { 'my.company.app' }
@@ -231,18 +231,18 @@ FactoryBot.define do
     app_version { '1.0-SNAPSHOT' }
   end
 
-  factory :conan_metadatum, class: 'Packages::ConanMetadatum' do
+  factory :conan_metadatum, class: 'Packages::Conan::Metadatum' do
     association :package, factory: [:conan_package, :without_loaded_metadatum]
     package_username { 'username' }
     package_channel { 'stable' }
   end
 
-  factory :pypi_metadatum, class: 'Packages::PypiMetadatum' do
+  factory :pypi_metadatum, class: 'Packages::Pypi::Metadatum' do
     association :package, package_type: :pypi
     required_python { '>=2.7' }
   end
 
-  factory :conan_file_metadatum, class: 'Packages::ConanFileMetadatum' do
+  factory :conan_file_metadatum, class: 'Packages::Conan::FileMetadatum' do
     package_file
     recipe_revision { '0' }
 
@@ -274,7 +274,7 @@ FactoryBot.define do
     end
   end
 
-  factory :nuget_dependency_link_metadatum, class: 'Packages::NugetDependencyLinkMetadatum' do
+  factory :nuget_dependency_link_metadatum, class: 'Packages::Nuget::DependencyLinkMetadatum' do
     target_framework { '.NETStandard2.0' }
   end
 

ee/spec/models/packages/conan_file_metadatum_spec.rb → ee/spec/models/packages/conan/file_metadatum_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-RSpec.describe Packages::ConanFileMetadatum, type: :model do
+RSpec.describe Packages::Conan::FileMetadatum, type: :model do
   describe 'relationships' do
     it { is_expected.to belong_to(:package_file) }
   end

ee/spec/models/packages/conan_metadatum_spec.rb → ee/spec/models/packages/conan/metadatum_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-RSpec.describe Packages::ConanMetadatum, type: :model do
+RSpec.describe Packages::Conan::Metadatum, type: :model do
   describe 'relationships' do
     it { is_expected.to belong_to(:package) }
   end

ee/spec/models/packages/maven_metadatum_spec.rb → ee/spec/models/packages/maven/metadatum_spec.rb

 # frozen_string_literal: true
 require 'spec_helper'
 
-RSpec.describe Packages::MavenMetadatum, type: :model do
+RSpec.describe Packages::Maven::Metadatum, type: :model do
   describe 'relationships' do
     it { is_expected.to belong_to(:package) }
   end

ee/spec/models/packages/nuget_dependency_link_metadatum_spec.rb → ee/spec/models/packages/nuget/dependency_link_metadatum_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-RSpec.describe Packages::NugetDependencyLinkMetadatum, type: :model do
+RSpec.describe Packages::Nuget::DependencyLinkMetadatum, type: :model do
   describe 'relationships' do
     it { is_expected.to belong_to(:dependency_link) }
   end

ee/spec/models/packages/package_spec.rb

@@ -267,7 +267,7 @@ RSpec.describe Packages::Package, type: :model do
     describe '.with_conan_username' do
       subject do
         described_class.with_conan_username(
-          Packages::ConanMetadatum.package_username_from(full_path: package.project.full_path)
+          Packages::Conan::Metadatum.package_username_from(full_path: package.project.full_path)
         )
       end
 

ee/spec/models/packages/pypi/metadatum_spec.rb

+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Packages::Pypi::Metadatum, type: :model do
+  describe 'relationships' do
+    it { is_expected.to belong_to(:package) }
+  end
+
+  describe 'validations' do
+    it { is_expected.to validate_presence_of(:package) }
+  end
+end

ee/spec/requests/api/conan_packages_spec.rb

@@ -218,7 +218,7 @@ describe API::ConanPackages do
   shared_examples 'rejects recipe for not found package' do
     context 'with invalid recipe path' do
       let(:recipe_path) do
-        'aa/bb/%{project}/ccc' % { project: ::Packages::ConanMetadatum.package_username_from(full_path: project.full_path) }
+        'aa/bb/%{project}/ccc' % { project: ::Packages::Conan::Metadatum.package_username_from(full_path: project.full_path) }
       end
 
       it 'returns not found' do
@@ -232,13 +232,13 @@ describe API::ConanPackages do
   shared_examples 'empty recipe for not found package' do
     context 'with invalid recipe url' do
       let(:recipe_path) do
-        'aa/bb/%{project}/ccc' % { project: ::Packages::ConanMetadatum.package_username_from(full_path: project.full_path) }
+        'aa/bb/%{project}/ccc' % { project: ::Packages::Conan::Metadatum.package_username_from(full_path: project.full_path) }
       end
 
       it 'returns not found' do
         allow(::Packages::Conan::PackagePresenter).to receive(:new)
           .with(
-            'aa/bb@%{project}/ccc' % { project: ::Packages::ConanMetadatum.package_username_from(full_path: project.full_path) },
+            'aa/bb@%{project}/ccc' % { project: ::Packages::Conan::Metadatum.package_username_from(full_path: project.full_path) },
             user,
             project,
             any_args
@@ -568,7 +568,7 @@ describe API::ConanPackages do
       it_behaves_like 'a project is not found'
 
       context 'tracking the conan_package.tgz download' do
-        let(:package_file) { package.package_files.find_by(file_name: ::Packages::ConanFileMetadatum::PACKAGE_BINARY) }
+        let(:package_file) { package.package_files.find_by(file_name: ::Packages::Conan::FileMetadatum::PACKAGE_BINARY) }
 
         it_behaves_like 'a gitlab tracking event', described_class.name, 'pull_package'
       end
@@ -802,7 +802,7 @@ describe API::ConanPackages do
       it_behaves_like 'rejects invalid recipe'
       it_behaves_like 'uploads a package file'
       context 'tracking the conan_package.tgz upload' do
-        let(:file_name) { ::Packages::ConanFileMetadatum::PACKAGE_BINARY }
+        let(:file_name) { ::Packages::Conan::FileMetadatum::PACKAGE_BINARY }
 
         it_behaves_like 'a gitlab tracking event', described_class.name, 'push_package'
       end

ee/spec/requests/api/maven_packages_spec.rb

@@ -517,7 +517,7 @@ describe API::MavenPackages do
 
       it 'creates package and stores package file' do
         expect { upload_file_with_token(params) }.to change { project.packages.count }.by(1)
-          .and change { Packages::MavenMetadatum.count }.by(1)
+          .and change { Packages::Maven::Metadatum.count }.by(1)
           .and change { Packages::PackageFile.count }.by(1)
 
         expect(response).to have_gitlab_http_status(:ok)

ee/spec/services/packages/conan/create_package_service_spec.rb

@@ -13,7 +13,7 @@ describe Packages::Conan::CreatePackageService do
         {
           package_name: 'my-pkg',
           package_version: '1.0.0',
-          package_username: ::Packages::ConanMetadatum.package_username_from(full_path: project.full_path),
+          package_username: ::Packages::Conan::Metadatum.package_username_from(full_path: project.full_path),
           package_channel: 'stable'
         }
       end

ee/spec/services/packages/nuget/create_dependency_service_spec.rb

@@ -12,7 +12,7 @@ describe Packages::Nuget::CreateDependencyService do
         expect { subject }
           .to change { Packages::Dependency.count }.by(dependency_count)
           .and change { Packages::DependencyLink.count }.by(dependency_link_count)
-          .and change { Packages::NugetDependencyLinkMetadatum.count }.by(dependencies_with_metadata.size)
+          .and change { Packages::Nuget::DependencyLinkMetadatum.count }.by(dependencies_with_metadata.size)
         expect(expected_dependency_names).to contain_exactly(*dependency_names)
         expect(package.dependency_links.map(&:dependency_type).uniq).to contain_exactly('dependencies')
 

ee/spec/services/packages/nuget/update_package_from_metadata_service_spec.rb

@@ -37,7 +37,7 @@ describe Packages::Nuget::UpdatePackageFromMetadataService do
           .to change { ::Packages::Package.count }.by(-1)
           .and change { Packages::Dependency.count }.by(0)
           .and change { Packages::DependencyLink.count }.by(0)
-          .and change { Packages::NugetDependencyLinkMetadatum.count }.by(0)
+          .and change { Packages::Nuget::DependencyLinkMetadatum.count }.by(0)
         expect(package_file.reload.file_name).to eq(package_file_name)
         expect(package_file.package).to eq(existing_package)
       end
@@ -60,7 +60,7 @@ describe Packages::Nuget::UpdatePackageFromMetadataService do
           .to change { ::Packages::Package.count }.by(1)
           .and change { Packages::Dependency.count }.by(4)
           .and change { Packages::DependencyLink.count }.by(4)
-          .and change { Packages::NugetDependencyLinkMetadatum.count }.by(2)
+          .and change { Packages::Nuget::DependencyLinkMetadatum.count }.by(2)
 
         expect(package.reload.name).to eq(package_name)
         expect(package.version).to eq(package_version)

ee/spec/support/shared_examples/requests/api/pypi_packages_shared_examples.rb

@@ -6,7 +6,7 @@ RSpec.shared_examples 'PyPi package creation' do |user_type, status, add_member
       expect { subject }
           .to change { project.packages.pypi.count }.by(1)
           .and change { Packages::PackageFile.count }.by(1)
-          .and change { Packages::PypiMetadatum.count }.by(1)
+          .and change { Packages::Pypi::Metadatum.count }.by(1)
       expect(response).to have_gitlab_http_status(status)
 
       package = project.reload.packages.pypi.last