bfe4b0e2c7260c6a5f18893c72c93708f80fde11
[htsworkflow.git] / htsworkflow / frontend / samples / tests.py
1 import datetime
2 import unittest
3
4 try:
5     import json
6 except ImportError, e:
7     import simplejson as json
8
9 from django.test import TestCase
10
11 from htsworkflow.frontend.samples.models import \
12         Affiliation, \
13         ExperimentType, \
14         Species, \
15         Library
16
17 from htsworkflow.frontend.samples.views import \
18      library_dict, \
19      library_json
20
21 from htsworkflow.frontend.auth import apidata
22 from htsworkflow.util.conversion import unicode_or_none
23 from htsworkflow.util.ethelp import validate_xhtml
24
25 class LibraryTestCase(TestCase):
26     fixtures = ['test_samples.json']
27
28     def setUp(self):
29         create_db(self)
30
31     def testOrganism(self):
32         self.assertEquals(self.library_10001.organism(), 'human')
33
34     def testAffiliations(self):
35         self.library_10001.affiliations.add(self.affiliation_alice)
36         self.library_10002.affiliations.add(
37                 self.affiliation_alice,
38                 self.affiliation_bob
39         )
40         self.failUnless(len(self.library_10001.affiliations.all()), 1)
41         self.failUnless(self.library_10001.affiliation(), 'Alice')
42
43         self.failUnless(len(self.library_10002.affiliations.all()), 2)
44         self.failUnless(self.library_10001.affiliation(), 'Alice, Bob')
45
46
47 class SampleWebTestCase(TestCase):
48     """
49     Test returning data from our database in rest like ways.
50     (like returning json objects)
51     """
52     fixtures = ['test_samples.json']
53
54     def test_library_info(self):
55         for lib in Library.objects.all():
56             lib_dict = library_dict(lib.id)
57             url = '/samples/library/%s/json' % (lib.id,)
58             lib_response = self.client.get(url, apidata)
59             self.failUnlessEqual(lib_response.status_code, 200)
60             lib_json = json.loads(lib_response.content)
61
62             for d in [lib_dict, lib_json]:
63                 # amplified_from_sample is a link to the library table,
64                 # I want to use the "id" for the data lookups not
65                 # the embedded primary key.
66                 # It gets slightly confusing on how to implement sending the right id
67                 # since amplified_from_sample can be null
68                 #self.failUnlessEqual(d['amplified_from_sample'], lib.amplified_from_sample)
69                 self.failUnlessEqual(d['antibody_id'], lib.antibody_id)
70                 self.failUnlessEqual(d['cell_line_id'], lib.cell_line_id)
71                 self.failUnlessEqual(d['cell_line'], unicode_or_none(lib.cell_line))
72                 self.failUnlessEqual(d['experiment_type'], lib.experiment_type.name)
73                 self.failUnlessEqual(d['experiment_type_id'], lib.experiment_type_id)
74                 self.failUnlessEqual(d['gel_cut_size'], lib.gel_cut_size)
75                 self.failUnlessEqual(d['hidden'], lib.hidden)
76                 self.failUnlessEqual(d['id'], lib.id)
77                 self.failUnlessEqual(d['insert_size'], lib.insert_size)
78                 self.failUnlessEqual(d['library_name'], lib.library_name)
79                 self.failUnlessEqual(d['library_species'], lib.library_species.scientific_name)
80                 self.failUnlessEqual(d['library_species_id'], lib.library_species_id)
81                 self.failUnlessEqual(d['library_type_id'], lib.library_type_id)
82                 if lib.library_type_id is not None:
83                     self.failUnlessEqual(d['library_type'], lib.library_type.name)
84                 else:
85                     self.failUnlessEqual(d['library_type'], None)
86                     self.failUnlessEqual(d['made_for'], lib.made_for)
87                     self.failUnlessEqual(d['made_by'], lib.made_by)
88                     self.failUnlessEqual(d['notes'], lib.notes)
89                     self.failUnlessEqual(d['replicate'], lib.replicate)
90                     self.failUnlessEqual(d['stopping_point'], lib.stopping_point)
91                     self.failUnlessEqual(d['successful_pM'], lib.successful_pM)
92                     self.failUnlessEqual(d['undiluted_concentration'],
93                                          unicode(lib.undiluted_concentration))
94                 # some specific tests
95                 if lib.id == '10981':
96                     # test a case where there is no known status
97                     lane_set = {u'status': u'Unknown',
98                                 u'paired_end': True,
99                                 u'read_length': 75,
100                                 u'lane_number': 1,
101                                 u'lane_id': 1193,
102                                 u'flowcell': u'303TUAAXX',
103                                 u'status_code': None}
104                     self.failUnlessEqual(len(d['lane_set']), 1)
105                     self.failUnlessEqual(d['lane_set'][0], lane_set)
106                 elif lib.id == '11016':
107                     # test a case where there is a status
108                     lane_set = {u'status': 'Good',
109                                 u'paired_end': True,
110                                 u'read_length': 75,
111                                 u'lane_number': 5,
112                                 u'lane_id': 1197,
113                                 u'flowcell': u'303TUAAXX',
114                                 u'status_code': 2}
115                     self.failUnlessEqual(len(d['lane_set']), 1)
116                     self.failUnlessEqual(d['lane_set'][0], lane_set)
117
118
119     def test_invalid_library_json(self):
120         """
121         Make sure we get a 404 if we request an invalid library id
122         """
123         response = self.client.get('/samples/library/nottheone/json', apidata)
124         self.failUnlessEqual(response.status_code, 404)
125
126
127     def test_invalid_library(self):
128         response = self.client.get('/library/nottheone/')
129         self.failUnlessEqual(response.status_code, 404)
130
131
132     def test_library_no_key(self):
133         """
134         Make sure we get a 302 if we're not logged in
135         """
136         response = self.client.get('/samples/library/10981/json')
137         self.failUnlessEqual(response.status_code, 403)
138         response = self.client.get('/samples/library/10981/json', apidata)
139         self.failUnlessEqual(response.status_code, 200)
140
141     def test_library_rdf(self):
142         import RDF
143         from htsworkflow.util.rdfhelp import get_model, \
144              fromTypedNode, \
145              load_string_into_model, \
146              rdfNS, \
147              libraryOntology
148         model = get_model()
149
150         response = self.client.get('/library/10981/')
151         self.assertEqual(response.status_code, 200)
152         content = response.content
153         load_string_into_model(model, 'rdfa', content)
154
155         body = """prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
156         prefix libns: <http://jumpgate.caltech.edu/wiki/LibraryOntology#>
157
158         select ?library ?name ?library_id ?gel_cut ?made_by
159         where {
160            ?library a libns:library ;
161                     libns:name ?name ;
162                     libns:library_id ?library_id ;
163                     libns:gel_cut ?gel_cut ;
164                     libns:made_by ?made_by
165         }"""
166         query = RDF.SPARQLQuery(body)
167         for r in query.execute(model):
168             self.assertEqual(fromTypedNode(r['library_id']), u'10981')
169             self.assertEqual(fromTypedNode(r['name']),
170                              u'Paired End Multiplexed Sp-BAC')
171             self.assertEqual(fromTypedNode(r['gel_cut']), 400)
172             self.assertEqual(fromTypedNode(r['made_by']), u'Igor')
173
174         state = validate_xhtml(content)
175         if state is not None: self.assertTrue(state)
176
177     def test_library_index_rdfa(self):
178         from htsworkflow.util.rdfhelp import \
179              add_default_schemas, get_model, load_string_into_model
180
181         from htsworkflow.util.rdfinfer import Infer
182
183         model = get_model()
184         add_default_schemas(model)
185         inference = Infer(model)
186
187         response = self.client.get('/library/')
188         self.assertEqual(response.status_code, 200)
189         load_string_into_model(model, 'rdfa', response.content)
190
191         errmsgs = list(inference.run_validation())
192         self.assertEqual(len(errmsgs), 2)
193         # didn't feel like giving the index page a type since all
194         # its doing is showing a list of things.
195         for err in errmsgs:
196             self.assertEqual(err, 'Missing type for: http://localhost/')
197
198         body =  """prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
199         prefix libns: <http://jumpgate.caltech.edu/wiki/LibraryOntology#>
200
201         select ?library ?library_id ?name ?species
202         where {
203            ?library a libns:Library .
204            OPTIONAL { ?library libns:library_id ?library_id . }
205            OPTIONAL { ?library libns:species ?species . }
206            OPTIONAL { ?library libns:name ?name . }
207         }"""
208         bindings = set(['library', 'library_id', 'name', 'species'])
209         query = RDF.SPARQLQuery(body)
210         count = 0
211         for r in query.execute(model):
212             count += 1
213             for name, value in r.items():
214                 self.assertTrue(name in bindings)
215                 self.assertTrue(value is not None)
216
217         self.assertEqual(count, len(Library.objects.filter(hidden=False)))
218
219         state = validate_xhtml(response.content)
220         if state is not None: self.assertTrue(state)
221 # The django test runner flushes the database between test suites not cases,
222 # so to be more compatible with running via nose we flush the database tables
223 # of interest before creating our sample data.
224 def create_db(obj):
225     obj.species_human = Species.objects.get(pk=8)
226     obj.experiment_rna_seq = ExperimentType.objects.get(pk=4)
227     obj.affiliation_alice = Affiliation.objects.get(pk=1)
228     obj.affiliation_bob = Affiliation.objects.get(pk=2)
229
230     Library.objects.all().delete()
231     obj.library_10001 = Library(
232         id = "10001",
233         library_name = 'C2C12 named poorly',
234         library_species = obj.species_human,
235         experiment_type = obj.experiment_rna_seq,
236         creation_date = datetime.datetime.now(),
237         made_for = 'scientist unit 2007',
238         made_by = 'microfludics system 7321',
239         stopping_point = '2A',
240         undiluted_concentration = '5.01',
241         hidden = False,
242     )
243     obj.library_10001.save()
244     obj.library_10002 = Library(
245         id = "10002",
246         library_name = 'Worm named poorly',
247         library_species = obj.species_human,
248         experiment_type = obj.experiment_rna_seq,
249         creation_date = datetime.datetime.now(),
250         made_for = 'scientist unit 2007',
251         made_by = 'microfludics system 7321',
252         stopping_point = '2A',
253         undiluted_concentration = '5.01',
254         hidden = False,
255     )
256     obj.library_10002.save()
257
258 try:
259     import RDF
260     HAVE_RDF = True
261
262     rdfNS = RDF.NS("http://www.w3.org/1999/02/22-rdf-syntax-ns#")
263     xsdNS = RDF.NS("http://www.w3.org/2001/XMLSchema#")
264     libNS = RDF.NS("http://jumpgate.caltech.edu/wiki/LibraryOntology#")
265 except ImportError,e:
266     HAVE_RDF = False
267
268
269 class TestRDFaLibrary(TestCase):
270     fixtures = ['test_samples.json']
271
272     def test_parse_rdfa(self):
273         model = get_rdf_memory_model()
274         parser = RDF.Parser(name='rdfa')
275         url = '/library/10981/'
276         lib_response = self.client.get(url)
277         self.failIfEqual(len(lib_response.content), 0)
278
279         parser.parse_string_into_model(model,
280                                        lib_response.content,
281                                        'http://localhost'+url)
282         # http://jumpgate.caltech.edu/wiki/LibraryOntology#affiliation>
283         self.check_literal_object(model, ['Bob'], p=libNS['affiliation'])
284         self.check_literal_object(model, ['Multiplexed'], p=libNS['experiment_type'])
285         self.check_literal_object(model, ['400'], p=libNS['gel_cut'])
286         self.check_literal_object(model, ['Igor'], p=libNS['made_by'])
287         self.check_literal_object(model, ['Paired End Multiplexed Sp-BAC'], p=libNS['name'])
288         self.check_literal_object(model, ['Drosophila melanogaster'], p=libNS['species'])
289
290         self.check_uri_object(model,
291                               [u'http://localhost/lane/1193'],
292                               p=libNS['has_lane'])
293
294         fc_uri = RDF.Uri('http://localhost/flowcell/303TUAAXX/')
295         self.check_literal_object(model,
296                                   [u"303TUAAXX"],
297                                   s=fc_uri, p=libNS['flowcell_id'])
298
299     def check_literal_object(self, model, values, s=None, p=None, o=None):
300         statements = list(model.find_statements(
301             RDF.Statement(s,p,o)))
302         self.failUnlessEqual(len(statements), len(values),
303                         "Couln't find %s %s %s" % (s,p,o))
304         for s in statements:
305             self.failUnless(s.object.literal_value['string'] in values)
306
307
308     def check_uri_object(self, model, values, s=None, p=None, o=None):
309         statements = list(model.find_statements(
310             RDF.Statement(s,p,o)))
311         self.failUnlessEqual(len(statements), len(values),
312                         "Couln't find %s %s %s" % (s,p,o))
313         for s in statements:
314             self.failUnless(unicode(s.object.uri) in values)
315
316
317
318 def get_rdf_memory_model():
319     storage = RDF.MemoryStorage()
320     model = RDF.Model(storage)
321     return model
322