feat: prevent polluting normal testing

Author: wwayne

.eslintignore

@@ -1,2 +1,3 @@
 lib/
-bin/
+bin/
+examples/

examples/.gitignore

@@ -0,0 +1 @@
+*.yaml

examples/README.md

@@ -0,0 +1 @@
+##

examples/express+mocha/cases1.test.js

@@ -0,0 +1,72 @@
+const request = require('supertest');
+
+const app = require('./index.js');
+
+describe('api testing', () => {
+  it('should able to find all', (done) => {
+    request(app)
+      .get('/projects')
+      .set('x-api-key', 'outdoc-test')
+      .expect(200)
+      .end(function(err, res) {
+        if (err) throw err;
+        done();
+      });
+  });
+
+  it('should able to find one', (done) => {
+    request(app)
+      .get('/projects/uuid-1234')
+      .expect(200)
+      .end(function(err, res) {
+        if (err) throw err;
+        done();
+      });
+  });
+
+  it('should able to find one 401', (done) => {
+    request(app)
+      .get('/projects/401')
+      .expect(401)
+      .end(function(err, res) {
+        if (err) throw err;
+        done();
+      });
+  });
+
+  it('should able to find one 404', (done) => {
+    request(app)
+      .get('/projects/404')
+      .expect(404)
+      .end(function(err, res) {
+        if (err) throw err;
+        done();
+      });
+  });
+
+  describe('users', () => {
+    it('should able to find one user', (done) => {
+      request(app)
+        .get('/users/user-wayne')
+        .expect(200)
+        .end(function(err, res) {
+          if (err) throw err;
+          done();
+        });
+    });
+
+    it('should able to post', (done) => {
+      request(app)
+        .post('/users')
+        .set('content-type', 'application/json')
+        .send({
+          name: 'user wayne'
+        })
+        .expect(201)
+        .end(function(err, res) {
+          if (err) throw err;
+          done();
+        });
+    });
+  });
+});

examples/express+mocha/cases2.test.js

@@ -0,0 +1,46 @@
+const request = require('supertest');
+
+const app = require('./index.js');
+
+describe('api testing', () => {
+  it('should able to path', (done) => {
+    request(app)
+      .patch('/projects/uuid-1234')
+      .set('Accept', 'application/json')
+      .send({
+        project: {
+          tags: ['2016', '2017']
+        }
+      })
+      .expect(200)
+      .end(function(err, res) {
+        if (err) throw err;
+        done();
+      });
+  });
+
+  it('should able to post', (done) => {
+    request(app)
+      .post('/projects')
+      .set('content-type', 'application/json')
+      .set('x-api-key', 'wayne-test')
+      .send({
+        name: 'john'
+      })
+      .expect(201)
+      .end(function(err, res) {
+        if (err) throw err;
+        done();
+      });
+  });
+
+  it('should able to delete', (done) => {
+    request(app)
+      .delete('/projects/uuid-2')
+      .expect(204)
+      .end(function(err, res) {
+        if (err) throw err;
+        done();
+      });
+  });
+});

examples/index.js examples/express+mocha/index.jsexamples/index.js renamed to examples/express+mocha/index.js

@@ -1,10 +1,10 @@
-const express = require('express')
-const app = express()
-const port = 3000
+const express = require('express');
+const app = express();
+const port = 3000;
 
 if (process.env.NODE_ENV === "test") {
-  const { OutDoc } = require('outdoc')
-  OutDoc.init()
+  const { OutDoc } = require('../../lib/index');
+  OutDoc.init();
 }
 
 app.get('/projects', (req, res) => {
@@ -14,67 +14,63 @@ app.get('/projects', (req, res) => {
   }, {
     id: '2',
     name: 'cominsoon'
-  }])
-})
+  }]);
+});
 
 app.get('/projects/:id', (req, res) => {
-  const { id } = req.params
+  const { id } = req.params;
   if (id === "404") {
-    return res.sendStatus(404)
+    return res.sendStatus(404);
   }
   if (id === "401") {
     return res.status(401).json({
       error: {
         code: '123',
         message: '401 unauth'
       }
-    })
+    });
   }
   return res.json({
     id: '2',
     name: 'cominsoon'
-  })
-})
+  });
+});
 
 app.patch('/projects/:id', (req, res) => {
   res.json([{
     id: '2',
     name: 'cominsoon'
-  }])
-})
+  }]);
+});
 
 app.post('/projects', (req, res) => {
   res.status(201).json([{
     id: '1',
     name: 'dapi v1'
-  }])
-})
+  }]);
+});
 
 app.delete('/projects/:id', (req, res) => {
-  res.sendStatus(204)
-})
+  res.sendStatus(204);
+});
 
 app.get('/users/:id', (req, res) => {
-  const { id } = req.params
+  const { id } = req.params;
   return res.json({
     id: '1',
     name: 'wayne user'
-  })
-})
+  });
+});
 
 app.post('/users', (req, res) => {
   res.status(201).json([{
     id: '1',
     name: 'user v1'
-  }])
-})
-
-// app.listen(port, () => {
-//   console.log(`Example app listening on port ${port}`)
-// })
+  }]);
+});
 
 if (process.env.NODE_ENV !== 'test') {
-  app.listen(port, () => console.log(`Listening on port ${port}`))
+  app.listen(port, () => console.log(`Listening on port ${port}`));
 }
 
 module.exports = app;

examples/package.json

@@ -3,7 +3,10 @@
   "version": "1.0.0",
   "description": "examples for outdoc",
   "main": "index.js",
-  "scripts": {},
+  "scripts": {
+    "express-mocha:test": "mocha -b --timeout 10000 --reporter spec --exit express+mocha/*.test.js",
+    "express-mocha": "outdoc npm run express-mocha:test"
+  },
   "dependencies": {
     "express": "^4.18.1"
   },

src/index.ts

@@ -33,6 +33,9 @@ type serverResType = {
 
 export class OutDoc {
   public static init (): void {
+    // Prevent pollute running normal testing
+    if (process.env.IS_OUTDOC !== 'true') return
+
     const asyncHook = async_hooks.createHook({
       init: (
         asyncId: number,

src/runner.ts

@@ -52,7 +52,12 @@ export async function runner (
 
   const childProcess = spawn(args[0], args.slice(1), {
     detached: true,
-    stdio: ["inherit", "inherit", "pipe"]
+    stdio: ["inherit", "inherit", "pipe"],
+    env: {
+      ...process.env,
+      NODE_ENV: 'test',
+      IS_OUTDOC: 'true'
+    }
   });
 
   childProcess.stderr.on('data', (data) => {