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