Add scope from role for api token realm

scm-webapp/src/test/java/sonia/scm/security/ApiKeyRealmTest.java

@@ -0,0 +1,105 @@
+/*
+ * 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.security;
+
+import org.apache.shiro.authc.AuthenticationToken;
+import org.apache.shiro.authz.AuthorizationException;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Answers;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import sonia.scm.repository.RepositoryRole;
+import sonia.scm.repository.RepositoryRoleManager;
+
+import static java.util.Collections.singleton;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.argThat;
+import static org.mockito.Mockito.lenient;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+import static sonia.scm.security.BearerToken.valueOf;
+
+@ExtendWith(MockitoExtension.class)
+class ApiKeyRealmTest {
+
+  @Mock
+  ApiKeyService apiKeyService;
+  @Mock
+  DAORealmHelperFactory helperFactory;
+  @Mock
+  DAORealmHelper helper;
+  @Mock(answer = Answers.RETURNS_SELF)
+  DAORealmHelper.AuthenticationInfoBuilder authenticationInfoBuilder;
+  @Mock
+  RepositoryRoleManager repositoryRoleManager;
+
+  ApiKeyRealm realm;
+
+  @BeforeEach
+  void initRealmHelper() {
+    lenient().when(helperFactory.create("ApiTokenRealm")).thenReturn(helper);
+    lenient().when(helper.authenticationInfoBuilder(any())).thenReturn(authenticationInfoBuilder);
+    realm = new ApiKeyRealm(apiKeyService, helperFactory, repositoryRoleManager);
+  }
+
+  @Test
+  void shouldCreateAuthenticationWithScope() {
+    when(apiKeyService.check("towel")).thenReturn(new ApiKeyService.CheckResult("ford", "READ"));
+    when(repositoryRoleManager.get("READ")).thenReturn(new RepositoryRole("guide", singleton("read"), "system"));
+
+    realm.doGetAuthenticationInfo(valueOf("towel"));
+
+    verify(helper).authenticationInfoBuilder("ford");
+    verifyScopeSet("repository:read:*");
+    verify(authenticationInfoBuilder).withSessionId(null);
+  }
+
+  @Test
+  void shouldFailWithoutBearerToken() {
+    AuthenticationToken otherToken = mock(AuthenticationToken.class);
+    assertThrows(IllegalArgumentException.class, () -> realm.doGetAuthenticationInfo(otherToken));
+  }
+
+  @Test
+  void shouldFailWithUnknownRole() {
+    when(apiKeyService.check("towel")).thenReturn(new ApiKeyService.CheckResult("ford", "READ"));
+    when(repositoryRoleManager.get("READ")).thenReturn(null);
+
+    BearerToken token = valueOf("towel");
+    assertThrows(AuthorizationException.class, () -> realm.doGetAuthenticationInfo(token));
+  }
+
+  void verifyScopeSet(String... permissions) {
+    verify(authenticationInfoBuilder).withScope(argThat(scope -> {
+      assertThat(scope).containsExactly(permissions);
+      return true;
+    }));
+  }
+}