972e3ff2490a34f3433d9dad5c4ab7a4eafe79a9
[jabaws.git] / testsrc / compbio / runner / disorder / JronnTester.java
1 /* Copyright (c) 2009 Peter Troshin\r
2  *  \r
3  *  JAva Bioinformatics Analysis Web Services (JABAWS) @version: 1.0     \r
4  * \r
5  *  This library is free software; you can redistribute it and/or modify it under the terms of the\r
6  *  Apache License version 2 as published by the Apache Software Foundation\r
7  * \r
8  *  This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without\r
9  *  even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache \r
10  *  License for more details.\r
11  * \r
12  *  A copy of the license is in apache_license.txt. It is also available here:\r
13  * @see: http://www.apache.org/licenses/LICENSE-2.0.txt\r
14  * \r
15  * Any republication or derived work distributed in source code form\r
16  * must include this copyright and license notice.\r
17  */\r
18 \r
19 package compbio.runner.disorder;\r
20 \r
21 import static org.testng.Assert.assertEquals;\r
22 import static org.testng.Assert.assertFalse;\r
23 import static org.testng.Assert.assertNotNull;\r
24 import static org.testng.Assert.assertNull;\r
25 import static org.testng.Assert.assertTrue;\r
26 import static org.testng.Assert.fail;\r
27 \r
28 import java.io.File;\r
29 import java.io.FileInputStream;\r
30 import java.io.FileNotFoundException;\r
31 import java.io.IOException;\r
32 import java.text.ParseException;\r
33 import java.util.Map;\r
34 \r
35 import javax.xml.bind.ValidationException;\r
36 \r
37 import org.ggf.drmaa.DrmaaException;\r
38 import org.ggf.drmaa.JobInfo;\r
39 import org.testng.annotations.BeforeMethod;\r
40 import org.testng.annotations.Test;\r
41 \r
42 import compbio.data.sequence.Score;\r
43 import compbio.engine.AsyncExecutor;\r
44 import compbio.engine.Configurator;\r
45 import compbio.engine.FilePuller;\r
46 import compbio.engine.SyncExecutor;\r
47 import compbio.engine.client.ConfExecutable;\r
48 import compbio.engine.client.ConfiguredExecutable;\r
49 import compbio.engine.client.Executable;\r
50 import compbio.engine.client.RunConfiguration;\r
51 import compbio.engine.cluster.drmaa.ClusterUtil;\r
52 import compbio.engine.cluster.drmaa.JobRunner;\r
53 import compbio.engine.cluster.drmaa.StatisticManager;\r
54 import compbio.engine.local.LocalRunner;\r
55 import compbio.metadata.AllTestSuit;\r
56 import compbio.metadata.ChunkHolder;\r
57 import compbio.metadata.JobExecutionException;\r
58 import compbio.metadata.JobStatus;\r
59 import compbio.metadata.JobSubmissionException;\r
60 import compbio.metadata.LimitsManager;\r
61 import compbio.metadata.PresetManager;\r
62 import compbio.metadata.ResultNotAvailableException;\r
63 import compbio.metadata.RunnerConfig;\r
64 import compbio.util.FileWatcher;\r
65 import compbio.util.SysPrefs;\r
66 \r
67 public class JronnTester {\r
68 \r
69         public static String test_outfile = "TO1381.jronn.out"; // "/homes/pvtroshin/TO1381.clustal.cluster.out\r
70 \r
71         private Jronn jronn;\r
72 \r
73         @BeforeMethod(alwaysRun = true)\r
74         void init() {\r
75                 jronn = new Jronn();\r
76                 jronn.setInput(AllTestSuit.test_input).setOutput(test_outfile);\r
77         }\r
78 \r
79         @Test(groups = {AllTestSuit.test_group_cluster,\r
80                         AllTestSuit.test_group_runner})\r
81         public void testRunOnCluster() {\r
82                 assertFalse(SysPrefs.isWindows,\r
83                                 "Cluster execution can only be in unix environment");\r
84                 try {\r
85                         ConfiguredExecutable<Jronn> confJronn = Configurator\r
86                                         .configureExecutable(jronn, Executable.ExecProvider.Cluster);\r
87                         JobRunner runner = JobRunner.getInstance(confJronn);\r
88 \r
89                         assertNotNull(runner, "Runner is NULL");\r
90                         runner.executeJob();\r
91                         // assertNotNull("JobId is null", jobId1);\r
92                         JobStatus status = runner.getJobStatus();\r
93                         assertTrue(status == JobStatus.PENDING\r
94                                         || status == JobStatus.RUNNING,\r
95                                         "Status of the process is wrong!");\r
96                         JobInfo info = runner.getJobInfo();\r
97                         assertNotNull(info, "JobInfo is null");\r
98                         StatisticManager sm = new StatisticManager(info);\r
99                         assertNotNull(sm, "Statictic manager is null");\r
100                         try {\r
101 \r
102                                 String exits = sm.getExitStatus();\r
103                                 assertNotNull("Exit status is null", exits);\r
104                                 // cut 4 trailing zeros from the number\r
105                                 int exitsInt = ClusterUtil.CLUSTER_STAT_IN_SEC.parse(exits)\r
106                                                 .intValue();\r
107                                 assertEquals(0, exitsInt);\r
108                                 System.out.println(sm.getAllStats());\r
109 \r
110                         } catch (ParseException e) {\r
111                                 e.printStackTrace();\r
112                                 fail("Parse Exception: " + e.getMessage());\r
113                         }\r
114                         // assertFalse(runner.cleanup());\r
115                         assertTrue(sm.hasExited());\r
116                         assertFalse(sm.wasAborted());\r
117                         assertFalse(sm.hasDump());\r
118                         assertFalse(sm.hasSignaled());\r
119 \r
120                 } catch (JobSubmissionException e) {\r
121                         e.printStackTrace();\r
122                         fail("DrmaaException caught:" + e.getMessage());\r
123                 } catch (JobExecutionException e) {\r
124                         e.printStackTrace();\r
125                         fail("DrmaaException caught:" + e.getMessage());\r
126                 } catch (DrmaaException e) {\r
127                         e.printStackTrace();\r
128                         fail("DrmaaException caught:" + e.getMessage());\r
129                 }\r
130         }\r
131 \r
132         /**\r
133          * This tests fails from time to time depending on the cluster load or some\r
134          * other factors. Any client code has to adjust for this issue\r
135          */\r
136         @Test(groups = {AllTestSuit.test_group_cluster,\r
137                         AllTestSuit.test_group_runner})\r
138         public void testRunOnClusterAsync() {\r
139                 assertFalse(SysPrefs.isWindows,\r
140                                 "Cluster execution can only be in unix environment");\r
141                 try {\r
142                         ConfiguredExecutable<Jronn> confJronn = Configurator\r
143                                         .configureExecutable(jronn, Executable.ExecProvider.Cluster);\r
144                         AsyncExecutor aengine = Configurator.getAsyncEngine(confJronn);\r
145                         String jobId = aengine.submitJob(confJronn);\r
146                         assertNotNull(jobId, "Runner is NULL");\r
147                         // let drmaa to start\r
148                         Thread.sleep(500);\r
149                         JobStatus status = aengine.getJobStatus(jobId);\r
150                         while (status != JobStatus.FINISHED) {\r
151                                 System.out.println("Job Status: " + status);\r
152                                 Thread.sleep(1000);\r
153                                 status = aengine.getJobStatus(jobId);\r
154                                 ConfiguredExecutable<Jronn> result = (ConfiguredExecutable<Jronn>) aengine\r
155                                                 .getResults(jobId);\r
156                                 assertNotNull(result);\r
157                                 System.out.println("RES:" + result);\r
158                                 // Some times the job could be removed from the cluster\r
159                                 // accounting\r
160                                 // before it has been reported to finish. Make sure\r
161                                 // to stop waiting in such case\r
162                                 if (status == JobStatus.UNDEFINED) {\r
163                                         break;\r
164                                 }\r
165                         }\r
166                 } catch (JobSubmissionException e) {\r
167                         e.printStackTrace();\r
168                         fail("DrmaaException caught:" + e.getMessage());\r
169                 } catch (InterruptedException e) {\r
170                         e.printStackTrace();\r
171                         fail(e.getMessage());\r
172                 } catch (ResultNotAvailableException e) {\r
173                         e.printStackTrace();\r
174                         fail(e.getMessage());\r
175                 }\r
176         }\r
177 \r
178         @Test(groups = {AllTestSuit.test_group_runner})\r
179         public void testRunLocally() {\r
180                 try {\r
181                         ConfiguredExecutable<Jronn> confJronn = Configurator\r
182                                         .configureExecutable(jronn, Executable.ExecProvider.Local);\r
183 \r
184                         // For local execution use relative\r
185                         LocalRunner lr = new LocalRunner(confJronn);\r
186                         lr.executeJob();\r
187                         ConfiguredExecutable<?> al1 = lr.waitForResult();\r
188                         assertNotNull(al1.getResults());\r
189                         Map<String, Score> al2 = confJronn.getResults();\r
190                         assertNotNull(al2);\r
191                         assertEquals(al2.size(), 3);\r
192                         assertEquals(al1.getResults(), al2);\r
193                 } catch (JobSubmissionException e) {\r
194                         e.printStackTrace();\r
195                         fail(e.getLocalizedMessage());\r
196                 } catch (ResultNotAvailableException e) {\r
197                         e.printStackTrace();\r
198                         fail(e.getLocalizedMessage());\r
199                 } catch (JobExecutionException e) {\r
200                         e.printStackTrace();\r
201                         fail(e.getLocalizedMessage());\r
202                 }\r
203         }\r
204 \r
205         @Test(groups = {AllTestSuit.test_group_runner})\r
206         public void testRunLocallyOnTwoCpu() {\r
207                 try {\r
208                         jronn.setNCore(2);\r
209                         ConfiguredExecutable<Jronn> confJronn = Configurator\r
210                                         .configureExecutable(jronn, Executable.ExecProvider.Local);\r
211 \r
212                         // For local execution use relative\r
213                         LocalRunner lr = new LocalRunner(confJronn);\r
214                         lr.executeJob();\r
215                         ConfiguredExecutable<?> al1 = lr.waitForResult();\r
216                         assertNotNull(al1.getResults());\r
217                         Map<String, Score> al2 = confJronn.getResults();\r
218                         assertNotNull(al2);\r
219                         assertEquals(al2.size(), 3);\r
220                         assertEquals(al1.getResults(), al2);\r
221                 } catch (JobSubmissionException e) {\r
222                         e.printStackTrace();\r
223                         fail(e.getLocalizedMessage());\r
224                 } catch (ResultNotAvailableException e) {\r
225                         e.printStackTrace();\r
226                         fail(e.getLocalizedMessage());\r
227                 } catch (JobExecutionException e) {\r
228                         e.printStackTrace();\r
229                         fail(e.getLocalizedMessage());\r
230                 }\r
231         }\r
232 \r
233         @Test(groups = {AllTestSuit.test_group_runner})\r
234         public void readStatistics() {\r
235                 try {\r
236                         ConfiguredExecutable<Jronn> confJronn = Configurator\r
237                                         .configureExecutable(jronn, Executable.ExecProvider.Local);\r
238                         // For local execution use relavive\r
239 \r
240                         AsyncExecutor sexec = Configurator.getAsyncEngine(confJronn);\r
241                         String jobId = sexec.submitJob(confJronn);\r
242                         FilePuller fw = FilePuller.newFilePuller(\r
243                                         confJronn.getWorkDirectory() + File.separator\r
244                                                         + Jronn.getStatFile(),\r
245                                         FileWatcher.MIN_CHUNK_SIZE_BYTES);\r
246                         int count = 0;\r
247                         long position = 0;\r
248                         fw.waitForFile(4);\r
249                         JobStatus status = sexec.getJobStatus(jobId);\r
250                         while (status != JobStatus.FINISHED) {\r
251                                 if (fw.hasMoreData()) {\r
252                                         ChunkHolder ch = fw.pull(position);\r
253                                         String chunk = ch.getChunk();\r
254                                         position = ch.getNextPosition();\r
255                                 }\r
256                                 count++;\r
257                                 // Make sure the loop is terminated if the job fails\r
258                                 if ((status == JobStatus.UNDEFINED || status == JobStatus.FAILED)) {\r
259                                         break;\r
260                                 }\r
261                                 Thread.sleep(300);\r
262                                 status = sexec.getJobStatus(jobId);\r
263                         }\r
264                         assertTrue(count > 1);\r
265                         ConfiguredExecutable<?> al = sexec.getResults(jobId);\r
266                         assertNotNull(al.getResults());\r
267                 } catch (JobSubmissionException e) {\r
268                         e.printStackTrace();\r
269                         fail(e.getMessage());\r
270                 } catch (ResultNotAvailableException e) {\r
271                         e.printStackTrace();\r
272                         fail(e.getMessage());\r
273                 } catch (IOException e) {\r
274                         e.printStackTrace();\r
275                         fail(e.getMessage());\r
276                 } catch (InterruptedException e) {\r
277                         e.printStackTrace();\r
278                         fail(e.getMessage());\r
279                 }\r
280         }\r
281 \r
282         @Test(groups = {AllTestSuit.test_group_runner})\r
283         public void testPersistance() {\r
284                 try {\r
285                         Jronn jronn = new Jronn();\r
286                         jronn.setError("errrr.txt").setInput(AllTestSuit.test_input)\r
287                                         .setOutput("outtt.txt");\r
288                         assertEquals(jronn.getInput(), AllTestSuit.test_input);\r
289                         assertEquals(jronn.getError(), "errrr.txt");\r
290                         assertEquals(jronn.getOutput(), "outtt.txt");\r
291                         ConfiguredExecutable<Jronn> cJronn = Configurator\r
292                                         .configureExecutable(jronn, Executable.ExecProvider.Local);\r
293 \r
294                         SyncExecutor sexec = Configurator.getSyncEngine(cJronn);\r
295                         sexec.executeJob();\r
296                         ConfiguredExecutable<?> al = sexec.waitForResult();\r
297                         assertNotNull(al.getResults());\r
298                         // Save run configuration\r
299                         assertTrue(cJronn.saveRunConfiguration());\r
300 \r
301                         // See if loaded configuration is the same as saved\r
302                         RunConfiguration loadedRun = RunConfiguration\r
303                                         .load(new FileInputStream(new File(cJronn\r
304                                                         .getWorkDirectory(), RunConfiguration.rconfigFile)));\r
305                         assertEquals(\r
306                                         ((ConfExecutable<Jronn>) cJronn).getRunConfiguration(),\r
307                                         loadedRun);\r
308                         // Load run configuration as ConfExecutable\r
309                         ConfiguredExecutable<Jronn> resurrectedCMuscle = (ConfiguredExecutable<Jronn>) cJronn\r
310                                         .loadRunConfiguration(new FileInputStream(new File(cJronn\r
311                                                         .getWorkDirectory(), RunConfiguration.rconfigFile)));\r
312                         assertNotNull(resurrectedCMuscle);\r
313                         assertEquals(resurrectedCMuscle.getExecutable().getInput(),\r
314                                         AllTestSuit.test_input);\r
315                         assertEquals(resurrectedCMuscle.getExecutable().getError(),\r
316                                         "errrr.txt");\r
317                         assertEquals(resurrectedCMuscle.getExecutable().getOutput(),\r
318                                         "outtt.txt");\r
319                         // See in details whether executables are the same\r
320                         assertEquals(resurrectedCMuscle.getExecutable(), jronn);\r
321 \r
322                         ConfiguredExecutable<Jronn> resJronn = Configurator\r
323                                         .configureExecutable(resurrectedCMuscle.getExecutable(),\r
324                                                         Executable.ExecProvider.Local);\r
325 \r
326                         sexec = Configurator.getSyncEngine(resJronn,\r
327                                         Executable.ExecProvider.Local);\r
328                         sexec.executeJob();\r
329                         al = sexec.waitForResult();\r
330                         assertNotNull(al);\r
331 \r
332                 } catch (JobSubmissionException e) {\r
333                         e.printStackTrace();\r
334                         fail(e.getMessage());\r
335                 } catch (JobExecutionException e) {\r
336                         e.printStackTrace();\r
337                         fail(e.getMessage());\r
338                 } catch (FileNotFoundException e) {\r
339                         e.printStackTrace();\r
340                         fail(e.getMessage());\r
341                 } catch (IOException e) {\r
342                         e.printStackTrace();\r
343                         fail(e.getMessage());\r
344                 } catch (ResultNotAvailableException e) {\r
345                         e.printStackTrace();\r
346                         fail(e.getMessage());\r
347                 }\r
348         }\r
349 \r
350         @Test(groups = {AllTestSuit.test_group_runner})\r
351         public void testConfigurationLoading() {\r
352                 try {\r
353                         RunnerConfig<Jronn> jronnConfig = ConfExecutable\r
354                                         .getRunnerOptions(Jronn.class);\r
355                         // There is not supported parameters for Jronn\r
356                         assertNull(jronnConfig);\r
357 \r
358                         PresetManager<Jronn> jronnPresets = ConfExecutable\r
359                                         .getRunnerPresets(Jronn.class);\r
360                         assertNull(jronnPresets); // there is no presets\r
361 \r
362                         LimitsManager<Jronn> jronnLimits = ConfExecutable\r
363                                         .getRunnerLimits(Jronn.class);\r
364                         assertNotNull(jronnLimits);\r
365                         assertTrue(jronnLimits.getLimits().size() > 0);\r
366                         jronnLimits.validate(jronnPresets);\r
367 \r
368                 } catch (FileNotFoundException e) {\r
369                         e.printStackTrace();\r
370                         fail(e.getLocalizedMessage());\r
371                 } catch (IOException e) {\r
372                         e.printStackTrace();\r
373                         fail(e.getLocalizedMessage());\r
374                 } catch (ValidationException e) {\r
375                         e.printStackTrace();\r
376                         fail(e.getLocalizedMessage());\r
377                 }\r
378         }\r
379 \r
380 }\r