Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pipeline CLI: Add support for static text spinner #2633

Merged
merged 1 commit into from
Apr 6, 2022

Conversation

ptitzler
Copy link
Member

@ptitzler ptitzler commented Apr 5, 2022

Improves the rendering of 'in progress' for long running tasks in the elyra-pipeline CLI, such as pipeline submission or pipeline monitoring.

Output when the CLI is running in a terminal window - note the animations:

$ elyra-pipeline submit test.pipeline --runtime-config kfp_test_env --monitor

2022-04-04_16-53-12 (1)

Output when the CLI is running in a terminal window and the output is sent to a pipe - no animations:

$ elyra-pipeline submit test.pipeline --runtime-config kfp_test_env --monitor | cat

2022-04-04_16-56-40 (1)

The main goal is to minimize the amount of information that is logged if the CLI is run non-interactively, e.g. in batch.

Example of captured STDOUT output prior to this PR:

$ elyra-pipeline submit test.pipeline --runtime-config kfp_test_env --monitor > a.out
$ cat a.out

image

Closes #2617

What changes were proposed in this pull request?

  • Add/use a new 'in progress' spinner that displays only text, without any animation

How was this pull request tested?

See invocation examples above

Developer's Certificate of Origin 1.1

   By making a contribution to this project, I certify that:

   (a) The contribution was created in whole or in part by me and I
       have the right to submit it under the Apache License 2.0; or

   (b) The contribution is based upon previous work that, to the best
       of my knowledge, is covered under an appropriate open source
       license and I have the right under that license to submit that
       work with modifications, whether created in whole or in part
       by me, under the same open source license (unless I am
       permitted to submit under a different license), as indicated
       in the file; or

   (c) The contribution was provided directly to me by some other
       person who certified (a), (b) or (c) and I have not modified
       it.

   (d) I understand and agree that this project and the contribution
       are public and that a record of the contribution (including all
       personal information I submit with it, including my sign-off) is
       maintained indefinitely and may be redistributed consistent with
       this project or the open source license(s) involved.

@ptitzler ptitzler added kind:bug Something isn't working component:cli-tools Command line tools labels Apr 5, 2022
@ptitzler ptitzler added this to the 3.8.0 milestone Apr 5, 2022
@elyra-bot
Copy link

elyra-bot bot commented Apr 5, 2022

Thanks for making a pull request to Elyra!

To try out this branch on binder, follow this link: Binder

@ptitzler ptitzler changed the title Add support for static text spinner Pipeline CLI: Add support for static text spinner Apr 5, 2022
@ptitzler ptitzler added the status:Test in Progress Test creation or testing is still in progress. A PR tagged with this label is ready for review. label Apr 5, 2022
Copy link
Member

@kevin-bates kevin-bates left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice.

@akchinSTC akchinSTC self-requested a review April 5, 2022 15:34
@ptitzler
Copy link
Member Author

ptitzler commented Apr 5, 2022

Confirmed that the CI output is now clean:

image

For comparison, this is what the output looked before:

image

@ptitzler ptitzler removed the status:Test in Progress Test creation or testing is still in progress. A PR tagged with this label is ready for review. label Apr 5, 2022
@akchinSTC akchinSTC merged commit 8558c5d into elyra-ai:master Apr 6, 2022
@ptitzler ptitzler deleted the spinner branch April 11, 2022 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:cli-tools Command line tools kind:bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Pipeline CLI: allow for logging-friendly output
3 participants