From 7c0abef74b69702f4403e3013f6460789b26761a Mon Sep 17 00:00:00 2001 From: Ruud Senden <8635138+rsenden@users.noreply.github.com> Date: Tue, 13 Dec 2022 15:47:16 +0100 Subject: [PATCH] fix: `fcli ssc appversion-artifact upload`: Improve usage message for `--engine-type` option (fixes #176) --- .../cli/cmd/SSCAppVersionArtifactUploadCommand.java | 2 +- .../resources/com/fortify/cli/ssc/i18n/SSCMessages.properties | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/fcli-ssc/src/main/java/com/fortify/cli/ssc/appversion_artifact/cli/cmd/SSCAppVersionArtifactUploadCommand.java b/fcli-ssc/src/main/java/com/fortify/cli/ssc/appversion_artifact/cli/cmd/SSCAppVersionArtifactUploadCommand.java index 50fc16bb55..c39c28af1e 100644 --- a/fcli-ssc/src/main/java/com/fortify/cli/ssc/appversion_artifact/cli/cmd/SSCAppVersionArtifactUploadCommand.java +++ b/fcli-ssc/src/main/java/com/fortify/cli/ssc/appversion_artifact/cli/cmd/SSCAppVersionArtifactUploadCommand.java @@ -52,7 +52,7 @@ public class SSCAppVersionArtifactUploadCommand extends AbstractSSCAppVersionArt @Mixin private SSCAppVersionResolverMixin.RequiredOption parentResolver; @Parameters(arity="1") private String filePath; - @Option(names = {"-e", "--engine-type"}, description = "Engine type for the artifact being uploaded") + @Option(names = {"-e", "--engine-type"}) private String engineType; @Override diff --git a/fcli-ssc/src/main/resources/com/fortify/cli/ssc/i18n/SSCMessages.properties b/fcli-ssc/src/main/resources/com/fortify/cli/ssc/i18n/SSCMessages.properties index ff3e5873ce..c4b7deb4d9 100644 --- a/fcli-ssc/src/main/resources/com/fortify/cli/ssc/i18n/SSCMessages.properties +++ b/fcli-ssc/src/main/resources/com/fortify/cli/ssc/i18n/SSCMessages.properties @@ -95,6 +95,7 @@ fcli.ssc.appversion-artifact.download.id = Artifact id to download fcli.ssc.appversion-artifact.get.usage.header = Get artifact details fcli.ssc.appversion-artifact.list.usage.header = List application version artifacts fcli.ssc.appversion-artifact.upload.usage.header = Upload an artifact +fcli.ssc.appversion-artifact.upload.engine-type = Engine type specifying which SSC parser plugin should be used to process the uploaded artifact. This option should only be used for raw 3rd-party results, not for standard Fortify (FPR) results or 3rd-party results in a zip-file accompanied by a scan.info file. fcli.ssc.appversion-artifact.wait-for.usage.header = Wait for SSC artifact to reach or exit specified artifact statuses fcli.ssc.appversion-artifact.wait-for.usage.description.0 = Although this command offers a lot of options to cover many different use cases, to just wait for artifact processing to complete after running "fcli ssc appversion-artifact upload ... --store '?'", you can simply run "fcli ssc appversion-artifact wait-for '?'". fcli.ssc.appversion-artifact.wait-for.usage.description.1 = %nIf none of the --while or --until options are specified, this command will by default wait until the uploaded artifact has been processed by SSC. If any error state or unknown state is detected, an exception will be thrown.