feat(ts-sdk): added support for test coverage (#29)

* fix(express.ts): header and body issue

* fix(express.ts): header and body issue

* fix(express.ts): header and body issue

* fix(express.ts): header and body issue

* feat:changes for check method

* adding

* check method update

* check method update

* wip

* fix: call create inside middleware

* fix: adds calls for test and denoise methods

during capturing the response a subsequent denoise call is made to identify the noise fields and
test method is fixed to test the captured api responses

* refactor: removes unfinished changes

* style: fixes sethttpheaders

* fix(simulate): adds request headers in simulate api call

* fix: adds time delay before calling test function

* fix(register): adds the properties of express object into wrapped object

* fix: fixes borales/action-yarn version to 2.1.0

* fix(middleware): adds finish event callback to record the asynchronous responses from the handlers

makes a call to capture the testcases before sending the response to the client and after res.send
call by the handler.

* docs: adds documentation for integration with ts/js server

* feat(ts-sdk): added support for test coverage

* docs(ts-sdk): adding example for testing framework

* docs(ts-sdk): adding example for testing framework

* docs(ts-sdk): adding example for testing framework

* feat(ts-sdk): added support for test coverage

* fix: merge conflicts

* fix: merge conflicts

* commiting

* docs(ts-sdk): updating readme

Signed-off-by: Pradhyuman-sharma <sharmapuru0642@gmail.com>

Signed-off-by: Pradhyuman-sharma <sharmapuru0642@gmail.com>
Co-authored-by: re-Tick <jain.ritik.1001@gmail.com>
Co-authored-by: Rajat Sharma <lunasunkaiser@gmail.com>

Author: 3 people

README.md

@@ -3,15 +3,15 @@
 [![License](.github/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 # Keploy Typescript-SDK
-[Keploy](https://keploy.io) is a no-code testing platform that generates tests from API calls. This is the Typescript client SDK for recording and replaying the API Calls. There are 2 modes: 
+[Keploy](https://keploy.io) is a no-code testing platform that generates tests from API calls. This is the Typescript client SDK for recording and replaying the API Calls. There are 2 modes:
 1. **Record mode**
     1. Record requests, response and sends to Keploy server.
     2. After keploy server removes duplicates, it then runs the request on the API again to identify noisy fields.
-    3. Sends the noisy fields to the keploy server to be saved along with the testcase. 
+    3. Sends the noisy fields to the keploy server to be saved along with the testcase.
 2. **Test mode**
-    1. Fetches testcases for the app from keploy server. 
-    2. Calls the API with same request payload in testcase. 
-    3. Validates the respones and uploads results to the keploy server. 
+    1. Fetches testcases for the app from keploy server.
+    2. Calls the API with same request payload in testcase.
+    3. Validates the respones and uploads results to the keploy server.
 
 ## Contents
 1. [Installation](#installation)
@@ -30,7 +30,6 @@ npm i https://github.com/keploy/typescript-sdk
 require("typescript-sdk/dist/integrations/express/register");
 ```
 ## Configure
-Keploy can be configured by environment varibales. Below is an example .env file
 ```
 export KEPLOY_MODE="test"
 export KEPLOY_APP_NAME="my-app"
@@ -46,10 +45,10 @@ export KEPLOY_SERVER_URL="http://localhost:8081/api" # self hosted keploy runnin
 ### KEPLOY_MODE
 There are 3 modes:
  - **Record**: Sets to record mode.
- - **Test**: Sets to test mode. 
+ - **Test**: Sets to test mode.
  - **Off**: Turns off all the functionality provided by the API
 
-**Note:** `KEPLOY_MODE` value is case sensitive. 
+**Note:** `KEPLOY_MODE` value is case sensitive.
 
 ## Supported Frameworks
 ### 1. Express
@@ -87,6 +86,29 @@ npm i -g yarn
 yarn install
 ```
 
+### Integration with Mocha testing framework
+You just need to do some imports and call a built-in assert function in your code in your unit test file and that's it!!🔥🔥🔥
+```js
+const {runServer} = require('../server') //your server wrapper
+const {keploy}  = require('typescript-sdk/dist/integrations/express/register')
+const {describe,test,before,after}=  require('mocha')
+describe("test function", ()=>{
+    before( (done)=>{
+            keploy.setTestMode();
+            runServer()
+            done()
+          })
+    test("should be running", async ()=> {
+      await keploy.assertTests();
+    });
+    after(()=>{
+         process.exit(1); //exits the node server
+       })
+})
+```
+Note:- To see code coverage please use nyc mocha and see how many lines are covered!!
+
+
 - Furthermore, to commit your changes use `yarn commit` instead of `git commit` for better commit experience.
 
 - For VSCode setup, make sure these extensions are installed:

integrations/express/register.ts

@@ -5,15 +5,14 @@ import Keploy from "../../src/keploy";
 import bodyParser from "body-parser";
 import cors from "cors";
 import mixin from "merge-descriptors";
+const keploy = new Keploy();
 
 // @ts-ignore
 Hook(["express"], function (exports) {
   const expressApp = exports;
-
   function keployWrappedExpress() {
     const keployApp = expressApp();
 
-    const keploy = new Keploy();
     keployApp.use(bodyParser.json());
     keployApp.use(cors());
     keployApp.use(expressMiddleware(keploy));
@@ -28,3 +27,4 @@ Hook(["express"], function (exports) {
   exports = keployWrappedExpress;
   return exports;
 });
+export { keploy };