path: root/src/test/java/com/keuin/kbackupfabric/operation/backup/method/ConfiguredIncrementalBackupMethodTest.java

package com.keuin.kbackupfabric.operation.backup.method;

import com.keuin.kbackupfabric.backup.name.IncrementalBackupFileNameEncoder;
import com.keuin.kbackupfabric.metadata.BackupMetadata;
import com.keuin.kbackupfabric.operation.backup.feedback.IncrementalBackupFeedback;
import org.apache.commons.codec.digest.DigestUtils;
import org.apache.commons.io.FileUtils;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

import java.io.*;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.time.LocalDateTime;
import java.util.*;
import java.util.function.Function;
import java.util.logging.Logger;

import static org.apache.commons.io.FileUtils.forceDelete;
import static org.junit.Assert.*;

public class ConfiguredIncrementalBackupMethodTest {

    public static final String SUBDIRECTORY = "kb_temp";
    private String testTempPath;
    private final String sourceDirectoryName = "source";
    private final String destDirectoryName = "destination";
    private final String customBackupName = "index";
    private final String indexFileName = IncrementalBackupFileNameEncoder.INSTANCE.encode(customBackupName, LocalDateTime.now());

    private final double directoryFactor = 0.05;
    private final double fileFactor = 0.1;
    private final int maxRandomFileSizeBytes = 1024 * 1024;
    private final Function<Integer, Integer> scaleDecayFunc = (x) -> x - 1;

    private static final Logger logger = Logger.getLogger(ConfiguredIncrementalBackupMethodTest.class.getName());

    @Before
    public void setUp() throws IOException {
        // select temporary directory
        String path = System.getenv("KB_TEMP_DIR");
        if (path != null && !path.isEmpty() && new File(path).isDirectory()) {
            testTempPath = Paths.get(path, SUBDIRECTORY).toString();
        } else {
            testTempPath = findTempPath();
        }
        logger.info(String.format("Using temp path: %s", testTempPath));
    }

    private static String findTempPath() throws IOException {
        String path;
        if (System.getProperty("os.name").startsWith("Windows")) {
            // Windows
            path = System.getProperty("java.io.tmpdir");
        } else {
            // Unix
            path = System.getenv("XDG_RUNTIME_DIR");
            if (!new File(path).isDirectory()) {
                path = "/tmp";
            }
        }
        if (!new File(path).isDirectory()) {
            throw new IOException("Cannot find suitable temporary path");
        }
        path = Paths.get(path, SUBDIRECTORY).toString();
        return path;
    }

    @After
    public void tearDown() throws IOException {
        if (testTempPath.endsWith(SUBDIRECTORY)) {
            // recursive delete with safeguard
            FileUtils.deleteDirectory(new File(testTempPath));
        }
    }

    @Test
    public void iterationTest() throws IOException {
        int a = 12;
        for (int i = 0; i < a; ++i) {
            performTest(Math.min(i + 1, 10));
            System.out.println("Round " + i + " passed.");
        }
    }

    private void performTest(int scale) throws IOException {

        // init source and destination
        final Path sourcePath = Paths.get(testTempPath, sourceDirectoryName);
        final Path destPath = Paths.get(testTempPath, destDirectoryName);
        if (new File(sourcePath.toString()).exists()) {
            forceDelete(new File(sourcePath.toString()));
            if (!new File(sourcePath.toString()).mkdirs())
                fail();
        }
        if (new File(destPath.toString()).exists()) {
            forceDelete(new File(destPath.toString()));
            if (!new File(destPath.toString()).mkdirs())
                fail();
        }
        if (new File(testTempPath, indexFileName).exists()) {
            if (!new File(testTempPath, indexFileName).delete())
                fail();
        }

        // initialize src
        createRandomDirectoryTree(sourcePath.toString(), scale);

        String hash1 = calcMD5HashForDir(sourcePath.toFile(), true);

        // copy src to dest
        ConfiguredIncrementalBackupMethod method = new ConfiguredIncrementalBackupMethod(
                indexFileName,
                sourcePath.toString(),
                testTempPath,
                destPath.toString()
        );
        IncrementalBackupFeedback feedback = method.backup();
        assertNotNull("Feedback should not be null.", feedback);
        if (!feedback.isSuccess())
            fail("Failed to backup. Cannot perform test.");
        assertTrue("Index file was not generated by backup.", new File(testTempPath, indexFileName).exists());

        // delete src
        forceDelete(sourcePath.toFile());
        assertFalse(sourcePath.toFile().exists());

        // restore src
        if (!method.restore())
            fail();

        boolean fake = scale % 2 != 0;

        int[] success = new int[1];
        if (fake) {
            Files.walk(sourcePath).filter(path -> path.toFile().isFile()).limit(4).forEach(path -> {
                System.out.println("Deleted file `" + path.toFile().getName() + "`.");
                if (!path.toFile().delete())
                    fail();
                if (!Objects.equals(path.toFile().getName(), BackupMetadata.metadataFileName))
                    success[0]++;
            });
            if (success[0] == 0)
                fake = false;
        }

        if (fake)
            System.out.println("Fake: deleted " + success[0] + " file(s).");

        String hash2 = calcMD5HashForDir(sourcePath.toFile(), true);

        if (!fake)
            assertEquals(hash1, hash2);
        else
            assertNotEquals(hash1, hash2);
    }

    private void createRandomDirectoryTree(String path, int scale) throws IOException {
        if (scale <= 0) {
            if (Math.random() < 0.5)
                if (!new File(path).mkdirs() && !new File(path).exists())
                    throw new IOException("Failed to create directory " + path);
            return;
        }
        if (!new File(path).isDirectory() && !new File(path).mkdirs())
            throw new IOException("Failed to create directory " + path);

        int subFileCount = (int) Math.round(Math.random() * 10 * scale * fileFactor);
        for (int i = 0; i < subFileCount; i++) {
            String subFile = null;
            while (subFile == null || new File(path, subFile).exists())
                subFile = getRandomString((int) (Math.random() * 16 + 5));
            createRandomFile(new File(path, subFile), maxRandomFileSizeBytes);
        }


        int subDirCount = (int) Math.round(Math.random() * 10 * scale * directoryFactor);
        for (int i = 0; i < subDirCount; i++) {
            String subDir = null;
            while (subDir == null || new File(path, subDir).exists())
                subDir = getRandomString((int) (Math.random() * 16 + 5));
            createRandomDirectoryTree(new File(path, subDir).getAbsolutePath(), scaleDecayFunc.apply(scale));
        }
    }

    private static void createRandomFile(File file, int maxSizeBytes) throws IOException {
        if (!file.createNewFile())
            throw new IOException("Failed to create file " + file.getAbsolutePath());
        try (FileOutputStream fileOutputStream = new FileOutputStream(file)) {
            int fileBytes = (int) (maxSizeBytes * Math.random() + 1);
            Random random = new Random();
            final int chunkSize = 1024 * 4;
            byte[] randomChunk = new byte[chunkSize];
            for (int i = 0; i < fileBytes / chunkSize; i++) {
                random.nextBytes(randomChunk);
                fileOutputStream.write(randomChunk);
            }
            if (fileBytes % chunkSize != 0) {
                randomChunk = new byte[fileBytes % chunkSize];
                random.nextBytes(randomChunk);
                fileOutputStream.write(randomChunk);
            }
        }
    }

    private static String getRandomString(int length) {
        String str = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
        Random random = new Random();
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < length; i++) {
            int number = random.nextInt(62);
            sb.append(str.charAt(number));
        }
        return sb.toString();
    }

    public String calcMD5HashForDir(File dirToHash, boolean includeHiddenFiles) {

        assert (dirToHash.isDirectory());
        Vector<FileInputStream> fileStreams = new Vector<>();

        System.out.println("Found files for hashing:");
        collectInputStreams(dirToHash, fileStreams, includeHiddenFiles, Collections.singleton(BackupMetadata.metadataFileName));

        SequenceInputStream seqStream =
                new SequenceInputStream(fileStreams.elements());

        try {
            String md5Hash = DigestUtils.md5Hex(seqStream);
            seqStream.close();
            return md5Hash;
        } catch (IOException e) {
            throw new RuntimeException("Error reading files to hash in "
                    + dirToHash.getAbsolutePath(), e);
        }

    }

    private void collectInputStreams(File dir,
                                     List<FileInputStream> foundStreams,
                                     boolean includeHiddenFiles,
                                     Set<String> ignoredFiles) {

        File[] fileList = dir.listFiles();
        Arrays.sort(fileList,               // Need in reproducible order
                new Comparator<File>() {
                    public int compare(File f1, File f2) {
                        return f1.getName().compareTo(f2.getName());
                    }
                });

        for (File f : fileList) {
            if (!includeHiddenFiles && f.getName().startsWith(".") ||
                    Optional.ofNullable(ignoredFiles).orElse(Collections.emptySet()).contains(f.getName())) {
                // Skip it
            } else if (f.isDirectory()) {
                collectInputStreams(f, foundStreams, includeHiddenFiles, ignoredFiles);
            } else {
                try {
                    System.out.println("\t" + f.getAbsolutePath());
                    foundStreams.add(new FileInputStream(f));
                } catch (FileNotFoundException e) {
                    throw new AssertionError(e.getMessage()
                            + ": file should never not be found!");
                }
            }
        }

    }
}