#36 We assume a configured proxy only if username/password are set

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

Author: Weltraumschaf

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

@@ -18,22 +18,39 @@
  * </p>
  */
 public final class ProxyConfigFactory {
+    static final ProxyConfig DEFAULT_CONFIG = ProxyConfig.NULL;
     private final SystemPropertyFinder properties = new SystemPropertyFinder();
 
+    /**
+     * Creates a configuration based on {@link ProxyConfigNames environment variables}
+     * <p>
+     * We assume a complete proxy configuration only if {@link ProxyConfigNames#HTTP_PROXY_USER user} and
+     * {@link ProxyConfigNames#HTTP_PROXY_PASSWORD password} is configured. Unless an
+     * {@link #DEFAULT_CONFIG} configuration will be returned.
+     * </p>
+     * <p>
+     * Throws {@link MissingProxyConfigValue}, if not all configuration values are present.
+     * </p>
+     *
+     * @return never {@code null}
+     */
     public ProxyConfig create() {
-        final var builder = ProxyConfig.builder();
-
-        if (properties.notHasProperty(ProxyConfigNames.HTTP_PROXY_USER)) {
-            throw new MissingProxyConfigValue(ProxyConfigNames.HTTP_PROXY_USER);
+        if (shouldCreateFromProperties()) {
+            return createFromProperties();
         }
 
-        builder.user(properties.getProperty(ProxyConfigNames.HTTP_PROXY_USER));
+        return DEFAULT_CONFIG;
+    }
 
-        if (properties.notHasProperty(ProxyConfigNames.HTTP_PROXY_PASSWORD)) {
-            throw new MissingProxyConfigValue(ProxyConfigNames.HTTP_PROXY_PASSWORD);
-        }
+    private boolean shouldCreateFromProperties() {
+        return properties.hasProperty(ProxyConfigNames.HTTP_PROXY_USER) &&
+                properties.hasProperty(ProxyConfigNames.HTTP_PROXY_PASSWORD);
+    }
 
-        builder.password(properties.getProperty(ProxyConfigNames.HTTP_PROXY_PASSWORD));
+    private ProxyConfig createFromProperties() {
+        final var builder = ProxyConfig.builder()
+                .user(properties.getProperty(ProxyConfigNames.HTTP_PROXY_USER))
+                .password(properties.getProperty(ProxyConfigNames.HTTP_PROXY_PASSWORD));
 
         if (properties.notHasProperty(ProxyConfigNames.HTTP_PROXY_HOST)) {
             throw new MissingProxyConfigValue(ProxyConfigNames.HTTP_PROXY_HOST);
@@ -49,10 +66,10 @@ public ProxyConfig create() {
             builder.port(Integer.parseInt(properties.getProperty(ProxyConfigNames.HTTP_PROXY_PORT)));
         } catch (final NumberFormatException e) {
             throw new IllegalArgumentException(
-                String.format("Given port for proxy authentication configuration (property '%s') is not a valid number! Given value wa '%s'.",
-                    ProxyConfigNames.HTTP_PROXY_PORT.getLiterat(),
-                    System.getProperty("http.proxyPort")),
-                e);
+                    String.format("Given port for proxy authentication configuration (property '%s') is not a valid number! Given value wa '%s'.",
+                            ProxyConfigNames.HTTP_PROXY_PORT.getLiterat(),
+                            System.getProperty("http.proxyPort")),
+                    e);
         }
 
         return builder.build();

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

@@ -24,74 +24,82 @@ class ProxyConfigFactoryTest {
     private final ProxyConfigFactory sut = new ProxyConfigFactory();
 
     @Test
-    void create_throesExceptionIfUserNotSet() {
-        System.clearProperty(ProxyConfigNames.HTTP_PROXY_USER.getLiterat());
-        System.setProperty(ProxyConfigNames.HTTP_PROXY_PASSWORD.getLiterat(), "password");
-        System.setProperty(ProxyConfigNames.HTTP_PROXY_HOST.getLiterat(), "host");
-        System.setProperty(ProxyConfigNames.HTTP_PROXY_PORT.getLiterat(), "4242");
+    void create_returnsDefaultIfUserAndPasswordNotPresent() {
+        assertThat(sut.create(), is(ProxyConfigFactory.DEFAULT_CONFIG));
+    }
 
-        final var thrown = assertThrows(
-            MissingProxyConfigValue.class,
-            sut::create);
+    @Test
+    void create_returnsDefaultIfUserNotPresent() {
+        System.setProperty(ProxyConfigNames.HTTP_PROXY_USER.getLiterat(), "user");
 
-        assertThat(thrown.getMessage(), containsString("'http.proxyUser'"));
+        assertThat(sut.create(), is(ProxyConfigFactory.DEFAULT_CONFIG));
     }
 
     @Test
-    void create_throesExceptionIfPasswordNotSet() {
+    void create_returnsDefaultIfPasswordNotPresent() {
+        System.setProperty(ProxyConfigNames.HTTP_PROXY_PASSWORD.getLiterat(), "password");
+
+        assertThat(sut.create(), is(ProxyConfigFactory.DEFAULT_CONFIG));
+    }
+
+    @Test
+    void create_returnsCompleteConfigIfAllPropertiesArePresent() {
         System.setProperty(ProxyConfigNames.HTTP_PROXY_USER.getLiterat(), "user");
-        System.clearProperty(ProxyConfigNames.HTTP_PROXY_PASSWORD.getLiterat());
+        System.setProperty(ProxyConfigNames.HTTP_PROXY_PASSWORD.getLiterat(), "password");
         System.setProperty(ProxyConfigNames.HTTP_PROXY_HOST.getLiterat(), "host");
         System.setProperty(ProxyConfigNames.HTTP_PROXY_PORT.getLiterat(), "4242");
 
-        final var thrown = assertThrows(
-            MissingProxyConfigValue.class,
-            sut::create);
+        final var expected = ProxyConfig.builder()
+                .user("user")
+                .password("password")
+                .host("host")
+                .port(4242)
+                .build();
 
-        assertThat(thrown.getMessage(), containsString("'http.proxyPassword'"));
+        assertThat(sut.create(), is(expected));
     }
 
     @Test
-    void create_throesExceptionIfHostNotSet() {
+    void create_throwsExceptionIfHostNotSet() {
         System.setProperty(ProxyConfigNames.HTTP_PROXY_USER.getLiterat(), "user");
         System.setProperty(ProxyConfigNames.HTTP_PROXY_PASSWORD.getLiterat(), "password");
         System.clearProperty(ProxyConfigNames.HTTP_PROXY_HOST.getLiterat());
         System.setProperty(ProxyConfigNames.HTTP_PROXY_PORT.getLiterat(), "4242");
 
         final var thrown = assertThrows(
-            MissingProxyConfigValue.class,
-            sut::create);
+                MissingProxyConfigValue.class,
+                sut::create);
 
         assertThat(thrown.getMessage(), containsString("'http.proxyHost'"));
     }
 
     @Test
-    void create_throesExceptionIfPortNotSet() {
+    void create_throwsExceptionIfPortNotSet() {
         System.setProperty(ProxyConfigNames.HTTP_PROXY_USER.getLiterat(), "user");
         System.setProperty(ProxyConfigNames.HTTP_PROXY_PASSWORD.getLiterat(), "password");
         System.setProperty(ProxyConfigNames.HTTP_PROXY_HOST.getLiterat(), "host");
         System.clearProperty(ProxyConfigNames.HTTP_PROXY_PORT.getLiterat());
 
         final var thrown = assertThrows(
-            MissingProxyConfigValue.class,
-            sut::create);
+                MissingProxyConfigValue.class,
+                sut::create);
 
         assertThat(thrown.getMessage(), containsString("'http.proxyPort'"));
     }
 
     @Test
-    void create_throesExceptionIfPortIsNotInteger() {
+    void create_throwsExceptionIfPortIsNotInteger() {
         System.setProperty(ProxyConfigNames.HTTP_PROXY_USER.getLiterat(), "user");
         System.setProperty(ProxyConfigNames.HTTP_PROXY_PASSWORD.getLiterat(), "password");
         System.setProperty(ProxyConfigNames.HTTP_PROXY_HOST.getLiterat(), "host");
         System.setProperty(ProxyConfigNames.HTTP_PROXY_PORT.getLiterat(), "FUBAR");
 
         final var thrown = assertThrows(
-            IllegalArgumentException.class,
-            sut::create);
+                IllegalArgumentException.class,
+                sut::create);
 
         assertThat(
-            thrown.getMessage(),
-            is("Given port for proxy authentication configuration (property 'http.proxyPort') is not a valid number! Given value wa 'FUBAR'."));
+                thrown.getMessage(),
+                is("Given port for proxy authentication configuration (property 'http.proxyPort') is not a valid number! Given value wa 'FUBAR'."));
     }
 }