Merge pull request #3338 from StefanoVuerich/master

fix: conditional getuid and getgid for Windows environment

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

@@ -17,16 +17,9 @@ import Stream, { PassThrough } from 'stream';
 import os from 'os';
 import fs from 'fs';
 import Docker from 'dockerode';
-import { runDockerContainer } from './helpers';
+import { UserOptions, runDockerContainer } from './helpers';
 
 describe('helpers', () => {
-  if (process.platform === 'win32') {
-    // eslint-disable-next-line jest/no-focused-tests
-    it.only('should skip tests on windows', () => {
-      expect('test').not.toBe('run');
-    });
-  }
-
   const mockDocker = new Docker() as jest.Mocked<Docker>;
 
   beforeEach(() => {
@@ -142,12 +135,17 @@ describe('helpers', () => {
         dockerClient: mockDocker,
       });
 
+      const userOptions: UserOptions = {};
+      if (process.getuid && process.getgid) {
+        userOptions.User = `${process.getuid()}:${process.getgid()}`;
+      }
+
       expect(mockDocker.run).toHaveBeenCalledWith(
         imageName,
         args,
         expect.any(Stream),
         expect.objectContaining({
-          User: `${process.getuid()}:${process.getgid()}`,
+          ...userOptions,
           Env: ['HOME=/tmp'],
         }),
       );

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

@@ -36,6 +36,10 @@ export type RunCommandOptions = {
   logStream?: Writable;
 };
 
+export type UserOptions = {
+  User?: string;
+};
+
 /**
  * Gets the templater key to use for templating from the entity
  * @param entity Template entity
@@ -115,6 +119,16 @@ export const runDockerContainer = async ({
     });
   });
 
+  const userOptions: UserOptions = {};
+  if (process.getuid && process.getgid) {
+    // Files that are created inside the Docker container will be owned by
+    // root on the host system on non Mac systems, because of reasons. Mainly the fact that
+    // volume sharing is done using NFS on Mac and actual mounts in Linux world.
+    // So we set the user in the container as the same user and group id as the host.
+    // On Windows we don't have process.getuid nor process.getgid
+    userOptions.User = `${process.getuid()}:${process.getgid()}`;
+  }
+
   const [{ Error: error, StatusCode: statusCode }] = await dockerClient.run(
     imageName,
     args,
@@ -129,11 +143,7 @@ export const runDockerContainer = async ({
           `${await fs.promises.realpath(templateDir)}:/template`,
         ],
       },
-      // Files that are created inside the Docker container will be owned by
-      // root on the host system on non Mac systems, because of reasons. Mainly the fact that
-      // volume sharing is done using NFS on Mac and actual mounts in Linux world.
-      // So we set the user in the container as the same user and group id as the host.
-      User: `${process.getuid()}:${process.getgid()}`,
+      ...userOptions,
       // Set the home directory inside the container as something that applications can
       // write to, otherwise they will just flop and fail trying to write to /
       Env: ['HOME=/tmp'],