Updated order of checkboxed and added new checkbox description

Signed-off-by: SimoneFiorani <[email protected]>
eclipse-kura · Oct 4, 2023 · da8490a · da8490a
1 parent 4dad303
commit da8490a
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 17 deletions.
diff --git a/...eb2/src/main/java/org/eclipse/kura/web/client/ui/drivers/assets/AssetConfigurationUi.java b/...eb2/src/main/java/org/eclipse/kura/web/client/ui/drivers/assets/AssetConfigurationUi.java
@@ -145,12 +145,16 @@ interface AssetConfigurationUiBinder extends UiBinder<Widget, AssetConfiguration
     @UiField
     CheckBox appendCheck;
     @UiField
+    CheckBox emptyStringCheck;
+    @UiField
     Hidden xsrfTokenField;
     @UiField
     Hidden assetPidField;
     @UiField
     Hidden driverPidField;
     @UiField
+    Hidden emptyStringCheckField;
+    @UiField
     Hidden appendCheckField;
     @UiField
     Paragraph emptyTableLabel;
@@ -229,6 +233,8 @@ public void setPageStart(int index) {
                             .getParameterValue(AssetConstants.ASSET_DRIVER_PROP.value()));
                     AssetConfigurationUi.this.appendCheckField
                             .setValue(AssetConfigurationUi.this.appendCheck.getValue().toString());
+                    AssetConfigurationUi.this.emptyStringCheckField
+                            .setValue(AssetConfigurationUi.this.emptyStringCheck.getValue().toString());
                     AssetConfigurationUi.this.uploadForm.submit();
                     AssetConfigurationUi.this.uploadModal.hide();
                     AssetConfigurationUi.this.formSubmitCallback = context.callback(completeEvent -> {
@@ -680,6 +686,12 @@ private void uploadAndApply() {
         this.appendCheckField.setName("doReplace");
         this.appendCheckField.setValue("");
 
+        this.emptyStringCheck.setName("emptyStringCheck");
+        this.emptyStringCheck.setValue(false);
+        this.emptyStringCheckField.setID("doEmptyStringConversion");
+        this.emptyStringCheckField.setName("doEmptyStringConversion");
+        this.emptyStringCheckField.setValue("");
+
     }
 
     @Override

diff --git a/...2/src/main/java/org/eclipse/kura/web/client/ui/drivers/assets/AssetConfigurationUi.ui.xml b/...2/src/main/java/org/eclipse/kura/web/client/ui/drivers/assets/AssetConfigurationUi.ui.xml
@@ -104,6 +104,8 @@
                                     <b:FormGroup>
                                         <b:FormLabel>File</b:FormLabel>
                                         <g:FileUpload ui:field="filePath"></g:FileUpload>
+                                        <b:CheckBox ui:field="emptyStringCheck" text="{msgs.wiresEmptyStringCheck}"/>
+                                        <b:HelpBlock text="{msgs.wiresEmptyStringCheckHelpText}"/>
                                         <b:CheckBox ui:field="appendCheck" text="{msgs.wiresAppendChannelsCheck}"/>
                                         <b:HelpBlock text="{msgs.wiresAppendChannelsHelpText}"/>
                                     </b:FormGroup>
@@ -115,6 +117,7 @@
                                     <g:Hidden ui:field="assetPidField"></g:Hidden>
                                     <g:Hidden ui:field="driverPidField"></g:Hidden>
                                     <g:Hidden ui:field="appendCheckField"></g:Hidden>
+                                    <g:Hidden ui:field="emptyStringCheckField"></g:Hidden>
                                 </b:FieldSet>
                             </b:Form>
                         </b:Container>

diff --git a/.../org.eclipse.kura.web2/src/main/java/org/eclipse/kura/web/server/servlet/FileServlet.java b/.../org.eclipse.kura.web2/src/main/java/org/eclipse/kura/web/server/servlet/FileServlet.java
@@ -450,9 +450,10 @@ private void doPostAsset(HttpServletRequest req, HttpServletResponse resp) throw
             String csvString = new String(data, StandardCharsets.UTF_8);
             String assetPid = formFields.get("assetPid");
             String driverPid = formFields.get("driverPid");
+            Boolean nullValueAsEmptyString = Boolean.parseBoolean(formFields.get("doEmptyStringConversion"));
 
             List<GwtConfigParameter> parametersFromCsv = AssetConfigValidator.get().validateCsv(csvString, driverPid,
-                    errors);
+                    errors, nullValueAsEmptyString);
 
             final GwtConfigComponent config = new GwtConfigComponent();
             config.setParameters(parametersFromCsv);

diff --git a/...clipse.kura.web2/src/main/java/org/eclipse/kura/web/server/util/AssetConfigValidator.java b/...clipse.kura.web2/src/main/java/org/eclipse/kura/web/server/util/AssetConfigValidator.java
@@ -88,10 +88,10 @@ private class LineScanner {
         private final List<Tad> adsByIndex;
         private final List<GwtConfigParameter> defaultValues;
 
-        public LineScanner(final List<Tad> fullChannelMetatype, final List<String> columnHeaders)
-                throws ValidationException {
+        public LineScanner(final List<Tad> fullChannelMetatype, final List<String> columnHeaders,
+                Boolean nullValueAsEmptyString) throws ValidationException {
             this.adsByIndex = probeAdsByIndex(fullChannelMetatype, columnHeaders);
-            this.defaultValues = probeDefaultValues(fullChannelMetatype, this.adsByIndex);
+            this.defaultValues = probeDefaultValues(fullChannelMetatype, this.adsByIndex, nullValueAsEmptyString);
         }
 
         private <T> Optional<T> findLast(final Collection<T> collection, final Predicate<T> predicate) {
@@ -170,7 +170,7 @@ private List<Tad> probeAdsByIndex(final List<Tad> fullChannelMetatype, final Lis
         }
 
         private List<GwtConfigParameter> probeDefaultValues(final List<Tad> fullChannelMetatype,
-                final List<Tad> boundAds) {
+                final List<Tad> boundAds, Boolean nullValueAsEmptyString) {
             final List<Tad> missing = fullChannelMetatype.stream()
                     .filter(c -> boundAds.stream().noneMatch(b -> b.getId().equals(c.getId())))
                     .collect(Collectors.toList());
@@ -184,7 +184,8 @@ private List<GwtConfigParameter> probeDefaultValues(final List<Tad> fullChannelM
                 }
 
                 try {
-                    final Object defaultValue = validate(ad, ad.getDefault(), new ArrayList<>(), 0);
+                    final Object defaultValue = validate(ad, ad.getDefault(), new ArrayList<>(), 0,
+                            nullValueAsEmptyString);
                     result.add(GwtServerUtil.toGwtConfigParameter(ad, defaultValue));
                 } catch (final Exception e) {
                     logger.warn("Ad default value is probably not valid", e);
@@ -195,7 +196,7 @@ private List<GwtConfigParameter> probeDefaultValues(final List<Tad> fullChannelM
         }
 
         public String scan(final CSVRecord line, final Consumer<GwtConfigParameter> parameterConsumer,
-                List<String> errors) {
+                List<String> errors, Boolean nullValueAsEmptyString) {
             String channelName = "";
             boolean errorInChannel = false;
             if (line.size() != adsByIndex.size()) {
@@ -213,7 +214,7 @@ public String scan(final CSVRecord line, final Consumer<GwtConfigParameter> para
                             channelName = token;
                         }
                         final Tad ad = adsByIndex.get(i);
-                        final Object value = validate(ad, token, errors, lineNumber);
+                        final Object value = validate(ad, token, errors, lineNumber, nullValueAsEmptyString);
 
                         parameterConsumer.accept(GwtServerUtil.toGwtConfigParameter(ad, value));
                     } catch (Exception ex) {
@@ -231,8 +232,8 @@ public String scan(final CSVRecord line, final Consumer<GwtConfigParameter> para
         }
     }
 
-    public List<GwtConfigParameter> validateCsv(String csv, String driverPid, List<String> errors)
-            throws ServletException {
+    public List<GwtConfigParameter> validateCsv(String csv, String driverPid, List<String> errors,
+            Boolean nullValueAsEmptyString) throws ServletException {
 
         try (CSVParser parser = CSVParser.parse(csv, CSVFormat.RFC4180)) {
             errors.clear();
@@ -250,11 +251,11 @@ public List<GwtConfigParameter> validateCsv(String csv, String driverPid, List<S
             final List<String> header = StreamSupport.stream(lines.remove(0).spliterator(), false)
                     .collect(Collectors.toList());
 
-            final LineScanner scanner = new LineScanner(fullChannelMetatype, header);
+            final LineScanner scanner = new LineScanner(fullChannelMetatype, header, nullValueAsEmptyString);
 
             lines.forEach(record -> {
                 final List<GwtConfigParameter> params = new ArrayList<>();
-                String channelName = scanner.scan(record, params::add, errors);
+                String channelName = scanner.scan(record, params::add, errors, nullValueAsEmptyString);
                 if (!channelName.isEmpty() && !channels.contains(channelName)) {
                     channels.add(channelName);
                     for (final GwtConfigParameter param : params) {
@@ -302,17 +303,18 @@ private String errorString(int lineNumber, Tad field, String value) {
     }
 
     // Validates all the entered values
-    protected Object validate(Tad field, String value, List<String> errors, int lineNumber) throws ValidationException {
+    protected Object validate(Tad field, String value, List<String> errors, int lineNumber,
+            Boolean nullValueAsEmptyString) throws ValidationException {
 
         String trimmedValue = value.trim();
         final boolean isEmpty = trimmedValue.isEmpty();
-        final boolean isEmptyString = field.getType().equals(Scalar.STRING);
+        final boolean convertNullToEmptyString = nullToEmptyStringValueManagement(field, nullValueAsEmptyString);
 
         if (field.isRequired() && isEmpty) {
             throw new ValidationException();
         }
 
-        if (isEmptyOrEmptyString(isEmpty, isEmptyString)) {
+        if (validateTrimmedValue(isEmpty, convertNullToEmptyString)) {
             // Validate "Options" field first. Data type will be taken care of next.
             if (!field.getOption().isEmpty()) {
                 boolean foundEqual = false;
@@ -363,8 +365,18 @@ protected Object validate(Tad field, String value, List<String> errors, int line
         return null;
     }
 
-    private boolean isEmptyOrEmptyString(boolean isEmpty, boolean isEmptyString) {
-        return !isEmpty || isEmptyString;
+    private boolean nullToEmptyStringValueManagement(Tad field, Boolean nullValueAsEmptyString) {
+
+        boolean returnValue = false;
+
+        if (nullValueAsEmptyString.booleanValue()) {
+            returnValue = field.getType().equals(Scalar.STRING);
+        }
+        return returnValue;
+    }
+
+    private boolean validateTrimmedValue(boolean isEmpty, boolean convertNullToEmptyString) {
+        return !isEmpty || convertNullToEmptyString;
     }
 
     protected interface ValidationErrorConsumer {

diff --git a/...pse.kura.web2/src/main/resources/org/eclipse/kura/web/client/messages/Messages.properties b/...pse.kura.web2/src/main/resources/org/eclipse/kura/web/client/messages/Messages.properties
@@ -771,6 +771,8 @@ wiresDownloadChannels=Download Channels
 wiresUploadChannels=Upload Channels
 wiresNewChannel=New Channel
 wiresDeleteChannel=Delete Channel
+wiresEmptyStringCheck=Import empty values as empty strings.
+wiresEmptyStringCheckHelpText=If checked, empty values contained in the csv will be parsed as empty strings, for all those fields whose type is <String>.
 wiresAppendChannelsCheck=Replace current channels.
 wiresAppendChannelsHelpText=If checked, channels will be replaced by the imported ones. Otherwise, existing Asset configuration will be merged with the imported one, parameters values of imported channels will override the existing ones. The change will not be applied until Asset configuration is saved.