Merge branch '216451-add-package_name-as-option-to-group-packages-api' into 'master'

Add package_name param to group packages API

See merge request gitlab-org/gitlab!30980

doc/api/packages.md

@@ -68,6 +68,7 @@ GET /groups/:id/packages
 | `order_by`| string | no | The field to use as order. One of `created_at` (default), `name`, `version`, `type`, or `project_path`. |
 | `sort`    | string | no | The direction of the order, either `asc` (default) for ascending order or `desc` for descending order. |
 | `package_type` | string | no | Filter the returned packages by type. One of `conan`, `maven`, `npm`, `pypi` or `nuget`. (_Introduced in GitLab 12.9_) |
+| `package_name` | string | no | Filter the project packages with a fuzzy search by name. (_[Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/30980) in GitLab 13.0_)
 
 ```shell
 curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/packages?exclude_subgroups=true

ee/app/finders/packages/group_packages_finder.rb

@@ -4,6 +4,8 @@ module Packages
   class GroupPackagesFinder
     attr_reader :current_user, :group, :params
 
+    InvalidPackageTypeError = Class.new(StandardError)
+
     def initialize(current_user, group, params = { exclude_subgroups: false, order_by: 'created_at', sort: 'asc' })
       @current_user = current_user
       @group = group
@@ -25,9 +27,9 @@ module Packages
         .has_version
         .sort_by_attribute("#{params[:order_by]}_#{params[:sort]}")
 
-      return packages unless package_type
-
-      packages.with_package_type(package_type)
+      packages = filter_by_package_type(packages)
+      packages = filter_by_package_name(packages)
+      packages
     end
 
     def group_projects_visible_to_current_user
@@ -39,7 +41,7 @@ module Packages
     end
 
     def package_type
-      @params[:package_type].presence
+      params[:package_type].presence
     end
 
     def groups
@@ -51,5 +53,18 @@ module Packages
     def exclude_subgroups?
       params[:exclude_subgroups]
     end
+
+    def filter_by_package_type(packages)
+      return packages unless package_type
+      raise InvalidPackageTypeError unless Package.package_types.key?(package_type)
+
+      packages.with_package_type(package_type)
+    end
+
+    def filter_by_package_name(packages)
+      return packages unless params[:package_name].present?
+
+      packages.search_by_name(params[:package_name])
+    end
   end
 end

ee/changelogs/unreleased/216451-add-package_name-as-option-to-group-packages-api.yml

+---
+title: Adds package_name filter to group packages API
+merge_request: 30980
+author:
+type: added

ee/lib/api/group_packages.rb

@@ -27,12 +27,14 @@ module API
                         desc: 'Return packages sorted in `asc` or `desc` order.'
         optional :package_type, type: String, values: Packages::Package.package_types.keys,
                                 desc: 'Return packages of a certain type'
+        optional :package_name, type: String,
+                                desc: 'Return packages with this name'
       end
       get ':id/packages' do
         packages = Packages::GroupPackagesFinder.new(
           current_user,
           user_group,
-          declared(params).slice(:exclude_subgroups, :order_by, :sort, :package_type)
+          declared(params).slice(:exclude_subgroups, :order_by, :sort, :package_type, :package_name)
         ).execute
 
         present paginate(packages), with: EE::API::Entities::Package, user: current_user, group: true

ee/spec/finders/packages/group_packages_finder_spec.rb

@@ -2,9 +2,9 @@
 require 'spec_helper'
 
 describe Packages::GroupPackagesFinder do
-  let(:user)     { create(:user) }
-  let(:group)    { create(:group) }
-  let(:project)  { create(:project, namespace: group) }
+  let_it_be(:user)     { create(:user) }
+  let_it_be(:group)    { create(:group) }
+  let_it_be(:project)  { create(:project, namespace: group) }
   let(:another_group) { create(:group) }
 
   before do
@@ -58,6 +58,25 @@ describe Packages::GroupPackagesFinder do
 
         it { is_expected.not_to include(package_without_version) }
       end
+
+      context 'with package_name' do
+        let_it_be(:named_package) { create(:maven_package, project: project, name: 'maven') }
+        let(:params) { { package_name: package_name } }
+
+        context 'as complete name' do
+          let(:package_name) { 'maven' }
+
+          it { is_expected.to eq([named_package]) }
+        end
+
+        %w[aven mav ave].each do |filter|
+          context "for fuzzy filter #{filter}" do
+            let(:package_name) { filter }
+
+            it { is_expected.to eq([named_package]) }
+          end
+        end
+      end
     end
 
     context 'group has package of all types' do
@@ -86,6 +105,12 @@ describe Packages::GroupPackagesFinder do
       it { is_expected.to match_array([package1])}
     end
 
+    context 'with invalid package_type' do
+      let(:params) { { package_type: 'invalid_type' } }
+
+      it { expect { subject }.to raise_exception(described_class::InvalidPackageTypeError) }
+    end
+
     context 'when project is public' do
       let_it_be(:other_user) { create(:user) }
       let(:finder) { described_class.new(other_user, group) }