Fix problem with test data for RNAalifold
[jabaws.git] / webservices / compbio / ws / client / WSTester.java
index a0e635b..483c162 100644 (file)
@@ -1,6 +1,6 @@
-/* Copyright (c) 2009 Peter Troshin\r
+/* Copyright (c) 2011 Peter Troshin\r
  *  \r
- *  JAva Bioinformatics Analysis Web Services (JABAWS) @version: 1.0     \r
+ *  JAva Bioinformatics Analysis Web Services (JABAWS) @version: 2.0     \r
  * \r
  *  This library is free software; you can redistribute it and/or modify it under the terms of the\r
  *  Apache License version 2 as published by the Apache Software Foundation\r
@@ -26,10 +26,11 @@ import java.io.ByteArrayInputStream;
 import java.io.Closeable;\r
 import java.io.IOException;\r
 import java.io.PrintWriter;\r
+import java.net.ConnectException;\r
 import java.util.Arrays;\r
 import java.util.List;\r
 \r
-import org.apache.log4j.Logger;\r
+import javax.xml.ws.WebServiceException;\r
 \r
 import compbio.data.msa.JABAService;\r
 import compbio.data.msa.Metadata;\r
@@ -40,16 +41,13 @@ import compbio.data.sequence.FastaSequence;
 import compbio.data.sequence.ScoreManager;\r
 import compbio.data.sequence.SequenceUtil;\r
 import compbio.metadata.JobStatus;\r
-import compbio.metadata.JobSubmissionException;\r
 import compbio.metadata.Limit;\r
 import compbio.metadata.LimitsManager;\r
 import compbio.metadata.Option;\r
 import compbio.metadata.Preset;\r
 import compbio.metadata.PresetManager;\r
-import compbio.metadata.ResultNotAvailableException;\r
 import compbio.metadata.RunnerConfig;\r
 import compbio.metadata.UnsupportedRuntimeException;\r
-import compbio.metadata.WrongParameterException;\r
 import compbio.util.FileUtil;\r
 import compbio.util.Util;\r
 \r
@@ -62,22 +60,24 @@ import compbio.util.Util;
  */\r
 public class WSTester {\r
 \r
-       private static Logger log = Logger.getLogger(WSTester.class);\r
        /**\r
         * Sequences to be used as input for all WS\r
         */\r
-       static final String fastaInput = ">Foo\n"\r
+       public static final String fastaInput = ">Foo\n"\r
                        + "MTADGPRELLQLRAAVRHRPQDFVAWLMLADAELGMGDTTAGEMAVQRGLALHPGHPEAV"\r
                        + "\n>Bar\n"\r
-                       + "ASDAAPEHPGIALWLHALEDAGQAEAAAAYTRAHQLLPEEPYITAQLLNAVA";\r
+                       + "ASDAAPEHPGIALWLHALEDAGQAEAAAAYTRAHQLLPEEPYITAQLLNAVA\n";\r
 \r
-       static final String fastaAlignment = ">Foo\r\n"\r
-                       + "MTADGPRELLQLRAAVRHRPQDFVAWLMLADAELGMGDTTAGEMAVQRGLALHPGHPEAV--------\r\n"\r
-                       + ">Bar\r\n"\r
-                       + "ASDAAPEH------------PGIALWLHALE-DAGQAEAAA---AYTRAHQLLPEEPYITAQLLNAVA\r\n"\r
+       public static final String fastaAlignment = ">Foo\n"\r
+                       + "MTADGPRELLQLRAAVRHRPQDFVAWLMLADAELGMGDTTAGEMAVQRGLALHPGHPEAV--------\n"\r
+                       + ">Bar\n"\r
+                       + "ASDAAPEH------------PGIALWLHALE-DAGQAEAAA---AYTRAHQLLPEEPYITAQLLNAVA\n"\r
                        + "";\r
 \r
-       static final List<FastaSequence> seqs = loadSeqs();\r
+       public static final String fastaRNAAlignment = ">Foo\n"\r
+                       + "C-UUGCGUUAAUGAGAACAGAAACG-UAAA--CUAUAA-CCUAG-G-GGUUUCUGUUGGAUGGUUG----GCAAC\n"\r
+                       + ">Bar\n"\r
+                       + "G-UGGCGCUUAUGACGCAGUUGUCU-UAAA-CUCGAAC--UCGA-GCGGGCAAUUGCUGAU-UACGAUUAACCAC\n";\r
 \r
        private static final String FAILED = "FAILED";\r
        private static final String OK = "OK";\r
@@ -103,7 +103,7 @@ public class WSTester {
        /**\r
         * Converting input to a form accepted by WS\r
         * \r
-        * @return List of FastaSequence records\r
+        * @return List of FastaSequence records with aligned protein sequences\r
         */\r
        private static List<FastaSequence> loadAlignment() {\r
                try {\r
@@ -115,10 +115,33 @@ public class WSTester {
                }\r
                return null;\r
        }\r
+       /**\r
+        * Converting input to a form accepted by WS\r
+        * \r
+        * @return List of FastaSequence records with aligned RNA sequences\r
+        */\r
+       private static List<FastaSequence> loadRNAAlignment() {\r
+               try {\r
+                       return SequenceUtil.readFasta(new ByteArrayInputStream(fastaRNAAlignment.getBytes()));\r
+               } catch (IOException ignored) {\r
+                       // Should not happen as a source is not a external stream\r
+                       ignored.printStackTrace();\r
+               }\r
+               return null;\r
+       }\r
 \r
        private final PrintWriter writer;\r
        private final String hostname;\r
 \r
+       /**\r
+        * Construct an instance of JABAWS tester\r
+        * \r
+        * @param hostname\r
+        *            - fully qualified host and context name of JABAWS e.g.\r
+        *            http://nanna.cluster.lifesci.dundee.ac.uk:8080/jaba\r
+        * @param writer\r
+        *            a PrintWriter instance to writer test log to.\r
+        */\r
        public WSTester(String hostname, PrintWriter writer) {\r
                if (Util.isEmpty(hostname)) {\r
                        throw new NullPointerException("Hostname must be provided!");\r
@@ -164,45 +187,28 @@ public class WSTester {
                        writer.print("Aligning with preset '" + preset.getName() + "'... ");\r
                        Alignment al = null;\r
                        try {\r
-                               String taskId = msaws.presetAlign(seqs, preset);\r
+                               String taskId = msaws.presetAlign(loadSeqs(), preset);\r
                                al = msaws.getResult(taskId);\r
                                if (al != null) {\r
                                        writer.println(OK);\r
                                }\r
                                succeed = true;\r
-                       } catch (UnsupportedRuntimeException e) {\r
-                               writer.println(FAILED);\r
-                               // If executable is not supported than none of the presets are\r
-                               // going to work\r
-                               throw new UnsupportedRuntimeException(e);\r
-                       } catch (JobSubmissionException e) {\r
-                               // TODO custom message\r
-                               writer.println(FAILED);\r
-                               writer.println();\r
-                               writer.println(e.getLocalizedMessage());\r
-                               e.printStackTrace(writer);\r
-                               continue;\r
-                       } catch (WrongParameterException e) {\r
-                               // TODO custom message\r
-                               writer.println(FAILED);\r
-                               writer.println();\r
-                               writer.println(e.getLocalizedMessage());\r
-                               e.printStackTrace(writer);\r
-                               continue;\r
-                       } catch (ResultNotAvailableException e) {\r
-                               // TODO custom message\r
-                               writer.println(FAILED);\r
-                               writer.println();\r
-                               writer.println(e.getLocalizedMessage());\r
-                               e.printStackTrace(writer);\r
+                       } catch (Exception e) {\r
+                               if (e instanceof UnsupportedRuntimeException) {\r
+                                       // If executable is not supported than none of the presets\r
+                                       // are\r
+                                       // going to work\r
+                                       throw (UnsupportedRuntimeException) e;\r
+                               } else {\r
+                                       reportException(e);\r
+                               }\r
                                continue;\r
                        }\r
                }\r
                return succeed;\r
        }\r
 \r
-       private <T> boolean testMsaWS(MsaWS<T> msaws)\r
-                       throws UnsupportedRuntimeException {\r
+       private <T> boolean testMsaWS(MsaWS<T> msaws) throws Exception {\r
                assert msaws != null;\r
 \r
                boolean succeed = testDefaultAlignment(msaws);\r
@@ -217,6 +223,7 @@ public class WSTester {
                testMetadata(msaws);\r
                return succeed;\r
        }\r
+       \r
        /**\r
         * Call most of web services functions and check the output\r
         * \r
@@ -229,7 +236,7 @@ public class WSTester {
         *             executable does not exists for a server platform\r
         */\r
        @SuppressWarnings("unchecked")\r
-       private <T> boolean checkService(JABAService wservice) {\r
+       private <T> boolean checkService(JABAService wservice, Services service) {\r
                try {\r
                        if (wservice == null) {\r
                                throw new NullPointerException(\r
@@ -239,32 +246,37 @@ public class WSTester {
                        if (wservice instanceof MsaWS) {\r
                                return testMsaWS((MsaWS<T>) wservice);\r
                        } else if (wservice instanceof SequenceAnnotation) {\r
-                               return testSequenceAnnotationWS((SequenceAnnotation<T>) wservice);\r
+                               return testSequenceAnnotationWS(\r
+                                               (SequenceAnnotation<T>) wservice, service);\r
                        } else {\r
                                throw new UnsupportedOperationException("The service: "\r
                                                + wservice.getClass() + " is not supported! ");\r
                        }\r
-               } catch (UnsupportedRuntimeException e) {\r
-                       writer.println(e.getLocalizedMessage());\r
-                       e.printStackTrace(writer);\r
+               } catch (Exception e) {\r
+                       reportException(e);\r
                        return false;\r
                }\r
        }\r
 \r
-       private <T> boolean testSequenceAnnotationWS(SequenceAnnotation<T> wservice)\r
-                       throws UnsupportedRuntimeException {\r
-               writer.println("Calling analyse.........");\r
-               boolean success = testDefaultAnalyse(loadAlignment(), wservice, null,\r
-                               null);\r
+       private <T> boolean testSequenceAnnotationWS(\r
+                       SequenceAnnotation<T> wservice, Services service) throws Exception {\r
+               writer.print("Calling analyse.........");\r
+\r
+               List<FastaSequence> input = loadSeqs();\r
+               if (service == Services.AAConWS ) {\r
+                       input = loadAlignment();\r
+               } else if (service == Services.RNAalifoldWS) {\r
+                       input = loadRNAAlignment();\r
+               }\r
+               boolean success = testDefaultAnalyse(input, wservice, null, null);\r
 \r
                PresetManager<T> presetman = wservice.getPresets();\r
                if (presetman != null) {\r
                        List<Preset<T>> presets = presetman.getPresets();\r
                        if (presets != null && !presets.isEmpty()) {\r
                                Preset<T> preset = presets.get(0);\r
-                               writer.println("Calling analyse with Preset.........");\r
-                               success = testDefaultAnalyse(loadAlignment(), wservice, preset,\r
-                                               null);\r
+                               writer.print("Calling analyse with Preset.........");\r
+                               success = testDefaultAnalyse(input, wservice, preset, null);\r
                        }\r
                }\r
                testMetadata(wservice);\r
@@ -273,43 +285,35 @@ public class WSTester {
 \r
        private <T> boolean testDefaultAnalyse(List<FastaSequence> fastalist,\r
                        SequenceAnnotation<T> wsproxy, Preset<T> preset,\r
-                       List<Option<T>> customOptions) throws UnsupportedRuntimeException {\r
+                       List<Option<T>> customOptions) throws Exception {\r
 \r
                ScoreManager scores = null;\r
-               try {\r
-                       String jobId = null;\r
-                       if (customOptions != null) {\r
-                               jobId = wsproxy.customAnalize(fastalist, customOptions);\r
-                       } else if (preset != null) {\r
-                               jobId = wsproxy.presetAnalize(fastalist, preset);\r
-                       } else {\r
-                               jobId = wsproxy.analize(fastalist);\r
-                       }\r
-                       Thread.sleep(1000);\r
-                       scores = wsproxy.getAnnotation(jobId);\r
-\r
-               } catch (JobSubmissionException e) {\r
-                       writer.println("Exception while submitting job to a web server. "\r
-                                       + "Exception details are below:");\r
-                       e.printStackTrace(writer);\r
-               } catch (ResultNotAvailableException e) {\r
-                       writer.println("Exception while waiting for results. "\r
-                                       + "Exception details are below:");\r
-                       e.printStackTrace(writer);\r
-               } catch (InterruptedException e) {\r
-                       // ignore and propagate an interruption\r
-                       Thread.currentThread().interrupt();\r
-                       writer.println("Exception while waiting for results. "\r
-                                       + "Exception details are below:");\r
-                       e.printStackTrace(writer);\r
-               } catch (WrongParameterException e) {\r
-                       writer.println("Exception while parsing the web method input parameters. "\r
-                                       + "Exception details are below:");\r
-                       e.printStackTrace(writer);\r
+\r
+               String jobId = null;\r
+               if (customOptions != null) {\r
+                       jobId = wsproxy.customAnalize(fastalist, customOptions);\r
+               } else if (preset != null) {\r
+                       jobId = wsproxy.presetAnalize(fastalist, preset);\r
+               } else {\r
+                       jobId = wsproxy.analize(fastalist);\r
+               }\r
+               Thread.sleep(1000);\r
+               scores = wsproxy.getAnnotation(jobId);\r
+               if (scores != null) {\r
+                       writer.println(OK);\r
                }\r
+\r
                return scores != null;\r
        }\r
 \r
+       private void reportException(Exception e) {\r
+               writer.println(FAILED);\r
+               writer.println("Exception while waiting for results. "\r
+                               + "Exception details are below:");\r
+               writer.println(e.getLocalizedMessage());\r
+               e.printStackTrace(writer);\r
+       }\r
+\r
        private <T> void testMetadata(Metadata<T> msaws)\r
                        throws UnsupportedRuntimeException {\r
 \r
@@ -333,6 +337,7 @@ public class WSTester {
                LimitsManager<T> limits = msaws.getLimits();\r
                if (limits != null && limits.getLimits().size() > 0) {\r
                        writer.println(OK);\r
+                       // writer.println("Limits details: \n" + limits.toString());\r
                } else {\r
                        writer.println(UNSUPPORTED);\r
                }\r
@@ -354,38 +359,28 @@ public class WSTester {
         * @param msaws\r
         * @throws UnsupportedRuntimeException\r
         */\r
-       private <T> boolean testDefaultAlignment(MsaWS<T> msaws)\r
-                       throws UnsupportedRuntimeException {\r
+       private <T> boolean testDefaultAlignment(MsaWS<T> msaws) throws Exception {\r
                writer.print("Testing alignment with default parameters:");\r
                Alignment al = null;\r
                boolean succeed = false;\r
-               try {\r
-                       String taskId = msaws.align(seqs);\r
-                       writer.print("\nQuerying job status...");\r
-                       JobStatus status = msaws.getJobStatus(taskId);\r
-                       while (status != JobStatus.FINISHED) {\r
-                               Thread.sleep(1000);\r
-                               status = msaws.getJobStatus(taskId);\r
-                       }\r
-                       writer.println(OK);\r
-                       writer.print("Retrieving results...");\r
-                       al = msaws.getResult(taskId);\r
-                       succeed = true;\r
-               } catch (Exception e) {\r
-                       if (e instanceof UnsupportedRuntimeException) {\r
-                               throw (UnsupportedRuntimeException) e;\r
-                       } else {\r
-                               writer.println(FAILED);\r
-                               writer.println(e.getLocalizedMessage());\r
-                               e.printStackTrace(writer);\r
-                       }\r
+\r
+               String taskId = msaws.align(loadSeqs());\r
+               writer.print("\nQuerying job status...");\r
+               JobStatus status = msaws.getJobStatus(taskId);\r
+               while (status != JobStatus.FINISHED) {\r
+                       Thread.sleep(1000);\r
+                       status = msaws.getJobStatus(taskId);\r
                }\r
+               writer.println(OK);\r
+               writer.print("Retrieving results...");\r
+               al = msaws.getResult(taskId);\r
+               succeed = true;\r
                if (al != null) {\r
                        writer.println(OK);\r
                }\r
                return succeed;\r
        }\r
-\r
+       \r
        /**\r
         * Test JWS2 web services\r
         * \r
@@ -435,10 +430,19 @@ public class WSTester {
                        tester.writer.println();\r
                        tester.checkService(serv);\r
                }\r
-\r
        }\r
 \r
-       public boolean checkService(Services service) {\r
+       /**\r
+        * Test JABA web service\r
+        * \r
+        * @param service\r
+        *            the service to test\r
+        * @return true if the service works as expected, false otherwise\r
+        * @throws WebServiceException\r
+        * @throws ConnectException\r
+        */\r
+       public boolean checkService(Services service) throws ConnectException,\r
+                       WebServiceException {\r
                JABAService ws = Jws2Client.connect(hostname, service);\r
                if (ws == null) {\r
                        writer.println("Cannot estabilish the connection to host "\r
@@ -448,7 +452,7 @@ public class WSTester {
                boolean succeed = false;\r
                try {\r
                        writer.println("Checking service " + service.toString());\r
-                       succeed = checkService(ws);\r
+                       succeed = checkService(ws, service);\r
                } finally {\r
                        FileUtil.closeSilently(((Closeable) ws));\r
                }\r
@@ -458,11 +462,9 @@ public class WSTester {
 \r
        private void reportResults(Services serv, boolean succeed) {\r
                if (succeed) {\r
-                       writer.println("Check is completed. The Service " + serv\r
-                                       + " IS WORKING\n");\r
+                       writer.println("Check is completed. The Service " + serv + " IS WORKING\n");\r
                } else {\r
-                       writer.println("Check is completed. The Service " + serv\r
-                                       + " HAS SOME PROBLEMS\n");\r
+                       writer.println("Check is aborted. The Service " + serv + " HAS SOME PROBLEMS\n");\r
                }\r
        }\r
 }\r