diff mbox series

patchtest: reject Upstream-Status after scissors

Message ID 20251215204507.1675-1-lukakrstic031@gmail.com
State New
Headers show
Series patchtest: reject Upstream-Status after scissors | expand

Commit Message

Luka Krstic Dec. 15, 2025, 8:45 p.m. UTC
From: l-krstic <lukakrstic031@gmail.com>

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.

Fixes: [YOCTO #15940]
Signed-off-by: Luka Krstic <lukakrstic031@gmail.com>
---
 meta/lib/patchtest/tests/test_patch.py | 109 +++++++++++++++++++------
 1 file changed, 86 insertions(+), 23 deletions(-)

Comments

Mathieu Dubois-Briand Dec. 17, 2025, 7:13 a.m. UTC | #1
On Mon Dec 15, 2025 at 9:45 PM CET, Luka Krstic via lists.openembedded.org wrote:
> From: l-krstic <lukakrstic031@gmail.com>
>
> 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.
>
> Fixes: [YOCTO #15940]
> Signed-off-by: Luka Krstic <lukakrstic031@gmail.com>
> ---

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
Mathieu Dubois-Briand Dec. 17, 2025, 12:20 p.m. UTC | #2
On Wed Dec 17, 2025 at 8:25 AM CET, Лука Крстић wrote:
> 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
diff mbox series

Patch

diff --git a/meta/lib/patchtest/tests/test_patch.py b/meta/lib/patchtest/tests/test_patch.py
index d7187a0cb1..08992fbfd1 100644
--- a/meta/lib/patchtest/tests/test_patch.py
+++ b/meta/lib/patchtest/tests/test_patch.py
@@ -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: