Add `run-command` flag to `odo dev` to run non-default Run command #5878

rm3l · 2022-06-27T05:18:44Z

What type of PR is this:
/kind feature
/area dev

What does this PR do / why we need it:
See #5775 for the use case.

Which issue(s) this PR fixes:
Fixes #5775

PR acceptance criteria:

Unit test
Integration test
Documentation

How to test changes / Special notes to the reviewer:
odo dev --run-command <command> should allow to run the specified <command>, provided it is in the run group.

netlify · 2022-06-27T05:18:48Z

✅ Deploy Preview for odo-docusaurus-preview ready!

Name	Link
🔨 Latest commit	`068d864`
🔍 Latest deploy log	https://app.netlify.com/sites/odo-docusaurus-preview/deploys/62ba08573a90a700091d475e
😎 Deploy Preview	https://deploy-preview-5878--odo-docusaurus-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

odo-robot · 2022-06-27T05:25:46Z

Unit Tests on commit afc6850 finished successfully.
View logs: TXT HTML

odo-robot · 2022-06-27T05:37:01Z

Kubernetes Tests on commit afc6850 finished successfully.
View logs: TXT HTML

odo-robot · 2022-06-27T05:44:35Z

OpenShift Tests on commit afc6850 finished successfully.
View logs: TXT HTML

odo-robot · 2022-06-27T05:45:37Z

Windows Tests (OCP) on commit afc6850 finished successfully.
View logs: TXT HTML

odo-robot · 2022-06-27T05:47:20Z

Validate Tests on commit afc6850 finished successfully.
View logs: TXT HTML

tests/integration/devfile/cmd_dev_test.go

dharmit · 2022-06-27T07:31:26Z

pkg/libdevfile/libdevfile.go

+	cmdName string,
+	kind v1alpha2.CommandGroupKind,
+	handler Handler,
+	ignoreCommandNotFound bool,


In what case this boolean would be useful? What if user provides a custom command of certain kind and has set this boolean to true? Could you also brief this in function's comment?

The use case for this was mainly for the Build command. The previous behavior I noticed was ignoring errors if the Devfile does not have any Build commands.
I'll update the description of this function - thanks.

dharmit · 2022-06-27T07:35:14Z

pkg/libdevfile/libdevfile.go

-	commands, err := data.GetCommands(common.DevfileOptions{})
+// getDefaultCommand iterates through the devfile commands and returns the default command associated with the group kind.
+// If there is no default command, the second return value is false.
+func getDefaultCommand(devfileObj parser.DevfileObj, groupType v1alpha2.CommandGroupKind) (v1alpha2.Command, bool, error) {


A plural for default command? Is it possible to have multiple default commands for the same group kind in a devfile?

Ah, OK. It's an error to have multiple default commands. Isn't this already covered in the devfile validator? 🤔

Where is this Devfile validator? And when is it called in odo? I basically used what was done before, but if it is already validated elsewhere, we can remove this check here.

Where is this Devfile validator? And when is it called in odo?

odo/pkg/devfile/devfile.go

Lines 15 to 19 in 33733a0

func parseDevfile(args parser.ParserArgs) (parser.DevfileObj, error) {

devObj, varWarnings, err := devfile.ParseDevfileAndValidate(args)

if err != nil {

return parser.DevfileObj{}, err

}

I basically used what was done before, but if it is already validated elsewhere, we can remove this check here.

@feloy came up with libdevfile package as a way to add things on top of devfile library. These could eventually be put into the library itself. But that's a different story. Point is, you don't need to remove a check unless you can find a counterpart in devfile library.

pkg/libdevfile/libdevfile.go

dharmit · 2022-06-27T11:27:53Z

/lgtm

pkg/devfile/adapters/kubernetes/utils/utils.go

tests/helper/helper_dev.go

feloy · 2022-06-27T16:51:59Z

/approve

openshift-ci · 2022-06-27T16:52:08Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: feloy

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [feloy]

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

Few functions used to have similar but slightly different logic, which could make them quite confusing to use. This also fixes a behavior which is not supposed to be part of the Devfile spec: in the past, if a Devfile contains a single but non-default command for a given kind, this command would get returned as the Default command for such kind. Now, an explicit error is returned instead if this single command is not marked as default in the Devfile.

sonarcloud · 2022-06-27T19:43:50Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication

feloy · 2022-06-28T08:19:20Z

/lgtm

valaparthvi · 2022-06-28T08:59:04Z

/retest-required

rm3l · 2022-06-28T12:24:03Z

/test v4.10-integration-e2e

rm3l · 2022-06-28T15:09:59Z

/override ci/prow/v4.10-integration-e2e

Doesn't pass in Prow due to the same issues with SBO. Overriding because IBM Cloud tests are passing.

openshift-ci · 2022-06-28T15:10:05Z

@rm3l: Overrode contexts on behalf of rm3l: ci/prow/v4.10-integration-e2e

In response to this:

/override ci/prow/v4.10-integration-e2e

Doesn't pass in Prow due to the same issues with SBO. Overriding because IBM Cloud tests are passing.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

rm3l · 2022-06-28T15:29:01Z

golangci/golangci-lint info checking GitHub for tag 'v1.37.0'
golangci/golangci-lint crit unable to find 'v1.37.0' - use 'latest' or see https://github.com/golangci/golangci-lint/releases for details
make[1]: *** [goget-tools] Error 1
make[1]: Leaving directory `/go/src/github.com/redhat-developer/odo'

/override ci/prow/unit

Unit tests passing in IBM Cloud.

openshift-ci · 2022-06-28T15:29:07Z

@rm3l: Overrode contexts on behalf of rm3l: ci/prow/unit

In response to this:

golangci/golangci-lint info checking GitHub for tag 'v1.37.0'
golangci/golangci-lint crit unable to find 'v1.37.0' - use 'latest' or see https://github.com/golangci/golangci-lint/releases for details
make[1]: *** [goget-tools] Error 1
make[1]: Leaving directory `/go/src/github.com/redhat-developer/odo'

/override ci/prow/unit

Unit tests passing in IBM Cloud.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

…edhat-developer#5878) * Add documentation * Add integration test cases * Refactor functions in 'pkg/libdevfile/libdevfile.go' Few functions used to have similar but slightly different logic, which could make them quite confusing to use. This also fixes a behavior which is not supposed to be part of the Devfile spec: in the past, if a Devfile contains a single but non-default command for a given kind, this command would get returned as the Default command for such kind. Now, an explicit error is returned instead if this single command is not marked as default in the Devfile. * Add `run-command` to `odo dev`, to run non-default run commands * Fix documentation of a few libdevfile functions, as suggested in review

rm3l requested review from dharmit, feloy and valaparthvi June 27, 2022 05:18

openshift-ci bot added kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation area/dev Issues or PRs related to `odo dev` labels Jun 27, 2022

openshift-ci bot requested a review from cdrage June 27, 2022 05:18

dharmit suggested changes Jun 27, 2022

View reviewed changes

openshift-ci bot assigned dharmit Jun 27, 2022

rm3l requested a review from dharmit June 27, 2022 10:32

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Jun 27, 2022

feloy reviewed Jun 27, 2022

View reviewed changes

pkg/devfile/adapters/kubernetes/utils/utils.go Outdated Show resolved Hide resolved

tests/helper/helper_dev.go Outdated Show resolved Hide resolved

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Jun 27, 2022

rm3l requested a review from feloy June 27, 2022 16:01

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. Required by Prow. label Jun 27, 2022

rm3l added 5 commits June 27, 2022 21:41

Add documentation

695baa3

Add integration test cases

56db5bc

Add run-command to odo dev, to run non-default run commands

89b107f

Fix documentation of a few libdevfile functions, as suggested in review

068d864

rm3l force-pushed the 5775-odo-dev-add-flag-to-run-non-default-run-command branch from 978f52a to 068d864 Compare June 27, 2022 19:43

openshift-ci bot assigned feloy Jun 28, 2022

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Jun 28, 2022

openshift-ci bot merged commit b9507c9 into redhat-developer:main Jun 28, 2022

rm3l deleted the 5775-odo-dev-add-flag-to-run-non-default-run-command branch December 1, 2022 16:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `run-command` flag to `odo dev` to run non-default Run command #5878

Add `run-command` flag to `odo dev` to run non-default Run command #5878

rm3l commented Jun 27, 2022 •

edited

Loading

netlify bot commented Jun 27, 2022 •

edited

Loading

odo-robot bot commented Jun 27, 2022 •

edited

Loading

odo-robot bot commented Jun 27, 2022 •

edited

Loading

odo-robot bot commented Jun 27, 2022 •

edited

Loading

odo-robot bot commented Jun 27, 2022 •

edited

Loading

odo-robot bot commented Jun 27, 2022 •

edited

Loading

dharmit Jun 27, 2022

rm3l Jun 27, 2022

dharmit Jun 27, 2022

dharmit Jun 27, 2022

rm3l Jun 27, 2022

dharmit Jun 27, 2022

dharmit commented Jun 27, 2022

feloy commented Jun 27, 2022

openshift-ci bot commented Jun 27, 2022

sonarcloud bot commented Jun 27, 2022

feloy commented Jun 28, 2022

valaparthvi commented Jun 28, 2022

rm3l commented Jun 28, 2022

rm3l commented Jun 28, 2022

openshift-ci bot commented Jun 28, 2022

rm3l commented Jun 28, 2022

openshift-ci bot commented Jun 28, 2022

	func parseDevfile(args parser.ParserArgs) (parser.DevfileObj, error) {
	devObj, varWarnings, err := devfile.ParseDevfileAndValidate(args)
	if err != nil {
	return parser.DevfileObj{}, err
	}

Add run-command flag to odo dev to run non-default Run command #5878

Add run-command flag to odo dev to run non-default Run command #5878

Conversation

rm3l commented Jun 27, 2022 • edited Loading

netlify bot commented Jun 27, 2022 • edited Loading

✅ Deploy Preview for odo-docusaurus-preview ready!

odo-robot bot commented Jun 27, 2022 • edited Loading

odo-robot bot commented Jun 27, 2022 • edited Loading

odo-robot bot commented Jun 27, 2022 • edited Loading

odo-robot bot commented Jun 27, 2022 • edited Loading

odo-robot bot commented Jun 27, 2022 • edited Loading

dharmit Jun 27, 2022

Choose a reason for hiding this comment

rm3l Jun 27, 2022

Choose a reason for hiding this comment

dharmit Jun 27, 2022

Choose a reason for hiding this comment

dharmit Jun 27, 2022

Choose a reason for hiding this comment

rm3l Jun 27, 2022

Choose a reason for hiding this comment

dharmit Jun 27, 2022

Choose a reason for hiding this comment

dharmit commented Jun 27, 2022

feloy commented Jun 27, 2022

openshift-ci bot commented Jun 27, 2022

sonarcloud bot commented Jun 27, 2022

feloy commented Jun 28, 2022

valaparthvi commented Jun 28, 2022

rm3l commented Jun 28, 2022

rm3l commented Jun 28, 2022

openshift-ci bot commented Jun 28, 2022

rm3l commented Jun 28, 2022

openshift-ci bot commented Jun 28, 2022

Add `run-command` flag to `odo dev` to run non-default Run command #5878

Add `run-command` flag to `odo dev` to run non-default Run command #5878

rm3l commented Jun 27, 2022 •

edited

Loading

netlify bot commented Jun 27, 2022 •

edited

Loading

odo-robot bot commented Jun 27, 2022 •

edited

Loading

odo-robot bot commented Jun 27, 2022 •

edited

Loading

odo-robot bot commented Jun 27, 2022 •

edited

Loading

odo-robot bot commented Jun 27, 2022 •

edited

Loading

odo-robot bot commented Jun 27, 2022 •

edited

Loading