mirror of
https://gitee.com/dolphinscheduler/DolphinScheduler.git
synced 2024-12-02 20:28:03 +08:00
45 lines
1.5 KiB
Markdown
45 lines
1.5 KiB
Markdown
|
# DolphinScheduler Backend API Test
|
||
|
|
|
||
|
|
## Page Object Model
|
||
|
|
|
||
|
|
DolphinScheduler API test respects
|
||
|
|
the [Page Object Model (POM)](https://www.selenium.dev/documentation/guidelines/page_object_models/) design pattern.
|
||
|
|
Every page of DolphinScheduler's api is abstracted into a class for better maintainability.
|
||
|
|
|
||
|
|
### Example
|
||
|
|
|
||
|
|
The login page's api is abstracted
|
||
|
|
as [`LoginPage`](dolphinscheduler-api-test-case/src/test/java/org/apache/dolphinscheduler/api.test/pages/LoginPage.java), with the
|
||
|
|
following fields,
|
||
|
|
|
||
|
|
```java
|
||
|
|
public HttpResponse login(String username, String password) {
|
||
|
|
Map<String, Object> params = new HashMap<>();
|
||
|
|
|
||
|
|
params.put("userName", username);
|
||
|
|
params.put("userPassword", password);
|
||
|
|
|
||
|
|
RequestClient requestClient = new RequestClient();
|
||
|
|
|
||
|
|
return requestClient.post("/login", null, params);
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
where `userName`, `userPassword` are the main elements on UI that we are interested in.
|
||
|
|
|
||
|
|
## Test Environment Setup
|
||
|
|
|
||
|
|
DolphinScheduler API test uses [testcontainers](https://www.testcontainers.org) to set up the testing
|
||
|
|
environment, with docker compose.
|
||
|
|
|
||
|
|
Typically, every test case needs one or more `docker-compose.yaml` files to set up all needed components, and expose the
|
||
|
|
DolphinScheduler UI port for testing. You can use `@DolphinScheduler(composeFiles = "")` and pass
|
||
|
|
the `docker-compose.yaml` files to automatically set up the environment in the test class.
|
||
|
|
|
||
|
|
```java
|
||
|
|
|
||
|
|
@DolphinScheduler(composeFiles = "docker/tenant/docker-compose.yaml")
|
||
|
|
class TenantAPITest {
|
||
|
|
}
|
||
|
|
```
|