Nest: Testing Documentation

Created on 4 Mar 2018 · 5Comments · Source: nestjs/nest

I'm submitting a...


[ ] Regression 
[ ] Bug report
[ ] Feature request
[X] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

Looking through the documentation and the examples, testing feels like it is taking a back seat to delivering an exceptional Node framework.

Expected behavior

Let's try to make testing a first class citizen in the documentation and examples.

Minimal reproduction of the problem with instructions

N/A

What is the motivation / use case for changing the behavior?

Testing is fundamental to developing high-quality code and can make discovering problems so much easier in large scale enterprise and e-commerce applications. I don't think any of the examples contain tests and test documentation is limited to a couple of short pages. Specifically, the e2e testing documentation could probably use some love.

Environment

N/A

discussion 🔥 type

Source

patrickhousley

👍6

Most helpful comment

To kick off the discussion, let me add the below:

Tests should be wrote for all the examples.
Run all tests in the examples as part of CI. Consider these e2e testing for Nest itself.
Document unit and e2e testing of a controller and component that depends on the CQRS module.
Document unit and e2e testing of microservice controller and component.
Document unit and e2e testing of a middleware, pipe, guard, and interceptor for core, microservice, and websocket.

These are some initial items that I think could use a bit of love.

patrickhousley on 4 Mar 2018

👍22

All 5 comments

To kick off the discussion, let me add the below:

Tests should be wrote for all the examples.
Run all tests in the examples as part of CI. Consider these e2e testing for Nest itself.
Document unit and e2e testing of a controller and component that depends on the CQRS module.
Document unit and e2e testing of microservice controller and component.
Document unit and e2e testing of a middleware, pipe, guard, and interceptor for core, microservice, and websocket.

These are some initial items that I think could use a bit of love.

patrickhousley on 4 Mar 2018

👍22

Hey Patrick, can you add also to document Mongoose testing? I can't seem to test models that I injected into services.

vanor89 on 4 Mar 2018

👍2

I totally agree with that. There're plans to significantly improve a documentation, but I'm a little bit behind due to development stuff so far. I promise it's gonna change in the near future :)