Api to get resources from one or multiple catalogs

This patch adds a catalogs params to query api and
which takes one or multiple catalogs name

Signed-off-by: Shiv Verma <[email protected]>

api/design/resource.go

@@ -32,12 +32,15 @@ var _ = Service("resource", func() {
 
 	// Will be deprecated, moved to v1
 	Method("Query", func() {
-		Description("Find resources by a combination of name, kind and tags")
+		Description("Find resources by a combination of name, kind , catalog and tags")
 		Payload(func() {
 			Attribute("name", String, "Name of resource", func() {
 				Default("")
 				Example("name", "buildah")
 			})
+			Attribute("catalogs", ArrayOf(String), "Catalogs of resource to filter by", func() {
+				Example([]string{"tekton", "openshift"})
+			})
 			Attribute("kinds", ArrayOf(String), "Kinds of resource to filter by", func() {
 				Example([]string{"task", "pipelines"})
 			})
@@ -60,6 +63,7 @@ var _ = Service("resource", func() {
 			GET("/query")
 
 			Param("name")
+			Param("catalogs")
 			Param("kinds")
 			Param("tags")
 			Param("limit")

api/gen/http/openapi.yaml

@@ -159,7 +159,7 @@ paths:
       tags:
       - resource
       summary: Query resource
-      description: Find resources by a combination of name, kind and tags
+      description: Find resources by a combination of name, kind , catalog and tags
       operationId: resource#Query
       parameters:
       - name: name
@@ -168,6 +168,14 @@ paths:
         required: false
         type: string
         default: ""
+      - name: catalogs
+        in: query
+        description: Catalogs of resource to filter by
+        required: false
+        type: array
+        items:
+          type: string
+        collectionFormat: multi
       - name: kinds
         in: query
         description: Kinds of resource to filter by

api/gen/http/openapi3.yaml

@@ -264,7 +264,7 @@ paths:
       tags:
       - resource
       summary: Query resource
-      description: Find resources by a combination of name, kind and tags
+      description: Find resources by a combination of name, kind , catalog and tags
       operationId: resource#Query
       parameters:
       - name: name
@@ -277,6 +277,22 @@ paths:
           default: ""
           example: buildah
         example: buildah
+      - name: catalogs
+        in: query
+        description: Catalogs of resource to filter by
+        allowEmptyValue: true
+        schema:
+          type: array
+          items:
+            type: string
+            example: Et at.
+          description: Catalogs of resource to filter by
+          example:
+          - tekton
+          - openshift
+        example:
+        - tekton
+        - openshift
       - name: kinds
         in: query
         description: Kinds of resource to filter by
@@ -285,7 +301,7 @@ paths:
           type: array
           items:
             type: string
-            example: Et at.
+            example: Aperiam tempore animi iure eum et et.
           description: Kinds of resource to filter by
           example:
           - task
@@ -301,7 +317,7 @@ paths:
           type: array
           items:
             type: string
-            example: Aperiam tempore animi iure eum et et.
+            example: Pariatur corrupti.
           description: Tags associated with a resource to filter by
           example:
           - image
@@ -327,11 +343,11 @@ paths:
           type: string
           description: Strategy used to find matching resources
           default: contains
-          example: exact
+          example: contains
           enum:
           - exact
           - contains
-        example: contains
+        example: exact
       responses:
         "200":
           description: OK response.
@@ -448,11 +464,11 @@ paths:
         schema:
           type: string
           description: kind of resource
-          example: task
+          example: pipeline
           enum:
           - task
           - pipeline
-        example: pipeline
+        example: task
       - name: name
         in: path
         description: Name of resource
@@ -546,7 +562,7 @@ paths:
           enum:
           - task
           - pipeline
-        example: pipeline
+        example: task
       - name: name
         in: path
         description: name of resource

api/pkg/service/resource/resource.go

@@ -45,6 +45,7 @@ func (s *service) Query(ctx context.Context, p *resource.QueryPayload) (*resourc
 		Log:   s.Logger(ctx),
 		Name:  p.Name,
 		Kinds: p.Kinds,
+		Catalogs: p.Catalogs,
 		Tags:  p.Tags,
 		Limit: p.Limit,
 		Match: p.Match,

api/pkg/shared/resource/resource.go

@@ -31,6 +31,7 @@ type Request struct {
 	Name      string
 	Match     string
 	Kinds     []string
+	Catalogs  []string
 	Tags      []string
 	Limit     uint
 	Version   string
@@ -46,7 +47,7 @@ var (
 
 // Query resources based on name, kind, tags.
 // Match is the type of search: 'exact' or 'contains'
-// Fields: name, []kinds, []Tags, Match, Limit
+// Fields: name, []kinds,[]Catalogs []Tags, Match, Limit
 func (r *Request) Query() ([]model.Resource, error) {
 
 	// Validate the kinds passed are supported by Hub
@@ -64,6 +65,7 @@ func (r *Request) Query() ([]model.Resource, error) {
 	r.Db = r.Db.Select("DISTINCT(resources.id), resources.*").Scopes(
 		filterByTags(r.Tags),
 		filterByKinds(r.Kinds),
+		filterByCatalogs(r.Catalogs),
 		filterResourceName(r.Match, r.Name),
 		withResourceDetails,
 	).Limit(int(r.Limit))
@@ -314,6 +316,19 @@ func filterResourceName(match, name string) func(db *gorm.DB) *gorm.DB {
 	}
 }
 
+func filterByCatalogs(catalogs []string) func(db *gorm.DB) *gorm.DB {
+	if len(catalogs) == 0 {
+		return noop
+	}
+
+	catalogs = lower(catalogs)
+	return func(db *gorm.DB) *gorm.DB {
+		return db.Model(&model.Resource{}).
+			Joins("JOIN catalogs as ct on ct.id = resources.catalog_id").
+			Where("lower(ct.name) in (?)", catalogs)
+	}
+}
+
 func noop(db *gorm.DB) *gorm.DB {
 	return db
 }

api/pkg/shared/resource/resource_test.go

@@ -142,6 +142,26 @@ func TestQuery_ByTags(t *testing.T) {
 	assert.Equal(t, 1, len(res))
 }
 
+func TestQuery_ByCatalogs(t *testing.T) {
+	tc := testutils.Setup(t)
+	testutils.LoadFixtures(t, tc.FixturePath())
+
+	req := Request{
+		Db:    tc.DB(),
+		Log:   tc.Logger("resource"),
+		Name:  "",
+		Kinds: []string{},
+		Catalogs:  []string{"catalog-community"},
+		Limit: 100,
+	}
+
+	res, err := req.Query()
+	assert.NoError(t, err)
+
+	assert.Equal(t, 1, len(res))
+	assert.Equal(t,"catalog-community",res[0].Catalog.Name)
+}
+
 func TestQuery_ByNameAndKind(t *testing.T) {
 	tc := testutils.Setup(t)
 	testutils.LoadFixtures(t, tc.FixturePath())