From 4e9453d6ed0c5099b28fcc3a81f192de8b123628 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mattias=20Frinnstr=C3=B6m?=
 <mattias.frinnstrom@husqvarnagroup.com>
Date: Fri, 23 Oct 2020 14:42:59 +0200
Subject: [PATCH 1/7] Add workdir config support to scaffolder

---
 app-config.yaml                               |  1 +
 packages/backend/src/plugins/scaffolder.ts    |  1 +
 .../templates/default-app/app-config.yaml.hbs |  1 +
 .../scaffolder/stages/prepare/azure.test.ts   | 19 +++++++++-----
 .../src/scaffolder/stages/prepare/azure.ts    | 15 ++++++-----
 .../scaffolder/stages/prepare/file.test.ts    |  5 +++-
 .../src/scaffolder/stages/prepare/file.ts     |  9 ++++---
 .../scaffolder/stages/prepare/github.test.ts  | 20 ++++++++++-----
 .../src/scaffolder/stages/prepare/github.ts   |  9 ++++---
 .../scaffolder/stages/prepare/gitlab.test.ts  | 19 +++++++++-----
 .../src/scaffolder/stages/prepare/gitlab.ts   | 10 +++++---
 .../src/scaffolder/stages/prepare/types.ts    |  2 +-
 .../src/service/router.test.ts                |  2 ++
 .../scaffolder-backend/src/service/router.ts  | 25 ++++++++++++++++++-
 14 files changed, 99 insertions(+), 39 deletions(-)

diff --git a/app-config.yaml b/app-config.yaml
index 6e3a68a229..009876a64b 100644
--- a/app-config.yaml
+++ b/app-config.yaml
@@ -155,6 +155,7 @@ catalog:
       target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/acme-corp.yaml
 
 scaffolder:
+  # workingDirectory: /tmp # Use this to configure a working direcotry for the scaffolder, defaults to the OS temp-dir
   github:
     token:
       $env: GITHUB_TOKEN
diff --git a/packages/backend/src/plugins/scaffolder.ts b/packages/backend/src/plugins/scaffolder.ts
index c84928ea68..6eacd143c1 100644
--- a/packages/backend/src/plugins/scaffolder.ts
+++ b/packages/backend/src/plugins/scaffolder.ts
@@ -45,6 +45,7 @@ export default async function createPlugin({
     templaters,
     publishers,
     logger,
+    config,
     dockerClient,
   });
 }
diff --git a/packages/create-app/templates/default-app/app-config.yaml.hbs b/packages/create-app/templates/default-app/app-config.yaml.hbs
index 1f265d7e7d..9f66e7db0a 100644
--- a/packages/create-app/templates/default-app/app-config.yaml.hbs
+++ b/packages/create-app/templates/default-app/app-config.yaml.hbs
@@ -69,6 +69,7 @@ auth:
   providers: {}
 
 scaffolder:
+  # workingDirectory: /tmp # Use this to configure a working direcotry for the scaffolder, defaults to the OS temp-dir
   github:
     token:
       $env: GITHUB_TOKEN
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.test.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.test.ts
index 7a7973e981..065ebaefa5 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.test.ts
@@ -19,6 +19,11 @@ const mocks = {
   CheckoutOptions: jest.fn(() => {}),
 };
 jest.doMock('nodegit', () => mocks);
+jest.doMock('fs-extra', () => ({
+  promises: {
+    mkdtemp: jest.fn(dir => `${dir}-static`),
+  },
+}));
 
 import { AzurePreparer } from './azure';
 import {
@@ -73,7 +78,7 @@ describe('AzurePreparer', () => {
 
   it('calls the clone command with the correct arguments for a repository', async () => {
     const preparer = new AzurePreparer(ConfigReader.fromConfigs([]));
-    await preparer.prepare(mockEntity);
+    await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
     expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
       1,
       'https://dev.azure.com/backstage-org/backstage-project/_git/template-repo',
@@ -99,7 +104,7 @@ describe('AzurePreparer', () => {
         },
       ]),
     );
-    await preparer.prepare(mockEntity);
+    await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
     expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
       1,
       'https://dev.azure.com/backstage-org/backstage-project/_git/template-repo',
@@ -117,7 +122,7 @@ describe('AzurePreparer', () => {
   it('calls the clone command with the correct arguments for a repository when no path is provided', async () => {
     const preparer = new AzurePreparer(ConfigReader.fromConfigs([]));
     delete mockEntity.spec.path;
-    await preparer.prepare(mockEntity);
+    await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
     expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
       1,
       'https://dev.azure.com/backstage-org/backstage-project/_git/template-repo',
@@ -129,10 +134,12 @@ describe('AzurePreparer', () => {
   it('return the temp directory with the path to the folder if it is specified', async () => {
     const preparer = new AzurePreparer(ConfigReader.fromConfigs([]));
     mockEntity.spec.path = './template/test/1/2/3';
-    const response = await preparer.prepare(mockEntity);
+    const response = await preparer.prepare(mockEntity, {
+      workingDirectory: '/workDir',
+    });
 
-    expect(response.split('\\').join('/')).toMatch(
-      /\/template\/test\/1\/2\/3$/,
+    expect(response).toBe(
+      `/workDir/graphql-starter-static/template/test/1/2/3`,
     );
   });
 });
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.ts
index dc74ec0f75..aaf8508c8e 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.ts
@@ -15,7 +15,6 @@
  */
 import fs from 'fs-extra';
 import path from 'path';
-import os from 'os';
 import { TemplateEntityV1alpha1 } from '@backstage/catalog-model';
 import { parseLocationAnnotation } from '../helpers';
 import { InputError } from '@backstage/backend-common';
@@ -32,8 +31,12 @@ export class AzurePreparer implements PreparerBase {
       config.getOptionalString('scaffolder.azure.api.token') ?? '';
   }
 
-  async prepare(template: TemplateEntityV1alpha1): Promise<string> {
+  async prepare(
+    template: TemplateEntityV1alpha1,
+    opts: { workingDirectory: string },
+  ): Promise<string> {
     const { protocol, location } = parseLocationAnnotation(template);
+    const { workingDirectory } = opts;
 
     if (!['azure/api', 'url'].includes(protocol)) {
       throw new InputError(
@@ -42,18 +45,14 @@ export class AzurePreparer implements PreparerBase {
     }
     const templateId = template.metadata.name;
 
-    const url = new URL(location); // Need to extract filepath from search parameter
     const parsedGitLocation = GitUriParser(location);
     const repositoryCheckoutUrl = parsedGitLocation.toString('https');
-
     const tempDir = await fs.promises.mkdtemp(
-      path.join(os.tmpdir(), templateId),
+      path.join(workingDirectory, templateId),
     );
 
     const templateDirectory = path.join(
-      `${path
-        .dirname(url.searchParams.get('path') || '')
-        .replace(/^\/+/g, '')}`, // Strip leading slash
+      `${path.dirname(parsedGitLocation.filepath)}`,
       template.spec.path ?? '.',
     );
 
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.test.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.test.ts
index b9472fbc8d..d226736efe 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.test.ts
@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import os from 'os';
 import fs from 'fs-extra';
 import YAML from 'yaml';
 import { FilePreparer } from './file';
@@ -42,7 +43,9 @@ const setupTest = async (fixturePath: string) => {
   };
 
   const filePreparer = new FilePreparer();
-  const resultDir = await filePreparer.prepare(template);
+  const resultDir = await filePreparer.prepare(template, {
+    workingDirectory: os.tmpdir(),
+  });
 
   return { filePreparer, template, resultDir };
 };
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.ts
index b5ac846cf2..828238ae08 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.ts
@@ -15,15 +15,18 @@
  */
 import fs from 'fs-extra';
 import path from 'path';
-import os from 'os';
 import { TemplateEntityV1alpha1 } from '@backstage/catalog-model';
 import { parseLocationAnnotation } from '../helpers';
 import { InputError } from '@backstage/backend-common';
 import { PreparerBase } from './types';
 
 export class FilePreparer implements PreparerBase {
-  async prepare(template: TemplateEntityV1alpha1): Promise<string> {
+  async prepare(
+    template: TemplateEntityV1alpha1,
+    opts: { workingDirectory: string },
+  ): Promise<string> {
     const { protocol, location } = parseLocationAnnotation(template);
+    const { workingDirectory } = opts;
 
     if (protocol !== 'file') {
       throw new InputError(
@@ -33,7 +36,7 @@ export class FilePreparer implements PreparerBase {
     const templateId = template.metadata.name;
 
     const tempDir = await fs.promises.mkdtemp(
-      path.join(os.tmpdir(), templateId),
+      path.join(workingDirectory, templateId),
     );
 
     const parentDirectory = path.resolve(
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.test.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.test.ts
index de57043a50..29655f7ee9 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.test.ts
@@ -19,6 +19,11 @@ const mocks = {
   CheckoutOptions: jest.fn(() => {}),
 };
 jest.doMock('nodegit', () => mocks);
+jest.doMock('fs-extra', () => ({
+  promises: {
+    mkdtemp: jest.fn(dir => `${dir}-static`),
+  },
+}));
 
 import { GithubPreparer } from './github';
 import {
@@ -71,7 +76,7 @@ describe('GitHubPreparer', () => {
   });
   it('calls the clone command with the correct arguments for a repository', async () => {
     const preparer = new GithubPreparer();
-    await preparer.prepare(mockEntity);
+    await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
     expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
       1,
       'https://github.com/benjdlambert/backstage-graphql-template',
@@ -84,7 +89,7 @@ describe('GitHubPreparer', () => {
   it('calls the clone command with the correct arguments for a repository when no path is provided', async () => {
     const preparer = new GithubPreparer();
     delete mockEntity.spec.path;
-    await preparer.prepare(mockEntity);
+    await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
     expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
       1,
       'https://github.com/benjdlambert/backstage-graphql-template',
@@ -97,15 +102,18 @@ describe('GitHubPreparer', () => {
   it('return the temp directory with the path to the folder if it is specified', async () => {
     const preparer = new GithubPreparer();
     mockEntity.spec.path = './template/test/1/2/3';
-    const response = await preparer.prepare(mockEntity);
+    const response = await preparer.prepare(mockEntity, {
+      workingDirectory: '/workDir',
+    });
 
-    expect(response.split('\\').join('/')).toMatch(
-      /\/template\/test\/1\/2\/3$/,
+    expect(response).toBe(
+      `/workDir/graphql-starter-static/template/test/1/2/3`,
     );
   });
+
   it('calls the clone command with the token when provided', async () => {
     const preparer = new GithubPreparer({ token: 'abc' });
-    await preparer.prepare(mockEntity);
+    await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
     expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
       1,
       'https://github.com/benjdlambert/backstage-graphql-template',
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.ts
index 0f064d22fa..863b760d03 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.ts
@@ -15,7 +15,6 @@
  */
 import fs from 'fs-extra';
 import path from 'path';
-import os from 'os';
 import { TemplateEntityV1alpha1 } from '@backstage/catalog-model';
 import { parseLocationAnnotation } from '../helpers';
 import { InputError } from '@backstage/backend-common';
@@ -30,8 +29,12 @@ export class GithubPreparer implements PreparerBase {
     this.token = params.token;
   }
 
-  async prepare(template: TemplateEntityV1alpha1): Promise<string> {
+  async prepare(
+    template: TemplateEntityV1alpha1,
+    opts: { workingDirectory: string },
+  ): Promise<string> {
     const { protocol, location } = parseLocationAnnotation(template);
+    const { workingDirectory } = opts;
     const { token } = this;
 
     if (!['github', 'url'].includes(protocol)) {
@@ -44,7 +47,7 @@ export class GithubPreparer implements PreparerBase {
     const parsedGitLocation = GitUriParser(location);
     const repositoryCheckoutUrl = parsedGitLocation.toString('https');
     const tempDir = await fs.promises.mkdtemp(
-      path.join(os.tmpdir(), templateId),
+      path.join(workingDirectory, templateId),
     );
 
     const templateDirectory = path.join(
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.test.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.test.ts
index b25886b027..8df853ac06 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.test.ts
@@ -18,6 +18,11 @@ const mocks = {
   CheckoutOptions: jest.fn(() => {}),
 };
 jest.doMock('nodegit', () => mocks);
+jest.doMock('fs-extra', () => ({
+  promises: {
+    mkdtemp: jest.fn(dir => `${dir}-static`),
+  },
+}));
 
 import { GitlabPreparer } from './gitlab';
 import {
@@ -74,7 +79,7 @@ describe('GitLabPreparer', () => {
     it(`calls the clone command with the correct arguments for a repository using the ${protocol} protocol`, async () => {
       const preparer = new GitlabPreparer(ConfigReader.fromConfigs([]));
       mockEntity = mockEntityWithProtocol(protocol);
-      await preparer.prepare(mockEntity);
+      await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
       expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
         1,
         'https://gitlab.com/benjdlambert/backstage-graphql-template',
@@ -101,7 +106,7 @@ describe('GitLabPreparer', () => {
         ]),
       );
       mockEntity = mockEntityWithProtocol(protocol);
-      await preparer.prepare(mockEntity);
+      await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
       expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
         1,
         'https://gitlab.com/benjdlambert/backstage-graphql-template',
@@ -120,7 +125,7 @@ describe('GitLabPreparer', () => {
       const preparer = new GitlabPreparer(ConfigReader.fromConfigs([]));
       mockEntity = mockEntityWithProtocol(protocol);
       delete mockEntity.spec.path;
-      await preparer.prepare(mockEntity);
+      await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
       expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
         1,
         'https://gitlab.com/benjdlambert/backstage-graphql-template',
@@ -133,10 +138,12 @@ describe('GitLabPreparer', () => {
       const preparer = new GitlabPreparer(ConfigReader.fromConfigs([]));
       mockEntity = mockEntityWithProtocol(protocol);
       mockEntity.spec.path = './template/test/1/2/3';
-      const response = await preparer.prepare(mockEntity);
+      const response = await preparer.prepare(mockEntity, {
+        workingDirectory: '/workDir',
+      });
 
-      expect(response.split('\\').join('/')).toMatch(
-        /\/template\/test\/1\/2\/3$/,
+      expect(response).toBe(
+        `/workDir/graphql-starter-static/template/test/1/2/3`,
       );
     });
   });
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.ts
index 8ccde0b626..5be72f85b5 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.ts
@@ -15,7 +15,6 @@
  */
 import fs from 'fs-extra';
 import path from 'path';
-import os from 'os';
 import { TemplateEntityV1alpha1 } from '@backstage/catalog-model';
 import { parseLocationAnnotation } from '../helpers';
 import { InputError } from '@backstage/backend-common';
@@ -33,8 +32,12 @@ export class GitlabPreparer implements PreparerBase {
       '';
   }
 
-  async prepare(template: TemplateEntityV1alpha1): Promise<string> {
+  async prepare(
+    template: TemplateEntityV1alpha1,
+    opts: { workingDirectory: string },
+  ): Promise<string> {
     const { protocol, location } = parseLocationAnnotation(template);
+    const { workingDirectory } = opts;
 
     if (!['gitlab', 'gitlab/api', 'url'].includes(protocol)) {
       throw new InputError(
@@ -45,9 +48,8 @@ export class GitlabPreparer implements PreparerBase {
 
     const parsedGitLocation = GitUriParser(location);
     const repositoryCheckoutUrl = parsedGitLocation.toString('https');
-
     const tempDir = await fs.promises.mkdtemp(
-      path.join(os.tmpdir(), templateId),
+      path.join(workingDirectory, templateId),
     );
 
     const templateDirectory = path.join(
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/types.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/types.ts
index c9dd14c0a3..940d2b4178 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/types.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/types.ts
@@ -25,7 +25,7 @@ export type PreparerBase = {
    */
   prepare(
     template: TemplateEntityV1alpha1,
-    opts: { logger: Logger },
+    opts: { logger: Logger; workingDirectory: string },
   ): Promise<string>;
 };
 
diff --git a/plugins/scaffolder-backend/src/service/router.test.ts b/plugins/scaffolder-backend/src/service/router.test.ts
index 35d6b50ece..9e44fb8cbe 100644
--- a/plugins/scaffolder-backend/src/service/router.test.ts
+++ b/plugins/scaffolder-backend/src/service/router.test.ts
@@ -15,6 +15,7 @@
  */
 
 import { getVoidLogger } from '@backstage/backend-common';
+import { ConfigReader } from '@backstage/config';
 import express from 'express';
 import request from 'supertest';
 import { createRouter } from './router';
@@ -32,6 +33,7 @@ describe('createRouter', () => {
       preparers: new Preparers(),
       templaters: new Templaters(),
       publishers: new Publishers(),
+      config: ConfigReader.fromConfigs([]),
       dockerClient: new Docker(),
     });
     app = express().use(router);
diff --git a/plugins/scaffolder-backend/src/service/router.ts b/plugins/scaffolder-backend/src/service/router.ts
index f61d2566b9..60c17a3e80 100644
--- a/plugins/scaffolder-backend/src/service/router.ts
+++ b/plugins/scaffolder-backend/src/service/router.ts
@@ -15,7 +15,9 @@
  */
 
 import { TemplateEntityV1alpha1 } from '@backstage/catalog-model';
-import { JsonValue } from '@backstage/config';
+import { Config, JsonValue } from '@backstage/config';
+import os from 'os';
+import fs from 'fs-extra';
 import Docker from 'dockerode';
 import express from 'express';
 import Router from 'express-promise-router';
@@ -36,6 +38,7 @@ export interface RouterOptions {
   publishers: PublisherBuilder;
 
   logger: Logger;
+  config: Config;
   dockerClient: Docker;
 }
 
@@ -50,12 +53,31 @@ export async function createRouter(
     templaters,
     publishers,
     logger: parentLogger,
+    config,
     dockerClient,
   } = options;
 
   const logger = parentLogger.child({ plugin: 'scaffolder' });
   const jobProcessor = new JobProcessor();
 
+  const workingDirectory =
+    config.getOptionalString('scaffolder.workingDirectory') ?? os.tmpdir();
+  try {
+    // Check if working directory exists and is writable
+    await fs.promises.access(
+      workingDirectory,
+      fs.constants.F_OK | fs.constants.W_OK,
+    );
+    logger.info(`using working directory: ${workingDirectory}`);
+  } catch (err) {
+    logger.error(
+      `working directory ${workingDirectory} ${
+        err.code === 'ENOENT' ? 'does not exist' : 'is not writable'
+      }`,
+    );
+    throw err;
+  }
+
   router
     .get('/v1/job/:jobId', ({ params }, res) => {
       const job = jobProcessor.get(params.jobId);
@@ -104,6 +126,7 @@ export async function createRouter(
               const preparer = preparers.get(ctx.entity);
               const skeletonDir = await preparer.prepare(ctx.entity, {
                 logger: ctx.logger,
+                workingDirectory,
               });
               return { skeletonDir };
             },

From 3f9f500fe343fd5f5c1927930663cb217f3a55a6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mattias=20Frinnstr=C3=B6m?=
 <mattias.frinnstrom@husqvarnagroup.com>
Date: Mon, 26 Oct 2020 14:32:08 +0100
Subject: [PATCH 2/7] Add testing for working directory config

---
 .../src/service/router.test.ts                | 113 ++++++++++++++++++
 1 file changed, 113 insertions(+)

diff --git a/plugins/scaffolder-backend/src/service/router.test.ts b/plugins/scaffolder-backend/src/service/router.test.ts
index 9e44fb8cbe..32f9604caf 100644
--- a/plugins/scaffolder-backend/src/service/router.test.ts
+++ b/plugins/scaffolder-backend/src/service/router.test.ts
@@ -14,6 +14,18 @@
  * limitations under the License.
  */
 
+const mockAccess = jest.fn();
+jest.doMock('fs-extra', () => ({
+  promises: {
+    access: mockAccess,
+  },
+  constants: {
+    F_OK: 0,
+    W_OK: 1,
+  },
+}));
+
+import os from 'os';
 import { getVoidLogger } from '@backstage/backend-common';
 import { ConfigReader } from '@backstage/config';
 import express from 'express';
@@ -24,6 +36,107 @@ import Docker from 'dockerode';
 
 jest.mock('dockerode');
 
+describe('createRouter - working directory', () => {
+  const mockPrepare = jest.fn();
+  const mockPreparers = new Preparers();
+
+  beforeAll(() => {
+    const mockPreparer = {
+      prepare: mockPrepare,
+    };
+    mockPreparers.register('azure/api', mockPreparer);
+  });
+
+  beforeEach(() => {
+    jest.resetAllMocks();
+  });
+
+  const workDirConfig = (path: string) => ({
+    context: '',
+    data: {
+      scaffolder: {
+        workingDirectory: path,
+      },
+    },
+  });
+
+  const template = {
+    apiVersion: 'backstage.io/v1alpha1',
+    kind: 'Template',
+    metadata: {
+      annotations: {
+        'backstage.io/managed-by-location': 'azure/api:dev.azure.com',
+      },
+    },
+    spec: {
+      owner: 'template@backstage.io',
+      path: '.',
+      schema: {},
+    },
+  };
+
+  it('should throw an error when working directory does not exist or is not writable', async () => {
+    mockAccess.mockImplementation(() => {
+      throw new Error('access error');
+    });
+
+    await expect(
+      createRouter({
+        logger: getVoidLogger(),
+        preparers: new Preparers(),
+        templaters: new Templaters(),
+        publishers: new Publishers(),
+        config: ConfigReader.fromConfigs([workDirConfig('/path')]),
+        dockerClient: new Docker(),
+      }),
+    ).rejects.toThrow('access error');
+  });
+
+  it('should use the working directory when configured', async () => {
+    const router = await createRouter({
+      logger: getVoidLogger(),
+      preparers: mockPreparers,
+      templaters: new Templaters(),
+      publishers: new Publishers(),
+      config: ConfigReader.fromConfigs([workDirConfig('/path')]),
+      dockerClient: new Docker(),
+    });
+
+    const app = express().use(router);
+    await request(app).post('/v1/jobs').send({
+      template,
+      values: {},
+    });
+
+    expect(mockPrepare).toBeCalledWith(expect.anything(), {
+      logger: expect.anything(),
+      workingDirectory: '/path',
+    });
+  });
+
+  it('should default to OS temp-dir when no working directory is configured', async () => {
+    const router = await createRouter({
+      logger: getVoidLogger(),
+      preparers: mockPreparers,
+      templaters: new Templaters(),
+      publishers: new Publishers(),
+      config: ConfigReader.fromConfigs([]),
+      dockerClient: new Docker(),
+    });
+
+    const app = express().use(router);
+    await request(app).post('/v1/jobs').send({
+      template,
+      values: {},
+    });
+
+    expect(mockPrepare).toBeCalledWith(expect.anything(), {
+      logger: expect.anything(),
+      workingDirectory: os.tmpdir(),
+    });
+  });
+});
+
 describe('createRouter', () => {
   let app: express.Express;
 

From 3b44008556e92d274199e7477f74fd2402a10f6b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mattias=20Frinnstr=C3=B6m?=
 <mattias.frinnstrom@husqvarnagroup.com>
Date: Mon, 26 Oct 2020 14:45:47 +0100
Subject: [PATCH 3/7] Add missing config to create-app

---
 .../default-app/packages/backend/src/plugins/scaffolder.ts       | 1 +
 1 file changed, 1 insertion(+)

diff --git a/packages/create-app/templates/default-app/packages/backend/src/plugins/scaffolder.ts b/packages/create-app/templates/default-app/packages/backend/src/plugins/scaffolder.ts
index 240309fbd1..8de15920e9 100644
--- a/packages/create-app/templates/default-app/packages/backend/src/plugins/scaffolder.ts
+++ b/packages/create-app/templates/default-app/packages/backend/src/plugins/scaffolder.ts
@@ -102,6 +102,7 @@ export default async function createPlugin({
     templaters,
     publishers,
     logger,
+    config,
     dockerClient,
   });
 }

From 7f417559bb2728adcbb34eec6355468f2c8b91bd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mattias=20Frinnstr=C3=B6m?=
 <mattias.frinnstrom@husqvarnagroup.com>
Date: Mon, 26 Oct 2020 16:04:45 +0100
Subject: [PATCH 4/7] Move working directory config to backend

---
 app-config.yaml                                               | 2 +-
 packages/create-app/templates/default-app/app-config.yaml.hbs | 2 +-
 plugins/scaffolder-backend/src/service/router.test.ts         | 2 +-
 plugins/scaffolder-backend/src/service/router.ts              | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/app-config.yaml b/app-config.yaml
index 009876a64b..4746e822da 100644
--- a/app-config.yaml
+++ b/app-config.yaml
@@ -16,6 +16,7 @@ backend:
     credentials: true
   csp:
     connect-src: ["'self'", 'http:', 'https:']
+  # workingDirectory: /tmp # Use this to configure a working direcotry for the scaffolder, defaults to the OS temp-dir
 
 # See README.md in the proxy-backend plugin for information on the configuration format
 proxy:
@@ -155,7 +156,6 @@ catalog:
       target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/acme-corp.yaml
 
 scaffolder:
-  # workingDirectory: /tmp # Use this to configure a working direcotry for the scaffolder, defaults to the OS temp-dir
   github:
     token:
       $env: GITHUB_TOKEN
diff --git a/packages/create-app/templates/default-app/app-config.yaml.hbs b/packages/create-app/templates/default-app/app-config.yaml.hbs
index 9f66e7db0a..d643c72e0c 100644
--- a/packages/create-app/templates/default-app/app-config.yaml.hbs
+++ b/packages/create-app/templates/default-app/app-config.yaml.hbs
@@ -38,6 +38,7 @@ backend:
         #ca: # if you have a CA file and want to verify it you can uncomment this section
         #  $file: <file-path>/ca/server.crt
   {{/if}}
+  # workingDirectory: /tmp # Use this to configure a working direcotry for the scaffolder, defaults to the OS temp-dir
 
 integrations:
   github:
@@ -69,7 +70,6 @@ auth:
   providers: {}
 
 scaffolder:
-  # workingDirectory: /tmp # Use this to configure a working direcotry for the scaffolder, defaults to the OS temp-dir
   github:
     token:
       $env: GITHUB_TOKEN
diff --git a/plugins/scaffolder-backend/src/service/router.test.ts b/plugins/scaffolder-backend/src/service/router.test.ts
index 32f9604caf..bca17aa029 100644
--- a/plugins/scaffolder-backend/src/service/router.test.ts
+++ b/plugins/scaffolder-backend/src/service/router.test.ts
@@ -54,7 +54,7 @@ describe('createRouter - working directory', () => {
   const workDirConfig = (path: string) => ({
     context: '',
     data: {
-      scaffolder: {
+      backend: {
         workingDirectory: path,
       },
     },
diff --git a/plugins/scaffolder-backend/src/service/router.ts b/plugins/scaffolder-backend/src/service/router.ts
index 60c17a3e80..e66728ac91 100644
--- a/plugins/scaffolder-backend/src/service/router.ts
+++ b/plugins/scaffolder-backend/src/service/router.ts
@@ -61,7 +61,7 @@ export async function createRouter(
   const jobProcessor = new JobProcessor();
 
   const workingDirectory =
-    config.getOptionalString('scaffolder.workingDirectory') ?? os.tmpdir();
+    config.getOptionalString('backend.workingDirectory') ?? os.tmpdir();
   try {
     // Check if working directory exists and is writable
     await fs.promises.access(

From fe9ec8f98888b1d755352851b51bc2447009d44e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mattias=20Frinnstr=C3=B6m?=
 <mattias.frinnstrom@husqvarnagroup.com>
Date: Mon, 26 Oct 2020 17:10:27 +0100
Subject: [PATCH 5/7] Updated types and moved defaulting logic

---
 .../scaffolder/stages/prepare/azure.test.ts   | 12 ++++++-
 .../src/scaffolder/stages/prepare/azure.ts    |  5 +--
 .../src/scaffolder/stages/prepare/file.ts     |  5 +--
 .../scaffolder/stages/prepare/github.test.ts  | 13 ++++++-
 .../src/scaffolder/stages/prepare/github.ts   |  5 +--
 .../scaffolder/stages/prepare/gitlab.test.ts  | 12 ++++++-
 .../src/scaffolder/stages/prepare/gitlab.ts   |  5 +--
 .../src/scaffolder/stages/prepare/types.ts    |  2 +-
 .../src/service/router.test.ts                |  4 +--
 .../scaffolder-backend/src/service/router.ts  | 34 ++++++++++---------
 10 files changed, 66 insertions(+), 31 deletions(-)

diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.test.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.test.ts
index 065ebaefa5..ca5c29e9ce 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.test.ts
@@ -132,6 +132,16 @@ describe('AzurePreparer', () => {
   });
 
   it('return the temp directory with the path to the folder if it is specified', async () => {
+    const preparer = new AzurePreparer(ConfigReader.fromConfigs([]));
+    mockEntity.spec.path = './template/test/1/2/3';
+    const response = await preparer.prepare(mockEntity, {});
+
+    expect(response.split('\\').join('/')).toMatch(
+      /\/template\/test\/1\/2\/3$/,
+    );
+  });
+
+  it('return the working directory with the path to the folder if it is specified', async () => {
     const preparer = new AzurePreparer(ConfigReader.fromConfigs([]));
     mockEntity.spec.path = './template/test/1/2/3';
     const response = await preparer.prepare(mockEntity, {
@@ -139,7 +149,7 @@ describe('AzurePreparer', () => {
     });
 
     expect(response).toBe(
-      `/workDir/graphql-starter-static/template/test/1/2/3`,
+      '/workDir/graphql-starter-static/template/test/1/2/3',
     );
   });
 });
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.ts
index aaf8508c8e..bd5458b329 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.ts
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import os from 'os';
 import fs from 'fs-extra';
 import path from 'path';
 import { TemplateEntityV1alpha1 } from '@backstage/catalog-model';
@@ -33,10 +34,10 @@ export class AzurePreparer implements PreparerBase {
 
   async prepare(
     template: TemplateEntityV1alpha1,
-    opts: { workingDirectory: string },
+    opts: { workingDirectory?: string },
   ): Promise<string> {
     const { protocol, location } = parseLocationAnnotation(template);
-    const { workingDirectory } = opts;
+    const workingDirectory = opts.workingDirectory ?? os.tmpdir();
 
     if (!['azure/api', 'url'].includes(protocol)) {
       throw new InputError(
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.ts
index 828238ae08..b97e4ae08b 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.ts
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import os from 'os';
 import fs from 'fs-extra';
 import path from 'path';
 import { TemplateEntityV1alpha1 } from '@backstage/catalog-model';
@@ -23,10 +24,10 @@ import { PreparerBase } from './types';
 export class FilePreparer implements PreparerBase {
   async prepare(
     template: TemplateEntityV1alpha1,
-    opts: { workingDirectory: string },
+    opts: { workingDirectory?: string },
   ): Promise<string> {
     const { protocol, location } = parseLocationAnnotation(template);
-    const { workingDirectory } = opts;
+    const workingDirectory = opts.workingDirectory ?? os.tmpdir();
 
     if (protocol !== 'file') {
       throw new InputError(
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.test.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.test.ts
index 29655f7ee9..d652d8aa35 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.test.ts
@@ -99,7 +99,18 @@ describe('GitHubPreparer', () => {
       },
     );
   });
+
   it('return the temp directory with the path to the folder if it is specified', async () => {
+    const preparer = new GithubPreparer();
+    mockEntity.spec.path = './template/test/1/2/3';
+    const response = await preparer.prepare(mockEntity, {});
+
+    expect(response.split('\\').join('/')).toMatch(
+      /\/template\/test\/1\/2\/3$/,
+    );
+  });
+
+  it('return the working directory with the path to the folder if it is specified', async () => {
     const preparer = new GithubPreparer();
     mockEntity.spec.path = './template/test/1/2/3';
     const response = await preparer.prepare(mockEntity, {
@@ -107,7 +118,7 @@ describe('GitHubPreparer', () => {
     });
 
     expect(response).toBe(
-      `/workDir/graphql-starter-static/template/test/1/2/3`,
+      '/workDir/graphql-starter-static/template/test/1/2/3',
     );
   });
 
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.ts
index 863b760d03..1987c416b3 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.ts
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import os from 'os';
 import fs from 'fs-extra';
 import path from 'path';
 import { TemplateEntityV1alpha1 } from '@backstage/catalog-model';
@@ -31,10 +32,10 @@ export class GithubPreparer implements PreparerBase {
 
   async prepare(
     template: TemplateEntityV1alpha1,
-    opts: { workingDirectory: string },
+    opts: { workingDirectory?: string },
   ): Promise<string> {
     const { protocol, location } = parseLocationAnnotation(template);
-    const { workingDirectory } = opts;
+    const workingDirectory = opts.workingDirectory ?? os.tmpdir();
     const { token } = this;
 
     if (!['github', 'url'].includes(protocol)) {
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.test.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.test.ts
index 8df853ac06..3ee9dd103d 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.test.ts
@@ -138,12 +138,22 @@ describe('GitLabPreparer', () => {
       const preparer = new GitlabPreparer(ConfigReader.fromConfigs([]));
       mockEntity = mockEntityWithProtocol(protocol);
       mockEntity.spec.path = './template/test/1/2/3';
+      const response = await preparer.prepare(mockEntity, {});
+
+      expect(response.split('\\').join('/')).toMatch(
+        /\/template\/test\/1\/2\/3$/,
+      );
+    });
+
+    it('return the working directory with the path to the folder if it is specified', async () => {
+      const preparer = new GitlabPreparer(ConfigReader.fromConfigs([]));
+      mockEntity.spec.path = './template/test/1/2/3';
       const response = await preparer.prepare(mockEntity, {
         workingDirectory: '/workDir',
       });
 
       expect(response).toBe(
-        `/workDir/graphql-starter-static/template/test/1/2/3`,
+        '/workDir/graphql-starter-static/template/test/1/2/3',
       );
     });
   });
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.ts
index 5be72f85b5..55fc846bb5 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.ts
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import os from 'os';
 import fs from 'fs-extra';
 import path from 'path';
 import { TemplateEntityV1alpha1 } from '@backstage/catalog-model';
@@ -34,10 +35,10 @@ export class GitlabPreparer implements PreparerBase {
 
   async prepare(
     template: TemplateEntityV1alpha1,
-    opts: { workingDirectory: string },
+    opts: { workingDirectory?: string },
   ): Promise<string> {
     const { protocol, location } = parseLocationAnnotation(template);
-    const { workingDirectory } = opts;
+    const workingDirectory = opts.workingDirectory ?? os.tmpdir();
 
     if (!['gitlab', 'gitlab/api', 'url'].includes(protocol)) {
       throw new InputError(
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/types.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/types.ts
index 940d2b4178..1a28b316c6 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/types.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/types.ts
@@ -25,7 +25,7 @@ export type PreparerBase = {
    */
   prepare(
     template: TemplateEntityV1alpha1,
-    opts: { logger: Logger; workingDirectory: string },
+    opts: { logger: Logger; workingDirectory?: string },
   ): Promise<string>;
 };
 
diff --git a/plugins/scaffolder-backend/src/service/router.test.ts b/plugins/scaffolder-backend/src/service/router.test.ts
index bca17aa029..fae7ee8beb 100644
--- a/plugins/scaffolder-backend/src/service/router.test.ts
+++ b/plugins/scaffolder-backend/src/service/router.test.ts
@@ -25,7 +25,6 @@ jest.doMock('fs-extra', () => ({
   },
 }));
 
-import os from 'os';
 import { getVoidLogger } from '@backstage/backend-common';
 import { ConfigReader } from '@backstage/config';
 import express from 'express';
@@ -114,7 +113,7 @@ describe('createRouter - working directory', () => {
     });
   });
 
-  it('should default to OS temp-dir when no working directory is configured', async () => {
+  it('should not pass along anything when no working directory is configured', async () => {
     const router = await createRouter({
       logger: getVoidLogger(),
       preparers: mockPreparers,
@@ -132,7 +131,6 @@ describe('createRouter - working directory', () => {
 
     expect(mockPrepare).toBeCalledWith(expect.anything(), {
       logger: expect.anything(),
-      workingDirectory: os.tmpdir(),
     });
   });
 });
diff --git a/plugins/scaffolder-backend/src/service/router.ts b/plugins/scaffolder-backend/src/service/router.ts
index e66728ac91..bcb0896c6e 100644
--- a/plugins/scaffolder-backend/src/service/router.ts
+++ b/plugins/scaffolder-backend/src/service/router.ts
@@ -60,22 +60,24 @@ export async function createRouter(
   const logger = parentLogger.child({ plugin: 'scaffolder' });
   const jobProcessor = new JobProcessor();
 
-  const workingDirectory =
-    config.getOptionalString('backend.workingDirectory') ?? os.tmpdir();
-  try {
-    // Check if working directory exists and is writable
-    await fs.promises.access(
-      workingDirectory,
-      fs.constants.F_OK | fs.constants.W_OK,
-    );
-    logger.info(`using working directory: ${workingDirectory}`);
-  } catch (err) {
-    logger.error(
-      `working directory ${workingDirectory} ${
-        err.code === 'ENOENT' ? 'does not exist' : 'is not writable'
-      }`,
-    );
-    throw err;
+  let workingDirectory: string;
+  if (config.has('backend.workingDirectory')) {
+    workingDirectory = config.getString('backend.workingDirectory');
+    try {
+      // Check if working directory exists and is writable
+      await fs.promises.access(
+        workingDirectory,
+        fs.constants.F_OK | fs.constants.W_OK,
+      );
+      logger.info(`using working directory: ${workingDirectory}`);
+    } catch (err) {
+      logger.error(
+        `working directory ${workingDirectory} ${
+          err.code === 'ENOENT' ? 'does not exist' : 'is not writable'
+        }`,
+      );
+      throw err;
+    }
   }
 
   router

From 2e9d34fd87970bec402c8b23de452a3c20038847 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mattias=20Frinnstr=C3=B6m?=
 <mattias.frinnstrom@husqvarnagroup.com>
Date: Mon, 26 Oct 2020 17:18:32 +0100
Subject: [PATCH 6/7] Loosen up the type some more

---
 .../src/scaffolder/stages/prepare/azure.test.ts           | 8 ++++----
 .../src/scaffolder/stages/prepare/azure.ts                | 4 ++--
 .../src/scaffolder/stages/prepare/file.ts                 | 4 ++--
 .../src/scaffolder/stages/prepare/github.test.ts          | 8 ++++----
 .../src/scaffolder/stages/prepare/github.ts               | 4 ++--
 .../src/scaffolder/stages/prepare/gitlab.test.ts          | 8 ++++----
 .../src/scaffolder/stages/prepare/gitlab.ts               | 4 ++--
 .../src/scaffolder/stages/prepare/types.ts                | 2 +-
 plugins/scaffolder-backend/src/service/router.ts          | 1 -
 9 files changed, 21 insertions(+), 22 deletions(-)

diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.test.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.test.ts
index ca5c29e9ce..97f01e6b7d 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.test.ts
@@ -78,7 +78,7 @@ describe('AzurePreparer', () => {
 
   it('calls the clone command with the correct arguments for a repository', async () => {
     const preparer = new AzurePreparer(ConfigReader.fromConfigs([]));
-    await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
+    await preparer.prepare(mockEntity);
     expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
       1,
       'https://dev.azure.com/backstage-org/backstage-project/_git/template-repo',
@@ -104,7 +104,7 @@ describe('AzurePreparer', () => {
         },
       ]),
     );
-    await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
+    await preparer.prepare(mockEntity);
     expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
       1,
       'https://dev.azure.com/backstage-org/backstage-project/_git/template-repo',
@@ -122,7 +122,7 @@ describe('AzurePreparer', () => {
   it('calls the clone command with the correct arguments for a repository when no path is provided', async () => {
     const preparer = new AzurePreparer(ConfigReader.fromConfigs([]));
     delete mockEntity.spec.path;
-    await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
+    await preparer.prepare(mockEntity);
     expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
       1,
       'https://dev.azure.com/backstage-org/backstage-project/_git/template-repo',
@@ -134,7 +134,7 @@ describe('AzurePreparer', () => {
   it('return the temp directory with the path to the folder if it is specified', async () => {
     const preparer = new AzurePreparer(ConfigReader.fromConfigs([]));
     mockEntity.spec.path = './template/test/1/2/3';
-    const response = await preparer.prepare(mockEntity, {});
+    const response = await preparer.prepare(mockEntity);
 
     expect(response.split('\\').join('/')).toMatch(
       /\/template\/test\/1\/2\/3$/,
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.ts
index bd5458b329..bdcc7e07de 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.ts
@@ -34,10 +34,10 @@ export class AzurePreparer implements PreparerBase {
 
   async prepare(
     template: TemplateEntityV1alpha1,
-    opts: { workingDirectory?: string },
+    opts?: { workingDirectory?: string },
   ): Promise<string> {
     const { protocol, location } = parseLocationAnnotation(template);
-    const workingDirectory = opts.workingDirectory ?? os.tmpdir();
+    const workingDirectory = opts?.workingDirectory ?? os.tmpdir();
 
     if (!['azure/api', 'url'].includes(protocol)) {
       throw new InputError(
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.ts
index b97e4ae08b..683d0c8cfb 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.ts
@@ -24,10 +24,10 @@ import { PreparerBase } from './types';
 export class FilePreparer implements PreparerBase {
   async prepare(
     template: TemplateEntityV1alpha1,
-    opts: { workingDirectory?: string },
+    opts?: { workingDirectory?: string },
   ): Promise<string> {
     const { protocol, location } = parseLocationAnnotation(template);
-    const workingDirectory = opts.workingDirectory ?? os.tmpdir();
+    const workingDirectory = opts?.workingDirectory ?? os.tmpdir();
 
     if (protocol !== 'file') {
       throw new InputError(
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.test.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.test.ts
index d652d8aa35..f251a39d28 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.test.ts
@@ -76,7 +76,7 @@ describe('GitHubPreparer', () => {
   });
   it('calls the clone command with the correct arguments for a repository', async () => {
     const preparer = new GithubPreparer();
-    await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
+    await preparer.prepare(mockEntity);
     expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
       1,
       'https://github.com/benjdlambert/backstage-graphql-template',
@@ -89,7 +89,7 @@ describe('GitHubPreparer', () => {
   it('calls the clone command with the correct arguments for a repository when no path is provided', async () => {
     const preparer = new GithubPreparer();
     delete mockEntity.spec.path;
-    await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
+    await preparer.prepare(mockEntity);
     expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
       1,
       'https://github.com/benjdlambert/backstage-graphql-template',
@@ -103,7 +103,7 @@ describe('GitHubPreparer', () => {
   it('return the temp directory with the path to the folder if it is specified', async () => {
     const preparer = new GithubPreparer();
     mockEntity.spec.path = './template/test/1/2/3';
-    const response = await preparer.prepare(mockEntity, {});
+    const response = await preparer.prepare(mockEntity);
 
     expect(response.split('\\').join('/')).toMatch(
       /\/template\/test\/1\/2\/3$/,
@@ -124,7 +124,7 @@ describe('GitHubPreparer', () => {
 
   it('calls the clone command with the token when provided', async () => {
     const preparer = new GithubPreparer({ token: 'abc' });
-    await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
+    await preparer.prepare(mockEntity);
     expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
       1,
       'https://github.com/benjdlambert/backstage-graphql-template',
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.ts
index 1987c416b3..04b0bbcce1 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.ts
@@ -32,10 +32,10 @@ export class GithubPreparer implements PreparerBase {
 
   async prepare(
     template: TemplateEntityV1alpha1,
-    opts: { workingDirectory?: string },
+    opts?: { workingDirectory?: string },
   ): Promise<string> {
     const { protocol, location } = parseLocationAnnotation(template);
-    const workingDirectory = opts.workingDirectory ?? os.tmpdir();
+    const workingDirectory = opts?.workingDirectory ?? os.tmpdir();
     const { token } = this;
 
     if (!['github', 'url'].includes(protocol)) {
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.test.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.test.ts
index 3ee9dd103d..a229c4f394 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.test.ts
@@ -79,7 +79,7 @@ describe('GitLabPreparer', () => {
     it(`calls the clone command with the correct arguments for a repository using the ${protocol} protocol`, async () => {
       const preparer = new GitlabPreparer(ConfigReader.fromConfigs([]));
       mockEntity = mockEntityWithProtocol(protocol);
-      await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
+      await preparer.prepare(mockEntity);
       expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
         1,
         'https://gitlab.com/benjdlambert/backstage-graphql-template',
@@ -106,7 +106,7 @@ describe('GitLabPreparer', () => {
         ]),
       );
       mockEntity = mockEntityWithProtocol(protocol);
-      await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
+      await preparer.prepare(mockEntity);
       expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
         1,
         'https://gitlab.com/benjdlambert/backstage-graphql-template',
@@ -125,7 +125,7 @@ describe('GitLabPreparer', () => {
       const preparer = new GitlabPreparer(ConfigReader.fromConfigs([]));
       mockEntity = mockEntityWithProtocol(protocol);
       delete mockEntity.spec.path;
-      await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
+      await preparer.prepare(mockEntity);
       expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
         1,
         'https://gitlab.com/benjdlambert/backstage-graphql-template',
@@ -138,7 +138,7 @@ describe('GitLabPreparer', () => {
       const preparer = new GitlabPreparer(ConfigReader.fromConfigs([]));
       mockEntity = mockEntityWithProtocol(protocol);
       mockEntity.spec.path = './template/test/1/2/3';
-      const response = await preparer.prepare(mockEntity, {});
+      const response = await preparer.prepare(mockEntity);
 
       expect(response.split('\\').join('/')).toMatch(
         /\/template\/test\/1\/2\/3$/,
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.ts
index 55fc846bb5..4553137c26 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.ts
@@ -35,10 +35,10 @@ export class GitlabPreparer implements PreparerBase {
 
   async prepare(
     template: TemplateEntityV1alpha1,
-    opts: { workingDirectory?: string },
+    opts?: { workingDirectory?: string },
   ): Promise<string> {
     const { protocol, location } = parseLocationAnnotation(template);
-    const workingDirectory = opts.workingDirectory ?? os.tmpdir();
+    const workingDirectory = opts?.workingDirectory ?? os.tmpdir();
 
     if (!['gitlab', 'gitlab/api', 'url'].includes(protocol)) {
       throw new InputError(
diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/types.ts b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/types.ts
index 1a28b316c6..c17edc24a4 100644
--- a/plugins/scaffolder-backend/src/scaffolder/stages/prepare/types.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/stages/prepare/types.ts
@@ -25,7 +25,7 @@ export type PreparerBase = {
    */
   prepare(
     template: TemplateEntityV1alpha1,
-    opts: { logger: Logger; workingDirectory?: string },
+    opts?: { logger: Logger; workingDirectory?: string },
   ): Promise<string>;
 };
 
diff --git a/plugins/scaffolder-backend/src/service/router.ts b/plugins/scaffolder-backend/src/service/router.ts
index bcb0896c6e..fb40489622 100644
--- a/plugins/scaffolder-backend/src/service/router.ts
+++ b/plugins/scaffolder-backend/src/service/router.ts
@@ -16,7 +16,6 @@
 
 import { TemplateEntityV1alpha1 } from '@backstage/catalog-model';
 import { Config, JsonValue } from '@backstage/config';
-import os from 'os';
 import fs from 'fs-extra';
 import Docker from 'dockerode';
 import express from 'express';

From 5e4551e3a103b8975c0598bde747a9c32ddb7706 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mattias=20Frinnstr=C3=B6m?=
 <mattias.frinnstrom@husqvarnagroup.com>
Date: Tue, 27 Oct 2020 11:58:22 +0100
Subject: [PATCH 7/7] Add changeset

---
 .changeset/spicy-rockets-ring.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 .changeset/spicy-rockets-ring.md

diff --git a/.changeset/spicy-rockets-ring.md b/.changeset/spicy-rockets-ring.md
new file mode 100644
index 0000000000..b39b433c1b
--- /dev/null
+++ b/.changeset/spicy-rockets-ring.md
@@ -0,0 +1,10 @@
+---
+'@backstage/plugin-scaffolder-backend': patch
+---
+
+Added support for configuring the working directory of the Scaffolder:
+
+```yaml
+backend:
+  workingDirectory: /some-dir # Use this to configure a working directory for the scaffolder, defaults to the OS temp-dir
+```