You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by ch...@apache.org on 2017/06/02 13:14:21 UTC

[3/6] flink git commit: [FLINK-6793] Activate checkstyle for runtime/metrics

http://git-wip-us.apache.org/repos/asf/flink/blob/2b3d284b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskManagerGroupTest.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskManagerGroupTest.java b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskManagerGroupTest.java
index 11f3c0f..bd85303 100644
--- a/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskManagerGroupTest.java
+++ b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskManagerGroupTest.java
@@ -39,6 +39,9 @@ import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 
+/**
+ * Tests for the {@link TaskManagerMetricGroup}.
+ */
 public class TaskManagerGroupTest extends TestLogger {
 
 	// ------------------------------------------------------------------------
@@ -74,24 +77,24 @@ public class TaskManagerGroupTest extends TestLogger {
 			jid1, jobName1, vertex12, execution12, "test", 13, 1);
 		TaskMetricGroup tmGroup21 = group.addTaskForJob(
 			jid2, jobName2, vertex21, execution21, "test", 7, 2);
-		
+
 		assertEquals(2, group.numRegisteredJobMetricGroups());
 		assertFalse(tmGroup11.parent().isClosed());
 		assertFalse(tmGroup12.parent().isClosed());
 		assertFalse(tmGroup21.parent().isClosed());
-		
+
 		// close all for job 2 and one from job 1
 		tmGroup11.close();
 		tmGroup21.close();
 		assertTrue(tmGroup11.isClosed());
 		assertTrue(tmGroup21.isClosed());
-		
+
 		// job 2 should be removed, job should still be there
 		assertFalse(tmGroup11.parent().isClosed());
 		assertFalse(tmGroup12.parent().isClosed());
 		assertTrue(tmGroup21.parent().isClosed());
 		assertEquals(1, group.numRegisteredJobMetricGroups());
-		
+
 		// add one more to job one
 		TaskMetricGroup tmGroup13 = group.addTaskForJob(
 			jid1, jobName1, vertex13, execution13, "test", 0, 0);
@@ -101,7 +104,7 @@ public class TaskManagerGroupTest extends TestLogger {
 		assertTrue(tmGroup11.parent().isClosed());
 		assertTrue(tmGroup12.parent().isClosed());
 		assertTrue(tmGroup13.parent().isClosed());
-		
+
 		assertEquals(0, group.numRegisteredJobMetricGroups());
 
 		registry.shutdown();
@@ -111,8 +114,7 @@ public class TaskManagerGroupTest extends TestLogger {
 	public void testCloseClosesAll() throws IOException {
 		MetricRegistry registry = new MetricRegistry(MetricRegistryConfiguration.defaultMetricRegistryConfiguration());
 		final TaskManagerMetricGroup group = new TaskManagerMetricGroup(
-				registry, "localhost", new AbstractID().toString());
-
+			registry, "localhost", new AbstractID().toString());
 
 		final JobID jid1 = new JobID();
 		final JobID jid2 = new JobID();
@@ -136,14 +138,14 @@ public class TaskManagerGroupTest extends TestLogger {
 			jid2, jobName2, vertex21, execution21, "test", 7, 1);
 
 		group.close();
-		
+
 		assertTrue(tmGroup11.isClosed());
 		assertTrue(tmGroup12.isClosed());
 		assertTrue(tmGroup21.isClosed());
 
 		registry.shutdown();
 	}
-	
+
 	// ------------------------------------------------------------------------
 	//  scope name tests
 	// ------------------------------------------------------------------------
@@ -153,7 +155,7 @@ public class TaskManagerGroupTest extends TestLogger {
 		MetricRegistry registry = new MetricRegistry(MetricRegistryConfiguration.defaultMetricRegistryConfiguration());
 		TaskManagerMetricGroup group = new TaskManagerMetricGroup(registry, "localhost", "id");
 
-		assertArrayEquals(new String[] { "localhost", "taskmanager", "id" }, group.getScopeComponents());
+		assertArrayEquals(new String[]{"localhost", "taskmanager", "id"}, group.getScopeComponents());
 		assertEquals("localhost.taskmanager.id.name", group.getMetricIdentifier("name"));
 		registry.shutdown();
 	}
@@ -165,7 +167,7 @@ public class TaskManagerGroupTest extends TestLogger {
 		MetricRegistry registry = new MetricRegistry(MetricRegistryConfiguration.fromConfiguration(cfg));
 		TaskManagerMetricGroup group = new TaskManagerMetricGroup(registry, "host", "id");
 
-		assertArrayEquals(new String[] { "constant", "host", "foo", "host" }, group.getScopeComponents());
+		assertArrayEquals(new String[]{"constant", "host", "foo", "host"}, group.getScopeComponents());
 		assertEquals("constant.host.foo.host.name", group.getMetricIdentifier("name"));
 		registry.shutdown();
 	}

http://git-wip-us.apache.org/repos/asf/flink/blob/2b3d284b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskManagerJobGroupTest.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskManagerJobGroupTest.java b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskManagerJobGroupTest.java
index f9891cb..fc0ce5c 100644
--- a/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskManagerJobGroupTest.java
+++ b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskManagerJobGroupTest.java
@@ -22,16 +22,19 @@ import org.apache.flink.api.common.JobID;
 import org.apache.flink.configuration.Configuration;
 import org.apache.flink.configuration.MetricOptions;
 import org.apache.flink.runtime.metrics.MetricRegistry;
-
 import org.apache.flink.runtime.metrics.MetricRegistryConfiguration;
 import org.apache.flink.runtime.metrics.dump.QueryScopeInfo;
 import org.apache.flink.runtime.metrics.util.DummyCharacterFilter;
 import org.apache.flink.util.TestLogger;
+
 import org.junit.Test;
 
 import static org.junit.Assert.assertArrayEquals;
 import static org.junit.Assert.assertEquals;
 
+/**
+ * Tests for the {@link TaskManagerJobMetricGroup}.
+ */
 public class TaskManagerJobGroupTest extends TestLogger {
 
 	@Test

http://git-wip-us.apache.org/repos/asf/flink/blob/2b3d284b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskMetricGroupTest.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskMetricGroupTest.java b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskMetricGroupTest.java
index 183237a..22b0a1a 100644
--- a/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskMetricGroupTest.java
+++ b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/groups/TaskMetricGroupTest.java
@@ -28,12 +28,16 @@ import org.apache.flink.runtime.metrics.dump.QueryScopeInfo;
 import org.apache.flink.runtime.metrics.util.DummyCharacterFilter;
 import org.apache.flink.util.AbstractID;
 import org.apache.flink.util.TestLogger;
+
 import org.junit.Test;
 
 import static org.junit.Assert.assertArrayEquals;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 
+/**
+ * Tests for the {@link TaskMetricGroup}.
+ */
 public class TaskMetricGroupTest extends TestLogger {
 
 	// ------------------------------------------------------------------------
@@ -51,7 +55,7 @@ public class TaskMetricGroupTest extends TestLogger {
 		TaskMetricGroup taskGroup = new TaskMetricGroup(registry, jmGroup, vertexId, executionId, "aTaskName", 13, 2);
 
 		assertArrayEquals(
-				new String[] { "theHostName", "taskmanager", "test-tm-id", "myJobName", "aTaskName", "13"},
+				new String[]{"theHostName", "taskmanager", "test-tm-id", "myJobName", "aTaskName", "13"},
 				taskGroup.getScopeComponents());
 
 		assertEquals(
@@ -78,7 +82,7 @@ public class TaskMetricGroupTest extends TestLogger {
 				registry, jmGroup, vertexId, executionId, "aTaskName", 13, 2);
 
 		assertArrayEquals(
-				new String[] { "test-tm-id", jid.toString(), vertexId.toString(), executionId.toString() },
+				new String[]{"test-tm-id", jid.toString(), vertexId.toString(), executionId.toString()},
 				taskGroup.getScopeComponents());
 
 		assertEquals(
@@ -102,7 +106,7 @@ public class TaskMetricGroupTest extends TestLogger {
 				registry, jmGroup, new AbstractID(), executionId, "aTaskName", 13, 1);
 
 		assertArrayEquals(
-				new String[] { "theHostName", "taskmanager", "test-tm-id", "myJobName", executionId.toString(), "13" },
+				new String[]{"theHostName", "taskmanager", "test-tm-id", "myJobName", executionId.toString(), "13"},
 				taskGroup.getScopeComponents());
 
 		assertEquals(

http://git-wip-us.apache.org/repos/asf/flink/blob/2b3d284b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/DummyCharacterFilter.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/DummyCharacterFilter.java b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/DummyCharacterFilter.java
index 601f734..15bf718 100644
--- a/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/DummyCharacterFilter.java
+++ b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/DummyCharacterFilter.java
@@ -15,10 +15,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.apache.flink.runtime.metrics.util;
 
 import org.apache.flink.metrics.CharacterFilter;
 
+/**
+ * A {@link CharacterFilter} that returns the given string without any modification.
+ */
 public class DummyCharacterFilter implements CharacterFilter {
 	@Override
 	public String filterCharacters(String input) {

http://git-wip-us.apache.org/repos/asf/flink/blob/2b3d284b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/TestReporter.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/TestReporter.java b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/TestReporter.java
index cd96c60..e5e09d4 100644
--- a/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/TestReporter.java
+++ b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/TestReporter.java
@@ -23,6 +23,9 @@ import org.apache.flink.metrics.MetricConfig;
 import org.apache.flink.metrics.MetricGroup;
 import org.apache.flink.metrics.reporter.AbstractReporter;
 
+/**
+ * No-op reporter implementation.
+ */
 public class TestReporter extends AbstractReporter {
 
 	@Override

http://git-wip-us.apache.org/repos/asf/flink/blob/2b3d284b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/TestingHistogram.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/TestingHistogram.java b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/TestingHistogram.java
index 82f8504..8565ed3 100644
--- a/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/TestingHistogram.java
+++ b/flink-runtime/src/test/java/org/apache/flink/runtime/metrics/util/TestingHistogram.java
@@ -15,11 +15,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.apache.flink.runtime.metrics.util;
 
 import org.apache.flink.metrics.Histogram;
 import org.apache.flink.metrics.HistogramStatistics;
 
+/**
+ * Stateless test histogram for which all methods return a static value.
+ */
 public class TestingHistogram implements Histogram {
 
 	@Override