Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-18 03:01:05 +01:00
Code Issues Packages Projects Releases Activity

Read admin users from configuration

Browse Source
This commit is contained in:
René Pfeuffer
2019-05-31 16:32:19 +02:00
parent a91177a2d7
commit d9b9a07591
4 changed files with 105 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
scm-webapp/src/main/java/sonia/scm/user/update/XmlUserV1UpdateStep.java
View File

@@ -21,17 +21,20 @@ import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import static java.util.Collections.emptyList;
import static java.util.Optional.empty;
import static java.util.Optional.of;
import static java.util.Optional.ofNullable;
import static sonia.scm.version.Version.parse;
@Extension
@@ -57,9 +60,30 @@ public class XmlUserV1UpdateStep implements UpdateStep {
LOG.info("no v1 file for users found");
return;
}
Collection<String> adminUsers = determineAdminUsers();
LOG.debug("found the following admin users from global config: {}", adminUsers);
XmlUserV1UpdateStep.V1UserDatabase v1Database = readV1Database(v1UsersFile.get());
ConfigurationEntryStore<AssignedPermission> securityStore = createSecurityStore();
v1Database.userList.users.forEach(user -> update(user, securityStore));
v1Database.userList.users.forEach(user -> update(user, adminUsers, securityStore));
}
private Collection<String> determineAdminUsers() throws JAXBException {
Path configDirectory = determineConfigDirectory();
Path existingConfigFile = configDirectory.resolve("config" + StoreConstants.FILE_EXTENSION);
if (existingConfigFile.toFile().exists()) {
return extractAdminUsersFromConfigFile(existingConfigFile);
} else {
return emptyList();
}
}
private Collection<String> extractAdminUsersFromConfigFile(Path existingConfigFile) throws JAXBException {
JAXBContext jaxbContext = JAXBContext.newInstance(XmlUserV1UpdateStep.V1Configuration.class);
V1Configuration v1Configuration = (V1Configuration) jaxbContext.createUnmarshaller().unmarshal(existingConfigFile.toFile());
return ofNullable(v1Configuration.adminUsers)
.map(userList -> userList.split(","))
.map(Arrays::asList)
.orElse(emptyList());
}
@Override
@@ -72,7 +96,7 @@ public class XmlUserV1UpdateStep implements UpdateStep {
return "sonia.scm.user.xml";
}
private void update(XmlUserV1UpdateStep.V1User v1User, ConfigurationEntryStore<AssignedPermission> securityStore) {
private void update(V1User v1User, Collection<String> adminUsers, ConfigurationEntryStore<AssignedPermission> securityStore) {
LOG.debug("updating user {}", v1User.name);
User user = new User(
v1User.name,
@@ -85,7 +109,7 @@ public class XmlUserV1UpdateStep implements UpdateStep {
user.setLastModified(v1User.lastModified);
userDAO.add(user);
if (v1User.admin) {
if (v1User.admin || adminUsers.contains(v1User.name)) {
LOG.debug("setting admin permissions for user {}", v1User.name);
securityStore.put(new AssignedPermission(v1User.name, "*"));
}
@@ -101,7 +125,7 @@ public class XmlUserV1UpdateStep implements UpdateStep {
}
private Optional<Path> determineV1File() {
Path configDirectory = new File(contextProvider.getBaseDirectory(), StoreConstants.CONFIG_DIRECTORY_NAME).toPath();
Path configDirectory = determineConfigDirectory();
Path existingUsersFile = configDirectory.resolve("users" + StoreConstants.FILE_EXTENSION);
Path usersV1File = configDirectory.resolve("usersV1" + StoreConstants.FILE_EXTENSION);
if (existingUsersFile.toFile().exists()) {
@@ -116,6 +140,10 @@ public class XmlUserV1UpdateStep implements UpdateStep {
return empty();
}
private Path determineConfigDirectory() {
return new File(contextProvider.getBaseDirectory(), StoreConstants.CONFIG_DIRECTORY_NAME).toPath();
}
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "user")
private static class V1User {
@@ -147,6 +175,13 @@ public class XmlUserV1UpdateStep implements UpdateStep {
}
}
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "scm-config")
private static class V1Configuration {
@XmlElement(name = "admin-users")
private String adminUsers;
}
private static class UserList {
@XmlElement(name = "user")
private List<V1User> users;

27
scm-webapp/src/test/java/sonia/scm/user/update/XmlUserV1UpdateStepTest.java
View File

@@ -26,12 +26,12 @@ import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Optional;
import static org.mockito.Mockito.doNothing;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doNothing;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.assertj.core.api.Assertions.assertThat;
@ExtendWith(MockitoExtension.class)
@ExtendWith(TempDirectory.class)
@@ -53,7 +53,7 @@ class XmlUserV1UpdateStepTest {
when(contextProvider.getBaseDirectory()).thenReturn(tempDir.toFile());
assignedPermissionStore = new InMemoryConfigurationEntryStore<>();
ConfigurationEntryStoreFactory inMemoryConfigurationEntryStoreFactory = new InMemoryConfigurationEntryStoreFactory(assignedPermissionStore);
updateStep = new XmlUserV1UpdateStep(contextProvider,userDAO, inMemoryConfigurationEntryStoreFactory);
updateStep = new XmlUserV1UpdateStep(contextProvider, userDAO, inMemoryConfigurationEntryStoreFactory);
}
@Nested
@@ -66,10 +66,10 @@ class XmlUserV1UpdateStepTest {
@BeforeEach
void createUserV1XML(@TempDirectory.TempDir Path tempDir) throws IOException {
URL url = Resources.getResource("sonia/scm/user/update/users.xml");
Path configDir = tempDir.resolve("config");
Files.createDirectories(configDir);
Files.copy(url.openStream(), configDir.resolve("users.xml"));
copyTestDatabaseFile(configDir, "users.xml");
copyTestDatabaseFile(configDir, "config.xml");
}
@Test
@@ -83,7 +83,7 @@ class XmlUserV1UpdateStepTest {
@Test
void shouldCreateNewUserFromUsersV1Xml() throws JAXBException {
updateStep.doUpdate();
verify(userDAO, times(3)).add(any());
verify(userDAO, times(5)).add(any());
}
@Test
@@ -92,7 +92,7 @@ class XmlUserV1UpdateStepTest {
Optional<User> user = userCaptor.getAllValues().stream().filter(u -> u.getName().equals("scmadmin")).findFirst();
assertThat(user)
.get()
.hasFieldOrPropertyWithValue("name","scmadmin")
.hasFieldOrPropertyWithValue("name", "scmadmin")
.hasFieldOrPropertyWithValue("mail", "scm-admin@scm-manager.com")
.hasFieldOrPropertyWithValue("displayName", "SCM Administrator")
.hasFieldOrPropertyWithValue("active", false)
@@ -101,6 +101,19 @@ class XmlUserV1UpdateStepTest {
.hasFieldOrPropertyWithValue("lastModified", 1558597367492L)
.hasFieldOrPropertyWithValue("creationDate", 1558597074732L);
}
@Test
void shouldCreatePermissionForUsersConfiguredAsAdminInConfig() throws JAXBException {
updateStep.doUpdate();
Optional<AssignedPermission> assignedPermission = assignedPermissionStore.getAll().values().stream().filter(a -> a.getName().equals("dent")).findFirst();
assertThat(assignedPermission.get().getPermission().getValue()).contains("*");
assertThat(assignedPermission.get().isGroupPermission()).isFalse();
}
}
private void copyTestDatabaseFile(Path configDir, String usersFileName) throws IOException {
URL url = Resources.getResource("sonia/scm/user/update/" + usersFileName);
Files.copy(url.openStream(), configDir.resolve(usersFileName));
}
@Test

20
scm-webapp/src/test/resources/sonia/scm/user/update/config.xml Normal file
View File

@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<scm-config>
<admin-groups>admins,vogons</admin-groups>
<admin-users>arthur,dent</admin-users>
<base-url>http://localhost:8081/scm</base-url>
<enableProxy>false</enableProxy>
<force-base-url>false</force-base-url>
<forwardPort>80</forwardPort>
<plugin-url>http://plugins.scm-manager.org/scm-plugin-backend/api/{version}/plugins?os={os}&amp;arch={arch}&amp;snapshot=false</plugin-url>
<proxyPort>8080</proxyPort>
<proxyServer>proxy.mydomain.com</proxyServer>
<servername>localhost</servername>
<enableSSL>false</enableSSL>
<enablePortForward>false</enablePortForward>
<sslPort>8181</sslPort>
<enableRepositoryArchive>false</enableRepositoryArchive>
<disableGroupingGrid>false</disableGroupingGrid>
<dateFormat>Y-m-d H:i:s</dateFormat>
<anonymousAccessEnabled>false</anonymousAccessEnabled>
</scm-config>

28
scm-webapp/src/test/resources/sonia/scm/user/update/users.xml
View File

@@ -25,12 +25,34 @@
</user>
<user>
<properties/>
<admin>true</admin>
<admin>false</admin>
<creationDate>1558597107621</creationDate>
<displayName>edii</displayName>
<displayName>Arthur Dent</displayName>
<lastModified>1558597185919</lastModified>
<mail>edi@edi.de</mail>
<name>edi</name>
<name>dent</name>
<password>30f0d7632401710a20719ec21d21bc4ec232aa31</password>
<type>xml</type>
</user>
<user>
<properties/>
<admin>false</admin>
<creationDate>1558597107621</creationDate>
<displayName>Jeltz</displayName>
<lastModified>1558597185919</lastModified>
<mail>edi@edi.de</mail>
<name>jeltz</name>
<password>30f0d7632401710a20719ec21d21bc4ec232aa31</password>
<type>xml</type>
</user>
<user>
<properties/>
<admin>false</admin>
<creationDate>1558597107621</creationDate>
<displayName>Marvin</displayName>
<lastModified>1558597185919</lastModified>
<mail>edi@edi.de</mail>
<name>marvin</name>
<password>30f0d7632401710a20719ec21d21bc4ec232aa31</password>
<type>xml</type>
</user>