Feat(#5861): Support addon dependencies version ranges #6002

merusso · 2023-05-16T08:28:41Z

Description of your changes

This change enables addon maintainers to define version ranges for dependencies in an addon's metadata.yaml file.

This behavior is similar to the version range allowed in the system section of the metadata file. The version range expression for dependencies follows the same format as for system.

Example:

dependencies:
  - name: addon1
    version: ">= 2.3.3, < 3.0.0"
  - name: addon2
    version: ">= 0.1.0, < 1.0.0"

When installing an addon, the behavior varies depending on whether the dependency is already installed.

If a dependency is already installed, the installed version will be validated against the version range, and installation will fail with an error if there's a mismatch.
If a dependency is not installed, the version range will be used to select the addon version to be installed. If no addon version matching the range exists, the installation will fail with an error.

Fixes #5861

I have:

Read and followed KubeVela's contribution process.
Related Docs updated properly. In a new feature or configuration option, an update to the documentation is necessary.
PR: Docs(#5861): Update metadata.yaml dependencies.version kubevela.github.io#1240
Run make reviewable to ensure this PR is ready for review.
Added backport release-x.y labels to auto-backport this PR if necessary.

How has this code been tested

Added unit tests for new functions.
Manually tested on an existing cluster.

Special notes for your reviewer

This change enables addon maintainers to define version ranges for dependencies in an addon's metadata.yaml file. This behavior is similar to the version range allowed in the `system` section of the metadata file. The version range expression for `dependencies` follows the same format as for `system`. Example: ```yaml dependencies: - name: addon1 version: ">= 2.3.3, < 3.0.0" - name: addon2 version: ">= 0.1.0, < 1.0.0" ``` When installing an addon, the behavior varies depending on whether the dependency is already installed. If a dependency is already installed, the installed version will be validated against the version range, and installation will fail with an error if there's a mismatch. If a dependency is not installed, the version range will be used to select the addon version to be installed. If no addon version matching the range exists, the installation will fail with an error. Fixes #5861 Signed-off-by: Michael Russo <merusso@gmail.com>

codecov · 2023-05-16T08:42:20Z

Codecov Report

Patch coverage: 72.95% and project coverage change: +0.50 🎉

Comparison is base (7a8264d) 66.04% compared to head (e433245) 66.54%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6002      +/-   ##
==========================================
+ Coverage   66.04%   66.54%   +0.50%     
==========================================
  Files         193      191       -2     
  Lines       25127    24851     -276     
==========================================
- Hits        16595    16538      -57     
+ Misses       6917     6711     -206     
+ Partials     1615     1602      -13

Flag	Coverage Δ
core-unittests	`55.17% <72.95%> (+0.30%)`	⬆️
e2e-multicluster-test	`30.73% <0.00%> (+0.03%)`	⬆️
e2etests	`33.58% <ø> (+0.43%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
pkg/addon/source.go	`50.45% <45.00%> (-1.22%)`	⬇️
pkg/addon/addon.go	`62.66% <78.62%> (+1.95%)`	⬆️
pkg/addon/utils.go	`67.71% <100.00%> (-7.87%)`	⬇️
pkg/addon/versioned_registry.go	`80.00% <100.00%> (+1.11%)`	⬆️

... and 30 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.