Add spec.min, spec.max to categories endpoint #1059

mrodm · 2023-07-20T18:28:13Z

This PR adds the query parameters capabilities as well as spec.min and spec.max in the categories endpoint as they were introduced for search endpoint in these issues:

Examples:

~~This PR is a follow-up of #1058 . At the time of creating this PR was not merged, so this PR contains the same changes.~~

How to test

Update some test packages to build different packages with different version of format_version

Remember to update for each built package the version in manifest and changelog (e.g. 0.0.9) too
As an example, elastic_package_registry could be modified as:

 $ git diff
diff --git packages/elastic_package_registry/manifest.yml packages/elastic_package_registry/manifest.yml
index b8a41f9b5..0d819ff0e 100644
--- packages/elastic_package_registry/manifest.yml
+++ packages/elastic_package_registry/manifest.yml
@@ -1,4 +1,4 @@
-format_version: 1.0.0
+format_version: 2.10.0
 name: elastic_package_registry
 title: "Elastic Package Registry"
 version: 0.0.7
@@ -9,6 +9,9 @@ categories:
 conditions:
   kibana.version: "^8.0.0"
   elastic.subscription: basic
+  elastic.capabilities:
+    - observability
+    - security
 icons:
   - src: /img/elastic_package_registry-logo.svg
     title: Elastic Package Registry logo

Build the packages
```
elastic-package build
```

Build a new local docker image for package-registry

cd /path/to/package-registry   
docker build -t docker.elastic.co/package-registry/package-registry:v1.21.0-rc1 .

Run local package-registry using the packages directory with the built packages as a volume mount point:

docker run --rm -p 8080:8080 -v /home/mariorodriguez/Coding/work/integrations/build/packages/:/packages/package-registry -it docker.elastic.co/package-registry/package-registry:v1.21.0-rc1

Execute some queries against this local package-registry:

# filter categories with spec.min and spec.max
curl -s "http://localhost:8080/categories?spec.min=2.2.0&spec.max=3.0.0&prerelease=true" | jq -r '.[]|"\(.name) - \(.version)"'
# filter categories with spec and kibana.version
curl -s "http://localhost:8080/categories?spec.min=2.2.0&spec.max=3.0.0&kibana.version=8.6.0&prerelease=true" | jq -r '.[]|"\(.name) - \(.version)"'

# filter categories with capabilities
curl -s "http://localhost:8080/categories?capabilities=observability,security&prerelease=true" | jq -r '.[]|"\(.name) - \(.version)"'
 curl -s "http://localhost:8080/categories?capabilities=none&prerelease=true" | jq -r '.[]|"\(.name) - \(.version)"'

mrodm · 2023-07-24T08:52:44Z

categories_test.go

+	"github.com/elastic/package-registry/proxymode"
+)
+
+func TestCategoriesWithProxyMode(t *testing.T) {


This test was moved from proxy_mode_test.go file

mrodm · 2023-07-24T14:34:56Z

categories.go

+	if v := query.Get("capabilities"); v != "" {
+		filter.Capabilities = strings.Split(v, ",")
+	}
+
+	if v := query.Get("spec.min"); v != "" {
+		filter.SpecMin, err = semver.NewVersion(v)
+		if err != nil {
+			return nil, fmt.Errorf("invalid 'spec.min' version '%s': %w", v, err)
+		}
+	}
+
+	if v := query.Get("spec.max"); v != "" {
+		filter.SpecMax, err = semver.NewVersion(v)
+		if err != nil {
+			return nil, fmt.Errorf("invalid 'spec.max' version '%s': %w", v, err)
+		}
+	}
+


Main changes included in this PR, adding these new filters to categories endpoint.

mrodm · 2023-07-24T14:35:17Z

main_test.go

+		{"/categories?capabilities=observability,security&prerelease=true", "/categories", "categories-prerelease-capabilities-observability-security.json", categoriesHandler(testLogger, indexer, testCacheTime)},
+		{"/categories?capabilities=none&prerelease=true", "/categories", "categories-prerelease-capabilities-none.json", categoriesHandler(testLogger, indexer, testCacheTime)},
+		{"/categories?spec.min=1.1.0&spec.max=2.10.0&prerelease=true", "/categories", "categories-spec-min-1.1.0-max-2.10.0.json", categoriesHandler(testLogger, indexer, testCacheTime)},
+		{"/categories?spec.max=2.10.0&prerelease=true", "/categories", "categories-spec-max-2.10.0.json", categoriesHandler(testLogger, indexer, testCacheTime)},


Added new test cases for these new query parameters.

jsoriano

Looks good, but not sure if this will work for patch versions, please add a test for this case.

packages/packages_test.go

packages/package.go

…d_spec_capabilities_categories

elasticmachine · 2023-07-26T16:39:47Z

💚 Build Succeeded

Buildkite Build
Commit: 563984e

History

💚 Build #313 succeeded 348a8cc
💚 Build #310 succeeded ae570dd
💚 Build #304 succeeded 848766a
💔 Build #303 failed 9760cea

cc @mrodm

jsoriano

👍

mrodm added 10 commits July 20, 2023 15:02

Add spec.min and spec.max query parameters

701a1a4

Add error return parameter in Apply

50af49b

Update tests

c36b0f6

Update msg error

ea70991

Add changelog entry

c655d28

Remove capabilities and spec.min/max filters from legacyApply

ed4afff

Remove error from legacyApply

403dfa1

Update changelog entry

b8f49a5

Add tests for search endpoint (capabilities and spec)

10b0298

Delete unused test generated file

146b77a

mrodm self-assigned this Jul 20, 2023

mrodm commented Jul 24, 2023

View reviewed changes

Remove spec.min default value if it is not defined

2a15c15

mrodm force-pushed the add_spec_capabilities_categories branch from 04684d5 to 8a56ca2 Compare July 24, 2023 10:52

mrodm commented Jul 24, 2023

View reviewed changes

mrodm requested a review from a team July 24, 2023 14:46

mrodm marked this pull request as ready for review July 24, 2023 14:46

mrodm added 2 commits July 25, 2023 09:47

Allow just versions major.minor

27350b7

Remove link from changelog entry

a18750c

mrodm force-pushed the add_spec_capabilities_categories branch from 8a56ca2 to 7b04cdc Compare July 25, 2023 07:54

mrodm mentioned this pull request Jul 25, 2023

[Fleet] Use capabilities filter on categories endpoint #1061

Merged

mrodm added 8 commits July 25, 2023 15:58

Merge remote upstream/main into add_spec_min_max_search

85b5a31

Add new filters

af496a2

Move categories proxy mode test

e194b2b

Add tests

85840e2

Add changelog entry

a743bfc

Update tests

046ca09

Allow just spec versions major.minor

666eca4

Add missing test generated file

a193e34

Update changelog entry

ae570dd

mrodm force-pushed the add_spec_capabilities_categories branch from 848766a to ae570dd Compare July 25, 2023 14:00

mrodm changed the title ~~Add spec.min, spec.max and capabilities to categories endpoint~~ Add spec.min, spec.max to categories endpoint Jul 25, 2023

jsoriano reviewed Jul 25, 2023

View reviewed changes

packages/packages_test.go Outdated Show resolved Hide resolved

packages/package.go Outdated Show resolved Hide resolved

packages/package.go Outdated Show resolved Hide resolved

mrodm added 4 commits July 25, 2023 19:40

Set patch version to zero in spec to compare with spec.min/max

deab506

Skip specMajorMinorSemVer precalculation for proxied packages

0b01436

Merge remote-tracking branch 'origin/add_spec_min_max_search' into ad…

348a8cc

…d_spec_capabilities_categories

Merge remote upstream/main into add_spec_capabilities_categories

563984e

mrodm requested a review from jsoriano July 26, 2023 16:30

jsoriano approved these changes Jul 26, 2023

View reviewed changes

mrodm merged commit 4e84d23 into elastic:main Jul 27, 2023

mrodm deleted the add_spec_capabilities_categories branch July 27, 2023 07:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add spec.min, spec.max to categories endpoint #1059

Add spec.min, spec.max to categories endpoint #1059

mrodm commented Jul 20, 2023 •

edited

Loading

mrodm Jul 24, 2023

mrodm Jul 24, 2023

mrodm Jul 24, 2023

jsoriano left a comment

elasticmachine commented Jul 26, 2023

jsoriano left a comment

Add spec.min, spec.max to categories endpoint #1059

Add spec.min, spec.max to categories endpoint #1059

Conversation

mrodm commented Jul 20, 2023 • edited Loading

How to test

mrodm Jul 24, 2023

Choose a reason for hiding this comment

mrodm Jul 24, 2023

Choose a reason for hiding this comment

mrodm Jul 24, 2023

Choose a reason for hiding this comment

jsoriano left a comment

Choose a reason for hiding this comment

elasticmachine commented Jul 26, 2023

💚 Build Succeeded

History

jsoriano left a comment

Choose a reason for hiding this comment

mrodm commented Jul 20, 2023 •

edited

Loading