Fixinator Client Version 6.1.0

Add args json, and forceLocal

Author: pfreitag

README.md

@@ -94,6 +94,18 @@ When the `compatibility` goal is passed it will return compatibility issues foun
 
 Added in Fixinator Version 5.
 
+### json
+
+Default: `false` - when true outputs json results to the console
+
+Added in Fixinator Version 6.1.0
+
+### forceLocal
+
+Default: `false` - when true requires that the enterprise version is installed locally, for a local scan.
+
+Added in Fixinator Version 6.1.0
+
 ## Environment Variables
 
 The following environment variables are used by fixinator:

box.json

@@ -1,8 +1,8 @@
 {
     "name":"fixinator",
-    "version":"6.0.0",
+    "version":"6.1.0",
     "author":"Foundeo Inc.",
-    "location":"foundeo/fixinator#v6.0.0",
+    "location":"foundeo/fixinator#v6.1.0",
     "homepage":"https://fixinator.app/",
     "documentation":"https://github.com/foundeo/fixinator/wiki",
     "repository":{

commands/fixinator.cfc

@@ -35,7 +35,9 @@ component extends="commandbox.system.BaseCommand" excludeFromHelp=false {
 		"engines",
 		"includeScanners",
 		"configFile",
-		"goals"
+		"goals",
+		"json",
+		"forceLocal"
 	];
 
 	/**
@@ -63,6 +65,8 @@ component extends="commandbox.system.BaseCommand" excludeFromHelp=false {
 	* @configFile.hint A path to a .fixinator.json file to use
 	* @goals.hint A list of goals for scanning [compatibility,security], default: security
 	* @goals.optionsUDF goalsComplete
+	* @json.hint When true outputs results to the console as JSON
+	* @forceLocal.hint When true requires that the scan run locally with enterprise version
 	**/
 	function run(
         string path=".",
@@ -84,7 +88,9 @@ component extends="commandbox.system.BaseCommand" excludeFromHelp=false {
 		string engines="",
 		string includeScanners="",
 		string configFile="",
-		string goals="security"
+		string goals="security",
+		boolean json=false,
+		boolean forceLocal=false
     )  {
 		var fileInfo = "";
 		var severityLevel = 1;
@@ -94,6 +100,9 @@ component extends="commandbox.system.BaseCommand" excludeFromHelp=false {
 		var paths = [];
 		var isEnterprise = false;
 		var arg = "";
+		if (arguments.json) {
+			arguments.verbose=false;
+		}
 		if (arguments.verbose) {
 			//arguments.listScanners = true;
 
@@ -121,6 +130,18 @@ component extends="commandbox.system.BaseCommand" excludeFromHelp=false {
 			isEnterprise = true;
 		} catch(any entErr) {
 			//not using enterprise version
+			if (!arguments.forceLocal) {
+				rethrow;
+			}
+		}
+
+		if (arguments.forceLocal) {
+			fixinatorClient.setForceLocal(true);
+			if (!isEnterprise) {
+				error("Enterprise version was not loaded and forceLocal was specified");
+				setExitCode(1);
+				return;
+			}
 		}
 
 		//validate arguments
@@ -201,7 +222,7 @@ component extends="commandbox.system.BaseCommand" excludeFromHelp=false {
 			fixinatorClient.setAPIURL(configService.getSetting("modules.fixinator.api_url", "UNDEFINED"));
 		}
 
-		if (!fixinatorClient.hasFixinatorEnterpriseInstance() && fixinatorClient.isCloudAPIURL() && configService.getSetting("modules.fixinator.accept_policy", "UNDEFINED") == "UNDEFINED") {
+		if (!fixinatorClient.hasFixinatorEnterpriseInstance() && fixinatorClient.isCloudAPIURL() && configService.getSetting("modules.fixinator.accept_policy", "UNDEFINED") == "UNDEFINED" && !arguments.json) {
 			print.line();
 			print.line("Fixinator will send source code to: " & fixinatorClient.getAPIURL());
 			print.line("for scanning. The code is kept in RAM during scanning and is not persisted.");
@@ -264,8 +285,10 @@ component extends="commandbox.system.BaseCommand" excludeFromHelp=false {
 
 		if (arguments.debug) {
 			fixinatorClient.setDebugMode(true);
-			print.greenLine("✓ DEBUG MODE ENABLED: #fixinatorClient.isDebugModeEnabled()#");
-			print.greenLine("   ↳ #expandPath("{lucee-web}/logs/fixinator-client-debug.log")#");
+			if (arguments.verbose) {
+				print.greenLine("✓ DEBUG MODE ENABLED: #fixinatorClient.isDebugModeEnabled()#");
+				print.greenLine("   ↳ #expandPath("{lucee-web}/logs/fixinator-client-debug.log")#");
+			}
 		}
 
 
@@ -278,7 +301,7 @@ component extends="commandbox.system.BaseCommand" excludeFromHelp=false {
 			try {
 				if (arguments.gitLastCommit && arguments.verbose) {
 					print.yellowLine("Scanning only files changed in the last git commit.");
-				} else {
+				} else if (arguments.verbose) {
 					print.yellowLine("Scanning only files changed since the last git commit.");
 				}
 				arguments.path = fileSystemUtil.resolvePath( arguments.path );
@@ -371,7 +394,7 @@ component extends="commandbox.system.BaseCommand" excludeFromHelp=false {
 
 		if (!listFindNoCase("warn,low,medium,high", arguments.severity)) {
 			if (arguments.severity !="default") {
-				print.redLine("Invalid minimum severity level, use: warn,low,medium,high");
+				error("Invalid minimum severity level, use: warn,low,medium,high");
 				return;
 			}
 		} else {
@@ -380,7 +403,7 @@ component extends="commandbox.system.BaseCommand" excludeFromHelp=false {
 
 		if (!listFindNoCase("none,low,medium,high", arguments.confidence)) {
 			if (arguments.confidence != "default") {
-				print.redLine("Invalid minimum confidence level, use: none,low,medium,high");
+				error("Invalid minimum confidence level, use: none,low,medium,high");
 				return;	
 			}
 
@@ -410,22 +433,22 @@ component extends="commandbox.system.BaseCommand" excludeFromHelp=false {
 		if (len(arguments.configFile)) {
 			arguments.configFile = fileSystemUtil.resolvePath( arguments.configFile );
 			if (!fileExists(arguments.configFile)) {
-				print.boldRedLine("Sorry: configFile was not found: #arguments.configFile#");
+				error("Sorry: configFile was not found: #arguments.configFile#");
 				return;	
 			} else {
 				config.configFile = arguments.configFile;
 			}
 		}
 
 		if (!fileExists(arguments.path) && !directoryExists(arguments.path) && !arrayLen(paths)) {
-			print.boldRedLine("Sorry: #arguments.path# is not a file or directory.");
+			error("Sorry: #arguments.path# is not a file or directory.");
 			return;
 		}
 
 		fileInfo = getFileInfo(arguments.path);
 
 		if (!fileInfo.canRead) {
-			print.boldRedLine("Sorry: No read permission for source path");
+			error("Sorry: No read permission for source path");
 			return;
 		}
 
@@ -534,6 +557,15 @@ component extends="commandbox.system.BaseCommand" excludeFromHelp=false {
 			}
 		}
 
+		if (arguments.json) {
+			print.line(serializeJSON(local.results));
+			if (arrayLen(local.results.results) > 0 ) {
+				if (arguments.failOnIssues) {
+					setExitCode( 1 );	
+				}
+			}
+			return;
+		}
 
 		if (arrayLen(local.results.results) == 0 && arrayLen(local.results.warnings) == 0)   {
 			print.line().boldGreenLine("0 Issues Found");

models/fixinator/FixinatorClient.cfc

@@ -28,6 +28,8 @@ component {
 
 	variables.clientUpdate = false;
 	variables.debugMode = false;
+
+	variables.forceLocal = false;
 
 	public function getClientVersion() {
 		if (!structKeyExists(variables, "clientVersion")) {
@@ -425,6 +427,8 @@ component {
 		//if enterprise version locally installed, use that
 		if (hasFixinatorEnterpriseInstance()) {
 			return sendPayloadEnterprise(payload=arguments.payload);
+		} else if (variables.forceLocal) {
+			throw(message="Enterprise instance was not detected, and forceLocal was enabled");
 		}
 
 		local.payloadID = left(createUUID(),12);
@@ -739,6 +743,14 @@ component {
 		return results;
 	}
 
+	public void function setForceLocal(boolean forceLocal) {
+		variables.forceLocal = arguments.forceLocal;
+	}
+
+	public boolean function getForceLocal() {
+		return variables.forceLocal;
+	}
+
 	public function getFixinatorCategories() {
 
 	}

models/fixinator/FixinatorReport.cfc

@@ -622,6 +622,7 @@
 					<cfset rule.helpUri = i.link>
 				</cfif>
 				<cfset arrayAppend(run.tool.driver.rules, rule)>
+				<cfset rules[rule.id] = rule>
 			</cfif>
 			<cfset result = {"ruleId":rule.id, "message":{"text":i.category & ": " & i.message}, "locations":[]}>
 			<cfset location = {"physicalLocation": {"artifactLocation":{"uri":""}}}>