Skip to content

Commit 5ea93d3

Browse files
ClaudenwRyanSkraba
Claudenw
and
RyanSkraba
committed
Fix commons PMD errors (#539)
Co-authored-by: Ryan Skraba <[email protected]>
1 parent 930b1ad commit 5ea93d3

File tree

6 files changed

+45
-64
lines changed

6 files changed

+45
-64
lines changed

‎commons/src/test/java/io/aiven/kafka/connect/common/config/FileNameFragmentTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ void allConfigDefsAccountForTest() {
7777
names.remove(FileNameFragment.DEFAULT_FILENAME_TEMPLATE);
7878
// TODO remove this when we understand what it is for.
7979
names.remove(FileNameFragment.FILE_PATH_PREFIX_TEMPLATE_CONFIG);
80-
configDefSource().map(a -> (String) (a.get()[0])).forEach(names::remove);
80+
configDefSource().map(a -> (String) a.get()[0]).forEach(names::remove);
8181
assertThat(names.isEmpty())
8282
.as(() -> "Tests do not process the following arguments: " + String.join(", ", names))
8383
.isTrue();

‎commons/src/testFixtures/java/io/aiven/commons/kafka/testkit/KafkaConnectRunner.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ public void restartConnector(final String connectorName) {
286286
* @return the default set of worker properties.
287287
*/
288288
public Map<String, String> getWorkerProperties(final Class<? extends Connector> connectorClass) {
289-
Map<String, String> workerProperties = new HashMap<>();
289+
final Map<String, String> workerProperties = new HashMap<>();
290290
workerProperties.put(ConnectorConfig.KEY_CONVERTER_CLASS_CONFIG, ByteArrayConverter.class.getName());
291291
workerProperties.put(ConnectorConfig.VALUE_CONVERTER_CLASS_CONFIG, ByteArrayConverter.class.getCanonicalName());
292292
workerProperties.put(WorkerConfig.OFFSET_COMMIT_INTERVAL_MS_CONFIG,

‎commons/src/testFixtures/java/io/aiven/kafka/connect/common/config/ParquetTestingFixture.java‎

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,11 @@
1616

1717
package io.aiven.kafka.connect.common.config;
1818

19-
import static org.apache.kafka.connect.data.Schema.INT32_SCHEMA;
20-
import static org.apache.kafka.connect.data.Schema.STRING_SCHEMA;
21-
2219
import java.io.IOException;
23-
import java.io.OutputStream;
24-
import java.nio.file.Files;
2520
import java.nio.file.Path;
26-
import java.util.ArrayList;
27-
import java.util.Collections;
28-
import java.util.List;
2921

3022
import io.aiven.kafka.connect.common.format.ParquetTestDataFixture;
31-
import org.apache.kafka.common.record.TimestampType;
3223
import org.apache.kafka.connect.data.Schema;
33-
import org.apache.kafka.connect.data.SchemaBuilder;
34-
import org.apache.kafka.connect.data.Struct;
35-
import org.apache.kafka.connect.sink.SinkRecord;
36-
37-
import io.aiven.kafka.connect.common.output.parquet.ParquetOutputWriter;
38-
39-
import org.testcontainers.shaded.org.apache.commons.io.function.IOSupplier;
4024

4125
/**
4226
* Test fixture to generate standard parquet file.
@@ -49,7 +33,7 @@ public final class ParquetTestingFixture {
4933
public final static Schema PARQUET_SCHEMA = ParquetTestDataFixture.PARQUET_SCHEMA;
5034

5135
private ParquetTestingFixture() {
52-
// do int instantiate
36+
// do not instantiate
5337
}
5438

5539
/**

‎commons/src/testFixtures/java/io/aiven/kafka/connect/common/format/ParquetTestDataFixture.java‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@
3737
import io.aiven.kafka.connect.common.config.OutputField;
3838
import io.aiven.kafka.connect.common.config.OutputFieldEncodingType;
3939
import io.aiven.kafka.connect.common.config.OutputFieldType;
40-
import io.aiven.kafka.connect.common.config.ParquetTestingFixture;
4140
import io.aiven.kafka.connect.common.output.parquet.ParquetOutputWriter;
4241

4342
import org.apache.avro.Schema;
@@ -48,7 +47,6 @@
4847
import org.apache.parquet.io.InputFile;
4948
import org.apache.parquet.io.SeekableInputStream;
5049
import org.testcontainers.shaded.org.apache.commons.io.FileUtils;
51-
import org.testcontainers.shaded.org.apache.commons.io.function.IOSupplier;
5250

5351
/**
5452
* A testing feature to generate/read Parquet data.

‎commons/src/testFixtures/java/io/aiven/kafka/connect/common/source/AbstractSourceRecordIteratorTest.java‎

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ public abstract class AbstractSourceRecordIteratorTest<K extends Comparable<K>,
8888
* the key value as a string.
8989
* @return the native key equivalent of the {@code key} parameter.
9090
*/
91-
abstract protected K createKFrom(final String key);
91+
abstract protected K createKFrom(String key);
9292

9393
/**
9494
* Create the instance of the source record iterator to be tested.
@@ -102,7 +102,7 @@ public abstract class AbstractSourceRecordIteratorTest<K extends Comparable<K>,
102102
* @return A configured AbstractSourceRecordIterator.
103103
*/
104104
abstract protected AbstractSourceRecordIterator<K, N, O, T> createSourceRecordIterator(
105-
final SourceCommonConfig mockConfig, final OffsetManager<O> offsetManager, final Transformer transformer);
105+
SourceCommonConfig mockConfig, OffsetManager<O> offsetManager, Transformer transformer);
106106

107107
/**
108108
* Create a client mutator that will add testing data to the iterator under test.
@@ -122,8 +122,8 @@ abstract protected AbstractSourceRecordIterator<K, N, O, T> createSourceRecordIt
122122

123123
@BeforeEach
124124
public void setUp() {
125-
SourceTaskContext sourceTaskContext = mock(SourceTaskContext.class);
126-
OffsetStorageReader offsetStorageReader = mock(OffsetStorageReader.class);
125+
final SourceTaskContext sourceTaskContext = mock(SourceTaskContext.class);
126+
final OffsetStorageReader offsetStorageReader = mock(OffsetStorageReader.class);
127127
when(offsetStorageReader.offset(anyMap())).thenReturn(Collections.emptyMap());
128128
when(offsetStorageReader.offsets(anyCollection())).thenReturn(Collections.emptyMap());
129129
when(sourceTaskContext.offsetStorageReader()).thenReturn(offsetStorageReader);
@@ -147,7 +147,7 @@ public void setUp() {
147147
*/
148148
protected SourceCommonConfig mockSourceConfig(final String filePattern, final int taskId, final int maxTasks,
149149
final String targetTopic) {
150-
SourceCommonConfig mockConfig = createMockedConfig();
150+
final SourceCommonConfig mockConfig = createMockedConfig();
151151
when(mockConfig.getDistributionType()).thenReturn(DistributionType.OBJECT_HASH);
152152
when(mockConfig.getTaskId()).thenReturn(taskId);
153153
when(mockConfig.getMaxTasks()).thenReturn(maxTasks);
@@ -160,14 +160,13 @@ protected SourceCommonConfig mockSourceConfig(final String filePattern, final in
160160
@ParameterizedTest(name = "{index} {0}")
161161
@MethodSource("inputFormatList")
162162
void testEmptyClientReturnsEmptyIterator(final InputFormat format, final byte[] ignore) {
163-
Transformer transformer = TransformerFactory.getTransformer(format);
164-
165-
SourceCommonConfig mockConfig = mockSourceConfig(FILE_PATTERN, 0, 1, null);
163+
final Transformer transformer = TransformerFactory.getTransformer(format);
164+
final SourceCommonConfig mockConfig = mockSourceConfig(FILE_PATTERN, 0, 1, null);
166165
when(mockConfig.getInputFormat()).thenReturn(format);
167166

168167
// verify empty is empty.
169168
createClientMutator().build();
170-
AbstractSourceRecordIterator<K, N, O, T> iterator = createSourceRecordIterator(mockConfig, offsetManager,
169+
final AbstractSourceRecordIterator<K, N, O, T> iterator = createSourceRecordIterator(mockConfig, offsetManager,
171170
transformer);
172171
assertThat(iterator).isExhausted();
173172
assertThatThrownBy(iterator::next).isInstanceOf(NoSuchElementException.class);
@@ -176,13 +175,13 @@ void testEmptyClientReturnsEmptyIterator(final InputFormat format, final byte[]
176175
@ParameterizedTest(name = "{index} {0}")
177176
@MethodSource("inputFormatList")
178177
void testOneObjectReturnsOneObject(final InputFormat format, final byte[] data) {
179-
Transformer transformer = TransformerFactory.getTransformer(format);
180-
SourceCommonConfig mockConfig = mockSourceConfig(FILE_PATTERN, 0, 1, null);
178+
final Transformer transformer = TransformerFactory.getTransformer(format);
179+
final SourceCommonConfig mockConfig = mockSourceConfig(FILE_PATTERN, 0, 1, null);
181180
when(mockConfig.getInputFormat()).thenReturn(format);
182181

183182
// verify one data has one data
184183
createClientMutator().reset().addObject(key, ByteBuffer.wrap(data)).endOfBlock().build();
185-
AbstractSourceRecordIterator<K, N, O, T> iterator = createSourceRecordIterator(mockConfig, offsetManager,
184+
final AbstractSourceRecordIterator<K, N, O, T> iterator = createSourceRecordIterator(mockConfig, offsetManager,
186185
transformer);
187186
assertThat(iterator).hasNext();
188187
assertThat(iterator.next()).isNotNull();
@@ -192,13 +191,13 @@ void testOneObjectReturnsOneObject(final InputFormat format, final byte[] data)
192191

193192
@Test
194193
void testThrowsExceptionWhenNextOnEmptyIterator() {
195-
Transformer transformer = TransformerFactory.getTransformer(InputFormat.BYTES);
196-
SourceCommonConfig mockConfig = mockSourceConfig(FILE_PATTERN, 0, 1, null);
194+
final Transformer transformer = TransformerFactory.getTransformer(InputFormat.BYTES);
195+
final SourceCommonConfig mockConfig = mockSourceConfig(FILE_PATTERN, 0, 1, null);
197196
when(mockConfig.getInputFormat()).thenReturn(InputFormat.BYTES);
198197

199198
// verify empty is empty.
200199
createClientMutator().build();
201-
AbstractSourceRecordIterator<K, N, O, T> iterator = createSourceRecordIterator(mockConfig, offsetManager,
200+
final AbstractSourceRecordIterator<K, N, O, T> iterator = createSourceRecordIterator(mockConfig, offsetManager,
202201
transformer);
203202
assertThatThrownBy(iterator::next).isInstanceOf(NoSuchElementException.class);
204203
}
@@ -212,9 +211,9 @@ void testThrowsExceptionWhenNextOnEmptyIterator() {
212211
*/
213212
@SuppressWarnings("PMD.DataflowAnomalyAnalysis")
214213
static List<Arguments> inputFormatList() throws IOException {
215-
List<Arguments> result = new ArrayList<>();
214+
final List<Arguments> result = new ArrayList<>();
216215
byte[] bytes;
217-
for (InputFormat format : InputFormat.values()) {
216+
for (final InputFormat format : InputFormat.values()) {
218217
switch (format) {
219218
case BYTES :
220219
bytes = "Hello World".getBytes(StandardCharsets.UTF_8);
@@ -240,22 +239,22 @@ static List<Arguments> inputFormatList() throws IOException {
240239
@MethodSource("multiInputFormatList")
241240
void testMultipleRecordsReturned(final InputFormat format, final byte[] data) {
242241
createClientMutator().reset().addObject(key, ByteBuffer.wrap(data)).endOfBlock().build();
243-
Transformer transformer = TransformerFactory.getTransformer(format);
242+
final Transformer transformer = TransformerFactory.getTransformer(format);
244243
final SourceCommonConfig config = mockSourceConfig(FILE_PATTERN, 0, 1, null);
245244
when(config.getTransformerMaxBufferSize()).thenReturn(4096);
246245
when(config.getInputFormat()).thenReturn(format);
247-
AbstractSourceRecordIterator<K, N, O, T> iterator = createSourceRecordIterator(config, offsetManager,
246+
final AbstractSourceRecordIterator<K, N, O, T> iterator = createSourceRecordIterator(config, offsetManager,
248247
transformer);
249248

250249
// check first entry
251250
assertThat(iterator.hasNext()).isTrue();
252-
T t = iterator.next();
253-
assertThat(t.getRecordCount()).isEqualTo(1);
251+
T sourceRecord = iterator.next();
252+
assertThat(sourceRecord.getRecordCount()).isEqualTo(1);
254253

255254
// check 2nd entry
256255
assertThat(iterator.hasNext()).isTrue();
257-
t = iterator.next();
258-
assertThat(t.getRecordCount()).isEqualTo(2);
256+
sourceRecord = iterator.next();
257+
assertThat(sourceRecord.getRecordCount()).isEqualTo(2);
259258

260259
// check complete
261260
assertThat(iterator).isExhausted();
@@ -269,11 +268,11 @@ void testMultipleRecordsReturned(final InputFormat format, final byte[] data) {
269268
* @throws IOException
270269
* on data creation error.
271270
*/
272-
@SuppressWarnings("PMD.DataflowAnomalyAnalysis")
271+
@SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops")
273272
static List<Arguments> multiInputFormatList() throws IOException {
274-
List<Arguments> result = new ArrayList<>();
273+
final List<Arguments> result = new ArrayList<>();
275274
byte[] bytes;
276-
for (InputFormat format : InputFormat.values()) {
275+
for (final InputFormat format : InputFormat.values()) {
277276
switch (format) {
278277
case BYTES :
279278
bytes = new byte[4096 * 2];
@@ -310,25 +309,25 @@ void testIteratorProcessesMultipleObjectsFromByteArrayTransformer() {
310309
}
311310
createClientMutator().reset().addObject(key, ByteBuffer.wrap(testData)).endOfBlock().build();
312311

313-
Transformer transformer = TransformerFactory.getTransformer(InputFormat.BYTES);
312+
final Transformer transformer = TransformerFactory.getTransformer(InputFormat.BYTES);
314313
final SourceCommonConfig config = mockSourceConfig(FILE_PATTERN, 0, 1, null);
315314
when(config.getTransformerMaxBufferSize()).thenReturn(4096);
316315
when(config.getInputFormat()).thenReturn(InputFormat.BYTES);
317-
AbstractSourceRecordIterator<K, N, O, T> iterator = createSourceRecordIterator(config, offsetManager,
316+
final AbstractSourceRecordIterator<K, N, O, T> iterator = createSourceRecordIterator(config, offsetManager,
318317
transformer);
319318

320319
// check first entry
321320
assertThat(iterator.hasNext()).isTrue();
322-
T t = iterator.next();
323-
assertThat(t.getRecordCount()).isEqualTo(1);
324-
byte[] value = (byte[]) t.getValue().value();
321+
T sourceRecord = iterator.next();
322+
assertThat(sourceRecord.getRecordCount()).isEqualTo(1);
323+
byte[] value = (byte[]) sourceRecord.getValue().value();
325324
assertThat(value).as("Initial block match the first 4096 bytes").isEqualTo(Arrays.copyOf(testData, 4096));
326325

327326
// check 2nd entry
328327
assertThat(iterator.hasNext()).isTrue();
329-
t = iterator.next();
330-
assertThat(t.getRecordCount()).isEqualTo(2);
331-
value = (byte[]) t.getValue().value();
328+
sourceRecord = iterator.next();
329+
assertThat(sourceRecord.getRecordCount()).isEqualTo(2);
330+
value = (byte[]) sourceRecord.getValue().value();
332331
assertThat(value).as("Second block should match the remaining bytes")
333332
.isEqualTo(Arrays.copyOfRange(testData, 4096, 6000));
334333

@@ -406,7 +405,7 @@ abstract public static class ClientMutator<N, K extends Comparable<K>, T extends
406405
* the data to associate with the object.
407406
* @return An object of type N.
408407
*/
409-
abstract protected N createObject(final K key, final ByteBuffer data);
408+
abstract protected N createObject(K key, ByteBuffer data);
410409

411410
/**
412411
* Extracts the blocks from the mutator and creates a client that will return the blocks in order on calls to

‎commons/src/testFixtures/java/io/aiven/kafka/connect/common/source/AbstractSourceRecordTest.java‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public abstract class AbstractSourceRecordTest<N, K extends Comparable<K>, O ext
6060
* the key value as a string.
6161
* @return the native key equivalent of the {@code key} parameter.
6262
*/
63-
abstract protected K createKFrom(final String key);
63+
abstract protected K createKFrom(String key);
6464

6565
/**
6666
* Create an offset manager entry from the string key value,
@@ -69,7 +69,7 @@ public abstract class AbstractSourceRecordTest<N, K extends Comparable<K>, O ext
6969
* the key value as a string.
7070
* @return an OffsetManager entry.
7171
*/
72-
abstract protected O createOffsetManagerEntry(final String key);
72+
abstract protected O createOffsetManagerEntry(String key);
7373

7474
/**
7575
* Creates the source record under test.
@@ -156,7 +156,7 @@ void testModifyingInitialContextDoesNotAlterTheSourceRecordsContext() {
156156
@Test
157157
void testModifyingInitialOffsetManagerEntryDoesNotAlterTheSourceRecordsOffsetManagerEntry() {
158158
O offsetManagerEntry = createOffsetManagerEntry(TEST_OBJECT_KEY_TXT);
159-
Context<K> context = new Context<>(createKFrom(TEST_OBJECT_KEY_TXT));
159+
final Context<K> context = new Context<>(createKFrom(TEST_OBJECT_KEY_TXT));
160160
context.setPartition(3);
161161
context.setTopic(TEST_TOPIC);
162162

@@ -179,9 +179,9 @@ void testModifyingInitialOffsetManagerEntryDoesNotAlterTheSourceRecordsOffsetMan
179179

180180
@Test
181181
void testDuplicateMethod() {
182-
O offsetManagerEntry = createOffsetManagerEntry(TEST_OBJECT_KEY_TXT);
182+
final O offsetManagerEntry = createOffsetManagerEntry(TEST_OBJECT_KEY_TXT);
183183
offsetManagerEntry.incrementRecordCount();
184-
Context<K> context = new Context<>(createKFrom(TEST_OBJECT_KEY_TXT));
184+
final Context<K> context = new Context<>(createKFrom(TEST_OBJECT_KEY_TXT));
185185
context.setPartition(3);
186186
context.setTopic(TEST_TOPIC);
187187

@@ -213,15 +213,15 @@ void testDuplicateMethod() {
213213

214214
@Test
215215
void offsetManagerEntryTest() {
216-
O offsetManagerEntry = createOffsetManagerEntry(TEST_OBJECT_KEY_TXT);
216+
final O offsetManagerEntry = createOffsetManagerEntry(TEST_OBJECT_KEY_TXT);
217217
assertThat(offsetManagerEntry.getRecordCount()).isEqualTo(0);
218-
OffsetManager.OffsetManagerKey key = offsetManagerEntry.getManagerKey();
218+
final OffsetManager.OffsetManagerKey key = offsetManagerEntry.getManagerKey();
219219

220220
offsetManagerEntry.incrementRecordCount();
221221
assertThat(offsetManagerEntry.getRecordCount()).isEqualTo(1);
222222
assertThat(offsetManagerEntry.getManagerKey().getPartitionMap()).isEqualTo(key.getPartitionMap());
223223

224-
O offsetManagerEntry2 = offsetManagerEntry.fromProperties(offsetManagerEntry.getProperties());
224+
final O offsetManagerEntry2 = offsetManagerEntry.fromProperties(offsetManagerEntry.getProperties());
225225
assertThat(offsetManagerEntry2.getRecordCount()).isEqualTo(1);
226226
assertThat(offsetManagerEntry2.getManagerKey().getPartitionMap()).isEqualTo(key.getPartitionMap());
227227

0 commit comments

Comments
 (0)