Fix orphan fragments with numbers #564

mdellweg · 2023-11-07T08:46:46Z

Description

Fixes #562

Checklist

Make sure changes are covered by existing or new tests.
For at least one Python version, make sure local test run is green.
Create a file in src/towncrier/newsfragments/. Describe your
change and include important information. Your change will be included in the public release notes.
Make sure all GitHub Actions checks are green (they are automatically checking all of the above).
Ensure docs/tutorial.rst is still up-to-date.
If you add new CLI arguments (or change the meaning of existing ones), make sure docs/cli.rst reflects those changes.
If you add new configuration options (or change the meaning of existing ones), make sure docs/configuration.rst reflects those changes.

adiroiban · 2023-11-07T09:03:19Z

We can discuss the changes here.

The test changes looks great. It should be enought to update the existing tests.

No need for a new tests... a new test would be nice... but the current one is also ok.

I see the updated tests failing. THat's excellent.

~~Not sure why 3.9 wasn't failing and also mypy 3.11~~ (it was the build job, not the test one)

adiroiban · 2023-11-07T09:08:09Z

.gitignore

@@ -17,6 +17,8 @@
 .vs/
 .vscode
 Justfile
+*egg-info/


I guess we can have this. I have this rule in my global gitignore file

good call.
Also this is a python project, so i'd expect that directory to exist eventually.

.gitignore

mdellweg · 2023-11-07T10:08:38Z

src/towncrier/test/test_build.py

@@ -70,9 +78,13 @@ def _test_command(self, command):
                --------

                - Baz levitation (baz)
-                - Baz fix levitation (#2)
+                - Baz fix levitation (fix-1.2)


I'm not so sure about this one. But i'd argue, that is what was actually meant by:
https://github.com/twisted/towncrier/pull/564/files#diff-36db088409efe07783d49792a18cec6ae3778ace338bf1cd08daa8a3fce29e93R45-R47

# NOTE: This allows news fragment names like fix-1.2.3.feature or # something-cool.feature.ext for projects that don't use ticket # numbers in news fragment names.

adiroiban · 2023-11-07T10:13:31Z

src/towncrier/test/test_build.py

@@ -70,9 +78,13 @@ def _test_command(self, command):
                --------

                - Baz levitation (baz)
-                - Baz fix levitation (#2)
+                - Baz fix levitation (fix-1.2)


I think that this need a better comment.

I don't really understant what is the use case here.

This is the bad part of bundling all kind of scenarios in a single test case.

# Towncrier supports files that have a dot in the name of the # newsfragment with open("foo/newsfragments/fix-1.2.feature", "w") as f: f.write("Baz fix levitation")

since it has no orphan marker, I would consider it an error, and the file should be rejected.

As per my comment above, I think this snippet was parsed wrongly. But I cannot find anything in the docs about it the only reference is the comment (_builder.py):

# NOTE: This allows news fragment names like fix-1.2.3.feature or # something-cool.feature.ext for projects that don't use ticket # numbers in news fragment names.

And I do not think that in that case "3" was meant to be an issue number.

Also I read the comment you cited as the "name of the newsfragment" being fix-1.2.

adiroiban · 2023-11-07T10:14:40Z

src/towncrier/test/test_build.py

@@ -405,6 +417,7 @@ def test_draft_no_date(self):
            call(["git", "init"])
            call(["git", "config", "user.name", "user"])
            call(["git", "config", "user.email", "[email protected]"])
+            call(["git", "config", "commit.gpgSign", "false"])


We might need to refactor this code into an helper function that does the git init for us.

I expect that this is needed in other tests.

We can leave this as it is for now.

There are numerous bad practices in the towncrier tests.
It would be nice to have them fix, but it should not be a burder for new contributors.

How about this?

src/towncrier/test/test_builder.py

adiroiban

Thanks for the PR.
I did a review now as I had some time.

This needs changes due to test_dots_in_ticket_name

This change introduces a regression.

If we decide that test_dots_in_ticket_name was a bug, we need to add a .removal news fragment for this PR to let others know that this use case is no longer supported and that it was removed.

But, it looks like test_dots_in_ticket_name is indeed a feature... it's just that it was not documented.

So we need to decide if we want to keep the undocumented feature, add documentation for it, or plan to remove this feature.

I hope that we can keep this feature.

adiroiban · 2023-11-07T12:20:54Z

src/towncrier/test/test_builder.py

@@ -8,63 +8,73 @@

 class TestParseNewsfragmentBasename(TestCase):
    def test_simple(self):
+        """Plain <number>.<category> should be valid with counter=0."""


We can leave these comments.

Just a note, if you have time to make them better

I recommend this read ... is not log https://jml.io/test-docstrings/

Maybe

Suggested change

"""Plain <number>.<category> should be valid with counter=0."""

"""

<number>.<category> generates a counter value of 0.

"""

adiroiban · 2023-11-07T12:28:19Z

src/towncrier/test/helpers.py

@@ -69,3 +70,43 @@ def setup_simple_project(

    if mkdir_newsfragments:
        Path("foo/newsfragments").mkdir()
+
+
+def with_isolated_simple_project(


Thanks for the refactoring.

I know that we already have setup_simple_project

The test decorators are all about isolation.

And not sure if "simple" has value.

Do we also have "with_isolated_complex_project" ?

Suggested change

def with_isolated_simple_project(

def with_project(

Can we have a docstring for this function?

I think that in the docstring we can have more details about what is considered "simple".

My main goal for the docstring is to describe the intended use cases for each argument.

With that, you can decide if you need to extend this function, or create a new one (that for example is more complex)

adiroiban · 2023-11-07T12:28:49Z

src/towncrier/test/test_build.py

-            result = runner.invoke(command, ["--draft", "--date", "01-01-2001"])
+    @with_isolated_simple_project()
+    def _test_command(self, command, runner):
+        # Off the shelf newsfragment


What does this comment mean ?

I consider this the archetype of a newsfragment. (One line down; this is not a docstring...) How would you call it?

adiroiban · 2023-11-07T12:34:55Z

src/towncrier/test/helpers.py

+
+def with_isolated_simple_project(
+    *,
+    with_git=False,


I am not a big fan of flag arguments.

I prefer something like @with_project and @with_git_project . but we can have this like this, as long as the intended usage of with_git is documented.

adiroiban · 2023-11-07T12:35:23Z

src/towncrier/test/helpers.py

+def with_isolated_simple_project(
+    *,
+    with_git=False,
+    config: str | None = None,


maybe config can be dedented by default, so that we don't have to always call dedent.

By forcing the usage of dedent, it should make the tests easier to read.
We no longer have to do list concatenation

adiroiban · 2023-11-07T12:39:33Z

src/towncrier/test/helpers.py

+    *,
+    with_git=False,
+    config: str | None = None,
+    extra_config: str = "",


Just a comment. Not sure if it make sense to keep this.

I find it easier to read a test, if it has the full configuration.

adiroiban

Changes look very good. Many thanks.

I think that the only major comment is the missing release note for the fix.1.2.3.bugfix change.

We should add a note about this in the relese note, so that people who were accidentally relying on this bug, should know about it and switch to orphan marker.

The others are just minor comments. Nothing to block the merge.

Thanks again!

mdellweg · 2023-11-07T12:47:29Z

I'm going to separate the test rewrite into a different PR for easier review.

adiroiban · 2023-11-07T12:50:52Z

I'm going to separate the test rewrite into a different PR for easier review.

That would be awesome. Much appreciated.

src/towncrier/newsfragments/562.removal

src/towncrier/newsfragments/562.bugfix

adiroiban

Looks good. Thanks.

I am not sure we have a removal here.
I think there are just 2 bugfixes.

fixes twisted#562 Co-authored-by: Adi Roiban <[email protected]>

mdellweg · 2023-11-07T13:48:40Z

I believe i updated the fragments as you wanted (tried to fix any typo found...).

adiroiban · 2023-11-07T15:55:45Z

Many thanks. Great work. I have merged it and I will try to get a new release

mdellweg · 2023-11-07T16:06:37Z

Thank you for the quick reviews!

Add test for orphan fragments with numbers

ae9f321

mdellweg mentioned this pull request Nov 7, 2023

orphan fragments that contain a number in the filename are linked to issues. #562

Closed

adiroiban reviewed Nov 7, 2023

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

mdellweg changed the title ~~WIP: Fix orphan fragments with numbers~~ Fix orphan fragments with numbers Nov 7, 2023

mdellweg force-pushed the 562_adopted_orphan branch from dc6cede to 6dae5de Compare November 7, 2023 10:06

mdellweg commented Nov 7, 2023

View reviewed changes

mdellweg marked this pull request as ready for review November 7, 2023 10:11

mdellweg requested a review from a team as a code owner November 7, 2023 10:11

adiroiban reviewed Nov 7, 2023

View reviewed changes

src/towncrier/test/test_builder.py Show resolved Hide resolved

adiroiban reviewed Nov 7, 2023

View reviewed changes

src/towncrier/test/test_builder.py Show resolved Hide resolved

adiroiban requested changes Nov 7, 2023

View reviewed changes

mdellweg force-pushed the 562_adopted_orphan branch from 6dae5de to 132c8a3 Compare November 7, 2023 11:52

adiroiban reviewed Nov 7, 2023

View reviewed changes

adiroiban requested changes Nov 7, 2023

View reviewed changes

mdellweg force-pushed the 562_adopted_orphan branch from 774f6cf to 1a27fa3 Compare November 7, 2023 13:12

adiroiban reviewed Nov 7, 2023

View reviewed changes

src/towncrier/newsfragments/562.removal Outdated Show resolved Hide resolved

adiroiban reviewed Nov 7, 2023

View reviewed changes

src/towncrier/newsfragments/562.bugfix Outdated Show resolved Hide resolved

adiroiban approved these changes Nov 7, 2023

View reviewed changes

Fix fragment parsing with stray numbers and dots

16975ed

fixes twisted#562 Co-authored-by: Adi Roiban <[email protected]>

mdellweg force-pushed the 562_adopted_orphan branch from 61cb027 to 16975ed Compare November 7, 2023 13:47

adiroiban merged commit 3b27ce2 into twisted:trunk Nov 7, 2023
15 checks passed

mdellweg deleted the 562_adopted_orphan branch November 7, 2023 16:06

mdellweg mentioned this pull request Nov 7, 2023

Update for pulpcore 3.40 compatibility pulp/pulp_python#628

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix orphan fragments with numbers #564

Fix orphan fragments with numbers #564

mdellweg commented Nov 7, 2023 •

edited by adiroiban

Loading

adiroiban commented Nov 7, 2023 •

edited

Loading

adiroiban Nov 7, 2023

mdellweg Nov 7, 2023

mdellweg Nov 7, 2023

adiroiban Nov 7, 2023

mdellweg Nov 7, 2023

mdellweg Nov 7, 2023

adiroiban Nov 7, 2023 •

edited

Loading

mdellweg Nov 7, 2023

adiroiban left a comment

adiroiban Nov 7, 2023

adiroiban Nov 7, 2023

adiroiban Nov 7, 2023

mdellweg Nov 7, 2023

adiroiban Nov 7, 2023

adiroiban Nov 7, 2023 •

edited

Loading

adiroiban Nov 7, 2023

adiroiban left a comment

mdellweg commented Nov 7, 2023

adiroiban commented Nov 7, 2023

adiroiban left a comment

mdellweg commented Nov 7, 2023

adiroiban commented Nov 7, 2023

mdellweg commented Nov 7, 2023

Fix orphan fragments with numbers #564

Fix orphan fragments with numbers #564

Conversation

mdellweg commented Nov 7, 2023 • edited by adiroiban Loading

Description

Checklist

adiroiban commented Nov 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adiroiban Nov 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adiroiban left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adiroiban Nov 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adiroiban left a comment

Choose a reason for hiding this comment

mdellweg commented Nov 7, 2023

adiroiban commented Nov 7, 2023

adiroiban left a comment

Choose a reason for hiding this comment

mdellweg commented Nov 7, 2023

adiroiban commented Nov 7, 2023

mdellweg commented Nov 7, 2023

mdellweg commented Nov 7, 2023 •

edited by adiroiban

Loading

adiroiban commented Nov 7, 2023 •

edited

Loading

adiroiban Nov 7, 2023 •

edited

Loading

adiroiban Nov 7, 2023 •

edited

Loading