The uploadandscan composite action enables you to upload files to Veracode for scanning.
The auto-scan option is always set to on with the uploadandscan call.
The uploadandscan call supports these parameters:
|String||Name of the Veracode application profile.|
|Boolean||Create a Veracode application profile, if one does not exist, for the specified application profile name. Set to true to create a profile. Set to false to not create a profile.|
|String||Filepath or folderpath of the files you want to upload to Veracode for scanning. By default, the integration uploads all the subdirectories and files of this filepath. Ensure you have prepared the files according to the Veracode Packaging Requirements.|
|String||Name or version of the build that you want to scan.|
|createsandbox||Boolean||For development sandbox scans, create a sandbox for the specified Veracode application. Set to true to create a sandbox. Set to false to not create a sandbox.|
|criticality||String||Optional. Required if setting the createprofile parameter. The
level of criticality of the scan:
Only available with the Java API wrapper.
Set to true to automatically delete the current scan if there are any errors when uploading files or starting the scan. If the include or exclude parameters are set, this parameter deletes the scan if there are errors when starting the scan after module selection. Defaults to false.
With the scan deleted automatically, you can create subsequent scans without having to manually delete an incomplete scan.
|exclude||String||Case-sensitive, comma-separated list of module name patterns that represent the names of modules to not scan as top-level modules. The * wildcard matches 0 or more characters. The ? wildcard matches exactly one character.|
|include||String||Case-sensitive, comma-separated list of module name patterns that represent the names of modules to scan as top-level modules. The * wildcard matches 0 or more characters. The ? wildcard matches exactly one character.|
|lifecyclestage||String||One of these lifecycle stage values:
|maxretrycount||Integer||Number of times to retry polling for the status of a failed build. Value range is 0 to 5, where 0 specifies to not retry polling.|
|pattern||String||Case-sensitive filename pattern that represents the names of uploaded files to save with a different name. The * wildcard matches 0 or more characters. The ? wildcard matches exactly one character. Each wildcard corresponds to a numbered group that you can reference in the replacement pattern.|
|replacement||String||Replacement pattern that references groups captured by the filename pattern. For example, if the filename pattern is --SNAPSHOT.war and the replacement pattern is $1-master-SNAPSHOT.war, an uploaded file named app-branch-SNAPSHOT.war is saved as app-master-SNAPSHOT.war.|
|sandboxid||Integer||ID of the sandbox in which to run the scan.|
|sandboxname||String||Name of the sandbox in which to run the scan.|
|scanallnonfataltoplevelmodules||Boolean||If this parameter is not set, the default is false. When set to true, if the application has more than one module, and at least one of the top-level modules does not have any fatal prescan errors, it starts the scan for those modules after prescan is complete.|
Only available with the Java API wrapper.
|Integer||Interval, in seconds, to poll for the status of a running scan. Value range is 30 to 120 (2 minutes). Default is 120.|
|scantimeout||Integer||Number of minutes to wait for the scan to complete and pass policy. If the scan does not complete or fails policy, the build fails. Default is 60 minutes.|
|selected||Boolean||Set to true to scan the modules currently selected in the Veracode Platform.|
|selectedpreviously||Boolean||Set to true to scan only the modules selected in the previous scan.|
|teams||String||Comma-separated list of team names associated with the specified application. Validates against the names of existing teams for this account.|
|toplevel||Boolean||When set to true, Veracode only scans the top-level modules in
Veracode recommends that you include this parameter if you want to ensure the scan completes even though there are non-fatal errors, such as unsupported frameworks.
Veracode recommends that you use an external Veracode API credentials file to provide your credentials to the Veracode API wrapper. When you use a Veracode API credentials file, you can omit the -vid and -vkey parameters for specifying your Veracode API credentials.
These example commands demonstrate using the uploadandscan action with the Java API wrapper. For the C# API wrapper, replace java -jar vosp-api-wrapper-java<version>.jar with VeracodeC#API.
java -jar vosp-api-wrapper-java<version>.jar -action uploadandscan -vid <Veracode API ID> -vkey <Veracode API key> -appname myapp -createprofile true -teams myteam -criticality VeryHigh -sandboxname mysandbox -createsandbox true -version <unique version> -filepath /workspace/myapp.jar
java -jar vosp-api-wrapper-java<version>.jar -action uploadandscan -vid <Veracode API ID> -vkey <Veracode API key> -appname myapp -createprofile true -teams myteam -criticality VeryHigh -sandboxname mysandbox -createsandbox true -version <unique version> -scantimeout 30 -selectedpreviously true -filepath /workspace/myapp.jar