Docz: Begin writing tests across docz

[matchai]

Howdy docz maintainers!

I love the project and the experience of creating documentation with docz! 😄
Unfortunately, I have a tough time trusting that new releases will be reliable. I don't risk upgrading docz on my projects due to the risk involved with having no tests/CI on this project. The more this project grows, the more time and effort it would take for tests to give us confidence that new docz releases are working as intended. 😥

I was hoping to start a conversation where we could plan the future of testing on docz. 🙌

My proposed first steps would be to start adding testing and coverage tooling to the project, and to find the first 20% of coverage that would instill 80% of testing confidence. Such examples would be some simple snapshot tests:

• Testing the fresh installation flow
  
  
  
  • Would help us avoid issues like #416 and #425
  
  
• Component importing
  
  
  
  • External custom components
  
  
  • Built-in components
  
  
• Integration tests for built-in components

I'd love to help kickstart this initiative. Thoughts?

[Jared-Dev]

This is one of those that would be ideal to put in a PR to start the process. After all, it is free to use so if this is a feature that is blocking you from using it... Get the process rolling and there is likely to be someone that would come along and help fill in the gaps!

As I re-read your issue it sounds like this was your plan! I know I have had great luck getting in touch with Pedro to respond on twitter so this could be a great way to just touch base and confirm that if you submit a PR he'd be open to adding testing into the mix! I know I'd love to see them added and would help out where possible :)

[IssueHuntBot]

@boostio funded this issue with $20. See it on IssueHunt

[IssueHuntBot]

@issuehuntfest has funded $40.00 to this issue. See it on IssueHunt

[colshacol]

Count me in. :+1:

[IssueHuntBot]

@rororofff has funded $2.00 to this issue.

---

• Submit pull request via IssueHunt to receive this reward.
• Want to contribute? Chip in to this issue via IssueHunt.
• Checkout the IssueHunt Issue Explorer to see more funded issues.
• Need help from developers? Add your repository on IssueHunt to raise funds.

[nmccready]

I'd love to join in on this, but currently I can't even get dev to pass it's current tests. (WRT failing tests) Why is this project setup with yarn workspaces. I thought workspaces were for lerna projects which are private and unpublished.

The main test that is failing is here . Where remark-docz can not be found. Sure enough none of the dependencies for rehype-docz are being installed, nor hoisted.

There is a serious need for tests across the board as well as lerna love.

This project is super awesome, but I would like to get some reasoning so I or others can figure out where to go.

[dmtrKovalenko]

I can help you with adding some cypress tests :)

[matchai]

@rakannimer Could you provide some context around this issue having been closed?
What areas of docz are now being tested?
What should see more community contribution?

[rakannimer]

Hey @matchai,

Could you provide some context around this issue having been closed?

Sorry for closing the issue without explanation. I bulk-closed issues with no activity in the last 4 months to be able to focus on more recent, active and actionable issues. In hindsight, I see this was not a great idea, as some people, understandably, took it as a dismissal of their work. This was not my intent.

What areas of docz are now being tested?

Not as much as we'd like but a good enough start.

3 kinds of tests are run against docz on every commit :

Static tests

docz packages are usually tested statically by using eslint, the TypeScript compiler and/or making sure packages can be built.

yarn packages in particular will lint, fix and build all packages that support it.

Area of improvement : Some packages don't have linting configured (e.g. gatsby-theme-docz), we should configure them and add a lint package.json script.

Unit & integration tests

docz packages like docz-core, rehype-docz, remark-docz and babel-plugin-export-metadata run unit and integration tests with Jest

Area of improvement : Add more tests to existing packages + setup testing in the rest of the packages.

End-to-end tests

docz's end to end tests make sure that creating and running a docz project works.

Currently the test :

1. Runs an instance of verdaccio
2. Publishes docz packages to the local registry
3. Copies an example (examples/basic, examples/gatsby) to a new temporary file
4. Installs dependencies in temp directories from local registry
5. Start docz server in directories
6. Runs e2e web tests with testcafe

Read more here : https://github.com/doczjs/docz/tree/master/other-packages/e2e-tests

Area of improvement : Run tests on more examples. Add more cases and user paths to e2e tests.

What should see more community contribution?

The area of improvements I suggested above should give an idea of the work available.
Maybe we can break them down to new actionable issues that the community can work on ?

We're also on the docz slack channel if you'd like to chat in a less async-y way.