Ghost/test/api-acceptance/README.md

## Acceptance Tests

This folder should only contain a set of basic API use cases.

The goal for acceptance tests is to keep test cases to basic usecases e.g. upload an image, schedule a post, download a theme. Otherwise tests should be written as a part of regression test suite.

Future improvement notes:
- We probably need a differentiation for the acceptance tests for session and api_key authentication.
Separated test env into: acceptance, regression and unit tests (#10411) refs #9178 `yarn test` only runs acceptance and unit tests. We will setup a cronjob in Travis and run the regression tests once per day. You can manually run them with `yarn test:regression` This separation is just a first step into the right direction. Travis will no longer run for 10-13minutes. The goal is to run common API use cases and unit tests in Travis and locally by default. ## After this separation we still need to: - re-work our test utility - remove some tests - define which tests are our common API use cases - rewrite some tests - make testing easier (starting/stopping Ghost, fixtures and resetting services or event listeners, it's a pain and takes sometimes ages to fix tests) --- Acceptance: - common/basic API use cases against the current stable API Unit: - all unit tests (no database access) - proper mocking Regression: - packages we don't want to run for each PR or commit - tests which protect Ghost from breaking components and behaviour - it is wishful that regression tests are using Ghost's API's (frontend, apps, core) --- This PR requires an update to our docs. 2019-01-22 19:54:50 +03:00			`## Acceptance Tests`

			`This folder should only contain a set of basic API use cases.`

Updated acceptance&regression test suite readmes no reference - The instructions in readmes were outdates. Updated with a little more accurate information (they still need a massive cleanup, but that should be a part of a separate effort) 2021-01-22 06:41:32 +03:00			`The goal for acceptance tests is to keep test cases to basic usecases e.g. upload an image, schedule a post, download a theme. Otherwise tests should be written as a part of regression test suite.`
Separated test env into: acceptance, regression and unit tests (#10411) refs #9178 `yarn test` only runs acceptance and unit tests. We will setup a cronjob in Travis and run the regression tests once per day. You can manually run them with `yarn test:regression` This separation is just a first step into the right direction. Travis will no longer run for 10-13minutes. The goal is to run common API use cases and unit tests in Travis and locally by default. ## After this separation we still need to: - re-work our test utility - remove some tests - define which tests are our common API use cases - rewrite some tests - make testing easier (starting/stopping Ghost, fixtures and resetting services or event listeners, it's a pain and takes sometimes ages to fix tests) --- Acceptance: - common/basic API use cases against the current stable API Unit: - all unit tests (no database access) - proper mocking Regression: - packages we don't want to run for each PR or commit - tests which protect Ghost from breaking components and behaviour - it is wishful that regression tests are using Ghost's API's (frontend, apps, core) --- This PR requires an update to our docs. 2019-01-22 19:54:50 +03:00
Updated acceptance&regression test suite readmes no reference - The instructions in readmes were outdates. Updated with a little more accurate information (they still need a massive cleanup, but that should be a part of a separate effort) 2021-01-22 06:41:32 +03:00			`Future improvement notes:`
			`- We probably need a differentiation for the acceptance tests for session and api_key authentication.`