chore: add parent primary key resolver (#69)

Adding parent primary key resolver, which led to fleshing out methods in the `Table` and `Resource` classes

fixes: #49

Author: mnorbury

lib/src/main/java/io/cloudquery/schema/ClientMeta.java

@@ -1,4 +1,7 @@
 package io.cloudquery.schema;
 
+import lombok.Builder;
+
+@Builder
 public class ClientMeta {
 }

lib/src/main/java/io/cloudquery/schema/Column.java

@@ -29,6 +29,7 @@ public class Column {
             name("_cq_parent_id").
             type(new UUIDType()).
             description("Internal CQ ID of the parent row").
+            resolver(new ParentCQUUIDResolver()).
             ignoreInTests(true).
             build();
 

lib/src/main/java/io/cloudquery/schema/ParentCQUUIDResolver.java

@@ -0,0 +1,40 @@
+package io.cloudquery.schema;
+
+import io.cloudquery.scalar.Scalar;
+import io.cloudquery.scalar.UUID;
+import io.cloudquery.scalar.ValidationException;
+import io.cloudquery.transformers.TransformerException;
+
+import static io.cloudquery.schema.Column.CQ_ID_COLUMN;
+
+public class ParentCQUUIDResolver implements ColumnResolver {
+    @Override
+    public void resolve(ClientMeta meta, Resource resource, Column column) throws TransformerException {
+        Resource parent = resource.getParent();
+        if (parent == null) {
+            setOrThrow(resource, column, null);
+            return;
+        }
+
+        Scalar<?> parentCqID = parent.get(CQ_ID_COLUMN.getName());
+        if (parentCqID == null) {
+            setOrThrow(resource, column, null);
+            return;
+        }
+
+        if (!(parentCqID instanceof UUID)) {
+            setOrThrow(resource, column, null);
+            return;
+        }
+
+        setOrThrow(resource, column, parentCqID);
+    }
+
+    private static void setOrThrow(Resource resource, Column column, Scalar<?> parentCqID) throws TransformerException {
+        try {
+            resource.set(column.getName(), parentCqID);
+        } catch (ValidationException ex) {
+            throw new TransformerException("Failed to set parent CQ ID", ex);
+        }
+    }
+}

lib/src/main/java/io/cloudquery/schema/Resource.java

@@ -1,14 +1,40 @@
 package io.cloudquery.schema;
 
+import io.cloudquery.scalar.Scalar;
+import io.cloudquery.scalar.ValidationException;
 import lombok.Builder;
 import lombok.Getter;
 
-@Builder
+import java.util.ArrayList;
+import java.util.List;
+
 @Getter
 public class Resource {
     private Object item;
+    private Resource parent;
+    private Table table;
+
+    private final List<Scalar<?>> data;
+
+    @Builder(toBuilder = true)
+    public Resource(Table table, Resource parent, Object item) {
+        this.item = item;
+        this.parent = parent;
+        this.table = table != null ? table : Table.builder().build();
+        this.data = new ArrayList<>();
 
+        for (Column column : this.table.getColumns()) {
+            this.data.add(Scalar.fromArrowType(column.getType()));
+        }
+    }
+
+    public void set(String columnName, Object value) throws ValidationException {
+        int index = table.indexOfColumn(columnName);
+        this.data.get(index).set(value);
+    }
 
-    public void set(String columnName, Object value) {
+    public Scalar<?> get(String columnName) {
+        int index = table.indexOfColumn(columnName);
+        return this.data.get(index);
     }
 }

lib/src/main/java/io/cloudquery/schema/Table.java

@@ -140,6 +140,15 @@ public void addCQIDs() {
         }
     }
 
+    public int indexOfColumn(String columnName) {
+        for (int index = 0; index < columns.size(); index++) {
+            if (columns.get(index).getName().equals(columnName)) {
+                return index;
+            }
+        }
+        return -1;
+    }
+
     public List<String> primaryKeys() {
         return columns.stream().
                 filter(Column::isPrimaryKey).

lib/src/main/java/io/cloudquery/transformers/ResolverTransformer.java

@@ -2,6 +2,7 @@
 
 import io.cloudquery.helper.ReflectionPathResolver;
 import io.cloudquery.helper.ReflectionPathResolver.PathResolverException;
+import io.cloudquery.scalar.ValidationException;
 import io.cloudquery.schema.ColumnResolver;
 
 import java.lang.reflect.Field;
@@ -16,7 +17,7 @@ public ColumnResolver transform(Field field, String path) throws TransformerExce
             return (meta, resource, column) -> {
                 try {
                     resource.set(column.getName(), ReflectionPathResolver.resolve(resource.getItem(), path));
-                } catch (PathResolverException ex) {
+                } catch (PathResolverException | ValidationException ex) {
                     throw new TransformerException("Failed to resolve path: " + path, ex);
                 }
             };

lib/src/test/java/io/cloudquery/schema/ParentCQUUIDResolverTest.java

@@ -0,0 +1,66 @@
+package io.cloudquery.schema;
+
+import io.cloudquery.scalar.ValidationException;
+import io.cloudquery.transformers.TransformerException;
+import io.cloudquery.types.UUIDType;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class ParentCQUUIDResolverTest {
+    private static final java.util.UUID PARENT_UUID = java.util.UUID.randomUUID();
+    private static final java.util.UUID CHILD_UID = java.util.UUID.randomUUID();
+    private static final String CHILD_COLUMN = "child_column";
+    private static final Column COLUMN = Column.builder().name(CHILD_COLUMN).type(new UUIDType()).build();
+    private static final Table parentTable = Table.builder().name("parent").columns(List.of(Column.CQ_ID_COLUMN)).build();
+    private static final Table childTable = Table.builder().name("child").columns(List.of(COLUMN)).build();
+
+    private ColumnResolver resolver;
+
+    @BeforeEach
+    void setUp() {
+        resolver = new ParentCQUUIDResolver();
+    }
+
+    @Test
+    public void shouldSetColumnToNullIfWeDoNotHaveAParent() throws TransformerException, ValidationException {
+        Resource resourceWithNoParent = Resource.builder().table(childTable).build();
+        resourceWithNoParent.set(CHILD_COLUMN, CHILD_UID);
+
+        assertEquals(CHILD_UID, resourceWithNoParent.get(CHILD_COLUMN).get());
+        resolver.resolve(null, resourceWithNoParent, COLUMN);
+
+        assertEquals(null, resourceWithNoParent.get(CHILD_COLUMN).get());
+    }
+
+    @Test
+    public void shouldSetColumnToNullIfParentDoesNotHaveCQID() throws TransformerException, ValidationException {
+        Resource resource = Resource.builder().
+                table(childTable).
+                parent(Resource.builder().table(parentTable).build()).
+                build();
+        resource.set(CHILD_COLUMN, CHILD_UID);
+
+        assertEquals(CHILD_UID, resource.get(CHILD_COLUMN).get());
+        resolver.resolve(null, resource, COLUMN);
+
+        assertEquals(null, resource.get(CHILD_COLUMN).get());
+    }
+
+    @Test
+    public void shouldSetColumnToUUIDIfParentHasACQID() throws TransformerException, ValidationException {
+        Resource parentResource = Resource.builder().table(parentTable).build();
+        parentResource.set(Column.CQ_ID_COLUMN.getName(), PARENT_UUID);
+
+        Resource resource = Resource.builder().table(childTable).parent(parentResource).build();
+        resource.set(CHILD_COLUMN, CHILD_UID);
+
+        assertEquals(CHILD_UID, resource.get(CHILD_COLUMN).get());
+        resolver.resolve(null, resource, COLUMN);
+
+        assertEquals(PARENT_UUID, resource.get(CHILD_COLUMN).get());
+    }
+}

lib/src/test/java/io/cloudquery/schema/ResourceTest.java

@@ -0,0 +1,54 @@
+package io.cloudquery.schema;
+
+import io.cloudquery.scalar.ValidationException;
+import io.cloudquery.types.UUIDType;
+import org.apache.arrow.vector.types.pojo.ArrowType;
+import org.junit.jupiter.api.Test;
+
+import java.util.List;
+import java.util.UUID;
+
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertInstanceOf;
+
+public class ResourceTest {
+    private static final UUID UUID = java.util.UUID.randomUUID();
+
+    @Test
+    public void shouldBuildWithNoErrors() {
+        assertDoesNotThrow(() -> Resource.builder().build());
+    }
+
+    @Test
+    public void shouldCreateScalarData() {
+        Column column1 = Column.builder().
+                name("test_column1").
+                type(new UUIDType()).
+                build();
+        Column column2 = Column.builder().
+                name("test_column2").
+                type(ArrowType.Utf8.INSTANCE).
+                build();
+        Table table = Table.builder().name("test").columns(List.of(column1, column2)).build();
+
+        Resource resource = Resource.builder().table(table).build();
+
+        assertInstanceOf(io.cloudquery.scalar.UUID.class, resource.get(column1.getName()));
+        assertInstanceOf(io.cloudquery.scalar.String.class, resource.get(column2.getName()));
+    }
+
+    @Test
+    public void shouldSetAndGetDataTypes() throws ValidationException {
+        Column column1 = Column.builder().
+                name("test_column1").
+                type(new UUIDType()).
+                build();
+        Table table = Table.builder().name("test").columns(List.of(column1)).build();
+
+        Resource resource = Resource.builder().table(table).build();
+
+        resource.set(column1.getName(), UUID);
+        assertEquals(UUID, resource.get(column1.getName()).get());
+    }
+}

lib/src/test/java/io/cloudquery/transformers/DefaultResolverTransformerTest.java

@@ -1,5 +1,6 @@
 package io.cloudquery.transformers;
 
+import io.cloudquery.scalar.ValidationException;
 import io.cloudquery.schema.Column;
 import io.cloudquery.schema.Resource;
 import io.cloudquery.transformers.ResolverTransformer.DefaulResolverTransformer;
@@ -36,7 +37,7 @@ void setUp() {
     }
 
     @Test
-    public void shouldTransformCustomFieldNamesFromResource() throws TransformerException {
+    public void shouldTransformCustomFieldNamesFromResource() throws TransformerException, ValidationException {
         Column targetColumn = Column.builder().name("id").build();
 
         transformer.transform(null, "myCustomID").resolve(null, resource, targetColumn);