#36 Add class to hold proxy configuration

will be used later to remove code duplication in the services.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>

Author: Weltraumschaf

src/main/java/io/securecodebox/persistence/defectdojo/http/ProxyConfig.java

@@ -0,0 +1,84 @@
+package io.securecodebox.persistence.defectdojo.http;
+
+import lombok.Builder;
+import lombok.Value;
+
+/**
+ * Holds HTTP proxy configuration
+ * <p>
+ * This class is immutable by design and therefor thread safe. As defaults it does not use |{@code null} to prevent null
+ * pointer exceptions. It utilizes sane defaults (empty string or 0) to indicate a not set value. Also it introduces a
+ * null-object to indicate a not-existing configuration.
+ * </p>
+ */
+@Value
+@Builder
+class ProxyConfig {
+    /**
+     * Null pattern object.
+     */
+    static final ProxyConfig NULL = ProxyConfig.builder().build();
+    private static final String DEFAULT_STRING = "";
+    private static final int DEFAULT_INT = 0;
+
+    /**
+     * Username to authenticate on a proxy.
+     * <p>
+     * Defaults to empty string.
+     * </p>
+     */
+    @Builder.Default
+    String user = DEFAULT_STRING;
+
+    /**
+     * Password to authenticate on a proxy.
+     * <p>
+     * Defaults to empty string.
+     * </p>
+     */
+    @Builder.Default
+    String password = DEFAULT_STRING;
+
+    /**
+     * Host name of the proxy.
+     * <p>
+     * Defaults to empty string.
+     * </p>
+     */
+    @Builder.Default
+    String host = DEFAULT_STRING;
+
+    /**
+     * Port of the proxy.
+     * <p>
+     * Defaults to 0 (zero).
+     * </p>
+     */
+    @Builder.Default
+    int port = DEFAULT_INT;
+
+    /**
+     *  configuration is considered complete if all values are not default values
+     *
+     * @return {@code true} if all values are set else {@code false}
+     */
+    boolean isComplete() {
+        if (getUser().equals(DEFAULT_STRING)) {
+            return false;
+        }
+
+        if (getPassword().equals(DEFAULT_STRING)) {
+            return false;
+        }
+
+        if (getHost().equals(DEFAULT_STRING)) {
+            return false;
+        }
+
+        if (getPort() == DEFAULT_INT) {
+            return false;
+        }
+
+        return true;
+    }
+}

src/test/java/io/securecodebox/persistence/defectdojo/http/ProxyConfigTest.java

@@ -0,0 +1,83 @@
+package io.securecodebox.persistence.defectdojo.http;
+
+import nl.jqno.equalsverifier.EqualsVerifier;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import java.util.stream.Stream;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.*;
+
+/**
+ * Tests for {@link ProxyConfig}
+ */
+class ProxyConfigTest {
+    @Test
+    void equalsAndHashCode() {
+        EqualsVerifier.forClass(ProxyConfig.class).verify();
+    }
+
+    @Test
+    void builderCreatesDefault() {
+        final var sut = ProxyConfig.builder().build();
+
+        assertAll(
+            () -> assertThat(sut.getUser(), is(emptyString())),
+            () -> assertThat(sut.getPassword(), is(emptyString())),
+            () -> assertThat(sut.getHost(), is(emptyString())),
+            () -> assertThat(sut.getPort(), is(0))
+        );
+    }
+
+    @Test
+    void buildersDefaultIsEqualToNullObject() {
+        assertThat(ProxyConfig.builder().build(), is(ProxyConfig.NULL));
+    }
+
+    @Test
+    void isComplete_falseForNullObject() {
+        assertThat(ProxyConfig.NULL.isComplete(), is(false));
+    }
+
+    @Test
+    void isComplete_falseForDefault() {
+        assertThat(ProxyConfig.builder().build().isComplete(), is(false));
+    }
+
+    @ParameterizedTest
+    @MethodSource("incompleteConfigs")
+    void isComplete_falseUnlessAllFieldsAreSet(final ProxyConfig sut) {
+
+    }
+
+    private static Stream<Arguments> incompleteConfigs() {
+        return Stream.of(
+            // Only one is set:
+            Arguments.of(ProxyConfig.builder().user("user").build()),
+            Arguments.of(ProxyConfig.builder().password("pw").build()),
+            Arguments.of(ProxyConfig.builder().host("host").build()),
+            Arguments.of(ProxyConfig.builder().port(42).build()),
+            // All but one is set:
+            Arguments.of(ProxyConfig.builder().password("pwd").host("host").port(42).build()),
+            Arguments.of(ProxyConfig.builder().user("user").host("host").port(42).build()),
+            Arguments.of(ProxyConfig.builder().user("user").password("pwd").port(42).build()),
+            Arguments.of(ProxyConfig.builder().user("user").password("pwd").host("host").build())
+        );
+    }
+
+    @Test
+    void isComplete_trueIfAllFieldsAreNonDefaults() {
+        final var sut = ProxyConfig.builder()
+            .user("user")
+            .password("pw")
+            .host("host")
+            .port(42)
+            .build();
+
+        assertThat(sut.isComplete(), is(true));
+    }
+}