patchtest: reject Upstream-Status after scissors
PATCH 1/1 patchtest: reject Upstream-Status after scissors
From: l-krstic <[email protected]>
Upstream-Status must be placed in the patch header before the scissors line. patchtest currently accepts tags that appear only after the scissors, which means the tag is lost when the patch is refreshed by git or devtool.
Update test_upstream_status_presence_format() to distinguish between tags in the header and tags after the scissors, and reject the latter.
--- meta/lib/patchtest/tests/test_patch.py | 109 +++++++++++++++++++------ 1 file changed, 86 insertions(+), 23 deletions(-)
meta/lib/patchtest/tests/test_patch.py +86 -23
@@ -50,31 +50,94 @@ class TestPatch(base.Base): for newpatch in TestPatch.newpatches: payload = newpatch.__str__() - if not self.upstream_status_regex.search_string(payload): - self.fail('Added patch file is missing Upstream-Status: <Valid status> in the commit message', - data=[('Standard format', self.standard_format), ('Valid status', self.valid_status)]) - for line in payload.splitlines(): + lines = payload.splitlines() + + scissors_index = None + for idx, line in enumerate(lines): + if line.lstrip('+') == '---': + scissors_index = idx + break + + header_has_upstream = False + body_has_upstream = False + + for idx, line in enumerate(lines): + if not self.upstream_status_regex.search_string(line): + continue + if scissors_index is not None and idx > scissors_index: + body_has_upstream = True + else: + header_has_upstream = True + + if not header_has_upstream: + if body_has_upstream: + self.fail( + 'Upstream-Status is present only after the patch scissors ("---"). ' + 'It must be placed in the patch header before the scissors line.', + data=[ + ('Standard format', self.standard_format), + ('Valid status', self.valid_status), + ], + ) + else: + self.fail( + 'Added patch file is missing Upstream-Status: <Valid status> in the commit message', + data=[ + ('Standard format', self.standard_format), + ('Valid status', self.valid_status), + ], + ) + + for idx, line in enumerate(lines): if self.patchmetadata_regex.match(line): continue - if self.upstream_status_regex.search_string(line): - if parse_upstream_status.inappropriate_status_mark.searchString(line): - try: - parse_upstream_status.upstream_status_inappropriate_info.parseString(line.lstrip('+')) - except pyparsing.ParseException as pe: - self.fail('Upstream-Status is Inappropriate, but no reason was provided', - data=[('Current', pe.pstr), ('Standard format', 'Upstream-Status: Inappropriate [reason]')]) - elif parse_upstream_status.submitted_status_mark.searchString(line): - try: - parse_upstream_status.upstream_status_submitted_info.parseString(line.lstrip('+')) - except pyparsing.ParseException as pe: - self.fail('Upstream-Status is Submitted, but it is not mentioned where', - data=[('Current', pe.pstr), ('Standard format', 'Upstream-Status: Submitted [where]')]) - else: - try: - parse_upstream_status.upstream_status.parseString(line.lstrip('+')) - except pyparsing.ParseException as pe: - self.fail('Upstream-Status is in incorrect format', - data=[('Current', pe.pstr), ('Standard format', self.standard_format), ('Valid status', self.valid_status)]) + if not self.upstream_status_regex.search_string(line): + continue + if scissors_index is not None and idx > scissors_index: + self.fail( + 'Upstream-Status must be placed in the patch header before the scissors line ("---"), ' + 'but was found afterwards.', + data=[ + ('Current', line.lstrip('+')), + ('Standard format', self.standard_format), + ('Valid status', self.valid_status), + ], + ) + + if parse_upstream_status.inappropriate_status_mark.searchString(line): + try: + parse_upstream_status.upstream_status_inappropriate_info.parseString(line.lstrip('+')) + except pyparsing.ParseException as pe: + self.fail( + 'Upstream-Status is Inappropriate, but no reason was provided', + data=[ + ('Current', pe.pstr), + ('Standard format', 'Upstream-Status: Inappropriate [reason]'), + ], + ) + elif parse_upstream_status.submitted_status_mark.searchString(line): + try: + parse_upstream_status.upstream_status_submitted_info.parseString(line.lstrip('+')) + except pyparsing.ParseException as pe: + self.fail( + 'Upstream-Status is Submitted, but it is not mentioned where', + data=[ + ('Current', pe.pstr), + ('Standard format', 'Upstream-Status: Submitted [where]'), + ], + ) + else: + try: + parse_upstream_status.upstream_status.parseString(line.lstrip('+')) + except pyparsing.ParseException as pe: + self.fail( + 'Upstream-Status is in incorrect format', + data=[ + ('Current', pe.pstr), + ('Standard format', self.standard_format), + ('Valid status', self.valid_status), + ], + ) def test_signed_off_by_presence(self): if not TestPatch.newpatches:
Signature · 1 line
2.43.0
Quoted 7 lines · Luka Krstic via lists.openembedded.org
From: l-krstic <[email protected]>
Upstream-Status must be placed in the patch header before the scissors line. patchtest currently accepts tags that appear only after the scissors, which means the tag is lost when the patch is refreshed by git or devtool.
Quoted 7 lines
Update
test_upstream_status_presence_format()to distinguish between tags in the header and tags after the scissors, and reject the latter.Fixes [YOCTO #15940]Signed-off-by Luka Krstic <[email protected]>---
Hi Luka,
Thanks for your patch.
It is conflicting a lot with existing code on master branch: are you based on a recent master branch on your side?
Thanks,
Mathieu
Signature · 3 lines
Mathieu Dubois-Briand, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
A message that is not in the archive (sent off-list or not yet received): CABTLy3aZichqpsbZn3m84i-6b7_FdDgoCSkig3=SYQYWLvA66Q@mail.gmail.com
Quoted 6 lines · Лука Крстић
Hi Mathieu,
Thanks for the quick feedback.
I am based on the scarthgap branch.
I guess that is not good. Can you tell me what should be the base?
Hi Luka,
So I believe you wanted to get this patch merged in the scarthgap branch, which raises two points:
- any change you want to contribute in a stable branch must have been first accepted in the master branch, except if it does not make sense to merge it in master.
- patches targeting a stable branch must include the branch name in the mail prefix.
More details can be found here:
https://docs.yoctoproject.org/dev/contributor-guide/submit-changes.html#submitting-changes-to-stable-release-branches
So given the content of your patch, I believe this should be first merged in master.
Also, backport in stable branches should be reserved to bug or security fixes. I'm not involved in this decision, but I'm not fully convinced this patch meets the requirements.
Thanks,
Mathieu
Signature · 3 lines
Mathieu Dubois-Briand, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
A message that is not in the archive (sent off-list or not yet received): [email protected]
PATCH v2 1/1 patchtest: reject Upstream-Status after scissors
Upstream-Status must be placed in the patch header before the scissors line. patchtest currently accepts tags that appear only after the scissors, which means the tag is lost when the patch is refreshed by git or devtool.
Update test_upstream_status_presence_format() to distinguish between tags in the header and tags after the scissors, and reject the latter.
--- meta/lib/patchtest/tests/test_patch.py | 153 ++++++++++++++++--------- 1 file changed, 99 insertions(+), 54 deletions(-)
meta/lib/patchtest/tests/test_patch.py +99 -54
@@ -45,62 +45,107 @@ class TestPatch(base.Base): for newpatch in TestPatch.newpatches: payload = newpatch.__str__() - if not patchtest_patterns.upstream_status_regex.search_string(payload): - self.fail( - "Added patch file is missing Upstream-Status: <Valid status> in the commit message", - data=[ - ("Standard format", self.standard_format), - ("Valid status", self.valid_status), - ], - ) - for line in payload.splitlines(): + lines = payload.splitlines() + + scissors_index = None + for idx, line in enumerate(lines): + if line.lstrip("+") == "---": + scissors_index = idx + break + + header_has_upstream = False + body_has_upstream = False + + for idx, line in enumerate(lines): + if not patchtest_patterns.upstream_status_regex.search_string(line): + continue + + if scissors_index is not None and idx > scissors_index: + body_has_upstream = True + else: + header_has_upstream = True + + if not header_has_upstream: + if body_has_upstream: + self.fail( + 'Upstream-Status is present only after the patch scissors. ' + "It must be placed in the patch header before the scissors line.", + data=[ + ("Standard format", self.standard_format), + ("Valid status", self.valid_status), + ], + ) + else: + self.fail( + "Added patch file is missing Upstream-Status: <Valid status> in the commit message", + data=[ + ("Standard format", self.standard_format), + ("Valid status", self.valid_status), + ], + ) + + for idx, line in enumerate(lines): if patchtest_patterns.patchmetadata_regex.match(line): continue - if patchtest_patterns.upstream_status_regex.search_string(line): - if patchtest_patterns.inappropriate.searchString(line): - try: - patchtest_patterns.upstream_status_inappropriate_info.parseString( - line.lstrip("+") - ) - except pyparsing.ParseException as pe: - self.fail( - "Upstream-Status is Inappropriate, but no reason was provided", - data=[ - ("Current", pe.pstr), - ( - "Standard format", - "Upstream-Status: Inappropriate [reason]", - ), - ], - ) - elif patchtest_patterns.submitted.searchString(line): - try: - patchtest_patterns.upstream_status_submitted_info.parseString( - line.lstrip("+") - ) - except pyparsing.ParseException as pe: - self.fail( - "Upstream-Status is Submitted, but it is not mentioned where", - data=[ - ("Current", pe.pstr), - ( - "Standard format", - "Upstream-Status: Submitted [where]", - ), - ], - ) - else: - try: - patchtest_patterns.upstream_status.parseString(line.lstrip("+")) - except pyparsing.ParseException as pe: - self.fail( - "Upstream-Status is in incorrect format", - data=[ - ("Current", pe.pstr), - ("Standard format", self.standard_format), - ("Valid status", self.valid_status), - ], - ) + + if not patchtest_patterns.upstream_status_regex.search_string(line): + continue + + if scissors_index is not None and idx > scissors_index: + self.fail( + 'Upstream-Status must be placed in the patch header before the scissors line, ' + "but was found afterwards.", + data=[ + ("Current", line.lstrip("+")), + ("Standard format", self.standard_format), + ("Valid status", self.valid_status), + ], + ) + + if patchtest_patterns.inappropriate.searchString(line): + try: + patchtest_patterns.upstream_status_inappropriate_info.parseString( + line.lstrip("+") + ) + except pyparsing.ParseException as pe: + self.fail( + "Upstream-Status is Inappropriate, but no reason was provided", + data=[ + ("Current", pe.pstr), + ( + "Standard format", + "Upstream-Status: Inappropriate [reason]", + ), + ], + ) + elif patchtest_patterns.submitted.searchString(line): + try: + patchtest_patterns.upstream_status_submitted_info.parseString( + line.lstrip("+") + ) + except pyparsing.ParseException as pe: + self.fail( + "Upstream-Status is Submitted, but it is not mentioned where", + data=[ + ("Current", pe.pstr), + ( + "Standard format", + "Upstream-Status: Submitted [where]", + ), + ], + ) + else: + try: + patchtest_patterns.upstream_status.parseString(line.lstrip("+")) + except pyparsing.ParseException as pe: + self.fail( + "Upstream-Status is in incorrect format", + data=[ + ("Current", pe.pstr), + ("Standard format", self.standard_format), + ("Valid status", self.valid_status), + ], + ) def test_signed_off_by_presence(self): if not TestPatch.newpatches:
Signature · 1 line
2.43.0