Add discovery fields and tests for content packages (#1220)

Added tests related to content packages as well as the new discovery fields into the BasePackage manifest definition.
elastic · Sep 10, 2024 · f90ac28 · f90ac28
1 parent 1d3f0b9
commit f90ac28
Show file tree

Hide file tree

Showing 18 changed files with 615 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Added support for content packages and its discovery fields. [#1220](https://github.com/elastic/package-registry/pull/1220)
+
 ### Deprecated
 
 ### Known Issues

diff --git a/README.md b/README.md
@@ -17,10 +17,10 @@ The `/search` API endpoint has few additional query parameters. More might be ad
 * `kibana.version`: Filters out all the packages which are not compatible with the given Kibana version. If it is set to `7.3.1` and
   a package requires 7.4, the package will not be returned or an older compatible package will be shown.
   By default this endpoint always returns only the newest compatible package.
-* `category`: Filters the package by the given category. Available categories can be seend when going to `/categories` endpoint.
+* `category`: Filters the package by the given category. Available categories can be seen when going to `/categories` endpoint.
 * `package`: Filters by a specific package name, for example `mysql`. Returns the most recent version.
 * `all`: This can be set to `true` to list all package versions. This is set to `false` by default.
-* `prerelease`: This can be set to `true` to list prerelease versions of packages. Versions are considered prereleases if they are not stable according to sematic versioning, that is, if they are 0.x versions, or if they contain a prerelease tag. This is set to `false` by default.
+* `prerelease`: This can be set to `true` to list prerelease versions of packages. Versions are considered prereleases if they are not stable according to semantic versioning, that is, if they are 0.x versions, or if they contain a prerelease tag. This is set to `false` by default.
 * `experimental` (deprecated): This can be set to `true` to list packages considered to be experimental. This is set to `false` by default.
 
 The different query parameters above can be combined, so `?package=mysql&kibana.version=7.3.0` will return all mysql package versions
@@ -30,7 +30,7 @@ which are compatible with `7.3.0`.
 
 The `/categories` API endpoint has two additional query parameters.
 
-* `prerelease`: This can be set to `true` to list prerelease versions of packages. Versions are considered prereleases if they are not stable according to sematic versioning, that is, if they are 0.x versions, or if they contain a prerelease tag. This is set to `false` by default.
+* `prerelease`: This can be set to `true` to list prerelease versions of packages. Versions are considered prereleases if they are not stable according to semantic versioning, that is, if they are 0.x versions, or if they contain a prerelease tag. This is set to `false` by default.
 * `experimental` (deprecated): This can be set to `true` to list categories from experimental packages. This is set to `false` by default.
 * `include_policy_templates`: This can be set to `true` to include categories from policy templates. This is set to `false` by default.
 
@@ -77,7 +77,7 @@ go run .
 
 ### Single binary
 
-You can build the `package-registry` binary usig [`mage`](https://magefile.org):
+You can build the `package-registry` binary using [`mage`](https://magefile.org):
 ```
 mage build
 ```

diff --git a/main_test.go b/main_test.go
@@ -92,6 +92,7 @@ func TestEndpoints(t *testing.T) {
 		{"/search?prerelease=true", "/search", "search-package-prerelease.json", searchHandler(testLogger, indexer, testCacheTime)},
 		{"/search?prerelease=foo", "/search", "search-package-prerelease-error.txt", searchHandler(testLogger, indexer, testCacheTime)},
 		{"/search?category=datastore&prerelease=true", "/search", "search-category-datastore-prerelease.json", searchHandler(testLogger, indexer, testCacheTime)},
+		{"/search?type=content&prerelease=true", "/search", "search-content-packages.json", searchHandler(testLogger, indexer, testCacheTime)},
 		{"/search?type=input&prerelease=true", "/search", "search-input-packages.json", searchHandler(testLogger, indexer, testCacheTime)},
 		{"/search?type=input&package=integration_input&prerelease=true", "/search", "search-input-integration-package.json", searchHandler(testLogger, indexer, testCacheTime)},
 		{"/search?type=integration&package=integration_input&prerelease=true", "/search", "search-integration-integration-package.json", searchHandler(testLogger, indexer, testCacheTime)},
@@ -190,7 +191,6 @@ func TestStatics(t *testing.T) {
 			runEndpoint(t, test.endpoint, test.path, test.file, test.handler)
 		})
 	}
-
 }
 
 func TestStaticsModifiedTime(t *testing.T) {
@@ -588,7 +588,6 @@ func listArchivedFiles(t *testing.T, body []byte) []byte {
 		// Using filepath.ToSlash(f.Name) ensures that the file name has the expected format
 		// regardless of the OS.
 		listing.WriteString(fmt.Sprintf("%d %s\n", f.UncompressedSize64, filepath.ToSlash(f.Name)))
-
 	}
 	return listing.Bytes()
 }

diff --git a/packages/package.go b/packages/package.go
@@ -76,6 +76,7 @@ type BasePackage struct {
 	Owner               *Owner               `config:"owner,omitempty" json:"owner,omitempty" yaml:"owner,omitempty"`
 	Categories          []string             `config:"categories,omitempty" json:"categories,omitempty" yaml:"categories,omitempty"`
 	SignaturePath       string               `config:"signature_path,omitempty" json:"signature_path,omitempty" yaml:"signature_path,omitempty"`
+	Discovery           *Discovery           `config:"discovery,omitempty" json:"discovery,omitempty" yaml:"discovery,omitempty"`
 }
 
 // BasePolicyTemplate is used for the package policy templates in the /search endpoint
@@ -160,6 +161,16 @@ type PackageElasticsearch struct {
 	Privileges *PackageElasticsearchPrivileges `config:"privileges,omitempty" json:"privileges,omitempty" yaml:"privileges,omitempty"`
 }
 
+// Discovery define indications for the data this package can be useful with.
+type Discovery struct {
+	Fields []DiscoveryField `config:"fields,omitempty" json:"fields,omitempty" yaml:"fields,omitempty"`
+}
+
+// DiscoveryField defines a field used for discovery.
+type DiscoveryField struct {
+	Name string `config:"name" json:"name" yaml:"name"`
+}
+
 type PackageElasticsearchPrivileges struct {
 	Cluster []string `config:"cluster,omitempty" json:"cluster,omitempty" yaml:"cluster,omitempty"`
 }
@@ -187,7 +198,7 @@ func getDownloadPath(p Package, t string) string {
 // NewPackage creates a new package instances based on the given base path.
 // The path passed goes to the root of the package where the manifest.yml is.
 func NewPackage(basePath string, fsBuilder FileSystemBuilder) (*Package, error) {
-	var p = &Package{
+	p := &Package{
 		BasePath:  basePath,
 		fsBuilder: fsBuilder,
 	}

diff --git a/packages/testdata/marshaler/packages.json b/packages/testdata/marshaler/packages.json
@@ -1082,6 +1082,68 @@
     "/package/foo/1.0.0/docs/README.md"
    ]
   },
+  {
+   "name": "good_content",
+   "title": "Good content package",
+   "version": "0.1.0",
+   "release": "beta",
+   "source": {
+    "license": "Apache-2.0"
+   },
+   "description": "This package is a dummy example for packages with the content type. These packages contain resources that are useful with data ingested by other integrations. They are not used to configure data sources.\n",
+   "type": "content",
+   "download": "/epr/good_content/good_content-0.1.0.zip",
+   "path": "/package/good_content/0.1.0",
+   "icons": [
+    {
+     "src": "/img/system.svg",
+     "path": "/package/good_content/0.1.0/img/system.svg",
+     "title": "system",
+     "size": "1000x1000",
+     "type": "image/svg+xml"
+    }
+   ],
+   "conditions": {
+    "kibana": {
+     "version": "^8.16.0"
+    },
+    "elastic": {
+     "subscription": "basic"
+    }
+   },
+   "owner": {
+    "type": "elastic",
+    "github": "elastic/ecosystem"
+   },
+   "discovery": {
+    "fields": [
+     {
+      "name": "process.pid"
+     }
+    ]
+   },
+   "format_version": "3.4.0",
+   "readme": "/package/good_content/0.1.0/docs/README.md",
+   "license": "basic",
+   "screenshots": [
+    {
+     "src": "/img/kibana-system.png",
+     "path": "/package/good_content/0.1.0/img/kibana-system.png",
+     "title": "kibana system",
+     "size": "1220x852",
+     "type": "image/png"
+    }
+   ],
+   "assets": [
+    "/package/good_content/0.1.0/LICENSE.txt",
+    "/package/good_content/0.1.0/changelog.yml",
+    "/package/good_content/0.1.0/manifest.yml",
+    "/package/good_content/0.1.0/validation.yml",
+    "/package/good_content/0.1.0/docs/README.md",
+    "/package/good_content/0.1.0/img/kibana-system.png",
+    "/package/good_content/0.1.0/img/system.svg"
+   ]
+  },
   {
    "name": "hidden",
    "title": "Hidden",

diff --git a/testdata/generated/package/good_content/0.1.0/index.json b/testdata/generated/package/good_content/0.1.0/index.json
@@ -0,0 +1,62 @@
+{
+  "name": "good_content",
+  "title": "Good content package",
+  "version": "0.1.0",
+  "release": "beta",
+  "source": {
+    "license": "Apache-2.0"
+  },
+  "description": "This package is a dummy example for packages with the content type. These packages contain resources that are useful with data ingested by other integrations. They are not used to configure data sources.\n",
+  "type": "content",
+  "download": "/epr/good_content/good_content-0.1.0.zip",
+  "path": "/package/good_content/0.1.0",
+  "icons": [
+    {
+      "src": "/img/system.svg",
+      "path": "/package/good_content/0.1.0/img/system.svg",
+      "title": "system",
+      "size": "1000x1000",
+      "type": "image/svg+xml"
+    }
+  ],
+  "conditions": {
+    "kibana": {
+      "version": "^8.16.0"
+    },
+    "elastic": {
+      "subscription": "basic"
+    }
+  },
+  "owner": {
+    "type": "elastic",
+    "github": "elastic/ecosystem"
+  },
+  "discovery": {
+    "fields": [
+      {
+        "name": "process.pid"
+      }
+    ]
+  },
+  "format_version": "3.4.0",
+  "readme": "/package/good_content/0.1.0/docs/README.md",
+  "license": "basic",
+  "screenshots": [
+    {
+      "src": "/img/kibana-system.png",
+      "path": "/package/good_content/0.1.0/img/kibana-system.png",
+      "title": "kibana system",
+      "size": "1220x852",
+      "type": "image/png"
+    }
+  ],
+  "assets": [
+    "/package/good_content/0.1.0/LICENSE.txt",
+    "/package/good_content/0.1.0/changelog.yml",
+    "/package/good_content/0.1.0/manifest.yml",
+    "/package/good_content/0.1.0/validation.yml",
+    "/package/good_content/0.1.0/docs/README.md",
+    "/package/good_content/0.1.0/img/kibana-system.png",
+    "/package/good_content/0.1.0/img/system.svg"
+  ]
+}
diff --git a/testdata/generated/search-content-packages.json b/testdata/generated/search-content-packages.json
@@ -0,0 +1,43 @@
+[
+  {
+    "name": "good_content",
+    "title": "Good content package",
+    "version": "0.1.0",
+    "release": "beta",
+    "source": {
+      "license": "Apache-2.0"
+    },
+    "description": "This package is a dummy example for packages with the content type. These packages contain resources that are useful with data ingested by other integrations. They are not used to configure data sources.\n",
+    "type": "content",
+    "download": "/epr/good_content/good_content-0.1.0.zip",
+    "path": "/package/good_content/0.1.0",
+    "icons": [
+      {
+        "src": "/img/system.svg",
+        "path": "/package/good_content/0.1.0/img/system.svg",
+        "title": "system",
+        "size": "1000x1000",
+        "type": "image/svg+xml"
+      }
+    ],
+    "conditions": {
+      "kibana": {
+        "version": "^8.16.0"
+      },
+      "elastic": {
+        "subscription": "basic"
+      }
+    },
+    "owner": {
+      "type": "elastic",
+      "github": "elastic/ecosystem"
+    },
+    "discovery": {
+      "fields": [
+        {
+          "name": "process.pid"
+        }
+      ]
+    }
+  }
+]
diff --git a/testdata/generated/search-package-experimental.json b/testdata/generated/search-package-experimental.json
@@ -249,6 +249,47 @@
       "custom"
     ]
   },
+  {
+    "name": "good_content",
+    "title": "Good content package",
+    "version": "0.1.0",
+    "release": "beta",
+    "source": {
+      "license": "Apache-2.0"
+    },
+    "description": "This package is a dummy example for packages with the content type. These packages contain resources that are useful with data ingested by other integrations. They are not used to configure data sources.\n",
+    "type": "content",
+    "download": "/epr/good_content/good_content-0.1.0.zip",
+    "path": "/package/good_content/0.1.0",
+    "icons": [
+      {
+        "src": "/img/system.svg",
+        "path": "/package/good_content/0.1.0/img/system.svg",
+        "title": "system",
+        "size": "1000x1000",
+        "type": "image/svg+xml"
+      }
+    ],
+    "conditions": {
+      "kibana": {
+        "version": "^8.16.0"
+      },
+      "elastic": {
+        "subscription": "basic"
+      }
+    },
+    "owner": {
+      "type": "elastic",
+      "github": "elastic/ecosystem"
+    },
+    "discovery": {
+      "fields": [
+        {
+          "name": "process.pid"
+        }
+      ]
+    }
+  },
   {
     "name": "hidden",
     "title": "Hidden",

diff --git a/testdata/generated/search-package-prerelease.json b/testdata/generated/search-package-prerelease.json
@@ -257,6 +257,47 @@
       "custom"
     ]
   },
+  {
+    "name": "good_content",
+    "title": "Good content package",
+    "version": "0.1.0",
+    "release": "beta",
+    "source": {
+      "license": "Apache-2.0"
+    },
+    "description": "This package is a dummy example for packages with the content type. These packages contain resources that are useful with data ingested by other integrations. They are not used to configure data sources.\n",
+    "type": "content",
+    "download": "/epr/good_content/good_content-0.1.0.zip",
+    "path": "/package/good_content/0.1.0",
+    "icons": [
+      {
+        "src": "/img/system.svg",
+        "path": "/package/good_content/0.1.0/img/system.svg",
+        "title": "system",
+        "size": "1000x1000",
+        "type": "image/svg+xml"
+      }
+    ],
+    "conditions": {
+      "kibana": {
+        "version": "^8.16.0"
+      },
+      "elastic": {
+        "subscription": "basic"
+      }
+    },
+    "owner": {
+      "type": "elastic",
+      "github": "elastic/ecosystem"
+    },
+    "discovery": {
+      "fields": [
+        {
+          "name": "process.pid"
+        }
+      ]
+    }
+  },
   {
     "name": "hidden",
     "title": "Hidden",