Invalidation of caches and search index

In the general admin settings, the user can find two button to either invalidate the cache or rebuild the search index.

The endpoints are defined in the InvalidationResource class in scm-webapp.

Co-authored-by: René Pfeuffer<rene.pfeuffer@cloudogu.com>

scm-webapp/src/test/java/sonia/scm/api/v2/resources/IndexDtoGeneratorTest.java

@@ -155,6 +155,68 @@ class IndexDtoGeneratorTest {
         Link.linkBuilder("search", "/api/v2/search/query/group").withName("group").build()
       );
     }
+
+    @Nested
+    class InvalidationLinks {
+      @Test
+      void shouldAppendInvalidationLinks() {
+        when(subject.isAuthenticated()).thenReturn(true);
+        when(subject.isPermitted("configuration:list")).thenReturn(true);
+        when(subject.isPermitted("configuration:write:1")).thenReturn(true);
+        mockOtherPermissions();
+        when(configuration.getId()).thenReturn("1");
+
+        IndexDto dto = generator.generate();
+        assertThat(dto.getLinks().getLinkBy("invalidateCaches")).contains(
+          Link.linkBuilder("invalidateCaches", "/api/v2/invalidations/caches").build()
+        );
+        assertThat(dto.getLinks().getLinkBy("invalidateSearchIndex")).contains(
+          Link.linkBuilder("invalidateSearchIndex", "/api/v2/invalidations/search-index").build()
+        );
+      }
+
+      @Test
+      void shouldNotAppendInvalidationsIfWritePermissionIsMissing() {
+        when(subject.isAuthenticated()).thenReturn(true);
+        when(subject.isPermitted("configuration:list")).thenReturn(true);
+        when(subject.isPermitted("configuration:write:1")).thenReturn(false);
+        mockOtherPermissions();
+        when(configuration.getId()).thenReturn("1");
+
+        IndexDto dto = generator.generate();
+        assertThat(dto.getLinks().getLinkBy("invalidateCaches")).isEmpty();
+        assertThat(dto.getLinks().getLinkBy("invalidateSearchIndex")).isEmpty();
+      }
+
+      @Test
+      void shouldNotAppendInvalidationsIfListPermissionIsMissing() {
+        when(subject.isAuthenticated()).thenReturn(true);
+        when(subject.isPermitted("configuration:list")).thenReturn(false);
+        mockOtherPermissions();
+
+        IndexDto dto = generator.generate();
+        assertThat(dto.getLinks().getLinkBy("invalidateCaches")).isEmpty();
+        assertThat(dto.getLinks().getLinkBy("invalidateSearchIndex")).isEmpty();
+      }
+
+      @Test
+      void shouldNotAppendInvalidationsIfUnauthenticated() {
+        when(subject.isAuthenticated()).thenReturn(false);
+
+        IndexDto dto = generator.generate();
+        assertThat(dto.getLinks().getLinkBy("invalidateCaches")).isEmpty();
+        assertThat(dto.getLinks().getLinkBy("invalidateSearchIndex")).isEmpty();
+      }
+
+      private void mockOtherPermissions() {
+        when(subject.isPermitted("plugin:read")).thenReturn(false);
+        when(subject.isPermitted("plugin:write")).thenReturn(false);
+        when(subject.isPermitted("user:list")).thenReturn(false);
+        when(subject.isPermitted("user:autocomplete")).thenReturn(false);
+        when(subject.isPermitted("group:autocomplete")).thenReturn(false);
+        when(subject.isPermitted("group:list")).thenReturn(false);
+      }
+    }
   }
 
   private SearchableType searchableType(String name) {

scm-webapp/src/test/java/sonia/scm/api/v2/resources/InvalidationResourceTest.java

@@ -0,0 +1,126 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * 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, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package sonia.scm.api.v2.resources;
+
+import org.github.sdorra.jse.ShiroExtension;
+import org.github.sdorra.jse.SubjectAware;
+import org.jboss.resteasy.mock.MockHttpRequest;
+import org.jboss.resteasy.mock.MockHttpResponse;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import sonia.scm.cache.CacheManager;
+import sonia.scm.search.IndexRebuilder;
+import sonia.scm.web.RestDispatcher;
+
+import java.net.URISyntaxException;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoInteractions;
+
+
+@ExtendWith({MockitoExtension.class, ShiroExtension.class})
+@SubjectAware("TrainerRed")
+class InvalidationResourceTest {
+
+  @Mock
+  private CacheManager cacheManager;
+  @Mock
+  private IndexRebuilder indexRebuilder;
+
+  private RestDispatcher dispatcher;
+
+  private final String basePath = "/v2/invalidations";
+
+  @BeforeEach
+  void init() {
+   InvalidationResource invalidationResource = new InvalidationResource(cacheManager, indexRebuilder);
+
+   dispatcher = new RestDispatcher();
+   dispatcher.addSingletonResource(invalidationResource);
+  }
+
+  @Nested
+  class InvalidateCaches {
+
+    @Test
+    void shouldReturnForbiddenBecauseOfMissingPermission() throws URISyntaxException {
+      MockHttpResponse response = invokeInvalidateCaches();
+      assertThat(response.getStatus()).isEqualTo(403);
+      verifyNoInteractions(cacheManager);
+    }
+
+    @Test
+    @SubjectAware(permissions = {"configuration:write:global"})
+    void shouldClearCaches() throws URISyntaxException {
+      MockHttpResponse response = invokeInvalidateCaches();
+      assertThat(response.getStatus()).isEqualTo(204);
+      verify(cacheManager).clearAllCaches();
+    }
+
+    private MockHttpResponse invokeInvalidateCaches() throws URISyntaxException {
+      MockHttpRequest request = MockHttpRequest.post(basePath + "/caches");
+      MockHttpResponse response = new MockHttpResponse();
+
+      dispatcher.invoke(request, response);
+      return response;
+    }
+  }
+
+  @Nested
+  class ReIndex {
+
+    @Test
+    void shouldReturnForbiddenBecauseOfMissingPermission() throws URISyntaxException {
+      MockHttpResponse response = invokeReIndex();
+
+      assertThat(response.getStatus()).isEqualTo(403);
+
+      verifyNoInteractions(indexRebuilder);
+    }
+
+    @Test
+    @SubjectAware(permissions = {"configuration:write:global"})
+    void shouldReIndexAll() throws URISyntaxException {
+      MockHttpResponse response = invokeReIndex();
+
+      assertThat(response.getStatus()).isEqualTo(204);
+
+      verify(indexRebuilder).rebuildAll();
+    }
+
+    private MockHttpResponse invokeReIndex() throws URISyntaxException {
+      MockHttpRequest request = MockHttpRequest.post(basePath + "/search-index");
+      MockHttpResponse response = new MockHttpResponse();
+
+      dispatcher.invoke(request, response);
+      return response;
+    }
+  }
+}

scm-webapp/src/test/java/sonia/scm/cache/CacheManagerTestBase.java

@@ -87,6 +87,20 @@ public abstract class CacheManagerTestBase<C extends Cache>
     assertIsSame(c1, c2);
   }
 
+  @Test
+  public void shouldClearCache() {
+    Cache<String, String> c1 = cacheManager.getCache("test-1");
+    c1.put("key1", "value1");
+
+    Cache<String, String> c2 = cacheManager.getCache("test-2");
+    c2.put("key2", "value2");
+
+    cacheManager.clearAllCaches();
+
+    assertEquals(c1.size(), 0);
+    assertEquals(c2.size(), 0);
+  }
+
   /**
    * Method description
    *