Feature/marp 916 refinement what must be done to implement an end2end test for the axon ivy marketplace

.github/workflows/ci.yml

@@ -10,3 +10,5 @@ on:
 jobs:
   build:
     uses: axonivy-market/github-workflows/.github/workflows/ci.yml@v4
+    secrets:
+      mvnArgs: -Dopenweather.apitoken=${{ secrets.API_TOKEN }}

.github/workflows/dev.yml

@@ -9,3 +9,5 @@ on:
 jobs:
   build:
     uses: axonivy-market/github-workflows/.github/workflows/dev.yml@v4
+    secrets:
+      mvnArgs: -Dopenweather.apitoken=${{ secrets.API_TOKEN }}

open-weather-connector-test/pom.xml

@@ -40,6 +40,11 @@
 			<version>${tester.version}</version>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+	      <groupId>com.microsoft.playwright</groupId>
+	      <artifactId>playwright</artifactId>
+	      <version>1.48.0</version>
+	    </dependency>
 	</dependencies>
 	<build>
 		<pluginManagement>
@@ -61,6 +66,15 @@
 				<version>${project.build.plugin.version}</version>
 				<extensions>true</extensions>
 			</plugin>
+			<plugin>
+       			<artifactId>maven-surefire-plugin</artifactId>
+        		<version>3.0.0-M5</version>
+        		<configuration>
+          			<systemPropertyVariables>
+            			<apiToken>${openweather.apitoken}</apiToken>
+          			</systemPropertyVariables>
+        		</configuration>
+      		</plugin>
 		</plugins>
 	</build>
 </project>

open-weather-connector-test/src_test/com/axonivy/connector/openweather/test/BaseAPITest.java

@@ -0,0 +1,84 @@
+package com.axonivy.connector.openweather.test;
+
+import java.util.Map;
+import java.util.Objects;
+
+import org.apache.commons.collections4.map.HashedMap;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
+
+import com.microsoft.playwright.APIRequestContext;
+import com.microsoft.playwright.APIResponse;
+import com.microsoft.playwright.Playwright;
+import com.microsoft.playwright.options.RequestOptions;
+
+public class BaseAPITest {
+  private static final String DEFAULT_WEATHER_DATA_URL = "https://api.openweathermap.org/data/2.5/forecast";
+  private static final String DEFAULT_WEATHER_GEO_URL = "https://api.openweathermap.org/data/2.5/forecast";
+  private static final String APP_ID_QUERRY_PARAM_KEY = "appId";
+  protected static String appId;
+  protected APIRequestContext request;
+  private Playwright playwright;
+
+  @BeforeAll
+  void beforeAll() {
+    createPlaywright();
+    appId = System.getProperty("apiToken");
+  }
+
+  @AfterAll
+  void afterAll() {
+    disposeAPIRequestContext();
+    closePlaywright();
+  }
+
+  void createPlaywright() {
+    playwright = Playwright.create();
+    createSimpleRequestContext();
+  }
+
+  void createSimpleRequestContext() {
+    request = playwright.request().newContext();
+  }
+
+  private APIResponse getResponseFromUrlWithQueryParams(String url, RequestOptions queryOptions) {
+    return request.get(url, queryOptions);
+  }
+
+  protected APIResponse getResponseFromDataUrlWithQueryParams(Map<String, String> queryParams) {
+    return getResponseFromUrlWithQueryParams(DEFAULT_WEATHER_DATA_URL, createRequestOptionFromQueryParam(queryParams));
+  }
+
+  protected APIResponse getResponseFromGeoUrlWithQueryParams(Map<String, String> queryParams) {
+    return getResponseFromUrlWithQueryParams(DEFAULT_WEATHER_GEO_URL, createRequestOptionFromQueryParam(queryParams));
+  }
+
+  private RequestOptions createRequestOptionFromQueryParam(Map<String, String> queryParams) {
+    Objects.requireNonNullElse(queryParams, new HashedMap<>());
+    RequestOptions requestOptions = RequestOptions.create();
+    for (Map.Entry<String, String> entry : queryParams.entrySet()) {
+      requestOptions.setQueryParam(entry.getKey(), entry.getValue());
+    }
+    return requestOptions;
+  }
+
+  protected Map<String, String> updateAppIdQueryParam(Map<String, String> params) {
+    Objects.requireNonNullElse(params, new HashedMap<>());
+    params.put(APP_ID_QUERRY_PARAM_KEY, appId);
+    return params;
+  }
+
+  void disposeAPIRequestContext() {
+    if (request != null) {
+      request.dispose();
+      request = null;
+    }
+  }
+
+  void closePlaywright() {
+    if (playwright != null) {
+      playwright.close();
+      playwright = null;
+    }
+  }
+}

open-weather-connector-test/src_test/com/axonivy/connector/openweather/test/ForecastWeatherApiTest.java

@@ -0,0 +1,57 @@
+package com.axonivy.connector.openweather.test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInstance;
+
+import com.microsoft.playwright.APIResponse;
+
+
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
+public class ForecastWeatherApiTest extends BaseAPITest {
+  private static final String NEW_YORK_LON_VALUE = "-74.0060152";
+  private static final String NEW_YORK_LAT_VALUE = "40.7127281";
+  private static final String LON_QUERRY_PARAM_KEY = "lon";
+  private static final String LAT_QUERRY_PARAM_KEY = "lat";
+  private static final String UNITS_QUERRY_PARAM_KEY = "units";
+  private static final String METRIC_UNIT_VALUE = "metric";
+  private static final String LOCATION_QUERRY_PARAM_KEY = "q";
+  private static final String LIMIT_QUERRY_PARAM_KEY = "limit";
+  private static final String NEW_YORK_LOCATION_VALUE = "New York";
+
+  @Test
+  void shouldReturnOkStatusWhenCallGetNewYorkData() {
+    APIResponse repsonse = getResponseFromDataUrlWithQueryParams(createNewYorkDataParam());
+    assertTrue(repsonse.ok());
+  }
+
+  @Test
+  void shouldReturnNewYorkInResponseWhenCallGetNewYorkGeo() {
+    APIResponse repsonse = getResponseFromGeoUrlWithQueryParams(createNewYorkLocationParam());
+    assertTrue(repsonse.ok());
+    // This test case should be failed
+    assertEquals("New York County", repsonse.toString());
+  }
+
+  private Map<String, String> createNewYorkDataParam() {
+    Map<String, String> params = new HashMap<String, String>();
+    params.put(LON_QUERRY_PARAM_KEY, NEW_YORK_LON_VALUE);
+    params.put(LAT_QUERRY_PARAM_KEY, NEW_YORK_LAT_VALUE);
+    params.put(UNITS_QUERRY_PARAM_KEY, METRIC_UNIT_VALUE);
+    updateAppIdQueryParam(params);
+    return params;
+  }
+
+  private Map<String, String> createNewYorkLocationParam() {
+    Map<String, String> params = new HashMap<String, String>();
+    params.put(LOCATION_QUERRY_PARAM_KEY, NEW_YORK_LOCATION_VALUE);
+    params.put(LIMIT_QUERRY_PARAM_KEY, "1");
+    updateAppIdQueryParam(params);
+    return params;
+  }
+}