Resloving initial feadback comments

Signed-off-by: Vinnie McGuinness <vinnie.mcguinness@intive.com>
2025-05-12 11:18:20 +01:00
parent e4dabc605c
commit 704d94ba03
7 changed files with 67 additions and 77 deletions
@@ -51,7 +51,7 @@ yarn.lock                                         @backstage/maintainers @backst
 /plugins/catalog-backend-module-aws               @backstage/maintainers @backstage/reviewers @backstage/catalog-maintainers @pjungermann
 /plugins/catalog-backend-module-bitbucket-cloud   @backstage/maintainers @backstage/reviewers @backstage/catalog-maintainers @pjungermann
 /plugins/catalog-backend-module-backstage-openapi @backstage/maintainers @backstage/reviewers @backstage/openapi-tooling-maintainers
-/plugins/catalog-backend-module-gitea             @backstage/maintainers @backstage/reviewers @vinnie-jog-on
+/plugins/catalog-backend-module-gitea             @backstage/maintainers @backstage/reviewers @backstage/catalog-maintainers
 /plugins/catalog-backend-module-msgraph           @backstage/maintainers @backstage/reviewers @backstage/catalog-maintainers @pjungermann
 /plugins/catalog-backend-module-puppetdb          @backstage/maintainers @backstage/reviewers @backstage/catalog-maintainers
 /plugins/catalog-graph                            @backstage/maintainers @backstage/reviewers @backstage/catalog-maintainers @backstage/sda-se-reviewers
@@ -2,14 +2,9 @@
 id: discovery
 title: Gitea Discovery
 sidebar_label: Discovery
-# prettier-ignore
 description: Automatically discovering catalog entities from Gitea repositories
 ---

-:::info
-This documentation is written for [the new backend system](../../backend-system/index.md) which is the default since Backstage [version 1.24](../../releases/v1.24.0.md).
-:::
-
 The Gitea integration has a special entity provider for discovering catalog entities
 from Gitea repositories. The provider uses the "List Projects" API in Gitea to get
 a list of repositories and will automatically ingest all `catalog-info.yaml` files
@@ -0,0 +1,58 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * 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 { SchedulerServiceTaskScheduleDefinition } from '@backstage/backend-plugin-api';
+
+export interface Config {
+  catalog?: {
+    /**
+     * List of provider-specific options and attributes
+     */
+    providers?: {
+      /**
+       * GiteaEntityProvider configuration
+       *
+       * Maps provider id with configuration.
+       */
+      gitea?: {
+        [name: string]: {
+          /**
+           * (Required) The host of the Gitea integration to use.
+           */
+          host: string;
+          /**
+           * (Required) Name of your organization account/workspace.
+           */
+          organization: string;
+          /**
+           * (Optional) Branch.
+           * The branch where the provider will try to find entities. Uses the default to "main".
+           */
+          branch?: string;
+          /**
+           * (Optional) Path where the catalog YAML manifest file is expected in the repository.
+           * Defaults to "catalog-info.yaml".
+           */
+          catalogPath?: string;
+          /**
+           * (Optional) TaskScheduleDefinition for the discovery.
+           */
+          schedule?: SchedulerServiceTaskScheduleDefinition;
+        };
+      };
+    };
+  };
+}
@@ -1,8 +1,7 @@
 {
  "name": "@backstage/plugin-catalog-backend-module-gitea",
-  "version": "0.1.0",
+  "version": "0.0.0",
  "license": "Apache-2.0",
-  "private": true,
  "description": "The gitea backend module for the catalog plugin.",
  "main": "src/index.ts",
  "types": "src/index.ts",
@@ -41,7 +40,6 @@
    "uuid": "^11.0.0"
  },
  "devDependencies": {
-    "@backstage/backend-common": "^0.25.0",
    "@backstage/backend-test-utils": "workspace:^",
    "@backstage/cli": "workspace:^"
  },
@@ -13,8 +13,7 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-import { getVoidLogger } from '@backstage/backend-common';
-import { LoggerService } from '@backstage/backend-plugin-api';
+import { mockServices } from '@backstage/backend-test-utils';
 import { ConfigReader } from '@backstage/config';
 import { EntityProviderConnection } from '@backstage/plugin-catalog-node';
 import { GiteaEntityProvider } from './GiteaEntityProvider';
@@ -28,7 +27,8 @@ jest.mock('./core');
 jest.mock('uuid');

 describe('GiteaEntityProvider', () => {
-  const logger = getVoidLogger() as unknown as LoggerService;
+  const logger = mockServices.logger.mock();
+
  const mockScheduler = {
    createScheduledTaskRunner: jest.fn(),
    triggerTask: jest.fn(),
@@ -285,66 +285,6 @@ describe('GiteaEntityProvider', () => {
        fn: expect.any(Function),
      });
    });
-
-    it('should run the scheduled refresh function', async () => {
-      await provider.connect(mockConnection);
-
-      // Extract and call the scheduled function
-      const runArgument = mockTaskRunner.run.mock.calls[0][0];
-      const refreshFn = runArgument.fn;
-
-      // Mock the refresh behavior
-      (global.fetch as jest.Mock).mockImplementation(async (url: string) => {
-        if (url.includes('/orgs/test-org/repos')) {
-          if (url.includes('page=1')) {
-            return {
-              ok: true,
-              json: async () => [
-                {
-                  name: 'repo1',
-                  html_url: 'https://gitea.example.com/test-org/repo1',
-                  empty: false,
-                },
-                {
-                  name: 'repo2',
-                  html_url: 'https://gitea.example.com/test-org/repo2',
-                  empty: false,
-                },
-              ],
-            };
-          }
-          return {
-            ok: true,
-            json: async () => [],
-          };
-        } else if (url.includes('/contents/catalog-info.yaml')) {
-          if (url.includes('repo1')) {
-            return { ok: true };
-          }
-        }
-        return { ok: false };
-      });
-
-      const abortController = new AbortController();
-      await refreshFn(abortController.signal);
-
-      expect(mockConnection.applyMutation).toHaveBeenCalledWith({
-        type: 'full',
-        entities: [
-          {
-            locationKey: 'gitea-provider:test-provider',
-            entity: expect.objectContaining({
-              metadata: expect.objectContaining({
-                annotations: expect.objectContaining({
-                  'backstage.io/managed-by-location':
-                    'url:https://gitea.example.com/test-org/repo1/src/branch/main/catalog-info.yaml',
-                }),
-              }),
-            }),
-          },
-        ],
-      });
-    });
  });

  describe('refresh', () => {
@@ -164,7 +164,7 @@ export class GiteaEntityProvider implements EntityProvider {
    let allRepos: any[] = [];

    try {
-      // Step 1: Fetch all repos for an organization
+      // Fetch all repos for an organization
      const OrgRepoApiUrl = `${getGiteaApiUrl(this.integration.config)}orgs/${
        this.config.organization
      }/repos`;
@@ -201,7 +201,7 @@ export class GiteaEntityProvider implements EntityProvider {
      );
    }

-    // Step 2: Filter for repos that have catalog-info.yaml at root
+    // Filter for repos that have catalog-info.yaml at root
    const { default: pLimit } = await import('p-limit');
    const limit = pLimit(5);
    const validRepos: string[] = [];
@@ -234,11 +234,11 @@ export class GiteaEntityProvider implements EntityProvider {
        }),
      ),
    );
-    // Step 3: create location specs for each valid repo
+    // Create location specs for each valid repo
    const locations = await Promise.all(
      validRepos.map(repo => limit(() => this.createLocationSpec(repo))),
    );
-    // Step 4: Apply the locations to the catalog
+    // Apply the locations to the catalog
    try {
      const providerName: string = this.getProviderName();
      const entities = locations.map(location => ({
@@ -5946,7 +5946,6 @@ __metadata:
  version: 0.0.0-use.local
  resolution: "@backstage/plugin-catalog-backend-module-gitea@workspace:plugins/catalog-backend-module-gitea"
  dependencies:
-    "@backstage/backend-common": "npm:^0.25.0"
    "@backstage/backend-plugin-api": "workspace:^"
    "@backstage/backend-test-utils": "workspace:^"
    "@backstage/cli": "workspace:^"