Streamline code styles (#384)

* feat: streamline code styles

* feat: spacing for comments and return statements

* chore: enforce camelcase

* fix: remove npm lock file

* fix: add integrity test

* fix: remove logfile

* chore: update node in test workflow

src/model/cloud-runner/cloud-runner.test.ts

@@ -16,7 +16,7 @@ describe('Cloud Runner', () => {
   const testSecretValue = 'testSecretValue';
   if (Input.cloudRunnerTests) {
     it('All build parameters sent to cloud runner as env vars', async () => {
-      // build parameters
+      // Build parameters
       Cli.options = {
         versioning: 'None',
         projectPath: 'test-project',
@@ -32,13 +32,16 @@ describe('Cloud Runner', () => {
         `,
       };
       Input.githubInputEnabled = false;
-      // setup parameters
+
+      // Setup parameters
       const buildParameter = await BuildParameters.create();
       Input.githubInputEnabled = true;
       const baseImage = new ImageTag(buildParameter);
-      // run the job
+
+      // Run the job
       const file = await CloudRunner.run(buildParameter, baseImage.toString());
-      // assert results
+
+      // Assert results
       expect(file).toContain(JSON.stringify(buildParameter));
       expect(file).toContain(`${Input.ToEnvVarFormat(testSecretName)}=${testSecretValue}`);
       const environmentVariables = TaskParameterSerializer.readBuildEnvironmentVariables();
@@ -89,7 +92,7 @@ describe('Cloud Runner', () => {
     }, 1000000);
   }
   it('Local cloud runner returns commands', async () => {
-    // build parameters
+    // Build parameters
     Cli.options = {
       versioning: 'None',
       projectPath: 'test-project',
@@ -106,16 +109,18 @@ describe('Cloud Runner', () => {
       `,
     };
     Input.githubInputEnabled = false;
-    // setup parameters
+
+    // Setup parameters
     const buildParameter = await BuildParameters.create();
     const baseImage = new ImageTag(buildParameter);
-    // run the job
+
+    // Run the job
     await expect(CloudRunner.run(buildParameter, baseImage.toString())).resolves.not.toThrow();
     Input.githubInputEnabled = true;
     delete Cli.options;
   }, 1000000);
   it('Test cloud runner returns commands', async () => {
-    // build parameters
+    // Build parameters
     Cli.options = {
       versioning: 'None',
       projectPath: 'test-project',
@@ -124,10 +129,12 @@ describe('Cloud Runner', () => {
       targetPlatform: 'StandaloneLinux64',
     };
     Input.githubInputEnabled = false;
-    // setup parameters
+
+    // Setup parameters
     const buildParameter = await BuildParameters.create();
     const baseImage = new ImageTag(buildParameter);
-    // run the job
+
+    // Run the job
     await expect(CloudRunner.run(buildParameter, baseImage.toString())).resolves.not.toThrow();
     Input.githubInputEnabled = true;
     delete Cli.options;

src/model/cloud-runner/cloud-runner.ts

@@ -80,6 +80,7 @@ class CloudRunner {
       );
       CloudRunnerLogger.log(`Cleanup complete`);
       if (!CloudRunner.buildParameters.isCliMode) core.endGroup();
+
       return output;
     } catch (error) {
       if (!CloudRunner.buildParameters.isCliMode) core.endGroup();

src/model/cloud-runner/providers/aws/aws-cloud-formation-templates.ts

@@ -29,6 +29,7 @@ export class AWSCloudFormationTemplates {
   public static insertAtTemplate(template, insertionKey, insertion) {
     const index = template.search(insertionKey) + insertionKey.length + '\n'.length;
     template = [template.slice(0, index), insertion, template.slice(index)].join('');
+
     return template;
   }
 

src/model/cloud-runner/providers/aws/aws-job-stack.ts

@@ -112,14 +112,7 @@ export class AWSJobStack {
       CloudRunnerLogger.log('Creating cloud runner job');
       await CF.waitFor('stackCreateComplete', { StackName: taskDefStackName }).promise();
     } catch (error) {
-      await AWSError.handleStackCreationFailure(
-        error,
-        CF,
-        taskDefStackName,
-        //taskDefCloudFormation,
-        //parameters,
-        //secrets,
-      );
+      await AWSError.handleStackCreationFailure(error, CF, taskDefStackName);
       throw error;
     }
 

src/model/cloud-runner/providers/aws/aws-task-runner.ts

@@ -64,6 +64,7 @@ class AWSTaskRunner {
     const wasSuccessful = exitCode === 0 || (exitCode === undefined && taskData.lastStatus === 'RUNNING');
     if (wasSuccessful) {
       CloudRunnerLogger.log(`Cloud runner job has finished successfully`);
+
       return output;
     } else {
       if (taskData.stoppedReason === 'Essential container in task exited' && exitCode === 1) {
@@ -135,6 +136,7 @@ class AWSTaskRunner {
         output,
       ));
     }
+
     return output;
   }
 
@@ -152,6 +154,7 @@ class AWSTaskRunner {
       .promise();
     iterator = records.NextShardIterator || '';
     ({ shouldReadLogs, output } = AWSTaskRunner.logRecords(records, iterator, taskDef, shouldReadLogs, output));
+
     return { iterator, shouldReadLogs, output };
   }
 
@@ -170,6 +173,7 @@ class AWSTaskRunner {
       }
       CloudRunnerLogger.log(`## Status of job: ${taskData.lastStatus}`);
     }
+
     return { timestamp, shouldReadLogs };
   }
 
@@ -208,6 +212,7 @@ class AWSTaskRunner {
         }
       }
     }
+
     return { shouldReadLogs, output };
   }
 

src/model/cloud-runner/providers/aws/index.ts

@@ -79,6 +79,7 @@ class AWSBuildEnvironment implements ProviderInterface {
       if (postRunTaskTimeMs !== undefined)
         CloudRunnerLogger.log(`Cleanup job time: ${Math.floor((postCleanupTimeMs - postRunTaskTimeMs) / 1000)}s`);
     }
+
     return output;
   }
 

src/model/cloud-runner/providers/k8s/index.ts

@@ -77,7 +77,7 @@ class Kubernetes implements ProviderInterface {
     secrets: CloudRunnerSecret[],
   ): Promise<string> {
     try {
-      // setup
+      // Setup
       this.buildGuid = buildGuid;
       this.secretName = `build-credentials-${buildGuid}`;
       this.jobName = `unity-builder-job-${buildGuid}`;
@@ -98,7 +98,7 @@ class Kubernetes implements ProviderInterface {
         k8s,
       );
 
-      //run
+      // Run
       const jobResult = await this.kubeClientBatch.createNamespacedJob(this.namespace, jobSpec);
       CloudRunnerLogger.log(`Creating build job ${JSON.stringify(jobResult.body.metadata, undefined, 4)}`);
 
@@ -131,6 +131,7 @@ class Kubernetes implements ProviderInterface {
         }
       }
       await this.cleanupTaskResources();
+
       return output;
     } catch (error) {
       CloudRunnerLogger.log('Running job failed');
@@ -163,6 +164,7 @@ class Kubernetes implements ProviderInterface {
         async () => {
           const jobBody = (await this.kubeClientBatch.readNamespacedJob(this.jobName, this.namespace)).body;
           const podBody = (await this.kubeClient.readNamespacedPod(this.podName, this.namespace)).body;
+
           return (jobBody === null || jobBody.status?.active === 0) && podBody === null;
         },
         {
@@ -195,6 +197,7 @@ class Kubernetes implements ProviderInterface {
     if (pod === undefined) {
       throw new Error("pod with job-name label doesn't exist");
     }
+
     return pod;
   }
 }

src/model/cloud-runner/providers/k8s/kubernetes-job-spec-factory.ts

@@ -117,6 +117,7 @@ class KubernetesJobSpecFactory {
                   const environmentVariable = new V1EnvVar();
                   environmentVariable.name = x.name;
                   environmentVariable.value = x.value;
+
                   return environmentVariable;
                 }),
                 ...secrets.map((x) => {
@@ -127,6 +128,7 @@ class KubernetesJobSpecFactory {
                   const environmentVariable = new V1EnvVar();
                   environmentVariable.name = x.EnvironmentVariable;
                   environmentVariable.valueFrom = secret;
+
                   return environmentVariable;
                 }),
               ],
@@ -155,6 +157,7 @@ class KubernetesJobSpecFactory {
         },
       },
     };
+
     return job;
   }
 }

src/model/cloud-runner/providers/k8s/kubernetes-secret.ts

@@ -21,6 +21,7 @@ class KubernetesSecret {
     for (const buildSecret of secrets) {
       secret.data[buildSecret.ParameterKey] = base64.encode(buildSecret.ParameterValue);
     }
+
     return kubeClient.createNamespacedSecret(namespace, secret);
   }
 }

src/model/cloud-runner/providers/k8s/kubernetes-service-account.ts

@@ -10,6 +10,7 @@ class KubernetesServiceAccount {
       name: serviceAccountName,
     };
     serviceAccount.automountServiceAccountToken = false;
+
     return kubeClient.createNamespacedServiceAccount(namespace, serviceAccount);
   }
 }

src/model/cloud-runner/providers/k8s/kubernetes-storage.ts

@@ -4,6 +4,7 @@ import * as k8s from '@kubernetes/client-node';
 import BuildParameters from '../../../build-parameters';
 import CloudRunnerLogger from '../../services/cloud-runner-logger';
 import YAML from 'yaml';
+import { IncomingMessage } from 'http';
 
 class KubernetesStorage {
   public static async createPersistentVolumeClaim(
@@ -15,6 +16,7 @@ class KubernetesStorage {
     if (buildParameters.kubeVolume) {
       CloudRunnerLogger.log(buildParameters.kubeVolume);
       pvcName = buildParameters.kubeVolume;
+
       return;
     }
     const pvcList = (await kubeClient.listNamespacedPersistentVolumeClaim(namespace)).body.items.map(
@@ -27,6 +29,7 @@ class KubernetesStorage {
       if (!buildParameters.isCliMode) {
         core.setOutput('volume', pvcName);
       }
+
       return;
     }
     CloudRunnerLogger.log(`Creating PVC ${pvcName} (does not exist)`);
@@ -96,11 +99,12 @@ class KubernetesStorage {
       YAML.parse(process.env.K8s_STORAGE_PVC_SPEC);
     }
     const result = await kubeClient.createNamespacedPersistentVolumeClaim(namespace, pvc);
+
     return result;
   }
 
   private static async handleResult(
-    result: { response: import('http').IncomingMessage; body: k8s.V1PersistentVolumeClaim },
+    result: { response: IncomingMessage; body: k8s.V1PersistentVolumeClaim },
     kubeClient: k8s.CoreV1Api,
     namespace: string,
     pvcName: string,

src/model/cloud-runner/providers/k8s/kubernetes-task-runner.ts

@@ -73,6 +73,7 @@ class KubernetesTaskRunner {
       throw error;
     }
     CloudRunnerLogger.log('end of log stream');
+
     return output;
   }
 
@@ -90,6 +91,7 @@ class KubernetesTaskRunner {
           }`,
         );
         if (success || phase !== 'Pending') return true;
+
         return false;
       },
       {
@@ -97,6 +99,7 @@ class KubernetesTaskRunner {
         intervalBetweenAttempts: 15000,
       },
     );
+
     return success;
   }
 }

src/model/cloud-runner/providers/local-docker/index.ts

@@ -42,6 +42,7 @@ class LocalDockerCloudRunner implements ProviderInterface {
   ): Promise<string> {
     CloudRunnerLogger.log(buildGuid);
     CloudRunnerLogger.log(commands);
+
     return CloudRunnerSystem.Run(commands, false, false);
   }
 }

src/model/cloud-runner/providers/local/index.ts

@@ -42,6 +42,7 @@ class LocalCloudRunner implements ProviderInterface {
     CloudRunnerLogger.log(image);
     CloudRunnerLogger.log(buildGuid);
     CloudRunnerLogger.log(commands);
+
     return await CloudRunnerSystem.Run(commands);
   }
 }

src/model/cloud-runner/providers/test/index.ts

@@ -41,6 +41,7 @@ class TestCloudRunner implements ProviderInterface {
     CloudRunnerLogger.log(image);
     CloudRunnerLogger.log(buildGuid);
     CloudRunnerLogger.log(commands);
+
     return await new Promise((result) => {
       result(commands);
     });

src/model/cloud-runner/remote-client/caching.test.ts

@@ -26,19 +26,19 @@ describe('Cloud Runner Caching', () => {
       const buildParameter = await BuildParameters.create();
       CloudRunner.buildParameters = buildParameter;
 
-      // create test folder
+      // Create test folder
       const testFolder = path.resolve(__dirname, Cli.options.cacheKey);
       fs.mkdirSync(testFolder);
 
-      // crate cache folder
+      // Create cache folder
       const cacheFolder = path.resolve(__dirname, `cache-${Cli.options.cacheKey}`);
       fs.mkdirSync(cacheFolder);
 
-      // add test has file to test folders
+      // Add test file to test folders
       fs.writeFileSync(path.resolve(testFolder, 'test.txt'), Cli.options.cacheKey);
       await Caching.PushToCache(cacheFolder, testFolder, `${Cli.options.cacheKey}`);
 
-      // delete test folder
+      // Delete test folder
       fs.rmdirSync(testFolder, { recursive: true });
       await Caching.PullFromCache(
         cacheFolder.replace(/\\/g, `/`),
@@ -49,7 +49,7 @@ describe('Cloud Runner Caching', () => {
       await CloudRunnerSystem.Run(`tree ${testFolder}`);
       await CloudRunnerSystem.Run(`tree ${cacheFolder}`);
 
-      // compare validity to original hash
+      // Compare validity to original hash
       expect(fs.readFileSync(path.resolve(testFolder, 'test.txt'), { encoding: 'utf8' }).toString()).toContain(
         Cli.options.cacheKey,
       );

src/model/cloud-runner/remote-client/caching.ts

@@ -65,6 +65,7 @@ export class Caching {
           [path.resolve(sourceFolder, '..'), cacheFolder, cacheArtifactName],
           1,
         );
+
         return format.replace(/{(\d+)}/g, function (match, number) {
           return typeof arguments_[number] != 'undefined' ? arguments_[number] : match;
         });
@@ -116,6 +117,7 @@ export class Caching {
           [path.resolve(destinationFolder, '..'), cacheFolder, cacheArtifactName],
           1,
         );
+
         return format.replace(/{(\d+)}/g, function (match, number) {
           return typeof arguments_[number] != 'undefined' ? arguments_[number] : match;
         });

src/model/cloud-runner/services/cloud-runner-build-command-process.ts

@@ -30,6 +30,7 @@ export class CloudRunnerBuildCommandProcessor {
         throw error;
       }
     }
+
     return output.filter((x) => x.step !== undefined && x.hook !== undefined && x.hook.length > 0);
   }
 }

src/model/cloud-runner/services/cloud-runner-folders.ts

@@ -4,7 +4,7 @@ import { CloudRunner } from '../..';
 export class CloudRunnerFolders {
   public static readonly repositoryFolder = 'repo';
 
-  // only the following paths that do not start a path.join with another "Full" suffixed property need to start with an absolute /
+  // Only the following paths that do not start a path.join with another "Full" suffixed property need to start with an absolute /
 
   public static get uniqueCloudRunnerJobFolderAbsolute(): string {
     return path.join(`/`, CloudRunnerFolders.buildVolumeFolder, CloudRunner.buildParameters.buildGuid);

src/model/cloud-runner/services/cloud-runner-guid.ts

@@ -4,6 +4,7 @@ import CloudRunnerConstants from './cloud-runner-constants';
 class CloudRunnerNamespace {
   static generateGuid(runNumber: string | number, platform: string) {
     const nanoid = customAlphabet(CloudRunnerConstants.alphabet, 4);
+
     return `${runNumber}-${platform.toLowerCase().replace('standalone', '')}-${nanoid()}`;
   }
 }

src/model/cloud-runner/services/cloud-runner-query-override.ts

@@ -5,6 +5,7 @@ const formatFunction = (value, arguments_) => {
   for (const element of arguments_) {
     value = value.replace(`{${element.key}}`, element.value);
   }
+
   return value;
 };
 
@@ -22,6 +23,7 @@ class CloudRunnerQueryOverride {
     ) {
       return CloudRunnerQueryOverride.queryOverrides[alternativeKey];
     }
+
     return;
   }
 
@@ -31,6 +33,7 @@ class CloudRunnerQueryOverride {
         const doesInclude =
           Input.readInputFromOverrideList().split(',').includes(query) ||
           Input.readInputFromOverrideList().split(',').includes(Input.ToEnvVarFormat(query));
+
         return doesInclude ? true : false;
       } else {
         return true;

src/model/cloud-runner/services/cloud-runner-system.ts

@@ -8,6 +8,7 @@ export class CloudRunnerSystem {
         RemoteClientLogger.log(element);
       }
     }
+
     return await new Promise<string>((promise, throwError) => {
       let output = '';
       const child = exec(command, (error, stdout, stderr) => {

src/model/cloud-runner/services/depdency-override-service.ts

@@ -10,6 +10,7 @@ class DependencyOverrideService {
         return false;
       }
     }
+
     return true;
   }
   public static async TryStartDependencies() {

src/model/cloud-runner/services/lfs-hashing.ts

@@ -22,6 +22,7 @@ export class LfsHashing {
           .replace('  .lfs-assets-guid', '')
           .replace(/\n/g, ``),
       };
+
       return lfsHashes;
     } catch (error) {
       throw error;
@@ -34,6 +35,7 @@ export class LfsHashing {
       .replace(/\n/g, '')
       .split(` `)[0];
     process.chdir(startPath);
+
     return result;
   }
 

src/model/cloud-runner/services/task-parameter-serializer.ts

@@ -40,8 +40,10 @@ export class TaskParameterSerializer {
     array = array.map((x) => {
       x.name = Input.ToEnvVarFormat(x.name);
       x.value = `${x.value}`;
+
       return x;
     });
+
     return array;
   }
 
@@ -54,6 +56,7 @@ export class TaskParameterSerializer {
       });
     }
     array.push({ name: 'buildParameters', value: JSON.stringify(CloudRunner.buildParameters) });
+
     return array;
   }
 
@@ -67,6 +70,7 @@ export class TaskParameterSerializer {
         });
       }
     }
+
     return array;
   }
 
@@ -86,6 +90,7 @@ export class TaskParameterSerializer {
           };
         }),
     );
+
     return array;
   }
   private static getValue(key) {
@@ -104,6 +109,7 @@ export class TaskParameterSerializer {
         ParameterValue: value,
       });
     }
+
     return array;
   }
 }

src/model/cloud-runner/workflows/build-automation-workflow.ts

@@ -69,6 +69,7 @@ export class BuildAutomationWorkflow implements WorkflowInterface {
       (x) => x.step.includes(`build`),
     );
     const builderPath = path.join(CloudRunnerFolders.builderPathAbsolute, 'dist', `index.js`).replace(/\\/g, `/`);
+
     return `apt-get update > /dev/null
       apt-get install -y zip tree npm git-lfs jq unzip git > /dev/null
       npm install -g n > /dev/null
@@ -98,6 +99,7 @@ export class BuildAutomationWorkflow implements WorkflowInterface {
     const linuxCacheFolder = CloudRunnerFolders.cacheFolderFull.replace(/\\/g, `/`);
     const distFolder = path.join(CloudRunnerFolders.builderPathAbsolute, 'dist');
     const ubuntuPlatformsFolder = path.join(CloudRunnerFolders.builderPathAbsolute, 'dist', 'platforms', 'ubuntu');
+
     return `echo "game ci cloud runner init"
     mkdir -p ${`${CloudRunnerFolders.projectBuildFolderAbsolute}/build`.replace(/\\/g, `/`)}
     cd ${CloudRunnerFolders.projectPathAbsolute}

src/model/cloud-runner/workflows/custom-workflow.ts

@@ -25,6 +25,7 @@ export class CustomWorkflow {
             EnvironmentVariable: Input.ToEnvVarFormat(x.name),
             ParameterValue: x.value,
           };
+
           return secret;
         });
         output += await CloudRunner.Provider.runTask(
@@ -37,6 +38,7 @@ export class CustomWorkflow {
           [...CloudRunner.defaultSecrets, ...stepSecrets],
         );
       }
+
       return output;
     } catch (error) {
       throw error;

src/model/cloud-runner/workflows/workflow-composition-root.ts

@@ -18,6 +18,7 @@ export class WorkflowCompositionRoot implements WorkflowInterface {
       if (CloudRunner.buildParameters.customJob !== '') {
         return await CustomWorkflow.runCustomJob(CloudRunner.buildParameters.customJob);
       }
+
       return await new BuildAutomationWorkflow().run(
         new CloudRunnerStepState(baseImage, CloudRunner.cloudRunnerEnvironmentVariables, CloudRunner.defaultSecrets),
       );