Implement the new core key author

docs/releases.rst

@@ -17,6 +17,13 @@ for tmt. It is used by plugins that use Ansible under the hood,
 :ref:`finish/ansible</plugins/finish/ansible>`,
 and :ref:`prepare/feature</plugins/prepare/feature>`.
 
+A new core attribute :ref:`/spec/core/author` has been implemented
+for tracking the original author of the test, plan or story. In
+contrast to the :ref:`/spec/core/contact` key, this field is not
+supposed to be updated and can be useful when trying to track down
+the original author for consultation.
+
+
 tmt-1.41.0
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

spec/core/author.fmf

@@ -0,0 +1,32 @@
+summary: Author contact
+
+story:
+    As a user I would like to contact the original author of the
+    test, plan or story without having to dig through the git
+    history or check various random files.
+
+description: |
+    This dedicated field provides a standard location for
+    the original author's information, as it can be scattered
+    across various places and may be difficult to locate.
+    Additionally, when a test is moved to a different Git
+    repository, the original author's information can be lost.
+
+    .. versionadded:: 1.42
+
+example:
+  - |
+    # Single author
+    author: Name Surname <[email protected]>
+
+  - |
+    # Multiple authors
+    author:
+      - First Person <[email protected]>
+      - Second Person <[email protected]>
+
+link:
+  - implemented-by: /tmt/base.py
+  - verified-by: /tests/plan/show
+  - verified-by: /tests/story/show
+  - verified-by: /tests/test/show

tests/plan/show/data/plans/full.fmf

@@ -1,6 +1,7 @@
 # Core
 summary: Plan keys are correctly displayed
 description: Some description
+author: Original Author <[email protected]>
 contact: Some Body <[email protected]>
 id: e3a9a8ed-4585-4e86-80e8-1d99eb5345a9
 enabled: true

tests/plan/show/test.sh

@@ -128,6 +128,7 @@ rlJournalStart
         rlAssertGrep "summary Plan keys are correctly displayed" $rlRun_LOG
         rlAssertGrep "description Some description" $rlRun_LOG
         rlAssertGrep "contact Some Body <[email protected]>" $rlRun_LOG
+        rlAssertGrep "author Original Author <[email protected]>" $rlRun_LOG
         rlAssertGrep "id e3a9a8ed-4585-4e86-80e8-1d99eb5345a9" $rlRun_LOG
         rlAssertGrep "enabled true" $rlRun_LOG
         rlAssertGrep "order 70" $rlRun_LOG

tests/story/show/data/stories/full.fmf

@@ -2,6 +2,7 @@ summary: Story keys are correctly displayed
 title: Concise title
 story: As a user I want this and that
 description: Some description
+author: Original Author <[email protected]>
 contact: Some Body <[email protected]>
 priority: must have
 example: Inspiring example

tests/story/show/test.sh

@@ -29,6 +29,7 @@ rlJournalStart
         rlAssertGrep "title Concise title" $rlRun_LOG
         rlAssertGrep "story As a user I want this and that" $rlRun_LOG
         rlAssertGrep "description Some description" $rlRun_LOG
+        rlAssertGrep "author Original Author <[email protected]>" $rlRun_LOG
         rlAssertGrep "contact Some Body <[email protected]>" $rlRun_LOG
         rlAssertGrep "priority must have" $rlRun_LOG
         rlAssertGrep "example Inspiring example" $rlRun_LOG

tests/test/show/data/tests/full.fmf

@@ -1,5 +1,6 @@
 summary: Check the test keys are correctly displayed
 description: Some description
+author: Original Author <[email protected]>
 contact: Some Body <[email protected]>
 component: package
 id: e3a9a8ed-4585-4e86-80e8-1d99eb5345a9

tests/test/show/test.sh

@@ -34,6 +34,7 @@ rlJournalStart
         rlRun -s "tmt tests show full"
         rlAssertGrep "summary Check the test keys are correctly displayed" $rlRun_LOG
         rlAssertGrep "description Some description" $rlRun_LOG
+        rlAssertGrep "author Original Author <[email protected]>" $rlRun_LOG
         rlAssertGrep "contact Some Body <[email protected]>" $rlRun_LOG
         rlAssertGrep "component package" $rlRun_LOG
         rlAssertGrep "id e3a9a8ed-4585-4e86-80e8-1d99eb5345a9" $rlRun_LOG

tmt/base.py

@@ -667,6 +667,10 @@ class Core(
     # Core attributes (supported across all levels)
     summary: Optional[str] = None
     description: Optional[str] = None
+    author: list[str] = field(
+        default_factory=list,
+        normalize=tmt.utils.normalize_string_list
+        )
     contact: list[str] = field(
         default_factory=list,
         normalize=tmt.utils.normalize_string_list
@@ -697,6 +701,7 @@ class Core(
         # Basic stuff
         'summary',
         'description',
+        'author',
         'contact',
         'enabled',
         'order',
@@ -1117,6 +1122,7 @@ class Test(
         # Basic test information
         'summary',
         'description',
+        'author',
         'contact',
         'component',
         'id',
@@ -2136,9 +2142,10 @@ def show(self) -> None:
         if self.description:
             echo(tmt.utils.format(
                 'description', self.description, key_color='green'))
+        if self.author:
+            echo(tmt.utils.format('author', self.author, key_color='green'))
         if self.contact:
-            echo(tmt.utils.format(
-                'contact', self.contact, key_color='green'))
+            echo(tmt.utils.format('contact', self.contact, key_color='green'))
 
         # Individual step details
         for step in self.steps(enabled_only=False):
@@ -2676,6 +2683,7 @@ class Story(
         'id',
         'priority',
         'description',
+        'author',
         'contact',
         'example',
         'enabled',

tmt/schemas/core.yaml

@@ -17,6 +17,10 @@ definitions:
       - type: array
       - type: object
 
+  # https://tmt.readthedocs.io/en/stable/spec/core.html#author
+  author:
+    $ref: "/schemas/common#/definitions/one_or_more_strings"
+
   # https://tmt.readthedocs.io/en/stable/spec/core.html#contact
   contact:
     $ref: "/schemas/common#/definitions/one_or_more_strings"

tmt/schemas/discover/shell.yaml

@@ -68,6 +68,10 @@ properties:
         adjust:
           $ref: "/schemas/core#/definitions/adjust"
 
+        # https://tmt.readthedocs.io/en/stable/spec/core.html#author
+        author:
+          $ref: "/schemas/core#/definitions/author"
+
         # https://tmt.readthedocs.io/en/stable/spec/tests.html#component
         component:
           $ref: "/schemas/test#/properties/component"

tmt/schemas/plan.yaml

@@ -18,6 +18,10 @@ properties:
   adjust:
     $ref: "/schemas/core#/definitions/adjust"
 
+  # https://tmt.readthedocs.io/en/stable/spec/core.html#author
+  author:
+    $ref: "/schemas/core#/definitions/author"
+
   # https://tmt.readthedocs.io/en/stable/spec/core.html#contact
   contact:
     $ref: "/schemas/core#/definitions/contact"

tmt/schemas/story.yaml

@@ -18,6 +18,10 @@ properties:
   adjust:
     $ref: "/schemas/core#/definitions/adjust"
 
+  # https://tmt.readthedocs.io/en/stable/spec/core.html#author
+  author:
+    $ref: "/schemas/core#/definitions/author"
+
   # https://tmt.readthedocs.io/en/stable/spec/core.html#contact
   contact:
     $ref: "/schemas/core#/definitions/contact"

tmt/schemas/test.yaml

@@ -18,6 +18,10 @@ properties:
   adjust:
     $ref: "/schemas/core#/definitions/adjust"
 
+  # https://tmt.readthedocs.io/en/stable/spec/core.html#author
+  author:
+    $ref: "/schemas/core#/definitions/author"
+
   # https://tmt.readthedocs.io/en/stable/spec/tests.html#component
   component:
     $ref: "/schemas/common#/definitions/one_or_more_strings"

tmt/steps/discover/shell.py

@@ -92,6 +92,10 @@ class TestDescription(
         )
 
     # Basic test information
+    author: list[str] = field(
+        default_factory=list,
+        normalize=tmt.utils.normalize_string_list
+        )
     contact: list[str] = field(
         default_factory=list,
         normalize=tmt.utils.normalize_string_list

tmt/steps/report/reportportal.py

@@ -617,6 +617,9 @@ def execute_rp_import(self) -> None:
                     serial_number = test.serial_number
                     if not test_name:
                         test_name = test.name
+                    if test.author:
+                        item_attributes += [
+                            {'key': 'author', 'value': author} for author in test.author]
                     if test.contact:
                         item_attributes += [
                             {'key': 'contact', 'value': contact} for contact in test.contact]