test/jalview/bin/CommandsTest.java

   1 package jalview.bin;
   2
   3 import java.io.File;
   4 import java.io.IOException;
   5 import java.nio.file.Files;
   6 import java.util.Date;
   7 import java.util.HashSet;
   8 import java.util.Set;
   9
  10 import org.testng.Assert;
  11 import org.testng.annotations.AfterClass;
  12 import org.testng.annotations.AfterMethod;
  13 import org.testng.annotations.BeforeClass;
  14 import org.testng.annotations.DataProvider;
  15 import org.testng.annotations.Test;
  16
  17 import jalview.gui.AlignFrame;
  18 import jalview.gui.Desktop;
  19 import jalview.gui.JvOptionPane;
  20 import jalview.util.ArrayUtils;
  21
  22 @Test(singleThreaded = true)
  23 public class CommandsTest
  24 {
  25   private static final String testfiles = "test/jalview/bin/argparser/testfiles";
  26
  27   private static final String png1 = testfiles + "/dir1/test1.png";
  28
  29   private static final String png2 = testfiles + "/dir2/test1.png";
  30
  31   @BeforeClass(alwaysRun = true)
  32   public static void setUpBeforeClass() throws Exception
  33   {
  34     Cache.loadProperties("test/jalview/gui/quitProps.jvprops");
  35     Date oneHourFromNow = new Date(
  36             System.currentTimeMillis() + 3600 * 1000);
  37     Cache.setDateProperty("JALVIEW_NEWS_RSS_LASTMODIFIED", oneHourFromNow);
  38   }
  39
  40   @AfterClass(alwaysRun = true)
  41   public static void resetProps()
  42   {
  43     Cache.loadProperties("test/jalview/testProps.jvprops");
  44   }
  45
  46   @BeforeClass(alwaysRun = true)
  47   public void setUpJvOptionPane()
  48   {
  49     JvOptionPane.setInteractiveMode(false);
  50     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  51   }
  52
  53   @AfterMethod(alwaysRun = true)
  54   public void tearDown()
  55   {
  56     if (Desktop.instance != null)
  57       Desktop.instance.closeAll_actionPerformed(null);
  58   }
  59
  60   /* --setprop currently disabled
  61   @Test(groups = "Functional")
  62   public void setpropsTest()
  63   {
  64     String MOSTLY_HARMLESS = "MOSTLY_HARMLESS";
  65     String cmdLine = "--setprop=" + MOSTLY_HARMLESS + "=Earth";
  66     String[] args = cmdLine.split("\\s+");
  67     Jalview.main(args);
  68     Assert.assertEquals(Cache.getDefault(MOSTLY_HARMLESS, "Magrathea"),
  69             "Earth");
  70   }
  71   */
  72
  73   @Test(groups = "Functional", dataProvider = "cmdLines")
  74   public void commandsOpenTest(String cmdLine, boolean cmdArgs,
  75           int numFrames, String[] sequences)
  76   {
  77     String[] args = cmdLine.split("\\s+");
  78     Jalview.main(args);
  79     Commands cmds = Jalview.getInstance().getCommands();
  80     Assert.assertNotNull(cmds);
  81     Assert.assertEquals(cmds.commandArgsProvided(), cmdArgs,
  82             "Commands were not provided in the args");
  83     Assert.assertEquals(cmds.argsWereParsed(), cmdArgs,
  84             "Overall command parse and operation is false");
  85
  86     Assert.assertEquals(Desktop.getAlignFrames().length, numFrames);
  87
  88     if (sequences != null)
  89     {
  90       Set<String> openedSequenceNames = new HashSet<>();
  91       AlignFrame[] afs = Desktop.getAlignFrames();
  92       for (AlignFrame af : afs)
  93       {
  94         openedSequenceNames
  95                 .addAll(af.getViewport().getAlignment().getSequenceNames());
  96       }
  97       for (String sequence : sequences)
  98       {
  99         Assert.assertTrue(openedSequenceNames.contains(sequence),
 100                 "Sequence '" + sequence
 101                         + "' was not found in opened alignment files: "
 102                         + cmdLine + ".\nOpened sequence names are:\n"
 103                         + String.join("\n", openedSequenceNames));
 104       }
 105     }
 106
 107     Assert.assertFalse(
 108             lookForSequenceName("THIS_SEQUENCE_ID_DOESN'T_EXIST"));
 109   }
 110
 111   @Test(groups = "Functional", dataProvider = "argfileOutputFiles")
 112   public void argFilesGlobAndSubstitutionsTest(String cmdLine,
 113           String[] filenames) throws IOException
 114   {
 115     cleanupFiles(filenames);
 116     String[] args = cmdLine.split("\\s+");
 117     Jalview.main(args);
 118     Commands cmds = Jalview.getInstance().getCommands();
 119     Assert.assertNotNull(cmds);
 120     File lastFile = null;
 121     for (String filename : filenames)
 122     {
 123       File file = new File(filename);
 124       Assert.assertTrue(file.exists(), "File '" + filename
 125               + "' was not created by '" + cmdLine + "'");
 126       Assert.assertTrue(file.isFile(), "File '" + filename
 127               + "' is not a file from '" + cmdLine + "'");
 128       Assert.assertTrue(Files.size(file.toPath()) > 0, "File '" + filename
 129               + "' has no content from '" + cmdLine + "'");
 130       // make sure the successive output files get bigger!
 131       if (lastFile != null)
 132         Assert.assertTrue(
 133                 Files.size(file.toPath()) > Files.size(lastFile.toPath()));
 134     }
 135     cleanupFiles(filenames);
 136     tearDown();
 137   }
 138
 139   @DataProvider(name = "argfileOutputFiles")
 140   public Object[][] argfileOutputFiles()
 141   {
 142     return new Object[][] {
 143         { "--argfile=" + testfiles + "/**/*.txt", new String[]
 144         { testfiles + "/dir1/test1.png", testfiles + "/dir2/test1.png",
 145             testfiles + "/dir3/subdir/test0.png" } },
 146         { "--argfile=" + testfiles + "/**/argfile.txt", new String[]
 147         { testfiles + "/dir1/test1.png", testfiles + "/dir2/test1.png" } },
 148         { "--argfile=" + testfiles + "/dir*/argfile.txt", new String[]
 149         { testfiles + "/dir1/test1.png", testfiles + "/dir2/test1.png" } },
 150         { "--initsubstitutions --open examples/uniref50.fa --image "
 151                 + testfiles + "/{basename}.png",
 152             new String[]
 153             { testfiles + "/uniref50.png" } },
 154         { "--open examples/uniref50.fa --image " + testfiles
 155                 + "/{basename}.png",
 156             new String[]
 157             { testfiles + "/{basename}.png" } } };
 158   }
 159
 160   @DataProvider(name = "cmdLines")
 161   public Object[][] cmdLines()
 162   {
 163     String[] someUniref50Seqs = new String[] { "FER_CAPAA", "FER_CAPAN",
 164         "FER1_MAIZE", "FER1_SPIOL", "O80429_MAIZE" };
 165     String[] t1 = new String[] { "TEST1" };
 166     String[] t2 = new String[] { "TEST2" };
 167     String[] t3 = new String[] { "TEST3" };
 168     return new Object[][] {
 169         { "--open=examples/uniref50.fa", true, 1, someUniref50Seqs },
 170         { "--open examples/uniref50.fa", true, 1, someUniref50Seqs },
 171         { "--open=examples/uniref50*.fa", true, 1, someUniref50Seqs },
 172         // NOTE we cannot use shell expansion in tests, so list all files!
 173         { "--open examples/uniref50.fa examples/uniref50_mz.fa", true, 1,
 174             someUniref50Seqs },
 175         { "--open=[new]examples/uniref50*.fa", true, 2, someUniref50Seqs },
 176         { "--opennew=examples/uniref50*.fa", true, 2, someUniref50Seqs },
 177         { "examples/uniref50.fa", true, 1, someUniref50Seqs },
 178         { "examples/uniref50.fa " + testfiles + "/test1.fa", true, 2,
 179             ArrayUtils.concatArrays(someUniref50Seqs, t1) },
 180         { "examples/uniref50.fa " + testfiles + "/test1.fa", true, 2, t1 },
 181         { "--argfile=" + testfiles + "/argfile0.txt", true, 1,
 182             ArrayUtils.concatArrays(t1, t3) },
 183         { "--argfile=" + testfiles + "/argfile*.txt", true, 4,
 184             ArrayUtils.concatArrays(t1, t2, t3) },
 185         { "--argfile=" + testfiles + "/argfile.autocounter", true, 3,
 186             ArrayUtils.concatArrays(t1, t2) } };
 187   }
 188
 189   public static boolean lookForSequenceName(String sequenceName)
 190   {
 191     AlignFrame[] afs = Desktop.getAlignFrames();
 192     for (AlignFrame af : afs)
 193     {
 194       for (String name : af.getViewport().getAlignment().getSequenceNames())
 195       {
 196         if (sequenceName.equals(name))
 197         {
 198           return true;
 199         }
 200       }
 201     }
 202     return false;
 203   }
 204
 205   public static void cleanupFiles(String[] filenames)
 206   {
 207     for (String filename : filenames)
 208     {
 209       File file = new File(filename);
 210       if (file.exists())
 211       {
 212         file.delete();
 213       }
 214     }
 215   }
 216
 217 }