clan/clan-core
11
2
Fork 13
Code Issues 91 Pull Requests 6 Actions Packages Projects 1 Releases Wiki Activity

clan-cli: dev-shell, build, tab completion, formatting, linting, unit tests #11

Merged
Mic92 merged 11 commits from cli into main 2023-07-21 09:26:57 +00:00
Conversation 0 Commits 11 Files Changed 17 +420 -160
DavHau commented 2023-07-21 00:29:25 +00:00
Owner
Copy Link
  • updates the clan-cli to use #10 to get a proper dev environment + some useful commands + checks.
  • set up tab completion for bash, zsh, fish for the clan cli package as well as the python dev shell
  • adds flake output checks.clan
  • adds flake output packages.clan
  • add some unit tests
  • move clan-admin.py -> clan_admin.py so it can be loaded as a module
  • compose python sub commands via argparse subparsers instead of Popen

@lassulus For now I broke your design idea of implementing sub commands via Popen, not because I'm against it, but simply because this made it simpler to set up a proper python project with dev shell and tests. Also I'm not sure if the tab completion would integrate as nicely otherwise.
We could add this mechanism back as soon as we actually have a non-python implementation of some command. Would that be ok with you?

- updates the clan-cli to use https://git.clan.lol/clan/clan-core/pulls/10 to get a proper dev environment + some useful commands + checks. - set up tab completion for bash, zsh, fish for the clan cli package as well as the python dev shell - adds flake output `checks.clan` - adds flake output `packages.clan` - add some unit tests - move `clan-admin.py` -> `clan_admin.py` so it can be loaded as a module - compose python sub commands via argparse subparsers instead of Popen @lassulus For now I broke your design idea of implementing sub commands via Popen, not because I'm against it, but simply because this made it simpler to set up a proper python project with dev shell and tests. Also I'm not sure if the tab completion would integrate as nicely otherwise. We could add this mechanism back as soon as we actually have a non-python implementation of some command. Would that be ok with you?
DavHau requested review from Mic92 2023-07-21 00:29:35 +00:00
DavHau requested review from lassulus 2023-07-21 00:29:35 +00:00
Mic92 reviewed 2023-07-21 05:09:22 +00:00
pkgs/clan-cli/tests/test_clan_admin.py Outdated
@ -0,0 +3,4 @@
import clan_admin
def test_make_parser():
Mic92 commented 2023-07-21 05:09:22 +00:00
Owner
Copy Link

I would also add typing to tests because than refactoring becomes easier.

I would also add typing to tests because than refactoring becomes easier.
👍 1
Mic92 reviewed 2023-07-21 08:04:36 +00:00
pkgs/clan-cli/clan_admin.py Outdated
@ -0,0 +19,4 @@
)
def edit(args: argparse.Namespace) -> None: # pragma: no cover
Mic92 commented 2023-07-21 08:04:36 +00:00
Owner
Copy Link

Is no cover for pytest-coverage?

Is `no cover` for pytest-coverage?
DavHau commented 2023-07-21 10:09:32 +00:00
Author
Owner
Copy Link

Yes, currently it's set to require 100% coverage. You can then exclude functions from the coverage report via this comment. I thought, requiring tests for newly added functions is a better default than not requiring them.

Yes, currently it's set to require 100% coverage. You can then exclude functions from the coverage report via this comment. I thought, requiring tests for newly added functions is a better default than not requiring them.
Mic92 reviewed 2023-07-21 08:05:33 +00:00
pkgs/clan-cli/clan_admin.py
@ -0,0 +15,4 @@
"init",
"-t",
"git+https://git.clan.lol/clan/clan-core#clan-template",
]
Mic92 commented 2023-07-21 08:05:33 +00:00
Owner
Copy Link

This should have a check=True or handle the exit code in a different way.

This should have a `check=True` or handle the exit code in a different way.
👍 1
Mic92 reviewed 2023-07-21 08:05:53 +00:00
pkgs/clan-cli/clan_admin.py
@ -0,0 +67,4 @@
"git",
"-C",
args.folder,
] + args.git_args
Mic92 commented 2023-07-21 08:05:53 +00:00
Owner
Copy Link

Same here.

Same here.
Mic92 force-pushed cli from 1cfd48ffdc to e4fbb08f91 2023-07-21 09:19:22 +00:00 Compare
Mic92 added 2 commits 2023-07-21 09:22:07 +00:00
lassulus approved these changes 2023-07-21 09:24:47 +00:00
Mic92 force-pushed cli from dfa83ac9c3 to 3ab90e6785 2023-07-21 09:25:29 +00:00 Compare
Mic92 merged commit c87db7106a into main 2023-07-21 09:26:57 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Mic92
lassulus
Labels
Clear labels   
backups

   
blog

   
bootstrapping

Issues regarding bootstrapping, or onboarding

  
bug

Something is not working.

  
changes-requested

Please fix this.

  
cli

   
documentation

   
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
facts

Issues regarding facts and secrets setting and generation

  
help wanted

Need some help

  
invalid

Something is wrong

  
Inventory

Inventory

  
low_prio

   
manager

   
modules

   
needs-review

This PR needs to be reviewed. Use the request-changes label to request changes

  
networking

   
packaging

   
question

More information is needed

  
secrets

   
template

Issues regarding templates.

  
test

Issues regarding testing

  
tooling

Issues regarding internal devtools

  
user-testing

Issues that cristallised after hands on user testing.

  
vm

Issues regarding virtual machines.

  
wontfix

This won't be fixed

No Label
backups
blog
bootstrapping
bug
changes-requested
cli
documentation
duplicate
enhancement
facts
help wanted
invalid
Inventory
low_prio
manager
modules
needs-review
networking
packaging
question
secrets
template
test
tooling
user-testing
vm
wontfix
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: clan/clan-core#11
No description provided.
Delete Branch "cli"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?