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