regenerated stubs & TODO
[jabaws.git] / TODO.txt
1 Add more detailed tests for webservices? \r
2 \r
3 ? ideally should introduce native Mac support (and maybe abandon native windows support in \r
4 favour of VM)   \r
5 \r
6 TODO write some help on the executable.properties within this file! \r
7 check that after binaries relocation build tasks point to correct locations!\r
8 \r
9 Cluster stats: \r
10  -Remove hyperlinks from tasks which workdirs were removed \r
11  -graph generation \r
12  -user documentation (do not forget how to enable follow symlinks!)\r
13 \r
14 add to help text: To disable a web service remove it from WEB-INF/sun-jaxws.xml descriptor\r
15 \r
16 rename jaba.war to jabaws.war and make sure jabaws context path is used throughout. \r
17 \r
18 Current stat collector has to rely on file dates! \r
19 To change this you need \r
20 1) Collect all the stats in old format into the DB\r
21 2) Update the code to get the date out of the file.  \r
22 Can be done once JABAWS 1 is replaced with 2. \r
23 \r
24 Globprot need a proper reference to bio python and sav_gol binaries -> they should be \r
25 somehow taken from disembl. \r
26 \r
27 \r
28 ? Replace conservation.Method with server.ws.Method and try building WS. If this does not work - get rid of Method\r
29 \r
30 Output file parsing for stat reporting\r
31 install cluster engine stat of www-jws2 user\r
32 \r
33 integrate the above to tweak the size of the local job\r
34 \r
35 Good toString method for Limits (test with command line client -limits)\r
36 Document the Limits for presets\r
37 JABA DOCS\r
38 \r
39 (later) Add documentation on Presets, Parameters and Limits\r
40 (later) Explain how to define a limit\r
41 \r
42 Add test for repeated result collection from cluster engine\r
43 \r
44 (low) Pack the test cases and build file to run them in one of the distributives \r
45 \r
46 \r
47 DONE\r
48 \r
49 version 2\r
50 \r
51 DONE:  GET rid of binaries/help directory!\r
52 DONE:  update binaries\r
53  DONE:  muscle binary version 3.8.31 for win/lin32/lin64 and sources, docs in website/prog_docs\r
54  DONE:  test Muscle on the cluster\r
55  DONE:  test Muscle compilation\r
56  DONE:  probcons up-to-date\r
57  DONE:  clustal up-to-date \r
58  DONE:  update tcoffee (8.99 latest) source code updated  docs updated \r
59  DONE:  tcoffee compilation for IA32 \r
60  DONE:  update Mafft (6.857 latest) for win/lin32/lin64 and sources, no docs updates\r
61 DONE:  make sure conf files are optional!\r
62 \r
63 Cluster stats: \r
64  DONE: cancelled should not be reported as incomplete!\r
65  DONE: ant task to clean up clean stat db task before packing web app\r
66  DONE: pack web apps with stat db (NOT TESTED!)\r
67  DONE: change input size bites\r
68  DONE: add help info for each column in the detailed job list table\r
69  DONE: replace default -1 with ? \r
70  DONE: delete and re-import the database to fix clustal input staff    \r
71 \r
72 DONE:  Test all WS as names from Executables were removed\r
73 DONE:  Add default names for input and output in every executable and use them consistently\r
74   throughts (e.g. in all WS). Best of all use the same name from SceletalExectuable \r
75   For statistics. \r
76 \r
77 DONE:  FIXED Conecting to JABAWS version 2 service\r
78   09-Feb-2011 15:27:53 compbio.ws.client.Jws2Client connect\r
79   INFO: Connected successfully!\r
80   Exception in thread "main" java.lang.NullPointerException\r
81         at compbio.ws.client.MetadataHelper.getParametersList(MetadataHelper.java:30)\r
82         at compbio.ws.client.Jws2Client.<init>(Jws2Client.java:179)\r
83         at compbio.ws.client.Jws2Client.main(Jws2Client.java:483)\r
84 \r
85 DONE:  ScoreManager should output scores properly \r
86 DONE:  Allow empty Parameters and Preset files! \r
87 DONE:  Check the WS input and reject it on submission rather then of access with error message\r
88 \r
89 DONE: Add registry service to query services status\r
90 DONE: Refactor web services checker to enable a programmatic access to its methods.\r
91 DONE: Finish the client\r
92 DONE: Add AACon ws\r
93 DONE: Add iupred ws http://iupred.enzim.hu/\r
94 DONE: Add globprot ws - does not report raw scores, just regions\r
95 DONE: Add ronn ws\r
96 DONE: Define limits for presets - if required\r
97 DONE: Add logging facility to WSTester so more details of the problem can be reported\r
98 DONE: Statistics collector for engines (number of operations/timing)\r
99 \r
100 \r
101 version 1\r
102 \r
103 DONE: LocalExecutor service must be shutdown on web application undeploy event not on JVM shutdown. \r
104       This is because JVM is still running even after web application is shut down!\r
105 DONE: Use absolute path for web site download links as archives are not included into distro!\r
106 DONE: Rearrange web site docs - add links to the top of the page to the topics discussed below\r
107 DONE: Put the documentation for various executables online\r
108 DONE: Make left gradient image one-two characters larger + change "For developer ->For Developers"\r
109 DONE: test local/cluster execution - test Load balancer\r
110 DONE: Improve SimpleWS client so it can be scripted against: give user alignment and accept parameters\r
111 DONE: Make a configuration tester class (check that configuration files point to the executables, and they can be executed)\r
112 DONE: PUT CLIENT JAR INTO WEB-INF/LIB - most likely need to get rid of dist prefix in the build file\r
113 DONE: Different packages for download and dundee. generic vs specific settings. \r
114 DONE: JAVADOC\r
115 DONE: Refactor EngineResourcesLeak tester to hide a map implementation!\r
116 DONE: Compile executables for linux in the most generic way\r
117 DONE: Make different log4j configuration files / web services logs.\r
118 DONE: System manual\r
119 DONE: Developer doc\r
120 DONE: How to\r
121 DONE: Prepare different packages\r
122 DONE: extract commonly used names into variable in the build script\r
123 DONE: Test for high load conditions (TestNG?)\r
124 DONE: (low) Fix: Started jobs with unknown completion status reported as FINISHED by  msaws.getJobStatus(taskId) (see SimpleWSClient)\r
125 DONE: fix compile binaries script\r
126 DONE: Make script to change executable flag for linux systems\r
127 DONE: jobsout must be created within war\r
128 DONE: enable relative paths for local engine conf temp dir\r
129 COUND NOT REPRODUCE: fix cluster job status - RUNNING -> UNDEFINED\r
130 DONE: throw JobSubmission exception with appropriate method instead - (low) code discoverer/tester for ws - e.g. after war deployment to find out what actually works\r
131 DONE: fix build scripts after reorganising project\r
132 DONE: package as war file for deployment\r
133 DONE: package for jalview distro for local execution\r
134 DONE: reorganise project into independent chunks\r
135 DONE: test Parameter & Option toCommand method\r
136 DONE: Replace WS methods with new CommandBuilder.toCommand()\r
137 DONE: Setting default values is validated as external method \r
138 DONE: Refactoring to extract data model, and engines is performed\r
139 DONE: Default value is adopted for passing new Option values to server side\r
140 DONE: Converting Options to commands delegated to CommandBuilder  \r
141 DONE: Make Arguments mutable to facilitate default value setting for WS\r
142 DONE: Matrix files for alignment programme\r
143 DONE: Clean up testcases\r
144 DONE: Replace List<String> as command line parameters abstraction to dedicated CommandBuilder class \r
145 DONE: Parallel execution for tcoffee jobs\r
146 DONE: Copyright added\r
147 DONE: WRAP ProbCons\r
148 DONE: think about time limits and cluster parameters for parallel execution - NativeSpecs for cluster is implemented\r
149 DONE: (low) Use for WS: (@WebParam(name = "name") String name) {\r
150 DONE: Implement rough policy for runtimes (e.g. do not run excessively long tasks on the local machine if cluster is available)\r
151 DONE: Write tomcat conf to expose WS\r
152 DONE: access control to web.xml\r
153 DONE: Statistics collector for WS\r
154 DONE: implements limits for web services\r
155 DONE: WS clients must be able to connect to a web service given the service url. \r
156 e.i. ws URL should not be compiled in using wsimport, but determined from \r
157 the configuration file.  \r
158 \r
159 DONE: Could not find configuration files if run from within servlet container\r
160 DONE: Add ways to get engine based on the key for everything but submission of the new tasks \r
161 DONE: Add cache to Cluster JOBID - so that at least jobs for which results have not been collected is cached.\r
162 DONE: FINISHED overrides FINISHED with time stamp!\r
163 DONE: Consider think about JobStatus and StatFileStatus\r
164 DONE: a method to read 3 chars at the beginning of the file to indicate a progress is added\r
165 DONE: ConfiguredExecutable<?> al = sexec.getResults(jobId); || Alignment ?\r
166 DONE: ClustalW - OUTput must be set !\r
167 DONE: Add accessor methods to get a DUMP of the process output \r
168 DONE: FilePuller should be cached to avoid excessive fs exercise\r
169 DONE: Test List of the processes (ensure no memory leaks)\r
170 PART DONE - On the client on shutdown remember the task list - server tasks could be loaded and executed from saved run configurations, client should decide for themselves what they want\r
171 DONE: Persist the task list to enable later result collection on the server side\r
172 DONE Wrap TCoffee\r
173 DONE: improve parameters handling - new schema + update for all parameters\r
174 DONE: Cluster jobs report submitting and result collecting/finishing time (for sync jobs only(!)) and cluster jobid in the corresponding files  \r
175 DONE: Local jobs report starting and finising times in files with corresponding names in the task directory  \r
176 DONE: Generalize getResult method for MSA runners\r
177 DONE: Create test suits\r
178 DONE: Convert junit tests to TestNG\r
179 DONE: Redirect output & error streams to the named files as some processed need this  \r
180 DONE: Extract generilyzed class with most of the method for individual executable to use\r
181 DONE: Refit wrappers to use the generalised class to avoid duplication  \r
182 DONE: Pass environment variable settings to the executable\r
183 DONE: Complete AsyncExecutors implementation\r
184 DONE: Look to unify methods for engines\r
185 DONE: Provide way around of generated directory setup for test cases(?)\r
186 DONE: Fix the test cases for local engine (need to set directory on executable explicitly)\r
187 DONE: Make log files for processes err and out for local execution\r
188 DONE: Trace where AsyncExcel called with null Executable and attempts to create a new directory repeatedly\r
189 DONE: directory generator\r
190 DONE: tests for cancel \r
191 DONE tests for getStatus\r
192 DONE  ws async\r
193 DONE: parametrized clustal operations\r
194 DONE: test large datasets handling \r
195 DONE: write load balancer \r
196 DONE: (low) task persistance\r
197 DONE: Look at CancellableTask if with Sync and AsyncExecutor \r