Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gh-3098: Improve Testing of GafferEntityGenerator #3099

Merged
merged 4 commits into from
Nov 20, 2023
Merged

Gh-3098: Improve Testing of GafferEntityGenerator #3099

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
53672f7
Improve tests and coverage
tb06904 Nov 16, 2023
3d05b2c
remove redundant checks
tb06904 Nov 17, 2023
cc06326
check for empty properties
tb06904 Nov 17, 2023
e7bcb57
Merge branch 'develop' into gh-3098-improve-testing-gafferentitygener…
t92549 Nov 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 11 additions & 15 deletions ...tinkerpop/src/main/java/uk/gov/gchq/gaffer/tinkerpop/generator/GafferEntityGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,33 +16,29 @@

package uk.gov.gchq.gaffer.tinkerpop.generator;

import org.apache.tinkerpop.gremlin.structure.Property;
import org.apache.tinkerpop.gremlin.structure.VertexProperty;

import uk.gov.gchq.gaffer.data.element.Entity;
import uk.gov.gchq.gaffer.data.generator.OneToOneElementGenerator;
import uk.gov.gchq.gaffer.tinkerpop.GafferPopVertex;

import java.util.Iterator;

public class GafferEntityGenerator implements OneToOneElementGenerator<GafferPopVertex> {
@Override
public Entity _apply(final GafferPopVertex vertex) {
if (vertex == null) {
throw new IllegalArgumentException("Unable to convert a null GafferPopVertex Object");
}

final Entity entity = new Entity(vertex.label(), vertex.id());
final Iterator<VertexProperty<Object>> vertPropItr = vertex.properties();
while (vertPropItr.hasNext()) {
final VertexProperty<Object> vertProp = vertPropItr.next();
if (null != vertProp.key()) {
// Tinkerpop allows nested properties under a key for Gaffer we need to flatten these so only one property per key
vertex.properties().forEachRemaining(vertProp -> {
if (vertProp.key() != null) {
entity.putProperty(vertProp.key(), vertProp.value());
}
final Iterator<Property<Object>> propItr = vertProp.properties();
while (propItr.hasNext()) {
final Property<Object> prop = propItr.next();
if (null != prop.key()) {
vertProp.properties().forEachRemaining(prop -> {
if (prop.key() != null) {
entity.putProperty(prop.key(), prop.value());
}
tb06904 marked this conversation as resolved.
Show resolved Hide resolved
}
}
});
});
return entity;
}
}
77 changes: 66 additions & 11 deletions ...erpop/src/test/java/uk/gov/gchq/gaffer/tinkerpop/generator/GafferEntityGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,23 @@
import uk.gov.gchq.gaffer.tinkerpop.GafferPopGraph;
import uk.gov.gchq.gaffer.tinkerpop.GafferPopVertex;

import java.util.AbstractMap.SimpleEntry;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;

public class GafferEntityGeneratorTest {
class GafferEntityGeneratorTest {

@Test
public void shouldConvertGafferPopVertexToGafferEntity() {
void shouldConvertBasicGafferPopVertex() {
// Given
final String vertexNoPropsId = "vertexNoProps";
final String vertexWithPropsId = "vertexWithProps";
final String propValue = "propertyValue";

// Mock relevant bits so we can make a vertex with properties
final GafferPopGraph graph = mock(GafferPopGraph.class);
final Features features = mock(Features.class);
final VertexFeatures vertexFeatures = mock(VertexFeatures.class);
Expand All @@ -46,21 +55,67 @@ public void shouldConvertGafferPopVertexToGafferEntity() {
given(vertexFeatures.properties()).willReturn(vertexPropertyFeatures);
given(vertexPropertyFeatures.supportsNullPropertyValues()).willReturn(true);

final String vertex = "vertex";
final String propValue = "property value";
final GafferPopVertex gafferPopVertex = new GafferPopVertex(TestGroups.ENTITY, vertex, graph);
gafferPopVertex.property(Cardinality.list, TestPropertyNames.STRING, propValue);
// Create vertexes with and without properties
final GafferPopVertex vertexNoProps = new GafferPopVertex(TestGroups.ENTITY, vertexNoPropsId, graph);
final GafferPopVertex vertexWithProps = new GafferPopVertex(TestGroups.ENTITY, vertexWithPropsId, graph);
vertexWithProps.property(Cardinality.list, TestPropertyNames.STRING, propValue);

final GafferEntityGenerator generator = new GafferEntityGenerator();
// When
final Entity entityNoProps = generator._apply(vertexNoProps);
final Entity entityWithProps = generator._apply(vertexWithProps);

// Then
assertThat(entityNoProps.getGroup()).isEqualTo(TestGroups.ENTITY);
assertThat(entityNoProps.getVertex()).isEqualTo(vertexNoPropsId);
tb06904 marked this conversation as resolved.
Show resolved Hide resolved
assertThat(entityWithProps.getGroup()).isEqualTo(TestGroups.ENTITY);
assertThat(entityWithProps.getVertex()).isEqualTo(vertexWithPropsId);
assertThat(entityWithProps.getProperties()).containsOnly(
new SimpleEntry<String, String>(TestPropertyNames.STRING, propValue));
}

@Test
void shouldConvertGafferPopVertexWithNestedProperties() {
// Given
final String vertexNestedPropsId = "vertexNestedProps";
final String outerPropKey = "outerPropKey";
final String outerPropValue = "outerPropValue";
final String nestedPropKey = "nestedPropKey";
final String nestedPropValue = "nestedPropValue";

// Mock relevant bits so we can make a vertex with properties
final GafferPopGraph graph = mock(GafferPopGraph.class);
final Features features = mock(Features.class);
final VertexFeatures vertexFeatures = mock(VertexFeatures.class);
final VertexPropertyFeatures vertexPropertyFeatures = mock(VertexPropertyFeatures.class);
given(graph.features()).willReturn(features);
given(features.vertex()).willReturn(vertexFeatures);
given(vertexFeatures.supportsNullPropertyValues()).willReturn(true);
given(vertexFeatures.properties()).willReturn(vertexPropertyFeatures);
given(vertexPropertyFeatures.supportsNullPropertyValues()).willReturn(true);

final GafferPopVertex vertexNestedProps = new GafferPopVertex(TestGroups.ENTITY, vertexNestedPropsId, graph);
// Add an outer property key value pair then also nest a property with in it
vertexNestedProps.property(Cardinality.list, outerPropKey, outerPropValue);
vertexNestedProps.property(outerPropKey).property(nestedPropKey, nestedPropValue);

final GafferEntityGenerator generator = new GafferEntityGenerator();
// When
final Entity entity = generator._apply(gafferPopVertex);
final Entity entityNestedProps = generator._apply(vertexNestedProps);

// Then
assertThat(entity.getGroup()).isEqualTo(TestGroups.ENTITY);
assertThat(entity.getVertex()).isEqualTo(vertex);
assertThat(entity.getProperties()).hasSize(1);
assertThat(entity.getProperty(TestPropertyNames.STRING)).isEqualTo(propValue);
assertThat(entityNestedProps.getGroup()).isEqualTo(TestGroups.ENTITY);
assertThat(entityNestedProps.getVertex()).isEqualTo(vertexNestedPropsId);
assertThat(entityNestedProps.getProperties()).containsOnly(
new SimpleEntry<String, String>(outerPropKey, outerPropValue),
new SimpleEntry<String, String>(nestedPropKey, nestedPropValue));
}

@Test
void shouldNotConvertNullObject() {
final GafferEntityGenerator generator = new GafferEntityGenerator();

assertThatExceptionOfType(IllegalArgumentException.class)
.isThrownBy(() -> generator._apply(null));
}
}