-/* 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
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
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
* \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
* \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
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
+ 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
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
}\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, 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
* 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 (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(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
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
\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
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
* @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, Services service) 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
+ String taskId;\r
+\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
+ 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
* Test JWS2 web services\r
* \r
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
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
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
\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
\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
git://source.jalview.org / jabaws.git / blobdiff