getExpectations();
+
+ protected abstract String getMessageTemplate();
+
+ protected boolean skipMissingNode() {
+ return false;
+ }
+}
diff --git a/enforcer/file/common/src/main/java/com/optum/sourcehawk/enforcer/file/json/JsonValueEquals.java b/enforcer/file/common/src/main/java/com/optum/sourcehawk/enforcer/file/json/JsonValueEquals.java
index 082d6b7..939aad3 100644
--- a/enforcer/file/common/src/main/java/com/optum/sourcehawk/enforcer/file/json/JsonValueEquals.java
+++ b/enforcer/file/common/src/main/java/com/optum/sourcehawk/enforcer/file/json/JsonValueEquals.java
@@ -1,54 +1,30 @@
package com.optum.sourcehawk.enforcer.file.json;
-import com.fasterxml.jackson.core.JsonPointer;
import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
-import com.fasterxml.jackson.databind.node.ArrayNode;
-import com.fasterxml.jackson.databind.node.JsonNodeFactory;
-import com.fasterxml.jackson.databind.node.ObjectNode;
import com.optum.sourcehawk.core.utils.StringUtils;
-import com.optum.sourcehawk.enforcer.EnforcerResult;
-import com.optum.sourcehawk.enforcer.ResolverResult;
-import com.optum.sourcehawk.enforcer.file.AbstractFileEnforcer;
import com.optum.sourcehawk.enforcer.file.FileResolver;
import lombok.AllArgsConstructor;
import lombok.Builder;
-import lombok.NonNull;
-import lombok.val;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.Writer;
-import java.math.BigDecimal;
-import java.math.BigInteger;
import java.util.Collections;
import java.util.Map;
import java.util.Objects;
-import java.util.Optional;
-import java.util.stream.Collectors;
/**
* An enforcer implementation which enforces that the result of a JsonPath query equals a specific value
*
* @author Brian Wyka
+ * @author Christian Oestreich
*/
@Builder(builderClassName = "Builder")
@JsonDeserialize(builder = JsonValueEquals.Builder.class)
@AllArgsConstructor(staticName = "equals")
-public class JsonValueEquals extends AbstractFileEnforcer implements FileResolver {
-
- private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
- private static final String READ_ERROR_TEMPLATE = "Reading or parsing file resulted in error [%s]";
- private static final String QUERY_ERROR_TEMPLATE = "Execution of pointer expression [%s] yielded error [%s]";
- private static final String MISSING_MESSAGE_TEMPLATE = "Execution of pointer expression [%s] yielded no result";
- private static final String NOT_EQUAL_MESSAGE_TEMPLATE = "Execution of pointer expression [%s] yielded result [%s] which is not equal to [%s]";
- private static final String UPDATE_MESSAGE_TEMPLATE = "Pointer expression [%s] has been updated with value [%s]";
- private static final String UPDATE_MISSING_MESSAGE_TEMPLATE = "Pointer expression [%s] which was missing, has been set with value [%s]";
+public class JsonValueEquals extends AbstractJsonValue implements FileResolver {
/**
* Key: The JsonPointer expression to retrieve the value
- *
+ *
* Value: The expected value which the query should evaluate to
*/
private final Map expectations;
@@ -57,199 +33,19 @@ public class JsonValueEquals extends AbstractFileEnforcer implements FileResolve
* Create with a single path query and expected value
*
* @param jsonPointerExpression the JSON pointer expression
- * @param expectedValue the expected value
+ * @param expectedValue the expected value
* @return the enforcer
*/
public static JsonValueEquals equals(final String jsonPointerExpression, final Object expectedValue) {
return JsonValueEquals.equals(Collections.singletonMap(jsonPointerExpression, expectedValue));
}
- /** {@inheritDoc} */
@Override
- public EnforcerResult enforceInternal(@NonNull final InputStream actualFileInputStream) {
- final JsonNode jsonNode;
- try {
- jsonNode = OBJECT_MAPPER.readTree(actualFileInputStream);
- } catch (final IOException e) {
- return EnforcerResult.failed(String.format(READ_ERROR_TEMPLATE, e.getMessage()));
- }
- val messages = expectations.entrySet()
- .stream()
- .map(entry -> enforce(jsonNode, entry.getKey(), entry.getValue()))
- .filter(Optional::isPresent)
- .map(Optional::get)
- .collect(Collectors.toSet());
- return EnforcerResult.create(messages);
- }
-
- /**
- * Enforce individual json path queries with expected value
- *
- * @param jsonNode the JSON node
- * @param jsonPointerExpression the JSON pointer expression
- * @param expectedValue the expected value
- * @return The message to be added, otherwise {@link Optional#empty()}
- */
- private static Optional enforce(final JsonNode jsonNode, final String jsonPointerExpression, final Object expectedValue) {
- try {
- val actualJsonNode = jsonNode.at(JsonPointer.compile(jsonPointerExpression));
- if (actualJsonNode == null || actualJsonNode.isMissingNode()) {
- return Optional.of(String.format(MISSING_MESSAGE_TEMPLATE, jsonPointerExpression));
- }
- if (jsonNodeValueEquals(actualJsonNode, expectedValue)) {
- return Optional.empty();
- }
- return Optional.of(String.format(NOT_EQUAL_MESSAGE_TEMPLATE, jsonPointerExpression, actualJsonNode.asText(), expectedValue));
- } catch (final Exception e) {
- return Optional.of(String.format(QUERY_ERROR_TEMPLATE, jsonPointerExpression, e.getMessage()));
- }
- }
-
- /** {@inheritDoc} */
- @Override
- public ResolverResult resolve(final @NonNull InputStream actualFileInputStream, final @NonNull Writer outputFileWriter) throws IOException {
- final JsonNode rootJsonNode;
- try {
- rootJsonNode = OBJECT_MAPPER.readTree(actualFileInputStream);
- } catch (final IOException e) {
- return ResolverResult.error(String.format(READ_ERROR_TEMPLATE, e.getMessage()));
- }
- val resolverResult = expectations.entrySet().stream()
- .map(entry -> resolve(rootJsonNode, entry.getKey(), entry.getValue()))
- .reduce(ResolverResult.builder().error(true).build(), ResolverResult::reduce);
- if (resolverResult.isUpdatesApplied()) {
- outputFileWriter.write(rootJsonNode.toPrettyString());
- }
- return resolverResult;
- }
-
- /**
- * Resolve an individual json path query with the expected value
- *
- * @param rootJsonNode the root JSON node
- * @param jsonPointerExpression the JSON pointer expression
- * @param expectedValue the expected value
- * @return the resolver result
- */
- private static ResolverResult resolve(final JsonNode rootJsonNode, final String jsonPointerExpression, final Object expectedValue) {
- try {
- val jsonPointer = JsonPointer.compile(jsonPointerExpression);
- val actualJsonNode = rootJsonNode.at(jsonPointer);
- final String resolverResultMessage;
- if (actualJsonNode.isMissingNode()) {
- resolverResultMessage = String.format(UPDATE_MISSING_MESSAGE_TEMPLATE, jsonPointerExpression, expectedValue);
- } else {
- resolverResultMessage = String.format(UPDATE_MESSAGE_TEMPLATE, jsonPointerExpression, expectedValue);
- }
- if (jsonNodeValueEquals(actualJsonNode, expectedValue)) {
- return ResolverResult.NO_UPDATES;
- }
- val parentNode = rootJsonNode.at(jsonPointer.head());
- if (parentNode instanceof ObjectNode) {
- updateObjectNodeValue((ObjectNode) parentNode, jsonPointer.last().toString().substring(1), expectedValue);
- } else if (parentNode instanceof ArrayNode) {
- updateArrayNodeValue((ArrayNode) parentNode, Integer.parseInt(jsonPointer.last().toString().substring(1)), expectedValue, actualJsonNode.isMissingNode());
- } else {
- return ResolverResult.error("Update not supported for given pointer expression");
- }
- return ResolverResult.updatesApplied(resolverResultMessage);
- } catch (final Exception e) {
- return ResolverResult.error(String.format(QUERY_ERROR_TEMPLATE, jsonPointerExpression, e.getMessage()));
- }
+ protected Map getExpectations() {
+ return this.expectations;
}
- /**
- * Update the actual node with the expected value
- *
- * @param parentObjectNode the parent object node
- * @param childNodeName the child node name
- * @param expectedValue the expected value
- */
- private static void updateObjectNodeValue(final ObjectNode parentObjectNode, final String childNodeName, final Object expectedValue) {
- if (expectedValue instanceof Boolean) {
- parentObjectNode.put(childNodeName, (boolean) expectedValue);
- } else if (expectedValue instanceof Integer) {
- parentObjectNode.put(childNodeName, (int) expectedValue);
- } else if (expectedValue instanceof Long) {
- parentObjectNode.put(childNodeName, (long) expectedValue);
- } else if (expectedValue instanceof Short) {
- parentObjectNode.put(childNodeName, (short) expectedValue);
- } else if (expectedValue instanceof BigDecimal) {
- parentObjectNode.put(childNodeName, (BigDecimal) expectedValue);
- } else if (expectedValue instanceof BigInteger) {
- parentObjectNode.put(childNodeName, (BigInteger) expectedValue);
- } else {
- parentObjectNode.put(childNodeName, expectedValue.toString());
- }
+ protected String getMessageTemplate(){
+ return "Execution of pointer expression [%s] yielded result [%s] which is not equal to [%s]";
}
-
- /**
- * Update the actual node with the expected value
- *
- * @param parentArrayNode the parent object node
- * @param actualNodeIndex the actual node index in the array
- * @param expectedValue the expected value
- * @param missing true if node does not currently exist, false otherwise
- */
- @SuppressWarnings("squid:S3776")
- private static void updateArrayNodeValue(final ArrayNode parentArrayNode, final int actualNodeIndex, final Object expectedValue, final boolean missing) {
- if (expectedValue instanceof Boolean) {
- if (missing) {
- parentArrayNode.insert(actualNodeIndex, (boolean) expectedValue);
- } else {
- parentArrayNode.set(actualNodeIndex, JsonNodeFactory.instance.booleanNode((boolean) expectedValue));
- }
- } else if (expectedValue instanceof Integer) {
- if (missing) {
- parentArrayNode.insert(actualNodeIndex, (int) expectedValue);
- } else {
- parentArrayNode.set(actualNodeIndex, JsonNodeFactory.instance.numberNode((int) expectedValue));
- }
- } else if (expectedValue instanceof Long) {
- if (missing) {
- parentArrayNode.insert(actualNodeIndex, (long) expectedValue);
- } else {
- parentArrayNode.set(actualNodeIndex, JsonNodeFactory.instance.numberNode((long) expectedValue));
- }
- } else if (expectedValue instanceof Short) {
- if (missing) {
- parentArrayNode.insert(actualNodeIndex, (short) expectedValue);
- } else {
- parentArrayNode.set(actualNodeIndex, JsonNodeFactory.instance.numberNode((short) expectedValue));
- }
- } else if (expectedValue instanceof BigDecimal) {
- if (missing) {
- parentArrayNode.insert(actualNodeIndex, (BigDecimal) expectedValue);
- } else {
- parentArrayNode.set(actualNodeIndex, JsonNodeFactory.instance.numberNode((BigDecimal) expectedValue));
- }
- } else if (expectedValue instanceof BigInteger) {
- if (missing) {
- parentArrayNode.insert(actualNodeIndex, (BigInteger) expectedValue);
- } else {
- parentArrayNode.set(actualNodeIndex, JsonNodeFactory.instance.numberNode((BigInteger) expectedValue));
- }
- } else {
- if (missing) {
- parentArrayNode.insert(actualNodeIndex, expectedValue.toString());
- } else {
- parentArrayNode.set(actualNodeIndex, JsonNodeFactory.instance.textNode(expectedValue.toString()));
- }
- }
- }
-
- /**
- * Determine if the {@code jsonNode} value equals that of the {@code expectedValue}
- *
- * @param jsonNode the JSON node to retrieve the value from
- * @param expectedValue the expected value
- * @return true if they are equal, false otherwise
- */
- private static boolean jsonNodeValueEquals(final JsonNode jsonNode, final Object expectedValue) {
- return (expectedValue instanceof CharSequence && StringUtils.equals((CharSequence) expectedValue, jsonNode.textValue()))
- || (expectedValue instanceof Number && expectedValue == jsonNode.numberValue())
- || (expectedValue instanceof Boolean && (boolean) expectedValue == jsonNode.booleanValue())
- || Objects.equals(expectedValue.toString(), jsonNode.asText());
- }
-
}
diff --git a/enforcer/file/common/src/main/java/com/optum/sourcehawk/enforcer/file/json/JsonValueNotEquals.java b/enforcer/file/common/src/main/java/com/optum/sourcehawk/enforcer/file/json/JsonValueNotEquals.java
new file mode 100644
index 0000000..b0982cb
--- /dev/null
+++ b/enforcer/file/common/src/main/java/com/optum/sourcehawk/enforcer/file/json/JsonValueNotEquals.java
@@ -0,0 +1,76 @@
+package com.optum.sourcehawk.enforcer.file.json;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.optum.sourcehawk.core.utils.StringUtils;
+import com.optum.sourcehawk.enforcer.file.FileResolver;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+
+import java.util.Collections;
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * An enforcer implementation which enforces that the result of a JsonPath query does not equal a specific value
+ *
+ * @author Brian Wyka
+ * @author Christian Oestreich
+ */
+@Builder(builderClassName = "Builder")
+@JsonDeserialize(builder = JsonValueNotEquals.Builder.class)
+@AllArgsConstructor(staticName = "equals")
+public class JsonValueNotEquals extends AbstractJsonValue implements FileResolver {
+
+ /**
+ * Key: The JsonPointer expression to retrieve the value
+ *
+ * Value: The expected value which the query should evaluate to
+ */
+ private final Map expectations;
+
+ /**
+ * Create with a single path query and expected value
+ *
+ * @param jsonPointerExpression the JSON pointer expression
+ * @param expectedValue the expected value
+ * @return the enforcer
+ */
+ public static JsonValueNotEquals equals(final String jsonPointerExpression, final Object expectedValue) {
+ return JsonValueNotEquals.equals(Collections.singletonMap(jsonPointerExpression, expectedValue));
+ }
+
+ /**
+ * Determine if the {@code jsonNode} value equals that of the {@code expectedValue}
+ *
+ * @param jsonNode the JSON node to retrieve the value from
+ * @param expectedValue the expected value
+ * @return true if they are equal, false otherwise
+ */
+ protected boolean jsonNodeValueEquals(final JsonNode jsonNode, final Object expectedValue) {
+ if (expectedValue instanceof CharSequence) {
+ return !StringUtils.equals((CharSequence) expectedValue, jsonNode.textValue());
+ }
+ if (expectedValue instanceof Number) {
+ return expectedValue != jsonNode.numberValue();
+ }
+ if (expectedValue instanceof Boolean) {
+ return (boolean) expectedValue != jsonNode.booleanValue();
+ }
+ return !Objects.equals(expectedValue.toString(), jsonNode.asText());
+ }
+
+ @Override
+ protected Map getExpectations() {
+ return this.expectations;
+ }
+
+ @Override
+ protected String getMessageTemplate() {
+ return "Execution of pointer expression [%s] yielded result [%s] which does equal [%s]";
+ }
+
+ protected boolean skipMissingNode(){
+ return true;
+ }
+}
diff --git a/enforcer/file/common/src/main/java/com/optum/sourcehawk/enforcer/file/yaml/YamlValueNotEquals.java b/enforcer/file/common/src/main/java/com/optum/sourcehawk/enforcer/file/yaml/YamlValueNotEquals.java
new file mode 100644
index 0000000..069c0c4
--- /dev/null
+++ b/enforcer/file/common/src/main/java/com/optum/sourcehawk/enforcer/file/yaml/YamlValueNotEquals.java
@@ -0,0 +1,69 @@
+package com.optum.sourcehawk.enforcer.file.yaml;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
+import com.optum.sourcehawk.enforcer.EnforcerResult;
+import com.optum.sourcehawk.enforcer.file.AbstractFileEnforcer;
+import com.optum.sourcehawk.enforcer.file.json.JsonValueEquals;
+import com.optum.sourcehawk.enforcer.file.json.JsonValueNotEquals;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.NonNull;
+import lombok.val;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.Charset;
+import java.util.Collections;
+import java.util.Map;
+
+/**
+ * An enforcer which is responsible for enforcing that a yaml file has a specific property with an expected value. Under
+ * the hood, this is delegating to {@link JsonValueEquals} after converting the yaml to json
+ *
+ * @author Christian Oestreich
+ * @see JsonValueNotEquals
+ */
+@Builder(builderClassName = "Builder")
+@JsonDeserialize(builder = YamlValueNotEquals.Builder.class)
+@AllArgsConstructor(staticName = "equals")
+public class YamlValueNotEquals extends AbstractFileEnforcer {
+
+ private static final ObjectMapper YAML_MAPPER = new YAMLMapper();
+ private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
+
+ /**
+ * Key: The Yaml Pointer expression to retrieve the value
+ *
+ * Value: The expected value which the query should evaluate to
+ */
+ private final Map expectations;
+
+ /**
+ * Create with a single path query and expected value
+ *
+ * @param yamlPathQuery the yaml path query
+ * @param expectedValue the expected value
+ * @return the enforcer
+ */
+ public static YamlValueNotEquals equals(final String yamlPathQuery, final Object expectedValue) {
+ return YamlValueNotEquals.equals(Collections.singletonMap(yamlPathQuery, expectedValue));
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public EnforcerResult enforceInternal(@NonNull final InputStream actualFileInputStream) throws IOException {
+ val yamlMap = YAML_MAPPER.readValue(actualFileInputStream, new TypeReference>() {
+ });
+ val json = OBJECT_MAPPER.writeValueAsString(yamlMap);
+ try (val jsonInputStream = new ByteArrayInputStream(json.getBytes(Charset.defaultCharset()))) {
+ return JsonValueNotEquals.equals(expectations).enforce(jsonInputStream);
+ }
+ }
+
+}
diff --git a/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/common/ContentNotEqualsSpec.groovy b/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/common/ContentNotEqualsSpec.groovy
new file mode 100644
index 0000000..669c46c
--- /dev/null
+++ b/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/common/ContentNotEqualsSpec.groovy
@@ -0,0 +1,80 @@
+package com.optum.sourcehawk.enforcer.file.common
+
+import com.optum.sourcehawk.enforcer.EnforcerResult
+import org.spockframework.util.IoUtil
+import spock.lang.Specification
+
+class ContentNotEqualsSpec extends Specification {
+
+ def "string"() {
+ expect:
+ ContentNotEquals.string('file')
+ }
+
+ def "enforce - null input stream"() {
+ when:
+ ContentNotEquals.string("abc").enforceInternal(null)
+
+ then:
+ thrown(NullPointerException)
+ }
+
+ def "enforce (passed)"() {
+ given:
+ ContentNotEquals contentNotEquals = ContentNotEquals.string(IoUtil.getResourceAsStream('/file.txt').text)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/file.txt')
+
+ when:
+ EnforcerResult result = contentNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ !result.passed
+ result.messages
+ result.messages[0] == "File contents do equal that of the expected file contents"
+ }
+
+ def "enforce (failed)"() {
+ given:
+ ContentNotEquals contentNotEquals = ContentNotEquals.string(IoUtil.getResourceAsStream('/file.txt').text)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/checksum.txt')
+
+ when:
+ EnforcerResult result = contentNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ result.passed
+ !result.messages
+ }
+
+ def "enforce - URL (passed)"() {
+ given:
+ ContentNotEquals notEquals = ContentNotEquals.url(new URL('https://raw.githubusercontent.com/optum/sourcehawk/main/README.md'))
+ InputStream fileInputStream = new URL('https://raw.githubusercontent.com/optum/sourcehawk/main/README.md').openStream()
+
+ when:
+ EnforcerResult result = notEquals.enforce(fileInputStream)
+
+ then:
+ result
+ !result.passed
+ result.messages
+ result.messages[0] == "File contents do equal that of the expected file contents"
+ }
+
+ def "enforce - URL (failed)"() {
+ given:
+ ContentNotEquals contentNotEquals = ContentNotEquals.url(new URL('https://raw.githubusercontent.com/optum/sourcehawk/main/README.md'))
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/checksum.txt')
+
+ when:
+ EnforcerResult result = contentNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ result.passed
+ !result.messages
+ }
+
+}
diff --git a/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/common/NotContainsLineSpec.groovy b/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/common/NotContainsLineSpec.groovy
new file mode 100644
index 0000000..4c3a555
--- /dev/null
+++ b/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/common/NotContainsLineSpec.groovy
@@ -0,0 +1,66 @@
+package com.optum.sourcehawk.enforcer.file.common
+
+
+import com.optum.sourcehawk.enforcer.EnforcerResult
+import org.spockframework.util.IoUtil
+import spock.lang.Specification
+import spock.lang.Unroll
+
+class NotContainsLineSpec extends Specification {
+
+ def "equals"() {
+ expect:
+ NotContainsLine.contains('I am a line')
+ }
+
+ def "enforce - null input stream"() {
+ when:
+ NotContainsLine.contains("line").enforceInternal(null)
+
+ then:
+ thrown(NullPointerException)
+ }
+
+ @Unroll
+ def "enforce - #expectedLine (passed)"() {
+ given:
+ NotContainsLine notContainsLine = NotContainsLine.contains(expectedLine)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/file.txt')
+
+ when:
+ EnforcerResult result = notContainsLine.enforce(fileInputStream)
+
+ then:
+ result
+ !result.passed
+ result.messages[0] == "File does contain the line [$expectedLine]"
+
+ where:
+ expectedLine << [
+ '^ Here is a special character: $',
+ 'Perhaps I should include a double " and a single \' as well...'
+ ]
+ }
+
+ @Unroll
+ def "enforce - #expectedLine (failed)"() {
+ given:
+ NotContainsLine notContainsLine = NotContainsLine.contains(expectedLine)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/file.txt')
+
+ when:
+ EnforcerResult result = notContainsLine.enforce(fileInputStream)
+
+ then:
+ result
+ result.passed
+ !result.messages
+
+ where:
+ expectedLine << [
+ 'Here is a special character: $',
+ 'Perhaps I should include a double " and a single \' as well'
+ ]
+ }
+
+}
diff --git a/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/common/NotContainsSpec.groovy b/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/common/NotContainsSpec.groovy
new file mode 100644
index 0000000..46e3d77
--- /dev/null
+++ b/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/common/NotContainsSpec.groovy
@@ -0,0 +1,67 @@
+package com.optum.sourcehawk.enforcer.file.common
+
+
+import com.optum.sourcehawk.enforcer.EnforcerResult
+import org.spockframework.util.IoUtil
+import spock.lang.Specification
+import spock.lang.Unroll
+
+class NotContainsSpec extends Specification {
+
+ def "equals"() {
+ expect:
+ NotContains.substring('Hello')
+ }
+
+ def "enforce - null input stream"() {
+ when:
+ NotContains.substring("abc").enforceInternal(null)
+
+ then:
+ thrown(NullPointerException)
+ }
+
+ @Unroll
+ def "enforce - #expectedSubstring (passed)"() {
+ given:
+ NotContains notContains = NotContains.substring(expectedSubstring)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/file.txt')
+
+ when:
+ EnforcerResult result = notContains.enforce(fileInputStream)
+
+ then:
+ result
+ result.passed
+ !result.messages
+
+ where:
+ expectedSubstring << [
+ 'imaginary',
+ 'I should not include'
+ ]
+ }
+
+ @Unroll
+ def "enforce - #expectedSubstring (failed)"() {
+ given:
+ NotContains notContains = NotContains.substring(expectedSubstring)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/file.txt')
+
+ when:
+ EnforcerResult result = notContains.enforce(fileInputStream)
+
+ then:
+ result
+ !result.passed
+ result.messages
+ result.messages[0] == "File does contain the sub string [$expectedSubstring]"
+
+ where:
+ expectedSubstring << [
+ 'special',
+ 'Perhaps I should include'
+ ]
+ }
+
+}
diff --git a/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/common/Sha256ChecksumNotEqualsSpec.groovy b/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/common/Sha256ChecksumNotEqualsSpec.groovy
new file mode 100644
index 0000000..862f59e
--- /dev/null
+++ b/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/common/Sha256ChecksumNotEqualsSpec.groovy
@@ -0,0 +1,54 @@
+package com.optum.sourcehawk.enforcer.file.common
+
+
+import com.optum.sourcehawk.enforcer.EnforcerResult
+import org.spockframework.util.IoUtil
+import spock.lang.Specification
+
+class Sha256ChecksumNotEqualsSpec extends Specification {
+
+ def "equals"() {
+ expect:
+ Sha256ChecksumNotEquals.equals("checksum")
+ }
+
+ def "enforce - null input stream"() {
+ when:
+ Sha256ChecksumNotEquals.equals("abc").enforceInternal(null)
+
+ then:
+ thrown(NullPointerException)
+ }
+
+ def "enforce (passed))"() {
+ given:
+ String expectedChecksum = "a6179a1feff6949517fab1d18804a35d25d807c597fcba21a6b4c3e919af6e6f"
+ Sha256ChecksumNotEquals sha256ChecksumNotEquals = Sha256ChecksumNotEquals.equals(expectedChecksum)
+ InputStream fileInputStream = IoUtil.getResourceAsStream("/checksum.txt")
+
+ when:
+ EnforcerResult enforcerResult = sha256ChecksumNotEquals.enforce(fileInputStream)
+
+ then:
+ enforcerResult
+ !enforcerResult.passed
+ enforcerResult.messages
+ enforcerResult.messages[0] == 'The SHA-256 checksum of the file does match'
+ }
+
+ def "enforce (failed))"() {
+ given:
+ String expectedChecksum = "123"
+ Sha256ChecksumNotEquals sha256ChecksumNotEquals = Sha256ChecksumNotEquals.equals(expectedChecksum)
+ InputStream fileInputStream = IoUtil.getResourceAsStream("/checksum.txt")
+
+ when:
+ EnforcerResult enforcerResult = sha256ChecksumNotEquals.enforce(fileInputStream)
+
+ then:
+ enforcerResult
+ enforcerResult.passed
+ !enforcerResult.messages
+ }
+
+}
diff --git a/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/json/JsonValueNotEqualsSpec.groovy b/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/json/JsonValueNotEqualsSpec.groovy
new file mode 100644
index 0000000..12a5208
--- /dev/null
+++ b/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/json/JsonValueNotEqualsSpec.groovy
@@ -0,0 +1,401 @@
+package com.optum.sourcehawk.enforcer.file.json
+
+
+import com.fasterxml.jackson.databind.ObjectMapper
+import com.fasterxml.jackson.databind.node.ArrayNode
+import com.fasterxml.jackson.databind.node.JsonNodeFactory
+import com.fasterxml.jackson.databind.node.ObjectNode
+import com.optum.sourcehawk.enforcer.EnforcerResult
+import com.optum.sourcehawk.enforcer.ResolverResult
+import org.spockframework.util.IoUtil
+import spock.lang.Specification
+import spock.lang.Unroll
+
+import java.util.function.Function
+
+class JsonValueNotEqualsSpec extends Specification {
+
+ def "equals"() {
+ expect:
+ JsonValueNotEquals.equals('/key', 'value')
+ }
+
+ def "enforce - null input stream"() {
+ when:
+ JsonValueNotEquals.equals('/foo', "bar").enforceInternal(null)
+
+ then:
+ thrown(NullPointerException)
+ }
+
+ @Unroll
+ def "enforce - #pointerExpression = #expectedValue (passed)"() {
+ given:
+ JsonValueNotEquals jsonPathNotEquals = JsonValueNotEquals.equals(pointerExpression, expectedValue)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle.json')
+
+ when:
+ EnforcerResult result = jsonPathNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ result.passed
+ !result.messages
+
+ where:
+ pointerExpression | expectedValue
+ '/make' | 'Trek'
+ '/size/value' | 61
+ '/components/0' | 'shifter'
+ }
+
+ @Unroll
+ def "enforce - #pointerExpression = #expectedValue (passed) - number based keys"() {
+ given:
+ JsonValueNotEquals jsonPathNotEquals = JsonValueNotEquals.equals(pointerExpression, expectedValue)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/index-map.json')
+
+ when:
+ EnforcerResult result = jsonPathNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ result.passed
+ !result.messages
+
+ where:
+ pointerExpression | expectedValue
+ '/index/0' | 'hello1'
+ '/index/1' | 'world1'
+ '/index/2' | 'foo1'
+ '/index/3' | 'bar1'
+ }
+
+ def "enforce - map (passed)"() {
+ given:
+ def map = [
+ '/make' : 'Trek',
+ '/size/value' : 61,
+ '/components/0' : 'shifter'
+ ]
+ JsonValueNotEquals jsonPathNotEquals = JsonValueNotEquals.equals(map)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle.json')
+
+ when:
+ EnforcerResult result = jsonPathNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ result.passed
+ !result.messages
+ }
+
+ @Unroll
+ def "enforce - #pointerExpression = #expectedValue (failed - incorrect value)"() {
+ given:
+ JsonValueNotEquals jsonPathNotEquals = JsonValueNotEquals.equals(pointerExpression, expectedValue)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle.json')
+
+ when:
+ EnforcerResult result = jsonPathNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ !result.passed
+ result.messages
+ result.messages[0] == "Execution of pointer expression [$pointerExpression] yielded result [$actualValue] which does equal [$expectedValue]"
+
+ where:
+ pointerExpression | actualValue | expectedValue
+ '/make' | 'Raleigh' | 'Raleigh'
+ '/size/value' | 60 | 60
+ '/components/0' | 'handlebars' | 'handlebars'
+ }
+
+ @Unroll
+ def "enforce - #pointerExpression = #expectedValue (failed - missing)"() {
+ given:
+ JsonValueNotEquals jsonPathNotEquals = JsonValueNotEquals.equals(pointerExpression, expectedValue)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle.json')
+
+ when:
+ EnforcerResult result = jsonPathNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ !result.passed
+ result.messages
+ result.messages[0] == "Execution of pointer expression [$pointerExpression] yielded no result"
+
+ where:
+ pointerExpression | expectedValue
+ '/class' | 'road'
+ '/components/8' | 'calipers'
+ }
+
+ @Unroll
+ def "enforce - #pointerExpression = #expectedValue (failed - pointer expression error)"() {
+ given:
+ JsonValueNotEquals jsonPathNotEquals = JsonValueNotEquals.equals(pointerExpression, expectedValue)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle.json')
+
+ when:
+ EnforcerResult result = jsonPathNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ !result.passed
+ result.messages
+ result.messages[0].startsWith("Execution of pointer expression [$pointerExpression] yielded error")
+
+ where:
+ pointerExpression | expectedValue
+ '*' | 'road'
+ }
+
+ @Unroll
+ def "enforce - #pointerExpression = #expectedValue (failed - null parse)"() {
+ given:
+ JsonValueNotEquals jsonPathNotEquals = JsonValueNotEquals.equals(pointerExpression, expectedValue)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle-bad.json')
+
+ when:
+ EnforcerResult result = jsonPathNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ !result.passed
+ result.messages
+ result.messages[0].startsWith("Reading or parsing file resulted in error")
+
+ where:
+ pointerExpression | expectedValue
+ '//' | 'road'
+ }
+
+ @Unroll
+ def "resolve - no updates required"() {
+ given:
+ JsonValueNotEquals jsonPathNotEquals = JsonValueNotEquals.equals(pointerExpression, expectedValue)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle.json')
+ StringWriter stringWriter = new StringWriter()
+
+ when:
+ ResolverResult result = jsonPathNotEquals.resolve(fileInputStream, stringWriter)
+
+ then:
+ result
+ !result.updatesApplied
+ result.fixCount == 0
+ !result.error
+ result.errorCount == 0
+ !result.messages
+
+ and:
+ !stringWriter.toString()
+
+ where:
+ pointerExpression | expectedValue
+ '/make' | 'Trek'
+ '/size/value' | 61
+ '/components/0' | 'brakes'
+ }
+
+ @Unroll
+ def "resolve - updates applied (pointer expression found)"() {
+ given:
+ JsonValueNotEquals jsonPathNotEquals = JsonValueNotEquals.equals(pointerExpression, expectedValue)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle.json')
+ StringWriter stringWriter = new StringWriter()
+
+ when:
+ ResolverResult result = jsonPathNotEquals.resolve(fileInputStream, stringWriter)
+
+ then:
+ result
+ result.updatesApplied
+ result.fixCount == 1
+ !result.error
+ result.errorCount == 0
+ result.messages
+ result.messages.size() == 1
+ result.messages[0] == "Pointer expression [$pointerExpression] has been updated with value [$expectedValue]"
+
+ and:
+ stringWriter.toString()
+
+ where:
+ pointerExpression | expectedValue
+ '/make' | 'Raleigh'
+ '/size/value' | 60
+ '/components/0' | 'handlebars'
+ }
+
+ @Unroll
+ def "resolve - updates applied (pointer expression not found)"() {
+ given:
+ JsonValueNotEquals jsonPathNotEquals = JsonValueNotEquals.equals(pointerExpression, expectedValue)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle.json')
+ StringWriter stringWriter = new StringWriter()
+
+ when:
+ ResolverResult result = jsonPathNotEquals.resolve(fileInputStream, stringWriter)
+
+ then:
+ result
+ result.updatesApplied
+ result.fixCount == 1
+ !result.error
+ result.errorCount == 0
+ result.messages
+ result.messages.size() == 1
+ result.messages[0] == "Pointer expression [$pointerExpression] which was missing, has been set with value [$expectedValue]"
+
+ when:
+ Map jsonObject = new ObjectMapper().readValue(stringWriter.toString(), Map)
+
+ then:
+ expectedJsonAssertion.apply(jsonObject)
+
+ where:
+ pointerExpression | expectedValue | expectedJsonAssertion
+ '/rating' | 98 | { json -> json.rating == 98 } as Function
+// '/notes/0' | 'Note 1' | { json -> json.notes[0] == "Note 1" } as Function (array addition not yet supported)
+// '/child/notes/0' | 'Child Note' | { json -> json['child.notes'][0] == "Child Note" } as Function (array addition not yet supported)
+ }
+
+ def "resolve - error"() {
+ given:
+ String pointerExpression = '$$'
+ JsonValueNotEquals jsonPathNotEquals = JsonValueNotEquals.equals(pointerExpression, "doesn't matter")
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle.json')
+ StringWriter stringWriter = new StringWriter()
+
+ when:
+ ResolverResult result = jsonPathNotEquals.resolve(fileInputStream, stringWriter)
+
+ then:
+ result
+ !result.updatesApplied
+ result.fixCount == 0
+ result.error
+ result.errorCount == 1
+ result.messages
+ result.messages.size() == 1
+ result.messages[0].startsWith("Execution of pointer expression [$pointerExpression] yielded error")
+
+ and:
+ !stringWriter.toString()
+ }
+
+ def "resolve - closed input stream"() {
+ given:
+ InputStream inputStream = IoUtil.getResourceAsStream('/bicycle.json')
+ inputStream.close()
+
+ when:
+ ResolverResult resolverResult = JsonValueNotEquals.equals('/key', "doesn't matter").resolve(inputStream, new StringWriter())
+
+ then:
+ resolverResult
+ !resolverResult.updatesApplied
+ resolverResult.fixCount == 0
+ resolverResult.error
+ resolverResult.errorCount == 1
+ resolverResult.messages
+ resolverResult.messages.size() == 1
+ resolverResult.messages[0].startsWith("Reading or parsing file resulted in error")
+ }
+
+ def "resolve - null input stream or writer"() {
+ when:
+ JsonValueNotEquals.equals('/key', "doesn't matter").resolve(null, new StringWriter())
+
+ then:
+ thrown(NullPointerException)
+
+ when:
+ JsonValueNotEquals.equals('/key', "doesn't matter").resolve( IoUtil.getResourceAsStream('/bicycle.json'), null)
+
+ then:
+ thrown(NullPointerException)
+ }
+
+ @Unroll
+ def "updateObjectNodeValue - #type"() {
+ given:
+ ObjectNode parentObjectNode = JsonNodeFactory.instance.objectNode()
+ String childNodeName = "child"
+
+ when:
+ JsonValueNotEquals.updateObjectNodeValue(parentObjectNode, childNodeName, expectedValue)
+
+ then:
+ noExceptionThrown()
+
+ where:
+ type | expectedValue
+ String | "hello"
+ Boolean | true
+ Integer | (int) 34
+ Long | (long) 28
+ Double | (double) 20.4
+ Float | (float) 100.7345
+ Short | (short) 1
+ BigInteger | BigInteger.ONE
+ BigDecimal | BigDecimal.ZERO
+ }
+
+ @Unroll
+ def "updateArrayNodeValue - #type (missing = false)"() {
+ given:
+ ArrayNode parentArrayNode = JsonNodeFactory.instance.arrayNode(10)
+ parentArrayNode.add(expectedValue)
+ parentArrayNode.add(expectedValue)
+ parentArrayNode.add(expectedValue)
+ parentArrayNode.add(expectedValue)
+ parentArrayNode.add(expectedValue)
+ parentArrayNode.add(expectedValue)
+ int childNodeIndex = 3
+
+ when:
+ JsonValueNotEquals.updateArrayNodeValue(parentArrayNode, childNodeIndex, expectedValue, false)
+
+ then:
+ noExceptionThrown()
+
+ where:
+ type | expectedValue
+ String | "hello"
+ Boolean | true
+ Integer | (int) 34
+ Long | (long) 28
+ Short | (short) 1
+ BigInteger | BigInteger.ONE
+ BigDecimal | BigDecimal.ZERO
+ }
+
+ @Unroll
+ def "updateArrayNodeValue - #type (missing = true)"() {
+ given:
+ ArrayNode parentArrayNode = JsonNodeFactory.instance.arrayNode(10)
+ int childNodeIndex = 3
+
+ when:
+ JsonValueNotEquals.updateArrayNodeValue(parentArrayNode, childNodeIndex, expectedValue, true)
+
+ then:
+ noExceptionThrown()
+
+ where:
+ type | expectedValue
+ String | "hello"
+ Boolean | true
+ Integer | (int) 34
+ Long | (long) 28
+ Short | (short) 1
+ BigInteger | BigInteger.ONE
+ BigDecimal | BigDecimal.ZERO
+ }
+
+}
diff --git a/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/yaml/YamlValueNotEqualsSpec.groovy b/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/yaml/YamlValueNotEqualsSpec.groovy
new file mode 100644
index 0000000..6b75d6b
--- /dev/null
+++ b/enforcer/file/common/src/test/groovy/com/optum/sourcehawk/enforcer/file/yaml/YamlValueNotEqualsSpec.groovy
@@ -0,0 +1,127 @@
+package com.optum.sourcehawk.enforcer.file.yaml
+
+
+import com.optum.sourcehawk.enforcer.EnforcerResult
+import org.spockframework.util.IoUtil
+import spock.lang.Specification
+import spock.lang.Unroll
+
+class YamlValueNotEqualsSpec extends Specification {
+
+ def "equals"() {
+ expect:
+ YamlValueNotEquals.equals('/key', 'value')
+ YamlValueNotEquals.equals(['/key': 'value'])
+ }
+
+ def "enforce - null input stream"() {
+ when:
+ YamlValueNotEquals.equals('/foo', "bar").enforceInternal(null)
+
+ then:
+ thrown(NullPointerException)
+ }
+
+ @Unroll
+ def "enforce - #pointerExpression = #expectedValue (passed)"() {
+ given:
+ YamlValueNotEquals yamlPathNotEquals = YamlValueNotEquals.equals(pointerExpression, expectedValue)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle.yml')
+
+ when:
+ EnforcerResult result = yamlPathNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ result.passed
+ !result.messages
+
+ where:
+ pointerExpression | expectedValue
+ '/make' | 'Trek'
+ '/size/value' | 61
+ '/components/0' | 'brakes'
+ }
+
+ def "enforce - map (passed)"() {
+ given:
+ def map = [
+ '/make' : 'Trek',
+ '/size/value' : 61,
+ '/components/0': 'brakes'
+ ]
+ YamlValueNotEquals yamlPathNotEquals = YamlValueNotEquals.equals(map)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle.yml')
+
+ when:
+ EnforcerResult result = yamlPathNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ result.passed
+ !result.messages
+ }
+
+ @Unroll
+ def "enforce - #pointerExpression = #expectedValue (failed - incorrect value)"() {
+ given:
+ YamlValueNotEquals yamlPathNotEquals = YamlValueNotEquals.equals(pointerExpression, expectedValue)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle.yml')
+
+ when:
+ EnforcerResult result = yamlPathNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ !result.passed
+ result.messages
+ result.messages[0] == "Execution of pointer expression [$pointerExpression] yielded result [$actualValue] which does equal [$expectedValue]"
+
+ where:
+ pointerExpression | actualValue | expectedValue
+ '/make' | 'Raleigh' | 'Raleigh'
+ '/size/value' | 60 | 60
+ '/components/0' | 'handlebars' | 'handlebars'
+ }
+
+ @Unroll
+ def "enforce - #pointerExpression = #expectedValue (failed - missing)"() {
+ given:
+ YamlValueNotEquals yamlPathNotEquals = YamlValueNotEquals.equals(pointerExpression, expectedValue)
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle.yml')
+
+ when:
+ EnforcerResult result = yamlPathNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ !result.passed
+ result.messages
+ result.messages[0] == "Execution of pointer expression [$pointerExpression] yielded no result"
+
+ where:
+ pointerExpression | expectedValue
+ '/class' | 'road'
+ '/components/8' | 'calipers'
+ }
+
+ @Unroll
+ def "enforce - #pointerExpression (failed - pointer expression error)"() {
+ given:
+ YamlValueNotEquals yamlPathNotEquals = YamlValueNotEquals.equals(pointerExpression, 'road')
+ InputStream fileInputStream = IoUtil.getResourceAsStream('/bicycle.yml')
+
+ when:
+ EnforcerResult result = yamlPathNotEquals.enforce(fileInputStream)
+
+ then:
+ result
+ !result.passed
+ result.messages
+ result.messages[0].startsWith("Execution of pointer expression [$pointerExpression] yielded error")
+
+ where:
+ pointerExpression << ['.', '$']
+ }
+
+}
diff --git a/enforcer/file/core/pom.xml b/enforcer/file/core/pom.xml
index 082fa20..96c8013 100644
--- a/enforcer/file/core/pom.xml
+++ b/enforcer/file/core/pom.xml
@@ -8,7 +8,7 @@
com.optum.sourcehawk
sourcehawk-enforcer-file
- 0.6.0-SNAPSHOT
+ 0.7.0-SNAPSHOT
../pom.xml
diff --git a/enforcer/file/docker/pom.xml b/enforcer/file/docker/pom.xml
index bda2632..6ec6ae9 100644
--- a/enforcer/file/docker/pom.xml
+++ b/enforcer/file/docker/pom.xml
@@ -8,7 +8,7 @@
com.optum.sourcehawk
sourcehawk-enforcer-file
- 0.6.0-SNAPSHOT
+ 0.7.0-SNAPSHOT
../pom.xml
diff --git a/enforcer/file/maven/pom.xml b/enforcer/file/maven/pom.xml
index 06e1453..76dd2ef 100644
--- a/enforcer/file/maven/pom.xml
+++ b/enforcer/file/maven/pom.xml
@@ -8,7 +8,7 @@
com.optum.sourcehawk
sourcehawk-enforcer-file
- 0.6.0-SNAPSHOT
+ 0.7.0-SNAPSHOT
../pom.xml
@@ -27,7 +27,7 @@
org.apache.maven
maven-model
- 3.6.3
+ ${maven.version}
compile
diff --git a/enforcer/file/pom.xml b/enforcer/file/pom.xml
index 5ef024b..bbb6251 100644
--- a/enforcer/file/pom.xml
+++ b/enforcer/file/pom.xml
@@ -8,7 +8,7 @@
com.optum.sourcehawk
sourcehawk-enforcer
- 0.6.0-SNAPSHOT
+ 0.7.0-SNAPSHOT
../pom.xml
diff --git a/enforcer/file/registry/pom.xml b/enforcer/file/registry/pom.xml
index 71ac145..663031c 100644
--- a/enforcer/file/registry/pom.xml
+++ b/enforcer/file/registry/pom.xml
@@ -8,7 +8,7 @@
com.optum.sourcehawk
sourcehawk-enforcer-file
- 0.6.0-SNAPSHOT
+ 0.7.0-SNAPSHOT
../pom.xml
diff --git a/enforcer/pom.xml b/enforcer/pom.xml
index 2ecf225..ee974cc 100644
--- a/enforcer/pom.xml
+++ b/enforcer/pom.xml
@@ -8,7 +8,7 @@
com.optum.sourcehawk
sourcehawk
- 0.6.0-SNAPSHOT
+ 0.7.0-SNAPSHOT
../pom.xml
diff --git a/exec/pom.xml b/exec/pom.xml
index a517011..a7bc559 100644
--- a/exec/pom.xml
+++ b/exec/pom.xml
@@ -8,7 +8,7 @@
com.optum.sourcehawk
sourcehawk
- 0.6.0-SNAPSHOT
+ 0.7.0-SNAPSHOT
../pom.xml
@@ -19,7 +19,7 @@
- 0.88
+ 0.87
diff --git a/exec/src/main/java/com/optum/sourcehawk/exec/scan/ScanExecutor.java b/exec/src/main/java/com/optum/sourcehawk/exec/scan/ScanExecutor.java
index edfbdce..7c8e96f 100644
--- a/exec/src/main/java/com/optum/sourcehawk/exec/scan/ScanExecutor.java
+++ b/exec/src/main/java/com/optum/sourcehawk/exec/scan/ScanExecutor.java
@@ -1,19 +1,15 @@
package com.optum.sourcehawk.exec.scan;
import com.optum.sourcehawk.core.configuration.SourcehawkConfiguration;
+import com.optum.sourcehawk.core.data.Severity;
import com.optum.sourcehawk.core.protocol.file.FileProtocol;
import com.optum.sourcehawk.core.result.ScanResult;
-import com.optum.sourcehawk.core.data.Severity;
import com.optum.sourcehawk.core.utils.CollectionUtils;
import com.optum.sourcehawk.core.utils.FileUtils;
import com.optum.sourcehawk.core.utils.Try;
import com.optum.sourcehawk.enforcer.file.FileEnforcer;
import com.optum.sourcehawk.exec.ConfigurationReader;
import com.optum.sourcehawk.exec.ExecOptions;
-import lombok.AccessLevel;
-import lombok.NoArgsConstructor;
-import lombok.val;
-
import java.io.IOException;
import java.nio.file.Path;
import java.util.ArrayList;
@@ -21,6 +17,9 @@
import java.util.Collection;
import java.util.Collections;
import java.util.stream.Collectors;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+import lombok.val;
/**
* Entry point into executing scans
@@ -117,7 +116,11 @@ private static ScanResult enforceFileProtocol(final ExecOptions execOptions, fin
if (execOptions.getRepositoryFileReader().supportsGlobPatterns() && FileUtils.isGlobPattern(fileProtocol.getRepositoryPath())) {
fileProtocolScanResults.addAll(executeFileEnforcerOnGlob(execOptions, fileProtocol, fileEnforcer));
} else {
- fileProtocolScanResults.add(executeFileEnforcer(execOptions, fileProtocol.getRepositoryPath(), fileProtocol.getSeverity(), fileEnforcer));
+ val scanResult = executeFileEnforcer(execOptions, fileProtocol.getRepositoryPath(), fileProtocol, fileEnforcer);
+ fileProtocolScanResults.add(scanResult);
+ if (isScanResultFileNotFound(scanResult)) {
+ break;
+ }
}
}
return fileProtocolScanResults.stream()
@@ -145,7 +148,7 @@ private static Collection executeFileEnforcerOnGlob(final ExecOption
}
val fileEnforcerScanResults = new ArrayList(repositoryPaths.size());
for (val repositoryPath : repositoryPaths) {
- fileEnforcerScanResults.add(executeFileEnforcer(execOptions, repositoryPath, fileProtocol.getSeverity(), fileEnforcer));
+ fileEnforcerScanResults.add(executeFileEnforcer(execOptions, repositoryPath, fileProtocol, fileEnforcer));
}
return fileEnforcerScanResults;
}
@@ -154,19 +157,33 @@ private static Collection executeFileEnforcerOnGlob(final ExecOption
* Execute the file enforcer to produce the scan result
*
* @param execOptions the exec options
- * @param repositoryFilePath the repository file path
- * @param severity the severity of the file protocol
+ * @param repositoryPath the repository path
+ * @param fileProtocol the file protocol
* @param fileEnforcer the file enforcer to execute
* @return the scan result
* @throws IOException if any error occurs accessing the file or executing enforcer
*/
- private static ScanResult executeFileEnforcer(final ExecOptions execOptions, final String repositoryFilePath, final String severity,
- final FileEnforcer fileEnforcer) throws IOException {
- try (val fileInputStream = execOptions.getRepositoryFileReader().read(repositoryFilePath)
- .orElseThrow(() -> new IOException(String.format("File not found: %s", repositoryFilePath)))) {
+ private static ScanResult executeFileEnforcer(final ExecOptions execOptions, final String repositoryPath, final FileProtocol fileProtocol,
+ final FileEnforcer fileEnforcer) throws IOException {
+ val fileInputStreamOptional = execOptions.getRepositoryFileReader().read(repositoryPath);
+ if (!fileInputStreamOptional.isPresent()) {
+ return ScanResultFactory.fileNotFound(execOptions, repositoryPath, fileProtocol.getSeverity());
+ }
+ try (val fileInputStream = fileInputStreamOptional.get()) {
val enforcerResult = fileEnforcer.enforce(fileInputStream);
- return ScanResultFactory.enforcerResult(execOptions, repositoryFilePath, Severity.parse(severity), enforcerResult);
+ return ScanResultFactory.enforcerResult(execOptions, repositoryPath, Severity.parse(fileProtocol.getSeverity()), enforcerResult);
}
}
+ /**
+ * Determine if the {@link ScanResult} is because the file was not found
+ *
+ * @param scanResult the scan result
+ * @return true if because of file not being found, false otherwise
+ */
+ private static boolean isScanResultFileNotFound(final ScanResult scanResult) {
+ return scanResult.getFormattedMessages().size() == 1
+ && scanResult.getFormattedMessages().stream().anyMatch(message -> message.contains("File not found"));
+ }
+
}
diff --git a/exec/src/main/java/com/optum/sourcehawk/exec/scan/ScanResultFactory.java b/exec/src/main/java/com/optum/sourcehawk/exec/scan/ScanResultFactory.java
index 32c3245..9bf3099 100644
--- a/exec/src/main/java/com/optum/sourcehawk/exec/scan/ScanResultFactory.java
+++ b/exec/src/main/java/com/optum/sourcehawk/exec/scan/ScanResultFactory.java
@@ -5,13 +5,12 @@
import com.optum.sourcehawk.core.result.ScanResult;
import com.optum.sourcehawk.enforcer.EnforcerResult;
import com.optum.sourcehawk.exec.ExecOptions;
-import lombok.experimental.UtilityClass;
-import lombok.val;
-
import java.util.ArrayList;
import java.util.Collections;
import java.util.Optional;
import java.util.function.IntConsumer;
+import lombok.experimental.UtilityClass;
+import lombok.val;
/**
* A factory for creating instances of {@link ScanResult}
@@ -95,18 +94,31 @@ public ScanResult globalError(final Throwable throwable) {
* @return the file not found scan result
*/
public ScanResult fileNotFound(final ExecOptions execOptions, final FileProtocol fileProtocol) {
- val severity = Severity.parse(fileProtocol.getSeverity());
+ return fileNotFound(execOptions, fileProtocol.getRepositoryPath(), fileProtocol.getSeverity());
+ }
+
+ /**
+ * Generate a scan result for situations where the file is not found
+ *
+ * @param execOptions the exec options
+ * @param repositoryPath the repository path
+ * @param fileProtocolSeverity the file protocol severity
+ * @return the file not found scan result
+ */
+ public ScanResult fileNotFound(final ExecOptions execOptions, final String repositoryPath, final String fileProtocolSeverity) {
+ val severity = Severity.parse(fileProtocolSeverity);
val messageDescriptor = ScanResult.MessageDescriptor.builder()
- .severity(fileProtocol.getSeverity())
- .repositoryPath(fileProtocol.getRepositoryPath())
- .message("File not found")
- .build();
+ .severity(fileProtocolSeverity)
+ .repositoryPath(repositoryPath)
+ .message("File not found")
+ .build();
val scanResultBuilder = ScanResult.builder()
- .passed(Severity.WARNING.equals(severity) && !execOptions.isFailOnWarnings())
- .messages(Collections.singletonMap(fileProtocol.getRepositoryPath(), Collections.singleton(messageDescriptor)))
- .formattedMessages(Collections.singleton(messageDescriptor.toString()));
- return acceptCount(scanResultBuilder, Severity.parse(fileProtocol.getSeverity()), 1)
- .build();
+
+ .passed(Severity.WARNING.equals(severity) && !execOptions.isFailOnWarnings())
+ .messages(Collections.singletonMap(repositoryPath, Collections.singleton(messageDescriptor)))
+ .formattedMessages(Collections.singleton(messageDescriptor.toString()));
+ return acceptCount(scanResultBuilder, severity, 1)
+ .build();
}
/**
diff --git a/exec/src/test/groovy/com/optum/sourcehawk/exec/ConfigurationReaderSpec.groovy b/exec/src/test/groovy/com/optum/sourcehawk/exec/ConfigurationReaderSpec.groovy
index d4ee1fe..ba6c9cf 100644
--- a/exec/src/test/groovy/com/optum/sourcehawk/exec/ConfigurationReaderSpec.groovy
+++ b/exec/src/test/groovy/com/optum/sourcehawk/exec/ConfigurationReaderSpec.groovy
@@ -2,7 +2,6 @@ package com.optum.sourcehawk.exec
import com.optum.sourcehawk.core.configuration.SourcehawkConfiguration
import org.spockframework.util.IoUtil
-import sun.nio.ch.ChannelInputStream
class ConfigurationReaderSpec extends FileBaseSpecification {
@@ -38,7 +37,7 @@ class ConfigurationReaderSpec extends FileBaseSpecification {
InputStream inputStream = ConfigurationReader.obtainInputStream(repositoryRoot, configurationFileLocation).get()
then:
- inputStream instanceof ChannelInputStream
+ inputStream.class.name == 'sun.nio.ch.ChannelInputStream'
}
def "obtainInputStream - relative file"() {
@@ -50,7 +49,7 @@ class ConfigurationReaderSpec extends FileBaseSpecification {
then:
inputStream
- inputStream instanceof ChannelInputStream
+ inputStream.class.name == 'sun.nio.ch.ChannelInputStream'
}
def "merge"() {
diff --git a/exec/src/test/groovy/com/optum/sourcehawk/exec/ExecOptionsSpec.groovy b/exec/src/test/groovy/com/optum/sourcehawk/exec/ExecOptionsSpec.groovy
index 0ca74cc..20adfc2 100644
--- a/exec/src/test/groovy/com/optum/sourcehawk/exec/ExecOptionsSpec.groovy
+++ b/exec/src/test/groovy/com/optum/sourcehawk/exec/ExecOptionsSpec.groovy
@@ -1,9 +1,10 @@
package com.optum.sourcehawk.exec
import com.optum.sourcehawk.core.data.RemoteRef
-import com.optum.sourcehawk.core.repository.GithubRepositoryFileReader
+
import com.optum.sourcehawk.core.repository.LocalRepositoryFileReader
import com.optum.sourcehawk.core.data.Verbosity
+import com.optum.sourcehawk.core.repository.RemoteRepositoryFileReader
import spock.lang.Specification
import java.nio.file.Paths
@@ -54,15 +55,15 @@ class ExecOptionsSpec extends Specification {
!execOptions.remoteRef
}
- def "builder - github"() {
+ def "builder - remote"() {
given:
- RemoteRef remoteRef = RemoteRef.parse(RemoteRef.Type.GITHUB, "owner/repo@main")
+ RemoteRef remoteRef = RemoteRef.parse("owner/repo", "main")
ExecOptions.ExecOptionsBuilder builder = ExecOptions.builder()
.repositoryRoot(Paths.get("/"))
.configurationFileLocation("Sourcehawk")
.verbosity(Verbosity.ZERO)
.failOnWarnings(true)
- .repositoryFileReader(new GithubRepositoryFileReader("token", remoteRef))
+ .repositoryFileReader(new RemoteRepositoryFileReader("https://raw.githubusercontent.com/owner/repo/main/%s", Collections.emptyMap()))
.remoteRef(remoteRef)
when:
@@ -75,7 +76,7 @@ class ExecOptionsSpec extends Specification {
execOptions.verbosity == Verbosity.ZERO
!execOptions.tags
execOptions.failOnWarnings
- execOptions.repositoryFileReader instanceof GithubRepositoryFileReader
+ execOptions.repositoryFileReader instanceof RemoteRepositoryFileReader
execOptions.remoteRef == remoteRef
}
diff --git a/exec/src/test/resources/sourcehawk-flattened-base.yml b/exec/src/test/resources/sourcehawk-flattened-base.yml
index b250224..2a183f9 100644
--- a/exec/src/test/resources/sourcehawk-flattened-base.yml
+++ b/exec/src/test/resources/sourcehawk-flattened-base.yml
@@ -53,4 +53,4 @@ file-protocols:
enforcers:
- enforcer: ".common.StringPropertyEquals"
property-name: "distributionUrl"
- expected-property-value: "https://apache.claz.org/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.zip"
+ expected-property-value: "https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.8.4/apache-maven-3.8.4-bin.zip"
diff --git a/pom.xml b/pom.xml
index 8ecf522..39b2b17 100644
--- a/pom.xml
+++ b/pom.xml
@@ -11,7 +11,7 @@
sourcehawk
- 0.6.0-SNAPSHOT
+ 0.7.0-SNAPSHOT
pom
Sourcehawk
@@ -28,7 +28,7 @@
0.97
- 1.7.30
+ 1.7.32
e1
@@ -108,13 +108,19 @@
org.spockframework
spock-core
- 2.0-M3-groovy-3.0
+ 2.0-groovy-3.0
+ test
+
+
+ org.codehaus.groovy
+ groovy
+ ${groovy.version}
test
junit
junit
- 4.13.1
+ 4.13.2
test
@@ -207,6 +213,7 @@
distributions-build
+ 11
ci.build