kdevops_archive: enhance commit and archive placement

The commit log on kdevops-results-archive does not provide much
details, we can't even tell what tree this was triggered from.
So enhance all this and add extra CI files the test runner could
populate in case it wanted to help users of kdevops-results-archive
or bots that scrape it for analysis of results.

New optional CI metadata files for kdevops archive:

  ci.trigger   - should be set by the repo basename name that triggered the test
                 like linux-radix-tree-kpd or linux-modules-kpd or
                 kdevops ... and so on
  ci.subject   - should be set to the last commit in your repo
                 tree that triggered this CI event, so this was designed
                 for something like 'git log -1 --pretty=format:"%s"'
  ci.result    - Test outcome status:
		 - ok
                 - not ok
                 - WTF
  ci.commit_extra - Additional details to include in commit message into
                    kdevops-results-archive. Whatever you want buddy.

All files are optional with these defaults:
  ci.trigger   -> target_linux_tree
  ci.subject   -> "${target_linux_tree} ${target_linux_ref} result #${test_number}"
  ci.result    -> "unknown"
  ci.commit_extra -> "No extra test report details available."

Also use the subject prefix of the ci.subject as you would get if
you use git format-patch on it, for the directory name where we
place your zip file. This lets you easily find the zip file for
posted patches on the mailing list fast.

Signed-off-by: Luis Chamberlain <[email protected]>

Author: mcgrof

playbooks/roles/kdevops_archive/defaults/main.yml

@@ -15,4 +15,9 @@ kdevops_archive_demo: False
 bootlinux_tree_set_by_cli: False
 kdevops_archive_base: "selftests/gh/linux-modules-kpd/20241021"
 kdevops_archive_test_number: "0001"
-kdevops_archive_prefix: "{{ kdevops_archive_base }}/{{ kdevops_archive_next_number }}/v6.12-rc4/"
+kdevops_archive_prefix: "{{ kdevops_archive_base }}/{{ kdevops_archive_test_number }}/v6.12-rc4/"
+kdevops_archive_test_trigger: "linux-radix-tree-kbd"
+kdevops_archive_test_subject: "maple_tree: dump error message based on format"
+kdevops_archive_ci_subject_patchform_name: "maple_tree-dump-error-message-based-on-format"
+kdevops_archive_ci_test_result: "unknown"
+kdevops_archive_test_commit: "Elaborate here on test details."

playbooks/roles/kdevops_archive/tasks/main.yml

@@ -218,36 +218,41 @@
   when:
     - 'kdevops_archive_demo|bool'
 
-- name: Get current date in YYYYMMDD format
+- name: Check if ci.trigger file exists
+  stat:
+    path: "{{ topdir_path }}/ci.trigger"
+  register: ci_trigger_file
+
+- name: Read ci.trigger file if it exists
+  slurp:
+    path: "{{ topdir_path }}/ci.trigger"
+  register: ci_trigger_content
+  when: ci_trigger_file.stat.exists
+
+- name: Set kdevops_archive_test_subject from ci.trigger
   set_fact:
-    current_date: "{{ '%Y%m%d' | strftime }}"
+    kdevops_archive_test_trigger: "{{ ci_trigger_content.content | b64decode | trim }}"
+  when: ci_trigger_file.stat.exists
 
-- name: Construct base directory path
+- name: Set kdevops_archive_test_subject in case ci.trigger is not set
   set_fact:
-    kdevops_archive_base: "{{ kdevops_workflow_name }}/{{ current_user.stdout }}/{{ target_linux_tree }}/{{ current_date }}"
+    kdevops_archive_test_trigger: "{{ target_linux_tree }}"
+  when: not ci_trigger_file.stat.exists
 
 - name: Get current date in YYYYMMDD format
   set_fact:
     current_date: "{{ '%Y%m%d' | strftime }}"
 
 - name: Construct base directory path
   set_fact:
-    kdevops_archive_base: "{{ kdevops_workflow_name }}/{{ current_user.stdout }}/{{ target_linux_tree }}/{{ current_date }}"
+    kdevops_archive_base: "{{ kdevops_workflow_name }}/{{ current_user.stdout }}/{{ kdevops_archive_test_trigger }}/{{ current_date }}"
 
 - name: Ensure base directory exists
   file:
     path: "{{ kdevops_results_archive_dir }}/{{ kdevops_archive_base }}"
     state: directory
     mode: '0755'
 
-- name: Get current date in YYYYMMDD format
-  set_fact:
-    current_date: "{{ '%Y%m%d' | strftime }}"
-
-- name: Construct base directory path
-  set_fact:
-    kdevops_archive_base: "{{ kdevops_workflow_name }}/{{ current_user.stdout }}/{{ target_linux_tree }}/{{ current_date }}"
-
 - name: List all directories in base path
   find:
     paths: "{{ kdevops_results_archive_dir }}/{{ kdevops_archive_base }}"
@@ -278,13 +283,43 @@
   set_fact:
     kdevops_archive_test_number: "{{ next_number }}"
 
-- name: Set complete archive prefix
+- name: Check if ci.subject file exists
+  stat:
+    path: "{{ topdir_path }}/ci.subject"
+  register: ci_subject_file
+
+- name: Read ci.subject file if it exists
+  slurp:
+    path: "{{ topdir_path }}/ci.subject"
+  register: ci_subject_content
+  when: ci_subject_file.stat.exists
+
+- name: Set kdevops_archive_test_subject from ci.subject
   set_fact:
-    kdevops_archive_prefix: "{{ kdevops_archive_base }}/{{ next_number }}/{{ target_linux_ref }}/"
+    kdevops_archive_test_subject: "{{ ci_subject_content.content | b64decode | trim }}"
+  when: ci_subject_file.stat.exists
 
-- name: Set complete archive prefix
+- name: Set best-effort heuristic subject in case ci.subject is not set
   set_fact:
-    kdevops_archive_prefix: "{{ kdevops_archive_base }}/{{ kdevops_archive_test_number }}/{{ target_linux_ref }}/"
+    kdevops_archive_test_subject: "{{ target_linux_tree }} {{ target_linux_ref }} result #{{ kdevops_archive_test_number }}"
+  when: not ci_subject_file.stat.exists
+
+- name: Generate git-format-patch style filename from subject
+  set_fact:
+    kdevops_archive_ci_subject_patchform_name: >-
+      {{
+        (kdevops_archive_test_subject | lower
+        | regex_replace('[^a-z0-9]+', '-')
+        | regex_replace('^-+|-+$', '')
+        | regex_replace('-+', '-')
+        )[:52] ~ (
+          (kdevops_archive_test_subject | length > 52) | ternary('...', '')
+        )
+      }}
+
+- name: Set complete archive prefix with subject-based name
+  set_fact:
+    kdevops_archive_prefix: "{{ kdevops_archive_base }}/{{ kdevops_archive_test_number }}/{{ kdevops_archive_ci_subject_patchform_name }}/"
 
 - name: Create target directory if it doesn't exist
   file:
@@ -312,16 +347,63 @@
   environment:
     GIT_LFS_SKIP_SMUDGE: "0"
 
+- name: Check if ci.commit_extra file exists
+  stat:
+    path: "{{ topdir_path }}/ci.commit_extra"
+  register: ci_commit_file
+
+- name: Read ci.commit_extra file if it exists
+  slurp:
+    path: "{{ topdir_path }}/ci.commit_extra"
+  register: ci_commit_content
+  when: ci_commit_file.stat.exists
+
+- name: Set kdevops_archive_test_subject from ci.commit_extra
+  set_fact:
+    kdevops_archive_test_commit: "{{ ci_commit_content.content | b64decode | trim }}"
+  when: ci_commit_file.stat.exists
+
+- name: Set kdevops_archive_test_subject in case ci.commit_extra is not set
+  set_fact:
+    kdevops_archive_test_commit: "No extra test report details available."
+  when: not ci_commit_file.stat.exists
+
+- name: Check if ci.result file exists
+  stat:
+    path: "{{ topdir_path }}/ci.result"
+  register: ci_result_file
+
+- name: Read ci.result file if it exists
+  slurp:
+    path: "{{ topdir_path }}/ci.result"
+  register: ci_result_content
+  when: ci_result_file.stat.exists
+
+- name: Set kdevops_archive_ci_test_result from ci.result
+  set_fact:
+    kdevops_archive_ci_test_result: "{{ ci_result_content.content | b64decode | trim }}"
+  when: ci_result_file.stat.exists
+
+- name: Set kdevops_archive_ci_test_result in case ci.result is not set
+  set_fact:
+    kdevops_archive_ci_test_result: "unknown"
+  when: not ci_result_file.stat.exists
+
 - name: Set commit message
   set_fact:
     commit_message: |
-      {{ kdevops_workflow_name }}: {{ target_linux_tree }} {{ target_linux_ref }} result #{{ kdevops_archive_test_number }}
+      {{ kdevops_archive_test_trigger }}: {{ kdevops_archive_test_subject }}
 
       This adds test results for:
         workflow: {{ kdevops_workflow_name }}
         tree: {{ target_linux_tree }}
         ref: {{ target_linux_ref }}
         test number: {{ kdevops_archive_test_number }}
+        test result: {{ kdevops_archive_ci_test_result }}
+
+      Detailed test report:
+
+      {{ kdevops_archive_test_commit }}
 
 - name: Commit the archive
   shell: |