ACS-4026: Create orphaned tag with POST /tags (#1748)

* ACS-4026: Create orphaned tag with POST /tags
2025-07-31 17:39:05 +00:00 · 2023-02-10 16:51:22 +01:00
parent 9457e019ef
commit 96c1464b6c
16 changed files with 933 additions and 73 deletions
--- a/repository/src/main/java/org/alfresco/repo/tagging/TaggingServiceImpl.java
+++ b/repository/src/main/java/org/alfresco/repo/tagging/TaggingServiceImpl.java
@@ -2,7 +2,7 @@
 * #%L
 * Alfresco Repository
 * %%
- * Copyright (C) 2005 - 2020 Alfresco Software Limited
+ * Copyright (C) 2005 - 2023 Alfresco Software Limited
 * %%
 * This file is part of the Alfresco software. 
 * If the software was purchased under a paid Alfresco license, the terms of 
@@ -26,7 +26,6 @@
 package org.alfresco.repo.tagging;

 import java.io.BufferedReader;
-import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.Serializable;
@@ -41,9 +40,10 @@ import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
 import java.util.Set;
+import java.util.stream.Collectors;

-import org.alfresco.error.AlfrescoRuntimeException;
 import org.alfresco.model.ContentModel;
 import org.alfresco.query.EmptyPagingResults;
 import org.alfresco.query.PagingRequest;
@@ -64,11 +64,13 @@ import org.alfresco.repo.security.authentication.AuthenticationUtil;
 import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
 import org.alfresco.repo.transaction.AlfrescoTransactionSupport;
 import org.alfresco.repo.transaction.TransactionListener;
+import org.alfresco.service.Experimental;
 import org.alfresco.service.cmr.action.Action;
 import org.alfresco.service.cmr.action.ActionService;
 import org.alfresco.service.cmr.repository.ChildAssociationRef;
 import org.alfresco.service.cmr.repository.ContentReader;
 import org.alfresco.service.cmr.repository.ContentService;
+import org.alfresco.service.cmr.repository.DuplicateChildNodeNameException;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.NodeService;
 import org.alfresco.service.cmr.repository.Path;
@@ -1575,4 +1577,27 @@ public class TaggingServiceImpl implements TaggingService,
        }
    }

+    @Experimental
+    @Override
+    public List<Pair<String, NodeRef>> createTags(final StoreRef storeRef, final List<String> tagNames)
+    {
+        updateTagBehaviour.disable();
+        createTagBehaviour.disable();
+        try
+        {
+            return tagNames.stream()
+                .peek(tagName -> categoryService.getRootCategories(storeRef, ContentModel.ASPECT_TAGGABLE, tagName, false).stream()
+                    .filter(association -> Objects.nonNull(association.getChildRef()))
+                    .findAny()
+                    .ifPresent(association -> { throw new DuplicateChildNodeNameException(association.getParentRef(), association.getTypeQName(), tagName, null); }))
+                .map(String::toLowerCase)
+                .map(tagName -> new Pair<>(tagName, getTagNodeRef(storeRef, tagName, true)))
+                .collect(Collectors.toList());
+        }
+        finally
+        {
+            updateTagBehaviour.enable();
+            createTagBehaviour.enable();
+        }
+    }
 }
--- a/repository/src/main/java/org/alfresco/service/cmr/tagging/TaggingService.java
+++ b/repository/src/main/java/org/alfresco/service/cmr/tagging/TaggingService.java
@@ -1,36 +1,38 @@
-/*
- * #%L
- * Alfresco Repository
- * %%
- * Copyright (C) 2005 - 2016 Alfresco Software Limited
- * %%
- * This file is part of the Alfresco software. 
- * If the software was purchased under a paid Alfresco license, the terms of 
- * the paid license agreement will prevail.  Otherwise, the software is 
- * provided under the following open source license terms:
- * 
- * Alfresco is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- * 
- * Alfresco is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Lesser General Public License for more details.
- * 
- * You should have received a copy of the GNU Lesser General Public License
- * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
- * #L%
- */
+/*
+ * #%L
+ * Alfresco Repository
+ * %%
+ * Copyright (C) 2005 - 2023 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software. 
+ * If the software was purchased under a paid Alfresco license, the terms of 
+ * the paid license agreement will prevail.  Otherwise, the software is 
+ * provided under the following open source license terms:
+ * 
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
 package org.alfresco.service.cmr.tagging;

+import java.util.Collections;
 import java.util.List;

 import org.alfresco.api.AlfrescoPublicApi; 
 import org.alfresco.query.PagingRequest;
 import org.alfresco.query.PagingResults;
 import org.alfresco.service.Auditable;
+import org.alfresco.service.Experimental;
 import org.alfresco.service.NotAuditable;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.StoreRef;
@@ -306,17 +308,31 @@ public interface TaggingService
     */
    @NotAuditable
    Pair<List<String>, Integer> getPagedTags(StoreRef storeRef, String filter, int fromTag, int pageSize);
-    
-    
-    /**
-     * Get tagged nodes and count of nodes group by tag name
-     * 
-     * @param storeRef
-     * @return
-     */
-    @NotAuditable
-    List<Pair<String, Integer>> findTaggedNodesAndCountByTagName(StoreRef storeRef);
-
+    
+    
+    /**
+     * Get tagged nodes and count of nodes group by tag name
+     * 
+     * @param storeRef
+     * @return
+     */
+    @NotAuditable
+    List<Pair<String, Integer>> findTaggedNodesAndCountByTagName(StoreRef storeRef);
+
+    /**
+     * Creates orphan tags. Tag names case will be lowered.
+     *
+     * @param storeRef Reference to node store.
+     * @param tagNames List of tag names.
+     * @return {@link List} of {@link Pair}s of tag names and node references.
+     * @throws org.alfresco.service.cmr.repository.DuplicateChildNodeNameException if tag already exists.
+     */
+    @Experimental
+    @Auditable(parameters = {"tagNames"})
+    default List<Pair<String, NodeRef>> createTags(StoreRef storeRef, List<String> tagNames)
+    {
+        return Collections.emptyList();
+    }
 }


--- a/repository/src/test/java/org/alfresco/AllUnitTestsSuite.java
+++ b/repository/src/test/java/org/alfresco/AllUnitTestsSuite.java
@@ -244,7 +244,8 @@ import org.junit.runners.Suite;

    org.alfresco.repo.event2.RepoEvent2UnitSuite.class,

-    org.alfresco.util.schemacomp.SchemaDifferenceHelperUnitTest.class
+    org.alfresco.util.schemacomp.SchemaDifferenceHelperUnitTest.class,
+    org.alfresco.repo.tagging.TaggingServiceImplUnitTest.class
 })
 public class AllUnitTestsSuite
 {
--- a/repository/src/test/java/org/alfresco/repo/tagging/TaggingServiceImplUnitTest.java
+++ b/repository/src/test/java/org/alfresco/repo/tagging/TaggingServiceImplUnitTest.java
@@ -0,0 +1,106 @@
+/*
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2023 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail.  Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.repo.tagging;
+
+import static org.alfresco.service.cmr.repository.StoreRef.STORE_REF_WORKSPACE_SPACESSTORE;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.catchThrowable;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.BDDMockito.given;
+import static org.mockito.BDDMockito.then;
+import static org.mockito.Mockito.mock;
+
+import java.util.List;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.repo.policy.PolicyComponent;
+import org.alfresco.service.cmr.repository.ChildAssociationRef;
+import org.alfresco.service.cmr.repository.DuplicateChildNodeNameException;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.cmr.repository.StoreRef;
+import org.alfresco.service.cmr.search.CategoryService;
+import org.alfresco.util.Pair;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
+
+@RunWith(MockitoJUnitRunner.class)
+public class TaggingServiceImplUnitTest
+{
+    private static final String TAG_ID = "tag-node-id";
+    private static final String TAG_NAME = "tag-dummy-name";
+    private static final NodeRef TAG_NODE_REF = new NodeRef(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE, TAG_ID);
+
+    @Mock
+    private CategoryService categoryServiceMock;
+    @Mock
+    private PolicyComponent policyComponentMock;
+
+    @InjectMocks
+    private TaggingServiceImpl taggingService;
+
+    @Before
+    public void setUp() throws Exception
+    {
+        taggingService.init();
+    }
+
+    @Test
+    public void testCreateTags()
+    {
+        final ChildAssociationRef tagAssociationMock = mock(ChildAssociationRef.class);
+        given(categoryServiceMock.getRootCategories(any(), any(), any(String.class), eq(true))).willReturn(List.of(tagAssociationMock));
+        given(tagAssociationMock.getChildRef()).willReturn(TAG_NODE_REF);
+
+        //when
+        final List<Pair<String, NodeRef>> actualTagPairs = taggingService.createTags(STORE_REF_WORKSPACE_SPACESSTORE, List.of(TAG_NAME));
+
+        then(categoryServiceMock).should().getRootCategories(STORE_REF_WORKSPACE_SPACESSTORE, ContentModel.ASPECT_TAGGABLE, TAG_NAME, false);
+        then(categoryServiceMock).should().getRootCategories(STORE_REF_WORKSPACE_SPACESSTORE, ContentModel.ASPECT_TAGGABLE, TAG_NAME, true);
+        then(categoryServiceMock).shouldHaveNoMoreInteractions();
+        List<Pair<String, NodeRef>> expectedTagPairs = List.of(new Pair<>(TAG_NAME, TAG_NODE_REF));
+        assertThat(actualTagPairs)
+            .isNotNull()
+            .isEqualTo(expectedTagPairs);
+    }
+
+    @Test
+    public void testCreateTags_whileTagAlreadyExists()
+    {
+        given(categoryServiceMock.getRootCategories(any(), any(), any(String.class), eq(false))).willThrow(new DuplicateChildNodeNameException(null, null, null, null));
+
+        //when
+        final Throwable actualException = catchThrowable(() -> taggingService.createTags(STORE_REF_WORKSPACE_SPACESSTORE, List.of(TAG_NAME)));
+
+        then(categoryServiceMock).should().getRootCategories(STORE_REF_WORKSPACE_SPACESSTORE, ContentModel.ASPECT_TAGGABLE, TAG_NAME, false);
+        then(categoryServiceMock).shouldHaveNoMoreInteractions();
+        assertThat(actualException).isInstanceOf(DuplicateChildNodeNameException.class);
+    }
+}