Merge imported repository permissions with existing repository permissions (#1520)

This commit is contained in:
Eduard Heimbuch
2021-02-05 12:20:55 +01:00
committed by GitHub
parent ac5d145266
commit 877713574a
7 changed files with 218 additions and 6 deletions

View File

@@ -28,8 +28,10 @@ import org.apache.commons.compress.archivers.ArchiveEntry;
import org.apache.commons.compress.archivers.tar.TarArchiveInputStream;
import org.apache.commons.compress.compressors.gzip.GzipCompressorInputStream;
import sonia.scm.ContextEntry;
import sonia.scm.importexport.RepositoryMetadataXmlGenerator.RepositoryMetadata;
import sonia.scm.repository.Repository;
import sonia.scm.repository.RepositoryManager;
import sonia.scm.repository.RepositoryPermission;
import sonia.scm.repository.api.ImportFailedException;
import sonia.scm.repository.api.RepositoryService;
import sonia.scm.repository.api.RepositoryServiceFactory;
@@ -40,7 +42,10 @@ import java.io.BufferedInputStream;
import java.io.FilterInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Collection;
import java.util.HashSet;
import static sonia.scm.importexport.FullScmRepositoryExporter.METADATA_FILE_NAME;
import static sonia.scm.importexport.FullScmRepositoryExporter.SCM_ENVIRONMENT_FILE_NAME;
import static sonia.scm.importexport.FullScmRepositoryExporter.STORE_DATA_FILE_NAME;
@@ -73,9 +78,10 @@ public class FullScmRepositoryImporter {
TarArchiveInputStream tais = new TarArchiveInputStream(gcis)
) {
checkScmEnvironment(repository, tais);
skipRepositoryMetadata(tais);
Collection<RepositoryPermission> importedPermissions = processRepositoryMetadata(tais);
Repository createdRepository = importRepositoryFromFile(repository, tais);
importStoresForCreatedRepository(createdRepository, tais);
importRepositoryPermissions(createdRepository, importedPermissions);
return createdRepository;
}
} else {
@@ -93,6 +99,14 @@ public class FullScmRepositoryImporter {
}
}
private void importRepositoryPermissions(Repository repository, Collection<RepositoryPermission> importedPermissions) {
Collection<RepositoryPermission> existingPermissions = repository.getPermissions();
RepositoryImportPermissionMerger permissionMerger = new RepositoryImportPermissionMerger();
Collection<RepositoryPermission> permissions = permissionMerger.merge(existingPermissions, importedPermissions);
repository.setPermissions(permissions);
repositoryManager.modify(repository);
}
private void importStoresForCreatedRepository(Repository repository, TarArchiveInputStream tais) throws IOException {
ArchiveEntry metadataEntry = tais.getNextEntry();
if (metadataEntry.getName().equals(STORE_DATA_FILE_NAME) && !metadataEntry.isDirectory()) {
@@ -135,7 +149,7 @@ public class FullScmRepositoryImporter {
boolean validEnvironment = compatibilityChecker.check(JAXB.unmarshal(new NoneClosingInputStream(tais), ScmEnvironment.class));
if (!validEnvironment) {
throw new ImportFailedException(
ContextEntry.ContextBuilder.entity(repository).build(),
ContextEntry.ContextBuilder.noContext(),
"Incompatible SCM-Manager environment. Could not import file."
);
}
@@ -147,8 +161,17 @@ public class FullScmRepositoryImporter {
}
}
private void skipRepositoryMetadata(TarArchiveInputStream tais) throws IOException {
tais.getNextEntry();
private Collection<RepositoryPermission> processRepositoryMetadata(TarArchiveInputStream tais) throws IOException {
ArchiveEntry metadataEntry = tais.getNextEntry();
if (metadataEntry.getName().equals(METADATA_FILE_NAME)) {
RepositoryMetadata metadata = JAXB.unmarshal(new NoneClosingInputStream(tais), RepositoryMetadata.class);
return new HashSet<>(metadata.getPermissions());
} else {
throw new ImportFailedException(
ContextEntry.ContextBuilder.noContext(),
String.format("Invalid import format. Missing SCM-Manager metadata description file %s.", METADATA_FILE_NAME)
);
}
}
@SuppressWarnings("java:S4929") // we only want to override close here

View File

@@ -0,0 +1,54 @@
/*
* 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.importexport;
import sonia.scm.repository.RepositoryPermission;
import java.util.Collection;
import java.util.HashSet;
import java.util.function.Predicate;
class RepositoryImportPermissionMerger {
public Collection<RepositoryPermission> merge(Collection<RepositoryPermission> existingPermissions,
Collection<RepositoryPermission> importedPermissions) {
HashSet<RepositoryPermission> permissions = new HashSet<>(existingPermissions);
importedPermissions
.stream()
.filter(permissionDoesNotExistYet(permissions))
.forEach(permissions::add);
return permissions;
}
private Predicate<RepositoryPermission> permissionDoesNotExistYet(HashSet<RepositoryPermission> permissions) {
return importedPermission ->
permissions.stream()
.noneMatch(existingPermission ->
existingPermission.getName().equals(importedPermission.getName())
&& existingPermission.isGroupPermission() == importedPermission.isGroupPermission()
);
}
}

View File

@@ -25,6 +25,7 @@
package sonia.scm.importexport;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import sonia.scm.ContextEntry;
import sonia.scm.repository.Repository;
@@ -57,9 +58,10 @@ class RepositoryMetadataXmlGenerator {
@AllArgsConstructor
@NoArgsConstructor
@Getter
@XmlRootElement(name = "metadata")
@XmlAccessorType(XmlAccessType.FIELD)
private static class RepositoryMetadata {
static class RepositoryMetadata {
private String namespace;
private String name;