Merge pull request #51 from supercharge/wait-for-mongodb

Wait for Single Instance MongoDB

CHANGELOG.md

@@ -1,6 +1,15 @@
 # Changelog
 
 
+## [1.10.0](https://github.com/superchargejs/mongodb-github-action/compare/v1.9.0...v1.10.0) - 2023-08-07
+
+### Added
+- MongoDB single instance: wait for MongoDB to be ready
+
+### Updated
+- bump dependencies
+
+
 ## [1.9.0](https://github.com/superchargejs/mongodb-github-action/compare/v1.8.0...v1.9.0) - 2023-02-10
 
 ### Added

README.md

@@ -45,7 +45,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [18.x, 20.x]
         mongodb-version: ['4.2', '4.4', '5.0', '6.0']
 
     steps:
@@ -58,7 +58,7 @@ jobs:
         node-version: ${{ matrix.node-version }}
 
     - name: Start MongoDB
-      uses: supercharge/mongodb-github-action@1.8.0
+      uses: supercharge/mongodb-github-action@1.10.0
       with:
         mongodb-version: ${{ matrix.mongodb-version }}
 
@@ -85,7 +85,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [18.x, 20.x]
         mongodb-version: ['4.2', '4.4', '5.0', '6.0']
 
     steps:
@@ -98,7 +98,7 @@ jobs:
         node-version: ${{ matrix.node-version }}
 
     - name: Start MongoDB
-      uses: supercharge/mongodb-github-action@1.8.0
+      uses: supercharge/mongodb-github-action@1.10.0
       with:
         mongodb-version: ${{ matrix.mongodb-version }}
         mongodb-replica-set: test-rs
@@ -129,7 +129,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [18.x, 20.x]
         mongodb-version: ['4.2', '4.4', '5.0', '6.0']
 
     steps:
@@ -142,7 +142,7 @@ jobs:
         node-version: ${{ matrix.node-version }}
 
     - name: Start MongoDB
-      uses: supercharge/mongodb-github-action@1.8.0
+      uses: supercharge/mongodb-github-action@1.10.0
       with:
         mongodb-version: ${{ matrix.mongodb-version }}
         mongodb-replica-set: test-rs
@@ -173,7 +173,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [18.x, 20.x]
         mongodb-version: ['4.2', '4.4', '5.0', '6.0']
 
     steps:
@@ -186,7 +186,7 @@ jobs:
         node-version: ${{ matrix.node-version }}
 
     - name: Start MongoDB
-      uses: supercharge/mongodb-github-action@1.8.0
+      uses: supercharge/mongodb-github-action@1.10.0
       with:
         mongodb-version: ${{ matrix.mongodb-version }}
         mongodb-username: supercharge

package.json

@@ -7,11 +7,11 @@
     "url": "https://github.com/supercharge/mongodb-github-action/issues"
   },
   "devDependencies": {
-    "@supercharge/eslint-config": "~1.1.2",
-    "c8": "~7.12.0",
-    "eslint": "~8.33.0",
-    "expect": "~29.4.2",
-    "mongoose": "~6.9.1",
+    "@supercharge/eslint-config": "~2.0.0",
+    "c8": "~8.0.1",
+    "eslint": "~8.46.0",
+    "expect": "~29.6.2",
+    "mongoose": "~7.4.2",
     "uvu": "~0.5.6"
   },
   "engines": {

start-mongodb.sh

@@ -8,6 +8,9 @@ MONGODB_DB=$4
 MONGODB_USERNAME=$5
 MONGODB_PASSWORD=$6
 
+# `mongosh` is used starting from MongoDB 5.x
+MONGODB_CLIENT="mongosh --quiet"
+
 
 if [ -z "$MONGODB_VERSION" ]; then
   echo ""
@@ -20,15 +23,48 @@ fi
 
 echo "::group::Selecting correct MongoDB client"
 if [ "`echo $MONGODB_VERSION | cut -c 1`" = "4" ]; then
-  MONGO_CLIENT="mongo"
-else
-  MONGO_CLIENT="mongosh --quiet"
+  MONGODB_CLIENT="mongo"
 fi
-echo "  - Using [$MONGO_CLIENT]"
+echo "  - Using MongoDB client: [$MONGODB_CLIENT]"
 echo ""
 echo "::endgroup::"
 
 
+# Helper function to wait for MongoDB to be started before moving on
+wait_for_mongodb () {
+  echo "::group::Waiting for MongoDB to accept connections"
+  sleep 1
+  TIMER=0
+
+  MONGODB_ARGS=""
+
+  if [ -z "$MONGODB_REPLICA_SET" ]
+  then
+    if [ -z "$MONGODB_USERNAME" ]
+    then
+      MONGODB_ARGS=""
+    else
+      # no replica set, but username given: use them as args
+      MONGODB_ARGS="--username $MONGODB_USERNAME --password $MONGODB_PASSWORD"
+    fi
+  fi
+
+  # until ${WAIT_FOR_MONGODB_COMMAND}
+  until docker exec --tty mongodb $MONGODB_CLIENT --port $MONGODB_PORT $MONGODB_ARGS --eval "db.serverStatus()"
+  do
+    echo "."
+    sleep 1
+    TIMER=$((TIMER + 1))
+
+    if [[ $TIMER -eq 20 ]]; then
+      echo "MongoDB did not initialize within 20 seconds. Exiting."
+      exit 2
+    fi
+  done
+  echo "::endgroup::"
+}
+
+
 if [ -z "$MONGODB_REPLICA_SET" ]; then
   echo "::group::Starting single-node instance, no replica set"
   echo "  - port [$MONGODB_PORT]"
@@ -37,15 +73,17 @@ if [ -z "$MONGODB_REPLICA_SET" ]; then
   echo "  - credentials [$MONGODB_USERNAME:$MONGODB_PASSWORD]"
   echo ""
 
-  docker run --name mongodb --publish $MONGODB_PORT:27017 -e MONGO_INITDB_DATABASE=$MONGODB_DB -e MONGO_INITDB_ROOT_USERNAME=$MONGODB_USERNAME -e MONGO_INITDB_ROOT_PASSWORD=$MONGODB_PASSWORD --detach mongo:$MONGODB_VERSION
+  docker run --name mongodb --publish $MONGODB_PORT:$MONGODB_PORT -e MONGO_INITDB_DATABASE=$MONGODB_DB -e MONGO_INITDB_ROOT_USERNAME=$MONGODB_USERNAME -e MONGO_INITDB_ROOT_PASSWORD=$MONGODB_PASSWORD --detach mongo:$MONGODB_VERSION --port $MONGODB_PORT
 
   if [ $? -ne 0 ]; then
       echo "Error starting MongoDB Docker container"
       exit 2
   fi
   echo "::endgroup::"
 
-  return
+  wait_for_mongodb
+
+  exit 0
 fi
 
 
@@ -63,28 +101,11 @@ if [ $? -ne 0 ]; then
 fi
 echo "::endgroup::"
 
-
-echo "::group::Waiting for MongoDB to accept connections"
-sleep 1
-TIMER=0
-
-until docker exec --tty mongodb $MONGO_CLIENT --port $MONGODB_PORT --eval "db.serverStatus()" # &> /dev/null
-do
-  sleep 1
-  echo "."
-  TIMER=$((TIMER + 1))
-
-  if [[ $TIMER -eq 20 ]]; then
-    echo "MongoDB did not initialize within 20 seconds. Exiting."
-    exit 2
-  fi
-done
-echo "::endgroup::"
-
+wait_for_mongodb
 
 echo "::group::Initiating replica set [$MONGODB_REPLICA_SET]"
 
-docker exec --tty mongodb $MONGO_CLIENT --port $MONGODB_PORT --eval "
+docker exec --tty mongodb $MONGODB_CLIENT --port $MONGODB_PORT --eval "
   rs.initiate({
     \"_id\": \"$MONGODB_REPLICA_SET\",
     \"members\": [ {
@@ -99,7 +120,5 @@ echo "::endgroup::"
 
 
 echo "::group::Checking replica set status [$MONGODB_REPLICA_SET]"
-docker exec --tty mongodb $MONGO_CLIENT --port $MONGODB_PORT --eval "
-  rs.status()
-"
+docker exec --tty mongodb $MONGODB_CLIENT --port $MONGODB_PORT --eval "rs.status()"
 echo "::endgroup::"

test/custom-port/custom-port.js

@@ -4,7 +4,7 @@ const { test } = require('uvu')
 const Mongoose = require('mongoose')
 
 test('connects to MongoDB on custom port 12345', async () => {
-  const connection = await Mongoose.createConnection('mongodb://localhost:12345').asPromise()
+  const connection = await Mongoose.createConnection('mongodb://localhost:12345')
   await connection.close()
 })
 

test/single-instance/single-instance.js

@@ -12,7 +12,7 @@ test('connects to MongoDB', async () => {
     pass: MONGODB_PASSWORD,
     dbName: MONGODB_DB,
     authSource: MONGODB_USERNAME && MONGODB_PASSWORD ? 'admin' : undefined
-  }).asPromise()
+  })
 
   await connection.close()
 })