Clean up logs

src/azuredevopsboard/AzureDevOpsBoardService.ts

@@ -9,7 +9,7 @@ export class AzureDevOpsBoardService {
   public static async getStateOfAzureDevOpsBoards(cydigConfig: CyDigConfig): Promise<void> {
     if (cydigConfig.azureDevOps.boards) {
       try {
-        console.log('\n Running Azure DevOps Boards control');
+        console.log('--- Azure DevOps Boards control ---');
 
         const azureDevOpsConnection: AzureDevOpsConnection = new AzureDevOpsConnection(
           cydigConfig.azureDevOps.boards.organizationName,
@@ -47,6 +47,7 @@ export class AzureDevOpsBoardService {
         core.warning('Error getting tickets for Azure DevOps Board!');
         console.log('Error:', error.message);
       }
+      console.log();
     }
   }
 }

src/branchprotection/BranchProtectionService.ts

@@ -5,7 +5,7 @@ import { GitHub } from '@actions/github/lib/utils';
 export class BranchProtectionService {
   public static async getStateOfBranchProtection(): Promise<void> {
     try {
-      console.log('\n Running branch protection control');
+      console.log('--- Branch protection control ---');
       const { owner, repo }: { owner: string; repo: string } = github.context.repo;
       const token: string = core.getInput('PAT-token');
 
@@ -43,5 +43,6 @@ export class BranchProtectionService {
         core.warning(error.message);
       }
     }
+    console.log();
   }
 }

src/codequalitytools/CodeQualityService.ts

@@ -2,17 +2,18 @@ import * as core from '@actions/core';
 
 export class CodeQualityService {
   public static async getStateOfCodeQualityTool(codeQualityTool: { nameOfTool: string }): Promise<void> {
-    console.log('\n Running Code Quality control');
+    console.log('--- Code Quality control ---');
     if (process.env.codeQualityTool) {
-      console.log(`Code Quality Tool: ${process.env.codeQualityTool}`);
+      console.log(`Tool:`, `${process.env.codeQualityTool}`);
       core.exportVariable('codeQualityTool', process.env.codeQualityTool);
     } else {
       if (!codeQualityTool.nameOfTool || codeQualityTool.nameOfTool === 'name-of-tool') {
         core.warning('Code Quality Tool is not set!');
         return;
       }
-      console.log(`Code Quality Tool: ${codeQualityTool.nameOfTool}`);
+      console.log(`Tool:`, `${codeQualityTool.nameOfTool}`);
       core.exportVariable('codeQualityTool', codeQualityTool.nameOfTool);
     }
+    console.log();
   }
 }

src/index.ts

@@ -15,7 +15,7 @@ import { SecretScanningService } from './secretscanning/SecretScanningService';
  */
 export async function run(): Promise<void> {
   try {
-    console.log('\n Running controls on your repository');
+    console.log('Running compliance controls \n');
     const cydigConfig: CyDigConfig = getContentOfFile(core.getInput('cydigConfigPath'));
 
     await CodeQualityService.getStateOfCodeQualityTool(cydigConfig.codeQualityTool);

src/pentest/PentestService.ts

@@ -2,6 +2,7 @@ import * as core from '@actions/core';
 
 export class PentestService {
   public static async getStateOfPentest(pentest: { date: string; boardsTag?: string }): Promise<void> {
+    console.log('--- Pentest control ---');
     if (process.env.pentestDate) {
       core.exportVariable('pentestDate', process.env.pentestDate);
     } else {
@@ -11,5 +12,6 @@ export class PentestService {
       }
       core.exportVariable('pentestDate', pentest.date);
     }
+    console.log();
   }
 }

src/sasttools/CodeQLService.ts

@@ -54,10 +54,10 @@ export class CodeQLService {
         }
       }
 
-      console.log('SASTNumberOfSeveritylow: ' + sastNumberOfSeverity1);
-      console.log('SASTNumberOfSeverityMedium: ' + sastNumberOfSeverity2);
-      console.log('SASTNumberOfSeverityHigh: ' + sastNumberOfSeverity3);
-      console.log('SASTNumberOfSeverityCritical: ' + sastNumberOfSeverity4);
+      console.log('Low: ' + sastNumberOfSeverity1);
+      console.log('Medium: ' + sastNumberOfSeverity2);
+      console.log('High: ' + sastNumberOfSeverity3);
+      console.log('Critical: ' + sastNumberOfSeverity4);
 
       core.exportVariable('SASTnumberOfSeverity1', sastNumberOfSeverity1);
       core.exportVariable('SASTnumberOfSeverity2', sastNumberOfSeverity2);

src/sasttools/SastService.ts

@@ -3,12 +3,12 @@ import { CodeQLService } from './CodeQLService';
 
 export class SastService {
   public static async getStateOfSastTool(sastTool: { nameOfTool: string }): Promise<void> {
-    console.log('\n Running SAST control');
+    console.log('--- SAST control ---');
     let sast: string = sastTool.nameOfTool;
     if (process.env.sastTool) {
       sast = process.env.sastTool;
     }
-    console.log(`SAST Tool: ${sast}`);
+    console.log(`Tool:`, `${sast}`);
     core.exportVariable('sastTool', sast);
 
     if (!sast || sast === '' || sast === 'name-of-tool') {
@@ -19,5 +19,6 @@ export class SastService {
     if (sast.toLowerCase() === 'codeql') {
       await CodeQLService.setCodeQLFindings();
     }
+    console.log();
   }
 }

src/scatools/DependabotService.ts

@@ -51,10 +51,10 @@ export class DependabotService {
         }
       }
 
-      console.log('SCAnumberOfSeverityLow: ' + scaNumberOfSeverity1);
-      console.log('SCAnumberOfSeverityMedium: ' + scaNumberOfSeverity2);
-      console.log('SCAnumberOfSeverityHigh: ' + scaNumberOfSeverity3);
-      console.log('SCAnumberOfSeverityCritical: ' + scaNumberOfSeverity4);
+      console.log('Low: ' + scaNumberOfSeverity1);
+      console.log('Medium: ' + scaNumberOfSeverity2);
+      console.log('High: ' + scaNumberOfSeverity3);
+      console.log('Critical: ' + scaNumberOfSeverity4);
 
       core.exportVariable('SCAnumberOfSeverity1', scaNumberOfSeverity1);
       core.exportVariable('SCAnumberOfSeverity2', scaNumberOfSeverity2);

src/scatools/ScaService.ts

@@ -3,12 +3,12 @@ import { DependabotService } from './DependabotService';
 
 export class ScaService {
   public static async getStateOfScaTool(scaTool: { nameOfTool: string }): Promise<void> {
-    console.log('\n Running SCA control');
+    console.log('--- SCA control ---');
     let sca: string = scaTool.nameOfTool;
     if (process.env.scaTool) {
       sca = process.env.scaTool;
     }
-    console.log(`SCA Tool: ${sca}`);
+    console.log(`Tool:`, `${sca}`);
     core.exportVariable('scaTool', sca);
 
     if (!sca || sca === '' || sca === 'name-of-tool') {
@@ -19,5 +19,6 @@ export class ScaService {
     if (sca.toLowerCase() === 'dependabot') {
       await DependabotService.setDependabotFindings();
     }
+    console.log();
   }
 }

src/secretscanning/SecretScanningService.ts

@@ -6,7 +6,7 @@ import { GetResponseDataTypeFromEndpointMethod, OctokitResponse } from '@octokit
 export class SecretScanningService {
   public static async getStateOfExposedSecrets(): Promise<void> {
     try {
-      console.log('\n Running exposed secrets control');
+      console.log('--- Exposed secrets control ---');
       const { owner, repo }: { owner: string; repo: string } = github.context.repo;
       const token: string = core.getInput('PAT-token');
 
@@ -33,13 +33,14 @@ export class SecretScanningService {
         numberOfExposedSecrets += alerts.length;
       }
 
-      console.log('Number of exposed secrets:', numberOfExposedSecrets);
+      console.log('Exposed secrets:', numberOfExposedSecrets);
       core.exportVariable('numberOfExposedSecrets', numberOfExposedSecrets);
     } catch (error) {
       core.warning('Failed to get number of exposed secrets');
       core.warning('Error status:', error.status);
       core.warning(error.message);
       core.exportVariable('numberOfExposedSecrets', 0);
     }
+    console.log();
   }
 }

src/threatmodeling/ThreatModelingService.ts

@@ -1,6 +1,7 @@
 import * as core from '@actions/core';
 export class ThreatModelingService {
   public static async getStateOfThreatModeling(threatModeling: { date: string; boardsTag?: string }): Promise<void> {
+    console.log('--- Threat modeling control ---');
     if (process.env.threatModelingDate) {
       core.exportVariable('threatModelingDate', process.env.threatModelingDate);
     } else {
@@ -10,5 +11,6 @@ export class ThreatModelingService {
       }
       core.exportVariable('threatModelingDate', threatModeling.date);
     }
+    console.log();
   }
 }