Add lint rules (#202)

* Fixed duplicate build:agent in build command

* Added additional lint spacing rules

* Fixed common, agent, and controller code for the new lint rules

* Added spacing and no-shadow lint rules to the guide results viewer

* Fixed lint issues in the guide

- Fixed no-shadow issues to match the version from the controller

.eslintrc

@@ -61,6 +61,8 @@
     "space-before-function-paren": 1,
     "spaced-comment": ["error", "always", { "block": { "balanced": true } }],
     "space-infix-ops":"warn",
+    "space-before-blocks": "warn",
+    "keyword-spacing": "warn",
     "strict": 1,
     "comma-dangle": 1,
     "triple-equals": 0,

agent/acceptance/tests.spec.ts

@@ -27,7 +27,7 @@ describe("Tests Integration", () => {
         done(new Error("Should have returned a 404"));
       }).catch((error: unknown) => {
         log(integrationUrl + "/tests/ error", LogLevel.DEBUG, error, { status: (error as AxiosError)?.response?.status });
-        if ((error as AxiosError)?.response?.status === 404){
+        if ((error as AxiosError)?.response?.status === 404) {
           done();
         } else {
           done(error);

agent/createtest/pewpewtest.spec.ts

@@ -227,7 +227,7 @@ describe("PewPewTest Create Test", () => {
         await test!.launch();
           // Should have thrown
           done(new Error("test.launch() should have failed with pewpew exited with kill"));
-        } catch(error) {
+        } catch (error) {
           // Kill should throw
           log("'Retrieve Test and launch, then kill should succeed' result", LogLevel.DEBUG, error);
           try {

agent/src/healthcheck.ts

@@ -65,7 +65,7 @@ export async function pingS3 (): Promise<boolean> {
     config.lastS3Access = new Date();
     log("Pinging S3 succeeded at " + new Date(), LogLevel.DEBUG);
     return true;
-  } catch(error) {
+  } catch (error) {
     log("pingS3 failed}", LogLevel.ERROR, error);
     // DO NOT REJECT. Just return false
     return false;

agent/src/pewpewtest.ts

@@ -305,7 +305,7 @@ export class PewPewTest {
   protected async writeTestStatus () {
     try {
       await this.ppaasTestStatus.writeStatus();
-    } catch(error) {
+    } catch (error) {
       this.log("Could not write ppaasTestStatus", LogLevel.ERROR, error, { ppaasTestStatus: this.ppaasTestStatus });
     }
   }
@@ -316,7 +316,7 @@ export class PewPewTest {
       const { testId } = this.testMessage;
       const messageId = await new PpaasCommunicationsMessage({ testId, messageType, messageData }).send();
       this.log(`Sent testStatus ${messageType}: " ${messageId}`, LogLevel.DEBUG, { messageData, messageId });
-    } catch(error) {
+    } catch (error) {
       this.log("Could not send TestStatus", LogLevel.ERROR, error, { messageData });
     }
   }
@@ -325,7 +325,7 @@ export class PewPewTest {
     try {
       const messageId = await refreshTestScalingMessage();
       this.log(`Sent refreshTestScalingMessage: " ${messageId}`, LogLevel.DEBUG, {  messageId });
-    } catch(error) {
+    } catch (error) {
       this.log("Error calling refreshTestScalingMessage", LogLevel.ERROR, error);
     }
   }
@@ -334,7 +334,7 @@ export class PewPewTest {
     try {
       const messageId = await deleteTestScalingMessage();
       this.log(`deleteTestScalingMessage: " ${messageId}`, LogLevel.DEBUG, {  messageId });
-    } catch(error) {
+    } catch (error) {
       this.log("Error calling deleteTestScalingMessage", LogLevel.ERROR, error);
     }
   }
@@ -594,7 +594,7 @@ export class PewPewTest {
       this.log(errorMessage, LogLevel.ERROR, error);
       try {
         await this.internalStop();
-      } catch(err) {
+      } catch (err) {
         this.log("Could not stop the pewpew process", LogLevel.ERROR, err);
       }
       // Send failed communications message and update teststatus
@@ -758,7 +758,7 @@ export class PewPewTest {
           await this.sendTestStatus();
           // Keep alive every loop
           await this.refreshTestScalingMessage();
-        } catch(error) {
+        } catch (error) {
           this.log(`Polling PewPew Results Error. iteration: ${iteration}`, LogLevel.ERROR, error);
         }
         if (Date.now() < endLoop) {
@@ -915,7 +915,7 @@ export class PewPewTest {
             this.writeTestStatus(),
             this.internalStop()
           ]);
-        } catch(err) {
+        } catch (err) {
           this.log("Could not stop the pewpew process", LogLevel.ERROR, err);
         }
         // Keep trying to check and kill the pewpew process?
@@ -928,7 +928,7 @@ export class PewPewTest {
             if (this.pewpewRunning) {
               await sleep(10000);
             }
-          } catch(err) {
+          } catch (err) {
             this.log("Could not stop the pewpew process", LogLevel.ERROR, err);
           }
         }

common/integration/s3.spec.ts

@@ -243,7 +243,7 @@ describe("S3Util Integration", () => {
           const objects = await listObjects(s3FileKey!);
           return (objects && objects.Contents && objects.Contents.length > 0);
         }, MAX_POLL_WAIT, (errMsg: string) => `${errMsg} Could not find the ${s3FileKey} in s3`);
-      } catch(error) {
+      } catch (error) {
         log(`beforeEach error uploadFile(${UNIT_TEST_FILEPATH}, ${UNIT_TEST_KEY_PREFIX})`, LogLevel.ERROR, error);
         throw error;
       }
@@ -416,7 +416,7 @@ describe("S3Util Integration", () => {
 
     afterEach (async () => {
       // Delete the local file
-      if(localFile) {
+      if (localFile) {
         await fs.unlink(localFile)
         .catch((error) => log("Could not delete " + localFile, LogLevel.WARN, error));
       }

common/integration/s3file.spec.ts

@@ -166,7 +166,7 @@ describe("PpaasS3File Integration", () => {
         testPpaasS3FileUpload.setLastModifiedLocal(0);
         testPpaasS3FileUpload.remoteUrl = "";
         // As long as we don't throw, it passes
-      } catch(error) {
+      } catch (error) {
         throw error;
       }
     });
@@ -238,7 +238,7 @@ describe("PpaasS3File Integration", () => {
         log("testPpaasS3FileUpload.upload() succeeded", LogLevel.DEBUG);
         s3FileKey = testPpaasS3FileUpload.key;
         // As long as we don't throw, it passes
-      } catch(error) {
+      } catch (error) {
         throw error;
       }
     });
@@ -361,7 +361,7 @@ describe("PpaasS3File Integration", () => {
 
     afterEach (async () => {
       // Delete the local file
-      if(localFile) {
+      if (localFile) {
         await fs.unlink(localFile)
         .catch((error) => log("Could not delete " + localFile, LogLevel.WARN, error));
       }

common/src/ppaascommessage.ts

@@ -85,7 +85,7 @@ export class PpaasCommunicationsMessage implements CommunicationsMessage {
         continue;
       } else if (value.DataType === "String") { // "Number" also is stored as StringValue
         log(`messageAttributes[${key}].StringValue = ${value.StringValue}`, LogLevel.DEBUG);
-        switch(key) {
+        switch (key) {
           // If this is set, it isn't a real message and should be swallowed. It was from an integration test
           case "UnitTestMessage":
             unittestMessage = true;

common/src/ppaastestmessage.ts

@@ -151,7 +151,7 @@ export class PpaasTestMessage implements TestMessage {
         continue;
       } else if (value.DataType === "String") {
         log(`messageAttributes[${key}].StringValue = ${value.StringValue}`, LogLevel.DEBUG);
-        switch(key) {
+        switch (key) {
           // If this is set, it isn't a real message and should be swallowed. It was from an integration test
           case "UnitTestMessage":
             unittestMessage = true;

common/test/ppaasteststatus.spec.ts

@@ -76,7 +76,7 @@ describe("PpaasTestStatus", () => {
     // should have all the TestStatus + lastModifiedRemote && testId && url
     expect(Object.keys(actualTestMessage).length, `Actual Keys: ${Object.keys(actualTestMessage).toString()}\nExpected Keys: ${Object.keys(testStatus).toString()}\nMessage keys length`).to.equal(Object.keys(testStatus).length + 3);
     for (const key in actualTestMessage) {
-      switch(key) {
+      switch (key) {
         case "lastModifiedRemote":
           expect(JSON.stringify(actualTestMessage.lastModifiedRemote), key).to.equal(JSON.stringify(new Date(0)));
           break;

common/test/s3.spec.ts

@@ -374,7 +374,7 @@ describe("S3Util", () => {
 
     afterEach (async () => {
       // Delete the local file
-      if(localFile) {
+      if (localFile) {
         await fs.unlink(localFile)
         .catch((error) => log("Could not delete " + localFile, LogLevel.WARN, error));
       }

common/test/s3file.spec.ts

@@ -496,7 +496,7 @@ describe("PpaasS3File", () => {
         testPpaasS3FileUpload.setLastModifiedLocal(0);
         testPpaasS3FileUpload.remoteUrl = "";
         // As long as we don't throw, it passes
-      } catch(error) {
+      } catch (error) {
         throw error;
       }
     });
@@ -564,7 +564,7 @@ describe("PpaasS3File", () => {
 
     afterEach (async () => {
       // Delete the local file
-      if(localFile) {
+      if (localFile) {
         await fs.unlink(localFile)
         .catch((error) => log("Could not delete " + localFile, LogLevel.WARN, error));
       }

controller/components/Calendar/index.tsx

@@ -48,7 +48,7 @@ export const PPaaSCalendar = ({ ...calendarProps}: CalendarProps) => {
   // It has to be client rendered so we get the local browser time zone
   if (Array.isArray(calendarProps.events)) {
     for (const event of calendarProps.events) {
-      if(typeof event.startRecur === "number") {
+      if (typeof event.startRecur === "number") {
         event.startTime = getHourMinuteFromTimestamp(event.startRecur);
         event.endTime = typeof event.testRunTimeMn === "number"
           ? getHourMinuteFromTimestamp(event.startRecur + (60000 * event.testRunTimeMn))

controller/components/StartTestForm/index.tsx

@@ -247,7 +247,7 @@ export const StartTestForm = ({
                 ({ ...prevState, environmentVariables: [...environmentVariables, ...newEnvironmentVariables] })
               );
             }
-          } catch(error) {
+          } catch (error) {
             log(`Could not parse file: ${file.name}`, LogLevel.ERROR, error);
             setState({ error: `Could not parse file: ${file.name} - ${formatError(error)}` });
           }

controller/components/TestResults/charts.ts

@@ -331,7 +331,7 @@ const afterBuildTicks = (chart: any) => {
   let lastLegendClick: [number, number, Chart] | undefined;
 
   Chart.defaults.plugins.legend.onClick = function (
-    e: ChartEvent,
+    _e: ChartEvent,
     legendItem: LegendItem,
     legend: LegendElement<keyof ChartTypeRegistry>
   ) {

controller/integration/ppaasencryptenvfile.spec.ts

@@ -168,7 +168,7 @@ describe("PpaasEncryptEnvironmentFile Integration", () => {
         log("testPpaasEncryptEnvironmentFileUpload.upload() succeeded", LogLevel.DEBUG);
         s3FileKey = testPpaasEncryptEnvironmentFileUpload.key;
         // As long as we don't throw, it passes
-      } catch(error) {
+      } catch (error) {
         throw error;
       }
     });

controller/integration/ppaasencrypts3file.spec.ts

@@ -128,7 +128,7 @@ describe("PpaasEncryptS3File Integration", () => {
         log("testPpaasEncryptS3FileUpload.upload() succeeded", LogLevel.DEBUG);
         s3FileKey = testPpaasEncryptS3FileUpload.key;
         // As long as we don't throw, it passes
-      } catch(error) {
+      } catch (error) {
         throw error;
       }
     });

controller/integration/testmanager.spec.ts

@@ -1812,7 +1812,7 @@ describe("TestManager Integration", () => {
           expect(Array.isArray(tests.recentTests)).to.equal(true);
           // Requested should have at least one now
           expect(tests.runningTests.length + tests.recentTests.length, "tests.runningTests.length + tests.recentTests.length").to.be.greaterThan(0);
-        } catch(error) {
+        } catch (error) {
           log("afterEach error", LogLevel.ERROR, error);
           throw error;
         }

controller/pages/api/auth.ts

@@ -24,7 +24,7 @@ export default async (req: NextApiRequest, res: NextApiResponse): Promise<void>
         log(`${req.method} ${req.url} response: ${JSON.stringify(authPermissions)}`, LogLevel.DEBUG);
         res.status(200).json(authPermissions);
       } else if (req.query.refreshToken && !Array.isArray(req.query.refreshToken)) {
-        try{
+        try {
           const tokenResponse: TokenResponse = await getTokenFromRefreshToken(req.query.refreshToken);
           log(`${req.method} ${req.url} returning token: ${JSON.stringify(tokenResponse)}`);
           res.status(200).json(tokenResponse);
@@ -34,7 +34,7 @@ export default async (req: NextApiRequest, res: NextApiResponse): Promise<void>
       } else {
         res.status(400).json({ message: `method ${req.method} must have a code or token queryparam` });
       }
-    } catch(error) {
+    } catch (error) {
       log(`${req.method} ${req.url} failed: ${error}`, LogLevel.ERROR, error);
       res.status(500).json(createErrorResponse(req, error, LogLevel.ERROR));
     }

controller/pages/api/error/[yamlFile]/[dateString]/index.ts

@@ -55,7 +55,7 @@ export default async (request: NextApiRequest, response: NextApiResponse<GetObje
       } else {
         response.status(400).json({ message: `method ${request.method} must have an yamlFile and dateString` });
       }
-    } catch(error) {
+    } catch (error) {
       log(`${request.method} ${request.url} failed: ${error}`, LogLevel.ERROR, error);
       response.status(500).json(createErrorResponse(request, error));
     }

controller/pages/api/json/[yamlFile]/[dateString]/[resultsFile].ts

@@ -51,7 +51,7 @@ export default async (req: NextApiRequest, res: NextApiResponse<GetObjectCommand
       } else {
         res.status(400).json({ message: `method ${req.method} must have a json file` });
       }
-    } catch(error) {
+    } catch (error) {
       log(`${req.method} ${req.url} failed: ${error}`, LogLevel.ERROR, error);
       res.status(500).json(createErrorResponse(req, error));
     }

controller/pages/api/login.ts

@@ -12,7 +12,7 @@ export default async (req: NextApiRequest, res: NextApiResponse): Promise<void>
       const authUrl: string = await getAuthUrl(req);
       log(`${req.method} ${req.url} authUrl response: ${authUrl}`, LogLevel.DEBUG);
       res.redirect(302, authUrl);
-    } catch(error) {
+    } catch (error) {
       log(`${req.method} ${req.url} failed: ${error}`, LogLevel.ERROR, error);
       res.status(500).json(createErrorResponse(req, error, LogLevel.ERROR));
     }

controller/pages/api/logout.ts

@@ -12,7 +12,7 @@ export default async (req: NextApiRequest, res: NextApiResponse): Promise<void>
       const logoutUrl: string = await getLogoutUrl(req);
       log(`${req.method} ${req.url} logoutUrl response: ${logoutUrl}`, LogLevel.DEBUG);
       res.redirect(302, logoutUrl);
-    } catch(error) {
+    } catch (error) {
       log(`${req.method} ${req.url} failed: ${error}`, LogLevel.ERROR, error);
       res.status(500).json(createErrorResponse(req, error, LogLevel.ERROR));
     }

controller/pages/api/queuenames.ts

@@ -8,7 +8,7 @@ export default (req: NextApiRequest, res: NextApiResponse): void => {
   try {
     const queueNames: string[] = PpaasTestMessage.getAvailableQueueNames();
     res.status(200).json({ queueNames });
-  } catch(error) {
+  } catch (error) {
     log(`${req.method} ${req.url} failed: ${error}`, LogLevel.ERROR, error);
     res.status(500).json(createErrorResponse(req, error));
   }

controller/pages/api/queues.ts

@@ -8,7 +8,7 @@ export default (req: NextApiRequest, res: NextApiResponse): void => {
   try {
     const queues: AgentQueueDescription = PpaasTestMessage.getAvailableQueueMap();
     res.status(200).json(queues);
-  } catch(error) {
+  } catch (error) {
     log(`${req.method} ${req.url} failed: ${error}`, LogLevel.ERROR, error);
     res.status(500).json(createErrorResponse(req, error));
   }

controller/pages/api/util/clientutil.ts

@@ -77,7 +77,7 @@ export function formatError (error: unknown): string {
     const methodText = `${axiosError.config?.method?.toUpperCase() || ""} ${axiosError.config?.url || "request"} failed`;
     if (axiosError.response) {
       let errorText: string;
-      if (typeof axiosError.response.data === "string"){
+      if (typeof axiosError.response.data === "string") {
         // It's a string
         errorText = axiosError.response.data;
       } else if (typeof (axiosError.response.data as TestManagerError)?.message === "string") {

controller/pages/api/util/healthcheck.ts

@@ -99,7 +99,7 @@ export async function pingS3 (): Promise<boolean> {
     await listObjects({ prefix: "ping", maxKeys: 1 }); // Limit 1 so we can get back fast
     log("Pinging S3 succeeded at " + new Date(), LogLevel.DEBUG);
     return true;
-  } catch(error) {
+  } catch (error) {
     log("pingS3 failed", LogLevel.ERROR, error);
     // DO NOT REJECT. Just return false
     return false;

controller/pages/api/util/testmanager.ts

@@ -462,7 +462,7 @@ export async function validateYamlfile (
         dummyEnvironmentVariables[splunkPath] = dummySplunkPath;
       }
       yamlParser = await YamlParser.parseYamlFile(yamlFile.filepath, dummyEnvironmentVariables);
-    } catch(error) {
+    } catch (error) {
       return { json: { message: `yamlFile: ${yamlFile.originalFilename || yamlFile.filepath} failed to parse`, error: formatError(error) }, status: 400 };
     }
 
@@ -1141,7 +1141,7 @@ export abstract class TestManager {
               }
             }
             log("parsed environmentVariables", LogLevel.DEBUG, Object.keys(environmentVariablesFile));
-          } catch(error) {
+          } catch (error) {
             log("Could not parse environmentVariables", LogLevel.TRACE, error, fields.environmentVariables);
             // Don't log the actual error or environmentVariables since it could include passwords
             return { json: { message: "Could not parse environmentVariables", error: formatError(error) }, status: 400 };
@@ -1541,7 +1541,7 @@ export abstract class TestManager {
           }
           try {
             await YamlParser.parseYamlFile(yamlFile.filepath, environmentVariables);
-          } catch(error) {
+          } catch (error) {
             return { json: { message: `yamlFile: ${yamlFile.originalFilename || yamlFile.filepath} failed to parse`, error: formatError(error) }, status: 400 };
           }
         }

controller/pages/api/util/util.ts

@@ -300,7 +300,7 @@ export async function parseZip (formFiles: Files): Promise<void> {
       formFiles.yamlFile = yamlFiles.length > 1 ? yamlFiles : yamlFiles[0];
     }
     // return formFiles;
-  } catch(error: any) {
+  } catch (error: any) {
     log ("Error parsing files in incoming test form files for zips: " + (error?.msg || error?.message || `${error}`), LogLevel.WARN, error);
     if (error instanceof Error && error.stack) {
       // eslint-disable-next-line no-console

controller/pages/api/yaml/[yamlFile]/[dateString]/[filename].ts

@@ -32,7 +32,7 @@ export default async (request: NextApiRequest, response: NextApiResponse<GetObje
       } else {
         response.status(400).json({ message: `method ${request.method} must have a yaml file` });
       }
-    } catch(error) {
+    } catch (error) {
       log(`${request.method} ${request.url} failed: ${error}`, LogLevel.ERROR, error);
       response.status(500).json(createErrorResponse(request, error));
     }