Scaffolder workspace serialization

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>

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

@@ -19,6 +19,8 @@ import { ConfigReader } from '@backstage/config';
 import { DatabaseTaskStore } from './DatabaseTaskStore';
 import { TaskSpec } from '@backstage/plugin-scaffolder-common';
 import { ConflictError } from '@backstage/errors';
+import { createMockDirectory } from '@backstage/backend-test-utils';
+import fs from 'fs-extra';
 
 const createStore = async () => {
   const manager = DatabaseManager.fromConfig(
@@ -37,6 +39,18 @@ const createStore = async () => {
   return { store, manager };
 };
 
+const workspaceDir = createMockDirectory({
+  content: {
+    'app-config.yaml': `
+            app:
+              title: Example App
+              sessionKey:
+                $file: secrets/session-key.txt
+              escaped: \$\${Escaped}
+          `,
+  },
+});
+
 describe('DatabaseTaskStore', () => {
   it('should create the database store and run migration', async () => {
     const { store, manager } = await createStore();
@@ -259,4 +273,22 @@ describe('DatabaseTaskStore', () => {
       },
     });
   });
+
+  it('serialize and restore the workspace', async () => {
+    const { store } = await createStore();
+    const { taskId } = await store.createTask({
+      spec: {} as TaskSpec,
+      createdBy: 'me',
+    });
+
+    await store.serializeWorkspace({ path: workspaceDir.path, taskId });
+    expect(fs.existsSync(`${workspaceDir.path}/app-config.yaml`)).toBeTruthy();
+
+    fs.removeSync(workspaceDir.path);
+    expect(fs.existsSync(`${workspaceDir.path}/app-config.yaml`)).toBeFalsy();
+
+    fs.mkdirSync(workspaceDir.path);
+    await store.rehydrateWorkspace({ targetPath: workspaceDir.path, taskId });
+    expect(fs.existsSync(`${workspaceDir.path}/app-config.yaml`)).toBeTruthy();
+  });
 });

plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts

@@ -511,7 +511,7 @@ export class DatabaseTaskStore implements TaskStore {
     });
   }
 
-  async rehydrateWorkspace?(options: {
+  async rehydrateWorkspace(options: {
     taskId: string;
     targetPath: string;
   }): Promise<void> {