Add strategy for devfile port detection to alizer enrichers

thepetk commented 1 year ago

Which area/kind this issue is related to?

/area alizer

Issue Description

This is part of EPIC #1154 and is focusing on the update of alizer's strategies by supporting devfile port detection. As a result, someone will be able to choose the devfile port detection as part of the port-detection strategy and they will be able to get any ports defined inside a devfile. The steps required are the following:

Create a new const inside the model.go:

const Devfile     PortDetectionAlgorithm = 3

Update the component command's getPortDetectionStrategy to take into account the model.Devfile as part of the strategy.
In every DoEnrichComponent function we should update the switch in order to include the model.Devfile case. The enrichers are the following:
1. dotnet_enricher.go
2. go_enricher.go
3. java_enricher.go
4. javascript_enricher.go
5. php_enricher.go
6. python_enricher.go
The model.Devfile case should call the GetPortsFromDevfile function created in https://github.com/devfile/api/issues/1331.

Acceptance Criteria

[ ] The new strategy option of model.Devfile has been added to the compose command.
[ ] All enrichers are up-to-date and they support the new strategy option.
[ ] Test cases are created for changes in each enricher and for getPortDetectionStrategy
[ ] Update port detection and other documentation.

openshift-ci[bot] commented 1 year ago

@thepetk: The label(s) area/cli cannot be applied, because the repository doesn't have them.

In response to [this](https://github.com/devfile/api/issues/1156): >## Which area/kind this issue is related to? > >/area cli >/area library > >## Issue Description > >This is part of EPIC #1154 and is focusing on the implementation of devfile detection. This task has several steps we should follow: > >* We need to create a new `model` called `Devfile` as an additional `PortDetectionAlgorithm` >* Inside each enriched which uses the detection algorithms (like `go_enricher` we should add a new case for `model.Devfile` and create a new `GetPortsFromDevfile` function. >* An update to `enricher.getPortsFromReader` might be necessary in order to handle `Dockerfile/Containerfile`, `docker-compose.yaml` and `devfile.yaml` with the same way. > Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

thepetk commented 1 year ago

Putting it in "waiting" as we may need to split the implementation of the GetPortsFromDevfile in a different issue and we need to prioritization of the detected ports (e.g innerloop vs outerloop)

thepetk commented 1 year ago

Putting it in "waiting" as we may need to split the implementation of the GetPortsFromDevfile in a different issue and we need to prioritization of the detected ports (e.g innerloop vs outerloop)

I've split the old issue into two:

One with a scope only to the implementation of the GetPortsFromDevfile function: https://github.com/devfile/api/issues/1331
The current one has the scope of the strategy options addition.

As the GetPortsFromDevfile is required for this issue, I've put a blocked label into this one and the blocker to https://github.com/devfile/api/issues/1331

github-actions[bot] commented 1 month ago

This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 60 days.

devfile / api