1 # -*- encoding: utf-8 -*-
3 import time # used to eval time.strftime expressions
9 from config import config
14 logger_channel = 'tests'
16 class YamlImportException(Exception):
19 class YamlImportAbortion(Exception):
22 def _is_yaml_mapping(node, tag_constructor):
23 value = isinstance(node, types.DictionaryType) \
24 and len(node.keys()) == 1 \
25 and isinstance(node.keys()[0], tag_constructor)
29 return isinstance(node, types.StringTypes)
32 return _is_yaml_mapping(node, yaml_tag.Assert)
35 return _is_yaml_mapping(node, yaml_tag.Record)
38 return _is_yaml_mapping(node, yaml_tag.Python)
40 def is_menuitem(node):
41 return isinstance(node, yaml_tag.Menuitem) \
42 or _is_yaml_mapping(node, yaml_tag.Menuitem)
44 def is_function(node):
45 return isinstance(node, yaml_tag.Function) \
46 or _is_yaml_mapping(node, yaml_tag.Function)
49 return isinstance(node, yaml_tag.Report)
51 def is_workflow(node):
52 return isinstance(node, yaml_tag.Workflow)
54 def is_act_window(node):
55 return isinstance(node, yaml_tag.ActWindow)
58 return isinstance(node, yaml_tag.Delete)
61 return isinstance(node, yaml_tag.Context)
64 return isinstance(node, yaml_tag.Url)
67 return isinstance(node, yaml_tag.Eval)
70 return _is_yaml_mapping(node, yaml_tag.IrSet)
73 class TestReport(object):
77 def record(self, success, severity):
79 Records the result of an assertion for the failed/success count.
82 if severity in self._report:
83 self._report[severity][success] += 1
85 self._report[severity] = {success: 1, not success: 0}
90 res.append('\nAssertions report:\nLevel\tsuccess\tfailure')
92 for severity in self._report:
93 res.append("%s\t%s\t%s" % (severity, self._report[severity][True], self._report[severity][False]))
94 success += self._report[severity][True]
95 failure += self._report[severity][False]
96 res.append("total\t%s\t%s" % (success, failure))
97 res.append("end of report (%s assertion(s) checked)" % success + failure)
100 class RecordDictWrapper(dict):
102 Used to pass a record as locals in eval:
103 records do not strictly behave like dict, so we force them to.
105 def __init__(self, record):
107 def __getitem__(self, key):
108 if key in self.record:
109 return self.record[key]
110 return dict.__getitem__(self, key)
112 class YamlInterpreter(object):
113 def __init__(self, cr, module, id_map, mode, filename, noupdate=False):
118 self.filename = filename
119 self.assert_report = TestReport()
120 self.noupdate = noupdate
121 self.logger = logging.getLogger("%s.%s" % (logger_channel, self.module))
122 self.pool = pooler.get_pool(cr.dbname)
124 self.context = {} # opererp context
125 self.eval_context = {'ref': self._ref, '_ref': self._ref} # added '_ref' so that record['ref'] is possible
128 return lambda xml_id: self.get_id(xml_id)
130 def get_model(self, model_name):
131 model = self.pool.get(model_name)
132 assert model, "The model %s does not exist." % (model_name,)
135 def validate_xml_id(self, xml_id):
138 module, id = xml_id.split('.', 1)
139 assert '.' not in id, "The ID reference '%s' must contains maximum one dot.\n" \
140 "It is used to refer to other modules ID, in the form: module.record_id" \
142 if module != self.module:
143 module_count = self.pool.get('ir.module.module').search_count(self.cr, self.uid, \
144 ['&', ('name', '=', module), ('state', 'in', ['installed'])])
145 assert module_count == 1, 'The ID "%s" refers to an uninstalled module.' % (xml_id,)
146 if len(id) > 64: # TODO where does 64 come from (DB is 128)? should be a constant or loaded form DB
147 self.logger.log(logging.ERROR, 'id: %s is to long (max: 64)', id)
149 def get_id(self, xml_id):
151 raise YamlImportException("The xml_id should be a non empty string.")
152 if isinstance(xml_id, types.IntType):
154 elif xml_id in self.id_map:
155 id = self.id_map[xml_id]
158 module, xml_id = xml_id.split('.', 1)
161 ir_id = self.pool.get('ir.model.data')._get_id(self.cr, self.uid, module, xml_id)
162 obj = self.pool.get('ir.model.data').read(self.cr, self.uid, ir_id, ['res_id'])
163 id = int(obj['res_id'])
164 self.id_map[xml_id] = id
167 def get_context(self, node, eval_dict):
168 context = self.context.copy()
170 context.update(eval(node.context, eval_dict))
173 def isnoupdate(self, node):
174 return self.noupdate or node.noupdate or False
176 def process_comment(self, node):
179 def _log_assert_failure(self, severity, msg, *args):
180 self.assert_report.record(False, severity)
181 self.logger.log(severity, msg, *args)
182 if severity >= config['assert_exit_level']:
183 raise YamlImportAbortion('Severe assertion failure (%s), aborting.' % logging.getLevelName(severity))
186 def _get_assertion_id(self, assertion):
188 ids = [self.get_id(assertion.id)]
189 elif assertion.search:
190 q = eval(assertion.search, self.eval_context)
191 ids = self.pool.get(assertion.model).search(self.cr, self.uid, q, context=assertion.context)
193 raise YamlImportException('Nothing to assert: you must give either an id or a search criteria.')
196 def process_assert(self, node):
197 assertion, expressions = node.items()[0]
199 if self.isnoupdate(assertion) and self.mode != 'init':
201 model = self.get_model(assertion.model)
202 ids = self._get_assertion_id(assertion)
203 if assertion.count and len(ids) != assertion.count:
204 msg = 'assertion "%s" failed!\n' \
205 ' Incorrect search count:\n' \
206 ' expected count: %d\n' \
207 ' obtained count: %d\n'
208 args = (assertion.string, assertion.count, len(ids))
209 self._log_assert_failure(assertion.severity, msg, *args)
211 context = self.get_context(assertion, self.eval_context)
213 record = model.browse(self.cr, self.uid, id, context)
214 for test in expressions.get('test', ''):
216 success = eval(test, self.eval_context, RecordDictWrapper(record))
218 raise YamlImportAbortion(e)
220 msg = 'Assertion "%s" FAILED\ntest: %s\n'
221 args = (assertion.string, test)
222 self._log_assert_failure(assertion.severity, msg, *args)
224 else: # all tests were successful for this assertion tag (no break)
225 self.assert_report.record(True, assertion.severity)
227 def process_record(self, node):
228 record, fields = node.items()[0]
230 self.validate_xml_id(record.id)
231 if self.isnoupdate(record) and self.mode != 'init':
232 model = self.get_model(record.model)
233 record_dict = self._create_record(model, fields)
234 self.logger.debug("RECORD_DICT %s" % record_dict)
235 id = self.pool.get('ir.model.data')._update(self.cr, self.uid, record.model, \
236 self.module, record_dict, record.id, noupdate=self.isnoupdate(record), mode=self.mode)
237 self.id_map[record.id] = int(id)
238 if config.get('import_partial', False):
241 def _create_record(self, model, fields):
243 for field_name, expression in fields.items():
244 field_value = self._eval_field(model, field_name, expression)
245 record_dict[field_name] = field_value
248 def _eval_field(self, model, field_name, expression):
249 column = model._columns[field_name]
250 if column._type == "many2one":
251 value = self.get_id(expression)
252 elif column._type == "one2many":
253 other_model = self.get_model(column._obj)
254 value = [(0, 0, self._create_record(other_model, fields)) for fields in expression]
255 elif column._type == "many2many":
256 ids = [self.get_id(xml_id) for xml_id in expression]
259 if isinstance(expression, yaml_tag.Eval):
260 value = eval(expression.expression)
263 # raise YamlImportException('Unsupported column "%s" or value %s:%s' % (field_name, type(expression), expression))
266 def process_context(self, node):
267 self.context = node.__dict__
269 self.uid = self.get_id(node.uid)
271 self.noupdate = node.noupdate
273 def process_python(self, node):
275 self.logger.log(logging.TEST, msg, *args)
276 python, statements = node.items()[0]
277 model = self.get_model(python.model)
278 statements = statements.replace("\r\n", "\n")
279 code_context = {'self': model, 'cr': self.cr, 'uid': self.uid, 'log': log, 'context': self.context}
281 code = compile(statements, self.filename, 'exec')
282 eval(code, {'ref': self.get_id}, code_context)
283 except AssertionError, e:
284 self._log_assert_failure(python.severity, 'AssertionError in Python code %s: %s', python.name, e)
287 raise YamlImportAbortion(e)
289 self.assert_report.record(True, python.severity)
291 def process_workflow(self, node):
292 workflow, values = node.items()[0]
293 if self.isnoupdate(workflow) and self.mode != 'init':
295 model = self.get_model(workflow.model)
297 id = self.get_id(workflow.ref)
300 raise YamlImportException('You must define a child node if you do not give a ref.')
301 if not len(values) == 1:
302 raise YamlImportException('Only one child node is accepted (%d given).' % len(values))
304 if not 'model' in value and (not 'eval' in value or not 'search' in value):
305 raise YamlImportException('You must provide a "model" and an "eval" or "search" to evaluate.')
306 value_model = self.get_model(value['model'])
307 local_context = {'obj': lambda x: value_model.browse(self.cr, self.uid, x, context=self.context)}
308 local_context.update(self.id_map)
309 id = eval(value['eval'], self.eval_context, local_context)
311 if workflow.uid is not None:
315 wf_service = netsvc.LocalService("workflow")
316 wf_service.trg_validate(uid, model, id, workflow.action, self.cr)
318 def process_function(self, node):
319 function, values = node.items()[0]
320 if self.isnoupdate(function) and self.mode != 'init':
322 context = self.get_context(function, self.eval_context)
325 args = eval(function.eval, self.eval_context)
327 if not 'model' in value and (not 'eval' in value or not 'search' in value):
328 raise YamlImportException('You must provide a "model" and an "eval" or "search" to evaluate.')
329 value_model = self.get_model(value['model'])
330 local_context = {'obj': lambda x: value_model.browse(self.cr, self.uid, x, context=context)}
331 local_context.update(self.id_map)
332 id = eval(value['eval'], self.eval_context, local_context)
335 model = self.get_model(function.model)
336 method = function.name
337 getattr(model, method)(self.cr, self.uid, *args)
339 def _set_group_values(self, node, values):
341 group_names = node.groups.split(',')
343 for group in group_names:
344 if group.startswith('-'):
345 group_id = self.get_id(group[1:])
346 groups_value.append((3, group_id))
348 group_id = self.get_id(group)
349 groups_value.append((4, group_id))
350 values['groups_id'] = groups_value
352 def process_menuitem(self, node):
353 self.validate_xml_id(node.id)
357 self.cr.execute('select id from ir_ui_menu where parent_id is null and name=%s', (node.name,))
358 res = self.cr.fetchone()
359 values = {'parent_id': parent_id, 'name': node.name}
361 parent_id = self.get_id(node.parent)
362 values = {'parent_id': parent_id}
364 values['name'] = node.name
366 res = [ self.get_id(node.id) ]
367 except: # which exception ?
371 action_type = node.type or 'act_window'
373 "act_window": 'STOCK_NEW',
374 "report.xml": 'STOCK_PASTE',
375 "wizard": 'STOCK_EXECUTE',
376 "url": 'STOCK_JUMP_TO',
378 values['icon'] = icons.get(action_type, 'STOCK_NEW')
379 if action_type == 'act_window':
380 action_id = self.get_id(node.action)
381 self.cr.execute('select view_type,view_mode,name,view_id,target from ir_act_window where id=%s', (action_id,))
382 ir_act_window_result = self.cr.fetchone()
383 assert ir_act_window_result, "No window action defined for this id %s !\n" \
384 "Verify that this is a window action or add a type argument." % (node.action,)
385 action_type, action_mode, action_name, view_id, target = ir_act_window_result
387 self.cr.execute('SELECT type FROM ir_ui_view WHERE id=%s', (view_id,))
388 # TODO guess why action_mode is ir_act_window.view_mode above and ir_ui_view.type here
389 action_mode = self.cr.fetchone()
390 self.cr.execute('SELECT view_mode FROM ir_act_window_view WHERE act_window_id=%s ORDER BY sequence LIMIT 1', (action_id,))
392 action_mode = self.cr.fetchone()
393 if action_type == 'tree':
394 values['icon'] = 'STOCK_INDENT'
395 elif action_mode and action_mode.startswith('tree'):
396 values['icon'] = 'STOCK_JUSTIFY_FILL'
397 elif action_mode and action_mode.startswith('graph'):
398 values['icon'] = 'terp-graph'
399 elif action_mode and action_mode.startswith('calendar'):
400 values['icon'] = 'terp-calendar'
402 values['icon'] = 'STOCK_EXECUTE'
403 if not values.get('name', False):
404 values['name'] = action_name
405 elif action_type == 'wizard':
406 action_id = self.get_id(node.action)
407 self.cr.execute('select name from ir_act_wizard where id=%s', (action_id,))
408 ir_act_wizard_result = self.cr.fetchone()
409 if (not values.get('name', False)) and ir_act_wizard_result:
410 values['name'] = ir_act_wizard_result[0]
412 raise YamlImportException("Unsupported type '%s' in menuitem tag." % action_type)
414 values['sequence'] = node.sequence
416 values['icon'] = node.icon
418 self._set_group_values(node, values)
420 pid = self.pool.get('ir.model.data')._update(self.cr, self.uid, \
421 'ir.ui.menu', self.module, values, node.id, mode=self.mode, \
422 noupdate=self.isnoupdate(node), res_id=res and res[0] or False)
424 if node.id and parent_id:
425 self.id_map[node.id] = int(parent_id)
427 if node.action and pid:
428 action_type = node.type or 'act_window'
429 action_id = self.get_id(node.action)
430 action = "ir.actions.%s,%d" % (action_type, action_id)
431 self.pool.get('ir.model.data').ir_set(self.cr, self.uid, 'action', \
432 'tree_but_open', 'Menuitem', [('ir.ui.menu', int(parent_id))], action, True, True, xml_id=node.id)
434 def process_act_window(self, node):
435 self.validate_xml_id(node.id)
438 view_id = self.get_id(node.view)
439 context = eval(node.context, self.eval_context)
443 'type': type or 'ir.actions.act_window',
445 'domain': node.domain,
447 'res_model': node.res_model,
448 'src_model': node.src_model,
449 'view_type': node.view_type or 'form',
450 'view_mode': node.view_mode or 'tree,form',
453 'auto_refresh': node.auto_refresh,
456 self._set_group_values(node, values)
459 values['target'] = node.target
460 id = self.pool.get('ir.model.data')._update(self.cr, self.uid, \
461 'ir.actions.act_window', self.module, values, node.id, mode=self.mode)
462 self.id_map[node.id] = int(id)
465 keyword = 'client_action_relate'
466 value = 'ir.actions.act_window,%s' % id
467 replace = node.replace or True
468 self.pool.get('ir.model.data').ir_set(self.cr, self.uid, 'action', keyword, \
469 node.id, [node.src_model], value, replace=replace, noupdate=self.isnoupdate(node), isobject=True, xml_id=node.id)
470 # TODO add remove ir.model.data
472 def process_delete(self, node):
475 ids = self.pool.get(node.model).search(self.cr, self.uid, eval(node.search, self.eval_context))
478 ids.append(self.get_id(node.id))
482 self.pool.get(node.model).unlink(self.cr, self.uid, ids)
483 self.pool.get('ir.model.data')._unlink(self.cr, self.uid, node.model, ids, direct=True)
485 def process_url(self, node):
486 self.validate_xml_id(node.id)
488 res = {'name': node.name, 'url': node.url, 'target': node.target}
490 id = self.pool.get('ir.model.data')._update(self.cr, self.uid, \
491 "ir.actions.url", self.module, res, node.id, mode=self.mode)
492 self.id_map[node.id] = int(id)
494 if (not node.menu or eval(node.menu)) and id:
495 keyword = node.keyword or 'client_action_multi'
496 value = 'ir.actions.url,%s' % id
497 replace = node.replace or True
498 self.pool.get('ir.model.data').ir_set(self.cr, self.uid, 'action', \
499 keyword, node.url, ["ir.actions.url"], value, replace=replace, \
500 noupdate=self.isnoupdate(node), isobject=True, xml_id=node.id)
502 def process_ir_set(self, node):
503 if not self.mode == 'init':
505 _, fields = node.items()[0]
507 for fieldname, expression in fields.items():
508 if isinstance(expression, Eval):
509 value = eval(expression.expression, self.eval_context)
512 res[fieldname] = value
513 self.pool.get('ir.model.data').ir_set(self.cr, self.uid, res['key'], res['key2'], \
514 res['name'], res['models'], res['value'], replace=res.get('replace',True), \
515 isobject=res.get('isobject', False), meta=res.get('meta',None))
517 def process_report(self, node):
519 for dest, f in (('name','string'), ('model','model'), ('report_name','name')):
520 values[dest] = getattr(node, f)
521 assert values[dest], "Attribute %s of report is empty !" % (f,)
522 for field,dest in (('rml','report_rml'),('xml','report_xml'),('xsl','report_xsl'),('attachment','attachment'),('attachment_use','attachment_use')):
523 if getattr(node, field):
524 values[dest] = getattr(node, field)
526 values['auto'] = eval(node.auto)
528 sxw_content = misc.file_open(node.sxw).read()
529 values['report_sxw_content'] = sxw_content
531 values['header'] = eval(node.header)
532 values['multi'] = node.multi and eval(node.multi)
534 self.validate_xml_id(xml_id)
536 self._set_group_values(node, values)
538 id = self.pool.get('ir.model.data')._update(self.cr, self.uid, "ir.actions.report.xml", \
539 self.module, values, xml_id, noupdate=self.isnoupdate(node), mode=self.mode)
540 self.id_map[xml_id] = int(id)
542 if not node.menu or eval(node.menu):
543 keyword = node.keyword or 'client_print_multi'
544 value = 'ir.actions.report.xml,%s' % id
545 replace = node.replace or True
546 self.pool.get('ir.model.data').ir_set(self.cr, self.uid, 'action', \
547 keyword, values['name'], [values['model']], value, replace=replace, isobject=True, xml_id=xml_id)
549 def process_none(self):
551 Empty node or commented node should not pass silently.
553 self._log_assert_failure(logging.WARNING, "You have an empty block in your tests.")
556 def process(self, yaml_string):
558 Processes a Yaml string. Custom tags are interpreted by 'process_' instance methods.
560 is_preceded_by_comment = False
561 for node in yaml.load(yaml_string):
562 is_preceded_by_comment = self._log(node, is_preceded_by_comment)
564 self._process_node(node)
565 except YamlImportException, e:
566 self.logger.log(logging.ERROR, e)
568 self.logger.log(logging.ERROR, e)
571 def _process_node(self, node):
573 self.process_comment(node)
574 elif is_assert(node):
575 self.process_assert(node)
576 elif is_record(node):
577 self.process_record(node)
578 elif is_python(node):
579 self.process_python(node)
580 elif is_menuitem(node):
581 self.process_menuitem(node)
582 elif is_delete(node):
583 self.process_delete(node)
585 self.process_url(node)
586 elif is_context(node):
587 self.process_context(node)
588 elif is_ir_set(node):
589 self.process_ir_set(node)
590 elif is_act_window(node):
591 self.process_act_window(node)
592 elif is_report(node):
593 self.process_report(node)
594 elif is_workflow(node):
595 if isinstance(node, types.DictionaryType):
596 self.process_workflow(node)
598 self.process_workflow({node: []})
599 elif is_function(node):
600 if isinstance(node, types.DictionaryType):
601 self.process_function(node)
603 self.process_function({node: []})
607 raise YamlImportException("Can not process YAML block: %s" % node)
609 def _log(self, node, is_preceded_by_comment):
611 is_preceded_by_comment = True
612 self.logger.log(logging.TEST, node)
613 elif not is_preceded_by_comment:
614 if isinstance(node, types.DictionaryType):
615 msg = "Creating %s\n with %s"
616 args = node.items()[0]
617 self.logger.log(logging.TEST, msg, *args)
619 self.logger.log(logging.TEST, node)
621 is_preceded_by_comment = False
622 return is_preceded_by_comment
624 def yaml_import(cr, module, yamlfile, idref=None, mode='init', noupdate=False, report=None):
627 yaml_string = yamlfile.read()
628 yaml_interpreter = YamlInterpreter(cr, module, idref, mode, filename=yamlfile.name, noupdate=noupdate)
629 yaml_interpreter.process(yaml_string)
631 # keeps convention of convert.py
632 convert_yaml_import = yaml_import
634 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: