Rename interface method and fix travis tests

Crim · web-flow · commit 7be85d62f071 · 2018-01-06T12:19:14.000+09:00
diff --git a/.travis.yml b/.travis.yml
@@ -1,4 +1,10 @@
 language: java
 sudo: false
 jdk:
-  - oraclejdk8
+  - oraclejdk8
+cache:
+  directories:
+  - $HOME/.m2
+  - kafka-webview-ui/src/main/frontend/node_modules/
+before_script:
+  - mkdir -p ./data/uploads
diff --git a/kafka-webview-plugin/src/main/java/org/sourcelab/kafka/webview/ui/plugin/filter/RecordFilter.java b/kafka-webview-plugin/src/main/java/org/sourcelab/kafka/webview/ui/plugin/filter/RecordFilter.java
@@ -50,7 +50,7 @@ default Set<String> getOptionNames() {
     /**
      * Configure this class.
      * @param consumerConfigs Consumer configuration in key/value pairs
-     * @param filterOptions User defined filter options.
+     * @param filterOptions User defined options for the implementation.
      */
     void configure(final Map<String, ?> consumerConfigs, final Map<String, String> filterOptions);
 
@@ -66,7 +66,7 @@ default Set<String> getOptionNames() {
      * @param value Deserialized Value object.
      * @return True means the record WILL be shown.  False means the record will NOT be shown.
      */
-    boolean filter(final String topic, final int partition, final long offset, final Object key, final Object value);
+    boolean includeRecord(final String topic, final int partition, final long offset, final Object key, final Object value);
 
     /**
      * Called on closing.
diff --git a/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/kafka/filter/RecordFilterInterceptor.java b/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/kafka/filter/RecordFilterInterceptor.java
@@ -64,7 +64,7 @@ public ConsumerRecords onConsume(final ConsumerRecords records) {
             // Iterate through filters
             for (final RecordFilterDefinition recordFilterDefinition : recordFilterDefinitions) {
                 // Pass through filter
-                result = recordFilterDefinition.getRecordFilter().filter(
+                result = recordFilterDefinition.getRecordFilter().includeRecord(
                     record.topic(),
                     record.partition(),
                     record.offset(),
diff --git a/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/ui/FlashMessage.java b/kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/ui/FlashMessage.java
@@ -30,7 +30,6 @@
 public class FlashMessage {
     private final String type;
     private final String message;
-    private boolean warning;
 
     private FlashMessage(final String type, final String message) {
         this.type = type;
@@ -77,4 +76,11 @@ public static FlashMessage newDanger(final String message) {
         return new FlashMessage("danger", message);
     }
 
+    @Override
+    public String toString() {
+        return "FlashMessage{"
+            + "type='" + type + '\''
+            + ", message='" + message + '\''
+            + '}';
+    }
 }
diff --git a/kafka-webview-ui/src/main/resources/templates/home/helpContent.html b/kafka-webview-ui/src/main/resources/templates/home/helpContent.html
@@ -210,7 +210,7 @@ <h2>Writing Custom Filters</h2>
 </em><em style="color:#629755; font-style:italic">     * </em><em style="color:#629755; font-style:italic; font-weight:bold">@param </em><em style="color:#8a653b; font-style:italic">value </em><em style="color:#629755; font-style:italic">Deserialized Value object.
 </em><em style="color:#629755; font-style:italic">     * </em><em style="color:#629755; font-style:italic; font-weight:bold">@return </em><em style="color:#629755; font-style:italic">True means the record WILL be shown.  False means the record will NOT be shown.
 </em><em style="color:#629755; font-style:italic">     */
-</em><em style="color:#629755; font-style:italic">    </em><span style="color:#cc7832">boolean </span><span style="color:#ffc66d">filter</span>(<span style="color:#cc7832">final </span>String topic<span style="color:#cc7832">, final int </span>partition<span style="color:#cc7832">, final long </span>offset<span style="color:#cc7832">, final </span>Object key<span style="color:#cc7832">, final </span>Object value)<span style="color:#cc7832">;
+</em><em style="color:#629755; font-style:italic">    </em><span style="color:#cc7832">boolean </span><span style="color:#ffc66d">includeRecord</span>(<span style="color:#cc7832">final </span>String topic<span style="color:#cc7832">, final int </span>partition<span style="color:#cc7832">, final long </span>offset<span style="color:#cc7832">, final </span>Object key<span style="color:#cc7832">, final </span>Object value)<span style="color:#cc7832">;
 </span>
 <span style="color:#cc7832">    </span><em style="color:#629755; font-style:italic">/**
 </em><em style="color:#629755; font-style:italic">     * Called on closing.
diff --git a/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/controller/configuration/AbstractMvcTest.java b/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/controller/configuration/AbstractMvcTest.java
@@ -60,7 +60,7 @@ public abstract class AbstractMvcTest {
     protected UserDetails adminUserDetails;
 
     protected User nonAdminUser;
-    protected UserDetails nonAdminUserDetials;
+    protected UserDetails nonAdminUserDetails;
 
     /**
      * Where JKS files are uploaded to.
@@ -78,7 +78,7 @@ public void setupAuth() {
 
         // Create non-admin user
         nonAdminUser = userTestTools.createUser();
-        nonAdminUserDetials = customUserDetailsService.loadUserByUsername(nonAdminUser.getEmail());
+        nonAdminUserDetails = customUserDetailsService.loadUserByUsername(nonAdminUser.getEmail());
 
         // Define upload path
         uploadPath = appProperties.getUploadPath();
@@ -99,7 +99,7 @@ protected void testUrlWithOutAdminRole(final String url, final boolean isPost) t
         }
 
         mockMvc
-            .perform(action.with(user(nonAdminUserDetials)))
+            .perform(action.with(user(nonAdminUserDetails)))
             .andDo(print())
             .andExpect(status().isForbidden());
     }
diff --git a/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/controller/configuration/user/UserControllerTest.java b/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/controller/configuration/user/UserControllerTest.java
@@ -123,7 +123,7 @@ public void testLoadEditForOtherUserAsAdminUser() throws Exception {
     public void testLoadEditSelfAsNonAdminUser() throws Exception {
         // Hit edit page for same user as logged in with.
         mockMvc
-            .perform(get("/configuration/user/edit/" + nonAdminUser.getId()).with(user(nonAdminUserDetials)))
+            .perform(get("/configuration/user/edit/" + nonAdminUser.getId()).with(user(nonAdminUserDetails)))
             .andDo(print())
             .andExpect(status().isOk())
 
@@ -142,7 +142,7 @@ public void testLoadEditSelfAsNonAdminUser() throws Exception {
     public void testLoadEditAnotherUserAsNonAdminUserIsBlocked() throws Exception {
         // Hit edit page for same user as logged in with.
         mockMvc
-            .perform(get("/configuration/user/edit/" + adminUser.getId()).with(user(nonAdminUserDetials)))
+            .perform(get("/configuration/user/edit/" + adminUser.getId()).with(user(nonAdminUserDetails)))
             .andDo(print())
             .andExpect(status().is3xxRedirection())
             .andExpect(redirectedUrl("/"));
diff --git a/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/manager/kafka/KafkaConsumerFactoryTest.java b/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/manager/kafka/KafkaConsumerFactoryTest.java
@@ -344,7 +344,7 @@ public void configure(final Map<String, ?> consumerConfigs, final Map<String, St
         }
 
         @Override
-        public boolean filter(final String topic, final int partition, final long offset, final Object key, final Object value) {
+        public boolean includeRecord(final String topic, final int partition, final long offset, final Object key, final Object value) {
             // Filter partition 0 records
             if (partition == 0) {
                 return false;
diff --git a/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/manager/kafka/WebKafkaConsumerFactoryTest.java b/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/manager/kafka/WebKafkaConsumerFactoryTest.java
@@ -311,7 +311,7 @@ public void configure(final Map<String, ?> consumerConfigs, final Map<String, St
         }
 
         @Override
-        public boolean filter(final String topic, final int partition, final long offset, final Object key, final Object value) {
+        public boolean includeRecord(final String topic, final int partition, final long offset, final Object key, final Object value) {
             return partition != partition;
         }
 
diff --git a/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/manager/kafka/filter/RecordFilterInterceptorTest.java b/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/manager/kafka/filter/RecordFilterInterceptorTest.java
@@ -104,8 +104,8 @@ public void testPassThrough() {
         final RecordFilter mockFilter1 = mock(RecordFilter.class);
         final RecordFilter mockFilter2 = mock(RecordFilter.class);
 
-        when(mockFilter1.filter(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject())).thenReturn(true);
-        when(mockFilter2.filter(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject())).thenReturn(true);
+        when(mockFilter1.includeRecord(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject())).thenReturn(true);
+        when(mockFilter2.includeRecord(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject())).thenReturn(true);
 
         final RecordFilterDefinition recordFilterDefinition1 = new RecordFilterDefinition(mockFilter1, new HashMap<>());
         final RecordFilterDefinition recordFilterDefinition2 = new RecordFilterDefinition(mockFilter2, new HashMap<>());
@@ -131,9 +131,9 @@ public void testPassThrough() {
 
         // Verify mocks
         verify(mockFilter1, times(totalRecords))
-            .filter(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject());
+            .includeRecord(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject());
         verify(mockFilter2, times(totalRecords))
-            .filter(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject());
+            .includeRecord(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject());
     }
 
     /**
@@ -147,9 +147,9 @@ public void testFilterMessages() {
         final RecordFilter mockFilter1 = mock(RecordFilter.class);
         final RecordFilter mockFilter2 = mock(RecordFilter.class);
 
-        when(mockFilter1.filter(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject()))
+        when(mockFilter1.includeRecord(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject()))
             .thenReturn(true, false, true, true, true);
-        when(mockFilter2.filter(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject()))
+        when(mockFilter2.includeRecord(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject()))
             .thenReturn(true, true, false, true);
 
         final RecordFilterDefinition recordFilterDefinition1 = new RecordFilterDefinition(mockFilter1, new HashMap<>());
@@ -182,9 +182,9 @@ public void testFilterMessages() {
 
         // Verify mocks
         verify(mockFilter1, times(totalRecords))
-            .filter(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject());
+            .includeRecord(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject());
         verify(mockFilter2, times(totalRecords - 1))
-            .filter(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject());
+            .includeRecord(eq("MyTopic"), eq(0), anyLong(), anyObject(), anyObject());
     }
 
     private ConsumerRecords createConsumerRecords(final int count) {
diff --git a/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/manager/plugin/PluginClassLoaderTest.java b/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/manager/plugin/PluginClassLoaderTest.java
@@ -61,7 +61,7 @@ public void testLoadingFilterPlugin() throws ClassNotFoundException, IllegalAcce
         final long offset = 2423L;
         final Object key = "key";
         final Object value = "{name='Bob', value='value'}";
-        filter.filter(topic, partition, offset, key, value);
+        filter.includeRecord(topic, partition, offset, key, value);
 
         // Validate it came from our classloader, more of a sanity test.
         assertTrue("Should have our parent class loader", filter.getClass().getClassLoader() instanceof PluginClassLoader);
diff --git a/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/manager/plugin/PluginFactoryTest.java b/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/manager/plugin/PluginFactoryTest.java
@@ -74,7 +74,7 @@ public void testWithRecordFilter() throws LoaderException {
         assertEquals("Has correct name", classPath, recordFilter.getClass().getName());
 
         // Call method on interface
-        recordFilter.filter("topic", 1, 1L, "Key", "Value");
+        recordFilter.includeRecord("topic", 1, 1L, "Key", "Value");
     }
 
     /**
diff --git a/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/tools/FileTestTools.java b/kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/tools/FileTestTools.java
@@ -38,6 +38,9 @@ public class FileTestTools {
      * @param contents Contents of the file
      */
     public static void createDummyFile(final String filename, final String contents) throws IOException {
+        // Ensure parent directories exist
+        Files.createDirectories(Paths.get(filename).getParent());
+
         try (final FileOutputStream outputStream = new FileOutputStream(filename)) {
             outputStream.write(contents.getBytes(Charsets.UTF_8));
         }
diff --git a/kafka-webview-ui/src/test/resources/testDeserializer/testPlugins.jar b/kafka-webview-ui/src/test/resources/testDeserializer/testPlugins.jar

Original file line number	Diff line number	Diff line change
`@@ -344,7 +344,7 @@ public void configure(final Map<String, ?> consumerConfigs, final Map<String, St`
`344`	`344`	`}`
`345`	`345`
`346`	`346`	`@Override`
`347`		`- public boolean filter(final String topic, final int partition, final long offset, final Object key, final Object value) {`
	`347`	`+ public boolean includeRecord(final String topic, final int partition, final long offset, final Object key, final Object value) {`
`348`	`348`	`// Filter partition 0 records`
`349`	`349`	`if (partition == 0) {`
`350`	`350`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -311,7 +311,7 @@ public void configure(final Map<String, ?> consumerConfigs, final Map<String, St`
`311`	`311`	`}`
`312`	`312`
`313`	`313`	`@Override`
`314`		`- public boolean filter(final String topic, final int partition, final long offset, final Object key, final Object value) {`
	`314`	`+ public boolean includeRecord(final String topic, final int partition, final long offset, final Object key, final Object value) {`
`315`	`315`	`return partition != partition;`
`316`	`316`	`}`
`317`	`317`