feat(ui): Add package configuration provider form data

Add package configuration provider fields to the create-run form schema,
default values, rerun restoration, validation, and payload conversion.

Selected providers are submitted via
`jobConfigs.evaluator.packageConfigurationProviders`, or via
`jobConfigs.reporter.packageConfigurationProviders` when the evaluator job
is disabled.

Signed-off-by: Jyrki Keisala <jyrki.keisala@doubleopen.io>

Author: Etsija

ui/src/routes/organizations/$orgId/products/$productId/repositories/$repoId/_repo-layout/create-run/-components/default-values.ts

@@ -37,7 +37,8 @@ export function defaultValues(
   advisorPlugins: PreconfiguredPluginDescriptor[],
   scannerPlugins: PreconfiguredPluginDescriptor[],
   isSuperuser: boolean,
-  packageCurationProviderPlugins: PreconfiguredPluginDescriptor[]
+  packageCurationProviderPlugins: PreconfiguredPluginDescriptor[],
+  packageConfigurationProviderPlugins: PreconfiguredPluginDescriptor[] = []
 ): CreateRunFormValues {
   /**
    * Constructs the default options for a package manager, either as a blank set of options
@@ -93,6 +94,16 @@ export function defaultValues(
   const packageCurationProviderFormValues = providerPluginConfigsToFormValues(
     ortRun?.jobConfigs.analyzer?.packageCurationProviders
   );
+  const packageConfigurationProviderPluginDefaultValues =
+    getPluginDefaultValues(packageConfigurationProviderPlugins);
+  const evaluatorPackageConfigurationProviderFormValues =
+    providerPluginConfigsToFormValues(
+      ortRun?.jobConfigs.evaluator?.packageConfigurationProviders
+    );
+  const reporterPackageConfigurationProviderFormValues =
+    providerPluginConfigsToFormValues(
+      ortRun?.jobConfigs.reporter?.packageConfigurationProviders
+    );
   const scannerDefaults = {
     scanners: ['ScanCode'],
     scannerScopes: {
@@ -170,12 +181,18 @@ export function defaultValues(
         copyrightGarbageFile: '',
         resolutionsFile: '',
         keepAliveWorker: false,
+        packageConfigurationProviders: [],
+        packageConfigurationProviderConfig:
+          packageConfigurationProviderPluginDefaultValues,
       },
       reporter: {
         enabled: true,
         formats: ['CycloneDX', 'SpdxDocument', 'WebApp'],
         deduplicateDependencyTree: false,
         keepAliveWorker: false,
+        packageConfigurationProviders: [],
+        packageConfigurationProviderConfig:
+          packageConfigurationProviderPluginDefaultValues,
       },
       notifier: {
         enabled: false,
@@ -289,6 +306,12 @@ export function defaultValues(
             enabled:
               ortRun.jobConfigs.evaluator !== undefined &&
               ortRun.jobConfigs.evaluator !== null,
+            packageConfigurationProviders:
+              evaluatorPackageConfigurationProviderFormValues.selectedPluginIds,
+            packageConfigurationProviderConfig: mergePluginConfigs(
+              evaluatorPackageConfigurationProviderFormValues.config,
+              packageConfigurationProviderPluginDefaultValues
+            ),
             keepAliveWorker:
               (ortRun.jobConfigs.evaluator?.keepAliveWorker && isSuperuser) ||
               baseDefaults.jobConfigs.evaluator.keepAliveWorker,
@@ -303,6 +326,12 @@ export function defaultValues(
               ) || baseDefaults.jobConfigs.reporter.formats,
             deduplicateDependencyTree:
               deduplicateDependencyTreeEnabled || undefined,
+            packageConfigurationProviders:
+              reporterPackageConfigurationProviderFormValues.selectedPluginIds,
+            packageConfigurationProviderConfig: mergePluginConfigs(
+              reporterPackageConfigurationProviderFormValues.config,
+              packageConfigurationProviderPluginDefaultValues
+            ),
             keepAliveWorker:
               (ortRun.jobConfigs.reporter?.keepAliveWorker && isSuperuser) ||
               baseDefaults.jobConfigs.reporter.keepAliveWorker,
@@ -443,6 +472,136 @@ if (import.meta.vitest) {
     });
   });
 
+  it('uses package configuration provider plugin default values for fresh runs', () => {
+    const defaults = defaultValues(
+      null,
+      [],
+      [],
+      false,
+      [],
+      [
+        {
+          id: 'OrtConfig',
+          type: 'PACKAGE_CONFIGURATION_PROVIDER',
+          displayName: 'ORT Config',
+          summary: 'A package configuration provider plugin',
+          description: 'A package configuration provider plugin.',
+          options: [
+            {
+              name: 'path',
+              description: 'Provider path.',
+              type: 'STRING',
+              defaultValue: 'package-configurations.yml',
+              isFixed: true,
+              isNullable: false,
+              isRequired: true,
+            },
+          ],
+        },
+      ]
+    );
+
+    expect(defaults.jobConfigs.evaluator.packageConfigurationProviders).toEqual(
+      []
+    );
+    expect(
+      defaults.jobConfigs.evaluator.packageConfigurationProviderConfig
+    ).toEqual({
+      OrtConfig: {
+        options: {
+          path: 'package-configurations.yml',
+        },
+        secrets: {},
+      },
+    });
+    expect(defaults.jobConfigs.reporter.packageConfigurationProviders).toEqual(
+      []
+    );
+    expect(
+      defaults.jobConfigs.reporter.packageConfigurationProviderConfig
+    ).toEqual({
+      OrtConfig: {
+        options: {
+          path: 'package-configurations.yml',
+        },
+        secrets: {},
+      },
+    });
+  });
+
+  it('preserves package configuration provider config from reruns', () => {
+    const ortRun = {
+      revision: 'main',
+      path: '',
+      jobConfigs: {
+        evaluator: {
+          packageConfigurationProviders: [
+            {
+              type: 'OrtConfig',
+              id: 'OrtConfig',
+              enabled: true,
+              options: {
+                path: 'evaluator-package-configurations.yml',
+              },
+              secrets: {
+                token: 'evaluator-token',
+              },
+            },
+          ],
+        },
+        reporter: {
+          packageConfigurationProviders: [
+            {
+              type: 'OrtConfig',
+              id: 'OrtConfig',
+              enabled: true,
+              options: {
+                path: 'reporter-package-configurations.yml',
+              },
+              secrets: {
+                token: 'reporter-token',
+              },
+            },
+          ],
+        },
+      },
+      labels: {},
+    } as unknown as OrtRun;
+
+    const defaults = defaultValues(ortRun, [], [], false, []);
+
+    expect(defaults.jobConfigs.evaluator.packageConfigurationProviders).toEqual(
+      ['OrtConfig']
+    );
+    expect(
+      defaults.jobConfigs.evaluator.packageConfigurationProviderConfig
+    ).toEqual({
+      OrtConfig: {
+        options: {
+          path: 'evaluator-package-configurations.yml',
+        },
+        secrets: {
+          token: 'evaluator-token',
+        },
+      },
+    });
+    expect(defaults.jobConfigs.reporter.packageConfigurationProviders).toEqual([
+      'OrtConfig',
+    ]);
+    expect(
+      defaults.jobConfigs.reporter.packageConfigurationProviderConfig
+    ).toEqual({
+      OrtConfig: {
+        options: {
+          path: 'reporter-package-configurations.yml',
+        },
+        secrets: {
+          token: 'reporter-token',
+        },
+      },
+    });
+  });
+
   it('uses scanner plugin default values for fresh runs', () => {
     const defaults = defaultValues(
       null,

ui/src/routes/organizations/$orgId/products/$productId/repositories/$repoId/_repo-layout/create-run/-components/payload.ts

@@ -19,6 +19,7 @@
 
 import {
   AnalyzerJobConfiguration,
+  EvaluatorJobConfiguration,
   PostRepositoryRun,
   ReporterJobConfiguration,
 } from '@/api';
@@ -228,8 +229,13 @@ export function formValuesToPayload(
   // Evaluator configuration
   //
 
-  const evaluatorConfig = values.jobConfigs.evaluator.enabled
+  const evaluatorConfig: EvaluatorJobConfiguration | undefined = values
+    .jobConfigs.evaluator.enabled
     ? {
+        packageConfigurationProviders: createProviderPluginPayload(
+          values.jobConfigs.evaluator.packageConfigurationProviderConfig,
+          values.jobConfigs.evaluator.packageConfigurationProviders
+        ),
         keepAliveWorker:
           values.jobConfigs.evaluator.keepAliveWorker || undefined,
       }
@@ -290,6 +296,12 @@ export function formValuesToPayload(
     ? {
         formats: values.jobConfigs.reporter.formats,
         config: Object.keys(config).length > 0 ? config : undefined,
+        packageConfigurationProviders: evaluatorConfig
+          ? undefined
+          : createProviderPluginPayload(
+              values.jobConfigs.reporter.packageConfigurationProviderConfig,
+              values.jobConfigs.reporter.packageConfigurationProviders
+            ),
         keepAliveWorker:
           values.jobConfigs.reporter.keepAliveWorker || undefined,
       }
@@ -449,6 +461,151 @@ if (import.meta.vitest) {
       ).toBeUndefined();
     });
 
+    it('adds selected evaluator package configuration providers', () => {
+      const values = createFormValues();
+      values.jobConfigs.evaluator.packageConfigurationProviders = ['OrtConfig'];
+      values.jobConfigs.evaluator.packageConfigurationProviderConfig = {
+        OrtConfig: {
+          options: {
+            path: 'evaluator-package-configurations.yml',
+          },
+          secrets: {
+            token: 'evaluator-token',
+          },
+        },
+        File: {
+          options: {
+            path: 'ignored-package-configurations.yml',
+          },
+          secrets: {},
+        },
+      };
+
+      const payload = formValuesToPayload(values);
+
+      expect(
+        payload.jobConfigs.evaluator?.packageConfigurationProviders
+      ).toEqual([
+        {
+          type: 'OrtConfig',
+          id: 'OrtConfig',
+          enabled: true,
+          options: {
+            path: 'evaluator-package-configurations.yml',
+          },
+          secrets: {
+            token: 'evaluator-token',
+          },
+        },
+      ]);
+    });
+
+    it('adds selected reporter package configuration providers when evaluator is disabled', () => {
+      const values = createFormValues();
+      values.jobConfigs.evaluator.enabled = false;
+      values.jobConfigs.reporter.packageConfigurationProviders = ['OrtConfig'];
+      values.jobConfigs.reporter.packageConfigurationProviderConfig = {
+        OrtConfig: {
+          options: {
+            path: 'reporter-package-configurations.yml',
+          },
+          secrets: {
+            token: 'reporter-token',
+          },
+        },
+      };
+
+      const payload = formValuesToPayload(values);
+
+      expect(payload.jobConfigs.evaluator).toBeUndefined();
+      expect(
+        payload.jobConfigs.reporter?.packageConfigurationProviders
+      ).toEqual([
+        {
+          type: 'OrtConfig',
+          id: 'OrtConfig',
+          enabled: true,
+          options: {
+            path: 'reporter-package-configurations.yml',
+          },
+          secrets: {
+            token: 'reporter-token',
+          },
+        },
+      ]);
+    });
+
+    it('omits package configuration providers if none are selected', () => {
+      const values = createFormValues();
+      values.jobConfigs.evaluator.packageConfigurationProviders = [];
+      values.jobConfigs.evaluator.packageConfigurationProviderConfig = {
+        OrtConfig: {
+          options: {
+            path: 'evaluator-package-configurations.yml',
+          },
+          secrets: {},
+        },
+      };
+      values.jobConfigs.reporter.packageConfigurationProviders = [];
+      values.jobConfigs.reporter.packageConfigurationProviderConfig = {
+        OrtConfig: {
+          options: {
+            path: 'reporter-package-configurations.yml',
+          },
+          secrets: {},
+        },
+      };
+
+      const payload = formValuesToPayload(values);
+
+      expect(
+        payload.jobConfigs.evaluator?.packageConfigurationProviders
+      ).toBeUndefined();
+      expect(
+        payload.jobConfigs.reporter?.packageConfigurationProviders
+      ).toBeUndefined();
+    });
+
+    it('omits reporter package configuration providers when evaluator is enabled', () => {
+      const values = createFormValues();
+      values.jobConfigs.evaluator.packageConfigurationProviders = ['OrtConfig'];
+      values.jobConfigs.evaluator.packageConfigurationProviderConfig = {
+        OrtConfig: {
+          options: {
+            path: 'evaluator-package-configurations.yml',
+          },
+          secrets: {},
+        },
+      };
+      values.jobConfigs.reporter.packageConfigurationProviders = ['File'];
+      values.jobConfigs.reporter.packageConfigurationProviderConfig = {
+        File: {
+          options: {
+            path: 'reporter-package-configurations.yml',
+          },
+          secrets: {},
+        },
+      };
+
+      const payload = formValuesToPayload(values);
+
+      expect(
+        payload.jobConfigs.evaluator?.packageConfigurationProviders
+      ).toEqual([
+        {
+          type: 'OrtConfig',
+          id: 'OrtConfig',
+          enabled: true,
+          options: {
+            path: 'evaluator-package-configurations.yml',
+          },
+        },
+      ]);
+      expect(
+        payload.jobConfigs.reporter?.packageConfigurationProviders
+      ).toBeUndefined();
+    });
+
     it('omits infrastructure services from environment configs', () => {
       const values = createFormValues();
       values.jobConfigs.analyzer.environmentDefinitions = {