-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
A number of small updates for implementation/fix of various outstandi…
…ng Issues (#661) feat: `fcli fod mast setup`, `fcli fod mast get-config`: Updates for new API (fixes #642) fix: `fcli fod release update`: Add "Retired" option fo `--sdlc-status` (fixes #642) feat: `fcli fod dast setup-website`, `fcli fod dast setup-workflow`, `fcli fod dast setup-api`: Add `--vpn` option for specifying Fortify Connect network name (site-to-site VPN) to use (fixes #644) Co-authored-by: kadraman <[email protected]>
- Loading branch information
Showing
12 changed files
with
280 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
157 changes: 157 additions & 0 deletions
157
...fcli-fod/src/main/java/com/fortify/cli/fod/mast_scan/cli/cmd/FoDMastScanSetupCommand.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| /******************************************************************************* | ||
| * Copyright 2021, 2023 Open Text. | ||
| * | ||
| * The only warranties for products and services of Open Text | ||
| * and its affiliates and licensors ("Open Text") are as may | ||
| * be set forth in the express warranty statements accompanying | ||
| * such products and services. Nothing herein should be construed | ||
| * as constituting an additional warranty. Open Text shall not be | ||
| * liable for technical or editorial errors or omissions contained | ||
| * herein. The information contained herein is subject to change | ||
| * without notice. | ||
| *******************************************************************************/ | ||
|
|
||
| package com.fortify.cli.fod.mast_scan.cli.cmd; | ||
|
|
||
| import java.time.format.DateTimeFormatter; | ||
| import java.util.Objects; | ||
| import org.apache.commons.logging.Log; | ||
| import org.apache.commons.logging.LogFactory; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.fasterxml.jackson.databind.node.ObjectNode; | ||
| import com.fortify.cli.common.cli.util.CommandGroup; | ||
| import com.fortify.cli.common.output.cli.mixin.OutputHelperMixins; | ||
| import com.fortify.cli.common.output.transform.IActionCommandResultSupplier; | ||
| import com.fortify.cli.common.output.transform.IRecordTransformer; | ||
| import com.fortify.cli.common.progress.cli.mixin.ProgressWriterFactoryMixin; | ||
| import com.fortify.cli.common.util.DisableTest; | ||
| import com.fortify.cli.common.util.DisableTest.TestType; | ||
| import com.fortify.cli.fod._common.cli.mixin.FoDDelimiterMixin; | ||
| import com.fortify.cli.fod._common.output.cli.cmd.AbstractFoDJsonNodeOutputCommand; | ||
| import com.fortify.cli.fod._common.scan.cli.mixin.FoDEntitlementFrequencyTypeMixins; | ||
| import com.fortify.cli.fod._common.scan.helper.FoDScanType; | ||
| import com.fortify.cli.fod.release.cli.mixin.FoDReleaseByQualifiedNameOrIdResolverMixin; | ||
| import com.fortify.cli.fod.release.helper.FoDReleaseAssessmentTypeDescriptor; | ||
| import com.fortify.cli.fod.release.helper.FoDReleaseAssessmentTypeHelper; | ||
| import com.fortify.cli.fod.release.helper.FoDReleaseDescriptor; | ||
| import com.fortify.cli.fod.mast_scan.helper.FoDScanConfigMobileDescriptor; | ||
| import com.fortify.cli.fod.mast_scan.helper.FoDScanConfigMobileHelper; | ||
| import com.fortify.cli.fod.mast_scan.helper.FoDScanConfigMobileSetupRequest; | ||
|
|
||
| import kong.unirest.UnirestInstance; | ||
| import lombok.Getter; | ||
| import picocli.CommandLine.Command; | ||
| import picocli.CommandLine.Mixin; | ||
| import picocli.CommandLine.Option; | ||
|
|
||
| @Command(name = OutputHelperMixins.Setup.CMD_NAME, hidden = false) @CommandGroup("*-scan-setup") | ||
| @DisableTest(TestType.CMD_DEFAULT_TABLE_OPTIONS_PRESENT) | ||
| public class FoDMastScanSetupCommand extends AbstractFoDJsonNodeOutputCommand implements IRecordTransformer, IActionCommandResultSupplier { | ||
| private static final Log LOG = LogFactory.getLog(FoDMastScanStartCommand.class); | ||
| DateTimeFormatter dtf = DateTimeFormatter.ofPattern("MM/dd/yyyy HH:mm"); | ||
| @Getter @Mixin private OutputHelperMixins.Start outputHelper; | ||
|
|
||
| @Mixin | ||
| private FoDDelimiterMixin delimiterMixin; // Is automatically injected in resolver mixins | ||
| @Mixin | ||
| private FoDReleaseByQualifiedNameOrIdResolverMixin.RequiredOption releaseResolver; | ||
|
|
||
| @Option(names = {"--assessment-type"}, required = true) | ||
| private String mobileAssessmentType; // Plain text name as custom assessment types can be created | ||
| @Option(names = {"--entitlement-id"}) | ||
| private Integer entitlementId; | ||
| @Mixin private FoDEntitlementFrequencyTypeMixins.RequiredOption entitlementFrequencyTypeMixin; | ||
| private enum MobileFrameworks { iOS, Android } | ||
| @Option(names = {"--framework"}, required = true) | ||
| private MobileFrameworks mobileFramework; | ||
| @Option(names = {"--timezone"}, defaultValue = "UTC") | ||
| private String timezone; | ||
| private enum MobileAuditPreferenceTypes { Manual, None } | ||
| @Option(names = {"--audit-preference"}, defaultValue = "None") | ||
| private MobileAuditPreferenceTypes auditPreferenceType; | ||
| private enum MobilePlatforms { Phone, Tablet, Both } | ||
| @Option(names = {"--platform"}, required = true) | ||
| private MobilePlatforms mobilePlatform; | ||
| @Option(names={"--skip-if-exists"}) | ||
| private Boolean skipIfExists = false; | ||
|
|
||
| @Mixin private ProgressWriterFactoryMixin progressWriterFactory; | ||
|
|
||
| @Override | ||
| public JsonNode getJsonNode(UnirestInstance unirest) { | ||
| try (var progressWriter = progressWriterFactory.create()) { | ||
| var releaseDescriptor = releaseResolver.getReleaseDescriptor(unirest); | ||
| var setupDescriptor = FoDScanConfigMobileHelper.getSetupDescriptor(unirest, releaseDescriptor.getReleaseId()); | ||
| if ( skipIfExists && setupDescriptor.getAssessmentTypeId()!=0 ) { | ||
| return setupDescriptor.asObjectNode().put("__action__", "SKIPPED_EXISTING"); | ||
| } else { | ||
| return setup(unirest, releaseDescriptor, setupDescriptor).asObjectNode(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private FoDScanConfigMobileDescriptor setup(UnirestInstance unirest, FoDReleaseDescriptor releaseDescriptor, FoDScanConfigMobileDescriptor currentSetup) { | ||
| var relId = releaseDescriptor.getReleaseId(); | ||
|
|
||
| LOG.info("Finding appropriate entitlement to use."); | ||
|
|
||
| var atd = FoDReleaseAssessmentTypeHelper.getAssessmentTypeDescriptor(unirest, relId, FoDScanType.Mobile, | ||
| entitlementFrequencyTypeMixin.getEntitlementFrequencyType(), mobileAssessmentType); | ||
| Integer assessmentTypeId = atd.getAssessmentTypeId(); | ||
| Integer entitlementIdToUse = atd.getEntitlementId(); | ||
|
|
||
| validateEntitlement(currentSetup, entitlementIdToUse, relId, atd); | ||
| LOG.info("Release will be usig entitlement " + entitlementIdToUse); | ||
|
|
||
| FoDScanConfigMobileSetupRequest setupMastScanRequest = FoDScanConfigMobileSetupRequest.builder() | ||
| .assessmentTypeId(assessmentTypeId) | ||
| .frameworkType(mobileFramework.name()) | ||
| .platformType(mobilePlatform.name()) | ||
| .auditPreferenceType(auditPreferenceType.name()) | ||
| .timeZone(timezone).build(); | ||
|
|
||
| return FoDScanConfigMobileHelper.setupScan(unirest, releaseDescriptor, setupMastScanRequest); | ||
| } | ||
|
|
||
| private void validateEntitlement(FoDScanConfigMobileDescriptor currentSetup, Integer entitlementIdToUse, String relId, FoDReleaseAssessmentTypeDescriptor atd) { | ||
| // validate entitlement specified or currently in use against assessment type found | ||
| if (entitlementId != null && entitlementId > 0) { | ||
| // check if "entitlement id" explicitly matches what has been found | ||
| if (!Objects.equals(entitlementIdToUse, entitlementId)) { | ||
| throw new IllegalArgumentException("Cannot find appropriate assessment type for use with entitlement: " + entitlementId + "=" + entitlementIdToUse); | ||
| } | ||
| } else { | ||
| if (currentSetup.getEntitlementId() != null && currentSetup.getEntitlementId() > 0) { | ||
| // check if "entitlement id" is already configured | ||
| if (!Objects.equals(entitlementIdToUse, currentSetup.getEntitlementId())) { | ||
| LOG.warn("Changing current release entitlement from " + currentSetup.getEntitlementId()); | ||
| } | ||
| } | ||
| } | ||
| // check if the entitlement is still valid | ||
| FoDReleaseAssessmentTypeHelper.validateEntitlement(relId, atd); | ||
| } | ||
|
|
||
| @Override | ||
| public JsonNode transformRecord(JsonNode record) { | ||
| FoDReleaseDescriptor releaseDescriptor = releaseResolver.getReleaseDescriptor(getUnirestInstance()); | ||
| return ((ObjectNode)record) | ||
| .put("scanType", mobileAssessmentType) | ||
| .put("setupType", auditPreferenceType.name()) | ||
| .put("applicationName", releaseDescriptor.getApplicationName()) | ||
| .put("releaseName", releaseDescriptor.getReleaseName()) | ||
| .put("microserviceName", releaseDescriptor.getMicroserviceName()); | ||
| } | ||
|
|
||
| @Override | ||
| public String getActionCommandResult() { | ||
| return "SETUP"; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isSingular() { | ||
| return true; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
...d/src/main/java/com/fortify/cli/fod/mast_scan/helper/FoDScanConfigMobileSetupRequest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /******************************************************************************* | ||
| * Copyright 2021, 2023 Open Text. | ||
| * | ||
| * The only warranties for products and services of Open Text | ||
| * and its affiliates and licensors ("Open Text") are as may | ||
| * be set forth in the express warranty statements accompanying | ||
| * such products and services. Nothing herein should be construed | ||
| * as constituting an additional warranty. Open Text shall not be | ||
| * liable for technical or editorial errors or omissions contained | ||
| * herein. The information contained herein is subject to change | ||
| * without notice. | ||
| *******************************************************************************/ | ||
|
|
||
| package com.fortify.cli.fod.mast_scan.helper; | ||
|
|
||
| import com.formkiq.graalvm.annotations.Reflectable; | ||
|
|
||
| import lombok.AllArgsConstructor; | ||
| import lombok.Builder; | ||
| import lombok.Data; | ||
| import lombok.NoArgsConstructor; | ||
|
|
||
| @Reflectable @NoArgsConstructor @AllArgsConstructor | ||
| @Data @Builder | ||
| public class FoDScanConfigMobileSetupRequest { | ||
| private Integer assessmentTypeId; | ||
| private String auditPreferenceType; | ||
| private String frameworkType; | ||
| private String platformType; | ||
| private String timeZone; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.