LAB-linuxserver/davos
1
0
Fork 0
mirror of https://github.com/linuxserver/davos.git synced 2026-04-20 00:01:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

Implemented TransferStrategies

Browse Source
This commit is contained in:
Josh Stark 2015-10-18 12:15:39 +01:00
parent 38b6ef1353
commit bfbc29ddc6
13 changed files with 315 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/main/java/io/linuxserver/davos/schedule/workflow/DisconnectWorkflowStep.java
View File

@ -1,8 +1,22 @@
package io.linuxserver.davos.schedule.workflow;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import io.linuxserver.davos.transfer.ftp.exception.FTPException;
public class DisconnectWorkflowStep extends WorkflowStep {
private static final Logger LOGGER = LoggerFactory.getLogger(DisconnectWorkflowStep.class);
@Override
public void runStep(ScheduleWorkflow schedule) {
try {
schedule.getClient().disconnect();
} catch (FTPException e) {
LOGGER.error("Unable to disconnect from host. Error was: {}", e.getMessage());
LOGGER.debug("Stacktrace", e);
}
}
}

2
src/main/java/io/linuxserver/davos/schedule/workflow/DownloadFilesWorkflowStep.java
View File

@ -30,6 +30,8 @@ public class DownloadFilesWorkflowStep extends WorkflowStep {
TransferStrategy strategyToUse = transferStrategyFactory.getStrategy(config.getTransferType(), schedule.getConnection());
LOGGER.debug("Strategy chosen for downloads is {}, selected {}", config.getTransferType(), strategyToUse);
strategyToUse.setPostDownloadActions(schedule.getConfig().getActions());
LOGGER.debug("PostDownloadActions {} have been set against chosen strategy", schedule.getConfig().getActions());
try {

2
src/main/java/io/linuxserver/davos/schedule/workflow/FilterFilesWorkflowStep.java
View File

@ -38,7 +38,7 @@ public class FilterFilesWorkflowStep extends WorkflowStep {
if (filters.isEmpty()) {
LOGGER.debug("Filter list was empty. Adding all found files to list");
LOGGER.info("Filter list was empty. Adding all found files to list");
((DownloadFilesWorkflowStep) nextStep).setFilesToDownload(filesToFilter);
} else {

5
src/main/java/io/linuxserver/davos/schedule/workflow/actions/MoveFileAction.java
View File

@ -36,4 +36,9 @@ public class MoveFileAction implements PostDownloadAction {
LOGGER.debug("Full stack trace on error", e);
}
}
@Override
public String toString() {
return getClass().getSimpleName();
}
}

5
src/main/java/io/linuxserver/davos/schedule/workflow/actions/PushbulletNotifyAction.java
View File

@ -45,6 +45,11 @@ public class PushbulletNotifyAction implements PostDownloadAction {
LOGGER.error("Unable to complete notification to Pushbullet. Given error: {}", e.getMessage());
}
}
@Override
public String toString() {
return getClass().getSimpleName();
}
@JsonIgnoreProperties(ignoreUnknown = true)
class PushbulletResponse {

18
src/main/java/io/linuxserver/davos/schedule/workflow/transfer/FilesAndFoldersTranferStrategy.java
View File

@ -1,16 +1,32 @@
package io.linuxserver.davos.schedule.workflow.transfer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import io.linuxserver.davos.transfer.ftp.FTPFile;
import io.linuxserver.davos.transfer.ftp.connection.Connection;
import io.linuxserver.davos.util.FileUtils;
public class FilesAndFoldersTranferStrategy extends TransferStrategy {
private static final Logger LOGGER = LoggerFactory.getLogger(FilesAndFoldersTranferStrategy.class);
public FilesAndFoldersTranferStrategy(Connection connection) {
super(connection);
}
@Override
public void transferFile(FTPFile fileToTransfer, String destination) {
// TODO Auto-generated method stub
String filename = fileToTransfer.getName();
String cleanFilePath = FileUtils.ensureTrailingSlash(fileToTransfer.getAbsolutePath());
String cleanDestination = FileUtils.ensureTrailingSlash(destination);
LOGGER.info("Downloading {} to {}", cleanFilePath + filename, cleanDestination);
connection.download(cleanFilePath + filename, cleanDestination);
LOGGER.info("Successfully downloaded file.");
LOGGER.info("Running post download actions on {}", filename);
runPostDownloadAction(fileToTransfer);
}
}

21
src/main/java/io/linuxserver/davos/schedule/workflow/transfer/FilesOnlyTransferStrategy.java
View File

@ -1,16 +1,35 @@
package io.linuxserver.davos.schedule.workflow.transfer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import io.linuxserver.davos.transfer.ftp.FTPFile;
import io.linuxserver.davos.transfer.ftp.connection.Connection;
import io.linuxserver.davos.util.FileUtils;
public class FilesOnlyTransferStrategy extends TransferStrategy {
private static final Logger LOGGER = LoggerFactory.getLogger(FilesOnlyTransferStrategy.class);
public FilesOnlyTransferStrategy(Connection connection) {
super(connection);
}
@Override
public void transferFile(FTPFile fileToTransfer, String destination) {
// TODO Auto-generated method stub
String filename = fileToTransfer.getName();
String cleanFilePath = FileUtils.ensureTrailingSlash(fileToTransfer.getAbsolutePath());
String cleanDestination = FileUtils.ensureTrailingSlash(destination);
if (!fileToTransfer.isDirectory()) {
LOGGER.info("Downloading {} to {}", cleanFilePath + filename, cleanDestination);
connection.download(cleanFilePath + filename, cleanDestination);
LOGGER.info("Successfully downloaded file.");
LOGGER.info("Running post download actions on {}", filename);
runPostDownloadAction(fileToTransfer);
}
}
}

36
src/main/java/io/linuxserver/davos/schedule/workflow/transfer/TransferStrategy.java
View File

@ -1,20 +1,52 @@
package io.linuxserver.davos.schedule.workflow.transfer;
import java.util.ArrayList;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import io.linuxserver.davos.schedule.workflow.actions.PostDownloadAction;
import io.linuxserver.davos.schedule.workflow.actions.PostDownloadExecution;
import io.linuxserver.davos.transfer.ftp.FTPFile;
import io.linuxserver.davos.transfer.ftp.connection.Connection;
public abstract class TransferStrategy {
private static final Logger LOGGER = LoggerFactory.getLogger(TransferStrategy.class);
protected Connection connection;
private List<PostDownloadAction> postDownloadActions = new ArrayList<PostDownloadAction>();
public TransferStrategy(Connection connection) {
this.connection = connection;
}
public abstract void transferFile(FTPFile fileToTransfer, String destination);
public void setPostDownloadActions(List<PostDownloadAction> postDownloadActions) {
this.postDownloadActions = postDownloadActions;
}
@Override
public String toString() {
return getClass().getSimpleName();
}
public abstract void transferFile(FTPFile fileToTransfer, String destination);
protected void runPostDownloadAction(FTPFile file) {
if (null == postDownloadActions) {
LOGGER.warn("Post download actions have been nulled! This should not happen. Will not attempt run of actions");
return;
}
for (PostDownloadAction action : postDownloadActions) {
PostDownloadExecution execution = new PostDownloadExecution();
execution.fileName = file.getName();
action.execute(execution);
}
}
}

63
src/test/java/io/linuxserver/davos/schedule/workflow/DisconnectWorkflowStepTest.java Normal file
View File

@ -0,0 +1,63 @@
package io.linuxserver.davos.schedule.workflow;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.verify;
import static org.mockito.MockitoAnnotations.initMocks;
import org.junit.Before;
import org.junit.Test;
import org.mockito.Mock;
import io.linuxserver.davos.schedule.ScheduleConfiguration;
import io.linuxserver.davos.transfer.ftp.FileTransferType;
import io.linuxserver.davos.transfer.ftp.TransferProtocol;
import io.linuxserver.davos.transfer.ftp.client.Client;
import io.linuxserver.davos.transfer.ftp.client.UserCredentials;
import io.linuxserver.davos.transfer.ftp.connection.Connection;
import io.linuxserver.davos.transfer.ftp.exception.ClientDisconnectException;
public class DisconnectWorkflowStepTest {
private DisconnectWorkflowStep workflowStep = new DisconnectWorkflowStep();
@Mock
private Client mockClient;
@Mock
private Connection mockConnection;
@Before
public void setUp() {
initMocks(this);
}
@Test
public void runStepShouldCloseTheConnection() {
ScheduleConfiguration config = new ScheduleConfiguration("", TransferProtocol.SFTP, "", 0, new UserCredentials("", ""),
"", "", FileTransferType.FILES_ONLY);
ScheduleWorkflow schedule = new ScheduleWorkflow(config);
schedule.setConnection(mockConnection);
schedule.setClient(mockClient);
workflowStep.runStep(schedule);
verify(mockClient).disconnect();
}
@Test
public void ifDisconnectingFailsThenDoNothing() {
ScheduleConfiguration config = new ScheduleConfiguration("", TransferProtocol.SFTP, "", 0, new UserCredentials("", ""),
"", "", FileTransferType.FILES_ONLY);
ScheduleWorkflow schedule = new ScheduleWorkflow(config);
schedule.setConnection(mockConnection);
schedule.setClient(mockClient);
doThrow(new ClientDisconnectException()).when(mockClient).disconnect();
workflowStep.runStep(schedule);
}
}

8
src/test/java/io/linuxserver/davos/schedule/workflow/DownloadFilesWorkflowStepTest.java
View File

@ -18,6 +18,8 @@ import org.mockito.Mock;
import org.mockito.Mockito;
import io.linuxserver.davos.schedule.ScheduleConfiguration;
import io.linuxserver.davos.schedule.workflow.actions.MoveFileAction;
import io.linuxserver.davos.schedule.workflow.actions.PostDownloadAction;
import io.linuxserver.davos.schedule.workflow.transfer.TransferStrategy;
import io.linuxserver.davos.schedule.workflow.transfer.TransferStrategyFactory;
import io.linuxserver.davos.transfer.ftp.FTPFile;
@ -72,6 +74,11 @@ public class DownloadFilesWorkflowStepTest {
ScheduleConfiguration config = new ScheduleConfiguration("", TransferProtocol.SFTP, "", 0, new UserCredentials("", ""),
"", "local/", FileTransferType.FILES_ONLY);
ArrayList<PostDownloadAction> actions = new ArrayList<PostDownloadAction>();
actions.add(new MoveFileAction("", ""));
config.setActions(actions);
ScheduleWorkflow schedule = new ScheduleWorkflow(config);
schedule.setConnection(mockConnection);
@ -79,6 +86,7 @@ public class DownloadFilesWorkflowStepTest {
verify(mockTransferStrategyFactory).getStrategy(FileTransferType.FILES_ONLY, mockConnection);
verify(mockTransferStrategy).setPostDownloadActions(actions);
verify(mockTransferStrategy).transferFile(file, "local/");
verify(mockTransferStrategy).transferFile(file2, "local/");
}

47
src/test/java/io/linuxserver/davos/schedule/workflow/transfer/FilesAndFoldersTranferStrategyTest.java Normal file
View File

@ -0,0 +1,47 @@
package io.linuxserver.davos.schedule.workflow.transfer;
import static org.mockito.Mockito.verify;
import static org.mockito.MockitoAnnotations.initMocks;
import org.junit.Before;
import org.junit.Test;
import org.mockito.Mock;
import io.linuxserver.davos.transfer.ftp.FTPFile;
import io.linuxserver.davos.transfer.ftp.connection.Connection;
public class FilesAndFoldersTranferStrategyTest {
private FilesAndFoldersTranferStrategy strategy;
@Mock
private Connection mockConnection;
@Before
public void setUp() {
initMocks(this);
strategy = new FilesAndFoldersTranferStrategy(mockConnection);
}
@Test
public void strategyShouldCallDownloadMethodForFiles() {
FTPFile file = new FTPFile("file1", 0, "remotePath/", 0, false);
strategy.transferFile(file, "destination");
verify(mockConnection).download("remotePath/file1", "destination/");
}
@Test
public void strategyShouldCallDownloadMethodForDirectories() {
FTPFile file = new FTPFile("file1", 0, "remotePath/", 0, true);
strategy.transferFile(file, "destination");
verify(mockConnection).download("remotePath/file1", "destination/");
}
}

49
src/test/java/io/linuxserver/davos/schedule/workflow/transfer/FilesOnlyTransferStrategyTest.java Normal file
View File

@ -0,0 +1,49 @@
package io.linuxserver.davos.schedule.workflow.transfer;
import static org.mockito.Matchers.anyString;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.MockitoAnnotations.initMocks;
import org.junit.Before;
import org.junit.Test;
import org.mockito.Mock;
import io.linuxserver.davos.transfer.ftp.FTPFile;
import io.linuxserver.davos.transfer.ftp.connection.Connection;
public class FilesOnlyTransferStrategyTest {
private FilesOnlyTransferStrategy strategy;
@Mock
private Connection mockConnection;
@Before
public void setUp() {
initMocks(this);
strategy = new FilesOnlyTransferStrategy(mockConnection);
}
@Test
public void strategyShouldCallDownloadMethodForFiles() {
FTPFile file = new FTPFile("file1", 0, "remotePath/", 0, false);
strategy.transferFile(file, "destination");
verify(mockConnection).download("remotePath/file1", "destination/");
}
@Test
public void strategyShouldNotCallDownloadMethodForDirectories() {
FTPFile file = new FTPFile("file1", 0, "remotePath/", 0, true);
strategy.transferFile(file, "destination");
verify(mockConnection, never()).download(anyString(), anyString());
}
}

53
src/test/java/io/linuxserver/davos/schedule/workflow/transfer/TransferStrategyTest.java
View File

@ -1,9 +1,16 @@
package io.linuxserver.davos.schedule.workflow.transfer;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import java.util.Arrays;
import org.junit.Test;
import org.mockito.ArgumentCaptor;
import io.linuxserver.davos.schedule.workflow.actions.PostDownloadAction;
import io.linuxserver.davos.schedule.workflow.actions.PostDownloadExecution;
import io.linuxserver.davos.transfer.ftp.FTPFile;
import io.linuxserver.davos.transfer.ftp.connection.Connection;
@ -14,8 +21,36 @@ public class TransferStrategyTest {
assertThat(new TestTransferStrategy(null).toString()).isEqualTo("TestTransferStrategy");
assertThat(new AnotherTestTransferStrategy(null).toString()).isEqualTo("AnotherTestTransferStrategy");
}
@Test
public void runPostDownloadActionShouldCallAllGivenActionsWithTheFile() {
ArgumentCaptor<PostDownloadExecution> captor = ArgumentCaptor.forClass(PostDownloadExecution.class);
DownloadActionImplTestTransferStrategy strategy = new DownloadActionImplTestTransferStrategy(null);
PostDownloadAction mockAction1 = mock(PostDownloadAction.class);
PostDownloadAction mockAction2 = mock(PostDownloadAction.class);
strategy.setPostDownloadActions(Arrays.asList(mockAction1, mockAction2));
strategy.transferFile(new FTPFile("file1", 0, null, 0, false), "destination/");
verify(mockAction1).execute(captor.capture());
verify(mockAction2).execute(captor.capture());
assertThat(captor.getAllValues().get(0).fileName).isEqualTo("file1");
assertThat(captor.getAllValues().get(1).fileName).isEqualTo("file1");
}
@Test
public void ensureNulLActionsAreCheckedBeforeAttemptingToRun() {
DownloadActionImplTestTransferStrategy strategy = new DownloadActionImplTestTransferStrategy(null);
strategy.setPostDownloadActions(null);
strategy.transferFile(new FTPFile("file1", 0, null, 0, false), "destination/");
}
class TestTransferStrategy extends TransferStrategy {
public TestTransferStrategy(Connection connection) {
@ -26,7 +61,7 @@ public class TransferStrategyTest {
public void transferFile(FTPFile fileToTransfer, String destination) {
}
}
class AnotherTestTransferStrategy extends TransferStrategy {
public AnotherTestTransferStrategy(Connection connection) {
@ -37,4 +72,16 @@ public class TransferStrategyTest {
public void transferFile(FTPFile fileToTransfer, String destination) {
}
}
class DownloadActionImplTestTransferStrategy extends TransferStrategy {
public DownloadActionImplTestTransferStrategy(Connection connection) {
super(connection);
}
@Override
public void transferFile(FTPFile fileToTransfer, String destination) {
runPostDownloadAction(fileToTransfer);
}
}
}