feat: use logExcerpt from output_files (#1829)

* fix: use logExcerpt from output_files

Fixes a step on logsheet where the log_excerpt should be retrieved from the output_files field of a build/test

Closes #1828

* tests: add unit tests for processLogData

Author: MarceloRobert

backend/kernelCI_app/models.py

@@ -109,6 +109,7 @@ class Builds(models.Model):
     architecture = models.TextField(blank=True, null=True)
     command = models.TextField(blank=True, null=True)
     compiler = models.TextField(blank=True, null=True)
+    # input/output files are an array of objects containing file fields such as name and url
     input_files = models.JSONField(blank=True, null=True)
     output_files = models.JSONField(blank=True, null=True)
     config_name = models.TextField(blank=True, null=True)
@@ -170,6 +171,8 @@ class UnitPrefix(models.TextChoices):
     )
     start_time = models.DateTimeField(blank=True, null=True)
     duration = models.FloatField(blank=True, null=True)
+    # input/output files are an array of objects containing file fields such as name and url
+    input_files = models.JSONField(blank=True, null=True)
     output_files = models.JSONField(blank=True, null=True)
     misc = models.JSONField(blank=True, null=True)
     number_value = models.FloatField(blank=True, null=True)
@@ -178,7 +181,6 @@ class UnitPrefix(models.TextChoices):
         max_length=10, choices=UnitPrefix.choices, blank=True, null=True
     )
     number_unit = models.TextField(blank=True, null=True)
-    input_files = models.JSONField(blank=True, null=True)
 
     class Meta:
         db_table = "tests"

dashboard/src/hooks/useLogData.test.ts

@@ -0,0 +1,54 @@
+import { describe, expect, it } from 'vitest';
+
+import { processLogData } from './useLogData';
+
+describe('processLogData', () => {
+  it('maps build fields and defaults status to NULL when missing', () => {
+    const result = processLogData('build-1', {
+      type: 'build',
+      git_commit_name: 'Fix scheduler race',
+      misc: { platform: 'qemu-x86' },
+      output_files: [{ name: 'other_file', url: 'https://example.com/other' }],
+    });
+
+    expect(result).toMatchObject({
+      id: 'build-1',
+      type: 'build',
+      title: 'Fix scheduler race',
+      status: 'NULL',
+      hardware: 'qemu-x86',
+      log_excerpt: undefined,
+    });
+  });
+
+  it('maps test fields and picks first hardware candidate from buildHardwareArray', () => {
+    const result = processLogData('test-1', {
+      type: 'test',
+      path: 'boot/smoke',
+      status: 'PASS',
+      environment_misc: { platform: 'rk3399' },
+      environment_compatible: ['arm64', 'lab-board'],
+    });
+
+    expect(result).toMatchObject({
+      id: 'test-1',
+      type: 'test',
+      title: 'boot/smoke',
+      status: 'PASS',
+      hardware: 'rk3399',
+    });
+  });
+
+  it('extracts log excerpt URL from output_files when present', () => {
+    const result = processLogData('build-2', {
+      type: 'build',
+      status: 'FAIL',
+      output_files: [
+        { name: 'artifact', url: 'https://example.com/artifact' },
+        { name: 'log_excerpt', url: 'https://example.com/log-excerpt' },
+      ],
+    });
+
+    expect(result.log_excerpt).toBe('https://example.com/log-excerpt');
+  });
+});

dashboard/src/hooks/useLogData.ts

@@ -55,6 +55,10 @@ export const processLogData = (
         ? data.misc.platform
         : undefined;
 
+  const logExcerptFileLink = data?.output_files?.find(
+    file => file && file['name'] === 'log_excerpt',
+  )?.['url'];
+
   return {
     id,
     type: data.type,
@@ -65,7 +69,7 @@ export const processLogData = (
     git_repository_url: data?.git_repository_url,
     architecture: data?.architecture,
     log_url: data?.log_url,
-    log_excerpt: data?.log_excerpt,
+    log_excerpt: data?.log_excerpt || logExcerptFileLink,
     status: handledStatus,
     hardware: handledHardware,
   };

dashboard/src/types/database.ts

@@ -3,3 +3,9 @@ import type { status } from '@/utils/constants/database';
 export type Status = (typeof status)[number];
 
 export type InconclusiveStatus = Exclude<Status, 'PASS' | 'FAIL'>;
+
+// Follows kcidb schema: https://github.com/kernelci/kcidb-io/blob/8971c0269a80307ec6270ff8c78ff3816fc639f6/kcidb_io/schema/v05_03.py#L62
+export type Resource = {
+  name: string;
+  url: string;
+};

dashboard/src/types/tree/BuildDetails.tsx

@@ -1,4 +1,4 @@
-import type { Status } from '@/types/database';
+import type { Resource, Status } from '@/types/database';
 
 export type TBuildDetails = {
   timestamp: string;
@@ -24,6 +24,6 @@ export type TBuildDetails = {
   build_origin: string;
   log_excerpt?: string;
   misc?: Record<string, unknown>;
-  input_files?: Record<string, unknown>;
-  output_files?: Record<string, unknown>;
+  input_files?: Resource[];
+  output_files?: Resource[];
 };

dashboard/src/types/tree/TestDetails.tsx

@@ -1,4 +1,4 @@
-import type { Status } from '@/types/database';
+import type { Resource, Status } from '@/types/database';
 
 export type TTestDetails = {
   architecture?: string;
@@ -18,8 +18,8 @@ export type TTestDetails = {
   environment_compatible?: string[];
   environment_misc?: Record<string, unknown>;
   misc?: Record<string, unknown>;
-  input_files?: Record<string, unknown>;
-  output_files?: Record<string, unknown>;
+  input_files?: Resource[];
+  output_files?: Resource[];
   tree_name?: string;
   origin?: string;
   field_timestamp: string;