Merge pull request #2 from djanickova/scorecard-file-checks-frontend

Scorecard file checks - frontend, aggregated card

Author: djanickova

workspaces/scorecard/app-config.yaml

@@ -133,3 +133,11 @@ scorecard:
           frequency: { minutes: 5 }
           timeout: { minutes: 10 }
           initialDelay: { seconds: 5 }
+      files_check:
+        files:
+          - readme: 'README.md'
+          - i18guide: 'docs/backstage-i18n-guide.md'
+        schedule:
+          frequency: { minutes: 5 }
+          timeout: { minutes: 10 }
+          initialDelay: { seconds: 5 }

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

@@ -27,6 +27,7 @@ import {
   emptyScorecardResponse,
   unavailableMetricResponse,
   invalidThresholdResponse,
+  fileCheckScorecardResponse,
   githubAggregatedResponse,
   jiraAggregatedResponse,
   emptyGithubAggregatedResponse,
@@ -188,6 +189,67 @@ test.describe('Scorecard Plugin Tests', () => {
 
       await runAccessibilityTests(page, testInfo);
     });
+
+    test('Verify file check metrics display correctly', async ({
+      browser,
+    }, testInfo) => {
+      await mockScorecardResponse(page, 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['github.files_check'].title,
+        'readme',
+      );
+      const readmeDescription = evaluateMessage(
+        translations.metric['github.files_check'].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['github.files_check'].title,
+        'codeowners',
+      );
+      const codeownersDescription = evaluateMessage(
+        translations.metric['github.files_check'].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('Aggregated Scorecards', () => {

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

@@ -13,7 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { DEFAULT_NUMBER_THRESHOLDS } from '@red-hat-developer-hub/backstage-plugin-scorecard-common';
+import {
+  DEFAULT_NUMBER_THRESHOLDS,
+  ScorecardThresholdRuleColors,
+} from '@red-hat-developer-hub/backstage-plugin-scorecard-common';
 
 export const customScorecardResponse = [
   {
@@ -260,3 +263,70 @@ export const emptyGithubAggregatedResponse = {
     thresholds: DEFAULT_NUMBER_THRESHOLDS,
   },
 };
+
+export const fileCheckScorecardResponse = [
+  {
+    id: 'github.files_check.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: ScorecardThresholdRuleColors.SUCCESS,
+            },
+            {
+              key: 'missing',
+              expression: '==false',
+              color: ScorecardThresholdRuleColors.ERROR,
+            },
+          ],
+        },
+        status: 'success',
+        evaluation: 'exist',
+      },
+    },
+  },
+  {
+    id: 'github.files_check.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: ScorecardThresholdRuleColors.SUCCESS,
+            },
+            {
+              key: 'missing',
+              expression: '==false',
+              color: ScorecardThresholdRuleColors.ERROR,
+            },
+          ],
+        },
+        status: 'success',
+        evaluation: 'missing',
+      },
+    },
+  },
+];

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

@@ -146,6 +146,66 @@ const mountPoints: HomePageCardMountPoint[] = [
       },
     },
   },
+  {
+    Component: ScorecardHomepageCard as ComponentType,
+    config: {
+      id: 'scorecard-github.files_check.readme',
+      title: 'Scorecard: README 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: {
+        metricId: 'github.files_check.readme',
+      },
+    },
+  },
+  {
+    Component: ScorecardHomepageCard as ComponentType,
+    config: {
+      id: 'scorecard-github.files_check.i18guide',
+      title: 'Scorecard: i18n guide 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: {
+        metricId: 'github.files_check.i18guide',
+      },
+    },
+  },
   {
     Component: ScorecardHomepageCard as ComponentType,
     config: {
@@ -180,14 +240,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',
+                'github.files_check.readme',
+                'github.files_check.i18guide',
+              ],
             },
           },
         },
         uiSchema: {
           metricId: {
             'ui:widget': 'RadioWidget',
-            'ui:enumNames': ['Jira Open Issues', 'GitHub Open PRs'],
+            'ui:enumNames': [
+              'Jira Open Issues',
+              'GitHub Open PRs',
+              'README file exists',
+              'i18n guide file exists',
+            ],
           },
         },
       },

workspaces/scorecard/plugins/scorecard-backend-module-github/src/metricProviders/GithubConfig.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  type ThresholdConfig,
+  ScorecardThresholdRuleColors,
+} from '@red-hat-developer-hub/backstage-plugin-scorecard-common';
+
+export const DEFAULT_FILE_CHECK_THRESHOLDS: ThresholdConfig = {
+  rules: [
+    {
+      key: 'exist',
+      expression: '==true',
+      color: ScorecardThresholdRuleColors.SUCCESS,
+    },
+    {
+      key: 'missing',
+      expression: '==false',
+      color: ScorecardThresholdRuleColors.ERROR,
+    },
+  ],
+};

workspaces/scorecard/plugins/scorecard-backend-module-github/src/metricProviders/GithubFilesProvider.test.ts

@@ -18,7 +18,7 @@ import { ConfigReader } from '@backstage/config';
 import type { Entity } from '@backstage/catalog-model';
 import { GithubFilesProvider } from './GithubFilesProvider';
 import { GithubClient } from '../github/GithubClient';
-import { DEFAULT_BOOLEAN_THRESHOLDS } from '@red-hat-developer-hub/backstage-plugin-scorecard-common';
+import { DEFAULT_FILE_CHECK_THRESHOLDS } from './GithubConfig';
 
 jest.mock('@backstage/catalog-model', () => ({
   ...jest.requireActual('@backstage/catalog-model'),
@@ -138,9 +138,9 @@ describe('GithubFilesProvider', () => {
       ]);
     });
 
-    it('should return default boolean thresholds', () => {
+    it('should return default file check thresholds', () => {
       expect(provider.getMetricThresholds()).toEqual(
-        DEFAULT_BOOLEAN_THRESHOLDS,
+        DEFAULT_FILE_CHECK_THRESHOLDS,
       );
     });
 

workspaces/scorecard/plugins/scorecard-backend-module-github/src/metricProviders/GithubFilesProvider.ts

@@ -18,10 +18,10 @@ import type { Config } from '@backstage/config';
 import { getEntitySourceLocation, type Entity } from '@backstage/catalog-model';
 import { CATALOG_FILTER_EXISTS } from '@backstage/catalog-client';
 import {
-  DEFAULT_BOOLEAN_THRESHOLDS,
   Metric,
   ThresholdConfig,
 } from '@red-hat-developer-hub/backstage-plugin-scorecard-common';
+import { DEFAULT_FILE_CHECK_THRESHOLDS } from './GithubConfig';
 import { MetricProvider } from '@red-hat-developer-hub/backstage-plugin-scorecard-node';
 import { GithubClient } from '../github/GithubClient';
 import { getRepositoryInformationFromEntity } from '../github/utils';
@@ -35,7 +35,7 @@ export class GithubFilesProvider implements MetricProvider<'boolean'> {
   private constructor(config: Config, filesConfig: GithubFilesConfig) {
     this.githubClient = new GithubClient(config);
     this.filesConfig = filesConfig;
-    this.thresholds = DEFAULT_BOOLEAN_THRESHOLDS;
+    this.thresholds = DEFAULT_FILE_CHECK_THRESHOLDS;
   }
 
   getProviderDatasourceId(): string {

workspaces/scorecard/plugins/scorecard-backend/__fixtures__/mockMetricProvidersRegistry.ts

@@ -41,15 +41,6 @@ export const buildMockMetricProvidersRegistry = ({
   const getProvider = provider
     ? jest.fn().mockReturnValue(provider)
     : jest.fn();
-  const getMetric = provider
-    ? jest.fn().mockImplementation((metricId: string) => {
-        if (provider.getMetrics) {
-          const metric = provider.getMetrics().find(m => m.id === metricId);
-          if (metric) return metric;
-        }
-        return provider.getMetric();
-      })
-    : jest.fn();
   const listMetrics = metricsList
     ? jest.fn().mockImplementation((metricIds?: string[]) => {
         if (metricIds && metricIds.length !== 0) {
@@ -61,6 +52,11 @@ export const buildMockMetricProvidersRegistry = ({
   const getMetric =
     provider || metricsList
       ? jest.fn().mockImplementation((metricId: string) => {
+          if (provider?.getMetrics) {
+            const found = provider.getMetrics().find(m => m.id === metricId);
+            if (found) return found;
+          }
+
           const pMetric = provider?.getMetric();
           if (pMetric && pMetric.id === metricId) return pMetric;
 
@@ -78,6 +74,5 @@ export const buildMockMetricProvidersRegistry = ({
     getProvider,
     getMetric,
     listMetrics,
-    getMetric,
   } as unknown as jest.Mocked<MetricProvidersRegistry>;
 };

workspaces/scorecard/plugins/scorecard-backend/src/service/CatalogMetricService.test.ts

@@ -502,6 +502,7 @@ describe('CatalogMetricService', () => {
         auth: mockedAuth,
         registry: mockedRegistry,
         database: mockedDatabase,
+        logger: mockedLogger,
       });
 
       const results = await service.getLatestEntityMetrics(