1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: Apache-2.0
9 from arvados import api, vocabulary
11 class VocabularyTest(unittest.TestCase):
18 {'label': 'Creature'},
24 {'label': 'Homo sapiens'},
29 {'label': 'Elephant'},
30 {'label': 'Loxodonta'},
38 {'label': 'Importance'},
39 {'label': 'Priority'},
45 {'label': 'High priority'},
51 {'label': 'Medium priority'},
57 {'label': 'Low priority'},
74 self.api = arvados.api('v1')
75 self.voc = vocabulary.Vocabulary(self.EXAMPLE_VOC)
76 self.api.vocabulary = mock.MagicMock(return_value=self.EXAMPLE_VOC)
78 def test_vocabulary_keys(self):
79 self.assertEqual(self.voc.strict_keys, False)
81 self.voc.key_aliases.keys(),
82 set(['idtaganimals', 'creature', 'animal',
83 'idtagimportances', 'importance', 'priority',
84 'idtagcomments', 'comment', 'notes'])
87 vk = self.voc.key_aliases['creature']
88 self.assertEqual(vk.strict, False)
89 self.assertEqual(vk.identifier, 'IDTAGANIMALS')
90 self.assertEqual(vk.aliases, ['Animal', 'Creature'])
91 self.assertEqual(vk.preferred_label, 'Animal')
93 vk.value_aliases.keys(),
94 set(['idvalanimal1', 'human', 'homo sapiens',
95 'idvalanimal2', 'elephant', 'loxodonta'])
98 def test_vocabulary_values(self):
99 vk = self.voc.key_aliases['creature']
100 vv = vk.value_aliases['human']
101 self.assertEqual(vv.identifier, 'IDVALANIMAL1')
102 self.assertEqual(vv.aliases, ['Human', 'Homo sapiens'])
103 self.assertEqual(vv.preferred_label, 'Human')
105 def test_vocabulary_indexing(self):
106 self.assertEqual(self.voc['creature']['human'].identifier, 'IDVALANIMAL1')
107 self.assertEqual(self.voc['Creature']['Human'].identifier, 'IDVALANIMAL1')
108 self.assertEqual(self.voc['CREATURE']['HUMAN'].identifier, 'IDVALANIMAL1')
109 with self.assertRaises(KeyError):
110 inexistant = self.voc['foo']
112 def test_empty_vocabulary(self):
113 voc = vocabulary.Vocabulary({})
114 self.assertEqual(voc.strict_keys, False)
115 self.assertEqual(voc.key_aliases, {})
117 def test_load_vocabulary_with_api(self):
118 voc = vocabulary.load_vocabulary(self.api)
119 self.assertEqual(voc['creature']['human'].identifier, 'IDVALANIMAL1')
120 self.assertEqual(voc['Creature']['Human'].identifier, 'IDVALANIMAL1')
121 self.assertEqual(voc['CREATURE']['HUMAN'].identifier, 'IDVALANIMAL1')
123 def test_convert_to_identifiers(self):
125 {'IDTAGIMPORTANCES': 'IDVALIMPORTANCE1'},
126 {'IDTAGIMPORTANCES': 'High'},
127 {'importance': 'IDVALIMPORTANCE1'},
128 {'priority': 'high priority'},
132 self.voc.convert_to_identifiers(case),
133 {'IDTAGIMPORTANCES': 'IDVALIMPORTANCE1'},
134 "failing test case: {}".format(case)
137 def test_convert_to_identifiers_multiple_pairs(self):
139 {'IDTAGIMPORTANCES': 'IDVALIMPORTANCE1', 'IDTAGANIMALS': 'IDVALANIMAL1', 'IDTAGCOMMENTS': 'Very important person'},
140 {'IDTAGIMPORTANCES': 'High', 'IDTAGANIMALS': 'IDVALANIMAL1', 'comment': 'Very important person'},
141 {'importance': 'IDVALIMPORTANCE1', 'animal': 'IDVALANIMAL1', 'notes': 'Very important person'},
142 {'priority': 'high priority', 'animal': 'IDVALANIMAL1', 'NOTES': 'Very important person'},
146 self.voc.convert_to_identifiers(case),
147 {'IDTAGIMPORTANCES': 'IDVALIMPORTANCE1', 'IDTAGANIMALS': 'IDVALANIMAL1', 'IDTAGCOMMENTS': 'Very important person'},
148 "failing test case: {}".format(case)
151 def test_convert_to_identifiers_value_lists(self):
153 {'IDTAGIMPORTANCES': ['IDVALIMPORTANCE1', 'IDVALIMPORTANCE2']},
154 {'IDTAGIMPORTANCES': ['High', 'Medium']},
155 {'importance': ['IDVALIMPORTANCE1', 'IDVALIMPORTANCE2']},
156 {'priority': ['high', 'medium']},
160 self.voc.convert_to_identifiers(case),
161 {'IDTAGIMPORTANCES': ['IDVALIMPORTANCE1', 'IDVALIMPORTANCE2']},
162 "failing test case: {}".format(case)
165 def test_convert_to_identifiers_unknown_key(self):
166 # Non-strict vocabulary
167 self.assertEqual(self.voc.strict_keys, False)
168 self.assertEqual(self.voc.convert_to_identifiers({'foo': 'bar'}), {'foo': 'bar'})
170 strict_voc = arvados.vocabulary.Vocabulary(self.EXAMPLE_VOC)
171 strict_voc.strict_keys = True
172 with self.assertRaises(KeyError):
173 strict_voc.convert_to_identifiers({'foo': 'bar'})
175 def test_convert_to_identifiers_unknown_value(self):
177 self.assertEqual(self.voc['animal'].strict, False)
178 self.assertEqual(self.voc.convert_to_identifiers({'Animal': 'foo'}), {'IDTAGANIMALS': 'foo'})
180 self.assertEqual(self.voc['priority'].strict, True)
181 with self.assertRaises(ValueError):
182 self.voc.convert_to_identifiers({'Priority': 'foo'})
184 def test_convert_to_identifiers_unknown_value_list(self):
186 self.assertEqual(self.voc['animal'].strict, False)
188 self.voc.convert_to_identifiers({'Animal': ['foo', 'loxodonta']}),
189 {'IDTAGANIMALS': ['foo', 'IDVALANIMAL2']}
192 self.assertEqual(self.voc['priority'].strict, True)
193 with self.assertRaises(ValueError):
194 self.voc.convert_to_identifiers({'Priority': ['foo', 'bar']})
196 def test_convert_to_labels(self):
198 {'IDTAGIMPORTANCES': 'IDVALIMPORTANCE1'},
199 {'IDTAGIMPORTANCES': 'High'},
200 {'importance': 'IDVALIMPORTANCE1'},
201 {'priority': 'high priority'},
205 self.voc.convert_to_labels(case),
206 {'Importance': 'High'},
207 "failing test case: {}".format(case)
210 def test_convert_to_labels_multiple_pairs(self):
212 {'IDTAGIMPORTANCES': 'IDVALIMPORTANCE1', 'IDTAGANIMALS': 'IDVALANIMAL1', 'IDTAGCOMMENTS': 'Very important person'},
213 {'IDTAGIMPORTANCES': 'High', 'IDTAGANIMALS': 'IDVALANIMAL1', 'comment': 'Very important person'},
214 {'importance': 'IDVALIMPORTANCE1', 'animal': 'IDVALANIMAL1', 'notes': 'Very important person'},
215 {'priority': 'high priority', 'animal': 'IDVALANIMAL1', 'NOTES': 'Very important person'},
219 self.voc.convert_to_labels(case),
220 {'Importance': 'High', 'Animal': 'Human', 'Comment': 'Very important person'},
221 "failing test case: {}".format(case)
224 def test_convert_to_labels_value_lists(self):
226 {'IDTAGIMPORTANCES': ['IDVALIMPORTANCE1', 'IDVALIMPORTANCE2']},
227 {'IDTAGIMPORTANCES': ['High', 'Medium']},
228 {'importance': ['IDVALIMPORTANCE1', 'IDVALIMPORTANCE2']},
229 {'priority': ['high', 'medium']},
233 self.voc.convert_to_labels(case),
234 {'Importance': ['High', 'Medium']},
235 "failing test case: {}".format(case)
238 def test_convert_to_labels_unknown_key(self):
239 # Non-strict vocabulary
240 self.assertEqual(self.voc.strict_keys, False)
241 self.assertEqual(self.voc.convert_to_labels({'foo': 'bar'}), {'foo': 'bar'})
243 strict_voc = arvados.vocabulary.Vocabulary(self.EXAMPLE_VOC)
244 strict_voc.strict_keys = True
245 with self.assertRaises(KeyError):
246 strict_voc.convert_to_labels({'foo': 'bar'})
248 def test_convert_to_labels_unknown_value(self):
250 self.assertEqual(self.voc['animal'].strict, False)
251 self.assertEqual(self.voc.convert_to_labels({'IDTAGANIMALS': 'foo'}), {'Animal': 'foo'})
253 self.assertEqual(self.voc['priority'].strict, True)
254 with self.assertRaises(ValueError):
255 self.voc.convert_to_labels({'IDTAGIMPORTANCES': 'foo'})
257 def test_convert_to_labels_unknown_value_list(self):
259 self.assertEqual(self.voc['animal'].strict, False)
261 self.voc.convert_to_labels({'IDTAGANIMALS': ['foo', 'IDVALANIMAL1']}),
262 {'Animal': ['foo', 'Human']}
265 self.assertEqual(self.voc['priority'].strict, True)
266 with self.assertRaises(ValueError):
267 self.voc.convert_to_labels({'IDTAGIMPORTANCES': ['foo', 'bar']})
269 def test_convert_roundtrip(self):
270 initial = {'IDTAGIMPORTANCES': 'IDVALIMPORTANCE1', 'IDTAGANIMALS': 'IDVALANIMAL1', 'IDTAGCOMMENTS': 'Very important person'}
271 converted = self.voc.convert_to_labels(initial)
272 self.assertNotEqual(converted, initial)
273 self.assertEqual(self.voc.convert_to_identifiers(converted), initial)