Add new migration strategies "delete" and "ignore"

This commit is contained in:
René Pfeuffer
2019-06-07 13:52:54 +02:00
parent 20acd4ca64
commit 8a6b57e06c
12 changed files with 121 additions and 27 deletions

View File

@@ -9,6 +9,9 @@ import sonia.scm.repository.RepositoryLocationResolver;
import javax.inject.Inject;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Optional;
import static java.util.Optional.of;
class CopyMigrationStrategy extends BaseMigrationStrategy {
@@ -23,14 +26,14 @@ class CopyMigrationStrategy extends BaseMigrationStrategy {
}
@Override
public Path migrate(String id, String name, String type) {
public Optional<Path> migrate(String id, String name, String type) {
Path repositoryBasePath = locationResolver.forClass(Path.class).createLocation(id);
Path targetDataPath = repositoryBasePath
.resolve(RepositoryDirectoryHandler.REPOSITORIES_NATIVE_DIRECTORY);
Path sourceDataPath = getSourceDataPath(name, type);
LOG.info("copying repository data from {} to {}", sourceDataPath, targetDataPath);
copyData(sourceDataPath, targetDataPath);
return repositoryBasePath;
return of(repositoryBasePath);
}
private void copyData(Path sourceDirectory, Path targetDirectory) {

View File

@@ -0,0 +1,32 @@
package sonia.scm.update.repository;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import sonia.scm.SCMContextProvider;
import sonia.scm.util.IOUtil;
import javax.inject.Inject;
import java.io.IOException;
import java.nio.file.Path;
import java.util.Optional;
public class DeleteMigrationStrategy extends BaseMigrationStrategy {
private static final Logger LOG = LoggerFactory.getLogger(DeleteMigrationStrategy.class);
@Inject
DeleteMigrationStrategy(SCMContextProvider contextProvider) {
super(contextProvider);
}
@Override
public Optional<Path> migrate(String id, String name, String type) {
Path sourceDataPath = getSourceDataPath(name, type);
try {
IOUtil.delete(sourceDataPath.toFile(), true);
} catch (IOException e) {
LOG.warn("could not delete old repository path for repository {} with type {} and id {}", name, type, id);
}
return Optional.empty();
}
}

View File

@@ -0,0 +1,13 @@
package sonia.scm.update.repository;
import java.nio.file.Path;
import java.util.Optional;
import static java.util.Optional.empty;
public class IgnoreMigrationStrategy implements MigrationStrategy.Instance {
@Override
public Optional<Path> migrate(String id, String name, String type) {
return empty();
}
}

View File

@@ -10,6 +10,9 @@ import javax.inject.Inject;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Optional;
import static java.util.Optional.of;
class InlineMigrationStrategy extends BaseMigrationStrategy {
@@ -24,14 +27,14 @@ class InlineMigrationStrategy extends BaseMigrationStrategy {
}
@Override
public Path migrate(String id, String name, String type) {
public Optional<Path> migrate(String id, String name, String type) {
Path repositoryBasePath = getSourceDataPath(name, type);
locationResolver.forClass(Path.class).setLocation(id, repositoryBasePath);
Path targetDataPath = repositoryBasePath
.resolve(RepositoryDirectoryHandler.REPOSITORIES_NATIVE_DIRECTORY);
LOG.info("moving repository data from {} to {}", repositoryBasePath, targetDataPath);
moveData(repositoryBasePath, targetDataPath);
return repositoryBasePath;
return of(repositoryBasePath);
}
private void moveData(Path sourceDirectory, Path targetDirectory) {

View File

@@ -3,6 +3,7 @@ package sonia.scm.update.repository;
import com.google.inject.Injector;
import java.nio.file.Path;
import java.util.Optional;
public enum MigrationStrategy {
@@ -15,7 +16,13 @@ public enum MigrationStrategy {
INLINE(InlineMigrationStrategy.class,
"Use the current directory where the repository data files are stored, but modify the directory " +
"structure so that it can be used for SCM-Manager v2. The repository data files will be moved to a new " +
"subdirectory 'data' inside the current directory.");
"subdirectory 'data' inside the current directory."),
IGNORE(IgnoreMigrationStrategy.class,
"The repository will not be migrated and will not be visible inside SCM-Manager. " +
"The data files will be kept at the current location."),
DELETE(DeleteMigrationStrategy.class,
"The repository will not be migrated and will not be visible inside SCM-Manager. " +
"The data files will be deleted!");
private final Class<? extends Instance> implementationClass;
private final String description;
@@ -25,6 +32,10 @@ public enum MigrationStrategy {
this.description = description;
}
public Class<? extends Instance> getImplementationClass() {
return implementationClass;
}
public String getDescription() {
return description;
}
@@ -34,6 +45,6 @@ public enum MigrationStrategy {
}
interface Instance {
Path migrate(String id, String name, String type);
Optional<Path> migrate(String id, String name, String type);
}
}

View File

@@ -11,8 +11,10 @@ import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.Optional;
import static java.util.Arrays.asList;
import static java.util.Optional.of;
class MoveMigrationStrategy extends BaseMigrationStrategy {
@@ -27,7 +29,7 @@ class MoveMigrationStrategy extends BaseMigrationStrategy {
}
@Override
public Path migrate(String id, String name, String type) {
public Optional<Path> migrate(String id, String name, String type) {
Path repositoryBasePath = locationResolver.forClass(Path.class).createLocation(id);
Path targetDataPath = repositoryBasePath
.resolve(RepositoryDirectoryHandler.REPOSITORIES_NATIVE_DIRECTORY);
@@ -35,7 +37,7 @@ class MoveMigrationStrategy extends BaseMigrationStrategy {
LOG.info("moving repository data from {} to {}", sourceDataPath, targetDataPath);
moveData(sourceDataPath, targetDataPath);
deleteOldDataDir(getTypeDependentPath(type), name);
return repositoryBasePath;
return of(repositoryBasePath);
}
private void deleteOldDataDir(Path rootPath, String name) {

View File

@@ -141,21 +141,25 @@ public class XmlRepositoryV1UpdateStep implements UpdateStep {
}
private void update(V1Repository v1Repository) {
Path destination = handleDataDirectory(v1Repository);
Repository repository = new Repository(
v1Repository.id,
v1Repository.type,
v1Repository.getNewNamespace(),
v1Repository.getNewName(),
v1Repository.contact,
v1Repository.description,
createPermissions(v1Repository));
LOG.info("creating new repository {} with id {} from old repository {} in directory {}", repository.getNamespaceAndName(), repository.getId(), v1Repository.name, destination);
repositoryDao.add(repository, destination);
propertyStore.put(v1Repository.id, v1Repository.properties);
Optional<Path> destination = handleDataDirectory(v1Repository);
destination.ifPresent(
newPath -> {
Repository repository = new Repository(
v1Repository.id,
v1Repository.type,
v1Repository.getNewNamespace(),
v1Repository.getNewName(),
v1Repository.contact,
v1Repository.description,
createPermissions(v1Repository));
LOG.info("creating new repository {} with id {} from old repository {} in directory {}", repository.getNamespaceAndName(), repository.getId(), v1Repository.name, newPath);
repositoryDao.add(repository, newPath);
propertyStore.put(v1Repository.id, v1Repository.properties);
}
);
}
private Path handleDataDirectory(V1Repository v1Repository) {
private Optional<Path> handleDataDirectory(V1Repository v1Repository) {
MigrationStrategy dataMigrationStrategy = readMigrationStrategy(v1Repository);
LOG.info("using strategy {} to migrate repository {} with id {}", dataMigrationStrategy.getClass(), v1Repository.name, v1Repository.id);
return dataMigrationStrategy.from(injector).migrate(v1Repository.id, v1Repository.name, v1Repository.type);

View File

@@ -48,13 +48,13 @@ class CopyMigrationStrategyTest {
@Test
void shouldUseStandardDirectory(@TempDirectory.TempDir Path tempDir) {
Path target = new CopyMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git");
Path target = new CopyMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git").get();
assertThat(target).isEqualTo(tempDir.resolve("b4f-a9f0-49f7-ad1f-37d3aae1c55f"));
}
@Test
void shouldCopyDataDirectory(@TempDirectory.TempDir Path tempDir) {
Path target = new CopyMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git");
Path target = new CopyMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git").get();
assertThat(target.resolve("data")).exists();
Path originalDataDir = tempDir
.resolve("repositories")

View File

@@ -41,7 +41,7 @@ class InlineMigrationStrategyTest {
@Test
void shouldUseExistingDirectory(@TempDirectory.TempDir Path tempDir) {
Path target = new InlineMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git");
Path target = new InlineMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git").get();
assertThat(target).isEqualTo(resolveOldDirectory(tempDir));
verify(locationResolverInstance).setLocation("b4f-a9f0-49f7-ad1f-37d3aae1c55f", target);
}

View File

@@ -3,10 +3,13 @@ package sonia.scm.update.repository;
import com.google.inject.Injector;
import sonia.scm.update.repository.MigrationStrategy.Instance;
import java.nio.file.Paths;
import java.util.HashMap;
import java.util.Map;
import static java.util.Optional.of;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.lenient;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
@@ -20,6 +23,13 @@ class MigrationStrategyMock {
.thenAnswer(
invocationOnMock -> mocks.computeIfAbsent(invocationOnMock.getArgument(0), key -> mock((Class<Instance>) key))
);
for (MigrationStrategy strategy : MigrationStrategy.values()) {
MigrationStrategy.Instance strategyMock = mock(strategy.getImplementationClass());
when(strategyMock.migrate(any(), any(), any())).thenReturn(of(Paths.get("")));
lenient().when(mock.getInstance((Class<MigrationStrategy.Instance>) strategy.getImplementationClass())).thenReturn(strategyMock);
}
return mock;
}
}

View File

@@ -45,13 +45,13 @@ class MoveMigrationStrategyTest {
@Test
void shouldUseStandardDirectory(@TempDirectory.TempDir Path tempDir) {
Path target = new MoveMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git");
Path target = new MoveMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git").get();
assertThat(target).isEqualTo(tempDir.resolve("b4f-a9f0-49f7-ad1f-37d3aae1c55f"));
}
@Test
void shouldMoveDataDirectory(@TempDirectory.TempDir Path tempDir) {
Path target = new MoveMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git");
Path target = new MoveMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git").get();
assertThat(target.resolve("data")).exists();
Path originalDataDir = tempDir
.resolve("repositories")

View File

@@ -25,6 +25,7 @@ import java.io.IOException;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Optional;
import static java.util.Optional.empty;
@@ -33,10 +34,12 @@ 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.Mockito.lenient;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static sonia.scm.update.repository.MigrationStrategy.COPY;
import static sonia.scm.update.repository.MigrationStrategy.DELETE;
import static sonia.scm.update.repository.MigrationStrategy.INLINE;
import static sonia.scm.update.repository.MigrationStrategy.MOVE;
@@ -177,13 +180,26 @@ class XmlRepositoryV1UpdateStepTest {
void shouldUseDirectoryFromStrategy(@TempDirectory.TempDir Path tempDir) throws JAXBException {
Path targetDir = tempDir.resolve("someDir");
MigrationStrategy.Instance strategyMock = injectorMock.getInstance(InlineMigrationStrategy.class);
when(strategyMock.migrate("454972da-faf9-4437-b682-dc4a4e0aa8eb", "simple", "git")).thenReturn(targetDir);
when(strategyMock.migrate("454972da-faf9-4437-b682-dc4a4e0aa8eb", "simple", "git")).thenReturn(of(targetDir));
updateStep.doUpdate();
assertThat(locationCaptor.getAllValues()).contains(targetDir);
}
@Test
void shouldSkipWhenStrategyGivesNoNewPath() throws JAXBException {
for (MigrationStrategy strategy : MigrationStrategy.values()) {
MigrationStrategy.Instance strategyMock = mock(strategy.getImplementationClass());
lenient().when(strategyMock.migrate(any(), any(), any())).thenReturn(empty());
lenient().when(injectorMock.getInstance((Class<MigrationStrategy.Instance>) strategy.getImplementationClass())).thenReturn(strategyMock);
}
updateStep.doUpdate();
assertThat(locationCaptor.getAllValues()).isEmpty();
}
@Test
void shouldFailForMissingMigrationStrategy() {
lenient().when(migrationStrategyDao.get("c1597b4f-a9f0-49f7-ad1f-37d3aae1c55f")).thenReturn(empty());