SbloodyS commented on code in PR #10442: URL: https://github.com/apache/dolphinscheduler/pull/10442#discussion_r897561396
########## dolphinscheduler-api-test/README.md: ########## @@ -0,0 +1,44 @@ +# 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 End-to-End test uses [testcontainers](https://www.testcontainers.org) to set up the testing Review Comment: Fixed. ########## dolphinscheduler-api-test/dolphinscheduler-api-test-case/src/test/java/org/apache/dolphinscheduler/api.test/utils/RequestClient.java: ########## @@ -0,0 +1,171 @@ +/* + * Licensed to Apache Software Foundation (ASF) under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Apache Software Foundation (ASF) licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.dolphinscheduler.api.test.utils; + +import lombok.SneakyThrows; +import lombok.extern.slf4j.Slf4j; +import org.apache.dolphinscheduler.api.test.core.Constants; +import org.apache.dolphinscheduler.api.test.entity.HttpResponse; +import org.apache.dolphinscheduler.api.test.entity.HttpResponseBody; +import org.testcontainers.shaded.okhttp3.FormBody; +import org.testcontainers.shaded.okhttp3.Headers; +import org.testcontainers.shaded.okhttp3.MediaType; +import org.testcontainers.shaded.okhttp3.OkHttpClient; +import org.testcontainers.shaded.okhttp3.Request; +import org.testcontainers.shaded.okhttp3.RequestBody; +import org.testcontainers.shaded.okhttp3.Response; + +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +@Slf4j +public class RequestClient { + + private OkHttpClient httpClient = null; + + public RequestClient() { + this.httpClient = new OkHttpClient(); + } + + @SneakyThrows + public HttpResponse get(String url, Map<String, String> headers, Map<String, Object> params) { + String requestUrl = String.format("%s%s%s", Constants.DOLPHINSCHEDULER_API_URL, url, getParams(params)); + + Headers headersBuilder = new Headers.Builder().build(); + if (headers != null) { + headersBuilder = Headers.of(headers); + } + + LOGGER.info("GET request to {}, Headers: {}", requestUrl, headersBuilder); + Request request = new Request.Builder() + .url(requestUrl) + .headers(headersBuilder) + .get() + .build(); + + Response response = this.httpClient.newCall(request).execute(); + + HttpResponseBody responseData = null; + int responseCode = response.code(); + if (response.body() != null) { + responseData = JSONUtils.parseObject(response.body().string(), HttpResponseBody.class); + } + response.close(); + + HttpResponse httpResponse = new HttpResponse(responseCode, responseData); + + LOGGER.info("GET response: {}", httpResponse); + + return httpResponse; + } + + public static String getParams(Map<String, Object> params) { + StringBuilder sb = new StringBuilder("?"); + if (params.size() > 0) { + for (Map.Entry<String, Object> item : params.entrySet()) { + Object value = item.getValue(); + if (Objects.nonNull(value)) { + sb.append("&"); Review Comment: Fixed. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
