asserts.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
 
 
from .robottypes import type_name
from .unic import unic
 
 
 
def fail(msg=None):
    _report_failure(msg)
 
 
 
def assert_false(expr, msg=None):
    if expr:
        _report_failure(msg)
 
 
 
def assert_true(expr, msg=None):
    if not expr:
        _report_failure(msg)
 
 
 
def assert_not_none(obj, msg=None, values=True):
    
    _msg = 'is None'
    if obj is None:
        if msg is None:
            msg = _msg
        elif values is True:
            msg = '%s: %s' % (msg, _msg)
        _report_failure(msg)
 
 
 
def assert_none(obj, msg=None, values=True):
    
    _msg = '%r is not None' % obj
    if obj is not None:
        if msg is None:
            msg = _msg
        elif values is True:
            msg = '%s: %s' % (msg, _msg)
        _report_failure(msg)
 
 
 
def assert_raises(exc_class, callable_obj, *args, **kwargs):
    try:
        callable_obj(*args, **kwargs)
    except exc_class as err:
        return err
    else:
        if hasattr(exc_class,'__name__'):
            exc_name = exc_class.__name__
        else:
            exc_name = str(exc_class)
        _report_failure('%s not raised' % exc_name)
 
 
 
def assert_raises_with_msg(exc_class, expected_msg, callable_obj, *args,
                           **kwargs):
    try:
        callable_obj(*args, **kwargs)
    except exc_class as err:
        assert_equal(expected_msg, unic(err),
                     'Correct exception but wrong message')
    else:
        if hasattr(exc_class,'__name__'):
            exc_name = exc_class.__name__
        else:
            exc_name = str(exc_class)
        _report_failure('%s not raised' % exc_name)
 
 
 
def assert_equal(first, second, msg=None, values=True, formatter=None):
    if not first == second:
        _report_inequality(first, second, '!=', msg, values, formatter)
 
 
 
def assert_not_equal(first, second, msg=None, values=True, formatter=None):
    if first == second:
        _report_inequality(first, second, '==', msg, values, formatter)
 
 
 
def assert_almost_equal(first, second, places=7, msg=None, values=True):
    if round(second - first, places) != 0:
        extra = 'within %r places' % places
        _report_inequality(first, second, '!=', msg, values, extra=extra)
 
 
 
def assert_not_almost_equal(first, second, places=7, msg=None, values=True):
    if round(second-first, places) == 0:
        extra = 'within %r places' % places
        _report_inequality(first, second, '==', msg, values, extra=extra)
 
 
def _report_failure(msg):
    if msg is None:
        raise AssertionError()
    raise AssertionError(msg)
 
 
def _report_inequality(obj1, obj2, delim, msg=None, values=False,
                       formatter=None, extra=None):
    if not msg:
        msg = _format_message(obj1, obj2, delim, formatter)
    elif values:
        msg = '%s: %s' % (msg, _format_message(obj1, obj2, delim, formatter))
    if values and extra:
        msg += ' ' + extra
    raise AssertionError(msg)
 
 
def _format_message(obj1, obj2, delim, formatter=None):
    formatter = formatter or unic
    str1 = formatter(obj1)
    str2 = formatter(obj2)
    if delim == '!=' and str1 == str2:
        return '%s (%s) != %s (%s)' % (str1, type_name(obj1),
                                       str2, type_name(obj2))
    return '%s %s %s' % (str1, delim, str2)