[gen-csv] Add interactive prompts to generate csv by varshaprasad96 · Pull Request #2891 · operator-framework/operator-sdk

varshaprasad96 · 2020-04-23T16:35:27Z

This PR introduces the feature to provide interactive prompts
to the user to obtain csv metadata.

Description of the change:
Add interactive prompts while generating csv.

varshaprasad96 · 2020-04-23T16:36:56Z

Would be helpful to have some reviews. Yet to write unit tests.

varshaprasad96 · 2020-04-26T06:43:01Z

Added tests.

estroz

I'd like to see a generalized interactive prompt library somewhere like internal/util/projutil so we can reuse it easily and not have to encode Generator-specific logic in cmd/operator-sdk.

varshaprasad96 · 2020-04-28T22:14:57Z

Refactored the code to address the comments.
@estroz Can you please take a look at it.

jmccormick2001 · 2020-05-01T14:04:13Z

I tested this and it seems to work, I'd say it needs a website docs update and a changelog fragment file?

varshaprasad96 · 2020-05-01T22:43:52Z

@jmccormick2001 I have added the changelog fragment file to this PR. Will create a follow-up PR to update the docs after this is merged.

varshaprasad96 · 2020-05-05T18:27:08Z

@estroz @camilamacedo86 Addressed review comments.

estroz

A few suggestions.

estroz

/lgtm

joelanford

Looks great! Mostly non-blocking nits.

I think spacing the prompts out would be my only blocker if there's agreement on that suggestion.

Another non-blocking follow-up to this could be to add support for default values. That way if someone has an existing CSV and they ask for --interactive, we can do something like this:

Display name for operator [Example Database Operator]:
>

And empty input would result in the default being used.

Lastly, was there any consideration for using an existing interactive prompt library? I'm not suggesting that we make that change here, but curious if we may want to think about that in the future if we need more features?

openshift-ci-robot · 2020-05-06T05:20:14Z

New changes are detected. LGTM label has been removed.

varshaprasad96 · 2020-05-06T05:22:51Z

@joelanford I completely agree with the formatting, and have modified the PR so that the prompts have spaces in between. There are a few prompt libraries like go-prompt and prompt-ui. These are shell libraries which have more advanced features like auto-complete/suggestions or selections . And for creating simple prompts as we have done, they follow a similar approach as here. To make it more flexible (like getting strings, and performing any further operations on it), I wrote these functions to do the same. But we could definitely modify the available libraries in future to have more powerful features and modifications in the prompts. I'll create a follow up PR for providing the default values to the user when we have base CSV.

joelanford

One more nit, but otherwise LGTM!

GREAT job on this! Totally digging the design of the CLI prompt library and keeping it separate from the CSV generation code that uses it.

This PR introduces the feature to provide interactive prompts to the user to obtain csv metadata.

openshift-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 23, 2020

openshift-ci-robot requested review from camilamacedo86 and estroz April 23, 2020 16:35

jmrodri reviewed Apr 23, 2020

View reviewed changes

Comment thread cmd/operator-sdk/generate/csv.go Outdated

jmrodri reviewed Apr 23, 2020

View reviewed changes

Comment thread cmd/operator-sdk/generate/csv_prompt_util.go Outdated

jmrodri reviewed Apr 23, 2020

View reviewed changes

Comment thread cmd/operator-sdk/generate/csv_prompt_util.go Outdated

jmrodri reviewed Apr 23, 2020

View reviewed changes

Comment thread cmd/operator-sdk/generate/csv_prompt_util.go Outdated

estroz reviewed Apr 23, 2020

View reviewed changes

Comment thread cmd/operator-sdk/generate/csv.go Outdated

jmrodri reviewed Apr 23, 2020

View reviewed changes

Comment thread cmd/operator-sdk/generate/csv.go Outdated

estroz reviewed Apr 23, 2020

View reviewed changes

Comment thread cmd/operator-sdk/generate/csv.go Outdated

varshaprasad96 force-pushed the gen-bundle/subcommand branch from bf6fc8c to 0ada52e Compare April 24, 2020 17:51

varshaprasad96 changed the title ~~[wip] Add interactive prompts to generate csv~~ [gen-csv] Add interactive prompts to generate csv Apr 24, 2020

varshaprasad96 marked this pull request as ready for review April 24, 2020 17:55

openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 24, 2020

varshaprasad96 force-pushed the gen-bundle/subcommand branch from 0ada52e to d9b07f3 Compare April 26, 2020 06:38

varshaprasad96 requested review from estroz and jmrodri April 26, 2020 06:43

varshaprasad96 force-pushed the gen-bundle/subcommand branch from d9b07f3 to e28a545 Compare April 28, 2020 00:19

estroz suggested changes Apr 28, 2020

View reviewed changes

Comment thread cmd/operator-sdk/generate/csv.go Outdated

varshaprasad96 force-pushed the gen-bundle/subcommand branch from e28a545 to 1cffae5 Compare April 28, 2020 22:13

varshaprasad96 force-pushed the gen-bundle/subcommand branch from 1cffae5 to 2493ef8 Compare April 28, 2020 22:23

estroz reviewed Apr 30, 2020

View reviewed changes

Comment thread internal/generate/olm-catalog/csv.go Outdated

varshaprasad96 force-pushed the gen-bundle/subcommand branch from 2493ef8 to 5207bf3 Compare April 30, 2020 21:17

camilamacedo86 reviewed May 1, 2020

View reviewed changes

Comment thread cmd/operator-sdk/generate/csv.go Outdated

varshaprasad96 force-pushed the gen-bundle/subcommand branch from 5207bf3 to 185be51 Compare May 1, 2020 22:42

estroz reviewed May 5, 2020

View reviewed changes

Comment thread internal/generate/olm-catalog/csv_cmd_prompt.go Outdated

estroz reviewed May 5, 2020

View reviewed changes

Comment thread internal/generate/olm-catalog/csv.go Outdated

estroz reviewed May 5, 2020

View reviewed changes

Comment thread ...eploy/olm-catalog/memcached-operator/manifests/memcached-operator.clusterserviceversion.yaml

varshaprasad96 force-pushed the gen-bundle/subcommand branch 2 times, most recently from b499a73 to 0b374d3 Compare May 5, 2020 18:25

camilamacedo86 reviewed May 5, 2020

View reviewed changes

Comment thread cmd/operator-sdk/generate/csv.go

camilamacedo86 reviewed May 5, 2020

View reviewed changes

Comment thread cmd/operator-sdk/generate/csv.go Outdated

camilamacedo86 reviewed May 5, 2020

View reviewed changes

Comment thread internal/generate/olm-catalog/csv_cmd_prompt.go Outdated

camilamacedo86 reviewed May 5, 2020

View reviewed changes

Comment thread internal/util/projutil/interactive_promt_util_test.go Outdated

camilamacedo86 reviewed May 5, 2020

View reviewed changes

Comment thread internal/util/projutil/interactive_promt_util_test.go

varshaprasad96 force-pushed the gen-bundle/subcommand branch from 0b374d3 to a37b863 Compare May 5, 2020 20:19

estroz reviewed May 5, 2020

View reviewed changes

Comment thread internal/generate/olm-catalog/csv_cmd_prompt.go Outdated

Comment thread internal/generate/olm-catalog/csv_cmd_prompt.go Outdated

Comment thread internal/generate/olm-catalog/csv_cmd_prompt.go Outdated

Comment thread cmd/operator-sdk/generate/csv.go Outdated

varshaprasad96 force-pushed the gen-bundle/subcommand branch 2 times, most recently from cd0df7c to 8629bf4 Compare May 5, 2020 21:25

estroz approved these changes May 5, 2020

View reviewed changes

openshift-ci-robot assigned estroz May 5, 2020

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label May 5, 2020

joelanford reviewed May 6, 2020

View reviewed changes

varshaprasad96 force-pushed the gen-bundle/subcommand branch from 8629bf4 to 688ceb8 Compare May 6, 2020 05:20

openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label May 6, 2020

varshaprasad96 force-pushed the gen-bundle/subcommand branch 2 times, most recently from 4be7b11 to 7703efa Compare May 6, 2020 05:47

joelanford approved these changes May 6, 2020

View reviewed changes

Comment thread internal/generate/olm-catalog/csv_cmd_prompt.go Outdated

[gen-csv] Add interactive prompts to generate csv

5366a39

This PR introduces the feature to provide interactive prompts to the user to obtain csv metadata.

varshaprasad96 force-pushed the gen-bundle/subcommand branch from 7703efa to 5366a39 Compare May 6, 2020 16:08

varshaprasad96 merged commit 4916e6a into operator-framework:master May 6, 2020

varshaprasad96 deleted the gen-bundle/subcommand branch May 22, 2020 22:24

Conversation

varshaprasad96 commented Apr 23, 2020

Uh oh!

varshaprasad96 commented Apr 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

varshaprasad96 commented Apr 26, 2020

Uh oh!

estroz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

varshaprasad96 commented Apr 28, 2020

Uh oh!

Uh oh!

Uh oh!

jmccormick2001 commented May 1, 2020

Uh oh!

varshaprasad96 commented May 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

varshaprasad96 commented May 5, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

estroz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

estroz left a comment

Choose a reason for hiding this comment

Uh oh!

joelanford left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

openshift-ci-robot commented May 6, 2020

Uh oh!

varshaprasad96 commented May 6, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joelanford left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

varshaprasad96 commented Apr 23, 2020 •

edited

Loading

varshaprasad96 commented May 1, 2020 •

edited

Loading

varshaprasad96 commented May 6, 2020 •

edited

Loading