CAST HIGHLIGHT - CLI - Error code 5 - Command Line result upload error – CAST

Command line is failing with the error (5) Command Line result upload error.

Action Plan

Check the user status, user role, and domain. The error code 5 - Command-Line result upload error" is usually seen with the permission issues with User ID / Password.
1. Check whether --login , --password and –-serverUrl are entered correctly.
2. Check whether the user has changed the password for the login to HL whether the user was able to login and upload results previously.
3. Check whether the account is locked.
4. Check whether user account is deactivated.
5. If token feature is enabled for the instance, use user tokens instead.
6. Check whether the user role has the permission to upload. eg, Application contributor role, Domain contributor or Portfolio Manager has the permission to upload.
7. Check whether the user is attached to the correct domain.
Check whether there is any proxy involved. If proxy is there user needs to pass the proxy parameters to the command line so that it can reach Highlight server through the proxy. An example can be found in the Command Line readme. Below is the sample command line with proxy

--------------------------------------
Special configuration for proxy server
--------------------------------------
Using a proxy server for upload.

Proxy with no password :
-Dhttps.proxyHost=<your proxy host>
-Dhttps.proxyPort=<your proxy port>

If a password is requested for proxy add the following additional parameter
-Dhttps.proxyUser=<user>
-Dhttps.proxyPassword=<password>

java -Dhttps.proxyHost=your proxy host -Dhttps.proxyPort=your proxy port -Dhttps.proxyUser=user -Dhttps.proxyPassword=password -jar HighlightAutomation.jar --workingDir "C:\highlight-myproject" --sourceDir "C:\myproject\src" --login xxx --password xxxx

1. 1. If using a proxy, and if the proxy name is similar to (http://something) check whether using the proxy name without http;// solves the issue.
  2. If the proxy is http and not https, try with -Dhttp settings to see if it still fails.
  3. Ensure that the format of the command is followed. For eg proxy name need not be given in quotes.
Confirm whether the TLS version used is supported by Highlight. Check in the logs for messages like javax.net.ssl.SSLHandshakeException: Remote host terminated the handshake Check the log, to find out the TLS version used

"ClientHello": {
"client version" : "TLSv1.2",

"supported_versions (43)": {
"versions": [TLSv1.3]
}, Configure Jenkins to use the TLS version used by Highlight or edit the command to correct the TLS version used. To find out the TLS version used by Highlight
1. 1. Open highlight URL in chrome browser and open developer tools.
  2. Go to security tab and in connection details we can determine the version of TLS that is being used.
  3. Match the TLS format in command line and check if upload works.
Check whether user is trying with a campaign name (snapshotLabel) that already exists? CLI uploads create their own campaigns. If so try without a snapshotLabel and/or a unique one.
If you are getting messages like "ERROR AnalysisPipeline: Upload failed
com.castsoftware.highlight.RTExceptionWithStatus: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target" please check out the workarounds mentioned in CAST HIGHLIGHT - SSL - "PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target"
If there are errors like - Caused by: java.lang.Exception: Failed to upload file 'Java-2023_0018.CloudReady.csv' to application result id='6369' with company [name='xxxxx='000000'] and application [name='XXXX',id=1234], which mentions the particular file and the application then try to upload the app manually thru CLI (not any pipelines) and sees if it throws the error. Please refer Highlight Automated Code Scan (Command Line)
Before using the pipeline again
1. Check the result CSV files that were generated as part of the scan. Check for empty file, error file etc.
2. Check the current campaign status on the HL portal
Check if there are any errors such as UTF-8 "\xE7" does not map to Unicode at perl/FileList.pm line XX and/or ERROR highlight: No header can be extracted to patch framework files (if all the code is not properly encoded) related to encoding which was not readable by Highlight. Please refer CAST HIGHLIGHT - Results Upload - CLI - UTF-8 "\xE7" does not map to Unicode at perl/FileList.pm line xx
In the logs if there are errors like

Uploading empty result is reject by the server. Please check if the --technologies option is not too restrictive.
Missing CSV File with Scan results

Abort : NonsignificantForRiskAnalysis: None bloc of code .

Error complains of not finding result CSVs.
1. 1. This could be because of minified files or DDL without any objects like procedures or functions that Highlight is looking for to report on. For more such possibilities please refer CAST HIGHLIGHT - Analysis Step - Analysis proceeds with limited results and CAST HIGHLIGHT - Discovery Step - Analyzer not detecting all the technologies
  2. Check if the user is trying to upload multiple zip files under a single zip file with the --uploadZipFile option . This might happen if zip files are nested underneath each other. Please check Highlight Automated Code Scan (Command Line)
  3. Check if --includeArchiveContent is used. Please check the conditions for using -includeArchiveContent in CAST HIGHLIGHT - Analyzer - Can Zip files or other archive files be used for Analysis ?
If NoAnalysis messages are seen in logs it means there are no results or there is an empty analysis upload, hence upload has failed.
1. 1. Check if the --workingDir option is included in the CLI
  2. Check if there is a Result.zip post the analysis completion. If yes, please try to upload it manually for that application.
  3. Check if the result zip file has .csv files in the root path. If not move the .csv file to the root path .zip file. Then result will get uploaded.
  4. Check the result csv's. If there is no code that has been analyzed, but there are a few dlls found in the binary library csv file, then add one 'dummy' source file to the analysis so that the binary library csv has some context.
  5. Check whether code is not accessible due to some permission issues.
  6. Check if source code contains only technologies that are not supported by Highlight. Then you may get the error ERROR AnalysisPipeline: Discover failed
    java.lang.Exception: Discovery child process failed with exit status 13. If Highlight is not able to find any source code for the technologies supported it may go directly from the discovery step to the upload step without listing any technologies as there is nothing to scan thus generating the error. Please refer CAST HIGHLIGHT - CLI - ERROR AnalysisPipeline: Discovery child process failed with exit status 13
If you see errors like this in HL Automation log 2023-06-21 13:40:31,881 INFO perl: out: Out of memory! 2023-06-21 13:40:31,881 INFO perl: out: Out of memory! then the analysis ended with "out of memory" before it reached the upload stage. Then split the scan as recommended in the Getting Started Guide.
If are having issues using the -appendResult and --skipSubmit flags please see this article: CAST HIGHLIGHT - CLI - Can --appendResult and --skipSubmit options be used together in a command?
If in the HL Automation log the error is Failed to fetch company with id='xxxxx' then follow CAST HIGHLIGHT - Results Upload - CLI - Failed to fetch company with id='XXXX'
If you are using Docker with Github Actions and getting the error [ERR5] HighlightAutomation --analyzerDir /opt/hlt/perl --sourceDir /s --workingDir /w --tokenAuth *** --companyId xxxxx --applicationId xxxxxx --serverUrl https://rpa.casthighlight.com --snapshotDatetime xxxxxxxxx --ignoreDirectories .github,examples failed with code 5

then it might be because user tokens are not correctly used. Please refer How to use Github Actions to scan your applications with CAST Highlight
Use the latest version of the CLI. As the platform evolves (new features, new API endpoints, etc.) are added. The command line also uses some of these functionalities.