From 4f21756d007c40f23cbed0f1c1f020154385adf2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Pfeuffer?= Date: Tue, 27 Aug 2019 16:56:44 +0200 Subject: [PATCH 01/12] Extract class to provide temporary work directories --- .../repository/util/SimpleWorkdirFactory.java | 20 +++---------- .../scm/repository/util/WorkdirProvider.java | 29 +++++++++++++++++++ .../util/SimpleWorkdirFactoryTest.java | 3 +- .../spi/SimpleGitWorkdirFactory.java | 8 ++--- .../repository/spi/GitBranchCommandTest.java | 5 ++-- .../repository/spi/GitMergeCommandTest.java | 3 +- .../spi/SimpleGitWorkdirFactoryTest.java | 11 ++++--- .../spi/SimpleHgWorkdirFactory.java | 4 ++- .../repository/spi/HgBranchCommandTest.java | 3 +- 9 files changed, 55 insertions(+), 31 deletions(-) create mode 100644 scm-core/src/main/java/sonia/scm/repository/util/WorkdirProvider.java diff --git a/scm-core/src/main/java/sonia/scm/repository/util/SimpleWorkdirFactory.java b/scm-core/src/main/java/sonia/scm/repository/util/SimpleWorkdirFactory.java index 0872242612..7236e0c3fe 100644 --- a/scm-core/src/main/java/sonia/scm/repository/util/SimpleWorkdirFactory.java +++ b/scm-core/src/main/java/sonia/scm/repository/util/SimpleWorkdirFactory.java @@ -7,29 +7,21 @@ import sonia.scm.repository.Repository; import java.io.File; import java.io.IOException; -import java.nio.file.Files; public abstract class SimpleWorkdirFactory implements WorkdirFactory { private static final Logger logger = LoggerFactory.getLogger(SimpleWorkdirFactory.class); - private final File poolDirectory; + private final WorkdirProvider workdirProvider; - public SimpleWorkdirFactory() { - this(new File(System.getProperty("scm.workdir" , System.getProperty("java.io.tmpdir")), "scm-work")); - } - - public SimpleWorkdirFactory(File poolDirectory) { - this.poolDirectory = poolDirectory; - if (!poolDirectory.exists() && !poolDirectory.mkdirs()) { - throw new IllegalStateException("could not create pool directory " + poolDirectory); - } + public SimpleWorkdirFactory(WorkdirProvider workdirProvider) { + this.workdirProvider = workdirProvider; } @Override public WorkingCopy createWorkingCopy(C context) { try { - File directory = createNewWorkdir(); + File directory = workdirProvider.createNewWorkdir(); ParentAndClone parentAndClone = cloneRepository(context, directory); return new WorkingCopy<>(parentAndClone.getClone(), parentAndClone.getParent(), this::close, directory); } catch (IOException e) { @@ -45,10 +37,6 @@ public abstract class SimpleWorkdirFactory implements WorkdirFactory protected abstract ParentAndClone cloneRepository(C context, File target) throws IOException; - private File createNewWorkdir() throws IOException { - return Files.createTempDirectory(poolDirectory.toPath(),"workdir").toFile(); - } - private void close(R repository) { try { closeRepository(repository); diff --git a/scm-core/src/main/java/sonia/scm/repository/util/WorkdirProvider.java b/scm-core/src/main/java/sonia/scm/repository/util/WorkdirProvider.java new file mode 100644 index 0000000000..35dae56faa --- /dev/null +++ b/scm-core/src/main/java/sonia/scm/repository/util/WorkdirProvider.java @@ -0,0 +1,29 @@ +package sonia.scm.repository.util; + +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; + +public class WorkdirProvider { + + private final File poolDirectory; + + public WorkdirProvider() { + this(new File(System.getProperty("scm.workdir" , System.getProperty("java.io.tmpdir")), "scm-work")); + } + + public WorkdirProvider(File poolDirectory) { + this.poolDirectory = poolDirectory; + if (!poolDirectory.exists() && !poolDirectory.mkdirs()) { + throw new IllegalStateException("could not create pool directory " + poolDirectory); + } + } + + public File createNewWorkdir() { + try { + return Files.createTempDirectory(poolDirectory.toPath(),"workdir").toFile(); + } catch (IOException e) { + throw new RuntimeException("could not create temporary workdir", e); + } + } +} diff --git a/scm-core/src/test/java/sonia/scm/repository/util/SimpleWorkdirFactoryTest.java b/scm-core/src/test/java/sonia/scm/repository/util/SimpleWorkdirFactoryTest.java index 2d3c2ed59e..31aa11c604 100644 --- a/scm-core/src/test/java/sonia/scm/repository/util/SimpleWorkdirFactoryTest.java +++ b/scm-core/src/test/java/sonia/scm/repository/util/SimpleWorkdirFactoryTest.java @@ -28,7 +28,8 @@ public class SimpleWorkdirFactoryTest { @Before public void initFactory() throws IOException { - simpleWorkdirFactory = new SimpleWorkdirFactory(temporaryFolder.newFolder()) { + WorkdirProvider workdirProvider = new WorkdirProvider(temporaryFolder.newFolder()); + simpleWorkdirFactory = new SimpleWorkdirFactory(workdirProvider) { @Override protected Repository getScmRepository(Context context) { return REPOSITORY; diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/SimpleGitWorkdirFactory.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/SimpleGitWorkdirFactory.java index c30ff59afb..28042f0834 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/SimpleGitWorkdirFactory.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/SimpleGitWorkdirFactory.java @@ -7,16 +7,14 @@ import org.eclipse.jgit.transport.ScmTransportProtocol; import sonia.scm.repository.GitWorkdirFactory; import sonia.scm.repository.InternalRepositoryException; import sonia.scm.repository.util.SimpleWorkdirFactory; +import sonia.scm.repository.util.WorkdirProvider; import java.io.File; public class SimpleGitWorkdirFactory extends SimpleWorkdirFactory implements GitWorkdirFactory { - public SimpleGitWorkdirFactory() { - } - - SimpleGitWorkdirFactory(File poolDirectory) { - super(poolDirectory); + public SimpleGitWorkdirFactory(WorkdirProvider workdirProvider) { + super(workdirProvider); } @Override diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBranchCommandTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBranchCommandTest.java index e429aa5a42..aa5e641b31 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBranchCommandTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBranchCommandTest.java @@ -5,6 +5,7 @@ import org.junit.Rule; import org.junit.Test; import sonia.scm.repository.Branch; import sonia.scm.repository.api.BranchRequest; +import sonia.scm.repository.util.WorkdirProvider; import java.io.IOException; import java.util.List; @@ -25,7 +26,7 @@ public class GitBranchCommandTest extends AbstractGitCommandTestBase { branchRequest.setParentBranch(source.getName()); branchRequest.setNewBranch("new_branch"); - new GitBranchCommand(context, repository, new SimpleGitWorkdirFactory()).branch(branchRequest); + new GitBranchCommand(context, repository, new SimpleGitWorkdirFactory(new WorkdirProvider())).branch(branchRequest); Branch newBranch = findBranch(context, "new_branch"); Assertions.assertThat(newBranch.getRevision()).isEqualTo(source.getRevision()); @@ -45,7 +46,7 @@ public class GitBranchCommandTest extends AbstractGitCommandTestBase { BranchRequest branchRequest = new BranchRequest(); branchRequest.setNewBranch("new_branch"); - new GitBranchCommand(context, repository, new SimpleGitWorkdirFactory()).branch(branchRequest); + new GitBranchCommand(context, repository, new SimpleGitWorkdirFactory(new WorkdirProvider())).branch(branchRequest); Assertions.assertThat(readBranches(context)).filteredOn(b -> b.getName().equals("new_branch")).isNotEmpty(); } diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitMergeCommandTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitMergeCommandTest.java index e8a62f5b86..8b3b4548d9 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitMergeCommandTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitMergeCommandTest.java @@ -24,6 +24,7 @@ import sonia.scm.repository.RepositoryManager; import sonia.scm.repository.api.HookContextFactory; import sonia.scm.repository.api.MergeCommandResult; import sonia.scm.repository.api.MergeDryRunCommandResult; +import sonia.scm.repository.util.WorkdirProvider; import sonia.scm.user.User; import java.io.IOException; @@ -244,6 +245,6 @@ public class GitMergeCommandTest extends AbstractGitCommandTestBase { } private GitMergeCommand createCommand() { - return new GitMergeCommand(createContext(), repository, new SimpleGitWorkdirFactory()); + return new GitMergeCommand(createContext(), repository, new SimpleGitWorkdirFactory(new WorkdirProvider())); } } diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/SimpleGitWorkdirFactoryTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/SimpleGitWorkdirFactoryTest.java index 616df5e68e..1b3c730ef1 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/SimpleGitWorkdirFactoryTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/SimpleGitWorkdirFactoryTest.java @@ -11,6 +11,7 @@ import sonia.scm.repository.GitRepositoryHandler; import sonia.scm.repository.PreProcessorUtil; import sonia.scm.repository.RepositoryManager; import sonia.scm.repository.api.HookContextFactory; +import sonia.scm.repository.util.WorkdirProvider; import sonia.scm.repository.util.WorkingCopy; import java.io.File; @@ -29,19 +30,21 @@ public class SimpleGitWorkdirFactoryTest extends AbstractGitCommandTestBase { // keep this so that it will not be garbage collected (Transport keeps this in a week reference) private ScmTransportProtocol proto; + private WorkdirProvider workdirProvider; @Before - public void bindScmProtocol() { + public void bindScmProtocol() throws IOException { HookContextFactory hookContextFactory = new HookContextFactory(mock(PreProcessorUtil.class)); HookEventFacade hookEventFacade = new HookEventFacade(of(mock(RepositoryManager.class)), hookContextFactory); GitRepositoryHandler gitRepositoryHandler = mock(GitRepositoryHandler.class); proto = new ScmTransportProtocol(of(hookEventFacade), of(gitRepositoryHandler)); Transport.register(proto); + workdirProvider = new WorkdirProvider(temporaryFolder.newFolder()); } @Test public void emptyPoolShouldCreateNewWorkdir() throws IOException { - SimpleGitWorkdirFactory factory = new SimpleGitWorkdirFactory(temporaryFolder.newFolder()); + SimpleGitWorkdirFactory factory = new SimpleGitWorkdirFactory(workdirProvider); File masterRepo = createRepositoryDirectory(); try (WorkingCopy workingCopy = factory.createWorkingCopy(createContext())) { @@ -59,7 +62,7 @@ public class SimpleGitWorkdirFactoryTest extends AbstractGitCommandTestBase { @Test public void cloneFromPoolShouldNotBeReused() throws IOException { - SimpleGitWorkdirFactory factory = new SimpleGitWorkdirFactory(temporaryFolder.newFolder()); + SimpleGitWorkdirFactory factory = new SimpleGitWorkdirFactory(workdirProvider); File firstDirectory; try (WorkingCopy workingCopy = factory.createWorkingCopy(createContext())) { @@ -73,7 +76,7 @@ public class SimpleGitWorkdirFactoryTest extends AbstractGitCommandTestBase { @Test public void cloneFromPoolShouldBeDeletedOnClose() throws IOException { - SimpleGitWorkdirFactory factory = new SimpleGitWorkdirFactory(temporaryFolder.newFolder()); + SimpleGitWorkdirFactory factory = new SimpleGitWorkdirFactory(workdirProvider); File directory; try (WorkingCopy workingCopy = factory.createWorkingCopy(createContext())) { diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/SimpleHgWorkdirFactory.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/SimpleHgWorkdirFactory.java index 9565f672d5..b9194145e6 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/SimpleHgWorkdirFactory.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/SimpleHgWorkdirFactory.java @@ -4,6 +4,7 @@ import com.aragost.javahg.Repository; import com.aragost.javahg.commands.CloneCommand; import com.aragost.javahg.commands.PullCommand; import sonia.scm.repository.util.SimpleWorkdirFactory; +import sonia.scm.repository.util.WorkdirProvider; import sonia.scm.web.HgRepositoryEnvironmentBuilder; import javax.inject.Inject; @@ -18,7 +19,8 @@ public class SimpleHgWorkdirFactory extends SimpleWorkdirFactory hgRepositoryEnvironmentBuilder; @Inject - public SimpleHgWorkdirFactory(Provider hgRepositoryEnvironmentBuilder) { + public SimpleHgWorkdirFactory(Provider hgRepositoryEnvironmentBuilder, WorkdirProvider workdirProvider) { + super(workdirProvider); this.hgRepositoryEnvironmentBuilder = hgRepositoryEnvironmentBuilder; } @Override diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgBranchCommandTest.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgBranchCommandTest.java index c015aa0f62..7976af8b3b 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgBranchCommandTest.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgBranchCommandTest.java @@ -7,6 +7,7 @@ import org.junit.Test; import sonia.scm.repository.Branch; import sonia.scm.repository.HgTestUtil; import sonia.scm.repository.api.BranchRequest; +import sonia.scm.repository.util.WorkdirProvider; import sonia.scm.web.HgRepositoryEnvironmentBuilder; import java.io.IOException; @@ -20,7 +21,7 @@ public class HgBranchCommandTest extends AbstractHgCommandTestBase { HgRepositoryEnvironmentBuilder hgRepositoryEnvironmentBuilder = new HgRepositoryEnvironmentBuilder(handler, HgTestUtil.createHookManager()); - SimpleHgWorkdirFactory workdirFactory = new SimpleHgWorkdirFactory(Providers.of(hgRepositoryEnvironmentBuilder)) { + SimpleHgWorkdirFactory workdirFactory = new SimpleHgWorkdirFactory(Providers.of(hgRepositoryEnvironmentBuilder), new WorkdirProvider()) { @Override public void configure(PullCommand pullCommand) { // we do not want to configure http hooks in this unit test From 44d99fcc9d8ff093dccfd55453baddeb35ff9ca2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Pfeuffer?= Date: Tue, 27 Aug 2019 16:57:10 +0200 Subject: [PATCH 02/12] Create new modification command --- .../api/ModificationCommandBuilder.java | 194 ++++++++++++++++++ .../repository/spi/ModificationCommand.java | 15 ++ .../api/ModificationCommandBuilderTest.java | 160 +++++++++++++++ 3 files changed, 369 insertions(+) create mode 100644 scm-core/src/main/java/sonia/scm/repository/api/ModificationCommandBuilder.java create mode 100644 scm-core/src/main/java/sonia/scm/repository/spi/ModificationCommand.java create mode 100644 scm-core/src/test/java/sonia/scm/repository/api/ModificationCommandBuilderTest.java diff --git a/scm-core/src/main/java/sonia/scm/repository/api/ModificationCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/ModificationCommandBuilder.java new file mode 100644 index 0000000000..863fb1731b --- /dev/null +++ b/scm-core/src/main/java/sonia/scm/repository/api/ModificationCommandBuilder.java @@ -0,0 +1,194 @@ +package sonia.scm.repository.api; + +import com.google.common.io.ByteSource; +import com.google.common.io.ByteStreams; +import com.google.common.io.Files; +import sonia.scm.repository.spi.ModificationCommand; +import sonia.scm.repository.util.WorkdirProvider; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.util.ArrayList; +import java.util.List; +import java.util.function.Consumer; + +public class ModificationCommandBuilder { + + private final ModificationCommand command; + private final File workdir; + + private final List modifications = new ArrayList<>(); + + ModificationCommandBuilder(ModificationCommand command, WorkdirProvider workdirProvider) { + this.command = command; + this.workdir = workdirProvider.createNewWorkdir(); + } + + ModificationCommandBuilder setBranchToModify(String branchToModify) { + return this; + } + + ContentLoader createFile(String path) { + return new ContentLoader( + content -> modifications.add(new CreateFile(path, content)) + ); + } + + ContentLoader modifyFile(String path) { + return new ContentLoader( + content -> modifications.add(new ModifyFile(path, content)) + ); + } + + ModificationCommandBuilder deleteFile(String path) { + modifications.add(new DeleteFile(path)); + return this; + } + + ModificationCommandBuilder moveFile(String sourcePath, String targetPath) { + modifications.add(new MoveFile(sourcePath, targetPath)); + return this; + } + + String execute() { + modifications.forEach(FileModification::execute); + modifications.forEach(FileModification::cleanup); + return command.commit(); + } + + private Content loadData(ByteSource data) throws IOException { + File file = createTemporaryFile(); + data.copyTo(Files.asByteSink(file)); + return new Content(file); + } + + private Content loadData(InputStream data) throws IOException { + File file = createTemporaryFile(); + OutputStream out = Files.asByteSink(file).openBufferedStream(); + ByteStreams.copy(data, out); + out.close(); + return new Content(file); + } + + private File createTemporaryFile() throws IOException { + return File.createTempFile("upload-", "", workdir); + } + + private interface FileModification { + void execute(); + + default void cleanup() { + } + } + + private class DeleteFile implements FileModification { + private final String path; + + public DeleteFile(String path) { + this.path = path; + } + + @Override + public void execute() { + command.delete(path); + } + } + + private class MoveFile implements FileModification { + private final String sourcePath; + private final String targetPath; + + private MoveFile(String sourcePath, String targetPath) { + this.sourcePath = sourcePath; + this.targetPath = targetPath; + } + + @Override + public void execute() { + command.move(sourcePath, targetPath); + } + } + + private abstract class DataBasedModification implements FileModification { + + private final Content content; + + DataBasedModification(Content content) { + this.content = content; + } + + public Content getContent() { + return content; + } + @Override + public void cleanup() { + content.deleteFile(); + } + } + + private class CreateFile extends DataBasedModification { + + private final String path; + + CreateFile(String path, Content content) { + super(content); + this.path = path; + } + @Override + public void execute() { + command.create(path, getContent().getFile()); + } + } + + private class ModifyFile extends DataBasedModification { + + private final String path; + + ModifyFile(String path, Content content) { + super(content); + this.path = path; + } + @Override + public void execute() { + command.modify(path, getContent().getFile()); + } + } + + public class ContentLoader { + + private final Consumer contentConsumer; + + private ContentLoader(Consumer contentConsumer) { + this.contentConsumer = contentConsumer; + } + + public ModificationCommandBuilder withData(ByteSource data) throws IOException { + Content content = loadData(data); + contentConsumer.accept(content); + return ModificationCommandBuilder.this; + } + public ModificationCommandBuilder withData(InputStream data) throws IOException { + Content content = loadData(data); + contentConsumer.accept(content); + return ModificationCommandBuilder.this; + } + } + + private class Content { + + private final File file; + + Content(File file) { + this.file = file; + } + + private File getFile() { + return file; + } + public void deleteFile() { + file.delete(); + } + } +} diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/ModificationCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/ModificationCommand.java new file mode 100644 index 0000000000..c221acc1d6 --- /dev/null +++ b/scm-core/src/main/java/sonia/scm/repository/spi/ModificationCommand.java @@ -0,0 +1,15 @@ +package sonia.scm.repository.spi; + +import java.io.File; + +public interface ModificationCommand { + String commit(); + + void delete(String toBeDeleted); + + void create(String toBeCreated, File file); + + void modify(String path, File file); + + void move(String sourcePath, String targetPath); +} diff --git a/scm-core/src/test/java/sonia/scm/repository/api/ModificationCommandBuilderTest.java b/scm-core/src/test/java/sonia/scm/repository/api/ModificationCommandBuilderTest.java new file mode 100644 index 0000000000..f27b89964c --- /dev/null +++ b/scm-core/src/test/java/sonia/scm/repository/api/ModificationCommandBuilderTest.java @@ -0,0 +1,160 @@ +package sonia.scm.repository.api; + +import com.google.common.io.ByteSource; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junitpioneer.jupiter.TempDirectory; +import org.mockito.ArgumentCaptor; +import org.mockito.Mock; +import org.mockito.invocation.InvocationOnMock; +import org.mockito.junit.jupiter.MockitoExtension; +import org.mockito.stubbing.Answer; +import sonia.scm.repository.spi.ModificationCommand; +import sonia.scm.repository.util.WorkdirProvider; + +import java.io.ByteArrayInputStream; +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.doAnswer; +import static org.mockito.Mockito.doNothing; +import static org.mockito.Mockito.lenient; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +@ExtendWith(MockitoExtension.class) +@ExtendWith(TempDirectory.class) +class ModificationCommandBuilderTest { + + @Mock + ModificationCommand command; + @Mock + WorkdirProvider workdirProvider; + + ModificationCommandBuilder commandBuilder; + + @BeforeEach + void initWorkdir(@TempDirectory.TempDir Path temp) throws IOException { + lenient().when(workdirProvider.createNewWorkdir()).thenReturn(temp.toFile()); + commandBuilder = new ModificationCommandBuilder(command, workdirProvider); + } + + @Test + void shouldReturnTargetRevisionFromCommit() { + when(command.commit()).thenReturn("target"); + + String targetRevision = commandBuilder.execute(); + + assertThat(targetRevision).isEqualTo("target"); + } + + @Test + void shouldExecuteDelete() { + commandBuilder + .deleteFile("toBeDeleted") + .execute(); + + verify(command).delete("toBeDeleted"); + } + + @Test + void shouldExecuteMove() { + commandBuilder + .moveFile("source", "target") + .execute(); + + verify(command).move("source", "target"); + } + + @Test + void shouldExecuteCreateWithByteSourceContent() throws IOException { + ArgumentCaptor nameCaptor = ArgumentCaptor.forClass(String.class); + List contentCaptor = new ArrayList<>(); + doAnswer(new ExtractContent(contentCaptor)).when(command).create(nameCaptor.capture(), any()); + + commandBuilder + .createFile("toBeCreated").withData(ByteSource.wrap("content".getBytes())) + .execute(); + + assertThat(nameCaptor.getValue()).isEqualTo("toBeCreated"); + assertThat(contentCaptor).contains("content"); + } + + @Test + void shouldExecuteCreateWithInputStreamContent() throws IOException { + ArgumentCaptor nameCaptor = ArgumentCaptor.forClass(String.class); + List contentCaptor = new ArrayList<>(); + doAnswer(new ExtractContent(contentCaptor)).when(command).create(nameCaptor.capture(), any()); + + commandBuilder + .createFile("toBeCreated").withData(new ByteArrayInputStream("content".getBytes())) + .execute(); + + assertThat(nameCaptor.getValue()).isEqualTo("toBeCreated"); + assertThat(contentCaptor).contains("content"); + } + + @Test + void shouldExecuteCreateMultipleTimes() throws IOException { + ArgumentCaptor nameCaptor = ArgumentCaptor.forClass(String.class); + List contentCaptor = new ArrayList<>(); + doAnswer(new ExtractContent(contentCaptor)).when(command).create(nameCaptor.capture(), any()); + + commandBuilder + .createFile("toBeCreated_1").withData(new ByteArrayInputStream("content_1".getBytes())) + .createFile("toBeCreated_2").withData(new ByteArrayInputStream("content_2".getBytes())) + .execute(); + + List createdNames = nameCaptor.getAllValues(); + assertThat(createdNames.get(0)).isEqualTo("toBeCreated_1"); + assertThat(createdNames.get(1)).isEqualTo("toBeCreated_2"); + assertThat(contentCaptor).contains("content_1", "content_2"); + } + + @Test + void shouldExecuteModify() throws IOException { + ArgumentCaptor nameCaptor = ArgumentCaptor.forClass(String.class); + List contentCaptor = new ArrayList<>(); + doAnswer(new ExtractContent(contentCaptor)).when(command).modify(nameCaptor.capture(), any()); + + commandBuilder + .modifyFile("toBeModified").withData(ByteSource.wrap("content".getBytes())) + .execute(); + + assertThat(nameCaptor.getValue()).isEqualTo("toBeModified"); + assertThat(contentCaptor).contains("content"); + } + + @Test + void shouldDeleteTemporaryFiles(@TempDirectory.TempDir Path temp) throws IOException { + ArgumentCaptor nameCaptor = ArgumentCaptor.forClass(String.class); + ArgumentCaptor fileCaptor = ArgumentCaptor.forClass(File.class); + doNothing().when(command).modify(nameCaptor.capture(), fileCaptor.capture()); + + commandBuilder + .modifyFile("toBeModified").withData(ByteSource.wrap("content".getBytes())) + .execute(); + + assertThat(Files.list(temp)).isEmpty(); + } + + private static class ExtractContent implements Answer { + private final List contentCaptor; + + public ExtractContent(List contentCaptor) { + this.contentCaptor = contentCaptor; + } + + @Override + public Object answer(InvocationOnMock invocation) throws Throwable { + return contentCaptor.add(Files.readAllLines(((File) invocation.getArgument(1)).toPath()).get(0)); + } + } +} From 956d9a42c8a3eb6ad17d518ce78422128b6d037b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Pfeuffer?= Date: Wed, 28 Aug 2019 06:32:15 +0200 Subject: [PATCH 03/12] Fix injection --- .../java/sonia/scm/repository/spi/SimpleGitWorkdirFactory.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/SimpleGitWorkdirFactory.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/SimpleGitWorkdirFactory.java index 28042f0834..9edcf0c0ea 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/SimpleGitWorkdirFactory.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/SimpleGitWorkdirFactory.java @@ -9,10 +9,12 @@ import sonia.scm.repository.InternalRepositoryException; import sonia.scm.repository.util.SimpleWorkdirFactory; import sonia.scm.repository.util.WorkdirProvider; +import javax.inject.Inject; import java.io.File; public class SimpleGitWorkdirFactory extends SimpleWorkdirFactory implements GitWorkdirFactory { + @Inject public SimpleGitWorkdirFactory(WorkdirProvider workdirProvider) { super(workdirProvider); } From 57e748b4e4ef2bd45dc5239d9947422a0964ba50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Pfeuffer?= Date: Wed, 28 Aug 2019 06:43:18 +0200 Subject: [PATCH 04/12] Rename class to distinguish between 'modifications' and 'modify' --- ...Builder.java => ModifyCommandBuilder.java} | 22 +++++++++---------- ...icationCommand.java => ModifyCommand.java} | 2 +- ...est.java => ModifyCommandBuilderTest.java} | 10 ++++----- 3 files changed, 17 insertions(+), 17 deletions(-) rename scm-core/src/main/java/sonia/scm/repository/api/{ModificationCommandBuilder.java => ModifyCommandBuilder.java} (85%) rename scm-core/src/main/java/sonia/scm/repository/spi/{ModificationCommand.java => ModifyCommand.java} (86%) rename scm-core/src/test/java/sonia/scm/repository/api/{ModificationCommandBuilderTest.java => ModifyCommandBuilderTest.java} (95%) diff --git a/scm-core/src/main/java/sonia/scm/repository/api/ModificationCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java similarity index 85% rename from scm-core/src/main/java/sonia/scm/repository/api/ModificationCommandBuilder.java rename to scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java index 863fb1731b..9653aed934 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/ModificationCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java @@ -3,7 +3,7 @@ package sonia.scm.repository.api; import com.google.common.io.ByteSource; import com.google.common.io.ByteStreams; import com.google.common.io.Files; -import sonia.scm.repository.spi.ModificationCommand; +import sonia.scm.repository.spi.ModifyCommand; import sonia.scm.repository.util.WorkdirProvider; import java.io.File; @@ -14,19 +14,19 @@ import java.util.ArrayList; import java.util.List; import java.util.function.Consumer; -public class ModificationCommandBuilder { +public class ModifyCommandBuilder { - private final ModificationCommand command; + private final ModifyCommand command; private final File workdir; private final List modifications = new ArrayList<>(); - ModificationCommandBuilder(ModificationCommand command, WorkdirProvider workdirProvider) { + ModifyCommandBuilder(ModifyCommand command, WorkdirProvider workdirProvider) { this.command = command; this.workdir = workdirProvider.createNewWorkdir(); } - ModificationCommandBuilder setBranchToModify(String branchToModify) { + ModifyCommandBuilder setBranchToModify(String branchToModify) { return this; } @@ -42,12 +42,12 @@ public class ModificationCommandBuilder { ); } - ModificationCommandBuilder deleteFile(String path) { + ModifyCommandBuilder deleteFile(String path) { modifications.add(new DeleteFile(path)); return this; } - ModificationCommandBuilder moveFile(String sourcePath, String targetPath) { + ModifyCommandBuilder moveFile(String sourcePath, String targetPath) { modifications.add(new MoveFile(sourcePath, targetPath)); return this; } @@ -164,15 +164,15 @@ public class ModificationCommandBuilder { this.contentConsumer = contentConsumer; } - public ModificationCommandBuilder withData(ByteSource data) throws IOException { + public ModifyCommandBuilder withData(ByteSource data) throws IOException { Content content = loadData(data); contentConsumer.accept(content); - return ModificationCommandBuilder.this; + return ModifyCommandBuilder.this; } - public ModificationCommandBuilder withData(InputStream data) throws IOException { + public ModifyCommandBuilder withData(InputStream data) throws IOException { Content content = loadData(data); contentConsumer.accept(content); - return ModificationCommandBuilder.this; + return ModifyCommandBuilder.this; } } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/ModificationCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommand.java similarity index 86% rename from scm-core/src/main/java/sonia/scm/repository/spi/ModificationCommand.java rename to scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommand.java index c221acc1d6..8843965295 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/ModificationCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommand.java @@ -2,7 +2,7 @@ package sonia.scm.repository.spi; import java.io.File; -public interface ModificationCommand { +public interface ModifyCommand { String commit(); void delete(String toBeDeleted); diff --git a/scm-core/src/test/java/sonia/scm/repository/api/ModificationCommandBuilderTest.java b/scm-core/src/test/java/sonia/scm/repository/api/ModifyCommandBuilderTest.java similarity index 95% rename from scm-core/src/test/java/sonia/scm/repository/api/ModificationCommandBuilderTest.java rename to scm-core/src/test/java/sonia/scm/repository/api/ModifyCommandBuilderTest.java index f27b89964c..86e8dc4fc1 100644 --- a/scm-core/src/test/java/sonia/scm/repository/api/ModificationCommandBuilderTest.java +++ b/scm-core/src/test/java/sonia/scm/repository/api/ModifyCommandBuilderTest.java @@ -10,7 +10,7 @@ import org.mockito.Mock; import org.mockito.invocation.InvocationOnMock; import org.mockito.junit.jupiter.MockitoExtension; import org.mockito.stubbing.Answer; -import sonia.scm.repository.spi.ModificationCommand; +import sonia.scm.repository.spi.ModifyCommand; import sonia.scm.repository.util.WorkdirProvider; import java.io.ByteArrayInputStream; @@ -31,19 +31,19 @@ import static org.mockito.Mockito.when; @ExtendWith(MockitoExtension.class) @ExtendWith(TempDirectory.class) -class ModificationCommandBuilderTest { +class ModifyCommandBuilderTest { @Mock - ModificationCommand command; + ModifyCommand command; @Mock WorkdirProvider workdirProvider; - ModificationCommandBuilder commandBuilder; + ModifyCommandBuilder commandBuilder; @BeforeEach void initWorkdir(@TempDirectory.TempDir Path temp) throws IOException { lenient().when(workdirProvider.createNewWorkdir()).thenReturn(temp.toFile()); - commandBuilder = new ModificationCommandBuilder(command, workdirProvider); + commandBuilder = new ModifyCommandBuilder(command, workdirProvider); } @Test From c57ef73475bfe7005c85004b3d196f30d22d5844 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Pfeuffer?= Date: Wed, 28 Aug 2019 12:58:56 +0200 Subject: [PATCH 05/12] Introduce command request for modify command --- .../repository/api/ModifyCommandBuilder.java | 135 ++++-------------- .../scm/repository/spi/ModifyCommand.java | 13 +- .../repository/spi/ModifyCommandRequest.java | 133 +++++++++++++++++ .../api/ModifyCommandBuilderTest.java | 73 +++++++--- 4 files changed, 224 insertions(+), 130 deletions(-) create mode 100644 scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommandRequest.java diff --git a/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java index 9653aed934..dc3ed4a331 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java @@ -1,17 +1,18 @@ package sonia.scm.repository.api; +import com.google.common.base.Preconditions; import com.google.common.io.ByteSource; import com.google.common.io.ByteStreams; import com.google.common.io.Files; +import sonia.scm.repository.Person; import sonia.scm.repository.spi.ModifyCommand; +import sonia.scm.repository.spi.ModifyCommandRequest; import sonia.scm.repository.util.WorkdirProvider; import java.io.File; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; -import java.util.ArrayList; -import java.util.List; import java.util.function.Consumer; public class ModifyCommandBuilder { @@ -19,7 +20,7 @@ public class ModifyCommandBuilder { private final ModifyCommand command; private final File workdir; - private final List modifications = new ArrayList<>(); + private final ModifyCommandRequest request = new ModifyCommandRequest(); ModifyCommandBuilder(ModifyCommand command, WorkdirProvider workdirProvider) { this.command = command; @@ -32,163 +33,81 @@ public class ModifyCommandBuilder { ContentLoader createFile(String path) { return new ContentLoader( - content -> modifications.add(new CreateFile(path, content)) + content -> request.addRequest(new ModifyCommandRequest.CreateFileRequest(path, content)) ); } ContentLoader modifyFile(String path) { return new ContentLoader( - content -> modifications.add(new ModifyFile(path, content)) + content -> request.addRequest(new ModifyCommandRequest.ModifyFileRequest(path, content)) ); } ModifyCommandBuilder deleteFile(String path) { - modifications.add(new DeleteFile(path)); + request.addRequest(new ModifyCommandRequest.DeleteFileRequest(path)); return this; } ModifyCommandBuilder moveFile(String sourcePath, String targetPath) { - modifications.add(new MoveFile(sourcePath, targetPath)); + request.addRequest(new ModifyCommandRequest.MoveFileRequest(sourcePath, targetPath)); return this; } String execute() { - modifications.forEach(FileModification::execute); - modifications.forEach(FileModification::cleanup); - return command.commit(); + Preconditions.checkArgument(request.isValid(), "commit message, author and branch are required"); + return command.execute(request); } - private Content loadData(ByteSource data) throws IOException { + private File loadData(ByteSource data) throws IOException { File file = createTemporaryFile(); data.copyTo(Files.asByteSink(file)); - return new Content(file); + return file; } - private Content loadData(InputStream data) throws IOException { + private File loadData(InputStream data) throws IOException { File file = createTemporaryFile(); OutputStream out = Files.asByteSink(file).openBufferedStream(); ByteStreams.copy(data, out); out.close(); - return new Content(file); + return file; } private File createTemporaryFile() throws IOException { return File.createTempFile("upload-", "", workdir); } - private interface FileModification { - void execute(); - - default void cleanup() { - } + public ModifyCommandBuilder setCommitMessage(String message) { + request.setCommitMessage(message); + return this; } - private class DeleteFile implements FileModification { - private final String path; - - public DeleteFile(String path) { - this.path = path; - } - - @Override - public void execute() { - command.delete(path); - } + public ModifyCommandBuilder setAuthor(Person author) { + request.setAuthor(author); + return this; } - private class MoveFile implements FileModification { - private final String sourcePath; - private final String targetPath; - - private MoveFile(String sourcePath, String targetPath) { - this.sourcePath = sourcePath; - this.targetPath = targetPath; - } - - @Override - public void execute() { - command.move(sourcePath, targetPath); - } - } - - private abstract class DataBasedModification implements FileModification { - - private final Content content; - - DataBasedModification(Content content) { - this.content = content; - } - - public Content getContent() { - return content; - } - @Override - public void cleanup() { - content.deleteFile(); - } - } - - private class CreateFile extends DataBasedModification { - - private final String path; - - CreateFile(String path, Content content) { - super(content); - this.path = path; - } - @Override - public void execute() { - command.create(path, getContent().getFile()); - } - } - - private class ModifyFile extends DataBasedModification { - - private final String path; - - ModifyFile(String path, Content content) { - super(content); - this.path = path; - } - @Override - public void execute() { - command.modify(path, getContent().getFile()); - } + public ModifyCommandBuilder setBranch(String branch) { + request.setBranch(branch); + return this; } public class ContentLoader { - private final Consumer contentConsumer; + private final Consumer contentConsumer; - private ContentLoader(Consumer contentConsumer) { + private ContentLoader(Consumer contentConsumer) { this.contentConsumer = contentConsumer; } public ModifyCommandBuilder withData(ByteSource data) throws IOException { - Content content = loadData(data); + File content = loadData(data); contentConsumer.accept(content); return ModifyCommandBuilder.this; } public ModifyCommandBuilder withData(InputStream data) throws IOException { - Content content = loadData(data); + File content = loadData(data); contentConsumer.accept(content); return ModifyCommandBuilder.this; } } - - private class Content { - - private final File file; - - Content(File file) { - this.file = file; - } - - private File getFile() { - return file; - } - public void deleteFile() { - file.delete(); - } - } } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommand.java index 8843965295..07b29e8d21 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommand.java @@ -3,13 +3,16 @@ package sonia.scm.repository.spi; import java.io.File; public interface ModifyCommand { - String commit(); - void delete(String toBeDeleted); + String execute(ModifyCommandRequest request); - void create(String toBeCreated, File file); + interface Worker { + void delete(String toBeDeleted); - void modify(String path, File file); + void create(String toBeCreated, File file); - void move(String sourcePath, String targetPath); + void modify(String path, File file); + + void move(String sourcePath, String targetPath); + } } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommandRequest.java new file mode 100644 index 0000000000..057ec2d875 --- /dev/null +++ b/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommandRequest.java @@ -0,0 +1,133 @@ +package sonia.scm.repository.spi; + +import org.apache.commons.lang.StringUtils; +import sonia.scm.Validateable; +import sonia.scm.repository.Person; + +import java.io.File; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +public class ModifyCommandRequest implements Resetable, Validateable { + + private final List requests = new ArrayList<>(); + + private Person author; + private String commitMessage; + private String branch; + + @Override + public void reset() { + requests.clear(); + author = null; + commitMessage = null; + branch = null; + } + + public void addRequest(PartialRequest request) { + this.requests.add(request); + } + + public void setAuthor(Person author) { + this.author = author; + } + + public void setCommitMessage(String commitMessage) { + this.commitMessage = commitMessage; + } + + public void setBranch(String branch) { + this.branch = branch; + } + + public List getRequests() { + return Collections.unmodifiableList(requests); + } + + @Override + public boolean isValid() { + return StringUtils.isNotEmpty(commitMessage) && StringUtils.isNotEmpty(branch) && author != null && !requests.isEmpty(); + } + + public interface PartialRequest { + void execute(ModifyCommand.Worker worker); + } + + public static class DeleteFileRequest implements PartialRequest { + private final String path; + + public DeleteFileRequest(String path) { + this.path = path; + } + + @Override + public void execute(ModifyCommand.Worker worker) { + worker.delete(path); + } + } + + public static class MoveFileRequest implements PartialRequest { + private final String sourcePath; + private final String targetPath; + + public MoveFileRequest(String sourcePath, String targetPath) { + this.sourcePath = sourcePath; + this.targetPath = targetPath; + } + + @Override + public void execute(ModifyCommand.Worker worker) { + worker.move(sourcePath, targetPath); + } + } + + private abstract static class ContentModificationRequest implements PartialRequest { + + private final File content; + + ContentModificationRequest(File content) { + this.content = content; + } + + File getContent() { + return content; + } + + void cleanup() { + content.delete(); // TODO Handle errors + } + } + + public static class CreateFileRequest extends ContentModificationRequest { + + private final String path; + + public CreateFileRequest(String path, File content) { + super(content); + this.path = path; + } + + @Override + public void execute(ModifyCommand.Worker worker) { + worker.create(path, getContent()); + cleanup(); + } + } + + public static class ModifyFileRequest extends ContentModificationRequest { + + private final String path; + + public ModifyFileRequest(String path, File content) { + super(content); + this.path = path; + } + + @Override + public void execute(ModifyCommand.Worker worker) { + worker.modify(path, getContent()); + cleanup(); + } + } +} diff --git a/scm-core/src/test/java/sonia/scm/repository/api/ModifyCommandBuilderTest.java b/scm-core/src/test/java/sonia/scm/repository/api/ModifyCommandBuilderTest.java index 86e8dc4fc1..adbefe7d2a 100644 --- a/scm-core/src/test/java/sonia/scm/repository/api/ModifyCommandBuilderTest.java +++ b/scm-core/src/test/java/sonia/scm/repository/api/ModifyCommandBuilderTest.java @@ -6,11 +6,14 @@ import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.junitpioneer.jupiter.TempDirectory; import org.mockito.ArgumentCaptor; +import org.mockito.Captor; import org.mockito.Mock; import org.mockito.invocation.InvocationOnMock; import org.mockito.junit.jupiter.MockitoExtension; import org.mockito.stubbing.Answer; +import sonia.scm.repository.Person; import sonia.scm.repository.spi.ModifyCommand; +import sonia.scm.repository.spi.ModifyCommandRequest; import sonia.scm.repository.util.WorkdirProvider; import java.io.ByteArrayInputStream; @@ -37,6 +40,11 @@ class ModifyCommandBuilderTest { ModifyCommand command; @Mock WorkdirProvider workdirProvider; + @Mock + ModifyCommand.Worker worker; + + @Captor + ArgumentCaptor requestCaptor; ModifyCommandBuilder commandBuilder; @@ -46,43 +54,54 @@ class ModifyCommandBuilderTest { commandBuilder = new ModifyCommandBuilder(command, workdirProvider); } + @BeforeEach + void initRequestCaptor() { + when(command.execute(requestCaptor.capture())).thenReturn("target"); + } + @Test void shouldReturnTargetRevisionFromCommit() { - when(command.commit()).thenReturn("target"); - - String targetRevision = commandBuilder.execute(); + String targetRevision = initCommand() + .deleteFile("toBeDeleted") + .execute(); assertThat(targetRevision).isEqualTo("target"); } @Test void shouldExecuteDelete() { - commandBuilder + initCommand() .deleteFile("toBeDeleted") .execute(); - verify(command).delete("toBeDeleted"); + executeRequest(); + + verify(worker).delete("toBeDeleted"); } @Test void shouldExecuteMove() { - commandBuilder + initCommand() .moveFile("source", "target") .execute(); - verify(command).move("source", "target"); + executeRequest(); + + verify(worker).move("source", "target"); } @Test void shouldExecuteCreateWithByteSourceContent() throws IOException { ArgumentCaptor nameCaptor = ArgumentCaptor.forClass(String.class); List contentCaptor = new ArrayList<>(); - doAnswer(new ExtractContent(contentCaptor)).when(command).create(nameCaptor.capture(), any()); + doAnswer(new ExtractContent(contentCaptor)).when(worker).create(nameCaptor.capture(), any()); - commandBuilder + initCommand() .createFile("toBeCreated").withData(ByteSource.wrap("content".getBytes())) .execute(); + executeRequest(); + assertThat(nameCaptor.getValue()).isEqualTo("toBeCreated"); assertThat(contentCaptor).contains("content"); } @@ -91,12 +110,14 @@ class ModifyCommandBuilderTest { void shouldExecuteCreateWithInputStreamContent() throws IOException { ArgumentCaptor nameCaptor = ArgumentCaptor.forClass(String.class); List contentCaptor = new ArrayList<>(); - doAnswer(new ExtractContent(contentCaptor)).when(command).create(nameCaptor.capture(), any()); + doAnswer(new ExtractContent(contentCaptor)).when(worker).create(nameCaptor.capture(), any()); - commandBuilder + initCommand() .createFile("toBeCreated").withData(new ByteArrayInputStream("content".getBytes())) .execute(); + executeRequest(); + assertThat(nameCaptor.getValue()).isEqualTo("toBeCreated"); assertThat(contentCaptor).contains("content"); } @@ -105,13 +126,15 @@ class ModifyCommandBuilderTest { void shouldExecuteCreateMultipleTimes() throws IOException { ArgumentCaptor nameCaptor = ArgumentCaptor.forClass(String.class); List contentCaptor = new ArrayList<>(); - doAnswer(new ExtractContent(contentCaptor)).when(command).create(nameCaptor.capture(), any()); + doAnswer(new ExtractContent(contentCaptor)).when(worker).create(nameCaptor.capture(), any()); - commandBuilder + initCommand() .createFile("toBeCreated_1").withData(new ByteArrayInputStream("content_1".getBytes())) .createFile("toBeCreated_2").withData(new ByteArrayInputStream("content_2".getBytes())) .execute(); + executeRequest(); + List createdNames = nameCaptor.getAllValues(); assertThat(createdNames.get(0)).isEqualTo("toBeCreated_1"); assertThat(createdNames.get(1)).isEqualTo("toBeCreated_2"); @@ -122,26 +145,42 @@ class ModifyCommandBuilderTest { void shouldExecuteModify() throws IOException { ArgumentCaptor nameCaptor = ArgumentCaptor.forClass(String.class); List contentCaptor = new ArrayList<>(); - doAnswer(new ExtractContent(contentCaptor)).when(command).modify(nameCaptor.capture(), any()); + doAnswer(new ExtractContent(contentCaptor)).when(worker).modify(nameCaptor.capture(), any()); - commandBuilder + initCommand() .modifyFile("toBeModified").withData(ByteSource.wrap("content".getBytes())) .execute(); + executeRequest(); + assertThat(nameCaptor.getValue()).isEqualTo("toBeModified"); assertThat(contentCaptor).contains("content"); } + private void executeRequest() { + ModifyCommandRequest request = requestCaptor.getValue(); + request.getRequests().forEach(r -> r.execute(worker)); + } + + private ModifyCommandBuilder initCommand() { + return commandBuilder + .setBranch("branch") + .setCommitMessage("message") + .setAuthor(new Person()); + } + @Test void shouldDeleteTemporaryFiles(@TempDirectory.TempDir Path temp) throws IOException { ArgumentCaptor nameCaptor = ArgumentCaptor.forClass(String.class); ArgumentCaptor fileCaptor = ArgumentCaptor.forClass(File.class); - doNothing().when(command).modify(nameCaptor.capture(), fileCaptor.capture()); + doNothing().when(worker).modify(nameCaptor.capture(), fileCaptor.capture()); - commandBuilder + initCommand() .modifyFile("toBeModified").withData(ByteSource.wrap("content".getBytes())) .execute(); + executeRequest(); + assertThat(Files.list(temp)).isEmpty(); } From a8ce0f028d6a2fc55b05616f98c2f4c0ec1461ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Pfeuffer?= Date: Wed, 28 Aug 2019 13:03:51 +0200 Subject: [PATCH 06/12] Add missing getter in reuest --- .../scm/repository/spi/ModifyCommandRequest.java | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommandRequest.java index 057ec2d875..f3dcca18ff 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommandRequest.java @@ -45,6 +45,18 @@ public class ModifyCommandRequest implements Resetable, Validateable { return Collections.unmodifiableList(requests); } + public Person getAuthor() { + return author; + } + + public String getCommitMessage() { + return commitMessage; + } + + public String getBranch() { + return branch; + } + @Override public boolean isValid() { return StringUtils.isNotEmpty(commitMessage) && StringUtils.isNotEmpty(branch) && author != null && !requests.isEmpty(); From e0ecb3440bc9db4c2f3bf176efb5c2410af1a80d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Pfeuffer?= Date: Wed, 28 Aug 2019 13:19:59 +0200 Subject: [PATCH 07/12] Add modify command --- scm-core/src/main/java/sonia/scm/repository/api/Command.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scm-core/src/main/java/sonia/scm/repository/api/Command.java b/scm-core/src/main/java/sonia/scm/repository/api/Command.java index 3249e54ec3..8e95e314bb 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/Command.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/Command.java @@ -66,5 +66,5 @@ public enum Command /** * @since 2.0 */ - MODIFICATIONS, MERGE, DIFF_RESULT, BRANCH; + MODIFICATIONS, MERGE, DIFF_RESULT, BRANCH, MODIFY; } From baa4f6a91731ffb77d8b71522c4be4ee0d084dc2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Pfeuffer?= Date: Wed, 28 Aug 2019 13:53:24 +0200 Subject: [PATCH 08/12] Make modify command available --- .../repository/api/ModifyCommandBuilder.java | 160 +++++++++++++----- .../scm/repository/api/RepositoryService.java | 31 +++- .../api/RepositoryServiceFactory.java | 5 +- .../spi/RepositoryServiceProvider.java | 8 + .../repository/api/RepositoryServiceTest.java | 6 +- 5 files changed, 162 insertions(+), 48 deletions(-) diff --git a/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java index dc3ed4a331..501a2ac3b0 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java @@ -15,6 +15,29 @@ import java.io.InputStream; import java.io.OutputStream; import java.util.function.Consumer; +/** + * Use this {@link ModifyCommandBuilder} to make file changes to the head of a branch. You can + *
    + *
  • create new files ({@link #createFile(String)}
    • + *
  • modify existing files ({@link #modifyFile(String)}
    • + *
  • delete existing files ({@link #deleteFile(String)}
    • + *
  • move/rename existing files ({@link #moveFile(String, String)}
    • + *
+ * + * You can collect multiple changes before they are executed with a call to {@link #execute()}. + * + *

Example: + * 

+ * commandBuilder
+ *     .setBranch("feature/branch")
+ *     .setCommitMessage("make some changes")
+ *     .setAuthor(new Person())
+ *     .createFile("file/to/create").withData(inputStream)
+ *     .deleteFile("old/file/to/delete")
+ *     .execute();
+ *
+ *

+ */ public class ModifyCommandBuilder { private final ModifyCommand command; @@ -27,37 +50,127 @@ public class ModifyCommandBuilder { this.workdir = workdirProvider.createNewWorkdir(); } - ModifyCommandBuilder setBranchToModify(String branchToModify) { + /** + * Set the branch that should be modified. The new commit will be made for this branch. + * @param branchToModify The branch to modify. + * @return This builder instance. + */ + public ModifyCommandBuilder setBranchToModify(String branchToModify) { return this; } - ContentLoader createFile(String path) { + /** + * Create a new file. The content of the file will be specified in a subsequent call to + * {@link ContentLoader#withData(ByteSource)} or {@link ContentLoader#withData(InputStream)}. + * @param path The path and the name of the file that should be created. + * @return The loader to specify the content of the new file. + */ + public ContentLoader createFile(String path) { return new ContentLoader( content -> request.addRequest(new ModifyCommandRequest.CreateFileRequest(path, content)) ); } - ContentLoader modifyFile(String path) { + /** + * Modify an existing file. The new content of the file will be specified in a subsequent call to + * {@link ContentLoader#withData(ByteSource)} or {@link ContentLoader#withData(InputStream)}. + * @param path The path and the name of the file that should be modified. + * @return The loader to specify the new content of the file. + */ + public ContentLoader modifyFile(String path) { return new ContentLoader( content -> request.addRequest(new ModifyCommandRequest.ModifyFileRequest(path, content)) ); } - ModifyCommandBuilder deleteFile(String path) { + /** + * Delete an existing file. + * @param path The path and the name of the file that should be deleted. + * @return This builder instance. + */ + public ModifyCommandBuilder deleteFile(String path) { request.addRequest(new ModifyCommandRequest.DeleteFileRequest(path)); return this; } - ModifyCommandBuilder moveFile(String sourcePath, String targetPath) { + /** + * Move an existing file. + * @param sourcePath The path and the name of the file that should be moved. + * @param targetPath The new path and name the file should be moved to. + * @return This builder instance. + */ + public ModifyCommandBuilder moveFile(String sourcePath, String targetPath) { request.addRequest(new ModifyCommandRequest.MoveFileRequest(sourcePath, targetPath)); return this; } - String execute() { + /** + * Apply the changes and create a new commit with the given message and author. + * @return The revision of the new commit. + */ + public String execute() { Preconditions.checkArgument(request.isValid(), "commit message, author and branch are required"); return command.execute(request); } + /** + * Set the commit message for the new commit. + * @return This builder instance. + */ + public ModifyCommandBuilder setCommitMessage(String message) { + request.setCommitMessage(message); + return this; + } + + /** + * Set the author for the new commit. + * @return This builder instance. + */ + public ModifyCommandBuilder setAuthor(Person author) { + request.setAuthor(author); + return this; + } + + /** + * Set the branch the changes should be made upon. + * @return This builder instance. + */ + public ModifyCommandBuilder setBranch(String branch) { + request.setBranch(branch); + return this; + } + + public class ContentLoader { + + private final Consumer contentConsumer; + + private ContentLoader(Consumer contentConsumer) { + this.contentConsumer = contentConsumer; + } + + /** + * Specify the data of the file using a {@link ByteSource}. + * @return The builder instance. + * @throws IOException If the data could not be read. + */ + public ModifyCommandBuilder withData(ByteSource data) throws IOException { + File content = loadData(data); + contentConsumer.accept(content); + return ModifyCommandBuilder.this; + } + + /** + * Specify the data of the file using an {@link InputStream}. + * @return The builder instance. + * @throws IOException If the data could not be read. + */ + public ModifyCommandBuilder withData(InputStream data) throws IOException { + File content = loadData(data); + contentConsumer.accept(content); + return ModifyCommandBuilder.this; + } + } + private File loadData(ByteSource data) throws IOException { File file = createTemporaryFile(); data.copyTo(Files.asByteSink(file)); @@ -75,39 +188,4 @@ public class ModifyCommandBuilder { private File createTemporaryFile() throws IOException { return File.createTempFile("upload-", "", workdir); } - - public ModifyCommandBuilder setCommitMessage(String message) { - request.setCommitMessage(message); - return this; - } - - public ModifyCommandBuilder setAuthor(Person author) { - request.setAuthor(author); - return this; - } - - public ModifyCommandBuilder setBranch(String branch) { - request.setBranch(branch); - return this; - } - - public class ContentLoader { - - private final Consumer contentConsumer; - - private ContentLoader(Consumer contentConsumer) { - this.contentConsumer = contentConsumer; - } - - public ModifyCommandBuilder withData(ByteSource data) throws IOException { - File content = loadData(data); - contentConsumer.accept(content); - return ModifyCommandBuilder.this; - } - public ModifyCommandBuilder withData(InputStream data) throws IOException { - File content = loadData(data); - contentConsumer.accept(content); - return ModifyCommandBuilder.this; - } - } } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/RepositoryService.java b/scm-core/src/main/java/sonia/scm/repository/api/RepositoryService.java index 5807ffa998..080d66ebf2 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/RepositoryService.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/RepositoryService.java @@ -40,6 +40,7 @@ import sonia.scm.repository.PreProcessorUtil; import sonia.scm.repository.Repository; import sonia.scm.repository.RepositoryPermissions; import sonia.scm.repository.spi.RepositoryServiceProvider; +import sonia.scm.repository.util.WorkdirProvider; import java.io.Closeable; import java.io.IOException; @@ -91,22 +92,25 @@ public final class RepositoryService implements Closeable { private final RepositoryServiceProvider provider; private final Repository repository; private final Set protocolProviders; + private final WorkdirProvider workdirProvider; /** * Constructs a new {@link RepositoryService}. This constructor should only * be called from the {@link RepositoryServiceFactory}. - * @param cacheManager cache manager + * @param cacheManager cache manager * @param provider implementation for {@link RepositoryServiceProvider} * @param repository the repository + * @param workdirProvider */ RepositoryService(CacheManager cacheManager, - RepositoryServiceProvider provider, Repository repository, - PreProcessorUtil preProcessorUtil, Set protocolProviders) { + RepositoryServiceProvider provider, Repository repository, + PreProcessorUtil preProcessorUtil, Set protocolProviders, WorkdirProvider workdirProvider) { this.cacheManager = cacheManager; this.provider = provider; this.repository = repository; this.preProcessorUtil = preProcessorUtil; this.protocolProviders = protocolProviders; + this.workdirProvider = workdirProvider; } /** @@ -399,6 +403,27 @@ public final class RepositoryService implements Closeable { return new MergeCommandBuilder(provider.getMergeCommand()); } + /** + * The modify command makes changes to the head of a branch. It is possible to + *
    + *
  • create new files
    • + *
  • delete existing files
    • + *
  • modify/replace files
    • + *
  • move files
    • + *
+ * + * @return instance of {@link ModifyCommandBuilder} + * @throws CommandNotSupportedException if the command is not supported + * by the implementation of the repository service provider. + * @since 2.0.0 + */ + public ModifyCommandBuilder getModifyCommand() { + LOG.debug("create modify command for repository {}", + repository.getNamespaceAndName()); + + return new ModifyCommandBuilder(provider.getModifyCommand(), workdirProvider); + } + /** * Returns true if the command is supported by the repository service. * diff --git a/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java b/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java index 8db3ab7546..fe2af9f9e1 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java @@ -61,6 +61,7 @@ import sonia.scm.repository.RepositoryManager; import sonia.scm.repository.RepositoryPermissions; import sonia.scm.repository.spi.RepositoryServiceProvider; import sonia.scm.repository.spi.RepositoryServiceResolver; +import sonia.scm.repository.util.WorkdirProvider; import sonia.scm.security.ScmSecurityException; import java.util.Set; @@ -256,7 +257,7 @@ public final class RepositoryServiceFactory } service = new RepositoryService(cacheManager, provider, repository, - preProcessorUtil, protocolProviders); + preProcessorUtil, protocolProviders, workdirProvider); break; } @@ -373,4 +374,6 @@ public final class RepositoryServiceFactory private final Set resolvers; private Set protocolProviders; + + private WorkdirProvider workdirProvider; } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceProvider.java b/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceProvider.java index bf9cdf6a25..cdd0417cf7 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceProvider.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceProvider.java @@ -275,4 +275,12 @@ public abstract class RepositoryServiceProvider implements Closeable { throw new CommandNotSupportedException(Command.MERGE); } + + /** + * @since 2.0 + */ + public ModifyCommand getModifyCommand() + { + throw new CommandNotSupportedException(Command.MODIFY); + } } diff --git a/scm-core/src/test/java/sonia/scm/repository/api/RepositoryServiceTest.java b/scm-core/src/test/java/sonia/scm/repository/api/RepositoryServiceTest.java index 2ceafc19bb..330a4c956a 100644 --- a/scm-core/src/test/java/sonia/scm/repository/api/RepositoryServiceTest.java +++ b/scm-core/src/test/java/sonia/scm/repository/api/RepositoryServiceTest.java @@ -24,7 +24,7 @@ public class RepositoryServiceTest { @Test public void shouldReturnMatchingProtocolsFromProvider() { - RepositoryService repositoryService = new RepositoryService(null, provider, repository, null, Collections.singleton(new DummyScmProtocolProvider())); + RepositoryService repositoryService = new RepositoryService(null, provider, repository, null, Collections.singleton(new DummyScmProtocolProvider()), null); Stream supportedProtocols = repositoryService.getSupportedProtocols(); assertThat(sizeOf(supportedProtocols.collect(Collectors.toList()))).isEqualTo(1); @@ -32,7 +32,7 @@ public class RepositoryServiceTest { @Test public void shouldFindKnownProtocol() { - RepositoryService repositoryService = new RepositoryService(null, provider, repository, null, Collections.singleton(new DummyScmProtocolProvider())); + RepositoryService repositoryService = new RepositoryService(null, provider, repository, null, Collections.singleton(new DummyScmProtocolProvider()), null); HttpScmProtocol protocol = repositoryService.getProtocol(HttpScmProtocol.class); @@ -41,7 +41,7 @@ public class RepositoryServiceTest { @Test public void shouldFailForUnknownProtocol() { - RepositoryService repositoryService = new RepositoryService(null, provider, repository, null, Collections.singleton(new DummyScmProtocolProvider())); + RepositoryService repositoryService = new RepositoryService(null, provider, repository, null, Collections.singleton(new DummyScmProtocolProvider()), null); assertThrows(IllegalArgumentException.class, () -> { repositoryService.getProtocol(UnknownScmProtocol.class); From b0267d69097f3964cfa466b45bc1568a091fb0c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Pfeuffer?= Date: Wed, 28 Aug 2019 15:10:38 +0200 Subject: [PATCH 09/12] Handle error on delete --- .../scm/repository/spi/ModifyCommandRequest.java | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommandRequest.java index f3dcca18ff..e8f2223bdd 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/ModifyCommandRequest.java @@ -1,16 +1,22 @@ package sonia.scm.repository.spi; import org.apache.commons.lang.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import sonia.scm.Validateable; import sonia.scm.repository.Person; +import sonia.scm.util.IOUtil; import java.io.File; +import java.io.IOException; import java.util.ArrayList; import java.util.Collections; import java.util.List; public class ModifyCommandRequest implements Resetable, Validateable { + private static final Logger LOG = LoggerFactory.getLogger(ModifyCommandRequest.class); + private final List requests = new ArrayList<>(); private Person author; @@ -107,7 +113,11 @@ public class ModifyCommandRequest implements Resetable, Validateable { } void cleanup() { - content.delete(); // TODO Handle errors + try { + IOUtil.delete(content); + } catch (IOException e) { + LOG.warn("could not delete temporary file {}", content, e); + } } } From bb0682fab59dd1163fcf7a43f774b68833137ef5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Pfeuffer?= Date: Wed, 28 Aug 2019 17:04:22 +0200 Subject: [PATCH 10/12] Delete temporary workdir after command was executed --- .../repository/api/ModifyCommandBuilder.java | 17 +++++++-- .../api/ModifyCommandBuilderTest.java | 35 ++++++------------- 2 files changed, 25 insertions(+), 27 deletions(-) diff --git a/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java index 501a2ac3b0..9cfcaebd6a 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java @@ -4,10 +4,13 @@ import com.google.common.base.Preconditions; import com.google.common.io.ByteSource; import com.google.common.io.ByteStreams; import com.google.common.io.Files; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import sonia.scm.repository.Person; import sonia.scm.repository.spi.ModifyCommand; import sonia.scm.repository.spi.ModifyCommandRequest; import sonia.scm.repository.util.WorkdirProvider; +import sonia.scm.util.IOUtil; import java.io.File; import java.io.IOException; @@ -40,6 +43,8 @@ import java.util.function.Consumer; */ public class ModifyCommandBuilder { + private static final Logger LOG = LoggerFactory.getLogger(ModifyCommandBuilder.class); + private final ModifyCommand command; private final File workdir; @@ -109,8 +114,16 @@ public class ModifyCommandBuilder { * @return The revision of the new commit. */ public String execute() { - Preconditions.checkArgument(request.isValid(), "commit message, author and branch are required"); - return command.execute(request); + try { + Preconditions.checkArgument(request.isValid(), "commit message, author and branch are required"); + return command.execute(request); + } finally { + try { + IOUtil.delete(workdir); + } catch (IOException e) { + LOG.warn("could not delete temporary workdir '{}'", workdir, e); + } + } } /** diff --git a/scm-core/src/test/java/sonia/scm/repository/api/ModifyCommandBuilderTest.java b/scm-core/src/test/java/sonia/scm/repository/api/ModifyCommandBuilderTest.java index adbefe7d2a..7d4d96642a 100644 --- a/scm-core/src/test/java/sonia/scm/repository/api/ModifyCommandBuilderTest.java +++ b/scm-core/src/test/java/sonia/scm/repository/api/ModifyCommandBuilderTest.java @@ -6,7 +6,6 @@ import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.junitpioneer.jupiter.TempDirectory; import org.mockito.ArgumentCaptor; -import org.mockito.Captor; import org.mockito.Mock; import org.mockito.invocation.InvocationOnMock; import org.mockito.junit.jupiter.MockitoExtension; @@ -43,20 +42,25 @@ class ModifyCommandBuilderTest { @Mock ModifyCommand.Worker worker; - @Captor - ArgumentCaptor requestCaptor; - ModifyCommandBuilder commandBuilder; + Path workdir; @BeforeEach void initWorkdir(@TempDirectory.TempDir Path temp) throws IOException { - lenient().when(workdirProvider.createNewWorkdir()).thenReturn(temp.toFile()); + workdir = Files.createDirectory(temp.resolve("workdir")); + lenient().when(workdirProvider.createNewWorkdir()).thenReturn(workdir.toFile()); commandBuilder = new ModifyCommandBuilder(command, workdirProvider); } @BeforeEach void initRequestCaptor() { - when(command.execute(requestCaptor.capture())).thenReturn("target"); + when(command.execute(any())).thenAnswer( + invocation -> { + ModifyCommandRequest request = invocation.getArgument(0); + request.getRequests().forEach(r -> r.execute(worker)); + return "target"; + } + ); } @Test @@ -74,8 +78,6 @@ class ModifyCommandBuilderTest { .deleteFile("toBeDeleted") .execute(); - executeRequest(); - verify(worker).delete("toBeDeleted"); } @@ -85,8 +87,6 @@ class ModifyCommandBuilderTest { .moveFile("source", "target") .execute(); - executeRequest(); - verify(worker).move("source", "target"); } @@ -100,8 +100,6 @@ class ModifyCommandBuilderTest { .createFile("toBeCreated").withData(ByteSource.wrap("content".getBytes())) .execute(); - executeRequest(); - assertThat(nameCaptor.getValue()).isEqualTo("toBeCreated"); assertThat(contentCaptor).contains("content"); } @@ -116,8 +114,6 @@ class ModifyCommandBuilderTest { .createFile("toBeCreated").withData(new ByteArrayInputStream("content".getBytes())) .execute(); - executeRequest(); - assertThat(nameCaptor.getValue()).isEqualTo("toBeCreated"); assertThat(contentCaptor).contains("content"); } @@ -133,8 +129,6 @@ class ModifyCommandBuilderTest { .createFile("toBeCreated_2").withData(new ByteArrayInputStream("content_2".getBytes())) .execute(); - executeRequest(); - List createdNames = nameCaptor.getAllValues(); assertThat(createdNames.get(0)).isEqualTo("toBeCreated_1"); assertThat(createdNames.get(1)).isEqualTo("toBeCreated_2"); @@ -151,17 +145,10 @@ class ModifyCommandBuilderTest { .modifyFile("toBeModified").withData(ByteSource.wrap("content".getBytes())) .execute(); - executeRequest(); - assertThat(nameCaptor.getValue()).isEqualTo("toBeModified"); assertThat(contentCaptor).contains("content"); } - private void executeRequest() { - ModifyCommandRequest request = requestCaptor.getValue(); - request.getRequests().forEach(r -> r.execute(worker)); - } - private ModifyCommandBuilder initCommand() { return commandBuilder .setBranch("branch") @@ -179,8 +166,6 @@ class ModifyCommandBuilderTest { .modifyFile("toBeModified").withData(ByteSource.wrap("content".getBytes())) .execute(); - executeRequest(); - assertThat(Files.list(temp)).isEmpty(); } From 2674dbaf52580076ee9ec7e418d7961778d675bb Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Thu, 29 Aug 2019 15:32:36 +0200 Subject: [PATCH 11/12] suppress UnstableApiUsage and use try with resources --- .../sonia/scm/repository/api/ModifyCommandBuilder.java | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java index 9cfcaebd6a..28adca18ae 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java @@ -184,17 +184,19 @@ public class ModifyCommandBuilder { } } + @SuppressWarnings("UnstableApiUsage") // Files only used internal private File loadData(ByteSource data) throws IOException { File file = createTemporaryFile(); data.copyTo(Files.asByteSink(file)); return file; } + @SuppressWarnings("UnstableApiUsage") // Files and ByteStreams only used internal private File loadData(InputStream data) throws IOException { File file = createTemporaryFile(); - OutputStream out = Files.asByteSink(file).openBufferedStream(); - ByteStreams.copy(data, out); - out.close(); + try (OutputStream out = Files.asByteSink(file).openBufferedStream()) { + ByteStreams.copy(data, out); + } return file; } From f85460ae62cd200cc6dcf3cbbb7768cd1a744c19 Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Thu, 29 Aug 2019 13:34:48 +0000 Subject: [PATCH 12/12] Close branch feature/modification_api