feat: custom value mapping for boolean attributes

Refs: #43

pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>ch.sbb.polarion.extensions</groupId>
         <artifactId>ch.sbb.polarion.extension.generic</artifactId>
-        <version>7.2.0</version>
+        <version>7.3.1</version>
     </parent>
 
     <artifactId>ch.sbb.polarion.extension.excel-importer</artifactId>

src/main/java/ch/sbb/polarion/extension/excel_importer/service/ImportService.java

@@ -3,6 +3,7 @@
 import ch.sbb.polarion.extension.excel_importer.settings.ExcelSheetMappingSettingsModel;
 import ch.sbb.polarion.extension.generic.fields.FieldType;
 import ch.sbb.polarion.extension.generic.fields.model.FieldMetadata;
+import ch.sbb.polarion.extension.generic.util.OptionsMappingUtils;
 import com.polarion.alm.projects.model.IUniqueObject;
 import com.polarion.alm.shared.api.transaction.TransactionalExecutor;
 import com.polarion.alm.tracker.model.ITrackerProject;
@@ -113,6 +114,9 @@ private String getIdentifierValue(Map<String, Object> recordMap, String columnLe
     private void fillWorkItemFields(IWorkItem workItem, Map<String, Object> mappingRecord, ExcelSheetMappingSettingsModel model, String linkColumnId) {
         mappingRecord.forEach((columnId, value) -> {
             String fieldId = model.getColumnsMapping().get(columnId);
+            // we need to know possible mapped value asap because some types (at least boolean) need it to check value for modification
+            String mappedOption = OptionsMappingUtils.getMappedOptionKey(fieldId, value, model.getEnumsMapping());
+            value = mappedOption != null ? mappedOption : value;
             Set<FieldMetadata> fieldMetadataSet = polarionServiceExt.getWorkItemsFields(workItem.getProjectId(), workItem.getType() == null ? "" : workItem.getType().getId());
             // The linkColumn field's value can't change, therefore it doesn't need to be overwritten.
             // However, it must be saved to the newly created work item otherwise sequential imports will produce several objects.

src/main/java/ch/sbb/polarion/extension/excel_importer/service/PolarionServiceExt.java

@@ -1,6 +1,7 @@
 package ch.sbb.polarion.extension.excel_importer.service;
 
 import ch.sbb.polarion.extension.generic.fields.model.FieldMetadata;
+import ch.sbb.polarion.extension.generic.fields.model.Option;
 import com.polarion.alm.projects.IProjectService;
 import com.polarion.alm.tracker.ITrackerService;
 import com.polarion.alm.tracker.model.ITrackerProject;
@@ -12,6 +13,7 @@
 import com.polarion.platform.security.ISecurityService;
 import com.polarion.platform.service.repository.IRepositoryService;
 import com.polarion.subterra.base.data.identification.IContextId;
+import com.polarion.subterra.base.data.model.internal.PrimitiveType;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.List;
@@ -21,6 +23,8 @@
 
 public class PolarionServiceExt extends ch.sbb.polarion.extension.generic.service.PolarionService {
 
+    private static final Set<Option> BOOLEAN_OPTIONS_MAPPING = Set.of(new Option("True", "true"), new Option("False", "false"));
+
     public PolarionServiceExt() {
     }
 
@@ -41,6 +45,7 @@ public Set<FieldMetadata> getWorkItemsFields(@NotNull String projectId, @NotNull
         fields.addAll(getGeneralFields(IWorkItem.PROTO, contextId)); // get common fields for WorkItem
         fields.addAll(getCustomFields(IWorkItem.PROTO, contextId, null)); // get custom fields for WorkItem with any type in the project (-- All Types --)
         fields.addAll(getCustomFields(IWorkItem.PROTO, contextId, typeOpt.getId())); // get custom fields for WorkItem with specific type in the project
+        fillBooleanOptionMappings(fields); // set mappings for booleans
         return fields;
     }
 
@@ -84,4 +89,12 @@ public ITrackerProject findProject(@NotNull String projectId) {
         }
         return trackerProject;
     }
+
+    private void fillBooleanOptionMappings(Set<FieldMetadata> fields) {
+        fields.forEach(f -> {
+            if (f.getType() instanceof PrimitiveType primitiveType && Boolean.class.getTypeName().equals(primitiveType.getTypeName())) {
+                f.setOptions(BOOLEAN_OPTIONS_MAPPING);
+            }
+        });
+    }
 }

src/main/resources/META-INF/MANIFEST.MF

@@ -7,6 +7,8 @@ Require-Bundle: com.polarion.portal.tomcat,
  com.fasterxml.jackson,
  com.fasterxml.jackson.jaxrs,
  io.swagger,
+ org.apache.commons.logging,
+ slf4j.api,
  org.springframework.spring-core,
  org.springframework.spring-web,
  ch.sbb.polarion.thirdparty.bundles.org.apache.poi;resolution:=optional

src/main/resources/webapp/excel-importer-admin/js/mappings.js

@@ -63,7 +63,7 @@ function createFieldCell(tableRow, fieldValue) {
 
     const mappingButton = document.createElement('button');
     mappingButton.classList.add('toolbar-button', 'options-mapping-button');
-    mappingButton.textContent = 'Enum mapping';
+    mappingButton.textContent = 'Options mapping';
     mappingButton.style.display = 'none';
     mappingButton.addEventListener('click', () => {
 
@@ -74,8 +74,7 @@ function createFieldCell(tableRow, fieldValue) {
 
         const hint = document.createElement('span');
         hint.classList.add('option-mapping-hint');
-        hint.innerHTML = 'By default both key and value are used for mapping to proper enum option. ' +
-            'Overriding values below will discontinue this behavior, so do not forget to specify enum default value explicitly if it still required.';
+        hint.innerHTML = 'Use <b>(empty)</b> keyword to map empty column value to some specific option.';
         const hintWrapper = document.createElement('span');
         hintWrapper.classList.add('option-mapping-hint-wrapper');
         hintWrapper.appendChild(hint);
@@ -107,7 +106,7 @@ function createFieldCell(tableRow, fieldValue) {
             const input = document.createElement('input');
             input.type = "text";
             input.placeholder = option.name;
-            input.title = `Comma-separated list of alternative values, which will be mapped to the enum option "${option.key}"`;
+            input.title = `Comma-separated list of alternative values, which will be mapped to the option "${option.key}"`;
             input.value = getEnumMappingForField(fieldSelect.value, option.key);
             input.classList.add('fs-14', 'option-mapping-value');
             cell.appendChild(input);
@@ -159,7 +158,7 @@ function createHiddenInput(className, value) {
     return idInput;
 }
 
-function saveEnumMapping() {
+function saveOptionsMapping() {
     const fieldId = (document.getElementById('modal-popup').getElementsByClassName('field-id')[0]).value;
     cache.enumsMapping[fieldId] = Object.fromEntries(getOptionsMapping());
 }

src/main/resources/webapp/excel-importer-admin/pages/mappings.jsp

@@ -121,10 +121,10 @@
 </div>
 
 <jsp:include page='modal.jsp'>
-    <jsp:param name="titleText" value="Enum mapping"/>
+    <jsp:param name="titleText" value="Options mapping"/>
     <jsp:param name="okText" value="Accept"/>
     <jsp:param name="cancelText" value="Cancel"/>
-    <jsp:param name="okClickFunction" value="saveEnumMapping()"/>
+    <jsp:param name="okClickFunction" value="saveOptionsMapping()"/>
 </jsp:include>
 
 <script type="text/javascript" src="../ui/generic/js/common.js?bundle=<%= bundleTimestamp %>"></script>

src/test/java/ch/sbb/polarion/extension/excel_importer/settings/ExcelSheetMappingSettingsTest.java

@@ -1,13 +1,19 @@
 package ch.sbb.polarion.extension.excel_importer.settings;
 
 import ch.sbb.polarion.extension.generic.exception.ObjectNotFoundException;
+import ch.sbb.polarion.extension.generic.rest.model.Context;
 import ch.sbb.polarion.extension.generic.settings.GenericNamedSettings;
 import ch.sbb.polarion.extension.generic.settings.SettingId;
 import ch.sbb.polarion.extension.generic.settings.SettingsService;
+import ch.sbb.polarion.extension.generic.util.ContextUtils;
 import ch.sbb.polarion.extension.generic.util.ScopeUtils;
 import com.polarion.subterra.base.location.ILocation;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Answers;
+import org.mockito.Mock;
 import org.mockito.MockedStatic;
 import org.mockito.junit.jupiter.MockitoExtension;
 
@@ -21,6 +27,21 @@
 
 @ExtendWith(MockitoExtension.class)
 class ExcelSheetMappingSettingsTest {
+
+    @Mock(answer = Answers.RETURNS_DEEP_STUBS)
+    MockedStatic<ContextUtils> contextUtils;
+
+    @BeforeEach
+    void setUp() {
+        Context context = new Context("excel-importer");
+        contextUtils.when(ContextUtils::getContext).thenReturn(context);
+    }
+
+    @AfterEach
+    void tearDown() {
+        contextUtils.close();
+    }
+
     @Test
     void testSettingDoesNotExist() {
         try (MockedStatic<ScopeUtils> mockScopeUtils = mockStatic(ScopeUtils.class)) {