updating terms

Signed-off-by: Lucas De Souza <lucas.desouza@aa.com>

plugins/catalog-backend/config.d.ts

@@ -42,11 +42,12 @@ export interface Config {
        * Limit this rule to a specific location
        *
        * Example with a fixed location
-       *  { "type": "url", "target": "https://github.com/a/b/blob/file.yaml}
+       *  { "type": "url", "exact": "https://github.com/a/b/blob/file.yaml"}
        *
        * Example using a Regex
-       *  { "type": "url", "match": "https://github.com/a/*}
+       *  { "type": "url", "pattern": "https://github.com/org/*\/blob/master/*.yaml"}
        *
+       * Using both exact and pattern will result in an error starting the application
        */
       locations?: Array<{
         /**
@@ -54,15 +55,15 @@ export interface Config {
          */
         type: string;
         /**
-         * The target URL of the location, e.g.
+         * The exact location, e.g.
          * "https://github.com/org/repo/blob/master/users.yaml".
          */
-        target?: string;
+        exact?: string;
         /**
          * The pattern allowed for the location, e.g.
          * "https://github.com/org/*\/blob/master/*.yaml.
          */
-        match?: string;
+        pattern?: string;
       }>;
     }>;
 

plugins/catalog-backend/src/ingestion/CatalogRules.test.ts

@@ -54,7 +54,7 @@ const location: Record<string, LocationSpec> = {
 };
 
 describe('DefaultCatalogRulesEnforcer', () => {
-  it('should throw an error if both match and target are used', () => {
+  it('should throw an error if both pattern and exact are used', () => {
     expect(() =>
       DefaultCatalogRulesEnforcer.fromConfig(
         new ConfigReader({
@@ -65,8 +65,8 @@ describe('DefaultCatalogRulesEnforcer', () => {
                 locations: [
                   {
                     type: 'url',
-                    match: 'https://github.com/b/**',
-                    target: 'https://github.com/a/b/blob/master/w.yaml',
+                    pattern: 'https://github.com/b/**',
+                    exact: 'https://github.com/a/b/blob/master/w.yaml',
                   },
                 ],
               },
@@ -74,7 +74,7 @@ describe('DefaultCatalogRulesEnforcer', () => {
           },
         }),
       ),
-    ).toThrow(/cannot have both target and match values/i);
+    ).toThrow(/cannot have both exact and pattern values/i);
   });
   it('should deny by default', () => {
     const enforcer = new DefaultCatalogRulesEnforcer([]);
@@ -250,7 +250,9 @@ describe('DefaultCatalogRulesEnforcer', () => {
             rules: [
               {
                 allow: ['Component'],
-                locations: [{ type: 'url', match: 'https://github.com/b/**' }],
+                locations: [
+                  { type: 'url', pattern: 'https://github.com/b/**' },
+                ],
               },
             ],
           },

plugins/catalog-backend/src/ingestion/CatalogRules.ts

@@ -30,9 +30,9 @@ export type CatalogRule = {
     kind: string;
   }>;
   locations?: Array<{
-    target?: string;
+    exact?: string;
     type: string;
-    match?: string;
+    pattern?: string;
   }>;
 };
 
@@ -78,6 +78,10 @@ export class DefaultCatalogRulesEnforcer implements CatalogRulesEnforcer {
    * catalog:
    *   rules:
    *   - allow: [Component, API]
+   *   - allow: [Template]
+   *     locations:
+   *       - type: url
+   *         pattern: https://github.com/org/*\/blob/master/template.yaml
    *
    *   locations:
    *   - type: url
@@ -102,13 +106,13 @@ export class DefaultCatalogRulesEnforcer implements CatalogRulesEnforcer {
             .getOptionalConfigArray('locations')
             ?.map(locationConfig => {
               const location = {
-                match: locationConfig.getOptionalString('match'),
+                pattern: locationConfig.getOptionalString('pattern'),
                 type: locationConfig.getString('type'),
-                target: locationConfig.getOptionalString('target'),
+                exact: locationConfig.getOptionalString('exact'),
               };
-              if (location.match && location.target) {
+              if (location.pattern && location.exact) {
                 throw new Error(
-                  'A catalog rule location cannot have both target and match values',
+                  'A catalog rule location cannot have both exact and pattern values',
                 );
               }
               return location;
@@ -127,11 +131,11 @@ export class DefaultCatalogRulesEnforcer implements CatalogRulesEnforcer {
             return [];
           }
           const type = locConf.getString('type');
-          const target = resolveTarget(type, locConf.getString('target'));
+          const exact = resolveTarget(type, locConf.getString('target'));
 
           return locConf.getConfigArray('rules').map(ruleConf => ({
             allow: ruleConf.getStringArray('allow').map(kind => ({ kind })),
-            locations: [{ type, target }],
+            locations: [{ type, exact }],
           }));
         });
 
@@ -163,7 +167,7 @@ export class DefaultCatalogRulesEnforcer implements CatalogRulesEnforcer {
 
   private matchLocation(
     location: LocationSpec,
-    matchers?: { target?: string; type: string; match?: string }[],
+    matchers?: { exact?: string; type: string; pattern?: string }[],
   ): boolean {
     if (!matchers) {
       return true;
@@ -173,12 +177,12 @@ export class DefaultCatalogRulesEnforcer implements CatalogRulesEnforcer {
       if (matcher.type !== location?.type) {
         continue;
       }
-      if (matcher.target && matcher.target !== location?.target) {
+      if (matcher.exact && matcher.exact !== location?.target) {
         continue;
       }
       if (
-        matcher.match &&
-        !minimatch(location?.target, matcher.match, { nocase: true })
+        matcher.pattern &&
+        !minimatch(location?.target, matcher.pattern, { nocase: true })
       ) {
         continue;
       }