New CLI Flag --devel To Include Development/Prerelease Versions of Charts

[Bhargav-InfraCloud]

Motivation

Issue #94

Changes

1. New CLI flag --devel.
2. Tests to cover Charts() and Containing().

Summary

CLI flag --devel to list/include development (prerelease versions like release candidate, alpha, beta, etc.) in the following endpoints:

• /api/helm/repositories/<repo>
• /api/helm/repositories/versions?name=<repo>
• /api/helm/repositories/latestver?name=<repo>

Related Issues

Closes #94

[undera]

There is massive refactoring happens in #131 , will have to wait for it to complete

[undera]

Just to record my investigations, exerpt from Helm sources, search_repo.go:

if o.devel { // search for releases and prereleases (alpha, beta, and release candidate releases).
		o.version = ">0.0.0-0"
	} else { // search only for stable releases, prerelease versions will be skip
		o.version = ">0.0.0"
	}
constraint, err := semver.NewConstraint(o.version)
v, err := semver.NewVersion(r.Chart.Version)
if constraint.Check(v) {
}

[undera]

The proper approach to this feature would include the checkbox in UI to enable display of development charts, passing that as parameter to API

[Bhargav-InfraCloud]

@undera Thanks for the pointers. It is working as expected. A query before submitting this PR:

How does the user enable development versions:

1. Directly from UI, the API response for the backend?
2. Starts the application using --devel which enables the option on UI to toggle on/off development versions, which is then sent to the backend as API response?

[undera]

Two factors I take into account:

1. Seems that not too many users use devel versions in Helm
2. It would be harder to add a UI checkbox to install/upgrade modal for versions filter.

From that, I would do it as an environment variable. Once set, the user would get versions filtered accordingly.

Note that the filtering has to apply not only in Charts(), but also for ByName()

[Bhargav-InfraCloud]

@undera Thanks! That makes sense. Please confirm the following:

1. In Charts(), the current logic is only considering a single version (0'th index) of each chart. Any particular reason in doing so or should my changes iterate over all versions, filter, and append?

2. From that, I would do it as an environment variable. Once set, the user would get versions filtered accordingly.

   If the devel is enabled/disabled only once from environment variables, why not have the --devel flag instead, as we initially discussed?

[undera]

1. The purpose of Charts() is to return the list of all charts, with the latest version specified. So, if the chart only has dev versions, we don't display it when flag is not set. We can't return all the versions 'cause it will produce too much output.

2. You can add that flag. Just it will be harder to propagate it to all the objects. If that flag is rarely used, it might not be that important. Up to you here.

[Bhargav-InfraCloud]

@undera While I was trying to add tests for these changes, I noticed that they need interfaces for mocking. Otherwise, not testable.

However, when I started adding interfaces and tests, I realized that it is reorganizing most parts or pkg/dashboard/objects. So, I reverted those extra changes. I'll submit them under #210 if approved.

This card can only be tested manually. These are the sample calls I used to verify, with and without --devel. Please check and let me know.

curl http://localhost:8080/api/helm/repositories/kafka-operator | jq '.[].version'
curl http://localhost:8080/api/helm/repositories/versions\?name\=kafka-operator | jq '.[].version'
curl http://localhost:8080/api/helm/repositories/latestver\?name\=kafka-operator

[undera]

I have replied in #210 about testing. The code is testable, with the Helm's standard way of injecting fixtures. I don't see a real need in in introducing interfaces.

[undera]

Do you plan to add the test @Bhargav-InfraCloud ?

[Bhargav-InfraCloud]

@undera My apologies, I didn't find time to update you on the progress. I've submitted the commit with test cases. Please review.

[undera]

Looks good. Awesome contributioN!

[Bhargav-InfraCloud]

Thanks, @undera. I appreciate the help throughout the time. 😊