Test CLI using click.testing.CliRunner

Question

Test CLI using click.testing.CliRunner

bignose-debian opened this issue a year ago · comments

The unit test cases for CLI behaviour are using a 'click.testing.CliRunner', which correctly separates the Click behaviour to be tested, versus the particular way an executable program was or was not installed.

There are some remaining test cases that directly invoke a sub-process expecting the 'towncrier' command to be available. These should all use a 'click.testing.CliRunner' to avoid that coupling.

Ben Finney · Answer 1 · Wed Feb 15 2023 10:31:26 GMT+0800 (China Standard Time)

The branch wip/issue/481/use-clirunner-consistently (in my personal fork repository) contains a series of commits to address this issue.

The branch currently merges cleanly to the 'trunk' branch.

Chris Beaven · Answer 2 · Wed Feb 22 2023 14:27:35 GMT+0800 (China Standard Time)

The branch [wip/issue/481/use-clirunner-consistently]
The branch currently merges cleanly to the 'trunk' branch.

Sounds like you should open up a pull request against your branch then :)

Ben Finney · Answer 3 · Wed Feb 22 2023 15:11:23 GMT+0800 (China Standard Time)

Sounds like you should open up a pull request against your branch then :)

Unless I'm mistaken, GitHub has never been able to use its proprietary "pull request" system on remote repositories.

So it's up to the GitHub users to get changes from remote repositories, using the normal Git distributed features.

Adi Roiban · Answer 4 · Wed Feb 22 2023 20:23:34 GMT+0800 (China Standard Time)

Thanks Ben for creating this issue on GitHub.

I am sure that when someone will have time for towncrier maintance, they will pick up your changes and try to merge them.

I tried to do a quick review on Salsa, but it looks like trunk branch is not available

https://salsa.debian.org/bignose/towncrier/-/compare/trunk...wip%2Fissue%2F481%2Fuse-clirunner-consistently?from_project_id=35328&straight=false

I will not comment on GitHub vs GitLab.
I am not a supporter of MS nor GitHub.
But for now, GitHub it's what is used by Towncrier devs and it provides tools for open colaboration.

We don't have the resources to run our private GitLab :(

I tried to login into Debian Gitlab, but I got - Access blocked: Debian Salsa can only be used within its organisation :( ... and on the Debian docs I read "Your account will be locked until a gitlab administrator enables it." . I understand that spam accounts are hard to block.

Ben Finney · Answer 5 · Thu Feb 23 2023 06:09:45 GMT+0800 (China Standard Time)

But for now, GitHub it's what is used by Towncrier devs and it provides tools for open colaboration.

Since neither GitHub nor GitLab provide a way to openly collaborate between repository hosts, feel free to comment here on this issue, if you have suggestions or changes for my proposed merge.

Hynek Schlawack · Answer 6 · Fri Jun 23 2023 17:47:51 GMT+0800 (China Standard Time)

As Adi wrote, there's no way for us to extract a patch to apply since your repo lacks our main branch (trunk).

Ben Finney · Answer 7 · Thu Jun 29 2023 14:50:15 GMT+0800 (China Standard Time)

As Adi wrote, there's no way for us to extract a patch to apply

Note that there's no need to extract a patch; we're both using Git for version control, and our repositories are compatible using normal Git operations. You can bring the commits directly from another repository, no need to work with patch files.

Anyone working on this repository can get changes from remote repositories, using the normal Git distributed features.

I have now updated the branch so that it merges cleanly to the current 'trunk' branch; you can follow the above GitHub documentation, to bring those commits into your repository.