Skip to content

Commit

Permalink
#285 issue remove iterator behaviour from the sequences (#291)
Browse files Browse the repository at this point in the history 
* #285 Removed iterator behaviour from sequences

* #285 Updated documentation and upped pom version

* #285 Solved some codacy problems

* #285 Solved some codacy problems

* #285 Solved some codacy problems
  • Loading branch information
@IsaUlloa
IsaUlloa authored Aug 26, 2022
1 parent e9b92c8 commit f556037
Show file tree
Hide file tree
Showing 10 changed files with 49 additions and 56 deletions.
6 changes: 4 additions & 2 deletions docs/schemas.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,15 @@ A special type has also been created, `seq`, to allow creating a custom sequence

In order to create a sequence, you need to specify `seq` as **Field Type**.

> In previous versions (up to 4.0.0), typing `{` in **Field Value List** was another requirement in order to create sequences. This is no longer required or supported.
> In previous versions (up to 4.0.0), typing `{` in **Field Values List** was another requirement in order to create sequences. This is no longer required or supported.
| Type | Details | Returns |
|----------|-------------------------------------------------------------------------------|--------|
| seq | Generates a numeric sequence starting in 1. Will cast to the AVRO Field Type. | Returns a sequence starting in 1 |

**Note:** If you want to specify a starting value, put it in the first position in the **Field Values List** field. The other values within the field will be considered constants for this field and converted to the corresponding field type.
**Note:** If you want to specify a starting value, put it in the **Field Values List** field.

> Sequences don't accept more than one value in the **Field Values List** field.
> Keep in mind to avoid Cast exceptions.
Expand Down
2 changes: 1 addition & 1 deletion pom-maven-central.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<artifactId>kloadgen</artifactId>

<version>4.13.1</version>
<version>5.0.0</version>
<name>KLoadGen</name>
<description>Load Generation Jmeter plugin for Kafka Cluster. Supporting AVRO, JSON Schema and Protobuf schema types. Generate Artificial data based on Data specification</description>
<url>https://corunet.github.io/kloadgen/</url>
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<artifactId>kloadgen</artifactId>

<version>4.13.1</version>
<version>5.0.0</version>
<name>KLoadGen</name>
<description>Load Generation Jmeter plugin for Kafka Cluster. Supporting AVRO, JSON Schema and Protobuf schema types. Generate Artificial data base on Data specification</description>
<url>https://corunet.github.io/kloadgen/</url>
Expand Down
13 changes: 5 additions & 8 deletions src/main/java/net/coru/kloadgen/randomtool/generator/AvroGeneratorTool.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,8 @@ public final Object generateObject(final Schema schema, final String fieldName,
} else if ("seq".equalsIgnoreCase(fieldType)) {
final String type = Type.UNION.getName().equals(ValueUtils.getValidTypeFromSchema(schema)) ? getRecordUnion(schema.getTypes()).getName()
: ValueUtils.getValidTypeFromSchema(schema);
if (!fieldValuesList.isEmpty() && (fieldValuesList.size() > 1 || RandomSequence.isTypeNotSupported(type))) {
value = RandomSequence.generateSequenceForFieldValueList(fieldName, type, fieldValuesList, context);
} else {
value = RandomSequence.generateSeq(fieldName, type, parameterList, context);
}
value = RandomSequence.generateSeq(fieldName, type, parameterList, context);

} else if ("it".equalsIgnoreCase(fieldType)) {
final String type = Type.UNION.getName().equals(ValueUtils.getValidTypeFromSchema(schema)) ? getRecordUnion(schema.getTypes()).getName()
: ValueUtils.getValidTypeFromSchema(schema);
Expand Down Expand Up @@ -104,7 +101,7 @@ private Object getEnumOrGenerate(final String fieldName, final String fieldType,
value = new GenericData.EnumSymbol(schema, enumValueList.get(RandomUtils.nextInt(0, enumValueList.size())));
} else {
if ("Seq".equalsIgnoreCase(fieldType)) {
value = new GenericData.EnumSymbol(schema, RandomSequence.generateSequenceForFieldValueList(fieldName, fieldValueMappingType, parameterList, context));
value = new GenericData.EnumSymbol(schema, RandomSequence.generateSeq(fieldName, fieldValueMappingType, parameterList, context));
} else if ("It".equalsIgnoreCase(fieldType)) {
value = new GenericData.EnumSymbol(schema, RandomIterator.generateIteratorForFieldValueList(fieldName, fieldValueMappingType, parameterList, context));
} else {
Expand Down Expand Up @@ -201,7 +198,7 @@ public final Object generateArray(
final List value = new ArrayList<>(valueLength);
if ("seq".equals(fieldType)) {
if (!fieldValuesList.isEmpty() && (fieldValuesList.size() > 1 || RandomSequence.isTypeNotSupported(fieldType))) {
value.add(RandomSequence.generateSequenceForFieldValueList(fieldName, fieldType, parameterList, context));
value.add(RandomSequence.generateSeq(fieldName, fieldType, parameterList, context));
} else if ("it".equals(fieldType)) {
if (!fieldValuesList.isEmpty() && (fieldValuesList.size() > 1 || RandomIterator.isTypeNotSupported(fieldType))) {
value.add(RandomIterator.generateIteratorForFieldValueList(fieldName, fieldType, parameterList, context));
Expand Down Expand Up @@ -233,7 +230,7 @@ public final Object generateMap(
if ("seq".equals(fieldType)) {
if (!fieldValuesList.isEmpty() && (fieldValuesList.size() > 1 || RandomSequence.isTypeNotSupported(fieldType))) {
value.put(RANDOM_OBJECT.generateRandom("string", valueLength, Collections.emptyList(), Collections.emptyMap()),
RandomSequence.generateSequenceForFieldValueList(fieldName, fieldType, parameterList, context));
RandomSequence.generateSeq(fieldName, fieldType, parameterList, context));
} else if ("it".equals(fieldType)) {
if (!fieldValuesList.isEmpty() && (fieldValuesList.size() > 1 || RandomIterator.isTypeNotSupported(fieldType))) {
value.put(RANDOM_OBJECT.generateRandom("string", valueLength, Collections.emptyList(), Collections.emptyMap()),
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/net/coru/kloadgen/randomtool/generator/ProtoBufGeneratorTool.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public final Object generateArray(final String fieldName, final String fieldType
final List value = new ArrayList<>(arraySize);
if ("seq".equals(fieldType)) {
if (!fieldValuesList.isEmpty() && (fieldValuesList.size() > 1 || RandomSequence.isTypeNotSupported(fieldType))) {
value.add(RandomSequence.generateSequenceForFieldValueList(fieldName, fieldType, parameterList, context));
value.add(RandomSequence.generateSeq(fieldName, fieldType, parameterList, context));
} else {
for (int i = arraySize; i > 0; i--) {
value.add(RandomSequence.generateSeq(fieldName, fieldType, parameterList, context));
Expand Down
6 changes: 1 addition & 5 deletions src/main/java/net/coru/kloadgen/randomtool/generator/StatelessGeneratorTool.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,7 @@ public final Object generateObject(final String fieldName, final String fieldTyp
final Object value;

if ("seq".equals(fieldType)) {
if (!fieldValuesList.isEmpty() && (fieldValuesList.size() > 1 || RandomSequence.isTypeNotSupported(fieldType))) {
value = RandomSequence.generateSequenceForFieldValueList(fieldName, fieldType, fieldValuesList, context);
} else {
value = RandomSequence.generateSeq(fieldName, fieldType, parameterList, context);
}
value = RandomSequence.generateSeq(fieldName, fieldType, parameterList, context);
} else if ("it".equals(fieldType)) {
if (!fieldValuesList.isEmpty() && (fieldValuesList.size() > 1 || RandomIterator.isTypeNotSupported(fieldType))) {
value = RandomIterator.generateIteratorForFieldValueList(fieldName, fieldType, fieldValuesList, context);
Expand Down
13 changes: 4 additions & 9 deletions src/main/java/net/coru/kloadgen/randomtool/random/RandomSequence.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,22 +35,17 @@ public static boolean isTypeNotSupported(final String fieldType) {
}

public static Object generateSeq(final String fieldName, final String fieldType, final List<String> fieldValueList, final Map<String, Object> context) {
if (!fieldValueList.isEmpty() && fieldValueList.size() > 1) {
throw new IllegalArgumentException("Sequences do not accept more than one option as initial value");
}
return context.compute(fieldName, (fieldNameMap, seqObject) ->
seqObject == null
? getFirstValueOrDefaultForType(fieldValueList, fieldType)
: addOneCasted(seqObject, fieldType));
}

public static Object generateSequenceForFieldValueList(final String fieldName, final String fieldType, final List<String> fieldValueList, final Map<String, Object> context) {
final var index = (Integer) context.compute(fieldName, (fieldNameMap, seqObject) -> seqObject == null ? 0 : (((Integer) seqObject) + 1) % fieldValueList.size());
return ValueUtils.castValue(fieldValueList.get(index), fieldType);
}

private static Object getFirstValueOrDefaultForType(final List<String> fieldValueList, final String fieldType) {
Object result = null;
if (isTypeNotSupported(fieldType)) {
throw new IllegalArgumentException("Field type is not supported for sequences");
}
final Object result;
if (!fieldValueList.isEmpty()) {
result = ValueUtils.castValue(fieldValueList.get(0), fieldType);
} else {
Expand Down
24 changes: 12 additions & 12 deletions src/test/java/net/coru/kloadgen/processor/AvroSchemaProcessorTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -417,11 +417,11 @@ private GenericRecord entityForCustomSequenceOfValuesWithSameStartingStartingVal
}

@Test
@DisplayName("Should process Custom Sequence Of Values With Same Starting Starting Value")
void testCustomSequenceOfValuesWithSameStartingStartingValue() {
@DisplayName("Should process Custom Iterator Of Values With Same Starting Value")
void testCustomSequenceOfValuesWithSameStartingValue() {
final var fieldValueMappingList = asList(
FieldValueMapping.builder().fieldName("values[3].id").fieldType("seq").valueLength(0).fieldValueList("[1,2]").required(true).isAncestorRequired(true).build(),
FieldValueMapping.builder().fieldName("values[3].otherId").fieldType("seq").valueLength(0).fieldValueList("[1,3]").required(true).isAncestorRequired(true).build());
FieldValueMapping.builder().fieldName("values[3].id").fieldType("it").valueLength(0).fieldValueList("[1,2]").required(true).isAncestorRequired(true).build(),
FieldValueMapping.builder().fieldName("values[3].otherId").fieldType("it").valueLength(0).fieldValueList("[1,3]").required(true).isAncestorRequired(true).build());

final var avroSchemaProcessor = new SchemaProcessor();
final var schemaWithTwoSequencesWithSameStartingValue = SchemaBuilder
Expand Down Expand Up @@ -454,7 +454,7 @@ void testCustomSequenceOfValuesWithSameStartingStartingValue() {
Assertions.assertThat(message.getGenericRecord()).isEqualTo(entity);
}

private GenericRecord entityForCustomSequenceOfValuesWithSameFieldNameInDifferentMappings(final Schema schema, final List<String> idValues, final List<String> idOtherValues) {
private GenericRecord entityForCustomIteratorOfValuesWithSameFieldNameInDifferentMappings(final Schema schema, final List<String> idValues, final List<String> idOtherValues) {
final var entity = new GenericData.Record(schema);
final var valuesData = getIdRecordsList(entity, "values", idValues);
final var otherValuesData = getIdRecordsList(entity, "otherValues", idOtherValues);
Expand All @@ -475,16 +475,16 @@ private List<GenericRecord> getIdRecordsList(final GenericRecord entity, final S
}

@Test
@DisplayName("Should process Custom Sequence Of Values With Same FieldName In Different Mappings")
void testCustomSequenceOfValuesWithSameFieldNameInDifferentMappings() {
@DisplayName("Should process Custom Iterator Of Values With Same FieldName In Different Mappings")
void testCustomIteratorOfValuesWithSameFieldNameInDifferentMappings() {
final var fieldValueMappingList = asList(
FieldValueMapping.builder().fieldName("values[4].id").fieldType("seq").valueLength(0).fieldValueList("[1,2.44,3.6]").required(true).isAncestorRequired(true).build(),
FieldValueMapping.builder().fieldName("otherValues[4].id").fieldType("seq").valueLength(0).fieldValueList("[1,3.02,4.98]").required(true).isAncestorRequired(true).build());
FieldValueMapping.builder().fieldName("values[4].id").fieldType("it").valueLength(0).fieldValueList("[1,2.44,3.6]").required(true).isAncestorRequired(true).build(),
FieldValueMapping.builder().fieldName("otherValues[4].id").fieldType("it").valueLength(0).fieldValueList("[1,3.02,4.98]").required(true).isAncestorRequired(true).build());

final var idSchema = LogicalTypes.decimal(5, 2).addToSchema(SchemaBuilder.builder().bytesBuilder().endBytes());

final var avroSchemaProcessor = new SchemaProcessor();
final var schemaWithTwoSequencesWithSameStartingValue = SchemaBuilder
final var schemaWithTwoIteratorsWithSameStartingValue = SchemaBuilder
.builder()
.record("Root")
.fields()
Expand Down Expand Up @@ -513,8 +513,8 @@ void testCustomSequenceOfValuesWithSameFieldNameInDifferentMappings() {
.endRecord())
.noDefault()
.endRecord();
final var entity = entityForCustomSequenceOfValuesWithSameFieldNameInDifferentMappings(schemaWithTwoSequencesWithSameStartingValue, asList("1", "2.44", "3.6", "1"), asList("1", "3.02", "4.98", "1"));
avroSchemaProcessor.processSchema(SchemaTypeEnum.AVRO, schemaWithTwoSequencesWithSameStartingValue,
final var entity = entityForCustomIteratorOfValuesWithSameFieldNameInDifferentMappings(schemaWithTwoIteratorsWithSameStartingValue, asList("1", "2.44", "3.6", "1"), asList("1", "3.02", "4.98", "1"));
avroSchemaProcessor.processSchema(SchemaTypeEnum.AVRO, schemaWithTwoIteratorsWithSameStartingValue,
new SchemaMetadata(1, 1, ""),
fieldValueMappingList);

Expand Down
10 changes: 5 additions & 5 deletions src/test/java/net/coru/kloadgen/randomtool/generator/AvroGeneratorToolTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ void testGenerateRandomValue(String fieldType, Integer valueLength, List<String>
assertThat(String.valueOf(number)).hasSize(valueLength);
}

private static Stream<Arguments> parametersForGenerateFieldValuesListSequence() {
private static Stream<Arguments> parametersForGenerateFieldValuesListIterator() {
return Stream.of(
Arguments.of(18,
List.of("1", "2", "3", "5", "6", "7", "7", "9", "9", "9", "10", "14", "17", "17", "17", "17", "18", "19", "20"),
Expand All @@ -186,15 +186,15 @@ private static Stream<Arguments> parametersForGenerateFieldValuesListSequence()
}

@ParameterizedTest
@DisplayName("Testing generate a sequence of a list of values")
@MethodSource("parametersForGenerateFieldValuesListSequence")
@DisplayName("Testing generate an iterator of a list of values")
@MethodSource("parametersForGenerateFieldValuesListIterator")
void testGenerateFieldValuesListSequence(int size, List<String> fieldValuesList, String fieldType, List<Object> expected) {
var intList = new ArrayList<>();
Schema schema = fieldType.equals(ValidTypeConstants.INT) ? SchemaBuilder.builder().intType() : SchemaBuilder.builder().stringType();
Field field = new Field("name", schema);
FieldValueMapping fieldValueMapping = FieldValueMapping.builder()
.fieldName(field.name())
.fieldType("seq")
.fieldType("it")
.valueLength(0)
.fieldValueList(String.join(",", fieldValuesList))
.build();
Expand Down Expand Up @@ -229,7 +229,7 @@ void testGenerateRandomValueForEnums(String fieldType, Integer valueLength, List

private static Stream<Arguments> parametersForGenerateSequenceValueForField() {
return Stream.of(
Arguments.of("seq", 1, Collections.singletonList("0"), new Field("name", SchemaBuilder.builder().stringType()), "0"),
Arguments.of("seq", 1, Collections.singletonList("0"), new Field("name", SchemaBuilder.builder().intType()), 0),
Arguments.of("seq", 1, Collections.singletonList("1"), new Field("name", SchemaBuilder.builder().intType()), 1),
Arguments.of("seq", 1, Collections.singletonList("2"), new Field("name", SchemaBuilder.builder().intType()), 2),
Arguments.of("it", 1, Collections.singletonList("0"), new Field("name", SchemaBuilder.builder().stringType()), "0"),
Expand Down
27 changes: 15 additions & 12 deletions src/test/java/net/coru/kloadgen/randomtool/random/RandomSequenceTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import java.util.stream.Stream;

import org.apache.groovy.util.Maps;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
Expand All @@ -45,22 +46,24 @@ void testGenerateSequenceValueForField(String fieldName, String fieldType, List<
private static Stream<Arguments> parametersForGenerateRandomValueWithList() {
return Stream.of(
Arguments.of(18,
List.of("1", "2", "3", "5", "6", "7", "7", "9", "9", "9", "10", "14", "17", "17", "17", "17", "18", "19", "20"),
List.of("1", "2", "3", "5", "6", "7", "7", "9", "9", "9", "10", "14", "17", "17", "17", "17", "18", "19", "20")),
Arguments.of(20,
List.of("1", "2", "3", "5", "6", "7", "7", "9", "9", "9", "10", "14", "17", "17", "17", "17", "18", "19", "20"),
List.of("1", "2", "3", "5", "6", "7", "7", "9", "9", "9", "10", "14", "17", "17", "17", "17", "18", "19", "20", "1", "2")));
List.of("1", "2", "3", "5", "6", "7", "7", "9", "9", "9", "10", "14", "17", "17", "17", "17", "18", "19", "20")));
}

@ParameterizedTest
@DisplayName("Testing Generate a Random Value With a List of Values")
@MethodSource("parametersForGenerateRandomValueWithList")
void testGenerateRandomValueWithList(final int size, final List<String> values, final List<String> expected) {
final var intList = new ArrayList<>();
final var context = new HashMap<String, Object>();
for (int i=0; i <= size; i++) {
intList.add(RandomSequence.generateSequenceForFieldValueList("ClientCode", "seq", values, context));
}
assertThat(intList).containsExactlyElementsOf(expected);
void testGenerateRandomValueWithList(final int size, final List<String> values) {
final Exception exception = Assertions.assertThrows(IllegalArgumentException.class, () -> {
final var intList = new ArrayList<>();
final var context = new HashMap<String, Object>();
for (int i=0; i <= size; i++) {
intList.add(RandomSequence.generateSeq("ClientCode", "seq", values, context));
}
});

final String expectedMessage = "Sequences do not accept more than one option as initial value";
final String actualMessage = exception.getMessage();

Assertions.assertTrue(actualMessage.contains(expectedMessage));
}
}

0 comments on commit f556037

Please sign in to comment.