fix: fcli aviator ssc audit: Reject --skip-if-exceeding-quota with --… #1019
There are no files selected for viewing
This file contains hidden or 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,45 @@ | ||
| /* | ||
| * Copyright 2021-2026 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.aviator.ssc.cli.cmd; | ||
|
|
||
| import org.junit.jupiter.api.Assertions; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import com.fortify.cli.app._main.cli.cmd.FCLIRootCommands; | ||
|
|
||
| import picocli.CommandLine; | ||
|
|
||
| public class AviatorSSCAuditCommandTest { | ||
| @Test | ||
| void parsesFolderPriorityOrderWithoutSkipIfExceedingQuota() { | ||
| Assertions.assertDoesNotThrow(() -> new CommandLine(FCLIRootCommands.class).parseArgs( | ||
| "aviator", "ssc", "audit", | ||
| "--av", "BULK_AUDIT:1.6", | ||
| "--app", "qoflow2", | ||
| "--folder-priority-order", "High,Medium")); | ||
| } | ||
|
|
||
| @Test | ||
| void rejectsSkipIfExceedingQuotaWithFolderPriorityOrder() { | ||
| var exception = Assertions.assertThrows(CommandLine.MutuallyExclusiveArgsException.class, | ||
| () -> new CommandLine(FCLIRootCommands.class).parseArgs( | ||
| "aviator", "ssc", "audit", | ||
| "--av", "BULK_AUDIT:1.6", | ||
| "--app", "qoflow2", | ||
| "--skip-if-exceeding-quota", | ||
| "--folder-priority-order", "High")); | ||
| Assertions.assertAll( | ||
| () -> Assertions.assertTrue(exception.getMessage().contains("--skip-if-exceeding-quota")), | ||
| () -> Assertions.assertTrue(exception.getMessage().contains("--folder-priority-order"))); | ||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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,266 @@ | ||
| /* | ||
| * Copyright 2021-2026 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.aviator.ssc.helper; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertNotNull; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.OutputStream; | ||
| import java.net.InetSocketAddress; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.fasterxml.jackson.databind.node.ArrayNode; | ||
| import com.fasterxml.jackson.databind.node.ObjectNode; | ||
| import com.fortify.cli.aviator.ssc.helper.AviatorSSCTagDefs.TagDefinition; | ||
| import com.fortify.cli.common.json.JsonHelper; | ||
| import com.fortify.cli.common.rest.unirest.UnirestHelper; | ||
| import com.fortify.cli.common.rest.unirest.config.UnirestJsonHeaderConfigurer; | ||
| import com.sun.net.httpserver.HttpExchange; | ||
| import com.sun.net.httpserver.HttpServer; | ||
|
|
||
| import kong.unirest.UnirestInstance; | ||
|
|
||
| class AviatorSSCCustomTagHelperTest { | ||
| @Test | ||
| void testSynchronizeUsesExistingCustomTag() throws Exception { | ||
| try (var server = new TestSscServer()) { | ||
| String tagId = "1001"; | ||
| server.withCustomTags(tagSummary(tagId, AviatorSSCTagDefs.AVIATOR_STATUS_TAG)); | ||
| server.withCustomTagDetails(tagId, tagDetails(tagId, AviatorSSCTagDefs.AVIATOR_STATUS_TAG)); | ||
|
|
||
| try (var unirest = newUnirest(server)) { | ||
| var result = new AviatorSSCPrepareHelper.PrepareResult(); | ||
| JsonNode syncResult = new AviatorSSCCustomTagHelper(unirest, AviatorSSCTagDefs.AVIATOR_STATUS_TAG) | ||
| .synchronize(result); | ||
|
|
||
| assertNotNull(syncResult); | ||
| assertEquals(tagId, syncResult.get("id").asText()); | ||
| assertEquals(1, syncResult.withArray("valueList").size()); | ||
| assertEquals(1, server.getCustomTagsGetCount()); | ||
| assertEquals(1, server.getCustomTagDetailsGetCount()); | ||
| assertEquals(0, server.getCustomTagCreateCount()); | ||
| assertEquals(0, server.getCustomTagUpdateCount()); | ||
| assertEquals("VERIFIED", result.toJsonNode().get(0).get("status").asText()); | ||
| assertEquals("'Aviator status' is already configured correctly.", | ||
| result.toJsonNode().get(0).get("details").asText()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void testSynchronizeUpdatesExistingCustomTagWhenValuesAreMissing() throws Exception { | ||
| try (var server = new TestSscServer()) { | ||
| String tagId = "1002"; | ||
| TagDefinition tagDefinition = AviatorSSCTagDefs.AVIATOR_PREDICTION_TAG; | ||
| String existingValue = tagDefinition.getValues().get(0); | ||
| server.withCustomTags(tagSummary(tagId, tagDefinition)); | ||
| server.withCustomTagDetails(tagId, tagDetails(tagId, tagDefinition, existingValue)); | ||
|
|
||
| try (var unirest = newUnirest(server)) { | ||
| var result = new AviatorSSCPrepareHelper.PrepareResult(); | ||
| JsonNode syncResult = new AviatorSSCCustomTagHelper(unirest, tagDefinition) | ||
| .synchronize(result); | ||
|
|
||
| assertNotNull(syncResult); | ||
| assertEquals(tagId, syncResult.get("id").asText()); | ||
| assertEquals(tagDefinition.getValues().size(), syncResult.withArray("valueList").size()); | ||
| assertTrue(hasLookupValue(syncResult.get("valueList"), "AVIATOR:Unsure")); | ||
| assertEquals(1, server.getCustomTagsGetCount()); | ||
| assertEquals(1, server.getCustomTagDetailsGetCount()); | ||
| assertEquals(0, server.getCustomTagCreateCount()); | ||
| assertEquals(1, server.getCustomTagUpdateCount()); | ||
| assertNotNull(server.getLastUpdatedTag()); | ||
| assertEquals(tagDefinition.getValues().size(), server.getLastUpdatedTag().withArray("valueList").size()); | ||
| assertEquals("UPDATED", result.toJsonNode().get(0).get("status").asText()); | ||
| assertEquals( | ||
| "Added 5 missing values to tag 'Aviator prediction'.", | ||
| result.toJsonNode().get(0).get("details").asText()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void testSynchronizeCreatesTagWhenAbsentFromBothEndpoints() throws Exception { | ||
| try (var server = new TestSscServer()) { | ||
| server.withCreateResponse(createdTag("2002", AviatorSSCTagDefs.AVIATOR_STATUS_TAG)); | ||
|
|
||
| try (var unirest = newUnirest(server)) { | ||
| var result = new AviatorSSCPrepareHelper.PrepareResult(); | ||
| JsonNode syncResult = new AviatorSSCCustomTagHelper(unirest, AviatorSSCTagDefs.AVIATOR_STATUS_TAG) | ||
| .synchronize(result); | ||
|
|
||
| assertNotNull(syncResult); | ||
| assertEquals("2002", syncResult.get("id").asText()); | ||
| assertEquals(1, server.getCustomTagsGetCount()); | ||
| assertEquals(0, server.getCustomTagDetailsGetCount()); | ||
| assertEquals(1, server.getCustomTagCreateCount()); | ||
| assertEquals(0, server.getCustomTagUpdateCount()); | ||
| assertEquals("CREATED", result.toJsonNode().get(0).get("status").asText()); | ||
| assertEquals("Tag 'Aviator status' created successfully.", | ||
| result.toJsonNode().get(0).get("details").asText()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private UnirestInstance newUnirest(TestSscServer server) { | ||
| return UnirestHelper.createUnirestInstance(unirest -> { | ||
| UnirestJsonHeaderConfigurer.configure(unirest); | ||
| unirest.config().defaultBaseUrl(server.getBaseUrl()); | ||
| }); | ||
| } | ||
|
|
||
| private static ObjectNode tagSummary(String id, TagDefinition tagDefinition) { | ||
| return JsonHelper.getObjectMapper().createObjectNode() | ||
| .put("id", id) | ||
| .put("guid", tagDefinition.getGuid()) | ||
| .put("name", tagDefinition.getName()); | ||
| } | ||
|
|
||
| private static ObjectNode tagDetails(String id, TagDefinition tagDefinition) { | ||
| return tagDetails(id, tagDefinition, tagDefinition.getValues().toArray(String[]::new)); | ||
| } | ||
|
|
||
| private static ObjectNode tagDetails(String id, TagDefinition tagDefinition, String... values) { | ||
| ObjectNode result = tagSummary(id, tagDefinition) | ||
| .put("valueType", "LIST") | ||
| .put("customTagType", "CUSTOM"); | ||
| ArrayNode valueList = result.putArray("valueList"); | ||
| for (String value : values) { | ||
| valueList.add(JsonHelper.getObjectMapper().createObjectNode().put("lookupValue", value)); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| private static ObjectNode createdTag(String id, TagDefinition tagDefinition) { | ||
| return tagSummary(id, tagDefinition) | ||
| .put("valueType", "LIST") | ||
| .put("customTagType", "CUSTOM"); | ||
| } | ||
|
|
||
| private static boolean hasLookupValue(JsonNode valueList, String lookupValue) { | ||
| for (JsonNode value : valueList) { | ||
| if (lookupValue.equals(value.path("lookupValue").asText())) { | ||
| return true; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| private static final class TestSscServer implements AutoCloseable { | ||
| private final HttpServer server; | ||
| private final ArrayNode customTags = JsonHelper.getObjectMapper().createArrayNode(); | ||
| private final Map<String, JsonNode> customTagDetailsById = new HashMap<>(); | ||
| private JsonNode createResponse = JsonHelper.getObjectMapper().createObjectNode(); | ||
| private int customTagsGetCount; | ||
| private int customTagDetailsGetCount; | ||
| private int customTagCreateCount; | ||
| private int customTagUpdateCount; | ||
| private JsonNode lastUpdatedTag; | ||
|
|
||
| private TestSscServer() throws IOException { | ||
| this.server = HttpServer.create(new InetSocketAddress(0), 0); | ||
| server.createContext("/api/v1/customTags", this::handleCustomTags); | ||
| server.createContext("/api/v1/customTags/", this::handleCustomTagById); | ||
| server.start(); | ||
| } | ||
|
|
||
| private String getBaseUrl() { | ||
| return "http://localhost:" + server.getAddress().getPort(); | ||
| } | ||
|
|
||
| private TestSscServer withCustomTags(JsonNode... tags) { | ||
| customTags.removeAll(); | ||
| for (JsonNode tag : tags) { | ||
| customTags.add(tag); | ||
| } | ||
| return this; | ||
| } | ||
|
|
||
| private TestSscServer withCustomTagDetails(String tagId, JsonNode tagDetails) { | ||
| customTagDetailsById.put(tagId, tagDetails); | ||
| return this; | ||
| } | ||
|
|
||
| private TestSscServer withCreateResponse(JsonNode tag) { | ||
| this.createResponse = tag; | ||
| return this; | ||
| } | ||
|
|
||
| private int getCustomTagsGetCount() { return customTagsGetCount; } | ||
| private int getCustomTagDetailsGetCount() { return customTagDetailsGetCount; } | ||
| private int getCustomTagCreateCount() { return customTagCreateCount; } | ||
| private int getCustomTagUpdateCount() { return customTagUpdateCount; } | ||
| private JsonNode getLastUpdatedTag() { return lastUpdatedTag; } | ||
|
|
||
| private void handleCustomTags(HttpExchange exchange) throws IOException { | ||
| if ("GET".equals(exchange.getRequestMethod())) { | ||
| customTagsGetCount++; | ||
| writeJson(exchange, customTags); | ||
| } else if ("POST".equals(exchange.getRequestMethod())) { | ||
| customTagCreateCount++; | ||
| writeJson(exchange, createResponse); | ||
| } else { | ||
| exchange.sendResponseHeaders(405, -1); | ||
| exchange.close(); | ||
| } | ||
| } | ||
|
|
||
| private void handleCustomTagById(HttpExchange exchange) throws IOException { | ||
| String prefix = "/api/v1/customTags/"; | ||
| String tagId = exchange.getRequestURI().getPath().substring(prefix.length()); | ||
| if ("GET".equals(exchange.getRequestMethod())) { | ||
| customTagDetailsGetCount++; | ||
| JsonNode tagDetails = customTagDetailsById.get(tagId); | ||
| if (tagDetails == null) { | ||
| exchange.sendResponseHeaders(404, -1); | ||
| exchange.close(); | ||
| return; | ||
| } | ||
| writeJson(exchange, tagDetails); | ||
| } else if ("PUT".equals(exchange.getRequestMethod())) { | ||
| customTagUpdateCount++; | ||
| lastUpdatedTag = JsonHelper.getObjectMapper().readTree(exchange.getRequestBody()); | ||
| customTagDetailsById.put(tagId, lastUpdatedTag); | ||
| writeJson(exchange, lastUpdatedTag); | ||
| } else { | ||
| exchange.sendResponseHeaders(405, -1); | ||
| exchange.close(); | ||
| } | ||
| } | ||
|
|
||
| private void writeJson(HttpExchange exchange, JsonNode data) throws IOException { | ||
| ObjectNode wrapper = JsonHelper.getObjectMapper().createObjectNode(); | ||
| wrapper.set("data", data); | ||
| byte[] response = JsonHelper.getObjectMapper() | ||
| .writeValueAsString(wrapper) | ||
| .getBytes(StandardCharsets.UTF_8); | ||
| exchange.getResponseHeaders().add("Content-Type", "application/json"); | ||
| exchange.sendResponseHeaders(200, response.length); | ||
| try (OutputStream outputStream = exchange.getResponseBody()) { | ||
| outputStream.write(response); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void close() { | ||
| server.stop(0); | ||
| } | ||
| } | ||
| } |
This file contains hidden or 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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
fcli-appmodule currently only contains unit tests for asserting generic fcli characteristics, no module/command-specific tests. I think it would make more sense to move this test scenario to fcli-functional-test, using existing functional test infrastructure to expect an error when running this fcli command with invalid combination of options. Potentially, this would also allow you to test the same scenario on the bulkaudit.yaml action.