DAOS-12950 test: auto-determine test tags

.github/workflows/linting.yml

@@ -40,3 +40,14 @@ jobs:
           ref: ${{ github.event.pull_request.head.sha }}
       - name: Check DAOS logging macro use.
         run: ./utils/cq/d_logging_check.py --github src
+
+  ftest-tags:
+    name: Ftest tag check
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: Check DAOS ftest tags.
+        run: ./src/tests/ftest/tags.py lint

Jenkinsfile

@@ -326,7 +326,7 @@ pipeline {
         stage('Get Commit Message') {
             steps {
                 script {
-                    env.COMMIT_MESSAGE = sh(script: 'git show -s --format=%B',
+                    env.COMMIT_MESSAGE = sh(script: 'ci/get_commit_message.py --target origin/' + target_branch,
                                             returnStdout: true).trim()
                     Map pragmas = [:]
                     // can't use eachLine() here: https://issues.jenkins.io/browse/JENKINS-46988/

ci/get_commit_message.py

@@ -0,0 +1,127 @@
+#!/usr/bin/env python3
+"""Get the latest commit message with some modifications."""
+
+import importlib.util
+import os
+import re
+import subprocess  # nosec
+from argparse import ArgumentParser
+
+PARENT_DIR = os.path.dirname(__file__)
+
+
+# Dynamically load the tags
+tags_path = os.path.realpath(
+    os.path.join(PARENT_DIR, '..', 'src', 'tests', 'ftest', 'tags.py'))
+tags_spec = importlib.util.spec_from_file_location('tags', tags_path)
+tags = importlib.util.module_from_spec(tags_spec)
+tags_spec.loader.exec_module(tags)
+
+
+def git_commit_message():
+    """Get the latest git commit message.
+
+    Returns:
+        str: the commit message
+    """
+    result = subprocess.run(
+        ['git', 'show', '-s', '--format=%B'],
+        stdout=subprocess.PIPE, check=True, cwd=PARENT_DIR)
+    return result.stdout.decode().rstrip('\n')
+
+
+def git_root_dir():
+    """Get the git root directory.
+
+    Returns:
+        str: the root directory path
+    """
+    result = subprocess.run(
+        ['git', 'rev-parse', '--show-toplevel'],
+        stdout=subprocess.PIPE, check=True, cwd=PARENT_DIR)
+    return result.stdout.decode().rstrip('\n')
+
+
+def git_files_changed(target):
+    """Get a list of files from git diff.
+
+    Args:
+        target (str): target branch or commit.
+
+    Returns:
+        list: absolute paths of modified files
+    """
+    git_root = git_root_dir()
+    result = subprocess.run(
+        ['git', 'diff', target, '--name-only', '--relative'],
+        stdout=subprocess.PIPE, cwd=git_root, check=True)
+    return [os.path.join(git_root, path) for path in result.stdout.decode().split('\n') if path]
+
+
+def modify_commit_message_pragmas(commit_message, target):
+    """Modify the commit message pragmas.
+
+    TODO: if a commit already has Test-tag, do not overwrite. Just comment the suggested.
+
+    Args:
+        commit_message (str): the original commit message
+        target (str): where the current branch is intended to be merged
+
+    Returns:
+        str: the modified commit message
+    """
+    modified_files = git_files_changed(target)
+
+    rec_tags = tags.files_to_tags(modified_files)
+    commit_tags = set()
+
+    # Extract all "Features" and "Test-tag"
+    feature_tags = re.findall(
+        r'^Features:(.*)$', commit_message, flags=re.MULTILINE | re.IGNORECASE)
+    if feature_tags:
+        for _tags in feature_tags:
+            commit_tags.update(filter(None, _tags.split(' ')))
+        commit_message = re.sub(
+            r'^Features:.*$', '', commit_message, flags=re.MULTILINE | re.IGNORECASE)
+    test_tags = re.findall(
+        r'^Test-tag:(.*)$', commit_message, flags=re.MULTILINE | re.IGNORECASE)
+    if test_tags:
+        for _tags in test_tags:
+            commit_tags.update(filter(None, _tags.split(' ')))
+        commit_message = re.sub(
+            r'^Test-tag:.*$', '', commit_message, flags=re.MULTILINE | re.IGNORECASE)
+
+    # Put "Test-tag" after the title
+    commit_message_split = commit_message.splitlines()
+    commit_message_split.insert(1, '')
+    if test_tags:
+        # Keep the commit tags but leave a comment with the recommended
+        commit_message_split.insert(2, f'Test-tag: {" ".join(sorted(commit_tags))}')
+        commit_message_split.insert(3, '# Auto-recommended Test-tag')
+        commit_message_split.insert(4, f'# Test-tag: {" ".join(sorted(rec_tags))}')
+        commit_message_split.insert(5, '')
+    else:
+        # If there were "Feature" tags, merge into the recommended.
+        # Otherwise, just use the recommended.
+        rec_tags.update(commit_tags)
+        commit_message_split.insert(2, '# Auto-recommended Test-tag')
+        commit_message_split.insert(3, f'Test-tag: {" ".join(sorted(rec_tags))}')
+        commit_message_split.insert(4, '')
+    return os.linesep.join(commit_message_split)
+
+
+def main():
+    parser = ArgumentParser()
+    parser.add_argument(
+        "--target",
+        help="if given, used to modify commit pragmas")
+    args = parser.parse_args()
+
+    if args.target:
+        print(modify_commit_message_pragmas(git_commit_message(), args.target))
+    else:
+        print(git_commit_message())
+
+
+if __name__ == '__main__':
+    main()

debian/changelog

@@ -1,4 +1,10 @@
-daos (2.5.100-10) unstable; urgency=medium
+daos (2.5.100-11) unstable; urgency=medium
+  [ Dalton Bohning ]
+  * Add tags.py
+
+ -- Dalton Bohning <[email protected]>  Wed, 08 Nov 2023 12:00:00 -0500
+
+ daos (2.5.100-10) unstable; urgency=medium
   [ Phillip Henderson ]
   * Move verify_perms.py location
 

src/container/srv_container.c

@@ -6,6 +6,7 @@
 /**
  * \file
  *
+ * dummy change
  * ds_cont: Container Operations
  *
  * This file contains the server API methods and the RPC handlers that are both

src/tests/ftest/datamover/dst_create.yaml

@@ -1,3 +1,4 @@
+# Dummy change
 hosts:
   test_servers: 1
   test_clients: 1

src/tests/ftest/dfuse/mu_mount.py

@@ -10,6 +10,8 @@
 from dfuse_test_base import DfuseTestBase
 from run_utils import command_as_user, run_remote
 
+# Dummy change
+
 
 class DfuseMUMount(DfuseTestBase):
     """Verifies multi-user dfuse mounting"""

src/tests/ftest/dfuse/mu_perms.py

@@ -13,6 +13,8 @@
 from run_utils import command_as_user, run_remote
 from user_utils import get_chown_command
 
+# Dummy change
+
 
 class DfuseMUPerms(DfuseTestBase):
     """Verify dfuse multi-user basic permissions."""

src/tests/ftest/nvme/object.py

@@ -64,7 +64,7 @@ def container_read(container, array_size=None):
         # read written objects and verify
         container.read_objects()
 
-    def test_runner(self, namespace, record_size, array_size, thread_per_size=4):
+    def run_test(self, namespace, record_size, array_size, thread_per_size=4):
         """Perform simultaneous writes of varying record size to a container.
 
         Args:
@@ -143,7 +143,7 @@ def test_nvme_object_single_pool(self):
         :avocado: tags=NvmeObject,test_nvme_object_single_pool
         """
         # perform multiple object writes to a single pool
-        self.test_runner("/run/pool_1/*", self.record_size[:-1], 0, self.array_size)
+        self.run_test("/run/pool_1/*", self.record_size[:-1], 0, self.array_size)
         report_errors(self, self.errors)
 
     @avocado.fail_on(DaosApiError)
@@ -165,7 +165,7 @@ def test_nvme_object_multiple_pools(self):
         :avocado: tags=NvmeObject,test_nvme_object_multiple_pools
         """
         # thread to perform simultaneous object writes to multiple pools
-        runner_manager = ThreadManager(self.test_runner, self.get_remaining_time() - 30)
+        runner_manager = ThreadManager(self.run_test, self.get_remaining_time() - 30)
         runner_manager.add(
             namespace='/run/pool_1/*', record_size=self.record_size, array_size=self.array_size)
         runner_manager.add(
@@ -178,6 +178,6 @@ def test_nvme_object_multiple_pools(self):
                 self.errors.append(result.result)
         report_errors(self, self.errors)
 
-        # run the test_runner after cleaning up all the pools for large nvme_pool size
-        self.test_runner("/run/pool_3/*", self.record_size, self.array_size)
+        # run again after cleaning up all the pools for large nvme_pool size
+        self.run_test("/run/pool_3/*", self.record_size, self.array_size)
         report_errors(self, self.errors)