Merge branch 'release/5.1.0'

HISTORY

@@ -1,3 +1,6 @@
+2021-08-27 5.1.0
+  - Added doReorderNode() to binding
+
 2021-07-30 5.0.0
   - AEM Cloud compatibility improvements (separate package for AEM cloud!)
   - Changed packages: no more bundle package, install always "complete" package (includes Groovy Console)

Readme.md

@@ -502,6 +502,7 @@ The matching nodes can be copied/moved to a new location. You can use ".." if yo
 * doCopyResourceToRelativePath(String relativePath, String newName): copies the node to the given target path under the new name
 * doMoveResourceToRelativePath(String relativePath): moves the node to the given target path
 * doMoveResourceToPathRegex(String matchPattern, String replacementExpr): moves a resource if its path matches the pattern to the target path obtained by applying the replacement expression. You can use group references such as $1 (hint: "$" needs to be escaped with "\" in Groovy).
+* doReorderNode(String nameOfNodeToMove, String newSuccessor) (since AECU 5.1.0): reorders subnode "nameOfNodeToMove" before subnode "newSuccessor". Set "newSuccessor" to null to order at the end.
 
 ```java
 aecu.contentUpgradeBuilder()
@@ -512,6 +513,7 @@ aecu.contentUpgradeBuilder()
         .doCopyResourceToRelativePath("../subNode", "newName")
         .doMoveResourceToRelativePath("../subNode")
         .doMoveResourceToPathRegex("/content/we-retail/(\\w+)/(\\w+)/(\\w+)", "/content/somewhere/\$1/and/\$2")
+        .doReorderNode("toMove", "successor")
         .run()
 ```
 

api/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>5.0.0</version>
+        <version>5.1.0</version>
     </parent>
 
     <artifactId>aecu.api</artifactId>

api/src/main/java/de/valtech/aecu/api/groovy/console/bindings/ContentUpgrade.java

@@ -374,6 +374,15 @@ public interface ContentUpgrade {
      */
     ContentUpgrade doMoveResourceToPathRegex(String matchPattern, String targetPathExpr);
 
+    /**
+     * Reorders a resource.
+     *
+     * @param nameOfNodeToMove entry name to move
+     * @param newSuccessor     entry will be put before this node (null to move at the end)
+     * @return upgrade object
+     */
+    ContentUpgrade doReorderNode(String nameOfNodeToMove, String newSuccessor);
+
     /**
      * Deletes the child resources if supplied. If no children are specified it deletes the resource
      * itself.

api/src/main/java/de/valtech/aecu/api/groovy/console/bindings/package-info.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018 - 2019 Valtech GmbH
+ * Copyright 2018 - 2021 Valtech GmbH
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
  * associated documentation files (the "Software"), to deal in the Software without restriction,
@@ -22,7 +22,7 @@
  * 
  * @author Roxana Muresan
  */
-@Version("4.5.0")
+@Version("4.6.0")
 package de.valtech.aecu.api.groovy.console.bindings;
 
 import org.osgi.annotation.versioning.Version;

complete-cloud/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>5.0.0</version>
+        <version>5.1.0</version>
     </parent>
 
     <artifactId>aecu.complete.cloud</artifactId>

complete/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>5.0.0</version>
+        <version>5.1.0</version>
     </parent>
 
     <artifactId>aecu.complete</artifactId>

core/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>5.0.0</version>
+        <version>5.1.0</version>
     </parent>
 
     <artifactId>aecu.core</artifactId>

core/src/main/java/de/valtech/aecu/core/groovy/console/bindings/accessrights/validators/resource/CreateAccessValidator.java

@@ -37,6 +37,7 @@ public class CreateAccessValidator extends BaseAccessRightsValidator {
      * 
      * @param group              group
      * @param resource           resource to check
+     * @param context            validation context
      * @param checkAccessGranted checks if the access is granted or denied
      */
     public CreateAccessValidator(Group group, Resource resource, AccessValidatorContext context, boolean checkAccessGranted) {

core/src/main/java/de/valtech/aecu/core/groovy/console/bindings/actions/resource/ReorderNode.java

@@ -0,0 +1,55 @@
+package de.valtech.aecu.core.groovy.console.bindings.actions.resource;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import javax.jcr.Node;
+import javax.jcr.RepositoryException;
+
+import org.apache.sling.api.resource.PersistenceException;
+import org.apache.sling.api.resource.Resource;
+
+import de.valtech.aecu.core.groovy.console.bindings.actions.Action;
+import de.valtech.aecu.core.groovy.console.bindings.impl.BindingContext;
+
+/**
+ * Reorders a subnode of a resource.
+ * 
+ * @author Roland Gruber
+ */
+public class ReorderNode implements Action {
+
+    protected String nameOfNodeToMove;
+    protected String newSuccessor;
+    private BindingContext context;
+
+    /**
+     * Constructor
+     * 
+     * @param nameOfNodeToMove node to move
+     * @param newSuccessor     new successor node name
+     * @param context          binding context
+     */
+    public ReorderNode(@Nonnull String nameOfNodeToMove, @Nullable String newSuccessor, @Nonnull BindingContext context) {
+        this.nameOfNodeToMove = nameOfNodeToMove;
+        this.newSuccessor = newSuccessor;
+        this.context = context;
+    }
+
+    @Override
+    public String doAction(@Nonnull Resource resource) throws PersistenceException {
+        Node node = resource.adaptTo(Node.class);
+        try {
+            if (null != node) {
+                if (!context.isDryRun()) {
+                    node.orderBefore(nameOfNodeToMove, newSuccessor);
+                }
+                return "Reordered " + nameOfNodeToMove + " on resource " + resource.getPath();
+            }
+        } catch (RepositoryException e) {
+            throw new PersistenceException("ERROR: could not reorder " + nameOfNodeToMove + " on resource " + resource.getPath(),
+                    e);
+        }
+        return "WARNING: could not reorder " + nameOfNodeToMove;
+    }
+
+}

core/src/main/java/de/valtech/aecu/core/groovy/console/bindings/impl/ContentUpgradeImpl.java

@@ -79,6 +79,7 @@
 import de.valtech.aecu.core.groovy.console.bindings.actions.resource.MoveResourceToPathRegex;
 import de.valtech.aecu.core.groovy.console.bindings.actions.resource.MoveResourceToRelativePath;
 import de.valtech.aecu.core.groovy.console.bindings.actions.resource.RenameResource;
+import de.valtech.aecu.core.groovy.console.bindings.actions.resource.ReorderNode;
 import de.valtech.aecu.core.groovy.console.bindings.actions.resource.ReplaceResourcePropertyValues;
 import de.valtech.aecu.core.groovy.console.bindings.actions.resource.ReplaceResourcePropertyValuesRegex;
 import de.valtech.aecu.core.groovy.console.bindings.actions.resource.ReplicateResourceAction;
@@ -365,6 +366,12 @@ public ContentUpgrade doMoveResourceToPathRegex(@Nonnull String matchPattern, @N
         return this;
     }
 
+    @Override
+    public ContentUpgrade doReorderNode(String nameOfNodeToMove, String newSuccessor) {
+        actions.add(new ReorderNode(nameOfNodeToMove, newSuccessor, context));
+        return this;
+    }
+
     @Override
     public ContentUpgrade doDeleteResource(String... children) {
         actions.add(new DeleteResource(context.getResolver(), children));

core/src/main/java/de/valtech/aecu/core/groovy/console/bindings/impl/ValidateAccessRightsImpl.java

@@ -388,7 +388,7 @@ private List<Resource> resolveResources() {
         for (String path : pathsToCheck) {
             Resource resource = resolver.getResource(path);
             if (resource == null) {
-                String message = "Unable to resolve path" + path;
+                String message = "Unable to resolve path " + path;
                 LOG.warn(message);
                 warnings.add(message);
             } else {

core/src/test/java/de/valtech/aecu/core/groovy/console/bindings/actions/resource/ReorderNodeTest.java

@@ -0,0 +1,67 @@
+package de.valtech.aecu.core.groovy.console.bindings.actions.resource;
+
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import javax.jcr.Node;
+import javax.jcr.RepositoryException;
+
+import org.apache.sling.api.resource.PersistenceException;
+import org.apache.sling.api.resource.Resource;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
+
+import de.valtech.aecu.core.groovy.console.bindings.impl.BindingContext;
+
+/**
+ * Tests ReorderNode
+ * 
+ * @author Roland Gruber
+ */
+@RunWith(MockitoJUnitRunner.class)
+public class ReorderNodeTest {
+
+    private static final String NODE_TO_MOVE = "toMove";
+
+    private static final String NEW_SUCCESSOR = "newSuccessor";
+
+    @Mock
+    private Resource resource;
+
+    @Mock
+    private Node node;
+
+    @Mock
+    private BindingContext context;
+
+    @Before
+    public void setup() {
+        when(resource.adaptTo(Node.class)).thenReturn(node);
+    }
+
+    @Test
+    public void test_doAction_dryRun() throws RepositoryException, PersistenceException {
+        when(context.isDryRun()).thenReturn(true);
+
+        ReorderNode action = new ReorderNode(NODE_TO_MOVE, NEW_SUCCESSOR, context);
+        action.doAction(resource);
+
+        verify(node, never()).orderBefore(NODE_TO_MOVE, NEW_SUCCESSOR);
+    }
+
+    @Test
+    public void test_doAction_run() throws RepositoryException, PersistenceException {
+        when(context.isDryRun()).thenReturn(false);
+
+        ReorderNode action = new ReorderNode(NODE_TO_MOVE, NEW_SUCCESSOR, context);
+        action.doAction(resource);
+
+        verify(node, times(1)).orderBefore(NODE_TO_MOVE, NEW_SUCCESSOR);
+    }
+
+}

examples/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>5.0.0</version>
+        <version>5.1.0</version>
     </parent>
 
     <artifactId>aecu.examples</artifactId>

oak.index/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>5.0.0</version>
+        <version>5.1.0</version>
     </parent>
 
     <artifactId>aecu.oak.index</artifactId>

pom.xml

@@ -4,7 +4,7 @@
     <groupId>de.valtech.aecu</groupId>
     <artifactId>aecu</artifactId>
     <packaging>pom</packaging>
-    <version>5.0.0</version>
+    <version>5.1.0</version>
     <name>AECU</name>
     <description>AEM Easy Content Upgrade</description>
     <url>https://github.com/valtech/aem-easy-content-upgrade</url>

sonar-project.properties

@@ -2,7 +2,7 @@
 sonar.projectKey=aecu
 # this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1.
 sonar.projectName=AEM Easy Content Upgrade
-sonar.projectVersion=4.2.0-SNAPSHOT
+sonar.projectVersion=5.0.1-SNAPSHOT
 
 # Encoding of the source code. Default is default system encoding
 sonar.sourceEncoding=UTF-8

ui.apps.groovyconsole/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>5.0.0</version>
+        <version>5.1.0</version>
     </parent>
 
     <artifactId>aecu.ui.apps.groovyconsole</artifactId>

ui.apps.structure/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>5.0.0</version>
+        <version>5.1.0</version>
     </parent>
 
     <artifactId>aecu.ui.apps.structure</artifactId>

ui.apps/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>5.0.0</version>
+        <version>5.1.0</version>
     </parent>
 
     <artifactId>aecu.ui.apps</artifactId>

ui.content/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>5.0.0</version>
+        <version>5.1.0</version>
     </parent>
 
     <artifactId>aecu.ui.content</artifactId>