Feature/af password component

.github/workflows/exporter-validate-pr.yml

@@ -48,10 +48,10 @@ jobs:
                 exit 1
               fi
 
-            # Check for changed values
-            for key in $base_keys; do
-              base_value=$(echo "$base_file" | jq -r --arg key "$key" '.[$key]')
-              head_value=$(echo "$head_file" | jq -r --arg key "$key" '.[$key]')
+              # Check for changed values
+              for key in $base_keys; do
+                base_value=$(echo "$base_file" | jq -r ".$key")
+                head_value=$(echo "$head_file" | jq -r ".$key")
 
                 if [ "$base_value" != "$head_value" ]; then
                   echo "Backward incompatibility change detected in $file. The value of key '$key' was changed from '$base_value' to '$head_value'."
@@ -64,4 +64,4 @@ jobs:
           done
 
           echo "All exporter JSON files have only additions. No backward incompatibility changes detected."
-        shell: bash
+        shell: bash

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/form/FormConstants.java

@@ -142,4 +142,6 @@ private FormConstants() {
 
     /* The resource type for the pre-selected the linked panel */
     public final static String RT_FD_FORM_REVIEW_DATASOURCE_V1 = RT_FD_FORM_PREFIX + "review/v1/datasource";
+
+    public static final String RT_FD_FORM_PASSWORD_V1 = RT_FD_FORM_PREFIX + "password/v1/password";
 }

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/models/v1/form/PasswordImpl.java

@@ -0,0 +1,90 @@
+/**~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  ~ Copyright 2024 Adobe
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~     http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
+
+package com.adobe.cq.forms.core.components.internal.models.v1.form;
+
+import javax.annotation.Nullable;
+import javax.annotation.PostConstruct;
+
+import org.apache.sling.api.SlingHttpServletRequest;
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.models.annotations.Exporter;
+import org.apache.sling.models.annotations.Model;
+import org.apache.sling.models.annotations.injectorspecific.InjectionStrategy;
+import org.apache.sling.models.annotations.injectorspecific.ValueMapValue;
+
+import com.adobe.cq.export.json.ComponentExporter;
+import com.adobe.cq.export.json.ExporterConstants;
+import com.adobe.cq.forms.core.components.internal.form.FormConstants;
+import com.adobe.cq.forms.core.components.models.form.FieldType;
+import com.adobe.cq.forms.core.components.models.form.Password;
+import com.adobe.cq.forms.core.components.util.AbstractFieldImpl;
+import com.adobe.cq.forms.core.components.util.ComponentUtils;
+
+@Model(
+    adaptables = { SlingHttpServletRequest.class, Resource.class },
+    adapters = { Password.class, ComponentExporter.class },
+    resourceType = { FormConstants.RT_FD_FORM_PASSWORD_V1 })
+@Exporter(
+    name = ExporterConstants.SLING_MODEL_EXPORTER_NAME,
+    extensions = ExporterConstants.SLING_MODEL_EXTENSION)
+public class PasswordImpl extends AbstractFieldImpl implements Password {
+
+    private Object exclusiveMinimumVaue;
+    private Object exclusiveMaximumValue;
+
+    @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL)
+    @Nullable
+    private String pattern;
+
+    @Override
+    public String getFieldType() {
+        return getFieldType(FieldType.PASSWORD);
+    }
+
+    @Override
+    public Integer getMinLength() {
+        return minLength;
+    }
+
+    @Override
+    public Integer getMaxLength() {
+        return maxLength;
+    }
+
+    @Override
+    public String getFormat() {
+        return displayFormat;
+    }
+
+    @Override
+    public String getPattern() {
+        return pattern;
+    }
+
+    @PostConstruct
+    private void initPassword() {
+        exclusiveMaximumValue = ComponentUtils.getExclusiveValue(exclusiveMaximum, maximum, null);
+        exclusiveMinimumVaue = ComponentUtils.getExclusiveValue(exclusiveMinimum, minimum, null);
+        // in json either, exclusiveMaximum or maximum should be present
+        if (exclusiveMaximumValue != null) {
+            maximum = null;
+        }
+        if (exclusiveMinimumVaue != null) {
+            minimum = null;
+        }
+    }
+}

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/models/form/Password.java

@@ -0,0 +1,29 @@
+/**~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  ~ Copyright 2024 Adobe
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~     http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
+
+package com.adobe.cq.forms.core.components.models.form;
+
+import org.osgi.annotation.versioning.ConsumerType;
+
+/**
+ * Interface for {@code Password} Sling Model used for the {@code /apps/core/fd/components/form/password/v1/password} component.
+ * 
+ * @since com.adobe.cq.forms.core.components.models.form 5.11.0
+ */
+@ConsumerType
+public interface Password extends Field, StringConstraint {
+
+}

bundles/af-core/src/test/java/com/adobe/cq/forms/core/components/internal/models/v1/form/PasswordImplTest.java

@@ -0,0 +1,176 @@
+/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ~ Copyright 2024 Adobe
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~     http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
+
+package com.adobe.cq.forms.core.components.internal.models.v1.form;
+
+import org.apache.commons.lang3.reflect.FieldUtils;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mockito;
+
+import com.adobe.cq.forms.core.Utils;
+import com.adobe.cq.forms.core.components.datalayer.FormComponentData;
+import com.adobe.cq.forms.core.components.internal.form.FormConstants;
+import com.adobe.cq.forms.core.components.models.form.FieldType;
+import com.adobe.cq.forms.core.components.models.form.Password;
+import com.adobe.cq.forms.core.context.FormsCoreComponentTestContext;
+import io.wcm.testing.mock.aem.junit5.AemContext;
+import io.wcm.testing.mock.aem.junit5.AemContextExtension;
+
+import static org.junit.Assert.assertEquals;
+
+@ExtendWith(AemContextExtension.class)
+public class PasswordImplTest {
+
+    private static final String BASE = "/form/password";
+    private static final String CONTENT_ROOT = "/content";
+    private static final String PATH_PASSWORD_DATALAYER = CONTENT_ROOT + "/password-datalayer";
+    private static final String PATH_PASSWORD_CUSTOMIZED = CONTENT_ROOT + "/password-customized";
+
+    private static final String PATH_PASSWORD = CONTENT_ROOT + "/password";
+
+    private static final String PATH_PASSWORD_PATTERN = CONTENT_ROOT + "/password-pattern";
+
+    private final AemContext context = FormsCoreComponentTestContext.newAemContext();
+
+    @BeforeEach
+    void setUp() {
+        context.load().json(BASE + FormsCoreComponentTestContext.TEST_CONTENT_JSON, CONTENT_ROOT);
+    }
+
+    @Test
+    void testExportedType() throws Exception {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals(FormConstants.RT_FD_FORM_PASSWORD_V1, password.getExportedType());
+        Password passwordMock = Mockito.mock(Password.class);
+        Mockito.when(passwordMock.getExportedType()).thenCallRealMethod();
+        assertEquals("", passwordMock.getExportedType());
+    }
+
+    @Test
+    void testJSONExport() throws Exception {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_PATTERN, Password.class, context);
+        Utils.testJSONExport(password, Utils.getTestExporterJSONPath(BASE, PATH_PASSWORD));
+    }
+
+    @Test
+    void testFieldType() {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals(FieldType.PASSWORD.getValue(), password.getFieldType());
+    }
+
+    @Test
+    void testGetLabel() {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals("pwd", password.getLabel().getValue());
+    }
+
+    @Test
+    void testPlaceholder() {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals("Enter valid password", password.getPlaceHolder());
+    }
+
+    @Test
+    void testGetName() {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals("password", password.getName());
+
+    }
+
+    @Test
+    void testDorProperties() {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals(true, password.getDorProperties().get("dorExclusion"));
+        assertEquals("4", password.getDorProperties().get("dorColspan"));
+        assertEquals("Text1", password.getDorProperties().get("dorBindRef"));
+
+    }
+
+    @Test
+    void testGetDescription() {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals("password field", password.getDescription());
+    }
+
+    @Test
+    void testGetRequired() {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals(true, password.isRequired());
+    }
+
+    @Test
+    void testIsEnabled() {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals(true, password.isEnabled());
+    }
+
+    @Test
+    void testIsEnabledForCustomized() {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals(true, password.isEnabled());
+    }
+
+    @Test
+    void testIsReadOnly() {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals(false, password.isReadOnly());
+    }
+
+    @Test
+    void testIsReadOnlyForCustomized() {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals(false, password.isReadOnly());
+    }
+
+    @Test
+    void testMinLength() {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals(5, password.getMinLength().intValue());
+    }
+
+    @Test
+    void testMaxLength() {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals(10, password.getMaxLength().intValue());
+    }
+
+    @Test
+    void testGetDisplayFormat() throws Exception {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_CUSTOMIZED, Password.class, context);
+        assertEquals("password", password.getFormat());
+    }
+
+    @Test
+    void testGetPattern() throws Exception {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_PATTERN, Password.class, context);
+        assertEquals("^(?=.*\\d.*\\d)[A-Za-z\\d!@]+$", password.getPattern());
+    }
+
+    @Test
+    void testDataLayerProperties() throws IllegalAccessException {
+        Password password = Utils.getComponentUnderTest(PATH_PASSWORD_DATALAYER, Password.class, context);
+        FieldUtils.writeField(password, "dataLayerEnabled", true, true);
+        FormComponentData dataObject = (FormComponentData) password.getData();
+        assert (dataObject != null);
+        assert (dataObject.getId()).equals("password-1c7bc238a6");
+        assert (dataObject.getType()).equals("core/fd/components/form/password/v1/password");
+        assert (dataObject.getTitle()).equals("Full Name");
+        assert (dataObject.getFieldType()).equals("password");
+        assert (dataObject.getDescription()).equals("Enter Full Name");
+    }
+}

bundles/af-core/src/test/resources/form/password/exporter-password-customized.json

@@ -0,0 +1,43 @@
+{
+  "id": "password-477c777f4e",
+  "fieldType": "password",
+  "name": "password1708629052628",
+  "visible": true,
+  "description": "<p>long desc</p>\r\n",
+  "tooltip": "<p>short desc</p>\r\n",
+  "type": "string",
+  "required": true,
+  "enabled": true,
+  "constraintMessages": {
+    "required": "Password is required",
+    "minLength": "min chars",
+    "maxLength": "max chars",
+    "pattern": "Invalid pwd"
+  },
+  "readOnly": false,
+  "minLength": 5,
+  "maxLength": 10,
+  "exclusiveMinimum" : 8,
+  "exclusiveMaximum" : 16,
+  "pattern": "/^(?=.*\\d)(?=.*[a-z])(?=.*[A-Z])(?=.*[a-zA-Z]).{8,}$/",
+  "label": {
+    "value": "Password",
+    "visible": true
+  },
+  "properties": {
+    "afs:layout": {
+      "tooltipVisible": false
+    },
+    "fd:dor": {
+      "dorExclusion": false
+    },
+    "fd:path": "/content/password-customized"
+  },
+  "events": {
+    "custom:setProperty": [
+      "$event.payload"
+    ]
+  },
+  "placeholder": "Enter valid password",
+  ":type": "core/fd/components/form/password/v1/password"
+}