Fetch TestExecution statuses from Kiwi TCMS API, don't hard-code

Author: atodorov

src/main/java/org/kiwitcms/java/api/RpcClient.java

@@ -1,5 +1,5 @@
 // Copyright (c) 2018-2019 Aneta Petkova <[email protected]>
-// Copyright (c) 2019-2021 Alexander Todorov <[email protected]>
+// Copyright (c) 2019-2022 Alexander Todorov <[email protected]>
 
 // Licensed under the GPLv3: https://www.gnu.org/licenses/gpl.html
 
@@ -199,7 +199,6 @@ public TestRun getRun(int runId) {
     }
 
     public TestPlan createNewTP(int productId, String name, int versionId) {
-        // TODO: remove call for plan type
         Map<String, Object> params = new HashMap<>();
         params.put("name", "Unit");
         JSONArray jsonArray = (JSONArray) executeViaPositionalParams("PlanType.filter", Arrays.asList((Object) params));
@@ -254,6 +253,7 @@ public TestExecution updateTestExecution(int tcRunId, int status) {
         Map<String, Object> params = new HashMap<>();
         params.put("execution_id", tcRunId);
         params.put("values", values);
+
         JSONObject json = (JSONObject) executeViaNamedParams(TEST_EXECUTION_UPDATE, params);
         try {
             return new ObjectMapper().readValue(json.toJSONString(), TestExecution.class);
@@ -389,4 +389,26 @@ public Priority[] getPriority(Map<String, Object> filter) {
     public JSONArray getCategory(Map<String, Object> filter) {
         return (JSONArray) executeViaPositionalParams(CATEGORY_FILTER, Arrays.asList((Object) filter));
     }
+
+    public TestExecutionStatus getTestExecutionStatus(String name, String weightLookup) {
+        Map<String, Object> filter = new HashMap<>();
+        filter.put("name", name);
+        JSONArray jsonArray = (JSONArray) executeViaPositionalParams("TestExecutionStatus.filter", Arrays.asList((Object) filter));
+
+        // name not found, search by weight
+        if (jsonArray == null || jsonArray.isEmpty()) {
+            filter.remove("name");
+            // eq, gt or lt zero
+            filter.put("weight" + weightLookup, 0);
+            jsonArray = (JSONArray) executeViaPositionalParams("TestExecutionStatus.filter", Arrays.asList((Object) filter));
+        }
+
+        try {
+            TestExecutionStatus[] statuses = new ObjectMapper().readValue(jsonArray.toJSONString(), TestExecutionStatus[].class);
+            return statuses[0];
+        } catch (IOException e) {
+            e.printStackTrace();
+            return null;
+        }
+    }
 }

src/main/java/org/kiwitcms/java/junit/TestDataEmitter.java

@@ -1,4 +1,5 @@
 // Copyright (c) 2018-2019 Aneta Petkova <[email protected]>
+// Copyright (c) 2022 Alexander Todorov <[email protected]>
 
 // Licensed under the GPLv3: https://www.gnu.org/licenses/gpl.html
 
@@ -104,11 +105,31 @@ public void addTestResultsToRun(int runId, List<TestMethod> tests) {
 
             TestExecution[] executions = client.addTestCaseToRunId(runId, testCase.getCaseId());
             for (TestExecution testExecution : executions) {
-                client.updateTestExecution(testExecution.getTcRunId(), test.getTestExecutionStatus());
+                client.updateTestExecution(testExecution.getTcRunId(), getTestExecutionStatusId(test.result));
             }
         }
     }
 
+    // TODO: this method is called for every execution.
+    // Results can be cached
+    private int getTestExecutionStatusId(String result) {
+        TestExecutionStatus status = null;
+
+        switch (result) {
+            case "PASS":
+                status = client.getTestExecutionStatus("PASSED", "__gt");
+                break;
+            case "FAIL":
+                status = client.getTestExecutionStatus("FAILED", "__lt");
+                break;
+            default:
+                //IDLE
+                status = client.getTestExecutionStatus(result, "");
+        }
+
+        return status.getId();
+    }
+
     public int getBuild(int versionId) {
         String confBuild = config.getBuild();
         Map<String, Object> filter = new HashMap<>();

src/main/java/org/kiwitcms/java/model/TestExecutionStatus.java

@@ -0,0 +1,42 @@
+// Copyright (c) 2022 Alexander Todorov <[email protected]>
+
+// Licensed under the GPLv3: https://www.gnu.org/licenses/gpl.html
+
+package org.kiwitcms.java.model;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonSetter;
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class TestExecutionStatus {
+    private int id;
+    private int weight;
+    private String name;
+
+    public int getId() {
+        return id;
+    }
+
+    @JsonSetter("id")
+    public void setId(int id) {
+        this.id = id;
+    }
+
+    public int getWeight() {
+        return weight;
+    }
+
+    @JsonSetter("weight")
+    public void setWeight(int weight) {
+        this.weight = weight;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    @JsonSetter("name")
+    public void setName(String name) {
+        this.name = name;
+    }
+}

src/main/java/org/kiwitcms/java/model/TestMethod.java

@@ -1,13 +1,10 @@
 // Copyright (c) 2018-2019 Aneta Petkova <[email protected]>
+// Copyright (c) 2022 Alexander Todorov <[email protected]>
 
 // Licensed under the GPLv3: https://www.gnu.org/licenses/gpl.html
 
 package org.kiwitcms.java.model;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
-
-import java.util.List;
 
 public class TestMethod {
     public String name;
@@ -26,35 +23,4 @@ public TestMethod(String name, String containingClass, String result){
     public String getSummary() {
         return containingClass + "." + name;
     }
-
-    public int getTestExecutionStatus() {
-//todo: this must be coming from the database, not hard-coded
-        switch (result) {
-            case "PASS":
-                return 4;
-            case "FAIL":
-                return 5;
-            default:
-                //IDLE
-                return 1;
-        }
-    }
-
-    public String toJSONString() {
-        ObjectMapper mapper = new ObjectMapper();
-        try {
-            return mapper.writeValueAsString(this);
-        } catch (JsonProcessingException e) {
-            return null;
-        }
-    }
-
-    public static String toJSONArrayString(List<TestMethod> list) {
-        ObjectMapper mapper = new ObjectMapper();
-        try {
-            return mapper.writeValueAsString(list);
-        } catch (JsonProcessingException e) {
-            return null;
-        }
-    }
 }