WIP: No SQL Module

.github/labeler.yml

@@ -37,3 +37,7 @@ accessibility:
 playwright:
   - maqs-playwright/*
   - maqs-playwright/**/*
+
+noSQL:
+  -maqs-nosql/*
+  -maqs-nosql/**/*

.github/workflows/maven.yml

@@ -108,7 +108,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        module-name: [ maqs-utilities, maqs-base, maqs-appium, maqs-selenium, maqs-webservices, maqs-cucumber, maqs-accessibility, maqs-database, maqs-playwright ]
+        module-name: [ maqs-utilities, maqs-base, maqs-appium, maqs-selenium, maqs-webservices, maqs-cucumber, maqs-accessibility, maqs-database, maqs-playwright, maqs-nosql ]
     steps:
       - name: Check if tests can be run
         if: matrix.module-name == 'maqs-appium' && github.actor == 'dependabot[bot]'

Docker/MAQSMongoDB/docker-compose.yml

@@ -0,0 +1,23 @@
+version: '2'
+
+services:
+  mongo:
+    image: mongo
+    restart: always
+    ports:
+      - "27017:27017"
+    volumes:
+      - ./seed/seed.js:/docker-entrypoint-initdb.d/seed.js
+  mongo-express:
+    image: mongo-express
+    restart: always
+    ports:
+      - 8081:8081
+    links:
+      - mongo
+    environment:
+      ME_CONFIG_MONGODB_ADMINUSERNAME:
+      ME_CONFIG_MONGODB_ADMINPASSWORD:
+
+    # Run a custom bash script that bootstraps the database after it is started.
+    command: [ '/bin/bash', '/mnt/host/initialize_and_start_sqlserver.sh' ]

Docker/MAQSMongoDB/seed/seed.js

@@ -0,0 +1,22 @@
+db = db.getSiblingDB('MongoDatabaseTest')
+db.MongoTestCollection.drop();
+db.MongoTestCollection.insertMany([
+  {
+    "lid": "test1",
+    "isChanged": true,
+    "order": 1
+  },
+  {
+    "lid": "test2",
+    "isChanged": false,
+    "order": 2
+  },
+  {
+    "lid": "test3",
+    "isChanged": false
+  },
+  {
+    "lid": "test4",
+    "isChanged": false
+  }
+])

Docker/docker-compose.yml

@@ -0,0 +1,15 @@
+# The extends functionality is not yet available in
+# Docker config files versioned 3 and higher.
+# If the version is bumped, this config file will have to change.
+# See https://github.com/moby/moby/issues/31101.
+version: '2'
+
+services:
+  mssql:
+    extends:
+      file: ./MAQSSQLServer/docker-compose.yml
+      service: mssql
+  mongo:
+    extends:
+      file: ./MAQSMongoDB/docker-compose.yml
+      service: mongo

docker/MAQSMongoDB/docker-compose.yml

@@ -3,11 +3,11 @@ version: '2'
 services:
   mongo:
     image: mongo
-    restart: always    
+    restart: always
     ports:
-    - "27017:27017"
+      - "27017:27017"
     volumes:
-    - ./seed/seed.js:/docker-entrypoint-initdb.d/seed.js
+      - ./seed/seed.js:/docker-entrypoint-initdb.d/seed.js
   mongo-express:
     image: mongo-express
     restart: always
@@ -16,5 +16,8 @@ services:
     links:
       - mongo
     environment:
-      ME_CONFIG_MONGODB_ADMINUSERNAME: 
-      ME_CONFIG_MONGODB_ADMINPASSWORD: 
+      ME_CONFIG_MONGODB_ADMINUSERNAME:
+      ME_CONFIG_MONGODB_ADMINPASSWORD:
+
+    # Run a custom bash script that bootstraps the database after it is started.
+    command: [ '/bin/bash', '/mnt/host/initialize_and_start_sqlserver.sh' ]

docker/MAQSMongoDB/seed/seed.js

@@ -19,4 +19,4 @@ db.MongoTestCollection.insertMany([
     "lid": "test4",
     "isChanged": false
   }
-])
+])

docker/docker-compose.yml

@@ -6,18 +6,10 @@ version: '2'
 
 services:
   mssql:
-    extends: 
+    extends:
       file: ./MAQSSQLServer/docker-compose.yml
       service: mssql
   mongo:
     extends:
       file: ./MAQSMongoDB/docker-compose.yml
-      service: mongo
-  imap:
-    extends:
-      file: ./MAQSEmail/docker-compose.yml
-      service: imap
-  webservice:
-    extends:
-      service: webservice
-      file: ./MAQSService/docker-compose.yml
+      service: mongo

maqs-nosql/config.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<configuration>
+    <ModualMaqs>
+        <!-- Generic wait time in milliseconds - AKA how long do you wait for rechecking something -->
+        <WaitTime>100</WaitTime>
+
+        <!-- Generic time-out in milliseconds -->
+        <Timeout>10000</Timeout>
+
+        <!-- Do you want to create logs for your tests
+        <Log>YES</Log>
+        <Log>NO</Log>
+        <Log>OnFail</Log>-->
+        <Log>YES</Log>
+
+        <!--Logging Levels
+        <LogLevel>VERBOSE</LogLevel>
+        <LogLevel>INFORMATION</LogLevel>
+        <LogLevel>GENERIC</LogLevel>
+        <LogLevel>SUCCESS</LogLevel>
+        <LogLevel>WARNING</LogLevel>
+        <LogLevel>ERROR</LogLevel>-->
+        <LogLevel>VERBOSE</LogLevel>
+
+        <!-- Logging Types
+        <LogType>CONSOLE</LogType>
+        <LogType>TXT</LogType>
+        <LogType>HTML</LogType>-->
+        <LogType>TXT</LogType>
+
+        <!-- Log file path - Defaults to build location if no value is defined -->
+        <FileLoggerPath>./target/logs</FileLoggerPath>
+    </ModualMaqs>
+    <MongoMaqs>
+        <MongoConnectionString>mongodb://localhost:27017</MongoConnectionString>
+        <MongoDatabase>MongoDatabaseTest</MongoDatabase>
+        <MongoCollection>MongoTestCollection</MongoCollection>
+        <MongoTimeout>30</MongoTimeout>
+    </MongoMaqs>
+</configuration>

maqs-nosql/pom.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.cognizantsoftvision.maqs</groupId>
+        <artifactId>maqs-java</artifactId>
+        <version>${revision}</version>
+    </parent>
+
+    <groupId>com.cognizantsoftvision.maqs.noSQL</groupId>
+    <artifactId>maqs-noSQL</artifactId>
+    <name>MAQS NoSQL Testing Module</name>
+    <version>${revision}</version>
+
+    <properties>
+        <mongoDB.version>4.5.0</mongoDB.version>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.cognizantsoftvision.maqs.base</groupId>
+            <artifactId>maqs-base</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.cognizantsoftvision.maqs.utilities</groupId>
+            <artifactId>maqs-utilities</artifactId>
+            <version>${project.version}</version>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mongodb</groupId>
+            <artifactId>mongodb-driver-sync</artifactId>
+            <version>${mongoDB.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.testng</groupId>
+            <artifactId>testng</artifactId>
+        </dependency>
+    </dependencies>
+</project>

maqs-nosql/src/main/java/com/cognizantsoftvision/maqs/nosql/BaseMongoTest.java

@@ -0,0 +1,106 @@
+/*
+ * Copyright 2022 (C) Cognizant SoftVision, All rights Reserved
+ */
+
+package com.cognizantsoftvision.maqs.nosql;
+
+import com.cognizantsoftvision.maqs.base.BaseExtendableTest;
+import com.mongodb.client.MongoCollection;
+import java.util.function.Supplier;
+import org.bson.Document;
+import org.testng.ITestResult;
+
+/**
+ * The Base Mongo Test class.
+ */
+public class BaseMongoTest extends BaseExtendableTest<MongoTestObject> {
+
+  /**
+   * Initializes a new instance of the BaseMongoTest class,
+   * Set up the database client for each test class.
+   */
+  public BaseMongoTest() {
+    // Currently, not populated with any logic
+  }
+
+  /**
+   * Gets the mongoDB driver.
+   * @return the mongoDB driver
+   */
+  public MongoDBDriver getMongoDBDriver() {
+    return this.getTestObject().getMongoDBDriver();
+  }
+
+  /**
+   * Sets the MongoDB driver.
+   * @param driver the MongoDB driver to be set.
+   */
+  public void setMongoDBDriver(MongoDBDriver driver) {
+    this.getTestObject().overrideMongoDBDriver(driver);
+  }
+
+  /**
+   * Override the Mongo driver - does not lazy load.
+   * @param driver New Mongo driver
+   */
+  public void overrideConnectionDriver(MongoDBDriver driver) {
+    this.getTestObject().overrideMongoDBDriver(driver);
+  }
+
+  /**
+   * Override the Mongo driver  - respects lazy loading.
+   * @param overrideCollectionConnection The collection function
+   */
+  public void overrideConnectionDriver(Supplier<MongoCollection<Document>> overrideCollectionConnection) {
+    this.getTestObject().overrideMongoDBDriver(overrideCollectionConnection);
+  }
+
+  /**
+   * Override the Mongo driver  - respects lazy loading.
+   * @param connectionString Client connection string
+   * @param databaseString Database connection string
+   * @param collectionString Mongo collection string
+   */
+  public void overrideConnectionDriver(String connectionString, String databaseString, String collectionString) {
+    this.getTestObject().overrideMongoDBDriver(connectionString, databaseString, collectionString);
+  }
+
+  /**
+   * Get the base web service url.
+   * @return The base web service url
+   */
+  protected String getBaseConnectionString() {
+    return MongoDBConfig.getConnectionString();
+  }
+
+  /**
+   * Get the base web service url.
+   * @return The base web service url
+   */
+  protected String getBaseDatabaseString() {
+    return MongoDBConfig.getDatabaseString();
+  }
+
+  /**
+   * Get the base web service url.
+   * @return The base web service url
+   */
+  protected String getBaseCollectionString() {
+    return MongoDBConfig.getCollectionString();
+  }
+
+  @Override
+  protected void createNewTestObject() {
+    this.setTestObject(new MongoTestObject(this.getBaseConnectionString(), this.getBaseDatabaseString(),
+        this.getBaseCollectionString(), this.createLogger(), this.getFullyQualifiedTestClassName()));
+  }
+
+  /**
+   * Steps to take before logging teardown results.
+   * @param resultType The test result
+   */
+  @Override
+  protected void beforeLoggingTeardown(ITestResult resultType) {
+    // Currently, not populated with any logic
+  }
+}

maqs-nosql/src/main/java/com/cognizantsoftvision/maqs/nosql/IMongoTestObject.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2022 (C) Cognizant SoftVision, All rights Reserved
+ */
+
+package com.cognizantsoftvision.maqs.nosql;
+
+import com.cognizantsoftvision.maqs.base.ITestObject;
+import com.mongodb.client.MongoCollection;
+import java.util.function.Supplier;
+import org.bson.Document;
+
+/**
+ * The Mongo Test Object interface.
+ */
+public interface IMongoTestObject extends ITestObject {
+
+  /**
+   * Gets the Mongo driver.
+   * @return the mongo database driver
+   */
+  MongoDBDriver getMongoDBDriver();
+
+  /**
+   * Gets the Mongo driver manager.
+   * @return the mongo database manager
+   */
+  MongoDriverManager getMongoDBManager();
+
+  /**
+   * Override the Mongo driver a collection function.
+    * @param overrideCollectionConnection The collection function
+   */
+  void overrideMongoDBDriver(Supplier<MongoCollection<Document>> overrideCollectionConnection);
+
+  /**
+   * Override the Mongo driver settings.
+   * @param driver New Mongo driver
+   */
+  void overrideMongoDBDriver(MongoDBDriver driver);
+
+  /**
+   * Override the Mongo driver settings.
+   * @param connectionString Client connection string
+   * @param databaseString Database connection string
+   * @param collectionString Mongo collection string
+   */
+  void overrideMongoDBDriver(String connectionString, String databaseString, String collectionString);
+}