Merge branch 'master' of github.com:spotify/backstage into shmidt-i/scaffolder-flow-frontend

plugins/scaffolder-backend/src/scaffolder/jobs/logger.test.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 import { makeLogStream } from './logger';
+
 describe('Logger', () => {
   const mockMeta = { test: 'blob' };
 

plugins/scaffolder-backend/src/scaffolder/stages/publish/types.ts

@@ -17,7 +17,17 @@ import { TemplateEntityV1alpha1 } from '@backstage/catalog-model';
 import { RequiredTemplateValues } from '../templater';
 import { JsonValue } from '@backstage/config';
 
+/**
+ * Publisher is in charge of taking a folder created by
+ * the templater, and pushing it to a remote storage
+ */
 export type Publisher = {
+  /**
+   *
+   * @param opts object containing the template entity from the service
+   *             catalog, plus the values from the form and the directory that has
+   *             been templated
+   */
   publish(opts: {
     entity: TemplateEntityV1alpha1;
     values: RequiredTemplateValues & Record<string, JsonValue>;

plugins/scaffolder-backend/src/scaffolder/stages/templater/cookiecutter.test.ts

@@ -131,13 +131,13 @@ describe('CookieCutter Templater', () => {
       component_id: 'newthing',
     };
 
-    const returnPath = await cookie.run({
+    const { resultDir } = await cookie.run({
       directory: tempdir,
       values,
       dockerClient: mockDocker,
     });
 
-    expect(returnPath.startsWith(`${tempdir}-result`)).toBeTruthy();
+    expect(resultDir.startsWith(`${tempdir}-result`)).toBeTruthy();
   });
 
   it('should pass through the streamer to the run docker helper', async () => {

plugins/scaffolder-backend/src/scaffolder/stages/templater/cookiecutter.ts

@@ -18,6 +18,8 @@ import { JsonValue } from '@backstage/config';
 import { runDockerContainer } from './helpers';
 import { TemplaterBase, TemplaterRunOptions } from '.';
 import path from 'path';
+import { TemplaterRunResult } from './types';
+
 export class CookieCutter implements TemplaterBase {
   private async fetchTemplateCookieCutter(
     directory: string,
@@ -33,7 +35,7 @@ export class CookieCutter implements TemplaterBase {
     }
   }
 
-  public async run(options: TemplaterRunOptions): Promise<string> {
+  public async run(options: TemplaterRunOptions): Promise<TemplaterRunResult> {
     // First lets grab the default cookiecutter.json file
     const cookieCutterJson = await this.fetchTemplateCookieCutter(
       options.directory,
@@ -65,6 +67,8 @@ export class CookieCutter implements TemplaterBase {
       dockerClient: options.dockerClient,
     });
 
-    return path.resolve(resultDir, options.values.component_id as string);
+    return {
+      resultDir: path.resolve(resultDir, options.values.component_id as string),
+    };
   }
 }

plugins/scaffolder-backend/src/scaffolder/stages/templater/helpers.test.ts

@@ -26,6 +26,9 @@ describe('helpers', () => {
     jest
       .spyOn(mockDocker, 'run')
       .mockResolvedValue([{ Error: null, StatusCode: 0 }]);
+    jest
+      .spyOn(mockDocker, 'pull')
+      .mockResolvedValue([{ Error: null, StatusCode: 0 }]);
   });
 
   describe('runDockerContainer', () => {
@@ -34,6 +37,17 @@ describe('helpers', () => {
     const templateDir = os.tmpdir();
     const resultDir = os.tmpdir();
 
+    it('will pull the docker container before running', async () => {
+      await runDockerContainer({
+        imageName,
+        args,
+        templateDir,
+        resultDir,
+        dockerClient: mockDocker,
+      });
+
+      expect(mockDocker.pull).toHaveBeenCalledWith(imageName, {});
+    });
     it('should call the dockerClient run command with the correct arguments passed through', async () => {
       await runDockerContainer({
         imageName,

plugins/scaffolder-backend/src/scaffolder/stages/templater/helpers.ts

@@ -44,6 +44,7 @@ export const runDockerContainer = async ({
   templateDir,
   dockerClient,
 }: RunDockerContainerOptions) => {
+  await dockerClient.pull(imageName, {});
   const [{ Error: error, StatusCode: statusCode }] = await dockerClient.run(
     imageName,
     args,

plugins/scaffolder-backend/src/scaffolder/stages/templater/types.ts

@@ -18,11 +18,28 @@ import type { Writable } from 'stream';
 import Docker from 'dockerode';
 import { JsonValue } from '@backstage/config';
 
+/**
+ * Currently the required template values. The owner
+ * and where to store the result from templating
+ */
 export type RequiredTemplateValues = {
   owner: string;
   storePath: string;
 };
 
+/**
+ * The returned directory from the templater which is ready
+ * to pass to the next stage of the scaffolder which is publishing
+ */
+export type TemplaterRunResult = {
+  resultDir: string;
+};
+
+/**
+ * The values that the templater will recieve. The directory of the
+ * skeleton, with the values from the frontend. A dedicated log stream and a docker
+ * client to run any templater on top of your directory.
+ */
 export type TemplaterRunOptions = {
   directory: string;
   values: RequiredTemplateValues & Record<string, JsonValue>;
@@ -32,7 +49,7 @@ export type TemplaterRunOptions = {
 
 export type TemplaterBase = {
   // runs the templating with the values and returns the directory to push the VCS
-  run(opts: TemplaterRunOptions): Promise<string>;
+  run(opts: TemplaterRunOptions): Promise<TemplaterRunResult>;
 };
 
 export type TemplaterConfig = {