MongoDB Ephemeral Server

MongoDB Ephemeral Server to test your NodeJS Application.
Explore the docs »

· Report Bug · Request Feature ·

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

This project will spin up an mongodb server specified the configuration for the same. This package uses the ephemeral storage for the database content. This means once the database instance is stopped, all data will be lost.

This makes it ideal for testing purpose or even development(if you wish).

(back to top)

Built With

The project is built using a combination of JavaScript and TypeScript.

• TypeScript
• JavaScript

(back to top)

Getting Started

To install the package simply run the following simple steps

Prerequisites

To run this, please make sure you have to following things installed.

• NodeJs - version 12.x+
• MongoDB - version 4.2+

Installation

• npm

  npm i mongodb-ephemeral-server

(back to top)

Usage

Example code to show the usage of the package:

1. Import the package in your code:

   const mongodbEphemeralServer = require("mongodb-ephemeral-server")

2. Provide the database configurations:

   const PORT = 27025; // Or anything you wish.
   const dbPath = '/home/user/mongodb-ephemeral/data'; // Path to your database
   const logPath = '/home/user/mongodb-ephemeral/log'; // Path to your database logs
   const dbName = 'sample_db_name';
   /**
    * In case you want to run test on windows - add the mongodExeLocation
    * Note adding this on linux won't have any effect
    * So, if you have written test on window machine
    * You need not to worry when running on a linux machine
    */
   const mongodExeLocation = 'C:/Program Files/MongoDB/Server/4.2/bin'

3. Create the ephemeral instance:

   const ephemeralInstance = new mongodbEphemeralServer(port, logpath, dbpath, mongodExeLocation);

4. Start the mongodb-ephemeral-server:

   ephemeralInstance.start();
   const dbUri = ephemeralInstance.getDbUri(dbName);

5. Connect to the database:

   // Connect to the Database using the uri obtained.
   // If using the mongoose ODM use the below code:
   const { mongoose } = require('mongoose');
   await mongoose.connect(dbUri, {});

6. Close the database connection: (Optional)

   // If using the mongoose ODM
   await mongoose.connection.close();

7. Terminate the mongodb-ephemeral-server:

   ephemeralInstance.stop();

For more examples, please refer to the sample project

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Adarrsh Paul - @AdarrshPaul

Project Link: https://github.com/adarrshpaul/mongodb-ephemeral-server

(back to top)