Skip to content

Fixing unit testing docs for Strapi 5 #2308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 9, 2024
Merged

Fixing unit testing docs for Strapi 5 #2308

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3168923
Update the first message to remove v4 docs and to let users know that…
kasonde Dec 6, 2024
a7a1008
Remove the testEnvironment key because it's already set to the Jest d…
kasonde Dec 6, 2024
72b47ba
Update setupStrapi function for Strapi 5
kasonde Dec 6, 2024
d1d6070
Remove the unneeded fs module import at the top of this example
kasonde Dec 6, 2024
f42ddf8
It's important to add this so that the correct database config file i…
kasonde Dec 6, 2024
f003853
Change callout at the top of the page
kasonde Dec 9, 2024
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions docusaurus/docs/dev-docs/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ tags:

# Unit testing

:::strapi
The Strapi blog has a tutorial on how to implement [API testing with Jest and Supertest](https://strapi.io/blog/automated-testing-for-strapi-api-with-jest-and-supertest) and [how to add unit tests to your Strapi plugin](https://strapi.io/blog/how-to-add-unit-tests-to-your-strapi-plugin).
:::info
Currently, our docs are only for Javascript projects that wish to have unit testing setup. We will update our docs soon as soon as we have the Typescript equivalent code samples available.
:::

In this guide we will see how you can run basic unit tests for a Strapi application using a testing framework.
Expand Down Expand Up @@ -74,7 +74,6 @@ and add those lines at the bottom of file
".tmp",
".cache"
],
"testEnvironment": "node"
}
```

Expand Down Expand Up @@ -119,7 +118,7 @@ let instance;

async function setupStrapi() {
if (!instance) {
await Strapi().load();
await Strapi.createStrapi().load();
instance = strapi;

await instance.server.mount();
Expand Down Expand Up @@ -153,7 +152,6 @@ module.exports = { setupStrapi, cleanupStrapi };
We need a main entry file for our tests, one that will also test our helper file.

```js title="path: ./tests/app.test.js"
const fs = require('fs');
const { setupStrapi, cleanupStrapi } = require("./helpers/strapi");

beforeAll(async () => {
Expand All @@ -169,7 +167,7 @@ it("strapi is defined", () => {
});
```

Actually this is all we need for writing unit tests. Just run `yarn test` and see a result of your first test
Actually this is all we need for writing unit tests. Just run `NODE_ENV=test yarn test` and see a result of your first test

```bash
yarn run v1.13.0
Expand Down