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 isinstance(node, yaml_tag.Ref) \
71 or _is_yaml_mapping(node, yaml_tag.Ref)
74 return _is_yaml_mapping(node, yaml_tag.IrSet)
77 class TestReport(object):
81 def record(self, success, severity):
83 Records the result of an assertion for the failed/success count.
86 if severity in self._report:
87 self._report[severity][success] += 1
89 self._report[severity] = {success: 1, not success: 0}
94 res.append('\nAssertions report:\nLevel\tsuccess\tfailure')
96 for severity in self._report:
97 res.append("%s\t%s\t%s" % (severity, self._report[severity][True], self._report[severity][False]))
98 success += self._report[severity][True]
99 failure += self._report[severity][False]
100 res.append("total\t%s\t%s" % (success, failure))
101 res.append("end of report (%s assertion(s) checked)" % success + failure)
102 return "\n".join(res)
104 class RecordDictWrapper(dict):
106 Used to pass a record as locals in eval:
107 records do not strictly behave like dict, so we force them to.
109 def __init__(self, record):
111 def __getitem__(self, key):
112 if key in self.record:
113 return self.record[key]
114 return dict.__getitem__(self, key)
116 class YamlInterpreter(object):
117 def __init__(self, cr, module, id_map, mode, filename, noupdate=False):
122 self.filename = filename
123 self.assert_report = TestReport()
124 self.noupdate = noupdate
125 self.logger = logging.getLogger("%s.%s" % (logger_channel, self.module))
126 self.pool = pooler.get_pool(cr.dbname)
128 self.context = {} # opererp context
129 self.eval_context = {'ref': self._ref, '_ref': self._ref, 'time': time} # added '_ref' so that record['ref'] is possible
132 return lambda xml_id: self.get_id(xml_id)
134 def get_model(self, model_name):
135 model = self.pool.get(model_name)
136 assert model, "The model %s does not exist." % (model_name,)
139 def validate_xml_id(self, xml_id):
142 module, id = xml_id.split('.', 1)
143 assert '.' not in id, "The ID reference '%s' must contains maximum one dot.\n" \
144 "It is used to refer to other modules ID, in the form: module.record_id" \
146 if module != self.module:
147 module_count = self.pool.get('ir.module.module').search_count(self.cr, self.uid, \
148 ['&', ('name', '=', module), ('state', 'in', ['installed'])])
149 assert module_count == 1, 'The ID "%s" refers to an uninstalled module.' % (xml_id,)
150 if len(id) > 64: # TODO where does 64 come from (DB is 128)? should be a constant or loaded form DB
151 self.logger.log(logging.ERROR, 'id: %s is to long (max: 64)', id)
153 def get_id(self, xml_id):
155 raise YamlImportException("The xml_id should be a non empty string.")
156 if isinstance(xml_id, types.IntType):
158 elif xml_id in self.id_map:
159 id = self.id_map[xml_id]
162 module, checked_xml_id = xml_id.split('.', 1)
165 checked_xml_id = xml_id
166 ir_id = self.pool.get('ir.model.data')._get_id(self.cr, self.uid, module, checked_xml_id)
167 obj = self.pool.get('ir.model.data').read(self.cr, self.uid, ir_id, ['res_id'])
168 id = int(obj['res_id'])
169 self.id_map[xml_id] = id
172 def get_context(self, node, eval_dict):
173 context = self.context.copy()
175 context.update(eval(node.context, eval_dict))
178 def isnoupdate(self, node):
179 return self.noupdate or node.noupdate or False
181 def process_comment(self, node):
184 def _log_assert_failure(self, severity, msg, *args):
185 self.assert_report.record(False, severity)
186 self.logger.log(severity, msg, *args)
187 if severity >= config['assert_exit_level']:
188 raise YamlImportAbortion('Severe assertion failure (%s), aborting.' % logging.getLevelName(severity))
191 def _get_assertion_id(self, assertion):
193 ids = [self.get_id(assertion.id)]
194 elif assertion.search:
195 q = eval(assertion.search, self.eval_context)
196 ids = self.pool.get(assertion.model).search(self.cr, self.uid, q, context=assertion.context)
198 raise YamlImportException('Nothing to assert: you must give either an id or a search criteria.')
201 def process_assert(self, node):
202 assertion, expressions = node.items()[0]
204 if self.isnoupdate(assertion) and self.mode != 'init':
205 self.logger.warn('This assertion was not evaluated ("%s").' % assertion.string)
207 model = self.get_model(assertion.model)
208 ids = self._get_assertion_id(assertion)
209 if assertion.count and len(ids) != assertion.count:
210 msg = 'assertion "%s" failed!\n' \
211 ' Incorrect search count:\n' \
212 ' expected count: %d\n' \
213 ' obtained count: %d\n'
214 args = (assertion.string, assertion.count, len(ids))
215 self._log_assert_failure(assertion.severity, msg, *args)
217 context = self.get_context(assertion, self.eval_context)
219 record = model.browse(self.cr, self.uid, id, context)
220 for test in expressions.get('test', ''):
222 success = eval(test, self.eval_context, RecordDictWrapper(record))
224 raise YamlImportAbortion(e)
226 msg = 'Assertion "%s" FAILED\ntest: %s\n'
227 args = (assertion.string, test)
228 self._log_assert_failure(assertion.severity, msg, *args)
230 else: # all tests were successful for this assertion tag (no break)
231 self.assert_report.record(True, assertion.severity)
233 def _coerce_bool(self, value, default=False):
234 if isinstance(value, types.BooleanType):
236 if isinstance(value, types.StringTypes):
237 b = value.strip().lower() not in ('0', 'false', 'off', 'no')
238 elif isinstance(value, types.IntType):
244 def process_record(self, node):
245 record, fields = node.items()[0]
247 self.validate_xml_id(record.id)
248 if self.isnoupdate(record) and self.mode != 'init':
249 id = self.pool.get('ir.model.data')._update_dummy(self.cr, self.uid, record.model, self.module, record.id)
250 # check if the resource already existed at the last update
252 self.id_map[record] = int(id)
255 if not self._coerce_bool(record.forcecreate):
258 model = self.get_model(record.model)
259 record_dict = self._create_record(model, fields)
260 self.logger.debug("RECORD_DICT %s" % record_dict)
261 id = self.pool.get('ir.model.data')._update(self.cr, self.uid, record.model, \
262 self.module, record_dict, record.id, noupdate=self.isnoupdate(record), mode=self.mode)
263 self.id_map[record.id] = int(id)
264 if config.get('import_partial', False):
267 def _create_record(self, model, fields):
269 for field_name, expression in fields.items():
270 field_value = self._eval_field(model, field_name, expression)
271 record_dict[field_name] = field_value
274 def _eval_field(self, model, field_name, expression):
275 column = model._columns[field_name]
276 if is_ref(expression):
278 other_model_name = expression.model
280 other_model_name = column._obj
281 other_model = self.get_model(other_model_name)
282 if expression.search:
283 q = eval(expression.search, self.eval_context)
284 ids = other_model.search(self.cr, self.uid, q)
286 instances = other_model.browse(self.cr, self.uid, ids)
287 elements = [inst[expression.use] for inst in instances]
290 if column._type in ("many2many", "one2many"):
291 value = [(6, 0, elements)]
294 elif column._type == "many2one":
295 value = self.get_id(expression)
296 elif column._type == "one2many":
297 other_model = self.get_model(column._obj)
298 value = [(0, 0, self._create_record(other_model, fields)) for fields in expression]
299 elif column._type == "many2many":
300 ids = [self.get_id(xml_id) for xml_id in expression]
301 value = [(6, 0, ids)]
303 if is_eval(expression):
304 value = eval(expression.expression, self.eval_context)
307 # raise YamlImportException('Unsupported column "%s" or value %s:%s' % (field_name, type(expression), expression))
310 def process_context(self, node):
311 self.context = node.__dict__
313 self.uid = self.get_id(node.uid)
315 self.noupdate = node.noupdate
317 def process_python(self, node):
319 self.logger.log(logging.TEST, msg, *args)
320 python, statements = node.items()[0]
321 model = self.get_model(python.model)
322 statements = statements.replace("\r\n", "\n")
323 code_context = {'self': model, 'cr': self.cr, 'uid': self.uid, 'log': log, 'context': self.context}
325 code = compile(statements, self.filename, 'exec')
326 eval(code, {'ref': self.get_id}, code_context)
327 except AssertionError, e:
328 self._log_assert_failure(python.severity, 'AssertionError in Python code %s: %s', python.name, e)
331 raise YamlImportAbortion(e)
333 self.assert_report.record(True, python.severity)
335 def process_workflow(self, node):
336 workflow, values = node.items()[0]
337 if self.isnoupdate(workflow) and self.mode != 'init':
339 model = self.get_model(workflow.model)
341 id = self.get_id(workflow.ref)
344 raise YamlImportException('You must define a child node if you do not give a ref.')
345 if not len(values) == 1:
346 raise YamlImportException('Only one child node is accepted (%d given).' % len(values))
348 if not 'model' in value and (not 'eval' in value or not 'search' in value):
349 raise YamlImportException('You must provide a "model" and an "eval" or "search" to evaluate.')
350 value_model = self.get_model(value['model'])
351 local_context = {'obj': lambda x: value_model.browse(self.cr, self.uid, x, context=self.context)}
352 local_context.update(self.id_map)
353 id = eval(value['eval'], self.eval_context, local_context)
355 if workflow.uid is not None:
359 wf_service = netsvc.LocalService("workflow")
360 wf_service.trg_validate(uid, model, id, workflow.action, self.cr)
362 def process_function(self, node):
363 function, values = node.items()[0]
364 if self.isnoupdate(function) and self.mode != 'init':
366 context = self.get_context(function, self.eval_context)
369 args = eval(function.eval, self.eval_context)
371 if not 'model' in value and (not 'eval' in value or not 'search' in value):
372 raise YamlImportException('You must provide a "model" and an "eval" or "search" to evaluate.')
373 value_model = self.get_model(value['model'])
374 local_context = {'obj': lambda x: value_model.browse(self.cr, self.uid, x, context=context)}
375 local_context.update(self.id_map)
376 id = eval(value['eval'], self.eval_context, local_context)
379 model = self.get_model(function.model)
380 method = function.name
381 getattr(model, method)(self.cr, self.uid, *args)
383 def _set_group_values(self, node, values):
385 group_names = node.groups.split(',')
387 for group in group_names:
388 if group.startswith('-'):
389 group_id = self.get_id(group[1:])
390 groups_value.append((3, group_id))
392 group_id = self.get_id(group)
393 groups_value.append((4, group_id))
394 values['groups_id'] = groups_value
396 def process_menuitem(self, node):
397 self.validate_xml_id(node.id)
401 self.cr.execute('select id from ir_ui_menu where parent_id is null and name=%s', (node.name,))
402 res = self.cr.fetchone()
403 values = {'parent_id': parent_id, 'name': node.name}
405 parent_id = self.get_id(node.parent)
406 values = {'parent_id': parent_id}
408 values['name'] = node.name
410 res = [ self.get_id(node.id) ]
411 except: # which exception ?
415 action_type = node.type or 'act_window'
417 "act_window": 'STOCK_NEW',
418 "report.xml": 'STOCK_PASTE',
419 "wizard": 'STOCK_EXECUTE',
420 "url": 'STOCK_JUMP_TO',
422 values['icon'] = icons.get(action_type, 'STOCK_NEW')
423 if action_type == 'act_window':
424 action_id = self.get_id(node.action)
425 self.cr.execute('select view_type,view_mode,name,view_id,target from ir_act_window where id=%s', (action_id,))
426 ir_act_window_result = self.cr.fetchone()
427 assert ir_act_window_result, "No window action defined for this id %s !\n" \
428 "Verify that this is a window action or add a type argument." % (node.action,)
429 action_type, action_mode, action_name, view_id, target = ir_act_window_result
431 self.cr.execute('SELECT type FROM ir_ui_view WHERE id=%s', (view_id,))
432 # TODO guess why action_mode is ir_act_window.view_mode above and ir_ui_view.type here
433 action_mode = self.cr.fetchone()
434 self.cr.execute('SELECT view_mode FROM ir_act_window_view WHERE act_window_id=%s ORDER BY sequence LIMIT 1', (action_id,))
436 action_mode = self.cr.fetchone()
437 if action_type == 'tree':
438 values['icon'] = 'STOCK_INDENT'
439 elif action_mode and action_mode.startswith('tree'):
440 values['icon'] = 'STOCK_JUSTIFY_FILL'
441 elif action_mode and action_mode.startswith('graph'):
442 values['icon'] = 'terp-graph'
443 elif action_mode and action_mode.startswith('calendar'):
444 values['icon'] = 'terp-calendar'
446 values['icon'] = 'STOCK_EXECUTE'
447 if not values.get('name', False):
448 values['name'] = action_name
449 elif action_type == 'wizard':
450 action_id = self.get_id(node.action)
451 self.cr.execute('select name from ir_act_wizard where id=%s', (action_id,))
452 ir_act_wizard_result = self.cr.fetchone()
453 if (not values.get('name', False)) and ir_act_wizard_result:
454 values['name'] = ir_act_wizard_result[0]
456 raise YamlImportException("Unsupported type '%s' in menuitem tag." % action_type)
458 values['sequence'] = node.sequence
460 values['icon'] = node.icon
462 self._set_group_values(node, values)
464 pid = self.pool.get('ir.model.data')._update(self.cr, self.uid, \
465 'ir.ui.menu', self.module, values, node.id, mode=self.mode, \
466 noupdate=self.isnoupdate(node), res_id=res and res[0] or False)
468 if node.id and parent_id:
469 self.id_map[node.id] = int(parent_id)
471 if node.action and pid:
472 action_type = node.type or 'act_window'
473 action_id = self.get_id(node.action)
474 action = "ir.actions.%s,%d" % (action_type, action_id)
475 self.pool.get('ir.model.data').ir_set(self.cr, self.uid, 'action', \
476 'tree_but_open', 'Menuitem', [('ir.ui.menu', int(parent_id))], action, True, True, xml_id=node.id)
478 def process_act_window(self, node):
479 self.validate_xml_id(node.id)
482 view_id = self.get_id(node.view)
483 context = eval(node.context, self.eval_context)
487 'type': type or 'ir.actions.act_window',
489 'domain': node.domain,
491 'res_model': node.res_model,
492 'src_model': node.src_model,
493 'view_type': node.view_type or 'form',
494 'view_mode': node.view_mode or 'tree,form',
497 'auto_refresh': node.auto_refresh,
500 self._set_group_values(node, values)
503 values['target'] = node.target
504 id = self.pool.get('ir.model.data')._update(self.cr, self.uid, \
505 'ir.actions.act_window', self.module, values, node.id, mode=self.mode)
506 self.id_map[node.id] = int(id)
509 keyword = 'client_action_relate'
510 value = 'ir.actions.act_window,%s' % id
511 replace = node.replace or True
512 self.pool.get('ir.model.data').ir_set(self.cr, self.uid, 'action', keyword, \
513 node.id, [node.src_model], value, replace=replace, noupdate=self.isnoupdate(node), isobject=True, xml_id=node.id)
514 # TODO add remove ir.model.data
516 def process_delete(self, node):
519 ids = self.pool.get(node.model).search(self.cr, self.uid, eval(node.search, self.eval_context))
522 ids.append(self.get_id(node.id))
526 self.pool.get(node.model).unlink(self.cr, self.uid, ids)
527 self.pool.get('ir.model.data')._unlink(self.cr, self.uid, node.model, ids, direct=True)
529 def process_url(self, node):
530 self.validate_xml_id(node.id)
532 res = {'name': node.name, 'url': node.url, 'target': node.target}
534 id = self.pool.get('ir.model.data')._update(self.cr, self.uid, \
535 "ir.actions.url", self.module, res, node.id, mode=self.mode)
536 self.id_map[node.id] = int(id)
538 if (not node.menu or eval(node.menu)) and id:
539 keyword = node.keyword or 'client_action_multi'
540 value = 'ir.actions.url,%s' % id
541 replace = node.replace or True
542 self.pool.get('ir.model.data').ir_set(self.cr, self.uid, 'action', \
543 keyword, node.url, ["ir.actions.url"], value, replace=replace, \
544 noupdate=self.isnoupdate(node), isobject=True, xml_id=node.id)
546 def process_ir_set(self, node):
547 if not self.mode == 'init':
549 _, fields = node.items()[0]
551 for fieldname, expression in fields.items():
552 if isinstance(expression, Eval):
553 value = eval(expression.expression, self.eval_context)
556 res[fieldname] = value
557 self.pool.get('ir.model.data').ir_set(self.cr, self.uid, res['key'], res['key2'], \
558 res['name'], res['models'], res['value'], replace=res.get('replace',True), \
559 isobject=res.get('isobject', False), meta=res.get('meta',None))
561 def process_report(self, node):
563 for dest, f in (('name','string'), ('model','model'), ('report_name','name')):
564 values[dest] = getattr(node, f)
565 assert values[dest], "Attribute %s of report is empty !" % (f,)
566 for field,dest in (('rml','report_rml'),('xml','report_xml'),('xsl','report_xsl'),('attachment','attachment'),('attachment_use','attachment_use')):
567 if getattr(node, field):
568 values[dest] = getattr(node, field)
570 values['auto'] = eval(node.auto)
572 sxw_content = misc.file_open(node.sxw).read()
573 values['report_sxw_content'] = sxw_content
575 values['header'] = eval(node.header)
576 values['multi'] = node.multi and eval(node.multi)
578 self.validate_xml_id(xml_id)
580 self._set_group_values(node, values)
582 id = self.pool.get('ir.model.data')._update(self.cr, self.uid, "ir.actions.report.xml", \
583 self.module, values, xml_id, noupdate=self.isnoupdate(node), mode=self.mode)
584 self.id_map[xml_id] = int(id)
586 if not node.menu or eval(node.menu):
587 keyword = node.keyword or 'client_print_multi'
588 value = 'ir.actions.report.xml,%s' % id
589 replace = node.replace or True
590 self.pool.get('ir.model.data').ir_set(self.cr, self.uid, 'action', \
591 keyword, values['name'], [values['model']], value, replace=replace, isobject=True, xml_id=xml_id)
593 def process_none(self):
595 Empty node or commented node should not pass silently.
597 self._log_assert_failure(logging.WARNING, "You have an empty block in your tests.")
600 def process(self, yaml_string):
602 Processes a Yaml string. Custom tags are interpreted by 'process_' instance methods.
604 is_preceded_by_comment = False
605 for node in yaml.load(yaml_string):
606 is_preceded_by_comment = self._log(node, is_preceded_by_comment)
608 self._process_node(node)
609 except YamlImportException, e:
610 self.logger.log(logging.ERROR, e)
612 self.logger.log(logging.ERROR, e)
615 def _process_node(self, node):
617 self.process_comment(node)
618 elif is_assert(node):
619 self.process_assert(node)
620 elif is_record(node):
621 self.process_record(node)
622 elif is_python(node):
623 self.process_python(node)
624 elif is_menuitem(node):
625 self.process_menuitem(node)
626 elif is_delete(node):
627 self.process_delete(node)
629 self.process_url(node)
630 elif is_context(node):
631 self.process_context(node)
632 elif is_ir_set(node):
633 self.process_ir_set(node)
634 elif is_act_window(node):
635 self.process_act_window(node)
636 elif is_report(node):
637 self.process_report(node)
638 elif is_workflow(node):
639 if isinstance(node, types.DictionaryType):
640 self.process_workflow(node)
642 self.process_workflow({node: []})
643 elif is_function(node):
644 if isinstance(node, types.DictionaryType):
645 self.process_function(node)
647 self.process_function({node: []})
651 raise YamlImportException("Can not process YAML block: %s" % node)
653 def _log(self, node, is_preceded_by_comment):
655 is_preceded_by_comment = True
656 self.logger.log(logging.TEST, node)
657 elif not is_preceded_by_comment:
658 if isinstance(node, types.DictionaryType):
659 msg = "Creating %s\n with %s"
660 args = node.items()[0]
661 self.logger.log(logging.TEST, msg, *args)
663 self.logger.log(logging.TEST, node)
665 is_preceded_by_comment = False
666 return is_preceded_by_comment
668 def yaml_import(cr, module, yamlfile, idref=None, mode='init', noupdate=False, report=None):
671 yaml_string = yamlfile.read()
672 yaml_interpreter = YamlInterpreter(cr, module, idref, mode, filename=yamlfile.name, noupdate=noupdate)
673 yaml_interpreter.process(yaml_string)
675 # keeps convention of convert.py
676 convert_yaml_import = yaml_import
678 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: