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.util.ArrayList;
  33
  34 import org.testng.Assert;
  35 import org.testng.FileAssert;
  36 import org.testng.annotations.BeforeClass;
  37 import org.testng.annotations.BeforeTest;
  38 import org.testng.annotations.DataProvider;
  39 import org.testng.annotations.Test;
  40
  41 import io.github.classgraph.ClassGraph;
  42 import io.github.classgraph.ScanResult;
  43
  44 public class CommandLineOperations
  45 {
  46
  47   @BeforeClass(alwaysRun = true)
  48   public void setUpJvOptionPane()
  49   {
  50     JvOptionPane.setInteractiveMode(false);
  51     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  52   }
  53
  54   private static final int TEST_TIMEOUT = 9000; // Note longer timeout needed on
  55                                                 // full test run than on
  56                                                 // individual tests
  57
  58   private static final int SETUP_TIMEOUT = 9000;
  59
  60   private static final int MINFILESIZE_SMALL = 2096;
  61
  62   private static final int MINFILESIZE_BIG = 4096;
  63
  64   private ArrayList<String> successfulCMDs = new ArrayList<>();
  65
  66   /***
  67    * from
  68    * http://stackoverflow.com/questions/808276/how-to-add-a-timeout-value-when
  69    * -using-javas-runtime-exec
  70    *
  71    * @author jimp
  72    *
  73    */
  74   private static class Worker extends Thread
  75   {
  76     private final Process process;
  77
  78     private BufferedReader outputReader;
  79
  80     private BufferedReader errorReader;
  81
  82     private Integer exit;
  83
  84     private Worker(Process process)
  85     {
  86       this.process = process;
  87     }
  88
  89     @Override
  90     public void run()
  91     {
  92       try
  93       {
  94         exit = process.waitFor();
  95       } catch (InterruptedException ignore)
  96       {
  97         return;
  98       }
  99     }
 100
 101     public BufferedReader getOutputReader()
 102     {
 103       return outputReader;
 104     }
 105
 106     public void setOutputReader(BufferedReader outputReader)
 107     {
 108       this.outputReader = outputReader;
 109     }
 110
 111     public BufferedReader getErrorReader()
 112     {
 113       return errorReader;
 114     }
 115
 116     public void setErrorReader(BufferedReader errorReader)
 117     {
 118       this.errorReader = errorReader;
 119     }
 120   }
 121
 122   private static ClassGraph scanner = null;
 123
 124   private static String classpath = null;
 125
 126   public synchronized static String getClassPath()
 127   {
 128     if (scanner == null)
 129     {
 130       scanner = new ClassGraph();
 131       ScanResult scan = scanner.scan();
 132       classpath = scan.getClasspath();
 133     }
 134     while (classpath == null)
 135     {
 136       try
 137       {
 138         Thread.sleep(10);
 139       } catch (InterruptedException x)
 140       {
 141
 142       }
 143     }
 144     return classpath;
 145   }
 146
 147   private Worker getJalviewDesktopRunner(boolean withAwt, String cmd,
 148           int timeout)
 149   {
 150     // Note: JAL-3065 - don't include quotes for lib/* because the arguments are
 151     // not expanded by the shell
 152     String classpath = getClassPath();
 153     String _cmd = "java "
 154             + (withAwt ? "-Djava.awt.headless=true" : "")
 155             + " -classpath " + classpath + " jalview.bin.Jalview ";
 156     Process ls2_proc = null;
 157     Worker worker = null;
 158     try
 159     {
 160       ls2_proc = Runtime.getRuntime().exec(_cmd + cmd);
 161     } catch (Throwable e1)
 162     {
 163       e1.printStackTrace();
 164     }
 165     if (ls2_proc != null)
 166     {
 167       BufferedReader outputReader = new BufferedReader(
 168               new InputStreamReader(ls2_proc.getInputStream()));
 169       BufferedReader errorReader = new BufferedReader(
 170               new InputStreamReader(ls2_proc.getErrorStream()));
 171       worker = new Worker(ls2_proc);
 172       worker.start();
 173       try
 174       {
 175         worker.join(timeout);
 176       } catch (InterruptedException e)
 177       {
 178         System.err.println("Thread interrupted");
 179       }
 180       worker.setOutputReader(outputReader);
 181       worker.setErrorReader(errorReader);
 182     }
 183     return worker;
 184   }
 185
 186   @BeforeTest(alwaysRun = true)
 187   public void initialize()
 188   {
 189     new CommandLineOperations();
 190   }
 191
 192   @BeforeTest(alwaysRun = true)
 193   public void setUpForHeadlessCommandLineInputOperations()
 194           throws IOException
 195   {
 196     String cmds = "nodisplay -open examples/uniref50.fa -sortbytree -props test/jalview/io/testProps.jvprops -colour zappo "
 197             + "-jabaws http://www.compbio.dundee.ac.uk/jabaws -nosortbytree "
 198             + "-features examples/testdata/plantfdx.features -annotations examples/testdata/plantfdx.annotations -tree examples/testdata/uniref50_test_tree";
 199     Worker worker = getJalviewDesktopRunner(true, cmds, SETUP_TIMEOUT);
 200     String ln = null;
 201     while ((ln = worker.getOutputReader().readLine()) != null)
 202     {
 203       System.out.println(ln);
 204       successfulCMDs.add(ln);
 205     }
 206     while ((ln = worker.getErrorReader().readLine()) != null)
 207     {
 208       System.err.println(ln);
 209     }
 210   }
 211
 212   @BeforeTest(alwaysRun = true)
 213   public void setUpForCommandLineInputOperations() throws IOException
 214   {
 215     String cmds = "-open examples/uniref50.fa -noquestionnaire -nousagestats";
 216     Worker worker = getJalviewDesktopRunner(false, cmds, SETUP_TIMEOUT);
 217     String ln = null;
 218     int count = 0;
 219     while ((ln = worker.getErrorReader().readLine()) != null)
 220     {
 221       System.out.println(ln);
 222       successfulCMDs.add(ln);
 223       if (++count > 5)
 224       {
 225         break;
 226       }
 227     }
 228     if (worker != null && worker.exit == null)
 229     {
 230       worker.interrupt();
 231       Thread.currentThread().interrupt();
 232       worker.process.destroy();
 233     }
 234   }
 235
 236   @Test(groups = { "Functional" }, dataProvider = "allInputOperationsData")
 237   public void testAllInputOperations(String expectedString,
 238           String failureMsg)
 239   {
 240     Assert.assertTrue(successfulCMDs.contains(expectedString), failureMsg);
 241   }
 242
 243   @Test(
 244     groups = { "Functional" },
 245     dataProvider = "headlessModeOutputOperationsData")
 246   public void testHeadlessModeOutputOperations(String harg, String type,
 247           String fileName, boolean withAWT, int expectedMinFileSize,
 248           int timeout)
 249   {
 250     String cmd = harg + type + " " + fileName;
 251     // System.out.println(">>>>>>>>>>>>>>>> Command : " + cmd);
 252     File file = new File(fileName);
 253     Worker worker = getJalviewDesktopRunner(withAWT, cmd, timeout);
 254     assertNotNull(worker, "worker is null");
 255     String msg = "Didn't create an output" + type + " file.[" + harg + "]";
 256     assertTrue(file.exists(), msg);
 257     FileAssert.assertFile(file, msg);
 258     FileAssert.assertMinLength(file, expectedMinFileSize);
 259     if (worker != null && worker.exit == null)
 260     {
 261       worker.interrupt();
 262       Thread.currentThread().interrupt();
 263       worker.process.destroy();
 264       Assert.fail("Jalview did not exit after "
 265               + type
 266               + " generation (try running test again to verify - timeout at "
 267               + SETUP_TIMEOUT + "ms). ["
 268               + harg + "]");
 269     }
 270     file.delete();
 271   }
 272
 273   @DataProvider(name = "allInputOperationsData")
 274   public Object[][] getHeadlessModeInputParams()
 275   {
 276     return new Object[][] {
 277         // headless mode input operations
 278         { "CMD [-color zappo] executed successfully!",
 279             "Failed command : -color zappo" },
 280         { "CMD [-props test/jalview/io/testProps.jvprops] executed successfully!",
 281             "Failed command : -props File" },
 282         { "CMD [-sortbytree] executed successfully!",
 283             "Failed command : -sortbytree" },
 284         { "CMD [-jabaws http://www.compbio.dundee.ac.uk/jabaws] executed successfully!",
 285             "Failed command : -jabaws http://www.compbio.dundee.ac.uk/jabaws" },
 286         { "CMD [-open examples/uniref50.fa] executed successfully!",
 287             "Failed command : -open examples/uniref50.fa" },
 288         { "CMD [-nosortbytree] executed successfully!",
 289             "Failed command : -nosortbytree" },
 290         { "CMD [-features examples/testdata/plantfdx.features]  executed successfully!",
 291             "Failed command : -features examples/testdata/plantfdx.features" },
 292         { "CMD [-annotations examples/testdata/plantfdx.annotations] executed successfully!",
 293             "Failed command : -annotations examples/testdata/plantfdx.annotations" },
 294         { "CMD [-tree examples/testdata/uniref50_test_tree] executed successfully!",
 295             "Failed command : -tree examples/testdata/uniref50_test_tree" },
 296         // non headless mode input operations
 297         { "CMD [-nousagestats] executed successfully!",
 298             "Failed command : -nousagestats" },
 299         { "CMD [-noquestionnaire] executed successfully!",
 300             "Failed command : -noquestionnaire" } };
 301   }
 302
 303   @DataProvider(name = "headlessModeOutputOperationsData")
 304   public static Object[][] getHeadlessModeOutputParams()
 305   {
 306     return new Object[][] {
 307         { "nodisplay -open examples/uniref50.fa", " -eps",
 308             "test/jalview/bin/test_uniref50_out.eps", true, MINFILESIZE_BIG,
 309             TEST_TIMEOUT },
 310         { "nodisplay -open examples/uniref50.fa", " -eps",
 311             "test/jalview/bin/test_uniref50_out.eps", false,
 312             MINFILESIZE_BIG, TEST_TIMEOUT },
 313         { "nogui -open examples/uniref50.fa", " -eps",
 314             "test/jalview/bin/test_uniref50_out.eps", true, MINFILESIZE_BIG,
 315             TEST_TIMEOUT },
 316         { "nogui -open examples/uniref50.fa", " -eps",
 317             "test/jalview/bin/test_uniref50_out.eps", false,
 318             MINFILESIZE_BIG, TEST_TIMEOUT },
 319         { "headless -open examples/uniref50.fa", " -eps",
 320             "test/jalview/bin/test_uniref50_out.eps", true, MINFILESIZE_BIG,
 321             TEST_TIMEOUT },
 322         { "headless -open examples/uniref50.fa", " -svg",
 323             "test/jalview/bin/test_uniref50_out.svg", false,
 324             MINFILESIZE_BIG, TEST_TIMEOUT },
 325         { "headless -open examples/uniref50.fa", " -png",
 326             "test/jalview/bin/test_uniref50_out.png", true, MINFILESIZE_BIG,
 327             TEST_TIMEOUT },
 328         { "headless -open examples/uniref50.fa", " -html",
 329             "test/jalview/bin/test_uniref50_out.html", true,
 330             MINFILESIZE_BIG, TEST_TIMEOUT },
 331         { "headless -open examples/uniref50.fa", " -fasta",
 332             "test/jalview/bin/test_uniref50_out.mfa", true,
 333             MINFILESIZE_SMALL, TEST_TIMEOUT },
 334         { "headless -open examples/uniref50.fa", " -clustal",
 335             "test/jalview/bin/test_uniref50_out.aln", true,
 336             MINFILESIZE_SMALL, TEST_TIMEOUT },
 337         { "headless -open examples/uniref50.fa", " -msf",
 338             "test/jalview/bin/test_uniref50_out.msf", true,
 339             MINFILESIZE_SMALL, TEST_TIMEOUT },
 340         { "headless -open examples/uniref50.fa", " -pileup",
 341             "test/jalview/bin/test_uniref50_out.aln", true,
 342             MINFILESIZE_SMALL, TEST_TIMEOUT },
 343         { "headless -open examples/uniref50.fa", " -pir",
 344             "test/jalview/bin/test_uniref50_out.pir", true,
 345             MINFILESIZE_SMALL, TEST_TIMEOUT },
 346         { "headless -open examples/uniref50.fa", " -pfam",
 347             "test/jalview/bin/test_uniref50_out.pfam", true,
 348             MINFILESIZE_SMALL, TEST_TIMEOUT },
 349         { "headless -open examples/uniref50.fa", " -blc",
 350             "test/jalview/bin/test_uniref50_out.blc", true,
 351             MINFILESIZE_SMALL, TEST_TIMEOUT },
 352         { "headless -open examples/uniref50.fa", " -jalview",
 353             "test/jalview/bin/test_uniref50_out.jvp", true,
 354             MINFILESIZE_SMALL, TEST_TIMEOUT }, };
 355   }
 356 }