Merge branch 'master' into beta

Author: hasezoey

.github/ISSUE_TEMPLATE/bug.md

@@ -13,8 +13,9 @@ Make sure you read [Mastering-Markdown](https://guides.github.com/features/maste
 ## Versions
 
 - NodeJS: 0.0.0
-- mongodb-memory-server-*: 0.0.0
+- mongodb-memory-server-*: 0.0.0 <!--"latest" is not a version-->
 - mongodb(the binary version): 0.0.0
+- mongodb(the js package): 0.0.0
 - mongoose: 0.0.0 <!--remove this if not used-->
 - system: <!--either Windows, MacOS, Linux (with distro and distro version)-->
 

.github/ISSUE_TEMPLATE/question.md

@@ -13,8 +13,9 @@ Make sure you read [Mastering-Markdown](https://guides.github.com/features/maste
 ## Versions
 
 - NodeJS: 0.0.0
-- mongodb-memory-server-*: 0.0.0
-- mongodb: 0.0.0
+- mongodb-memory-server-*: 0.0.0 <!--"latest" is not a version-->
+- mongodb(the binary version): 0.0.0
+- mongodb(the js package): 0.0.0
 - mongoose: 0.0.0 <!--remove this if not used-->
 - system: <!--either Windows, MacOS, Linux (with distro and distro version)-->
 

.github/workflows/tests.yml

@@ -48,7 +48,7 @@ jobs:
         uses: codecov/codecov-action@v2
 
   publish:
-    if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/beta'
+    if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/beta' || startsWith(github.ref, 'refs/heads/old')
     needs: [tests]
     runs-on: ubuntu-latest
     steps:

.releaserc.js

@@ -106,4 +106,13 @@ module.exports = {
     }],
     "@semantic-release/github"
   ],
+  branches: [
+    // from what i read in the semantic-release configuration and in some issues, the order has to be like this:
+    // other branches
+    // main / upstream branch
+    // prerelease branches
+    { name: "old\\/(\\d+)(\\.x)", range: "${name.replace(/^old\\//g, '')}", prerelease: false },
+    "master",
+    { name: "beta", prerelease: true }
+  ]
 };

CHANGELOG.md

@@ -78,6 +78,8 @@ And one of those (on Linux):
 - having an `/etc/*-release` file that is compliant to the [OS-Release Spec](https://www.freedesktop.org/software/systemd/man/os-release.html) (and does not include `lsb`)
 - manually specify which version & system should be used
 
+On Linux, you will also need `libcurl4` (or `libcurl3` on some older distro versions). This will probably only be an issue on "slim" Docker images.
+
 ### Choose the Correct Package
 
 [Choose the right package for the task](https://nodkz.github.io/mongodb-memory-server/docs/guides/quick-start-guide#choose-the-right-package)
@@ -225,7 +227,7 @@ For additional information it is recommended to read this article [Testing a Gra
 
 ### Test Runner Examples
 
-[Documentation for Integration Examples](https://nodkz.github.io/mongodb-memory-server/docs/guides/integration-examples)
+[Documentation for Test Runner Integration Examples](https://nodkz.github.io/mongodb-memory-server/docs/guides/integration-examples/test-runners)
 
 ### Docker Alpine
 

README.md

@@ -45,6 +45,10 @@ Typings: `getUri(otherDb?: string): string`
 
 Get an mongodb-usable uri (can also be used in mongoose)
 
+When no arguments are set, the URI will always use ip `127.0.0.1` and end with `/?replicaSet=ReplSetName` (not setting a database).  
+When setting `otherDbName`, the value of `otherDbName` will be appended after `/` and before any query arguments.  
+When setting `otherIp`, the ip will be the value of `otherIp` instead of `127.0.0.1` (for all instances).
+
 ### start
 
 Typings: `async start(): Promise<void>`
@@ -73,21 +77,23 @@ Ensures and returns that [`_keyfiletmp`](#_keyfiletmp) is defined an exists and
 
 ### stop
 
-Typings: `async stop(runCleanup: boolean = true): Promise<boolean>`
+Typings: `async stop(cleanupOptions?: Cleanup): Promise<boolean>`
 
-Stop an running instance
+Stop an running instance, this function will by default call [`.cleanup`](#cleanup) with `{ doCleanup: true, force: false }`.
 
-This function will by default run [`.cleanup`](#cleanup), this must be set to `false` to be able to restart (and an engine other than `ephemeralForTest` must be used)
+With `cleanupOptions` options for cleanup can be manually set.
 
 :::caution
 Will not Error if instance is not running
 :::
 
 ### cleanup
 
-Typings: `async cleanup(force: boolean = false): Promise<void>`
+Typings: `async cleanup(options?: Cleanup): Promise<void>`
+
+Cleanup all files used by this ReplSet's instances, by default `{ doCleanup: true, force: false }` is used.
 
-Cleanup all files used by this ReplSet & instances
+With `options` can be set how to run a cleanup.
 
 ### waitUntilRunning
 

docs/api/classes/mongo-memory-replset.md

@@ -37,6 +37,9 @@ Typings: `async start(forceSamePort: boolean = false): Promise<boolean>`
 
 Used to start an new Instance or to Re-Start an stopped instance
 
+with `forceSamePort` set to `true` and having `instance.port` set, it will use that port and not generate a new port.  
+with `forceSamePort` set to `true` and not having `instance.port` set, it will generate a new free port.  
+
 :::caution
 Will Error if instance is already running
 :::
@@ -53,7 +56,10 @@ Finds an new non-locked port
 
 <span class="badge badge--warning">Internal</span>
 
-Typings: `protected async getStartOptions(): Promise<MongoMemoryServerGetStartOptions>`
+Typings: `protected async getStartOptions(forceSamePort: boolean = false): Promise<MongoMemoryServerGetStartOptions>`
+
+with `forceSamePort` set to `true` and having `instance.port` set, it will use that port and not generate a new port.  
+with `forceSamePort` set to `true` and not having `instance.port` set, it will generate a new free port.  
 
 Constructs the Starting Options
 
@@ -67,19 +73,23 @@ Internal Functions used by [`start`](#start)
 
 ### stop
 
-Typings: `async stop(runCleanup: boolean = true): Promise<boolean>`
+Typings: `async stop(cleanupOptions?: Cleanup): Promise<boolean>`
+
+Stop an running instance, this function will by default call [`.cleanup`](#cleanup) with `{ doCleanup: true, force: false }`.
 
-Stop an running instance
+With `cleanupOptions` options for cleanup can be manually set.
 
 :::caution
 Will not Error if instance is not running
 :::
 
 ### cleanup
 
-Typings: `async cleanup(force: boolean): Promise<void>`
+Typings: `async cleanup(options?: Cleanup): Promise<void>`
 
-Cleanup all files used by this instance
+Cleanup all files used by this instance, by default `{ doCleanup: true, force: false }` is used.
+
+With `options` can be set how to run a cleanup.
 
 ### ensureInstance
 
@@ -93,10 +103,14 @@ Will Error if instance cannot be started
 
 ### getUri
 
-Typings: `getUri(otherDbName?: string): string`
+Typings: `getUri(otherDbName?: string, otherIp?: string): string`
 
 Get an mongodb-usable uri (can also be used in mongoose)
 
+When no arguments are set, the URI will always use ip `127.0.0.1` and end with `/` (not setting a database).  
+When setting `otherDbName`, the value of `otherDbName` will be appended after `/` and before any query arguments.  
+When setting `otherIp`, the ip will be the value of `otherIp` instead of `127.0.0.1`.
+
 ### createAuth
 
 <span class="badge badge--warning">Internal</span>

docs/api/classes/mongo-memory-server.md

@@ -53,6 +53,12 @@ Search for what version is used:
 - [`windows`](https://www.mongodb.org/dl/win32)
 - [`linux`](https://dl.mongodb.org/dl/linux)
 
+:::note
+When using [`SYSTEM_BINARY`](#system_binary) and [`SYSTEM_BINARY_VERSION_CHECK`](#system_binary_version_check), ONLY the major, minor, and patch versions of the system binary will be compared against the desired binary.
+
+That is, a system binary version of `4.2.19-11-ge2f2736a` will match a mongodb required version of `4.2.19`. DO NOT set the mongodb required version to the full `4.2.19-11-ge2f2736a` version as the check which examines the binary version will strip the additional tags.
+:::
+
 ### DEBUG
 
 Option `DEBUG` is used to enable Debug Output