cleanup

Crim · Crim · commit 076d368ee66c · 2020-07-06T18:22:28.000+09:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,15 @@
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.7.0 (UNRELEASED)
+#### New Features
+- [PR-225](https://github.com/SourceLabOrg/kafka-webview/pull/225)
+  - Adds the ability to set custom kafka client properties when defining a cluster.
+  - Adds a new debugging tool under `/configuration/cluster` to see the generated kafka client properties.
+
+#### Internal Dependency Updates
+- Updated Kafka Client library version from 2.0.1 to 2.2.2.
+
 ## 2.6.0 (06/21/2020)
 - [ISSUE-144](https://github.com/SourceLabOrg/kafka-webview/issues/144) Make providing a TrustStore file when setting up a SSL enabled cluster optional.  You might not want/need this option if your JVM is already configured to accept the SSL certificate served by the cluster, or if the cluster's certificate can be validated by a publically accessible CA.
 - [PR-215](https://github.com/SourceLabOrg/kafka-webview/pull/215) Improve errors displayed when using the `test cluster` functionality.
diff --git a/dev-cluster/src/main/java/org/sourcelab/kafka/devcluster/DevCluster.java b/dev-cluster/src/main/java/org/sourcelab/kafka/devcluster/DevCluster.java
@@ -47,7 +47,6 @@
 import org.slf4j.LoggerFactory;
 
 import java.net.URL;
-import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
diff --git a/dev-cluster/src/main/java/org/sourcelab/kafka/devcluster/LdapServer.java b/dev-cluster/src/main/java/org/sourcelab/kafka/devcluster/LdapServer.java
@@ -28,7 +28,6 @@
 import com.unboundid.ldap.listener.InMemoryDirectoryServerConfig;
 import com.unboundid.ldap.listener.InMemoryListenerConfig;
 import com.unboundid.ldap.sdk.LDAPException;
-import com.unboundid.ldap.sdk.OperationType;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
diff --git a/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/controller/cluster/ClusterController.java b/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/controller/cluster/ClusterController.java
@@ -29,11 +29,9 @@
 import org.sourcelab.kafka.webview.ui.manager.ui.FlashMessage;
 import org.sourcelab.kafka.webview.ui.manager.ui.datatable.Datatable;
 import org.sourcelab.kafka.webview.ui.manager.ui.datatable.DatatableColumn;
-import org.sourcelab.kafka.webview.ui.manager.ui.datatable.DatatableFilter;
 import org.sourcelab.kafka.webview.ui.manager.ui.datatable.LinkTemplate;
 import org.sourcelab.kafka.webview.ui.manager.ui.datatable.YesNoBadgeTemplate;
 import org.sourcelab.kafka.webview.ui.model.Cluster;
-import org.sourcelab.kafka.webview.ui.model.View;
 import org.sourcelab.kafka.webview.ui.repository.ClusterRepository;
 import org.sourcelab.kafka.webview.ui.repository.ViewRepository;
 import org.springframework.beans.factory.annotation.Autowired;
diff --git a/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/controller/configuration/cluster/ClusterConfigController.java b/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/controller/configuration/cluster/ClusterConfigController.java
@@ -26,16 +26,13 @@
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import org.apache.kafka.common.config.SslConfigs;
 import org.apache.kafka.common.errors.TimeoutException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.sourcelab.kafka.webview.ui.controller.BaseController;
 import org.sourcelab.kafka.webview.ui.controller.configuration.cluster.forms.ClusterForm;
-import org.sourcelab.kafka.webview.ui.controller.configuration.messageformat.forms.MessageFormatForm;
 import org.sourcelab.kafka.webview.ui.manager.SensitiveConfigScrubber;
 import org.sourcelab.kafka.webview.ui.manager.encryption.SecretManager;
-import org.sourcelab.kafka.webview.ui.manager.kafka.KafkaAdminFactory;
 import org.sourcelab.kafka.webview.ui.manager.kafka.KafkaClientConfigUtil;
 import org.sourcelab.kafka.webview.ui.manager.kafka.KafkaOperations;
 import org.sourcelab.kafka.webview.ui.manager.kafka.KafkaOperationsFactory;
@@ -58,7 +55,6 @@
 
 import javax.validation.Valid;
 import java.io.IOException;
-import java.util.Arrays;
 import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.Map;
@@ -573,7 +569,7 @@ public String getClientConfig(
         model.addAttribute("configs", configs);
         model.addAttribute("cluster", cluster);
 
-        // redirect to cluster index
+        // Render cluster config template
         return "configuration/cluster/config";
     }
 
diff --git a/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/controller/view/ViewController.java b/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/controller/view/ViewController.java
@@ -34,7 +34,6 @@
 import org.sourcelab.kafka.webview.ui.model.Cluster;
 import org.sourcelab.kafka.webview.ui.model.View;
 import org.sourcelab.kafka.webview.ui.repository.ClusterRepository;
-import org.sourcelab.kafka.webview.ui.repository.MessageFormatRepository;
 import org.sourcelab.kafka.webview.ui.repository.ViewRepository;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.data.domain.Pageable;
diff --git a/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/SensitiveConfigScrubber.java b/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/SensitiveConfigScrubber.java
@@ -26,8 +26,6 @@
 
 import org.apache.kafka.common.config.SaslConfigs;
 import org.apache.kafka.common.config.SslConfigs;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.sourcelab.kafka.webview.ui.manager.sasl.SaslProperties;
 import org.sourcelab.kafka.webview.ui.manager.sasl.SaslUtility;
 import org.sourcelab.kafka.webview.ui.model.Cluster;
@@ -36,30 +34,29 @@
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Objects;
 
 /**
  * Utility class for removing sensitive values from generated kafka client configuration.
  */
 public class SensitiveConfigScrubber {
-    private static final Logger logger = LoggerFactory.getLogger(SensitiveConfigScrubber.class);
 
     private final SaslUtility saslUtility;
 
     @Autowired
     public SensitiveConfigScrubber(final SaslUtility saslUtility) {
-        this.saslUtility = saslUtility;
+        this.saslUtility = Objects.requireNonNull(saslUtility);
     }
 
-
     /**
      * Given a Kafka Client Config, scrub any sensentivie fields from the config and return a copy.
      * @param config The config to scrub.
-     * @param cluster The cluster associated with the config.
+     * @param cluster (optional) The cluster associated with the config.
      * @return Copy of scrubbed configuration.
      */
-    public Map<String, Object> filterSensitiveOptions(
-        final Map<String, Object> config, final Cluster cluster
-    ) {
+    public Map<String, Object> filterSensitiveOptions(final Map<String, Object> config, final Cluster cluster) {
+        Objects.requireNonNull(config);
+
         // Create a copy of the map
         final Map<String, Object> copy = new HashMap<>(config);
 
@@ -75,9 +72,12 @@ public Map<String, Object> filterSensitiveOptions(
         if (copy.containsKey(SaslConfigs.SASL_JAAS_CONFIG) && cluster != null) {
             final SaslProperties saslProperties = saslUtility.decodeProperties(cluster);
 
-            String jaasConfig = (String) copy.get(SaslConfigs.SASL_JAAS_CONFIG);
-            jaasConfig = jaasConfig.replaceAll(saslProperties.getPlainPassword(), "**HIDDEN**");
-            copy.put(SaslConfigs.SASL_JAAS_CONFIG, jaasConfig);
+            // Only replace if plainPassword field set and non-empty.
+            if (saslProperties.getPlainPassword() != null && !saslProperties.getPlainPassword().isEmpty()) {
+                String jaasConfig = (String) copy.get(SaslConfigs.SASL_JAAS_CONFIG);
+                jaasConfig = jaasConfig.replaceAll(saslProperties.getPlainPassword(), "**HIDDEN**");
+                copy.put(SaslConfigs.SASL_JAAS_CONFIG, jaasConfig);
+            }
         }
 
         // Return copy of the map.
diff --git a/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/kafka/KafkaClientConfigUtil.java b/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/kafka/KafkaClientConfigUtil.java
@@ -32,10 +32,8 @@
 import org.apache.kafka.common.config.SslConfigs;
 import org.apache.kafka.common.security.auth.SecurityProtocol;
 import org.sourcelab.kafka.webview.ui.manager.kafka.config.ClusterConfig;
-import org.sourcelab.kafka.webview.ui.model.Cluster;
 
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Comparator;
 import java.util.HashMap;
 import java.util.HashSet;
diff --git a/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/ui/datatable/Datatable.java b/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/ui/datatable/Datatable.java
@@ -31,7 +31,6 @@
 import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
 
 import javax.persistence.criteria.Path;
-import javax.persistence.criteria.Predicate;
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
@@ -46,8 +45,6 @@
 import java.util.Objects;
 import java.util.Set;
 
-import static org.sourcelab.kafka.webview.ui.manager.ui.datatable.ConstraintOperator.EQUALS;
-
 /**
  * Aims to be a re-usable datatable UI component backed by a JPA Repository.
  * @param <T> Type of object being rendered in the datatable.
diff --git a/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/ui/datatable/DatatableColumn.java b/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/ui/datatable/DatatableColumn.java
@@ -29,7 +29,6 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.function.Function;
-import java.util.stream.Collectors;
 
 /**
  * Defines a column within a datatable.
diff --git a/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/repository/ClusterRepository.java b/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/repository/ClusterRepository.java
@@ -25,9 +25,6 @@
 package org.sourcelab.kafka.webview.ui.repository;
 
 import org.sourcelab.kafka.webview.ui.model.Cluster;
-import org.sourcelab.kafka.webview.ui.model.View;
-import org.springframework.data.domain.Page;
-import org.springframework.data.domain.Pageable;
 import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
 import org.springframework.data.repository.CrudRepository;
 import org.springframework.stereotype.Repository;
diff --git a/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/repository/UserRepository.java b/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/repository/UserRepository.java
@@ -25,7 +25,6 @@
 package org.sourcelab.kafka.webview.ui.repository;
 
 import org.sourcelab.kafka.webview.ui.model.User;
-import org.sourcelab.kafka.webview.ui.model.View;
 import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
 import org.springframework.data.repository.CrudRepository;
 import org.springframework.stereotype.Repository;
diff --git a/kafka-webview-ui/src/main/resources/templates/cluster/index.html b/kafka-webview-ui/src/main/resources/templates/cluster/index.html
@@ -2,7 +2,6 @@
 <html
     xmlns:layout="http://www.ultraq.net.nz/thymeleaf/layout"
     xmlns:th="http://www.thymeleaf.org"
-    xmlns:sec="http://www.thymeleaf.org/thymeleaf-extras-springsecurity4"
     layout:decorate="~{layout}">
 
 <head>
diff --git a/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/controller/configuration/cluster/ClusterConfigControllerTest.java b/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/controller/configuration/cluster/ClusterConfigControllerTest.java
@@ -101,10 +101,11 @@ public void setupUploadPath() {
     @Transactional
     public void test_withoutAdminRole() throws Exception {
         testUrlWithOutAdminRole("/configuration/cluster", false);
-        testUrlWithOutAdminRole("/configuration/filter/create", false);
-        testUrlWithOutAdminRole("/configuration/filter/edit/1", false);
-        testUrlWithOutAdminRole("/configuration/filter/update", true);
-        testUrlWithOutAdminRole("/configuration/filter/delete/1", true);
+        testUrlWithOutAdminRole("/configuration/cluster/create", false);
+        testUrlWithOutAdminRole("/configuration/cluster/edit/1", false);
+        testUrlWithOutAdminRole("/configuration/cluster/update", true);
+        testUrlWithOutAdminRole("/configuration/cluster/delete/1", true);
+        testUrlWithOutAdminRole("/configuration/cluster/config/1", false);
     }
 
     /**
diff --git a/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/manager/SensitiveConfigScrubberTest.java b/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/manager/SensitiveConfigScrubberTest.java
@@ -0,0 +1,87 @@
+package org.sourcelab.kafka.webview.ui.manager;
+
+import org.apache.kafka.common.config.SaslConfigs;
+import org.apache.kafka.common.config.SslConfigs;
+import org.junit.Before;
+import org.junit.Test;
+import org.sourcelab.kafka.webview.ui.manager.encryption.SecretManager;
+import org.sourcelab.kafka.webview.ui.manager.sasl.SaslProperties;
+import org.sourcelab.kafka.webview.ui.manager.sasl.SaslUtility;
+import org.sourcelab.kafka.webview.ui.model.Cluster;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotEquals;
+import static org.junit.Assert.assertNotSame;
+
+public class SensitiveConfigScrubberTest {
+
+    /**
+     * Instance under test.
+     */
+    private SensitiveConfigScrubber scrubber;
+
+    /**
+     * Dependency.
+     */
+    private SaslUtility saslUtility;
+
+    /**
+     * Setup.
+     */
+    @Before
+    public void setup() {
+        this.saslUtility = new SaslUtility(new SecretManager("NotARealSecret"));
+        this.scrubber = new SensitiveConfigScrubber(saslUtility);
+    }
+
+    /**
+     * Smoke test filterSensitiveOptions method.
+     */
+    @Test
+    public void smokeTest() {
+        final String secretPhrase = "secret";
+
+        final SaslProperties saslProperties = new SaslProperties("Username", secretPhrase, "Anything", "Something");
+
+        // Create cluster
+        final Cluster cluster = new Cluster();
+        cluster.setName("My Test Cluster");
+        cluster.setSaslConfig(saslUtility.encryptProperties(saslProperties));
+
+
+        // Create a mock config
+        final Map<String, Object> mockConfig = new HashMap<>();
+        mockConfig.put("Key1", "Value1");
+        mockConfig.put("Key2", "Value2");
+
+        // Add "sensitive" fields
+        mockConfig.put(SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG, secretPhrase);
+        mockConfig.put(SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG, secretPhrase);
+        mockConfig.put(SaslConfigs.SASL_JAAS_CONFIG, "Anything anything " + secretPhrase + " something");
+
+        // Call method under test
+        final Map<String, Object> scrubbed = scrubber.filterSensitiveOptions(mockConfig, cluster);
+
+        // Verify we have a new instance.
+        assertNotSame("Should be different instances", scrubbed, mockConfig);
+
+        // Verify keys
+        assertEquals(scrubbed.get("Key1"), mockConfig.get("Key1"));
+        assertEquals(scrubbed.get("Key2"), mockConfig.get("Key2"));
+
+        // Sensitive fields no longer match
+        assertNotEquals(scrubbed.get(SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG), mockConfig.get(SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG));
+        assertEquals("**HIDDEN**", scrubbed.get(SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG));
+        assertNotEquals(scrubbed.get(SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG), mockConfig.get(SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG));
+        assertEquals("**HIDDEN**", scrubbed.get(SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG));
+
+        assertNotEquals(scrubbed.get(SaslConfigs.SASL_JAAS_CONFIG), mockConfig.get(SaslConfigs.SASL_JAAS_CONFIG));
+        assertFalse(
+            ((String)scrubbed.get(SaslConfigs.SASL_JAAS_CONFIG)).contains(secretPhrase)
+        );
+    }
+}
