story #1234010: add query param to get coverage url for the new query for work items

Author: luizaM02

src/main/java/com/microfocus/octane/plugins/configuration/OctaneRestManager.java

@@ -31,7 +31,10 @@
 import org.slf4j.LoggerFactory;
 
 import javax.net.ssl.SSLHandshakeException;
+import java.io.UnsupportedEncodingException;
+import java.net.URLEncoder;
 import java.net.UnknownHostException;
+import java.nio.charset.StandardCharsets;
 import java.util.*;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
@@ -107,14 +110,22 @@ private static String getQueryParam(OctaneEntity octaneEntity, OctaneEntityTypeD
     }
 
     private static String getQueryForWorkItemNewVersion(OctaneEntity octaneEntity, OctaneEntityTypeDescriptor typeDescriptor) {
-        //http://localhost:8080/api/shared_spaces/1001/workspaces/1002/runs/groups?&query="((work_items_of_last_run={(id='2348')})||(work_items_of_last_run={path='0000000001OT0001OU000212*'}))"&group_by=status
+//http://localhost:8080/api/shared_spaces/1001/workspaces/1002/runs/groups?query="((work_items_of_last_run={(id='1005')})||(work_items_of_last_run={(subtype+IN+'story','defect','feature';path='0000000000TH0000TJ*')}))"&group_by=status
 
-        OctaneQueryBuilder queryBuilder = OctaneQueryBuilder.create()
-                .addGroupBy("status")
-                .addQueryCondition(new CrossQueryPhrase("work_items_of_last_run", new RawTextQueryPhrase("id='" + octaneEntity.getId() + "'")))
-                .addQueryCondition(new CrossQueryPhrase("work_items_of_last_run", createGetEntityCondition(octaneEntity)));
+        String coverageFieldName = typeDescriptor.getIndirectCoveringTestsField();
+        String queryParamValue = String.format("\"((%s={(id='%s')})||(%s={(subtype IN 'story','defect','feature';path='%s')}))\"",
+                coverageFieldName,
+                octaneEntity.getId(),
+                coverageFieldName,
+                octaneEntity.getString(PluginConstants.PATH) + "*");
 
-        return queryBuilder.build();
+        try {
+            queryParamValue = URLEncoder.encode(queryParamValue, StandardCharsets.UTF_8.name());
+        } catch (UnsupportedEncodingException e) {
+            throw new RuntimeException("Failed to encode params.", e);
+        }
+
+        return "query=" + queryParamValue + "&group_by=status";
     }
 
     public static GroupEntityCollection getNativeStatusCoverageForRunsWithoutStatus(SpaceConfiguration sc, OctaneEntity octaneEntity, OctaneEntityTypeDescriptor typeDescriptor, long workspaceId) {
@@ -157,8 +168,8 @@ public static int getTotalTestsCount(SpaceConfiguration sc, OctaneEntity octaneE
     }
 
     private static QueryPhrase createGetEntityCondition(OctaneEntity octaneEntity) {
-        String path = octaneEntity.getString("path");
-        return new LogicalQueryPhrase("path", path + "*");
+        String path = octaneEntity.getString(PluginConstants.PATH);
+        return new LogicalQueryPhrase(PluginConstants.PATH, path + "*");
     }
 
     public static OctaneEntityCollection getEntitiesByCondition(SpaceConfiguration sc, long workspaceId, String collectionName, Collection<QueryPhrase> conditions, Collection<String> fields) {

src/main/java/com/microfocus/octane/plugins/configuration/PluginConstants.java

@@ -4,6 +4,7 @@ public class PluginConstants {
 
     public static final int SPACE_CONTEXT = -1;
     public static final String PASSWORD_REPLACE = "__secret__password__"; // NON-NLS
+    public static final String PATH = "path";
 
     public static String URL_AUTHENTICATION = "/authentication/sign_in";
 

src/main/java/com/microfocus/octane/plugins/descriptors/OctaneEntityTypeDescriptor.java

@@ -57,9 +57,14 @@ public class OctaneEntityTypeDescriptor {
      */
     private String testReferenceField;
 
+    /**
+     * Name of the field for indirect test covering
+     */
+    private String indirectCoveringTestsField;
+
     private static final String TESTS_URL_FOR_DEFECTS = "&configuration={\"tabName\":\"%s\",\"relation_name\":\"test_to_work_items-gherkin_test-scenario_test-test_automated-test_manual-test_suite-target\"}";
 
-    public OctaneEntityTypeDescriptor(String typeName, String alias, String typeAbbreviation, String label, String typeColor, String nameForNavigation, String testTabName, String testReferenceField) {
+    public OctaneEntityTypeDescriptor(String typeName, String alias, String typeAbbreviation, String label, String typeColor, String nameForNavigation, String testTabName, String testReferenceField, String indirectCoveringTestsField) {
         this.typeName = typeName;
         this.alias = alias;
         this.label = label;
@@ -68,6 +73,7 @@ public OctaneEntityTypeDescriptor(String typeName, String alias, String typeAbbr
         this.nameForNavigation = nameForNavigation;
         this.testTabName = testTabName;
         this.testReferenceField = testReferenceField;
+        this.indirectCoveringTestsField = indirectCoveringTestsField;
     }
 
     public String getTypeAbbreviation() {
@@ -119,4 +125,8 @@ public String getLabel() {
     public String getAlias() {
         return alias;
     }
+
+    public String getIndirectCoveringTestsField() {
+        return indirectCoveringTestsField;
+    }
 }

src/main/java/com/microfocus/octane/plugins/descriptors/OctaneEntityTypeManager.java

@@ -26,12 +26,12 @@ public class OctaneEntityTypeManager {
 
     static {
         //TYPE
-        OctaneEntityTypeDescriptor featureType = new OctaneEntityTypeDescriptor("feature", null, "F", "Feature", "#e57828", "work_item", "tests_in_backlog", "covered_content");
-        OctaneEntityTypeDescriptor storyType = new OctaneEntityTypeDescriptor("story", null, "US", "User Story", "#ffb000", "work_item", "tests_in_backlog", "covered_content");
-        OctaneEntityTypeDescriptor defectType = new OctaneEntityTypeDescriptor("defect", null, "D", "Defect", "#b21646", "work_item", "relationships", "covered_content");
+        OctaneEntityTypeDescriptor featureType = new OctaneEntityTypeDescriptor("feature", null, "F", "Feature", "#e57828", "work_item", "tests_in_backlog", "covered_content", "work_items_of_last_run");
+        OctaneEntityTypeDescriptor storyType = new OctaneEntityTypeDescriptor("story", null, "US", "User Story", "#ffb000", "work_item", "tests_in_backlog", "covered_content", "work_items_of_last_run");
+        OctaneEntityTypeDescriptor defectType = new OctaneEntityTypeDescriptor("defect", null, "D", "Defect", "#b21646", "work_item", "relationships", "covered_content", "work_items_of_last_run");
 
-        OctaneEntityTypeDescriptor requirementType = new OctaneEntityTypeDescriptor("requirement_document", null, "RD", "Requirement", "#0b8eac", "requirement", "tests_in_requirement", "covered_requirement");
-        OctaneEntityTypeDescriptor applicationModuleType = new OctaneEntityTypeDescriptor("product_area", "application_module", "AM", "Application Module", "#43e4ff", "product_area", "tests-in-pa", "product_areas");
+        OctaneEntityTypeDescriptor requirementType = new OctaneEntityTypeDescriptor("requirement_document", null, "RD", "Requirement", "#0b8eac", "requirement", "tests_in_requirement", "covered_requirement", null);
+        OctaneEntityTypeDescriptor applicationModuleType = new OctaneEntityTypeDescriptor("product_area", "application_module", "AM", "Application Module", "#43e4ff", "product_area", "tests-in-pa", "product_areas", null);
 
         Arrays.asList(applicationModuleType, featureType, storyType, requirementType, defectType).forEach(descriptor -> {
             typeDescriptorsByName.put(descriptor.getTypeName(), descriptor);