Switch JpredWS from SequenceAnnotation to MsaWS
[jabaws.git] / webservices / compbio / ws / client / WSTester.java
index 7091f02..bae843b 100644 (file)
@@ -1,6 +1,7 @@
-/* Copyright (c) 2009 Peter Troshin\r
+/* Copyright (c) 2011 Peter Troshin\r
+ * Copyright (c) 2013 Alexander Sherstnev\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 +27,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
@@ -55,30 +57,27 @@ import compbio.util.Util;
  * \r
  * @author pvtroshin\r
  * \r
- * @version 1.0 February 2010\r
+ * @version 1.5 February 2013\r
  */\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
+        * Test sequences to be used as input for WS\r
         */\r
-       static final String fastaInput = ">Foo\n"\r
-                       + "MTADGPRELLQLRAAVRHRPQDFVAWLMLADAELGMGDTTAGEMAVQRGLALHPGHPEAV"\r
-                       + "\n>Bar\n"\r
-                       + "ASDAAPEHPGIALWLHALEDAGQAEAAAAYTRAHQLLPEEPYITAQLLNAVA";\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
-                       + "";\r
-\r
-       static final List<FastaSequence> seqs = loadSeqs();\r
+       public static final String fastaInput2records = \r
+                       ">Foo\nMTADGPRELLQLRAAVRHRPQDFVAWLMLADAELGMGDTTAGEMAVQRGLALHPGHPEAV\n"\r
+               +   ">Bar\nASDAAPEHPGIALWLHALEDAGQAEAAAAYTRAHQLLPEEPYITAQLLNAVA\n";\r
+       public static final String fastaInput1record = \r
+                       ">Foo\nMTADGPRELLQLRAAVRHRPQDFVAWLMLADAELGMGDTTAGEMAVQRGLALHPGHPEAV\n";\r
+       public static final String fastaAlignment = \r
+                       ">Foo\nMTADGPRELLQLRAAVRHRPQDFVAWLMLADAELGMGDTTAGEMAVQRGLALHPGHPEAV--------\n"\r
+               +   ">Bar\nASDAAPEH------------PGIALWLHALE-DAGQAEAAA---AYTRAHQLLPEEPYITAQLLNAVA\n";\r
 \r
+       /**\r
+        * Status strings\r
+        */\r
        private static final String FAILED = "FAILED";\r
        private static final String OK = "OK";\r
-\r
        private static final String UNSUPPORTED = "UNSUPPORTED";\r
 \r
        /**\r
@@ -86,10 +85,12 @@ public class WSTester {
         * \r
         * @return List of FastaSequence records\r
         */\r
-       private static List<FastaSequence> loadSeqs() {\r
+       private static List<FastaSequence> loadSeqs(int nLines) {\r
                try {\r
-                       return SequenceUtil.readFasta(new ByteArrayInputStream(fastaInput\r
-                                       .getBytes()));\r
+                       if (nLines == 1) {\r
+                               return SequenceUtil.readFasta(new ByteArrayInputStream(fastaInput1record.getBytes()));\r
+                       }\r
+                       return SequenceUtil.readFasta(new ByteArrayInputStream(fastaInput2records.getBytes()));\r
                } catch (IOException ignored) {\r
                        // Should not happen as a source is not a external stream\r
                        ignored.printStackTrace();\r
@@ -116,6 +117,15 @@ public class WSTester {
        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
@@ -132,12 +142,10 @@ public class WSTester {
                                + pseparator + "host_and_context " + "<" + servicekey\r
                                + pseparator + "serviceName>");\r
                System.out.println();\r
-               System.out\r
-                               .println(hostkey\r
+               System.out.println(hostkey\r
                                                + pseparator\r
                                                + "<host_and_context> - a full URL to the JABAWS web server including context path e.g. http://10.31.1.159:8080/ws");\r
-               System.out\r
-                               .println(servicekey\r
+               System.out.println(servicekey\r
                                                + pseparator\r
                                                + "<ServiceName> - optional if unspecified all services are tested otherwise one of "\r
                                                + Arrays.toString(Services.values()));\r
@@ -161,7 +169,7 @@ 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(2), preset);\r
                                al = msaws.getResult(taskId);\r
                                if (al != null) {\r
                                        writer.println(OK);\r
@@ -182,10 +190,10 @@ public class WSTester {
                return succeed;\r
        }\r
 \r
-       private <T> boolean testMsaWS(MsaWS<T> msaws) throws Exception {\r
+       private <T> boolean testMsaWS(MsaWS<T> msaws, Services service) throws Exception {\r
                assert msaws != null;\r
 \r
-               boolean succeed = testDefaultAlignment(msaws);\r
+               boolean succeed = testDefaultAlignment(msaws, service);\r
                // If exception above is thrown than the tests below is not run\r
 \r
                PresetManager<T> pmanager = msaws.getPresets();\r
@@ -209,20 +217,19 @@ 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
-                                               "JABAService instance must be provided!");\r
+                               throw new NullPointerException("JABAService instance must be provided!");\r
                        }\r
 \r
                        if (wservice instanceof MsaWS) {\r
-                               return testMsaWS((MsaWS<T>) wservice);\r
+                               return testMsaWS((MsaWS<T>) wservice, service);\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
+                               throw new UnsupportedOperationException("The service: " + wservice.getClass() + " is not supported! ");\r
                        }\r
                } catch (Exception e) {\r
                        reportException(e);\r
@@ -230,11 +237,15 @@ public class WSTester {
                }\r
        }\r
 \r
-       private <T> boolean testSequenceAnnotationWS(SequenceAnnotation<T> wservice)\r
-                       throws Exception {\r
+       private <T> boolean testSequenceAnnotationWS(\r
+                       SequenceAnnotation<T> wservice, Services service) throws Exception {\r
                writer.print("Calling analyse.........");\r
-               boolean success = testDefaultAnalyse(loadAlignment(), wservice, null,\r
-                               null);\r
+\r
+               List<FastaSequence> input = loadSeqs(2);\r
+               if (service == Services.AAConWS) {\r
+                       input = loadAlignment();\r
+               }\r
+               boolean success = testDefaultAnalyse(input, wservice, null, null);\r
 \r
                PresetManager<T> presetman = wservice.getPresets();\r
                if (presetman != null) {\r
@@ -242,8 +253,7 @@ public class WSTester {
                        if (presets != null && !presets.isEmpty()) {\r
                                Preset<T> preset = presets.get(0);\r
                                writer.print("Calling analyse with Preset.........");\r
-                               success = testDefaultAnalyse(loadAlignment(), wservice, preset,\r
-                                               null);\r
+                               success = testDefaultAnalyse(input, wservice, preset, null);\r
                        }\r
                }\r
                testMetadata(wservice);\r
@@ -304,6 +314,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
@@ -325,12 +336,17 @@ public class WSTester {
         * @param msaws\r
         * @throws UnsupportedRuntimeException\r
         */\r
-       private <T> boolean testDefaultAlignment(MsaWS<T> msaws) throws Exception {\r
+       private <T> boolean testDefaultAlignment(MsaWS<T> msaws, Services service) throws Exception {\r
                writer.print("Testing alignment with default parameters:");\r
                Alignment al = null;\r
                boolean succeed = false;\r
+               String taskId;\r
 \r
-               String taskId = msaws.align(seqs);\r
+               if (service == Services.JpredWS) {\r
+                       taskId = msaws.align(loadSeqs(1));\r
+               } else {\r
+                       taskId = msaws.align(loadSeqs(2));\r
+               }\r
                writer.print("\nQuerying job status...");\r
                JobStatus status = msaws.getJobStatus(taskId);\r
                while (status != JobStatus.FINISHED) {\r
@@ -368,8 +384,7 @@ public class WSTester {
                String host = CmdHelper.getHost(args);\r
                String serviceName = CmdHelper.getServiceName(args);\r
                if (!Jws2Client.validURL(host)) {\r
-                       System.err\r
-                                       .println("<host_and_context> parameter is not provided or is incorrect!");\r
+                       System.err.println("<host_and_context> parameter is not provided or is incorrect!");\r
                        System.exit(1);\r
                }\r
                WSTester tester = new WSTester(host, new PrintWriter(System.out, true));\r
@@ -377,8 +392,7 @@ public class WSTester {
                if (serviceName != null) {\r
                        Services service = Services.getService(serviceName);\r
                        if (service == null) {\r
-                               tester.writer.println("Service '" + serviceName\r
-                                               + "' is not supported. Valid values are: "\r
+                               tester.writer.println("Service '" + serviceName + "' is not supported. Valid values are: "\r
                                                + Arrays.toString(Services.values()));\r
                                tester.writer.println();\r
                                printUsage();\r
@@ -388,8 +402,7 @@ public class WSTester {
                        System.exit(0);\r
                }\r
 \r
-               tester.writer\r
-                               .println("<ServiceName> is not provided checking all known services...");\r
+               tester.writer.println("<ServiceName> is not provided checking all known services...");\r
 \r
                for (Services serv : Services.values()) {\r
                        tester.writer.println();\r
@@ -398,17 +411,27 @@ public class WSTester {
 \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
-                                       + hostname + " with service " + service.toString());\r
+                       String line = "Cannot estabilish the connection to host " + hostname + " with service ";\r
+                       writer.println(line + service.toString());\r
                        return false;\r
                }\r
                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
@@ -418,11 +441,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 aborted. 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