Start supporting multiple libraries per lane, as needed for the HiSeq
[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
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
56         for lib in Library.objects.all():
57             lib_dict = library_dict(lib.id)
58             url = '/samples/library/%s/json' % (lib.id,)
59             lib_response = self.client.get(url, apidata)
60             self.failUnlessEqual(lib_response.status_code, 200)
61             lib_json = json.loads(lib_response.content)
62
63             for d in [lib_dict, lib_json]:
64                 # amplified_from_sample is a link to the library table,
65                 # I want to use the "id" for the data lookups not
66                 # the embedded primary key.
67                 # It gets slightly confusing on how to implement sending the right id
68                 # since amplified_from_sample can be null
69                 #self.failUnlessEqual(d['amplified_from_sample'], lib.amplified_from_sample)
70                 self.failUnlessEqual(d['antibody_id'], lib.antibody_id)
71                 self.failUnlessEqual(d['cell_line_id'], lib.cell_line_id)
72                 self.failUnlessEqual(d['cell_line'], unicode_or_none(lib.cell_line))
73                 self.failUnlessEqual(d['experiment_type'], lib.experiment_type.name)
74                 self.failUnlessEqual(d['experiment_type_id'], lib.experiment_type_id)
75                 self.failUnlessEqual(d['gel_cut_size'], lib.gel_cut_size)
76                 self.failUnlessEqual(d['hidden'], lib.hidden)
77                 self.failUnlessEqual(d['id'], lib.id)
78                 self.failUnlessEqual(d['insert_size'], lib.insert_size)
79                 self.failUnlessEqual(d['library_name'], lib.library_name)
80                 self.failUnlessEqual(d['library_species'], lib.library_species.scientific_name)
81                 self.failUnlessEqual(d['library_species_id'], lib.library_species_id)
82                 self.failUnlessEqual(d['library_type_id'], lib.library_type_id)
83                 if lib.library_type_id is not None:
84                     self.failUnlessEqual(d['library_type'], lib.library_type.name)
85                 else:
86                     self.failUnlessEqual(d['library_type'], None)
87                     self.failUnlessEqual(d['made_for'], lib.made_for)
88                     self.failUnlessEqual(d['made_by'], lib.made_by)
89                     self.failUnlessEqual(d['notes'], lib.notes)
90                     self.failUnlessEqual(d['replicate'], lib.replicate)
91                     self.failUnlessEqual(d['stopping_point'], lib.stopping_point)
92                     self.failUnlessEqual(d['successful_pM'], lib.successful_pM)
93                     self.failUnlessEqual(d['undiluted_concentration'],
94                                          unicode(lib.undiluted_concentration))
95                 # some specific tests
96                 if lib.id == '10981':
97                     # test a case where there is no known status
98                     lane_set = {u'status': u'Unknown', u'paired_end': True, u'read_length': 75, u'lane_number': 1, u'flowcell': u'303TUAAXX', u'status_code': None}
99                     self.failUnlessEqual(len(d['lane_set']), 1)
100                     self.failUnlessEqual(d['lane_set'][0], lane_set)
101                 elif lib.id == '11016':
102                     # test a case where there is a status
103                     lane_set = {u'status': 'Good', u'paired_end': True, u'read_length': 75, u'lane_number': 5, u'flowcell': u'303TUAAXX', u'status_code': 2}
104                     self.failUnlessEqual(len(d['lane_set']), 1)
105                     self.failUnlessEqual(d['lane_set'][0], lane_set)
106
107     def test_invalid_library(self):
108         """
109         Make sure we get a 404 if we request an invalid library id
110         """
111         response = self.client.get('/samples/library/nottheone/json', apidata)
112         self.failUnlessEqual(response.status_code, 404)
113
114             
115     def test_library_no_key(self):
116         """
117         Make sure we get a 302 if we're not logged in
118         """
119         response = self.client.get('/samples/library/10981/json')
120         self.failUnlessEqual(response.status_code, 403)
121         response = self.client.get('/samples/library/10981/json', apidata)
122         self.failUnlessEqual(response.status_code, 200)
123
124 # The django test runner flushes the database between test suites not cases,
125 # so to be more compatible with running via nose we flush the database tables
126 # of interest before creating our sample data.
127 def create_db(obj):
128     obj.species_human = Species.objects.get(pk=8)
129     obj.experiment_rna_seq = ExperimentType.objects.get(pk=4)
130     obj.affiliation_alice = Affiliation.objects.get(pk=1)
131     obj.affiliation_bob = Affiliation.objects.get(pk=2)
132     
133     Library.objects.all().delete()
134     obj.library_10001 = Library(
135         id = "10001",
136         library_name = 'C2C12 named poorly',
137         library_species = obj.species_human,
138         experiment_type = obj.experiment_rna_seq,
139         creation_date = datetime.datetime.now(),
140         made_for = 'scientist unit 2007',
141         made_by = 'microfludics system 7321',
142         stopping_point = '2A',
143         undiluted_concentration = '5.01',
144         hidden = False,
145     )
146     obj.library_10001.save()
147     obj.library_10002 = Library(
148         id = "10002",
149         library_name = 'Worm named poorly',
150         library_species = obj.species_human,
151         experiment_type = obj.experiment_rna_seq,
152         creation_date = datetime.datetime.now(),
153         made_for = 'scientist unit 2007',
154         made_by = 'microfludics system 7321',
155         stopping_point = '2A',
156         undiluted_concentration = '5.01',
157         hidden = False,
158     )
159     obj.library_10002.save()
160  
161 try:
162     import RDF
163     HAVE_RDF = True
164
165     rdfNS = RDF.NS("http://www.w3.org/1999/02/22-rdf-syntax-ns#")
166     xsdNS = RDF.NS("http://www.w3.org/2001/XMLSchema#")
167     libNS = RDF.NS("http://jumpgate.caltech.edu/wiki/LibraryOntology#")
168 except ImportError,e:
169     HAVE_RDF = False
170
171     
172 class TestRDFaLibrary(TestCase):
173     fixtures = ['test_samples.json']
174
175     def test_parse_rdfa(self):
176         model = get_rdf_memory_model()
177         parser = RDF.Parser(name='rdfa')
178         url = '/library/10981/'
179         lib_response = self.client.get(url)
180         self.failIfEqual(len(lib_response.content), 0)
181         
182         parser.parse_string_into_model(model,
183                                        lib_response.content,
184                                        'http://localhost'+url)
185         # http://jumpgate.caltech.edu/wiki/LibraryOntology#affiliation>
186         self.check_literal_object(model, ['Bob'], p=libNS['affiliation'])
187         self.check_literal_object(model, ['Multiplexed'], p=libNS['experiment_type'])
188         self.check_literal_object(model, ['400'], p=libNS['gel_cut'])
189         self.check_literal_object(model, ['Igor'], p=libNS['made_by'])
190         self.check_literal_object(model, ['Paired End Multiplexed Sp-BAC'], p=libNS['name'])
191         self.check_literal_object(model, ['Drosophila melanogaster'], p=libNS['species'])
192
193         self.check_uri_object(model,
194                               [u'http://localhost/lane/1193'],
195                               p=libNS['has_lane'])
196
197         self.check_literal_object(model,
198                                   [u"303TUAAXX"],
199                                   s=RDF.Uri('http://localhost/flowcell/303TUAAXX/'))
200                                   
201     def check_literal_object(self, model, values, s=None, p=None, o=None):
202         statements = list(model.find_statements(
203             RDF.Statement(s,p,o)))
204         self.failUnlessEqual(len(statements), len(values),
205                         "Couln't find %s %s %s" % (s,p,o))
206         for s in statements:
207             self.failUnless(s.object.literal_value['string'] in values)
208
209
210     def check_uri_object(self, model, values, s=None, p=None, o=None):
211         statements = list(model.find_statements(
212             RDF.Statement(s,p,o)))
213         self.failUnlessEqual(len(statements), len(values),
214                         "Couln't find %s %s %s" % (s,p,o))
215         for s in statements:
216             self.failUnless(unicode(s.object.uri) in values)
217
218
219
220 def get_rdf_memory_model():
221     storage = RDF.MemoryStorage()
222     model = RDF.Model(storage)
223     return model
224