lodel2_mirror/tests/leapi/test_leobject.py

# 
# This file is part of Lodel 2 (https://github.com/OpenEdition)
#
# Copyright (C) 2015-2017 Cléo UMS-3287
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#


import unittest
from unittest import mock
from unittest.mock import patch

import tests.loader_utils
import leapi_dyncode as dyncode

from lodel.leapi.leobject import LeObject
from lodel.leapi.query import LeDeleteQuery, LeUpdateQuery, LeGetQuery, \
    LeInsertQuery
from lodel.leapi.exceptions import *

class LeObjectDummyTestCase(unittest.TestCase):
    """ Testing LeObject method with a dummy datasource """

    def test_init(self):
        """ Testing LeObject child class __init__ """
        dyncode.Person(
            lodel_id = '1',
            lastname = "Foo",
            firstname = "Bar",
            alias = "Foobar")

    def test_init_abstract(self):
        """ Testing init abstract LeObject childs """
        abstract_classes = [
            dyncode.Entitie, dyncode.Indexabs]
        for cls in abstract_classes:
            with self.assertRaises(NotImplementedError):
                cls(lodel_id = 1)

    def test_init_bad_fields(self):
        """ Testing init with bad arguments """
        with self.assertRaises(LeApiErrors):
            dyncode.Person(
                lodel_id = 1,
                foobar = "barfoo")
        with self.assertRaises(LeApiError):
            dyncode.Person(lastname = "foo", firstname = "bar")

    def test_data_accessor(self):
        """ Testing data accessor method """
        inst = dyncode.Person(lodel_id = 1, lastname = "foo")
        self.assertEqual(inst.data('lodel_id'), 1)
        self.assertEqual(inst.data('lastname'), 'foo')

    def test_data_accessor_fails(self):
        """ Testing that data accessor detects unitialized fields """
        inst = dyncode.Person(lodel_id = 1, lastname = "foo")
        with self.assertRaises(RuntimeError):
            inst.data('firstname')

    def test_name2class(self):
        """ Testing the class method that returns a dynamic object given it's
            name """
        self.assertEqual(dyncode.Object.name2class('Person'), dyncode.Person)
        self.assertEqual(dyncode.Object.name2class('Object'), dyncode.Object)
    
    def test_bad_name2class(self):
        """ Testing failures of the class method that returns a dynamic object
            given it's name """
        badnames = ['foobar', 'str', str, None, 42]
        callers = [dyncode.Object, dyncode.Person, dyncode.Entitie]
        for caller in callers:
            for badname in badnames:
                with self.assertRaises(LeApiError, msg="LeApiError not raised \
but invalid name %s was given" % badname):
                    caller.name2class(badname)

    def test_abstract_name2class(self):
        with self.assertRaises(NotImplementedError):
            LeObject.name2class('Person')
        with self.assertRaises(NotImplementedError):
            LeObject.name2class(42)

    def test_initilized(self):
        """ Testing initialized method """
        inst = dyncode.Person(
            lodel_id = 1, lastname="foo")
        self.assertFalse(inst.initialized)

    def test_uid_fieldname(self):
        self.assertEqual(dyncode.Person.uid_fieldname(), ["lodel_id"])

    def test_fieldnames_accessor(self):
        """ Testing fieldnames() accessor method """
        fnames = dyncode.Person.fieldnames(False)
        self.assertEqual(set(fnames),
            {'lastname', 'linked_texts', 'firstname', 'alias'})

    def test_bad_insert(self):
        """ Insert with bad arguments """
        badargs = [
            {},
            {'lodel_id': 1,'lastname': 'foo', 'firstname': 'bar'}]
        
        for arg in badargs:
            with self.assertRaises(LeApiDataCheckErrors):
                dyncode.Person.insert(arg)

    def test_delete_instance(self):
        """ Testing instance method delete """
        inst = dyncode.Person(
            lodel_id = 1, firstname = "foo", lastname = "bar")
        inst.delete()


class LeObjectQueryMockTestCase(unittest.TestCase):
    """ Testing LeObject mocking LeQuery objects """

    def test_insert(self):
        """ Checking that LeObject insert method calls LeInsertQuery
            correctly """
        datas = {'lastname': 'foo', 'firstname': 'bar'}
        with patch.object(
            LeInsertQuery, '__init__', return_value = None) as mock_init:

            try:
                dyncode.Person.insert(datas)
            except AttributeError:
                pass #Because of mock
            mock_init.assert_called_once_with(dyncode.Person)

        with patch.object(
            LeInsertQuery, 'execute', return_value = 42) as mock_insert:

            ret = dyncode.Person.insert(datas)
            self.assertEqual(ret, 42, 'Bad return value forwarding')
            mock_insert.assert_called_once_with(datas)
    
    def test_delete(self):
        """ Checking that LeObject delete method calls LeDeleteQuery
            correctly """
        with patch.object(
            LeDeleteQuery, '__init__', return_value = None) as mock_init:

            inst = dyncode.Person(
                lodel_id = 1, firstname = "foo", lastname = "bar")
            try:
                inst.delete()
            except AttributeError:
                pass
            mock_init.assert_called_once_with(
                dyncode.Person, [('lodel_id', '=', 1)])

        with patch.object(
            LeDeleteQuery, 'execute', return_value = 1) as mock_execute:

            inst = dyncode.Person(
                lodel_id = 1, firstname = "foo", lastname = "bar")
            ret = inst.delete()
            self.assertEqual(ret, 1, 'Bad return value forwarding')
            mock_execute.assert_called_once_with()

    def test_delete_bundle(self):
        """ Checking that LeObject delete_bundle method calls LeDeleteQuery
            correctly """
        with patch.object(
            LeDeleteQuery, '__init__', return_value = None) as mock_init:
            
            try:
                dyncode.Person.delete_bundle(['lodel_id > 1'])
            except AttributeError:
                pass
            mock_init.assert_called_once_with(
                dyncode.Person, ['lodel_id > 1'])

        with patch.object(
            LeDeleteQuery, 'execute', return_value = 1) as mock_execute:
            
            dyncode.Person.delete_bundle(['lodel_id > 1'])
            mock_execute.assert_called_once_with()

    def test_update_instance(self):
        """ Checking that LeObject update method calls LeUpdateQuery
            correctly """
        with patch.object(
            LeUpdateQuery, '__init__', return_value = None) as mock_init:
            with patch.object(
                LeObject, 'datas', return_value = {
                    'lodel_id': 1, 'firstname': 'foo', 'lastname': 'bar',
                    'fullname': 'Foo Bar', 'alias': None }) as mock_datas:
            
                inst = dyncode.Person(
                    lodel_id = 1, firstname = "foo", lastname = "bar")
                try:
                   inst.update()
                except AttributeError:
                    pass
                mock_init.assert_called_once_with(
                    dyncode.Person, [('lodel_id', '=', 1)])
        
        with patch.object(
            LeUpdateQuery, 'execute', return_value = None) as mock_update:
            with patch.object(
                LeObject, 'datas', return_value = {
                    'lodel_id': 1, 'firstname': 'foo', 'lastname': 'bar',
                    'fullname': 'Foo Bar', 'alias': None }) as mock_datas:
            
                inst = dyncode.Person(
                    lodel_id = 1, firstname = "foo", lastname = "bar")
                inst.update()
                mock_update.assert_called_once_with({
                    'lodel_id': 1, 'firstname': 'foo', 'lastname': 'bar',
                    'fullname': 'Foo Bar', 'alias': None })
                    
    
    def test_get(self):
        """ Checking that LeObject.get method calls LeGetQuery
            correctly """
        get_args = {
            'query_filters': ['lodel_id = 1'],
            'field_list': ['firstname'],
            'order': ['firstname'],
            'group': ['alias'],
            'limit': 42,
            'offset': 24}

        with patch.object(
            LeGetQuery, '__init__', return_value = None) as mock_init:
            
            try:
                dyncode.Person.get(**get_args)
            except AttributeError:
                pass

            mock_init.assert_called_once_with(
                dyncode.Person,
                **get_args)

        ret_val = [{
            'lodel_id': 1,
            'firstname': 'foo',
            'lastname': 'bar',
            'fullname': 'foo bar',
            'alias': None,
            'classname': 'Person'}]
        with patch.object(
            LeGetQuery, 'execute', return_value = ret_val) as mock_execute:
            results = dyncode.Person.get(**get_args)
            mock_execute.assert_called_once_with()
            res = results[0]
            self.assertEqual(res.d.lodel_id, 1)
            self.assertEqual(res.d.firstname, 'foo')
            self.assertEqual(res.d.lastname, 'bar')

    def test_get_mini(self):
        """ Checking that LeObject.get method calls LeGetQuery correctly
            when called with minimum args """
            
        with patch.object(
            LeGetQuery, '__init__', return_value = None) as mock_init:
        
            try:
                dyncode.Person.get(['lodel_id = 1'])
            except AttributeError:
                pass
            
            mock_init.assert_called_once_with(
                dyncode.Person,
                query_filters = ['lodel_id = 1'],
                field_list = None,
                order = None, group = None, limit = None, offset = 0)

        with patch.object(
            LeGetQuery, 'execute', return_value = []) as mock_exec:
            
            dyncode.Person.get(['lodel_id = 1'])
            mock_exec.assert_called_once_with()