[AD-400] Increase code coverage in calcite adapter (#228)

* [AD-400] Remove query execution in calcite-adapter

* [AD-400] Remove schema reader and writer interface and file schema reader/writer

* [AD-400] Remove unused methods in DocumentDbMetadataTable and DocumentDbSchemaTable

* [AD-400] Remove unused imports

* [AD-400] Add equals tests for models

* [AD-400] Remove passing mongo cursor to enumerator

* [AD-400] Fix test - create .documentdb dir if does not yet exist

* Commit Code Coverage Badge

* Commit Code Coverage Badge

* [AD-400] Improvements from code review

* [AD-400] Improvements from code review

* [AD-400] Correct formatting issues

* Commit Code Coverage Badge

* [AD-400] Improvements from code review

* Commit Code Coverage Badge

Co-authored-by: andiem-bq <[email protected]>

Author: andiemontoyeah

.github/badges/branches.svg

@@ -16,18 +16,12 @@
 
 package software.amazon.documentdb.jdbc.calcite.adapter;
 
-import com.mongodb.client.MongoClient;
-import com.mongodb.client.MongoDatabase;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import org.apache.calcite.linq4j.AbstractEnumerable;
 import org.apache.calcite.linq4j.Enumerator;
-import org.apache.calcite.linq4j.function.Function1;
-import org.apache.calcite.util.Util;
-import org.bson.Document;
 import org.bson.conversions.Bson;
 
-import java.util.Iterator;
 import java.util.List;
 
 /**
@@ -38,24 +32,14 @@
 @AllArgsConstructor
 public class DocumentDbEnumerable extends AbstractEnumerable<Object> {
 
-    private final MongoClient client;
     private final String databaseName;
     private final String collectionName;
     private final List<Bson> list;
-    private final Function1<Document, Object> getter;
     private final List<String> paths;
 
     @Override
     public Enumerator<Object> enumerator() {
-        final Iterator<Document> resultIterator;
-        try {
-            final MongoDatabase database = client.getDatabase(databaseName);
-            resultIterator = database.getCollection(collectionName)
-                    .aggregate(list).iterator();
-        } catch (Exception e) {
-            throw new RuntimeException("While running MongoDB query "
-                    + Util.toString(list, "[", ",\n", "]"), e);
-        }
-        return new DocumentDbEnumerator(resultIterator, getter);
+        // Implement the enumerable interface but do not execute query.
+        return new DocumentDbEnumerator();
     }
 }

.github/badges/jacoco.svg

@@ -16,177 +16,25 @@
  */
 package software.amazon.documentdb.jdbc.calcite.adapter;
 
-import lombok.SneakyThrows;
 import org.apache.calcite.linq4j.Enumerator;
-import org.apache.calcite.linq4j.function.Function1;
-import org.apache.calcite.linq4j.tree.Primitive;
-import org.bson.Document;
-import org.bson.types.Binary;
-import software.amazon.documentdb.jdbc.metadata.DocumentDbSchemaTable;
 
-import java.util.Date;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
-import java.util.Map.Entry;
-import java.util.stream.Collectors;
-
-/** Enumerator that reads from a MongoDB collection. */
+/** Implements the enumerator interface but does not return data. */
 class DocumentDbEnumerator implements Enumerator<Object> {
-    private final Iterator<Document> cursor;
-    private final Function1<Document, Object> getter;
-    private Object current;
 
-    /** Creates a DocumentDbEnumerator.
-     *
-     * @param cursor Mongo iterator (usually a {@link com.mongodb.client.MongoCursor})
-     * @param getter Converts an object into a list of fields
-     */
-    DocumentDbEnumerator(final Iterator<Document> cursor,
-            final Function1<Document, Object> getter) {
-        this.cursor = cursor;
-        this.getter = getter;
-    }
+    /** Creates a DocumentDbEnumerator. */
+    DocumentDbEnumerator() { }
 
     @Override public Object current() {
-        return current;
+        return null;
     }
 
     @Override public boolean moveNext() {
-        try {
-            if (cursor.hasNext()) {
-                final Document map = cursor.next();
-                current = getter.apply(map);
-                return true;
-            } else {
-                current = null;
-                return false;
-            }
-        } catch (Exception e) {
-            throw new RuntimeException(e);
-        }
+        return false;
     }
 
     @Override public void reset() {
         throw new UnsupportedOperationException();
     }
 
-    @SneakyThrows
-    @Override public void close() {
-        if (cursor instanceof AutoCloseable) {
-            ((AutoCloseable) cursor).close();
-        }
-        // AggregationOutput implements Iterator but not DBCursor. There is no
-        // available close() method -- apparently there is no open resource.
-    }
-
-    static Function1<Document, Map> mapGetter() {
-        return a0 -> (Map) a0;
-    }
-
-    /** Returns a function that projects a single field. */
-    static Function1<Document, Object> singletonGetter(final String fieldPath,
-            final Class fieldClass,
-            final DocumentDbSchemaTable tableMetadata) {
-        // DocumentDB: modified - start
-        return a0 -> getField(a0, fieldPath, fieldClass);
-        // DocumentDB: modified - end
-    }
-
-    /** Returns a function that projects fields.
-     *
-     * @param fields List of fields to project; or null to return map
-     */
-    static Function1<Document, Object[]> listGetter(
-            final List<Entry<String, Class<?>>> fields,
-            final DocumentDbSchemaTable tableMetadata) {
-        return a0 -> {
-            // DocumentDB: modified - start
-            return fields
-                    .stream()
-                    .map(field -> {
-                        final String path = field.getKey();
-                        return getField(a0, path, field.getValue());
-                    })
-                    .toArray();
-            // DocumentDB: modified - end
-        };
-    }
-
-    @SuppressWarnings("unchecked")
-    static Function1<Document, Object> getter(
-            final List<Entry<String, Class<?>>> fields,
-            final DocumentDbSchemaTable tableMetadata) {
-        //noinspection unchecked
-        // DocumentDB: modified - start
-        return fields == null
-                ? (Function1) mapGetter()
-                : fields.size() == 1
-                        ? singletonGetter(fields.get(0).getKey(), fields.get(0).getValue(),
-                                tableMetadata)
-                        : (Function1) listGetter(fields, tableMetadata);
-        // DocumentDB: modified - end
-    }
-
-    @SuppressWarnings("JdkObsolete")
-    private static Object convert(final Object o, final Class clazz) {
-        // DocumentDB: modified - start
-        Object sourceObject = o;
-        // DocumentDB: modified - end
-        Class sourceClazz = clazz;
-        if (sourceObject == null) {
-            return null;
-        }
-        Primitive primitive = Primitive.of(sourceClazz);
-        if (primitive != null) {
-            sourceClazz = primitive.boxClass;
-        } else {
-            primitive = Primitive.ofBox(sourceClazz);
-        }
-        if (sourceClazz.isInstance(sourceObject)) {
-            return sourceObject;
-        }
-        if (sourceObject instanceof Date && primitive != null) {
-            // DocumentDB: modified - begin
-            sourceObject = ((Date) sourceObject).getTime();
-            // DocumentDB: modified - end
-        }
-        if (sourceObject instanceof Number && primitive != null) {
-            return primitive.number((Number) sourceObject);
-        }
-        // DocumentDB: modified - begin
-        if (sourceObject instanceof Binary) {
-            return ((Binary) sourceObject).getData();
-        }
-        if (sourceObject instanceof Document) {
-            return ((Document) sourceObject).toJson();
-        }
-        if (sourceObject instanceof List) {
-          return ((List<?>) sourceObject)
-              .stream()
-                  .map(o1 -> o1 instanceof Document ? ((Document) o1).toJson() : o1)
-                  .collect(Collectors.toList());
-        }
-        // DocumentDB: modified - end
-        return sourceObject;
-    }
-
-    private static Object getField(
-            final Document a0,
-            final String path,
-            final Class<?> fieldClass)
-            throws UnsupportedOperationException {
-        final String[] segmentedPath = path.split("\\.");
-        int j = 0;
-        Object segmentValue = a0.get(segmentedPath[j]);
-        while (segmentValue instanceof Document) {
-            final Document document = (Document) segmentValue;
-            j++;
-            if (j >= segmentedPath.length) {
-                break;
-            }
-            segmentValue = document.get(segmentedPath[j]);
-        }
-        return convert(segmentValue, fieldClass);
-    }
+    @Override public void close() { }
 }

calcite-adapter/src/main/java/software/amazon/documentdb/jdbc/calcite/adapter/DocumentDbEnumerable.java

@@ -25,8 +25,8 @@
  * Builtin methods in the MongoDB adapter.
  */
 public enum DocumentDbMethod {
-    MONGO_QUERYABLE_FIND(DocumentDbTable.DocumentDbQueryable.class, "find", String.class,
-            String.class, List.class),
+    // TODO: Investigate using find() here for simpler queries.
+    //  See: https://github.com/aws/amazon-documentdb-jdbc-driver/issues/240
     MONGO_QUERYABLE_AGGREGATE(DocumentDbTable.DocumentDbQueryable.class, "aggregate",
             List.class, List.class, List.class);
 

calcite-adapter/src/main/java/software/amazon/documentdb/jdbc/calcite/adapter/DocumentDbEnumerator.java

@@ -16,8 +16,6 @@
  */
 package software.amazon.documentdb.jdbc.calcite.adapter;
 
-import com.mongodb.client.MongoClient;
-import com.mongodb.client.MongoClients;
 import lombok.SneakyThrows;
 import org.apache.calcite.schema.Table;
 import org.apache.calcite.schema.impl.AbstractSchema;
@@ -36,33 +34,22 @@
 /**
  * Provides a schema for DocumentDB
  */
-public class DocumentDbSchema extends AbstractSchema implements AutoCloseable {
+public class DocumentDbSchema extends AbstractSchema {
     private static final Logger LOGGER = LoggerFactory.getLogger(DocumentDbSchema.class);
     private Map<String, Table> tables;
     private final DocumentDbDatabaseSchemaMetadata databaseMetadata;
     private final String databaseName;
-    private final MongoClient client;
-    private final boolean closeClient;
 
     /**
      * Constructs a new {@link DocumentDbSchema} from {@link DocumentDbDatabaseSchemaMetadata}.
      *
      * @param databaseMetadata the database metadata.
-     * @param client the {@link MongoClient} client.
      */
     protected DocumentDbSchema(final DocumentDbDatabaseSchemaMetadata databaseMetadata,
-            final DocumentDbConnectionProperties connectionProperties,
-            final MongoClient client) {
+            final DocumentDbConnectionProperties connectionProperties) {
         this.databaseMetadata = databaseMetadata;
         this.databaseName = connectionProperties.getDatabase();
         tables = null;
-        if (client != null) {
-            this.client = client;
-            this.closeClient = false;
-        } else {
-            this.client = MongoClients.create(connectionProperties.buildMongoClientSettings());
-            this.closeClient = true;
-        }
     }
 
     @SneakyThrows
@@ -92,14 +79,6 @@ private Table getDocumentDbTable(final String tableName) {
         return new DocumentDbTable(schemaTable.getCollectionName(), schemaTable);
     }
 
-    /**
-     * Gets the {@link MongoClient} client.
-     *
-     * @return the {@link MongoClient} client.
-     */
-    public MongoClient getClient() {
-        return client;
-    }
 
     /**
      * Gets the name of the database.
@@ -109,11 +88,4 @@ public MongoClient getClient() {
     public String getDatabaseName() {
         return databaseName;
     }
-
-    @Override
-    public void close() {
-        if (closeClient && client != null) {
-            client.close();
-        }
-    }
 }

calcite-adapter/src/main/java/software/amazon/documentdb/jdbc/calcite/adapter/DocumentDbMethod.java

@@ -17,7 +17,6 @@
 
 package software.amazon.documentdb.jdbc.calcite.adapter;
 
-import com.mongodb.client.MongoClient;
 import org.apache.calcite.schema.Schema;
 import software.amazon.documentdb.jdbc.DocumentDbConnectionProperties;
 import software.amazon.documentdb.jdbc.metadata.DocumentDbDatabaseSchemaMetadata;
@@ -28,12 +27,10 @@ public class DocumentDbSchemaFactory {
      *
      * @param databaseMetadata the database metadata.
      * @param connectionProperties the connection properties.
-     * @param client the {@link MongoClient} client.
      * @return a new {@link Schema} for the database.
      */
     public static Schema create(final DocumentDbDatabaseSchemaMetadata databaseMetadata,
-            final DocumentDbConnectionProperties connectionProperties,
-            final MongoClient client) {
-        return new DocumentDbSchema(databaseMetadata, connectionProperties, client);
+            final DocumentDbConnectionProperties connectionProperties) {
+        return new DocumentDbSchema(databaseMetadata, connectionProperties);
     }
 }