fix: update result log with messages

- Add message for tests with status:
  failed, skipped, n/a, or error
- Skip adding messages for passed tests, as
  the status is self-explanatory

Signed-off-by: barmull <barbora.muller@tietoevry.com>

Author: barmull

src/tasks/utils/cnf_manager/points.cr

@@ -275,7 +275,7 @@ module CNFManager
       {max_points, max_passed}
     end
 
-    def self.upsert_task(task, status, points, start_time)
+    def self.upsert_task(task, status, points, start_time, message)
       logger = @@logger.for("upsert_task-#{task}")
 
       # Raise exception when results file does not exists.
@@ -293,7 +293,7 @@ module CNFManager
       # So encode it into YAML and parse it back again to assign it.
       #
       # Only add task timestamps if the env var is set.
-      if ENV.has_key?("TASK_TIMESTAMPS")
+      if status == "passed"
         task_result_info = {
           name:         task,
           status:       status,
@@ -304,12 +304,16 @@ module CNFManager
           task_runtime: "#{task_runtime}",
         }
         result_items << YAML.parse(task_result_info.to_yaml)
-      else
+      else 
         task_result_info = {
-          name:   task,
-          status: status,
-          type:   task_type_by_task(task),
-          points: points,
+          name:                 task,
+          status:               status,
+          status_description:   message,
+          type:                 task_type_by_task(task),
+          points:               points,
+          start_time:           start_time,
+          end_time:             end_time,
+          task_runtime:         "#{task_runtime}",
         }
         result_items << YAML.parse(task_result_info.to_yaml)
       end
@@ -329,17 +333,17 @@ module CNFManager
     end
 
     def self.failed_task(task, msg)
-      upsert_task(task, FAILED, task_points(task, false), start_time)
+      upsert_task(task, FAILED, task_points(task, false), start_time, msg)
       stdout_failure "#{msg}"
     end
 
     def self.passed_task(task, msg)
-      upsert_task(task, PASSED, task_points(task), start_time)
+      upsert_task(task, PASSED, task_points(task), start_time, msg)
       stdout_success "#{msg}"
     end
 
     def self.skipped_task(task, msg)
-      upsert_task(task, SKIPPED, task_points(task), start_time)
+      upsert_task(task, SKIPPED, task_points(task), start_time, msg)
       stdout_success "#{msg}"
     end
 

src/tasks/utils/utils.cr

@@ -195,50 +195,50 @@ def upsert_decorated_task(task, status : CNFManager::ResultStatus, message, star
   cat_emoji = CNFManager::Points.task_emoji_by_task(task)
   case status.to_basic
   when CNFManager::ResultStatus::Passed
-    upsert_passed_task(task, "✔️  #{cat_emoji}PASSED: [#{task}] #{message} #{tc_emoji}", start_time)
+    upsert_passed_task(task, "✔️  #{cat_emoji}PASSED: [#{task}] #{message} #{tc_emoji}", message, start_time)
   when CNFManager::ResultStatus::Failed
-    upsert_failed_task(task, "✖️  #{cat_emoji}FAILED: [#{task}] #{message} #{tc_emoji}", start_time)
+    upsert_failed_task(task, "✖️  #{cat_emoji}FAILED: [#{task}] #{message} #{tc_emoji}", message, start_time)
   when CNFManager::ResultStatus::Skipped
-    upsert_skipped_task(task, "⏭️  #{cat_emoji}SKIPPED: [#{task}] #{message} #{tc_emoji}", start_time)
+    upsert_skipped_task(task, "⏭️  #{cat_emoji}SKIPPED: [#{task}] #{message} #{tc_emoji}", message, start_time)
   when CNFManager::ResultStatus::NA
-    upsert_na_task(task, "⏭️  #{cat_emoji}N/A: [#{task}] #{message} #{tc_emoji}", start_time)
+    upsert_na_task(task, "⏭️  #{cat_emoji}N/A: [#{task}] #{message} #{tc_emoji}", message, start_time)
   when CNFManager::ResultStatus::Error
-    upsert_error_task(task, "💥  #{cat_emoji}ERROR: [#{task}] #{message}", start_time)
+    upsert_error_task(task, "💥  #{cat_emoji}ERROR: [#{task}] #{message}", message, start_time)
   end
 end
 
-def upsert_failed_task(task, message, start_time)
-  CNFManager::Points.upsert_task(task, FAILED, CNFManager::Points.task_points(task, CNFManager::ResultStatus::Failed), start_time)
-  stdout_failure message
-  message
+def upsert_failed_task(task, decorated_message, message, start_time)
+  CNFManager::Points.upsert_task(task, FAILED, CNFManager::Points.task_points(task, CNFManager::ResultStatus::Failed), start_time, message)
+  stdout_failure decorated_message
+  decorated_message
 end
 
-def upsert_passed_task(task, message, start_time)
-  CNFManager::Points.upsert_task(task, PASSED, CNFManager::Points.task_points(task, CNFManager::ResultStatus::Passed), start_time)
-  stdout_success message
-  message
+def upsert_passed_task(task, decorated_message, message, start_time)
+  CNFManager::Points.upsert_task(task, PASSED, CNFManager::Points.task_points(task, CNFManager::ResultStatus::Passed), start_time, message)
+  stdout_success decorated_message
+  decorated_message
 end
 
-def upsert_skipped_task(task, message, start_time)
-  CNFManager::Points.upsert_task(task, SKIPPED, CNFManager::Points.task_points(task, CNFManager::ResultStatus::Skipped), start_time)
-  stdout_warning message
-  message
+def upsert_skipped_task(task, decorated_message, message, start_time)
+  CNFManager::Points.upsert_task(task, SKIPPED, CNFManager::Points.task_points(task, CNFManager::ResultStatus::Skipped), start_time, message)
+  stdout_warning decorated_message
+  decorated_message
 end
 
-def upsert_na_task(task, message, start_time)
-  CNFManager::Points.upsert_task(task, NA, CNFManager::Points.task_points(task, CNFManager::ResultStatus::NA), start_time)
-  stdout_warning message
-  message
+def upsert_na_task(task, decorated_message, message, start_time)
+  CNFManager::Points.upsert_task(task, NA, CNFManager::Points.task_points(task, CNFManager::ResultStatus::NA), start_time, message)
+  stdout_warning decorated_message
+  decorated_message
 end
 
-def upsert_error_task(task, message, start_time)
-  CNFManager::Points.upsert_task(task, ERROR, CNFManager::Points.task_points(task, CNFManager::ResultStatus::Error), start_time)
-  stdout_error message
-  message
-end
+def upsert_error_task(task, decorated_message, message, start_time)
+  CNFManager::Points.upsert_task(task, ERROR, CNFManager::Points.task_points(task, CNFManager::ResultStatus::Error), start_time, message)
+   stdout_error decorated_message
+   decorated_message
+ end
 
 def upsert_dynamic_task(task, status : CNFManager::ResultStatus, message, start_time)
-  CNFManager::Points.upsert_task(task, status.to_s.downcase, CNFManager::Points.task_points(task, status), start_time)
+  CNFManager::Points.upsert_task(task, status.to_s.downcase, CNFManager::Points.task_points(task, status), start_time, message)
   case status.to_s.downcase
   when /pass/
     stdout_success message