SUPPORT-1511: Add the field ID To the errorMessage. (#678)

* Add the field ID To the errorMessage.

* Setting version to 0.23.0

* Remove extra tab

* Update version.sbt

* Improve junit-tests.

Author: ahalberkamp

common/app/com/commercetools/sunrise/common/forms/ErrorBean.java

@@ -6,10 +6,14 @@ public class ErrorBean extends Base {
 
     private String message;
 
+    private String field;
+
+
     public ErrorBean() {
     }
 
-    public ErrorBean(final String message) {
+    public ErrorBean(final String field, final String message) {
+        this.field = field;
         this.message = message;
     }
 
@@ -20,4 +24,12 @@ public String getMessage() {
     public void setMessage(final String message) {
         this.message = message;
     }
+
+    public String getField() {
+        return field;
+    }
+
+    public void setField(String field) {
+        this.field = field;
+    }
 }

common/app/com/commercetools/sunrise/common/forms/ErrorsBean.java

@@ -15,8 +15,8 @@ public class ErrorsBean extends Base {
     public ErrorsBean() {
     }
 
-    public ErrorsBean(final String errorMessage) {
-        this.globalErrors = singletonList(new ErrorBean(errorMessage));
+    public ErrorsBean(final String errorMessage, final String field) {
+        this.globalErrors = singletonList(new ErrorBean(field, errorMessage));
     }
 
     @Deprecated
@@ -25,7 +25,7 @@ public ErrorsBean(final List<Form<?>> filledForms) {
         filledForms.forEach(filledForm ->
                 filledForm.errors().forEach((field, errors) ->
                         errors.forEach(error ->
-                                globalErrors.add(new ErrorBean(error.key() + ": " + error.message())))));
+                                globalErrors.add(new ErrorBean(field, error.key() + ": " + error.message())))));
     }
 
     @Deprecated

common/app/com/commercetools/sunrise/common/template/engine/handlebars/PlayJavaFormResolver.java

@@ -53,14 +53,14 @@ private boolean isFalsy(@Nullable final String value) {
         return value != null && value.equals("false");
     }
 
-    private ErrorsBean extractErrors(@Nullable final Form<?> form) {
+     ErrorsBean extractErrors(@Nullable final Form<?> form) {
         final ErrorsBean errorsBean = new ErrorsBean();
         final List<ErrorBean> errorList = new ArrayList<>();
         if (form != null) {
             form.errors().forEach((field, errors) ->
                     errors.forEach(error -> {
                         final String errorMessage = errorFormatter.format(locales, error);
-                        errorList.add(new ErrorBean(errorMessage));
+                        errorList.add(new ErrorBean(field, errorMessage));
                     }));
         }
         errorsBean.setGlobalErrors(errorList);

common/test/com/commercetools/sunrise/common/template/engine/handlebars/PlayJavaFormResolverTest.java

@@ -0,0 +1,53 @@
+package com.commercetools.sunrise.common.template.engine.handlebars;
+
+import com.commercetools.sunrise.common.forms.ErrorBean;
+import com.commercetools.sunrise.common.forms.ErrorsBean;
+import com.commercetools.sunrise.common.utils.ErrorFormatter;
+import com.google.common.collect.Maps;
+import org.junit.Test;
+import org.mockito.Mockito;
+import play.data.Form;
+import play.data.validation.ValidationError;
+
+import java.util.*;
+import java.util.function.Predicate;
+
+import static java.util.Collections.singletonList;
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class PlayJavaFormResolverTest {
+
+    PlayJavaFormResolver formResolver = new PlayJavaFormResolver(singletonList(Locale.ENGLISH), (locales, message) ->
+            message);
+
+    @Test
+    public void extractErrors() throws Exception {
+        String errorField1 = "field1";
+        String errorField2 = "field2";
+        Form form = formWithSomeErrorsForFields(errorField1, errorField2);
+        ErrorsBean result = formResolver.extractErrors(form);
+
+        List<ErrorBean> errors = result.getGlobalErrors();
+        checkError(errors.get(0), errorField1, "errorkey1", "errorMessage1");
+        checkError(errors.get(1), errorField1, "errorkey2", "errorMessage2");
+        checkError(errors.get(2), errorField2, "errorkey21", "errorMessage21");
+    }
+
+    private void checkError(ErrorBean error, String field, String key, String message) {
+        assertThat(error.getField()).isEqualTo(field);
+        assertThat(error.getMessage()).isEqualTo(message + ": " + key);
+
+    }
+
+    private Form formWithSomeErrorsForFields(String field1, String field2) {
+
+        Form form = Mockito.mock(Form.class);
+        Map<String, List<ValidationError>> errorMap = new HashMap<String, List<ValidationError>>();
+        errorMap.put(field1, Arrays.asList(
+                new ValidationError("errorkey1", "errorMessage1"),
+                new ValidationError("errorkey2", "errorMessage2")));
+        errorMap.put(field2, Collections.singletonList(new ValidationError("errorkey21", "errorMessage21")));
+        Mockito.when(form.errors()).thenReturn(errorMap);
+        return form;
+    }
+}