feat(scorecard): File level checks - all providers (#2913)

Author: djanickova

workspaces/scorecard/.changeset/bright-candies-roll.md

@@ -0,0 +1,8 @@
+---
+'@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-filecheck': minor
+'@red-hat-developer-hub/backstage-plugin-scorecard-backend': minor
+'@red-hat-developer-hub/backstage-plugin-scorecard-node': minor
+'@red-hat-developer-hub/backstage-plugin-scorecard': minor
+---
+
+Add support for batch metric providers, allowing a single provider to handle multiple metrics efficiently. Introduce a new backend module for configurable file existence checks (filecheck.\*) that verify whether required files (like README, LICENSE, or CODEOWNERS) are present in a repository.

workspaces/scorecard/app-config.yaml

@@ -64,6 +64,24 @@ app:
                 sm: { w: 4, h: 6, x: 4 }
                 xs: { w: 4, h: 6, x: 4 }
                 xxs: { w: 4, h: 6, x: 4 }
+            AggregatedCardWithGithubFilecheckLicense:
+              priority: 450
+              breakpoints:
+                xl: { w: 4, h: 6 }
+                lg: { w: 4, h: 6 }
+                md: { w: 4, h: 6 }
+                sm: { w: 4, h: 6 }
+                xs: { w: 4, h: 6 }
+                xxs: { w: 4, h: 6 }
+            AggregatedCardWithGithubFilecheckCodeowners:
+              priority: 460
+              breakpoints:
+                xl: { w: 4, h: 6 }
+                lg: { w: 4, h: 6 }
+                md: { w: 4, h: 6 }
+                sm: { w: 4, h: 6 }
+                xs: { w: 4, h: 6 }
+                xxs: { w: 4, h: 6 }
 
 organization:
   name: My Company
@@ -198,6 +216,11 @@ scorecard:
       type: statusGrouped
       description: This KPI is provide information about Jira open issues grouped by status.
       metricId: jira.open_issues
+    licenseFileExistsKpi:
+      title: License File Exists KPI
+      type: statusGrouped
+      description: This KPI is provide information about whether the license file exists in the repository.
+      metricId: filecheck.license
   plugins:
     jira:
       open_issues:
@@ -211,3 +234,11 @@ scorecard:
           frequency: { minutes: 5 }
           timeout: { minutes: 10 }
           initialDelay: { seconds: 5 }
+    filecheck:
+      files:
+        license: 'LICENSE'
+        codeowners: 'CODEOWNERS'
+      schedule:
+        frequency: { minutes: 5 }
+        timeout: { minutes: 10 }
+        initialDelay: { seconds: 5 }

workspaces/scorecard/packages/app-legacy/e2e-tests/scorecard.test.ts

@@ -42,6 +42,7 @@ import {
   jiraEntitiesDrillDownResponse,
   jiraEntitiesDrillDownNoDataResponse,
   jiraMetricMetadataResponse,
+  fileCheckScorecardResponse,
 } from './utils/scorecardResponseUtils';
 import {
   ScorecardMessages,
@@ -254,6 +255,71 @@ test.describe('Scorecard Plugin Tests', () => {
 
       await runAccessibilityTests(page, testInfo);
     });
+
+    test('Verify file check metrics display correctly', async ({
+      browser,
+    }, testInfo) => {
+      await mockApiResponse(
+        page,
+        ScorecardRoutes.SCORECARD_API_ROUTE,
+        fileCheckScorecardResponse,
+      );
+
+      await catalogPage.openCatalog();
+      await catalogPage.openComponent('Red Hat Developer Hub');
+      await scorecardPage.openTab();
+
+      const existLabel = translations.thresholds.exist ?? 'Exist';
+      const missingLabel = translations.thresholds.missing ?? 'Missing';
+
+      const readmeTitle = evaluateMessage(
+        translations.metric.filecheck.title,
+        'readme',
+      );
+      const readmeDescription = evaluateMessage(
+        translations.metric.filecheck.description,
+        'readme',
+      );
+
+      const readmeCard = page
+        .locator('[role="article"]')
+        .filter({ hasText: readmeTitle })
+        .first();
+      await expect(readmeCard).toBeVisible();
+      await expect(readmeCard.getByText(readmeDescription)).toBeVisible();
+      await expect(
+        readmeCard.getByText(existLabel, { exact: true }),
+      ).toBeVisible();
+      await expect(
+        readmeCard.getByText(missingLabel, { exact: true }),
+      ).toBeVisible();
+
+      const codeownersTitle = evaluateMessage(
+        translations.metric.filecheck.title,
+        'codeowners',
+      );
+      const codeownersDescription = evaluateMessage(
+        translations.metric.filecheck.description,
+        'codeowners',
+      );
+
+      const codeownersCard = page
+        .locator('[role="article"]')
+        .filter({ hasText: codeownersTitle })
+        .first();
+      await expect(codeownersCard).toBeVisible();
+      await expect(
+        codeownersCard.getByText(codeownersDescription),
+      ).toBeVisible();
+      await expect(
+        codeownersCard.getByText(existLabel, { exact: true }),
+      ).toBeVisible();
+      await expect(
+        codeownersCard.getByText(missingLabel, { exact: true }),
+      ).toBeVisible();
+
+      await runAccessibilityTests(page, testInfo);
+    });
   });
 
   test.describe('Homepage aggregated scorecards', () => {

workspaces/scorecard/packages/app-legacy/e2e-tests/utils/scorecardResponseUtils.ts

@@ -506,3 +506,74 @@ export const jiraEntitiesDrillDownNoDataResponse = {
     isCapped: false,
   },
 };
+
+export const fileCheckScorecardResponse = [
+  {
+    id: 'filecheck.readme',
+    status: 'success',
+    metadata: {
+      title: 'GitHub File: README.md',
+      description: 'Checks if README.md exists in the repository.',
+      type: 'boolean',
+      history: true,
+    },
+    result: {
+      value: true,
+      timestamp: '2025-09-08T09:08:55.629Z',
+      thresholdResult: {
+        definition: {
+          rules: [
+            {
+              key: 'exist',
+              expression: '==true',
+              color: 'success.main',
+              icon: 'scorecardSuccessStatusIcon',
+            },
+            {
+              key: 'missing',
+              expression: '==false',
+              color: 'error.main',
+              icon: 'scorecardErrorStatusIcon',
+            },
+          ],
+        },
+        status: 'success',
+        evaluation: 'exist',
+      },
+    },
+  },
+  {
+    id: 'filecheck.codeowners',
+    status: 'success',
+    metadata: {
+      title: 'GitHub File: CODEOWNERS',
+      description: 'Checks if CODEOWNERS exists in the repository.',
+      type: 'boolean',
+      history: true,
+    },
+    result: {
+      value: false,
+      timestamp: '2025-09-08T09:08:55.629Z',
+      thresholdResult: {
+        definition: {
+          rules: [
+            {
+              key: 'exist',
+              expression: '==true',
+              color: 'success.main',
+              icon: 'scorecardSuccessStatusIcon',
+            },
+            {
+              key: 'missing',
+              expression: '==false',
+              color: 'error.main',
+              icon: 'scorecardErrorStatusIcon',
+            },
+          ],
+        },
+        status: 'success',
+        evaluation: 'missing',
+      },
+    },
+  },
+];

workspaces/scorecard/packages/app-legacy/src/App.tsx

@@ -217,6 +217,66 @@ const mountPoints: HomePageCardMountPoint[] = [
       },
     },
   },
+  {
+    Component: ScorecardHomepageCard as ComponentType,
+    config: {
+      id: 'scorecard-filecheck.license',
+      title: 'Scorecard: LICENSE file exists',
+      cardLayout: {
+        width: {
+          minColumns: 3,
+          maxColumns: 12,
+          defaultColumns: 4,
+        },
+        height: {
+          minRows: 5,
+          maxRows: 12,
+          defaultRows: 6,
+        },
+      },
+      layouts: {
+        xl: { w: 4, h: 6 },
+        lg: { w: 4, h: 6 },
+        md: { w: 4, h: 6 },
+        sm: { w: 4, h: 6 },
+        xs: { w: 4, h: 6 },
+        xxs: { w: 4, h: 6 },
+      },
+      props: {
+        aggregationId: 'licenseFileExistsKpi',
+      },
+    },
+  },
+  {
+    Component: ScorecardHomepageCard as ComponentType,
+    config: {
+      id: 'scorecard-filecheck.codeowners',
+      title: 'Scorecard: CODEOWNERS file exists',
+      cardLayout: {
+        width: {
+          minColumns: 3,
+          maxColumns: 12,
+          defaultColumns: 4,
+        },
+        height: {
+          minRows: 5,
+          maxRows: 12,
+          defaultRows: 6,
+        },
+      },
+      layouts: {
+        xl: { w: 4, h: 6, x: 4 },
+        lg: { w: 4, h: 6, x: 4 },
+        md: { w: 4, h: 6, x: 4 },
+        sm: { w: 4, h: 6, x: 4 },
+        xs: { w: 4, h: 6, x: 4 },
+        xxs: { w: 4, h: 6, x: 4 },
+      },
+      props: {
+        aggregationId: 'filecheck.codeowners',
+      },
+    },
+  },
   {
     Component: ScorecardHomepageCard as ComponentType,
     config: {
@@ -251,14 +311,24 @@ const mountPoints: HomePageCardMountPoint[] = [
               title: 'Metric (Needs currently a page reload after change!)',
               type: 'string',
               default: 'jira.open_issues',
-              enum: ['jira.open_issues', 'github.open_prs'],
+              enum: [
+                'jira.open_issues',
+                'github.open_prs',
+                'filecheck.license',
+                'filecheck.codeowners',
+              ],
             },
           },
         },
         uiSchema: {
           metricId: {
             'ui:widget': 'RadioWidget',
-            'ui:enumNames': ['Jira Open Issues', 'GitHub Open PRs'],
+            'ui:enumNames': [
+              'Jira Open Issues',
+              'GitHub Open PRs',
+              'LICENSE file exists',
+              'CODEOWNERS file exists',
+            ],
           },
         },
       },

workspaces/scorecard/packages/backend/package.json

@@ -47,6 +47,7 @@
     "@backstage/plugin-techdocs-backend": "^2.1.6",
     "@red-hat-developer-hub/backstage-plugin-scorecard-backend": "workspace:^",
     "@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-dependabot": "workspace:^",
+    "@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-filecheck": "workspace:^",
     "@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-github": "workspace:^",
     "@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-jira": "workspace:^",
     "@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-openssf": "workspace:^",

workspaces/scorecard/packages/backend/src/index.ts

@@ -72,6 +72,11 @@ backend.add(
     '@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-jira'
   ),
 );
+backend.add(
+  import(
+    '@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-filecheck'
+  ),
+);
 backend.add(
   import(
     '@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-openssf'

workspaces/scorecard/plugins/scorecard-backend-module-filecheck/.eslintrc.js

@@ -0,0 +1 @@
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);