lodel2_mirror/EditorialModel/test/test_field.py

import os
import logging
import datetime

from django.conf import settings
from unittest import TestCase
import unittest

from EditorialModel.components import EmComponent, EmComponentNotExistError
from EditorialModel.fields import EmField
from EditorialModel.classes import EmClass
from EditorialModel.classtypes import EmClassType
from EditorialModel.types import EmType
from EditorialModel.fieldgroups import EmFieldGroup
from EditorialModel.test.utils import *
from EditorialModel.fieldtypes import *

from Database import sqlutils

import sqlalchemy as sqla

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "Lodel.settings")

TEST_FIELD_DBNAME = 'lodel2_test_field_db.sqlite'

## SetUpModule
#
# This function is called once for this module.
# It is designed to overwrite the database configurations, and prepare objects for test_case initialization
def setUpModule():
    initTestDb(TEST_FIELD_DBNAME)
    setDbConf(TEST_FIELD_DBNAME)
    logging.basicConfig(level=logging.CRITICAL)
    pass

def tearDownModule():
    cleanDb(TEST_FIELD_DBNAME)
    pass


## FieldTestCase (Class)
#
# The parent class of all other test cases for the fields module.
# It defines a SetUp function and some utility functions for EmField tests.
class FieldTestCase(TestCase):

    @classmethod
    def setUpClass(cls):
        sqlsetup.init_db()

        # Generation of the test data
        testclass = EmClass.create("testclass1",EmClassType.entity)
        EmField_integer()
        EmFieldGroup.create('fieldgrp1',testclass)
        EmType.create('testtype1',testclass)
        saveDbState(TEST_FIELD_DBNAME)


    def setUp(self):
        restoreDbState(TEST_FIELD_DBNAME)
        self.testClass = EmClass("testclass1")
        self.testFieldType = EmField_integer()
        self.testFieldgroup = EmFieldGroup('fieldgrp1')
        self.testType = EmType('testtype1')

    ## Get_Field_Records (Function)
    #
    # Returns the list of fields corresponding to a given uid
    #
    # @param field EmField: EmField object
    # @return Number of found records
    def get_field_records(self,field):
        return self._get_field_records_Db(field)

    ## _Get_Field_Records_Db (Function)
    #
    # Queries the database to get the list of fields for a given uid
    #
    # @param field EmField: EmField object
    # @return Number of found records
    def _get_field_records_Db(self,field):
        dbe = field.db_engine
        fieldtable = sqla.Table(EmField.table, sqlutils.meta(dbe))
        conn = dbe.connect()
        req = fieldtable.select().where(fieldtable.c.uid==field.uid).where(fieldtable.c.name==field.name)
        res = conn.execute(req).fetchall()

        return len(res)

    ## Get_table_columns (Function)
    #
    # Returns the columns list of a table
    #
    # @param table_name str: Name of the table
    # @return list of columns
    def get_table_columns(self,table_name):
        return self._get_table_columns_Db(table_name)

    ## _Get_table_columns_Db (Function)
    #
    # Queries the database to get the list of columns of a table
    #
    # @param table_name str: Name of the table
    # @return list of columns
    def _get_table_columns_Db(self, table_name):
        dbe = self.testClass.db_engine
        table = sqla.Table(table_name, sqlutils.meta(dbe))
        return table.c

## TestField (Class)
#
# The test class for the fields module
class TestField(FieldTestCase):

    ## Test_create (Function)
    #
    # tests the creation process of a field
    def testCreate(self):
        """ Testing fields creation process """
        '''
        field_values = {
            'name':'testfield1',
            'fieldgroup_id' : self.testFieldgroup.uid,
            'fieldtype' : self.testFieldType,
            'rel_to_type_id': self.testType.uid
        }
        '''
        field = EmField.create(name='testfield1', fieldgroup=self.testFieldgroup, fieldtype=self.testFieldType)

        # We check that the field has been added in the em_field table
        field_records = self.get_field_records(field)
        self.assertGreater(field_records,0)

        # We check that the field has been added as a column in the corresponding table
        field_table_columns = self.get_table_columns(field.get_class_table())
        field_column_args = self.testFieldType.sqlalchemy_args()
        field_column_args['name']='testfield1'
        field_column = sqla.Column(**field_column_args)
        self.assertIn(field_column.name, field_table_columns)
        pass
    
    def test_deletion(self):
        """ Testing fields deletion process """
        field_names = ['field1', 'field2']
        for name in field_names:
            EmField.create(name=name, fieldgroup=self.testFieldgroup, fieldtype = self.testFieldType)

        for i,name in enumerate(field_names):
            test_field = EmField(name)
            self.assertTrue(test_field.delete())

            cols = self.get_table_columns(self.testClass.name)
            for deleted_name in field_names[:i+1]:
                self.assertNotIn(deleted_name, cols, "Column is  not deleted")
            for not_deleted_name in field_names[i+1:]:
                self.assertIn(not_deleted_name, cols, "A bad column was deleted")
                
            with self.assertRaises(EmComponentNotExistError, msg="This field should be deleted"):
                EmField(name)