package jalview.io;
-import jalview.bin.Cache;
-import jalview.datamodel.AlignmentI;
-import jalview.datamodel.Sequence;
-import jalview.datamodel.SequenceI;
-import jalview.gui.AlignFrame;
-import jalview.gui.JvOptionPane;
-
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
+import jalview.bin.Cache;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.Sequence;
+import jalview.datamodel.SequenceI;
+import jalview.gui.AlignFrame;
+import jalview.gui.JvOptionPane;
+
public class BackupFilesTest
{
@BeforeClass(alwaysRun = true)
}
private static boolean actuallyDeleteTmpFiles = true;
- private static String testDir = "examples";
+
+ private static String testDir = "test/jalview/io";
private static String testBasename = "backupfilestest";
private static String testFilename = testBasename + testExt;
-
private static String testFile = testDir + File.separatorChar
+ testFilename;
private static String suffix = "_BACKUPTEST-%n";
- private static int digits = 8;
+ private static int digits = 6;
private static int rollMax = 2;
Assert.assertTrue(backupFiles.length == 0);
}
+ // save with no numbers in the backup file names
+ @Test(groups = { "Functional" })
+ public void backupsEnabledSingleFileBackupTest() throws Exception
+ {
+ // Enable BackupFiles and set noMax so all backupfiles get kept
+ String mysuffix = "~";
+ BackupFilesPresetEntry bfpe = new BackupFilesPresetEntry(mysuffix, 1,
+ false, true, 1, false);
+ setBackupFilesOptions(true, false, true,
+ "test/jalview/io/testProps_singlefilebackup.jvprops", bfpe);
+
+ // init the newFile and backups (i.e. make sure newFile exists on its own
+ // and has no backups)
+ initNewFileForTesting();
+ HashMap<Integer, String> correctindexmap = new HashMap<>();
+ correctindexmap.put(0, "backupfilestestTemp.fa~");
+
+ save();
+ Assert.assertTrue(checkBackupFiles(correctindexmap, newFile, "~", 1));
+
+ // and a second time -- see JAL-3628
+ save();
+ Assert.assertTrue(checkBackupFiles(correctindexmap, newFile, "~", 1));
+
+ cleanupTmpFiles(newFile, "~", 1);
+ }
+
// save keeping all backup files
@Test(groups = { "Functional" })
public void backupsEnabledNoRollMaxTest() throws Exception
// check 10 backup files
HashMap<Integer, String> correctindexmap = new HashMap<>();
- correctindexmap.put(1, "backupfilestestTemp.fa_BACKUPTEST-00000001");
- correctindexmap.put(2, "backupfilestestTemp.fa_BACKUPTEST-00000002");
- correctindexmap.put(3, "backupfilestestTemp.fa_BACKUPTEST-00000003");
- correctindexmap.put(4, "backupfilestestTemp.fa_BACKUPTEST-00000004");
- correctindexmap.put(5, "backupfilestestTemp.fa_BACKUPTEST-00000005");
- correctindexmap.put(6, "backupfilestestTemp.fa_BACKUPTEST-00000006");
- correctindexmap.put(7, "backupfilestestTemp.fa_BACKUPTEST-00000007");
- correctindexmap.put(8, "backupfilestestTemp.fa_BACKUPTEST-00000008");
- correctindexmap.put(9, "backupfilestestTemp.fa_BACKUPTEST-00000009");
- correctindexmap.put(10, "backupfilestestTemp.fa_BACKUPTEST-00000010");
+ correctindexmap.put(1, "backupfilestestTemp.fa_BACKUPTEST-000001");
+ correctindexmap.put(2, "backupfilestestTemp.fa_BACKUPTEST-000002");
+ correctindexmap.put(3, "backupfilestestTemp.fa_BACKUPTEST-000003");
+ correctindexmap.put(4, "backupfilestestTemp.fa_BACKUPTEST-000004");
+ correctindexmap.put(5, "backupfilestestTemp.fa_BACKUPTEST-000005");
+ correctindexmap.put(6, "backupfilestestTemp.fa_BACKUPTEST-000006");
+ correctindexmap.put(7, "backupfilestestTemp.fa_BACKUPTEST-000007");
+ correctindexmap.put(8, "backupfilestestTemp.fa_BACKUPTEST-000008");
+ correctindexmap.put(9, "backupfilestestTemp.fa_BACKUPTEST-000009");
+ correctindexmap.put(10, "backupfilestestTemp.fa_BACKUPTEST-000010");
HashMap<Integer, String> wrongindexmap = new HashMap<>();
wrongindexmap.put(1, "backupfilestestTemp.fa_BACKUPTEST-1");
- wrongindexmap.put(2, "backupfilestestTemp.fa_BACKUPTEST-00000002");
- wrongindexmap.put(3, "backupfilestestTemp.fa_BACKUPTEST-00000003");
- wrongindexmap.put(4, "backupfilestestTemp.fa_BACKUPTEST-00000004");
- wrongindexmap.put(5, "backupfilestestTemp.fa_BACKUPTEST-00000005");
- wrongindexmap.put(6, "backupfilestestTemp.fa_BACKUPTEST-00000006");
- wrongindexmap.put(7, "backupfilestestTemp.fa_BACKUPTEST-00000007");
- wrongindexmap.put(8, "backupfilestestTemp.fa_BACKUPTEST-00000008");
- wrongindexmap.put(9, "backupfilestestTemp.fa_BACKUPTEST-00000009");
- wrongindexmap.put(10, "backupfilestestTemp.fa_BACKUPTEST-00000010");
+ wrongindexmap.put(2, "backupfilestestTemp.fa_BACKUPTEST-000002");
+ wrongindexmap.put(3, "backupfilestestTemp.fa_BACKUPTEST-000003");
+ wrongindexmap.put(4, "backupfilestestTemp.fa_BACKUPTEST-000004");
+ wrongindexmap.put(5, "backupfilestestTemp.fa_BACKUPTEST-000005");
+ wrongindexmap.put(6, "backupfilestestTemp.fa_BACKUPTEST-000006");
+ wrongindexmap.put(7, "backupfilestestTemp.fa_BACKUPTEST-000007");
+ wrongindexmap.put(8, "backupfilestestTemp.fa_BACKUPTEST-000008");
+ wrongindexmap.put(9, "backupfilestestTemp.fa_BACKUPTEST-000009");
+ wrongindexmap.put(10, "backupfilestestTemp.fa_BACKUPTEST-000010");
int[] indexes2 = { 3, 4, 5, 6, 7, 8, 9, 10 };
int[] indexes3 = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 };
Assert.assertTrue(checkBackupFiles(correctindexmap));
// check there are "rollMax" backup files and they are all saved correctly
// check 10 backup files
HashMap<Integer, String> correctindexmap = new HashMap<>();
- correctindexmap.put(9, "backupfilestestTemp.fa_BACKUPTEST-00000009");
- correctindexmap.put(10, "backupfilestestTemp.fa_BACKUPTEST-00000010");
+ correctindexmap.put(9, "backupfilestestTemp.fa_BACKUPTEST-000009");
+ correctindexmap.put(10, "backupfilestestTemp.fa_BACKUPTEST-000010");
int[] indexes2 = { 10 };
int[] indexes3 = { 8, 9, 10 };
Assert.assertTrue(checkBackupFiles(correctindexmap));
// check there are "rollMax" backup files and they are all saved correctly
// check 10 backup files
HashMap<Integer, String> correctindexmap = new HashMap<>();
- correctindexmap.put(1, "backupfilestestTemp.fa_BACKUPTEST-00000001");
- correctindexmap.put(2, "backupfilestestTemp.fa_BACKUPTEST-00000002");
+ correctindexmap.put(1, "backupfilestestTemp.fa_BACKUPTEST-000001");
+ correctindexmap.put(2, "backupfilestestTemp.fa_BACKUPTEST-000002");
int[] indexes2 = { 1 };
int[] indexes3 = { 1, 2, 3 };
Assert.assertTrue(checkBackupFiles(correctindexmap));
private void setBackupFilesOptions(boolean enabled, boolean reverse,
boolean noMax)
{
- Cache.loadProperties("test/jalview/io/testProps.jvprops");
-
BackupFilesPresetEntry bfpe = new BackupFilesPresetEntry(suffix, digits,
reverse, noMax, rollMax, false);
+ setBackupFilesOptions(enabled, reverse, noMax,
+ "test/jalview/io/testProps.jvprops", bfpe);
+ }
+
+ private void setBackupFilesOptions(boolean enabled, boolean reverse,
+ boolean noMax, String propsFile, BackupFilesPresetEntry bfpe)
+ {
+ Cache.loadProperties(propsFile);
Cache.applicationProperties.setProperty(BackupFiles.ENABLED,
Boolean.toString(enabled));
{
if (af != null)
{
- af.saveAlignment(newFile, jalview.io.FileFormat.Fasta);
+ af.saveAlignment(newFile, jalview.io.FileFormat.Fasta);
}
}
@AfterClass(alwaysRun = true)
private void cleanupTmpFiles()
{
- File newfile = new File(newFile);
+ cleanupTmpFiles(newFile, suffix, digits);
+ }
+
+ protected static void cleanupTmpFiles(String file, String mysuffix,
+ int mydigits)
+ {
+ File newfile = new File(file);
if (newfile.exists())
{
newfile.delete();
}
- File[] tmpFiles = getBackupFiles(newFile, suffix, digits);
+ File[] tmpFiles = getBackupFiles(file, mysuffix, mydigits);
for (int i = 0; i < tmpFiles.length; i++)
{
if (actuallyDeleteTmpFiles)
private static File[] getBackupFiles(String f, String s, int i)
{
- TreeMap<Integer, File> bfTreeMap = BackupFiles.getBackupFilesAsTreeMap(f,
- s, i);
+ TreeMap<Integer, File> bfTreeMap = BackupFiles
+ .getBackupFilesAsTreeMap(f, s, i);
File[] backupFiles = new File[bfTreeMap.size()];
bfTreeMap.values().toArray(backupFiles);
return backupFiles;
private static boolean checkBackupFiles(HashMap<Integer, String> indexmap)
throws IOException
{
- TreeMap<Integer, File> map = BackupFiles.getBackupFilesAsTreeMap(newFile,
- suffix, digits);
+ return checkBackupFiles(indexmap, newFile, suffix, digits);
+ }
+
+ private static boolean checkBackupFiles(HashMap<Integer, String> indexmap,
+ String file, String mysuffix, int mydigits) throws IOException
+ {
+ TreeMap<Integer, File> map = BackupFiles.getBackupFilesAsTreeMap(file,
+ mysuffix, mydigits);
Enumeration<Integer> indexesenum = Collections
.enumeration(indexmap.keySet());
while (indexesenum.hasMoreElements())
private static boolean checkBackupFiles(int[] indexes) throws IOException
{
- TreeMap<Integer, File> map = BackupFiles.getBackupFilesAsTreeMap(newFile,
- suffix, digits);
+ TreeMap<Integer, File> map = BackupFiles
+ .getBackupFilesAsTreeMap(newFile, suffix, digits);
for (int m = 0; m < indexes.length; m++)
{
int i = indexes[m];
{
return false;
}
- // check the filename -- although this uses the same code to forumulate the filename so not much of a test!
+ // check the filename -- although this uses the same code to forumulate
+ // the filename so not much of a test!
String filename = BackupFilenameParts.getBackupFilename(i,
newBasename + testExt, suffix, digits);
if (!filename.equals(f.getName()))
return filenames;
}
- public static boolean sequencesEqual(SequenceI s1, SequenceI s2) {
- if (s1 == null && s2 == null) {
+ public static boolean sequencesEqual(SequenceI s1, SequenceI s2)
+ {
+ if (s1 == null && s2 == null)
+ {
return true;
- } else if (s1 == null || s2 == null) {
+ }
+ else if (s1 == null || s2 == null)
+ {
return false;
}
return (s1.getName().equals(s2.getName())