(DOCSP-29415): Add Run Test GH Action (#83)

# Pull Request Info

[PR Reviewing
Guidelines](https://github.com/mongodb/docs-java/blob/master/REVIEWING.md)

Add GH action to run the unit test suite

JIRA - https://jira.mongodb.org/browse/DOCSP-29415
Staging -
https://docs-mongodbcom-staging.corp.mongodb.com/drivers/docsworker-xlarge/NNNNN/

## Self-Review Checklist

- [ ] Is this free of any warnings or errors in the RST?
- [ ] Did you run a spell-check?
- [ ] Did you run a grammar-check?
- [ ] Are all the links working?

Author: cbullinger

.github/workflows/kotlin.yml

@@ -0,0 +1,28 @@
+name: Kotlin Example Tests
+
+on:
+  pull_request:
+    paths:
+      - 'examples/**'
+
+defaults:
+  run:
+    working-directory: examples # The working directory path
+
+jobs:
+  build:
+    name: Run Kotlin Example Tests
+    runs-on: macos-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'zulu'
+          java-version: 11
+      - name: Run Kotlin tests
+        run: ./gradlew test --stacktrace --info
+        env: 
+          CI: true
+          CONNECTION_URI: ${{ secrets.CONNECTION_URI }}

examples/README.md

@@ -46,3 +46,22 @@ mlaunch start
 ```
 
 Refer to the mlaunch docs for install info and other commands.
+
+## Running tests
+
+All tests in the project are automatically run on PRs as a GitHub action.
+
+To manually run tests, run the `test` task using the Gradle wrapper. 
+Use the `--tests` flag to run specific test files or tests.
+
+```
+./gradlew :shared:test
+```
+
+```
+./gradlew :shared:test --tests ClassName
+```
+
+```
+./gradlew :shared:test --tests ClassName.individualTestName
+```

examples/src/main/kotlin/config/Config.kt

@@ -0,0 +1,16 @@
+package config
+
+import io.github.cdimascio.dotenv.dotenv
+
+data class Config(val connectionUri: String)
+
+fun getConfig(): Config {
+    val ci = System.getenv("CI")
+    if(ci == "true") {
+        val connectionUri = System.getenv("CONNECTION_URI")
+        return Config(System.getenv("CONNECTION_URI"))
+    }
+    val env = dotenv()
+    val connectionUri = env["MONGODB_CONNECTION_URI"]
+    return Config(connectionUri)
+}

examples/src/test/kotlin/AggregationTest.kt

@@ -5,7 +5,7 @@ import com.mongodb.client.model.Aggregates
 import com.mongodb.client.model.Filters
 import com.mongodb.client.model.Projections
 import com.mongodb.kotlin.client.coroutine.MongoClient
-import io.github.cdimascio.dotenv.dotenv
+import config.getConfig
 import kotlinx.coroutines.flow.toList
 import kotlinx.coroutines.runBlocking
 import org.bson.Document
@@ -34,8 +34,8 @@ class AggregationTest {
     // :snippet-end:
 
     companion object {
-        val dotenv = dotenv()
-        private val mongoClient = MongoClient.create(dotenv["MONGODB_CONNECTION_URI"])
+        val config = getConfig()
+        private val mongoClient = MongoClient.create(config.connectionUri)
         private val database = mongoClient.getDatabase("aggregation")
         val collection = database.getCollection<Restaurant>("restaurants")
 

examples/src/test/kotlin/BuildersTest.kt

@@ -3,7 +3,7 @@ import com.mongodb.*
 import com.mongodb.client.model.Filters.*
 import com.mongodb.client.model.Projections.*
 import com.mongodb.kotlin.client.coroutine.MongoClient
-import io.github.cdimascio.dotenv.dotenv
+import config.getConfig
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.runBlocking
 import org.bson.BsonObjectId
@@ -30,8 +30,8 @@ internal class BuildersTest {
     // :snippet-end:
 
     companion object {
-        val dotenv = dotenv()
-        val client = MongoClient.create(dotenv["MONGODB_CONNECTION_URI"])
+        val config = getConfig()
+        val client = MongoClient.create(config.connectionUri)
         val database = client.getDatabase("marketing")
         val collection = database.getCollection<User>("users")
 

examples/src/test/kotlin/BulkTest.kt

@@ -2,7 +2,7 @@
 import com.mongodb.MongoBulkWriteException
 import com.mongodb.client.model.*
 import com.mongodb.kotlin.client.coroutine.MongoClient
-import io.github.cdimascio.dotenv.dotenv
+import config.getConfig
 import kotlinx.coroutines.flow.toList
 import kotlinx.coroutines.runBlocking
 import org.bson.codecs.pojo.annotations.BsonId
@@ -23,8 +23,8 @@ data class SampleDoc(
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 internal class BulkTest {
     companion object {
-        val dotenv = dotenv()
-        val client = MongoClient.create(dotenv["MONGODB_CONNECTION_URI"])
+        val config = getConfig()
+        val client = MongoClient.create(config.connectionUri)
         val database = client.getDatabase("sample_db")
         val collection = database.getCollection<SampleDoc>("sample_docs")
 

examples/src/test/kotlin/ChangeStreamsTest.kt

@@ -9,7 +9,7 @@ import com.mongodb.client.model.changestream.FullDocumentBeforeChange
 import com.mongodb.client.model.changestream.OperationType
 import com.mongodb.kotlin.client.coroutine.MongoClient
 import com.mongodb.kotlin.client.coroutine.MongoCollection
-import io.github.cdimascio.dotenv.dotenv
+import config.getConfig
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
@@ -27,8 +27,8 @@ import kotlin.test.*
 internal class ChangeStreamsTest {
 
     companion object {
-        private val dotenv = dotenv()
-        private val client = MongoClient.create(dotenv["MONGODB_CONNECTION_URI"])
+        private val config = getConfig()
+        private val client = MongoClient.create(config.connectionUri)
         val database = client.getDatabase("censusData")
 
         @AfterAll
@@ -136,8 +136,9 @@ internal class ChangeStreamsTest {
 
     }
 
-    // NOTE: will not work with a shared M0 cluster. Must have a local cluster with a replica set or >=M10 on Atlas.
-    @Test
+    // NOTE: Test is being ignored because it will not work with a shared M0 cluster.
+    // Must have a local cluster with a replica set or >=M10 on Atlas to successfully run.
+    @Ignore
     fun createCollectionWithPreAndPostImagesTest() = runBlocking {
         val collectionName = "myChangeStreamCollection"
         // :snippet-start: create-collection-with-pre-and-post-images
@@ -174,8 +175,9 @@ internal class ChangeStreamsTest {
 
     }
 
-    // NOTE: will not work with a shared M0 cluster. Must have a local cluster with a replica set or >=M10 on Atlas.
-    @Test
+    // NOTE: Test is being ignored because it will not work with a shared M0 cluster.
+    // Must have a local cluster with a replica set or >=M10 on Atlas to successfully run.
+    @Ignore
     fun preImageConfigurationTest() = runBlocking {
         val collectionName = "myChangeStreamCollection2"
         val createdCollection = database.getCollection<Document>(collectionName)

examples/src/test/kotlin/ChangeTest.kt

@@ -1,7 +1,8 @@
+
 import com.mongodb.client.model.Filters
 import com.mongodb.client.model.Updates
 import com.mongodb.kotlin.client.coroutine.MongoClient
-import io.github.cdimascio.dotenv.dotenv
+import config.getConfig
 import kotlinx.coroutines.runBlocking
 import org.bson.codecs.pojo.annotations.BsonId
 import org.junit.jupiter.api.AfterAll
@@ -22,8 +23,8 @@ internal class ChangeTest {
     // :snippet-end:
 
     companion object {
-        val dotenv = dotenv()
-        val client = MongoClient.create(dotenv["MONGODB_CONNECTION_URI"])
+        val config = getConfig()
+        val client = MongoClient.create(config.connectionUri)
         val database = client.getDatabase("paint_store")
         val collection = database.getCollection<PaintOrder>("paint_order")
 

examples/src/test/kotlin/CompoundTest.kt

@@ -2,7 +2,7 @@
 import com.mongodb.client.model.*
 import com.mongodb.client.model.Sorts.*
 import com.mongodb.kotlin.client.coroutine.MongoClient
-import io.github.cdimascio.dotenv.dotenv
+import config.getConfig
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.flow.firstOrNull
 import kotlinx.coroutines.runBlocking
@@ -33,8 +33,8 @@ internal class CompoundOperationsTest {
     )
     // :snippet-end:
     companion object {
-        val dotenv = dotenv()
-        val client = MongoClient.create(dotenv["MONGODB_CONNECTION_URI"])
+        val config = getConfig()
+        val client = MongoClient.create(config.connectionUri)
         val database = client.getDatabase("compound_operations")
         val collection = database.getCollection<FoodOrder>("example")
         val hotelCollection = database.getCollection<HotelRoom>("rooms")

examples/src/test/kotlin/ConnectTest.kt

@@ -1,7 +1,7 @@
 
 import com.mongodb.*
 import com.mongodb.kotlin.client.coroutine.MongoClient
-import io.github.cdimascio.dotenv.dotenv
+import config.getConfig
 import kotlinx.coroutines.runBlocking
 import org.bson.BsonInt64
 import org.bson.Document
@@ -20,8 +20,8 @@ import kotlin.test.*
 internal class ConnectionTest {
 
     companion object {
-        private val dotenv = dotenv()
-        val CONNECTION_URI_PLACEHOLDER = dotenv["MONGODB_CONNECTION_URI"]
+        private val config = getConfig()
+        val CONNECTION_URI_PLACEHOLDER = config.connectionUri
         var higherScopedClient: MongoClient? = null
 
         @AfterAll
@@ -63,7 +63,7 @@ internal class ConnectionTest {
         }
         // :snippet-end:
         higherScopedClient = mongoClient
-        assertEquals(1.0, higherScopedCommandResult["ok"])
+        assertEquals(1, higherScopedCommandResult["ok"])
     }
 
     @Test