diff --git a/README.md b/README.md index 48d6a82..bdad77a 100644 --- a/README.md +++ b/README.md @@ -223,3 +223,18 @@ Note that you can run `python3 lib/parse_tests_toml.py /path/to/your/app/ | jq` ##### Test ids The test IDs to be used in only/exclude statements are: `install.root`, `install.subdir`, `install.nourl`, `install.multi`, `backup_restore`, `upgrade`, `upgrade.someCommitId` `change_url` + + +##### Curl tests + +Several curl tests can be defined under the `[suite.curl_tests]` block. Each curl test must have a unique ID to sort of "name" the test (for example `home`, `home_logged_in`, `dash`, `admin`, `file`, `caldav`, ...) + +For each curl test, you may define the following properties: +- `path`: the app endpoint to test, relative to the defaults to `/`. Can be for example `/foo/bar`, `/assets/logo.png`, `/api/whatever.json`, ... +- `logged_on_sso`: `true` or `false` wether the test is performed being logged in on the SSO or not (default: `false`) +- `expect_title`: some text expected to be found in the HTML page's `