adding support for dockerfile components #14

mike-hoang · 2023-07-23T23:59:37Z

What does this PR do?

Adds an enricher for the dockerfile component which allows Docker components to be found.

Implemented following the proposal here: https://github.com/devfile/alizer/blob/main/docs/proposals/dockerfile_component_detection.md

Which issue(s) does this PR fix

fixes: devfile/api#1178
epic: devfile/api#1159

PR acceptance criteria

Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened.

Unit/Functional tests
Documentation

How to test changes / Special notes to the reviewer

codecov · 2023-07-24T00:01:36Z

Codecov Report

❗ No coverage uploaded for pull request base (main@e55ee31). Click here to learn what that means.
Patch has no changes to coverable lines.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #14   +/-   ##
=======================================
  Coverage        ?   37.91%           
=======================================
  Files           ?        9           
  Lines           ?     1221           
  Branches        ?        0           
=======================================
  Hits            ?      463           
  Misses          ?      729           
  Partials        ?       29

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

thepetk

I think a good idea could be to add 2 more resources for this case. The 2 resources can ensure that our detection flow works. As it is designed we have:

FolderA and FolderB are children of root (/)

root -> FolderA contains a component 
| -> FolderB contains python files

The result will be 2 components detected: One in FolderA and one in FolderB

FolderB is child of folderA

root -> FolderA (contains a component) -> FolderB (contains python files)

The result will be 1 component detected in FolderA

FolderA is child of FolderB:

root -> FolderB (contains python files) -> FolderA (contains a component)

The result will be 1 component detected in folderA

test/apis/component_recognizer_test.go

thepetk

If we apply the proposed changes we should update the tests too

pkg/apis/enricher/docker_enricher.go

pkg/apis/recognizer/component_recognizer.go

Signed-off-by: Michael Hoang <[email protected]>

thepetk

/lgtm Very nice addition of tests for the component detection flow. They were missing for sure.

openshift-ci · 2023-07-25T13:49:53Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mike-hoang, thepetk

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Signed-off-by: Michael Hoang <[email protected]> Signed-off-by: thepetk <[email protected]>

* Add binaries to every new release (#237) * Add release yaml to workflows Signed-off-by: thepetk <[email protected]> * Remove autogeneration of release notes Signed-off-by: thepetk <[email protected]> * Update readme Signed-off-by: thepetk <[email protected]> * Update Readme.md Signed-off-by: thepetk <[email protected]> --------- Signed-off-by: thepetk <[email protected]> * flattening go dir (#1) Signed-off-by: Michael Hoang <[email protected]> Signed-off-by: thepetk <[email protected]> * Update realease.yaml (#2) Signed-off-by: thepetk <[email protected]> * adding proposal for dockerfile components (#3) Signed-off-by: Michael Hoang <[email protected]> Signed-off-by: thepetk <[email protected]> * Merge all test resources (#6) * Update test paths Signed-off-by: thepetk <[email protected]> * Update angular test resource Signed-off-by: thepetk <[email protected]> * Remove projectAngularjs Signed-off-by: thepetk <[email protected]> * Update containerfile test Signed-off-by: thepetk <[email protected]> * Update django test resources Signed-off-by: thepetk <[email protected]> * Update docker compose test resources Signed-off-by: thepetk <[email protected]> * Update tests for docker compose with ports Signed-off-by: thepetk <[email protected]> * Update test project dockerfile Signed-off-by: thepetk <[email protected]> * Update express js port tests Signed-off-by: thepetk <[email protected]> * Update flask port tests Signed-off-by: thepetk <[email protected]> * Update golang test resources Signed-off-by: thepetk <[email protected]> * Update jboss test resources Signed-off-by: thepetk <[email protected]> * Update laravel test resources Signed-off-by: thepetk <[email protected]> * Update test micronaut resources Signed-off-by: thepetk <[email protected]> * Update container docker file nested tests Signed-off-by: thepetk <[email protected]> * Update nuxt and next js tests Signed-off-by: thepetk <[email protected]> * Update port test for quarkus Signed-off-by: thepetk <[email protected]> * Update reactjs tests Signed-off-by: thepetk <[email protected]> * Remove port test project quarkus Signed-off-by: thepetk <[email protected]> * Update rest of port tests Signed-off-by: thepetk <[email protected]> * Fix issue with ip host go format Signed-off-by: thepetk <[email protected]> * Update test resources Signed-off-by: thepetk <[email protected]> * Finalize new component detection format Signed-off-by: thepetk <[email protected]> --------- Signed-off-by: thepetk <[email protected]> * Add min max cli args (#5) * Create dependabot.yml Signed-off-by: thepetk <[email protected]> * Update dependabot.yml Signed-off-by: thepetk <[email protected]> * Update realease.yaml (#2) Signed-off-by: thepetk <[email protected]> * adding proposal for dockerfile components (#3) Signed-off-by: Michael Hoang <[email protected]> Signed-off-by: thepetk <[email protected]> * Merge all test resources (#6) * Update test paths Signed-off-by: thepetk <[email protected]> * Update angular test resource Signed-off-by: thepetk <[email protected]> * Remove projectAngularjs Signed-off-by: thepetk <[email protected]> * Update containerfile test Signed-off-by: thepetk <[email protected]> * Update django test resources Signed-off-by: thepetk <[email protected]> * Update docker compose test resources Signed-off-by: thepetk <[email protected]> * Update tests for docker compose with ports Signed-off-by: thepetk <[email protected]> * Update test project dockerfile Signed-off-by: thepetk <[email protected]> * Update express js port tests Signed-off-by: thepetk <[email protected]> * Update flask port tests Signed-off-by: thepetk <[email protected]> * Update golang test resources Signed-off-by: thepetk <[email protected]> * Update jboss test resources Signed-off-by: thepetk <[email protected]> * Update laravel test resources Signed-off-by: thepetk <[email protected]> * Update test micronaut resources Signed-off-by: thepetk <[email protected]> * Update container docker file nested tests Signed-off-by: thepetk <[email protected]> * Update nuxt and next js tests Signed-off-by: thepetk <[email protected]> * Update port test for quarkus Signed-off-by: thepetk <[email protected]> * Update reactjs tests Signed-off-by: thepetk <[email protected]> * Remove port test project quarkus Signed-off-by: thepetk <[email protected]> * Update rest of port tests Signed-off-by: thepetk <[email protected]> * Fix issue with ip host go format Signed-off-by: thepetk <[email protected]> * Update test resources Signed-off-by: thepetk <[email protected]> * Finalize new component detection format Signed-off-by: thepetk <[email protected]> --------- Signed-off-by: thepetk <[email protected]> * Run tidy Signed-off-by: thepetk <[email protected]> * Update devfile_recognizer and models Signed-off-by: thepetk <[email protected]> * Update cli Signed-off-by: thepetk <[email protected]> * Update docs Signed-off-by: thepetk <[email protected]> * Add test cases for versions cli args Signed-off-by: thepetk <[email protected]> * Fix sec alert Signed-off-by: thepetk <[email protected]> * Fix typo Signed-off-by: thepetk <[email protected]> --------- Signed-off-by: thepetk <[email protected]> Signed-off-by: Michael Hoang <[email protected]> Co-authored-by: Michael Hoang <[email protected]> Signed-off-by: thepetk <[email protected]> * Remove dependabot (#10) Signed-off-by: [email protected] Signed-off-by: [email protected] Signed-off-by: thepetk <[email protected]> * Minor update on devfiles versioning (#11) * Remove dependabot Signed-off-by: [email protected] Signed-off-by: thepetk <[email protected]> * Add versions to alizer devfile response Signed-off-by: thepetk <[email protected]> * Update readme.md Signed-off-by: thepetk <[email protected]> * Update naming and devfile models in the proposal Signed-off-by: thepetk <[email protected]> * Update code naming Signed-off-by: thepetk <[email protected]> * Update tests after renaming Signed-off-by: thepetk <[email protected]> --------- Signed-off-by: [email protected] Signed-off-by: thepetk <[email protected]> * fixing gosec alerts (#12) Signed-off-by: Michael Hoang <[email protected]> Signed-off-by: thepetk <[email protected]> * Add test coverage check to CI.yaml (#13) * Add test coverage workflow Signed-off-by: thepetk <[email protected]> * Update ci.yaml Signed-off-by: thepetk <[email protected]> * Add separate check for code coverage Signed-off-by: thepetk <[email protected]> * Move code report in ci file Signed-off-by: thepetk <[email protected]> * Add .codecov.yaml Signed-off-by: thepetk <[email protected]> * Update workflow Signed-off-by: thepetk <[email protected]> * Bump up setup-go Signed-off-by:thepetk <[email protected]> --------- Signed-off-by: thepetk <[email protected]> * adding support for dockerfile components (#14) Signed-off-by: Michael Hoang <[email protected]> Signed-off-by: thepetk <[email protected]> * Add test coverage workflow Signed-off-by: thepetk <[email protected]> * Update ci.yaml Signed-off-by: thepetk <[email protected]> * Add separate check for code coverage Signed-off-by: thepetk <[email protected]> * Move code report in ci file Signed-off-by: thepetk <[email protected]> * Update workflow Signed-off-by: thepetk <[email protected]> * Bump up setup-go Signed-off-by:thepetk <[email protected]> Signed-off-by: thepetk <[email protected]> * Make DownloadDevFileTypesFromRegistry public Signed-off-by: thepetk <[email protected]> * Add devfile.yaml schema Signed-off-by: thepetk <[email protected]> * Add go script for generating registry entries json Signed-off-by: thepetk <[email protected]> * Implement nightly run script and workflow Signed-off-by: thepetk <[email protected]> * Update go mod Signed-off-by: thepetk <[email protected]> * Add new schedule to registry check signed-off-by: thepetk <[email protected]> Signed-off-by: thepetk <[email protected]> * Update workflow name Signed-off-by: thepetk <[email protected]> * Update go mod Signed-off-by: thepetk <[email protected]> * Update funcs in order to be mockable Signed-off-by: thepetk <[email protected]> * Move devfile_recognizer_test.go to recognizer dir Signed-off-by: thepetk <[email protected]> * Update docstring of script Signed-off-by: thepetk <[email protected]> * Add tests for check_registry.go Signed-off-by: thepetk <[email protected]> * Fix test paths Signed-off-by: thepetk <[email protected]> * Remove unecessary logging Signed-off-by: thepetk <[email protected]> * Remove binary Signed-off-by: thepetk <[email protected]> * Use make build instead of go command Signed-off-by: thepetk <[email protected]> * Further fixes on the workflow Signed-off-by: thepetk <[email protected]> --------- Signed-off-by: thepetk <[email protected]> Signed-off-by: Michael Hoang <[email protected]> Signed-off-by: [email protected] Co-authored-by: Michael Hoang <[email protected]>

mike-hoang requested a review from thepetk July 23, 2023 23:59

thepetk requested changes Jul 24, 2023

View reviewed changes

test/apis/component_recognizer_test.go Outdated Show resolved Hide resolved

openshift-ci bot assigned thepetk Jul 24, 2023

mike-hoang force-pushed the API-1178 branch from be4ce51 to 6103583 Compare July 24, 2023 20:39

mike-hoang requested a review from thepetk July 24, 2023 20:49

mike-hoang mentioned this pull request Jul 24, 2023

Enhance alizer dockerfile port detection logic devfile/api#1159

Closed

3 tasks

thepetk requested changes Jul 25, 2023

View reviewed changes

pkg/apis/enricher/docker_enricher.go Outdated Show resolved Hide resolved

pkg/apis/recognizer/component_recognizer.go Outdated Show resolved Hide resolved

mike-hoang force-pushed the API-1178 branch 2 times, most recently from 91212dd to 4842a45 Compare July 25, 2023 13:28

mike-hoang requested a review from thepetk July 25, 2023 13:30

mike-hoang force-pushed the API-1178 branch from 4842a45 to 9a1a788 Compare July 25, 2023 13:37

adding support for dockerfile components

de192a5

Signed-off-by: Michael Hoang <[email protected]>

mike-hoang force-pushed the API-1178 branch from 9a1a788 to de192a5 Compare July 25, 2023 13:41

thepetk approved these changes Jul 25, 2023

View reviewed changes

openshift-ci bot added the lgtm label Jul 25, 2023

mike-hoang merged commit 7f521b2 into devfile:main Jul 25, 2023

thepetk referenced this pull request in thepetk/devfile-alizer Jul 27, 2023

adding support for dockerfile components (#14)

24b52f5

Signed-off-by: Michael Hoang <[email protected]> Signed-off-by: thepetk <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adding support for dockerfile components #14

adding support for dockerfile components #14

mike-hoang commented Jul 23, 2023

codecov bot commented Jul 24, 2023 •

edited

Loading

thepetk left a comment

thepetk left a comment

thepetk left a comment

openshift-ci bot commented Jul 25, 2023

adding support for dockerfile components #14

adding support for dockerfile components #14

Conversation

mike-hoang commented Jul 23, 2023

What does this PR do?

Which issue(s) does this PR fix

PR acceptance criteria

How to test changes / Special notes to the reviewer

codecov bot commented Jul 24, 2023 • edited Loading

Codecov Report

thepetk left a comment

Choose a reason for hiding this comment

thepetk left a comment

Choose a reason for hiding this comment

thepetk left a comment

Choose a reason for hiding this comment

openshift-ci bot commented Jul 25, 2023

codecov bot commented Jul 24, 2023 •

edited

Loading