Merge pull request #131 from Real-Dev-Squad/feature/test-suite

[1] Integrate firestore emulator in test suite

Author: ankurnarkhede

.github/workflows/test.yml

@@ -28,6 +28,7 @@ jobs:
       uses: actions/setup-node@v1
       with:
         node-version: ${{ matrix.node-version }}
+    - run: npm install -g firebase-tools
     - run: npm install
     - run: npm run build --if-present
     - run: npm test

.gitignore

@@ -22,6 +22,7 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
+.coverage
 *.lcov
 
 # nyc test coverage

CONTRIBUTING.md

@@ -5,6 +5,8 @@
 - [NPM Command Reference](#npm-command-reference)
 - [Project Structure](#project-structure)
 - [Generating Authentication Token](#generating-authentication-token)
+- [Testing Guidelines](#testing-guidelines)
+- [Using Firebase Emulator Locally](#using-firebase-emulator-locally)
 - [Pull request guidelines](#pull-request-guidelines)
 
 ## Getting Started
@@ -58,22 +60,27 @@ The following project structure should be followed:
     |   |-- auth.js // the individual routes files should contain the OPEN API JSDOC reference
     |-- services
     |   |-- authService.js // Files using any 3rd party library/service or providing any secific service in the project
+    |-- scripts // Standalone scripts
     |-- test
     |   |-- fixtures
     |   |   |-- auth
     |   |       |-- githubUserInfo.js
     |   |-- integration // Integration tests
     |   |   |-- authController.test.js
     |   |-- unit // Unit tests
+    |   |   |-- middlewares
+    |   |   |-- services
+    |   |-- utils // Utility functions to be used while testing
     |-- utils // Files containing utility functions
     |    |-- logger.js
     |-- .github
     |   |-- workflows
     |       |-- // Github actions files
     |-- .gitignore
-    |-- .*rc, .*js, .*json, .*yml // config files for dependencies 
+    |-- .*rc, .*js, .*json, .*yml // config files for dependencies
     |-- CONTRIBUTING.md
     |-- README.md
+    |-- CHANGELOG.md
     |-- app.js
     |-- firestore-private-key.json // Firestore key file
     |-- package-lock.json
@@ -91,9 +98,31 @@ The following project structure should be followed:
 - For non-production environments, authentication is also supported with the `Authorization` header.
 - Authorization header: `Authorization: Bearer <token>`
 
+## Testing Guidelines
+- Libraries used in testing in the project:
+  - [mocha](https://mochajs.org/): Test framework
+  - [chai](https://www.chaijs.com/): Assertion library
+  - [sinon](https://sinonjs.org/): JavaScript test spies, stubs and mocks
+  - [nock](https://github.com/nock/nock/blob/main/README.md): HTTP requests mocking
+- The test suite uses [Firebase Local Emulator Suite](https://firebase.google.com/docs/emulator-suite) for running firestore for tests([documentation](https://firebase.google.com/docs/emulator-suite/install_and_configure)).
+- Pre-requisites:
+  - Node.js version 8.0 or higher.
+  - Java version 1.8 or higher.
+  - Firebase CLI: `npm install -g firebase-tools`
+
+## Using Firebase Emulator Locally
+- [Firebase Local Emulator Suite](https://firebase.google.com/docs/emulator-suite) can be used locally as the DB for the project
+- Pre-requisites:
+  - Node.js version 8.0 or higher.
+  - Java version 1.8 or higher.
+  - Firebase CLI: `npm install -g firebase-tools`
+- Run: `firebase emulators:start`
+- The emulator will be running on the port: 8080
+- You can view the emulator UI at: `http://localhost:4000`
+
 ## Pull request guidelines
 - Ensure that the tests pass locally before raising a PR.
-- All pull requests should be to the develop branch. 
+- All pull requests should have base as the develop branch.
 - Every pull request should have associated issue(s) on our [issue tracker](https://github.com/Real-Dev-Squad/website-backend/issues).
 - For any non-trivial fixes and features, unit and integration tests must be added. The PR reviewer should not approve/merge PR(s) that lack these.
 - The PR(s) should be merged only after the CI passes.

README.md

@@ -17,24 +17,31 @@
 This Project serves the backend APIs required for [Real Dev Squad](https://realdevsquad.com/) web projects. This project is built in [Express.js](https://expressjs.com/).
 
 ## Running the Project
-```shell script
+```shell
 $ npm install
-$ npm start 
+$ npm start
 ```
 #### Running in dev mode
-```shell script
+```shell
 $ npm run dev
 ```
 
+#### Test local setup
+```shell
+$ npm run test-config
+```
+
 ## Prerequisites
+- The application uses [node-config](https://github.com/lorenwest/node-config)([documentation](https://github.com/lorenwest/node-config/wiki/Configuration-Files)) for managing config.
 - Create a new file: `config/local.js`. Override the required config values from `config/development.js` and `config/default.js` into `config/local.js`.
 - Register the application for [GitHub OAuth](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps) to get the `clientId` and `clientSecret`. Add the callback URL as `http://<HOSTNAME>:<PORT>/auth/github/callback`
-- Create an application on [FireStore](https://firebase.google.com/docs/firestore) and [generate a service file](https://cloud.google.com/iam/docs/creating-managing-service-account-keys). Add the service file with the name `firestore-private-key.json` in the project root. 
-- Make sure your local development setup is working properly by running the following command: `npm run test-config`.
+- Create an application on [FireStore](https://firebase.google.com/docs/firestore) and [generate a service file](https://cloud.google.com/iam/docs/creating-managing-service-account-keys). Add the service file with the name `firestore-private-key.json` in the project root.
 
 ## API Documentation:
 - Run the server and navigate to `http://<HOSTNAME>:<PORT>/api-docs` to view the API documentation.
 - Alternatively, you can import the file [API Schema](https://github.com/Real-Dev-Squad/website-backend/blob/develop/public/apiSchema.json) to [Postman](https://www.postman.com/) or [SwaggerHub](https://swagger.io/tools/swaggerhub/).
 - If any API changes have been made:
     - Write JS Doc on top of your routes using YAML based annotations in OPEN API 3.0 format.
     - Run `npm run generate-api-schema` to generate the API schema. A file `public/apiSchema.json` will be created/updated.
+
+Read more about contributing to the project: [CONTRIBUTING](CONTRIBUTING.md)

config/test.js

@@ -47,5 +47,11 @@ module.exports = {
       'QnrvpfRSihRktA2dDQJAH+dQBx3nG3bZ9khVAZQ1jTJ7j0cKixaGndFuYS1TJvJ2\n' +
       'Zzn584h/xbSIcP9/4SXmEK3wtoueUtMkvS3yKTvk+w==\n' +
       '-----END RSA PRIVATE KEY-----'
+  },
+
+  db: {
+    firestore: {
+      projectId: 'rds-dev'
+    }
   }
 }

firebase.json

@@ -0,0 +1,11 @@
+{
+  "emulators": {
+    "firestore": {
+      "port": 8080
+    },
+    "ui": {
+      "enabled": true,
+      "port": 4000
+    }
+  }
+}

nyc.config.js

@@ -0,0 +1,13 @@
+/**
+ * Nyc coverage config
+ * Documentation: https://github.com/istanbuljs/nyc#common-configuration-options
+ */
+module.exports = {
+  all: true,
+  exclude: [
+    '**/test.js'
+  ],
+  reporter: ['text', 'lcov', 'text-summary'],
+  reportDir: '.coverage',
+  tempDir: '.coverage'
+}