refactor the TemplateInfo entityMetadata field to an entity object

Signed-off-by: Paul Cowan <paul.cowan@cutting.scot>

plugins/scaffolder-backend-module-cookiecutter/src/actions/fetch/cookiecutter.test.ts

@@ -92,9 +92,6 @@ describe('fetch:cookiecutter', () => {
       templateInfo: {
         entityRef: 'template:default/cookiecutter',
         baseUrl: 'somebase',
-        entityMetadata: {
-          name: 'cookiecutter',
-        },
       },
       workspacePath: mockTmpDir,
       logger: getVoidLogger(),

plugins/scaffolder-backend-module-rails/src/actions/fetch/rails/index.test.ts

@@ -65,9 +65,6 @@ describe('fetch:rails', () => {
     templateInfo: {
       baseUrl: 'somebase',
       entityRef: 'template:default/myTemplate',
-      entityMetadata: {
-        name: 'myTemplate',
-      },
     },
     workspacePath: mockTmpDir,
     logger: getVoidLogger(),

plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/template.test.ts

@@ -78,9 +78,6 @@ describe('fetch:template', () => {
     templateInfo: {
       baseUrl: 'base-url',
       entityRef: 'template:default/test-template',
-      entityMetadata: {
-        name: 'test-template',
-      },
     },
     input: {
       url: './skeleton',

plugins/scaffolder-backend/src/scaffolder/dryrun/createDryRunner.ts

@@ -106,9 +106,6 @@ export function createDryRunner(options: TemplateTesterCreateOptions) {
             baseUrl: pathToFileURL(
               resolveSafeChildPath(contentsPath, 'template.yaml'),
             ).toString(),
-            entityMetadata: {
-              name: 'dry-run',
-            },
           },
         },
         secrets: input.secrets,

plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts

@@ -181,21 +181,13 @@ describe('DefaultWorkflowRunner', () => {
             input: { foo: 1 },
           },
         ],
-        templateInfo: {
-          entityRef,
-          entityMetadata: {
-            name: 'templateName',
-          },
-        },
+        templateInfo: { entityRef },
       });
 
       await runner.execute(task);
 
       expect(fakeActionHandler.mock.calls[0][0].templateInfo).toEqual({
         entityRef,
-        entityMetadata: {
-          name: 'templateName',
-        },
       });
     });
 

plugins/scaffolder-backend/src/service/router.test.ts

@@ -261,7 +261,9 @@ describe('createRouter', () => {
                 name: mockTemplate.metadata?.name,
               }),
               baseUrl: 'https://dev.azure.com',
-              entityMetadata: mockTemplate.metadata,
+              entity: {
+                metadata: mockTemplate.metadata,
+              },
             },
           },
         }),
@@ -313,7 +315,9 @@ describe('createRouter', () => {
                 name: mockTemplate.metadata?.name,
               }),
               baseUrl: 'https://dev.azure.com',
-              entityMetadata: mockTemplate.metadata,
+              entity: {
+                metadata: mockTemplate.metadata,
+              },
             },
           },
         }),

plugins/scaffolder-backend/src/service/router.ts

@@ -249,7 +249,9 @@ export async function createRouter(
             name: template.metadata?.name,
           }),
           baseUrl,
-          entityMetadata: template.metadata,
+          entity: {
+            metadata: template.metadata,
+          },
         },
       };
 

plugins/scaffolder-common/api-report.md

@@ -65,6 +65,8 @@ export const templateEntityV1beta3Validator: KindValidator;
 export type TemplateInfo = {
   entityRef: string;
   baseUrl?: string;
-  entityMetadata: EntityMeta;
+  entity?: {
+    metadata: EntityMeta;
+  };
 };
 ```

plugins/scaffolder-common/src/TaskSpec.ts

@@ -34,9 +34,14 @@ export type TemplateInfo = {
   baseUrl?: string;
 
   /**
-   * The metadata of the Template entity
+   * the Template entity
    */
-  entityMetadata: EntityMeta;
+  entity?: {
+    /**
+     * The metadata of the Template
+     */
+    metadata: EntityMeta;
+  };
 };
 
 /**