From be6ff3ba4d37856eaf8f61c646c32216c1635913 Mon Sep 17 00:00:00 2001 From: veh3546 <113540609+veh3546@users.noreply.github.com> Date: Thu, 25 Apr 2024 09:37:48 -0400 Subject: [PATCH 1/4] Update running-the-api.md --- .../running-things-locally/running-the-api.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/contributing-to-keyshade/running-things-locally/running-the-api.md b/docs/contributing-to-keyshade/running-things-locally/running-the-api.md index 2a472974..a34011cb 100644 --- a/docs/contributing-to-keyshade/running-things-locally/running-the-api.md +++ b/docs/contributing-to-keyshade/running-things-locally/running-the-api.md @@ -26,18 +26,16 @@ pnpm run dev:api ## Testing your code -We currently perform two kinds of tests: **unit tests** and **integration tests.** +We currently perform two kinds of tests: **unit tests** and **e2e tests.** After you make sure that you have added your unit tests, or you have made some changes to the existing functionality, you can run them using: ```bash -pnpm run test:api +pnpm run unit:api ``` -After this is complete, you can run the integration tests. But for that, you would first need your test DB to be up and running. These commands will do of that for you. +After this is complete, you can run end-to-end tests to validate your entire application from start to finish. Use this command: ```bash -docker compose up -d pnpm run e2e:api -docker compose down ``` From c2963f3ba2173b975936b365be1f7366109a640a Mon Sep 17 00:00:00 2001 From: veh3546 <113540609+veh3546@users.noreply.github.com> Date: Thu, 25 Apr 2024 11:12:54 -0400 Subject: [PATCH 2/4] Update running-the-api.md --- .../running-things-locally/running-the-api.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/contributing-to-keyshade/running-things-locally/running-the-api.md b/docs/contributing-to-keyshade/running-things-locally/running-the-api.md index a34011cb..2178cb90 100644 --- a/docs/contributing-to-keyshade/running-things-locally/running-the-api.md +++ b/docs/contributing-to-keyshade/running-things-locally/running-the-api.md @@ -39,3 +39,9 @@ After this is complete, you can run end-to-end tests to validate your entire app ```bash pnpm run e2e:api ``` + +You can also skip these first two commands and perform the unit and e2e tests at the same time with: +```bash +pnpm run unit:api +pnpm run e2e:api +``` From 23afdf0f0f2c33a51fbc89facc72f048f8954498 Mon Sep 17 00:00:00 2001 From: veh3546 <113540609+veh3546@users.noreply.github.com> Date: Thu, 25 Apr 2024 14:19:29 -0400 Subject: [PATCH 3/4] Update running-the-api.md --- .../running-things-locally/running-the-api.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/contributing-to-keyshade/running-things-locally/running-the-api.md b/docs/contributing-to-keyshade/running-things-locally/running-the-api.md index 2178cb90..5b24e6b6 100644 --- a/docs/contributing-to-keyshade/running-things-locally/running-the-api.md +++ b/docs/contributing-to-keyshade/running-things-locally/running-the-api.md @@ -42,6 +42,5 @@ pnpm run e2e:api You can also skip these first two commands and perform the unit and e2e tests at the same time with: ```bash -pnpm run unit:api -pnpm run e2e:api +pnpm run test:api ``` From 73a2403146fb2e24b672892c1fa102147d144157 Mon Sep 17 00:00:00 2001 From: veh3546 <113540609+veh3546@users.noreply.github.com> Date: Fri, 26 Apr 2024 16:57:14 -0400 Subject: [PATCH 4/4] Update running-the-api.md --- .../running-things-locally/running-the-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing-to-keyshade/running-things-locally/running-the-api.md b/docs/contributing-to-keyshade/running-things-locally/running-the-api.md index 5b24e6b6..608e90f5 100644 --- a/docs/contributing-to-keyshade/running-things-locally/running-the-api.md +++ b/docs/contributing-to-keyshade/running-things-locally/running-the-api.md @@ -26,7 +26,7 @@ pnpm run dev:api ## Testing your code -We currently perform two kinds of tests: **unit tests** and **e2e tests.** +We currently perform two kinds of tests: **unit tests** and **integration tests.** After you make sure that you have added your unit tests, or you have made some changes to the existing functionality, you can run them using: