Move to entry points #3413

sgaist · 2019-10-16T19:43:15Z

These changes partially address #2802, #2972

Requirements check-list

I have read CONTRIBUTING.md and added my name as a Code Contributor.
Contains logically grouped changes (else tidy your branch by rebase).
Does not contain off-topic changes (use other PRs for other changes).
Already covered by existing tests.
No change log entry required (why? e.g. invisible to users).
No documentation update required.

hjoliver · 2019-10-16T20:35:47Z

A bunch of minor code style failures revealed on Travis CI.

cylc/flow/scripts/cylc.py

hjoliver · 2019-10-17T22:23:37Z

@sgaist - there's still a bunch of test failures. See /etc/bin/run-functional-tests.sh for how to run them locally (individually, or many, or all of them - not recommended). Ask if you need help understanding what's going on (some functional tests are hard to diagnose ... but these failures should be relatively easy, e.g. I can see a bunch for command help messages printed in the Travis CI logs which indicates simple command line errors).

kinow

Very close! Several tests passing, but found several under tests/validation failing, probably due to -v being verbose for cylc validate (and possibly other subcommands). Added comment with links/pointers to what I think is the problem.

Thank you @sgaist

cylc/flow/scripts/cylc.py

sgaist · 2019-10-22T22:20:15Z

One thing that is currently giving me some trouble: the help option.

There's currently all kinds of possible variants to get help on something. One that I havent seen before is --help something. Usually --help on -h is a flag that shows the associated help message. It is the first time I see it as an "option with argument". Therefore I am wondering whether it's something that should be more command line compliant ?

We would then have:

cylc -> shows help
cylc --h, --help, same as cylc alone
cylc help "something" shows the help about something

What do you guys think about that ?

hjoliver · 2019-10-22T23:41:31Z

What do you guys think about that ?

Happy to have that standardized. You can get rid of any such weird historical anachronisms 😁

hjoliver · 2019-10-22T23:42:52Z

But @sgaist cylc [sub-command] --help is standard, for sub-command help, isn't it? (you haven't listed that).

dwsutherland · 2019-10-23T00:54:08Z

But @sgaist cylc [sub-command] --help is standard, for sub-command help, isn't it? (you haven't listed that).

It's how git does it.. i.e git cherry-pick --help

sgaist · 2019-10-23T06:28:35Z

But @sgaist cylc [sub-command] --help is standard, for sub-command help, isn't it? (you haven't listed that).

I see I haven't been precise enough. I meant it only for the main entry point.

But @sgaist cylc [sub-command] --help is standard, for sub-command help, isn't it? (you haven't listed that).

It's how git does it.. i.e git cherry-pick --help

Agreed, that's why it wasn't listed and that part is already working.

oliver-sanders · 2019-10-23T08:47:12Z

Happy to have that standardized. You can get rid of any such weird historical anachronisms grin

We can definitely standardise behaviour!

sgaist · 2019-10-28T23:27:26Z

One question about the tests, is there any way to run single tests or more specifically the ones that are currently failing explicitly ?

While it seems pretty thorough, which is nice, the current test suite is a bit difficult to dive in.

kinow · 2019-10-28T23:32:23Z

One question about the tests, is there any way to run single tests or more specifically the ones that are currently failing explicitly ?

While it seems pretty thorough, which is nice, the current test suite is a bit difficult to dive in.

Hi @sgaist , yes, you can use ./etc/bin/run-functional-tests.sh -v $test. For example:

$ ./etc/bin/run-functional-tests.sh -v ./tests/api-suite-info/00-get-graph-raw-1.t

I use virtualenv, so before running this I activate my virtual environment to get the Cylc modules/dependencies in place first. Then I look at the output of Travis - normally I run this command to fix something I broke in a PR - copy the name of the failed test, and run with the command above.

Hope that helps 👍

kinow · 2019-10-28T23:33:23Z

ps: some tests may fail occasionally on Travis, but pass on your environment. Which is frustrating. But if they pass on your environment, it should be fine to just say that here, and one of us can try that too, or kick travis until the build passes 👍 Thanks!!!

hjoliver · 2019-10-30T02:59:36Z

@sgaist - the functional tests can be difficult to diagnose if you don't have much Cylc background (annoying, but it's just hard to test a workflow engine). In this case any failures should be pretty straightforward, but if you find it too maddening we might be able to dive in and help.

Matches current master behaviour

…ash script

As for jobs-summit and graph-diff, this commands takes arguments after "--".

…ime)

oliver-sanders · 2019-12-08T00:32:41Z

Two test failures unfortunately :(

tests/cylc-subscribe/01-subscribe.t (new command added in rebase)
tests/cli/01-help.t (command alias missing)

hjoliver · 2019-12-08T08:01:35Z

Here is an overview of what got changed by this pull request:

Issues
======
- Added 78
           

Complexity increasing per file
==============================
- cylc/flow/scripts/cylc_print.py  27
- cylc/flow/scripts/cylc_check_versions.py  21
- cylc/flow/scripts/cylc_run.py  1
- cylc/flow/scripts/cylc_get_directory.py  1
- cylc/flow/scripts/cylc_ping.py  5
- cylc/flow/scripts/cylc_dump.py  5
- cylc/flow/scripts/cylc_checkpoint.py  1
- cylc/flow/scripts/cylc_kill.py  2
- cylc/flow/scripts/cylc_hold.py  5
- cylc/flow/scripts/cylc_help.py  23
- cylc/flow/scripts/cylc_jobs_poll.py  2
- cylc/flow/scripts/cylc_get_suite_config.py  7
- cylc/flow/scripts/cylc_suite_state.py  25
- cylc/flow/scripts/cylc.py  32
- cylc/flow/scripts/cylc_cycle_point.py  36
- cylc/flow/scripts/cylc_function_run.py  3
- cylc/flow/scripts/cylc_poll.py  2
- cylc/flow/scripts/cylc_ls_checkpoints.py  5
- cylc/flow/scripts/cylc_jobs_submit.py  2
- cylc/flow/scripts/cylc_reset.py  7
- cylc/flow/scripts/cylc_set_verbosity.py  2
- cylc/flow/scripts/cylc_spawn.py  1
- cylc/flow/scripts/cylc_broadcast.py  22
- cylc/flow/scripts/cylc_report_timings.py  7
- cylc/flow/scripts/cylc_insert.py  3
- cylc/flow/scripts/cylc_get_site_config.py  4
- cylc/flow/scripts/cylc_ext_trigger.py  7
- cylc/flow/scripts/cylc_get_suite_version.py  1
- cylc/flow/scripts/cylc_remote_init.py  2
- cylc/flow/scripts/cylc_remove.py  1
- cylc/flow/scripts/cylc_client.py  3
- cylc/flow/scripts/cylc_edit.py  14
- cylc/flow/scripts/cylc_restart.py  1
- cylc/flow/scripts/cylc_get_suite_contact.py  4
- cylc/flow/scripts/cylc_register.py  1
- cylc/flow/scripts/cylc_graph.py  14
- cylc/flow/scripts/cylc_reload.py  1
- cylc/flow/scripts/cylc_check_software.py  13
- cylc/flow/scripts/cylc_show.py  32
- cylc/flow/scripts/cylc_stop.py  14
- cylc/flow/scripts/cylc_validate.py  19
- cylc/flow/scripts/cylc_nudge.py  1
- cylc/flow/scripts/cylc_submit.py  21
- cylc/flow/scripts/cylc_cat_log.py  44
- cylc/flow/scripts/cylc_search.py  20
- cylc/flow/scripts/cylc_monitor.py  83
- cylc/flow/scripts/cylc_view.py  13
- cylc/flow/scripts/cylc_diff.py  9
- cylc/flow/scripts/cylc_release.py  3
- cylc/flow/scripts/cylc_subscribe.py  10
- cylc/flow/scripts/cylc_remote_tidy.py  2
- cylc/flow/scripts/cylc_extract_resources.py  4
- cylc/flow/scripts/cylc_jobs_kill.py  2
- cylc/flow/scripts/cylc_get_host_metrics.py  8
- cylc/flow/scripts/cylc_scan.py  21
- cylc/flow/scripts/cylc_list.py  24
- cylc/flow/scripts/cylc_trigger.py  18
- cylc/flow/scripts/cylc_message.py  14

See the complete overview on Codacy

hjoliver · 2019-12-09T09:36:37Z

Kicked Travis CI as the failed test tests/triggering/08-fam-finish-any.t passes on this branch in my environment...

oliver-sanders · 2019-12-09T21:14:20Z

Kicking again!
...
Passed.

oliver-sanders

Conflicts resolved, tests passing 🍾.

Thanks for your efforts @sgaist, most Cylc changes go through a lot easier, honest!

kinow · 2019-12-09T23:16:19Z

@sgaist great work! Thanks a lot for your contribution and patience 👏 👏

hjoliver · 2019-12-09T23:18:26Z

@sgaist, many thanks from me too, good job 💐

sgaist · 2019-12-09T23:35:27Z

@oliver-sanders No worries, I'm used to more difficult merges :-)

You're welcome guys !

As next "big" step, may I suggest to add pre-commit like talked in cylc-admin issue 64 ?

This would partly help cleanup the warnings that have appeared on codacy and help automate coding style standardisation. It can then be applied either once on the whole code base (but might be a bit aggressive with regards to other pull request) or file by file when one is modified.

kinow · 2019-12-09T23:38:49Z

+1 for the pre-commit hook @sgaist. Is that something you'd like to submit as a PR? Or could help testing perhaps?

dwsutherland · 2019-12-10T00:44:27Z

@sgaist - Nice work! (and thanks sorting the conflicts I introduced!) 🍻

hjoliver · 2019-12-11T02:13:20Z

I'm in favour of pre-commit hook. We can discuss more on the cylc-admin issue.

sgaist · 2019-12-15T13:18:08Z

@kinow Do you mean submit a possible configuration to get started on cylc-flow ?

If so, sure thing, I can do that. I'll just wait the confirmation to avoid noise.

kinow · 2019-12-15T19:43:24Z

@sgaist yes, if you have time tgat would be great, please ☺

hjoliver assigned sgaist Oct 16, 2019

hjoliver added this to the cylc-8.0.0 milestone Oct 16, 2019

sgaist force-pushed the move_to_entry_points branch 3 times, most recently from 08a9664 to 4b4fff6 Compare October 16, 2019 21:34

oliver-sanders reviewed Oct 17, 2019

View reviewed changes

cylc/flow/scripts/cylc.py Outdated Show resolved Hide resolved

sgaist force-pushed the move_to_entry_points branch from 4b4fff6 to 36c88f4 Compare October 17, 2019 18:03

sgaist force-pushed the move_to_entry_points branch 2 times, most recently from e3e416c to 8d25b4b Compare October 18, 2019 21:30

cylc deleted a comment Oct 18, 2019

kinow suggested changes Oct 21, 2019

View reviewed changes

cylc/flow/scripts/cylc.py Outdated Show resolved Hide resolved

cylc/flow/scripts/cylc.py Outdated Show resolved Hide resolved

sgaist force-pushed the move_to_entry_points branch from 8d25b4b to 97de025 Compare October 24, 2019 22:35

cylc deleted a comment Oct 24, 2019

cylc deleted a comment Oct 27, 2019

cylc deleted a comment Oct 28, 2019

kinow mentioned this pull request Nov 1, 2019

Cylc Tutorial Suite cylc/cylc-doc#40

Closed

cylc deleted a comment Nov 2, 2019

sgaist and others added 7 commits December 7, 2019 00:17

[scripts][run] Add a main function

47c8a0d

[scripts][cylc] Improve handling of optional log folder

58e2266

[scripts][cylc] Improve category help handling

bfee42c

Matches current master behaviour

[scripts][cylc] Refactor and follow more closely the logic from the b…

8a7fadd

…ash script

[scripts][cylc] Add special handling for message command

8337eb9

As for jobs-summit and graph-diff, this commands takes arguments after "--".

Install on Travis without the editable flag (faster entrypoint load t…

0312751

…ime)

[scripts][cylc] Fix no argument handling for message command

6ea2267

sgaist force-pushed the move_to_entry_points branch from 7a52b8e to 6ea2267 Compare December 6, 2019 23:18

[scripts][cylc_scan] Fix too long line

d464c34

[cylc][flow] Move subscribe to scripts folder

77e25a0

oliver-sanders approved these changes Dec 9, 2019

View reviewed changes

oliver-sanders modified the milestones: cylc-8.0.0, cylc-8.0a2 Dec 9, 2019

oliver-sanders merged commit 6bb7662 into cylc:master Dec 9, 2019

sgaist deleted the move_to_entry_points branch December 9, 2019 23:07

oliver-sanders mentioned this pull request Dec 9, 2019

Centralise Cylc CLI Functionality cylc/cylc-admin#69

Closed

oliver-sanders mentioned this pull request Dec 18, 2019

cli: pager functionality #3468

Open

oliver-sanders mentioned this pull request Jan 27, 2020

Move the logic from Cylc commands/scripts to the cylc package #2802

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move to entry points #3413

Move to entry points #3413

sgaist commented Oct 16, 2019 •

edited by oliver-sanders

Loading

hjoliver commented Oct 16, 2019

hjoliver commented Oct 17, 2019

kinow left a comment

sgaist commented Oct 22, 2019

hjoliver commented Oct 22, 2019

hjoliver commented Oct 22, 2019

dwsutherland commented Oct 23, 2019

sgaist commented Oct 23, 2019

oliver-sanders commented Oct 23, 2019 •

edited

Loading

sgaist commented Oct 28, 2019

kinow commented Oct 28, 2019

kinow commented Oct 28, 2019

hjoliver commented Oct 30, 2019

oliver-sanders commented Dec 8, 2019

hjoliver commented Dec 8, 2019

hjoliver commented Dec 9, 2019

oliver-sanders commented Dec 9, 2019 •

edited

Loading

oliver-sanders left a comment

kinow commented Dec 9, 2019

hjoliver commented Dec 9, 2019

sgaist commented Dec 9, 2019

kinow commented Dec 9, 2019

dwsutherland commented Dec 10, 2019

hjoliver commented Dec 11, 2019

sgaist commented Dec 15, 2019

kinow commented Dec 15, 2019

Move to entry points #3413

Move to entry points #3413

Conversation

sgaist commented Oct 16, 2019 • edited by oliver-sanders Loading

hjoliver commented Oct 16, 2019

hjoliver commented Oct 17, 2019

kinow left a comment

Choose a reason for hiding this comment

sgaist commented Oct 22, 2019

hjoliver commented Oct 22, 2019

hjoliver commented Oct 22, 2019

dwsutherland commented Oct 23, 2019

sgaist commented Oct 23, 2019

oliver-sanders commented Oct 23, 2019 • edited Loading

sgaist commented Oct 28, 2019

kinow commented Oct 28, 2019

kinow commented Oct 28, 2019

hjoliver commented Oct 30, 2019

oliver-sanders commented Dec 8, 2019

hjoliver commented Dec 8, 2019

hjoliver commented Dec 9, 2019

oliver-sanders commented Dec 9, 2019 • edited Loading

oliver-sanders left a comment

Choose a reason for hiding this comment

kinow commented Dec 9, 2019

hjoliver commented Dec 9, 2019

sgaist commented Dec 9, 2019

kinow commented Dec 9, 2019

dwsutherland commented Dec 10, 2019

hjoliver commented Dec 11, 2019

sgaist commented Dec 15, 2019

kinow commented Dec 15, 2019

sgaist commented Oct 16, 2019 •

edited by oliver-sanders

Loading

oliver-sanders commented Oct 23, 2019 •

edited

Loading

oliver-sanders commented Dec 9, 2019 •

edited

Loading