Skip to content

Commit

Permalink
Merge pull request #236 from xlate/231_improve_schema_validation
Browse files Browse the repository at this point in the history 
Improve schema validation for impl segment order and positions
  • Loading branch information
@MikeEdgar
MikeEdgar committed Dec 19, 2021
2 parents 266a80a + e12e648 commit 9afdbd8
Show file tree
Hide file tree
Showing 2 changed files with 140 additions and 32 deletions.
108 changes: 76 additions & 32 deletions src/main/java/io/xlate/edi/internal/schema/SchemaReaderV3.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@
import java.util.ArrayList;
import java.util.Collections;
import java.util.Deque;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.Spliterator;
import java.util.Spliterators;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Supplier;
Expand Down Expand Up @@ -140,35 +142,69 @@ void setReferences(BaseComplexImpl type, Map<String, EDIType> types) {
return;
}

for (EDITypeImplementation t : implSequence) {
if (t == null) {
continue;
}
EDIReference stdRef;
BaseImpl<?> seqImpl = (BaseImpl<?>) t;

if (t instanceof Positioned) {
Positioned p = (Positioned) t;
int offset = p.getPosition() - 1;
if (standardRefs != null && offset > -1 && offset < standardRefs.size()) {
stdRef = standardRefs.get(offset);
AtomicBoolean verifyOrder = new AtomicBoolean(false);

implSequence.stream()
.filter(BaseImpl.class::isInstance)
.map(BaseImpl.class::cast)
.forEach(typeImpl -> {
if (typeImpl instanceof Positioned) {
typeImpl.setStandardReference(getReference((Positioned) typeImpl, standard));
} else {
throw schemaException("Position " + p.getPosition()
+ " does not correspond to an entry in type " + standard.getId());
typeImpl.setStandardReference(getReference(typeImpl, standard));
verifyOrder.set(true);
}
} else {
String refTypeId = seqImpl.getTypeId();

stdRef = standardRefs.stream().filter(r -> r.getReferencedType()
.getId()
.equals(refTypeId))
.findFirst()
.orElseThrow(() -> schemaException("Reference " + refTypeId
+ " does not correspond to an entry in type "
+ standard.getId()));
});

if (verifyOrder.get()) {
verifyOrder(standard, implSequence);
}
}

EDIReference getReference(Positioned positionedTypeImpl, EDIComplexType standard) {
final int position = positionedTypeImpl.getPosition();
final List<EDIReference> standardRefs = standard.getReferences();
final int offset = position - 1;

if (offset < standardRefs.size()) {
return standardRefs.get(offset);
} else {
throw schemaException("Position " + position + " does not correspond to an entry in type " + standard.getId());
}
}

EDIReference getReference(BaseImpl<?> typeImpl, EDIComplexType standard) {
final String refTypeId = typeImpl.getTypeId();

for (EDIReference stdRef : standard.getReferences()) {
if (stdRef.getReferencedType().getId().equals(refTypeId)) {
return stdRef;
}
}

throw schemaException("Reference " + refTypeId + " does not correspond to an entry in type " + standard.getId());
}

void verifyOrder(EDIComplexType standard, List<EDITypeImplementation> implSequence) {
Iterator<String> standardTypes = standard.getReferences()
.stream()
.map(EDIReference::getReferencedType)
.map(EDIType::getId)
.iterator();

String stdId = standardTypes.next();

for (EDITypeImplementation implRef : implSequence) {
String implId = implRef.getReferencedType().getId();

seqImpl.setStandardReference(stdRef);
while (!implId.equals(stdId)) {
if (standardTypes.hasNext()) {
stdId = standardTypes.next();
} else {
String template = "%s reference %s is not in the correct order for the sequence of standard type %s";
throw schemaException(String.format(template, implRef.getType(), implRef.getCode(), standard.getId()));
}
}
}
}

Expand Down Expand Up @@ -354,20 +390,20 @@ EDITypeImplementation getDiscriminatorElement(EDIElementPosition discriminatorPo
int position,
List<EDITypeImplementation> sequence,
String type) {
if (position > 0 && position <= sequence.size()) {
return sequence.get(position - 1);
} else {
throw schemaException("Discriminator " + type + " position invalid: " + discriminatorPos, reader);
}

validatePosition(position, 1, sequence.size(), () -> "Discriminator " + type + " position invalid: " + discriminatorPos);
return sequence.get(position - 1);
}

CompositeImpl readCompositeImplementation(XMLStreamReader reader) {
List<EDITypeImplementation> sequence = new ArrayList<>(5);
int position = parseAttribute(reader, ATTR_POSITION, Integer::parseInt, 0);
int position = parseAttribute(reader, ATTR_POSITION, Integer::parseInt, -1);
int minOccurs = parseAttribute(reader, ATTR_MIN_OCCURS, Integer::parseInt, -1);
int maxOccurs = parseAttribute(reader, ATTR_MAX_OCCURS, Integer::parseInt, -1);
String title = parseAttribute(reader, ATTR_TITLE, String::valueOf, null);

validatePosition(position, 1, Integer.MAX_VALUE, () -> "Invalid position");

return readTypeImplementation(reader,
() -> readSequence(reader, e -> readPositionedSequenceEntry(e, sequence, false)),
descr -> whenExpected(reader,
Expand All @@ -393,11 +429,13 @@ void readSequence(XMLStreamReader reader, Consumer<QName> startHandler) {

ElementImpl readElementImplementation(XMLStreamReader reader) {
this.valueSet.clear();
int position = parseAttribute(reader, ATTR_POSITION, Integer::parseInt, 0);
int position = parseAttribute(reader, ATTR_POSITION, Integer::parseInt, -1);
int minOccurs = parseAttribute(reader, ATTR_MIN_OCCURS, Integer::parseInt, -1);
int maxOccurs = parseAttribute(reader, ATTR_MAX_OCCURS, Integer::parseInt, -1);
String title = parseAttribute(reader, ATTR_TITLE, String::valueOf, null);

validatePosition(position, 1, Integer.MAX_VALUE, () -> "Invalid position");

return readTypeImplementation(reader,
() -> valueSet.set(super.readEnumerationValues(reader)),
descr -> whenExpected(reader,
Expand All @@ -411,6 +449,12 @@ ElementImpl readElementImplementation(XMLStreamReader reader) {
descr)));
}

void validatePosition(int position, int min, int max, Supplier<String> message) {
if (position < min || position > max) {
throw schemaException(message.get(), reader);
}
}

<T> T whenExpected(XMLStreamReader reader, QName expected, Supplier<T> supplier) {
requireElement(expected, reader);
return supplier.get();
Expand Down
64 changes: 64 additions & 0 deletions src/test/java/io/xlate/edi/internal/schema/StaEDISchemaFactoryTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -679,4 +679,68 @@ void testEmptyLoopImplementationCopiesStandard() throws EDISchemaException {
assertEquals("AK5", loop2000.getSequence().get(2).getCode());
}

@Test
void testImplementationSegmentWithoutStandardTypeThrowsException() throws EDISchemaException {
SchemaFactory factory = SchemaFactory.newFactory();
InputStream stream = new ByteArrayInputStream((""
+ "<schema xmlns='" + StaEDISchemaFactory.XMLNS_V4 + "'>"
+ " <include schemaLocation='file:./src/test/resources/x12/EDISchema997.xml' />"
+ " <implementation>"
+ " <sequence>"
+ " <segment type='AK1' />"
+ " <segment type='AK8' />"
+ " <segment type='AK9' />"
+ " </sequence>"
+ " </implementation>"
+ "</schema>").getBytes());

EDISchemaException thrown = assertThrows(EDISchemaException.class, () -> factory.createSchema(stream));
assertEquals("Reference AK8 does not correspond to an entry in type io.xlate.edi.internal.schema.TRANSACTION", thrown.getOriginalMessage());
}

@Test
void testOutOfOrderImplementationSegmentsThrowsException() throws EDISchemaException {
SchemaFactory factory = SchemaFactory.newFactory();
InputStream stream = new ByteArrayInputStream((""
+ "<schema xmlns='" + StaEDISchemaFactory.XMLNS_V4 + "'>"
+ " <include schemaLocation='file:./src/test/resources/x12/EDISchema997.xml' />"
+ " <implementation>"
+ " <sequence>"
+ " <segment type='AK9' />"
+ " <segment type='AK1' />"
+ " </sequence>"
+ " </implementation>"
+ "</schema>").getBytes());

EDISchemaException thrown = assertThrows(EDISchemaException.class, () -> factory.createSchema(stream));
assertEquals("SEGMENT reference AK1 is not in the correct order for the sequence of standard type io.xlate.edi.internal.schema.TRANSACTION", thrown.getOriginalMessage());
}

@ParameterizedTest
@CsvSource({
"element, '', 'Invalid position'",
"element, '0', 'Invalid position'",
"element, '3000000000', 'Invalid position'",
"composite, '', 'Invalid position'",
"composite, '0', 'Invalid position'",
"composite, '3000000000', 'Invalid position'",
"element, '50', 'Position 50 does not correspond to an entry in type AK1'"
})
void testInvalidElementPositionThrowsException(String type, String position, String message) throws EDISchemaException {
SchemaFactory factory = SchemaFactory.newFactory();
InputStream stream = new ByteArrayInputStream((""
+ "<schema xmlns='" + StaEDISchemaFactory.XMLNS_V4 + "'>"
+ " <include schemaLocation='file:./src/test/resources/x12/EDISchema997.xml' />"
+ " <implementation>"
+ " <sequence>"
+ " <segment type='AK1'>"
+ " <sequence><" + type + " position='" + position + "'/></sequence>"
+ " </segment>"
+ " </sequence>"
+ " </implementation>"
+ "</schema>").getBytes());

EDISchemaException thrown = assertThrows(EDISchemaException.class, () -> factory.createSchema(stream));
assertEquals(message, thrown.getOriginalMessage());
}
}

0 comments on commit 9afdbd8

Please sign in to comment.