[FLINK-15810] Add more description for FlinkKafkaProducerMigrationOpe…

…ratorTest
silenceland · Feb 3, 2020 · e6eea61 · e6eea61
1 parent d8164e1
commit e6eea61
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/.../org/apache/flink/streaming/connectors/kafka/FlinkKafkaProducerMigrationOperatorTest.java b/.../org/apache/flink/streaming/connectors/kafka/FlinkKafkaProducerMigrationOperatorTest.java
@@ -28,6 +28,11 @@
 
 /**
  * Migration test from FlinkKafkaProducer011 operator.
+ * This test depends on the resource generated by {@link FlinkKafkaProducer011MigrationTest#writeSnapshot()}.
+ *
+ * <p>Warning: We need to rename the generated resource based on the file naming pattern specified by
+ * the {@link #getOperatorSnapshotPath(MigrationVersion)} method then
+ * copy the resource to the path also specified by the {@link #getOperatorSnapshotPath(MigrationVersion)} method.
  */
 public class FlinkKafkaProducerMigrationOperatorTest extends FlinkKafkaProducerMigrationTest {
 	@Parameterized.Parameters(name = "Migration Savepoint: {0}")
@@ -46,11 +51,6 @@ public String getOperatorSnapshotPath(MigrationVersion version) {
 		return "src/test/resources/kafka-0.11-migration-kafka-producer-flink-" + version + "-snapshot";
 	}
 
-	/**
-	 * This test depends on the resources generated by {@link FlinkKafkaProducer011MigrationTest}.
-	 * Run {@link FlinkKafkaProducer011MigrationTest#writeSnapshot()} and copy the created resource
-	 * file to the path specified by the {@link #getOperatorSnapshotPath(MigrationVersion)} method.
-	 */
 	@Ignore
 	@Override
 	public void writeSnapshot() throws Exception {