test/jalview/bin/CommandLineOperations.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.bin;
  22
  23 import static org.testng.Assert.assertEquals;
  24 import static org.testng.Assert.assertNotNull;
  25 import static org.testng.Assert.assertTrue;
  26
  27 import jalview.gui.JvOptionPane;
  28 import jalview.io.DataSourceType;
  29 import jalview.io.FileFormat;
  30 import jalview.io.FileFormatException;
  31 import jalview.io.FileFormatI;
  32 import jalview.io.FileFormats;
  33 import jalview.io.IdentifyFile;
  34
  35 import java.io.BufferedReader;
  36 import java.io.File;
  37 import java.io.IOException;
  38 import java.io.InputStreamReader;
  39 import java.nio.file.Path;
  40 import java.nio.file.Paths;
  41 import java.util.ArrayList;
  42
  43 import org.testng.Assert;
  44 import org.testng.FileAssert;
  45 import org.testng.annotations.BeforeClass;
  46 import org.testng.annotations.BeforeTest;
  47 import org.testng.annotations.DataProvider;
  48 import org.testng.annotations.Test;
  49
  50 import io.github.classgraph.ClassGraph;
  51 import io.github.classgraph.ModuleRef;
  52 import io.github.classgraph.ScanResult;
  53
  54 public class CommandLineOperations
  55 {
  56
  57   @BeforeClass(alwaysRun = true)
  58   public void setUpJvOptionPane()
  59   {
  60     JvOptionPane.setInteractiveMode(false);
  61     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  62   }
  63
  64   private static final int TEST_TIMEOUT = 9000; // Note longer timeout needed
  65                                                 // on
  66                                                 // full test run than on
  67                                                 // individual tests
  68
  69   private static final int SETUP_TIMEOUT = 9000;
  70
  71   private static final int MINFILESIZE_SMALL = 2096;
  72
  73   private static final int MINFILESIZE_BIG = 4096;
  74
  75   private ArrayList<String> successfulCMDs = new ArrayList<>();
  76
  77   /***
  78    * from
  79    * http://stackoverflow.com/questions/808276/how-to-add-a-timeout-value-when
  80    * -using-javas-runtime-exec
  81    *
  82    * @author jimp
  83    *
  84    */
  85   private static class Worker extends Thread
  86   {
  87     private final Process process;
  88
  89     private BufferedReader outputReader;
  90
  91     private BufferedReader errorReader;
  92
  93     private Integer exit;
  94
  95     private Worker(Process process)
  96     {
  97       this.process = process;
  98     }
  99
 100     @Override
 101     public void run()
 102     {
 103       try
 104       {
 105         exit = process.waitFor();
 106       } catch (InterruptedException ignore)
 107       {
 108         return;
 109       }
 110     }
 111
 112     public BufferedReader getOutputReader()
 113     {
 114       return outputReader;
 115     }
 116
 117     public void setOutputReader(BufferedReader outputReader)
 118     {
 119       this.outputReader = outputReader;
 120     }
 121
 122     public BufferedReader getErrorReader()
 123     {
 124       return errorReader;
 125     }
 126
 127     public void setErrorReader(BufferedReader errorReader)
 128     {
 129       this.errorReader = errorReader;
 130     }
 131   }
 132
 133   private static ClassGraph scanner = null;
 134
 135   private static String classpath = null;
 136
 137   private static String modules = null;
 138
 139   private static String java_exe = null;
 140
 141   public synchronized static String getClassPath()
 142   {
 143     if (scanner == null)
 144     {
 145       scanner = new ClassGraph();
 146       ScanResult scan = scanner.scan();
 147       classpath = scan.getClasspath();
 148       modules = "";
 149       for (ModuleRef mr : scan.getModules())
 150       {
 151         modules.concat(mr.getName());
 152       }
 153       java_exe = System.getProperty("java.home") + File.separator + "bin"
 154               + File.separator + "java";
 155
 156     }
 157     while (classpath == null)
 158     {
 159       try
 160       {
 161         Thread.sleep(10);
 162       } catch (InterruptedException x)
 163       {
 164
 165       }
 166     }
 167     return classpath;
 168   }
 169
 170   private Worker getJalviewDesktopRunner(boolean withAwt, String cmd,
 171           int timeout)
 172   {
 173     // Note: JAL-3065 - don't include quotes for lib/* because the arguments are
 174     // not expanded by the shell
 175     String classpath = getClassPath();
 176     String _cmd = java_exe + " "
 177             + (withAwt ? "-Djava.awt.headless=true" : "")
 178             + " -classpath " + classpath
 179             + (modules.length() > 2 ? "--add-modules=\"" + modules + "\""
 180                     : "")
 181             + " jalview.bin.Jalview ";
 182     Process ls2_proc = null;
 183     Worker worker = null;
 184     try
 185     {
 186       ls2_proc = Runtime.getRuntime().exec(_cmd + cmd);
 187     } catch (Throwable e1)
 188     {
 189       e1.printStackTrace();
 190     }
 191     if (ls2_proc != null)
 192     {
 193       BufferedReader outputReader = new BufferedReader(
 194               new InputStreamReader(ls2_proc.getInputStream()));
 195       BufferedReader errorReader = new BufferedReader(
 196               new InputStreamReader(ls2_proc.getErrorStream()));
 197       worker = new Worker(ls2_proc);
 198       worker.start();
 199       try
 200       {
 201         worker.join(timeout);
 202       } catch (InterruptedException e)
 203       {
 204         System.err.println("Thread interrupted");
 205       }
 206       worker.setOutputReader(outputReader);
 207       worker.setErrorReader(errorReader);
 208     }
 209     return worker;
 210   }
 211
 212   @Test(groups = { "Functional" })
 213   public void reportCurrentWorkingDirectory()
 214   {
 215     try
 216     {
 217       Path currentRelativePath = Paths.get("");
 218       String s = currentRelativePath.toAbsolutePath().toString();
 219       System.out.println("Test CWD is " + s);
 220     } catch (Exception q)
 221     {
 222       q.printStackTrace();
 223     }
 224   }
 225
 226   @BeforeTest(alwaysRun = true)
 227   public void initialize()
 228   {
 229     new CommandLineOperations();
 230   }
 231
 232   @BeforeTest(alwaysRun = true)
 233   public void setUpForHeadlessCommandLineInputOperations()
 234           throws IOException
 235   {
 236     String cmds = "nodisplay -open examples/uniref50.fa -sortbytree -props test/jalview/io/testProps.jvprops -colour zappo "
 237             + "-jabaws http://www.compbio.dundee.ac.uk/jabaws -nosortbytree "
 238             + "-features examples/testdata/plantfdx.features -annotations examples/testdata/plantfdx.annotations -tree examples/testdata/uniref50_test_tree";
 239     Worker worker = getJalviewDesktopRunner(true, cmds, SETUP_TIMEOUT);
 240     String ln = null;
 241     while ((ln = worker.getOutputReader().readLine()) != null)
 242     {
 243       System.out.println(ln);
 244       successfulCMDs.add(ln);
 245     }
 246     while ((ln = worker.getErrorReader().readLine()) != null)
 247     {
 248       System.err.println(ln);
 249     }
 250   }
 251
 252   @BeforeTest(alwaysRun = true)
 253   public void setUpForCommandLineInputOperations() throws IOException
 254   {
 255     String cmds = "-open examples/uniref50.fa -noquestionnaire -nousagestats";
 256     Worker worker = getJalviewDesktopRunner(false, cmds, SETUP_TIMEOUT);
 257     String ln = null;
 258     int count = 0;
 259     while ((ln = worker.getErrorReader().readLine()) != null)
 260     {
 261       System.out.println(ln);
 262       successfulCMDs.add(ln);
 263       if (++count > 25)
 264       {
 265         break;
 266       }
 267     }
 268     if (worker != null && worker.exit == null)
 269     {
 270       worker.interrupt();
 271       Thread.currentThread().interrupt();
 272       worker.process.destroy();
 273     }
 274   }
 275
 276   @Test(groups = { "Functional" }, dataProvider = "allInputOperationsData")
 277   public void testAllInputOperations(String expectedString,
 278           String failureMsg)
 279   {
 280     Assert.assertTrue(successfulCMDs.contains(expectedString), failureMsg);
 281   }
 282
 283   @Test(
 284     groups =
 285     { "Functional", "testben" },
 286     dataProvider = "headlessModeOutputOperationsData")
 287   public void testHeadlessModeOutputOperations(String harg, String type,
 288           String fileName, boolean withAWT, int expectedMinFileSize,
 289           int timeout, String fileFormatType)
 290   {
 291     String cmd = harg + type + " " + fileName;
 292     // System.out.println(">>>>>>>>>>>>>>>> Command : " + cmd);
 293     File file = new File(fileName);
 294     file.deleteOnExit();
 295     Worker worker = getJalviewDesktopRunner(withAWT, cmd, timeout);
 296     assertNotNull(worker, "worker is null");
 297     String msg = "Didn't create an output" + type + " file.[" + harg + "]";
 298     assertTrue(file.exists(), msg);
 299     FileAssert.assertFile(file, msg);
 300     FileAssert.assertMinLength(file, expectedMinFileSize);
 301     if (fileFormatType!=null && fileFormatType.length()>0)
 302     {
 303       String format = FileFormats.getInstance().forName(fileFormatType).getName();
 304       if (format!=null)
 305       {
 306         try
 307         {
 308           FileFormatI exportedType = new IdentifyFile()
 309                   .identify(file.getAbsolutePath(), DataSourceType.FILE);
 310           assertEquals(exportedType, format,
 311                   "Exported file type was wrong");
 312         } catch (FileFormatException e)
 313         {
 314           Assert.fail("Couldn't identify file " + file
 315                   + " as an alignment format", e);
 316         }
 317       }
 318     }
 319     if (worker != null && worker.exit == null)
 320     {
 321       worker.interrupt();
 322       Thread.currentThread().interrupt();
 323       worker.process.destroy();
 324       Assert.fail("Jalview did not exit after " + type
 325               + " generation (try running test again to verify - timeout at "
 326               + timeout + "ms). [" + harg + "]");
 327     }
 328     file.delete();
 329   }
 330
 331   @DataProvider(name = "allInputOperationsData")
 332   public Object[][] getHeadlessModeInputParams()
 333   {
 334     return new Object[][] {
 335         // headless mode input operations
 336         { "CMD [-color zappo] executed successfully!",
 337             "Failed command : -color zappo" },
 338         { "CMD [-props test/jalview/io/testProps.jvprops] executed successfully!",
 339             "Failed command : -props File" },
 340         { "CMD [-sortbytree] executed successfully!",
 341             "Failed command : -sortbytree" },
 342         { "CMD [-jabaws http://www.compbio.dundee.ac.uk/jabaws] executed successfully!",
 343             "Failed command : -jabaws http://www.compbio.dundee.ac.uk/jabaws" },
 344         { "CMD [-open examples/uniref50.fa] executed successfully!",
 345             "Failed command : -open examples/uniref50.fa" },
 346         { "CMD [-nosortbytree] executed successfully!",
 347             "Failed command : -nosortbytree" },
 348         { "CMD [-features examples/testdata/plantfdx.features]  executed successfully!",
 349             "Failed command : -features examples/testdata/plantfdx.features" },
 350         { "CMD [-annotations examples/testdata/plantfdx.annotations] executed successfully!",
 351             "Failed command : -annotations examples/testdata/plantfdx.annotations" },
 352         { "CMD [-tree examples/testdata/uniref50_test_tree] executed successfully!",
 353             "Failed command : -tree examples/testdata/uniref50_test_tree" },
 354         // non headless mode input operations
 355         { "CMD [-nousagestats] executed successfully!",
 356             "Failed command : -nousagestats" },
 357         { "CMD [-noquestionnaire] executed successfully!",
 358             "Failed command : -noquestionnaire" } };
 359   }
 360
 361   @DataProvider(name = "headlessModeOutputOperationsData")
 362   public static Object[][] getHeadlessModeOutputParams()
 363   {
 364     // JBPNote: I'm not clear why need to specify full path for output file
 365     // when running tests on build server, but we will keep this patch for now
 366     // since it works.
 367     // https://issues.jalview.org/browse/JAL-1889?focusedCommentId=21609&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-21609
 368     String workingDir = "test/jalview/bin/";
 369     return new Object[][] { { "nodisplay -open examples/uniref50.fa",
 370         " -eps", workingDir + "test_uniref50_out.eps", true,
 371         MINFILESIZE_BIG, TEST_TIMEOUT, null },
 372         { "nodisplay -open examples/uniref50.fa", " -eps",
 373             workingDir + "test_uniref50_out.eps", false,
 374             MINFILESIZE_BIG, TEST_TIMEOUT, null },
 375         { "nogui -open examples/uniref50.fa", " -eps",
 376             workingDir + "test_uniref50_out.eps", true, MINFILESIZE_BIG,
 377             TEST_TIMEOUT, null },
 378         { "nogui -open examples/uniref50.fa", " -eps",
 379             workingDir + "test_uniref50_out.eps", false,
 380             MINFILESIZE_BIG, TEST_TIMEOUT, null },
 381         { "headless -open examples/uniref50.fa", " -eps",
 382             workingDir + "test_uniref50_out.eps", true, MINFILESIZE_BIG,
 383             TEST_TIMEOUT, null },
 384         { "headless -open examples/uniref50.fa", " -svg",
 385             workingDir + "test_uniref50_out.svg", false,
 386             MINFILESIZE_BIG, TEST_TIMEOUT, null },
 387         { "headless -open examples/uniref50.fa", " -png",
 388             workingDir + "test_uniref50_out.png", true, MINFILESIZE_BIG,
 389             TEST_TIMEOUT, null },
 390         { "headless -open examples/uniref50.fa", " -html",
 391             workingDir + "test_uniref50_out.html", true,
 392             MINFILESIZE_BIG, TEST_TIMEOUT, null },
 393         { "headless -open examples/uniref50.fa", " -fasta",
 394             workingDir + "test_uniref50_out.mfa", true, MINFILESIZE_SMALL,
 395             TEST_TIMEOUT, FileFormat.Fasta.toString() },
 396         { "headless -open examples/uniref50.fa", " -clustal",
 397             workingDir + "test_uniref50_out.aln", true, MINFILESIZE_SMALL,
 398             TEST_TIMEOUT, FileFormat.Clustal.toString() },
 399         { "headless -open examples/uniref50.fa", " -msf",
 400             workingDir + "test_uniref50_out.msf", true, MINFILESIZE_SMALL,
 401             TEST_TIMEOUT, FileFormat.MSF.toString() },
 402         { "headless -open examples/uniref50.fa", " -pileup",
 403             workingDir + "test_uniref50_out.aln", true, MINFILESIZE_SMALL,
 404             TEST_TIMEOUT, FileFormat.Pileup.toString() },
 405         { "headless -open examples/uniref50.fa", " -pir",
 406             workingDir + "test_uniref50_out.pir", true, MINFILESIZE_SMALL,
 407             TEST_TIMEOUT, FileFormat.PIR.toString() },
 408         { "headless -open examples/uniref50.fa", " -pfam",
 409             workingDir + "test_uniref50_out.pfam", true, MINFILESIZE_SMALL,
 410             TEST_TIMEOUT, FileFormat.Pfam.toString() },
 411         { "headless -open examples/uniref50.fa", " -blc",
 412             workingDir + "test_uniref50_out.blc", true, MINFILESIZE_SMALL,
 413             TEST_TIMEOUT, FileFormat.BLC.toString() },
 414         { "headless -open examples/uniref50.fa", " -jalview",
 415             workingDir + "test_uniref50_out.jvp", true, MINFILESIZE_SMALL,
 416             TEST_TIMEOUT, FileFormat.Jalview.toString() }, };
 417   }
 418 }