"""unit tests for module cubicweb.server.migractions

:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses

"""

from copy import deepcopy

from datetime import date

from os.path import join

from logilab.common.testlib import TestCase, unittest_main

from cubicweb import ConfigurationError

from cubicweb.devtools.testlib import CubicWebTC

from cubicweb.schema import CubicWebSchemaLoader

from cubicweb.server.sqlutils import SQL_PREFIX

from cubicweb.server.migractions import *

migrschema = None

def teardown_module(*args):

    global migrschema

    del migrschema

    del MigrationCommandsTC.origschema

class MigrationCommandsTC(CubicWebTC):

    @classmethod

    def init_config(cls, config):

        super(MigrationCommandsTC, cls).init_config(config)

        # we have to read schema from the database to get eid for schema entities

        config._cubes = None

        cls.repo.fill_schema()

        cls.origschema = deepcopy(cls.repo.schema)

        # hack to read the schema from data/migrschema

        config.appid = join('data', 'migratedapp')

        global migrschema

        migrschema = config.load_schema()

        config.appid = 'data'

        assert 'Folder' in migrschema

    @classmethod

    def _refresh_repo(cls):

        super(MigrationCommandsTC, cls)._refresh_repo()

        cls.repo.set_schema(deepcopy(cls.origschema), resetvreg=False)

        # reset migration schema eids

        for eschema in migrschema.entities():

            eschema.eid = None

        for rschema in migrschema.relations():

            rschema.eid = None

            for rdef in rschema.rdefs.values():

                rdef.eid = None

    def setUp(self):

        CubicWebTC.setUp(self)

        self.mh = ServerMigrationHelper(self.repo.config, migrschema,

                                        repo=self.repo, cnx=self.cnx,

                                        interactive=False)

        assert self.cnx is self.mh._cnx

        assert self.session is self.mh.session, (self.session.id, self.mh.session.id)

    def test_add_attribute_int(self):

        self.failIf('whatever' in self.schema)

        self.request().create_entity('Note')

        self.commit()

        orderdict = dict(self.mh.rqlexec('Any RTN, O WHERE X name "Note", RDEF from_entity X, '

                                         'RDEF relation_type RT, RDEF ordernum O, RT name RTN'))

        self.mh.cmd_add_attribute('Note', 'whatever')

        self.failUnless('whatever' in self.schema)

        self.assertEquals(self.schema['whatever'].subjects(), ('Note',))

        self.assertEquals(self.schema['whatever'].objects(), ('Int',))

        self.assertEquals(self.schema['Note'].default('whatever'), 2)

        note = self.execute('Note X').get_entity(0, 0)

        self.assertEquals(note.whatever, 2)

        orderdict2 = dict(self.mh.rqlexec('Any RTN, O WHERE X name "Note", RDEF from_entity X, '

                                          'RDEF relation_type RT, RDEF ordernum O, RT name RTN'))

        whateverorder = migrschema['whatever'].rdef('Note', 'Int').order

        for k, v in orderdict.iteritems():

            if v >= whateverorder:

                orderdict[k] = v+1

        orderdict['whatever'] = whateverorder

        self.assertDictEquals(orderdict, orderdict2)

        #self.assertEquals([r.type for r in self.schema['Note'].ordered_relations()],

        #                  ['modification_date', 'creation_date', 'owned_by',

        #                   'eid', 'ecrit_par', 'inline1', 'date', 'type',

        #                   'whatever', 'date', 'in_basket'])

        # NB: commit instead of rollback make following test fail with py2.5

        #     this sounds like a pysqlite/2.5 bug (the same eid is affected to

        #     two different entities)

        self.mh.rollback()

    def test_add_attribute_varchar(self):

        self.failIf('shortpara' in self.schema)

        self.mh.cmd_add_attribute('Note', 'shortpara')

        self.failUnless('shortpara' in self.schema)

        self.assertEquals(self.schema['shortpara'].subjects(), ('Note', ))

        self.assertEquals(self.schema['shortpara'].objects(), ('String', ))

        # test created column is actually a varchar(64)

        notesql = self.mh.sqlexec("SELECT sql FROM sqlite_master WHERE type='table' and name='%sNote'" % SQL_PREFIX)[0][0]

        fields = dict(x.strip().split()[:2] for x in notesql.split('(', 1)[1].rsplit(')', 1)[0].split(','))

        self.assertEquals(fields['%sshortpara' % SQL_PREFIX], 'varchar(64)')

        self.mh.rollback()

    def test_add_datetime_with_default_value_attribute(self):

        self.failIf('mydate' in self.schema)

        self.failIf('shortpara' in self.schema)

        self.mh.cmd_add_attribute('Note', 'mydate')

        self.failUnless('mydate' in self.schema)

        self.assertEquals(self.schema['mydate'].subjects(), ('Note', ))

        self.assertEquals(self.schema['mydate'].objects(), ('Date', ))

        testdate = date(2005, 12, 13)

        eid1 = self.mh.rqlexec('INSERT Note N')[0][0]

        eid2 = self.mh.rqlexec('INSERT Note N: N mydate %(mydate)s', {'mydate' : testdate})[0][0]

        d1 = self.mh.rqlexec('Any D WHERE X eid %(x)s, X mydate D', {'x': eid1})[0][0]

        d2 = self.mh.rqlexec('Any D WHERE X eid %(x)s, X mydate D', {'x': eid2})[0][0]

        self.assertEquals(d1, date.today())

        self.assertEquals(d2, testdate)

        self.mh.rollback()

    def test_rename_attribute(self):

        self.failIf('civility' in self.schema)

        eid1 = self.mh.rqlexec('INSERT Personne X: X nom "lui", X sexe "M"')[0][0]

        eid2 = self.mh.rqlexec('INSERT Personne X: X nom "l\'autre", X sexe NULL')[0][0]

        self.mh.cmd_rename_attribute('Personne', 'sexe', 'civility')

        self.failIf('sexe' in self.schema)

        self.failUnless('civility' in self.schema)

        # test data has been backported

        c1 = self.mh.rqlexec('Any C WHERE X eid %s, X civility C' % eid1)[0][0]

        self.failUnlessEqual(c1, 'M')

        c2 = self.mh.rqlexec('Any C WHERE X eid %s, X civility C' % eid2)[0][0]

        self.failUnlessEqual(c2, None)

    def test_workflow_actions(self):

        wf = self.mh.cmd_add_workflow(u'foo', ('Personne', 'Email'))

        for etype in ('Personne', 'Email'):

            s1 = self.mh.rqlexec('Any N WHERE WF workflow_of ET, ET name "%s", WF name N' %

                                 etype)[0][0]

            self.assertEquals(s1, "foo")

            s1 = self.mh.rqlexec('Any N WHERE ET default_workflow WF, ET name "%s", WF name N' %

                                 etype)[0][0]

            self.assertEquals(s1, "foo")

    def test_add_entity_type(self):

        self.failIf('Folder2' in self.schema)

        self.failIf('filed_under2' in self.schema)

        self.mh.cmd_add_entity_type('Folder2')

        self.failUnless('Folder2' in self.schema)

        self.failUnless(self.execute('CWEType X WHERE X name "Folder2"'))

        self.failUnless('filed_under2' in self.schema)

        self.failUnless(self.execute('CWRType X WHERE X name "filed_under2"'))

        self.schema.rebuild_infered_relations()

        self.assertEquals(sorted(str(rs) for rs in self.schema['Folder2'].subject_relations()),

                          ['created_by', 'creation_date', 'cwuri',

                           'description', 'description_format',

                           'eid',

                           'filed_under2', 'has_text',

                           'identity', 'in_basket', 'is', 'is_instance_of',

                           'modification_date', 'name', 'owned_by'])

        self.assertEquals([str(rs) for rs in self.schema['Folder2'].object_relations()],

                          ['filed_under2', 'identity'])

        self.assertEquals(sorted(str(e) for e in self.schema['filed_under2'].subjects()),

                          sorted(str(e) for e in self.schema.entities() if not e.final))

        self.assertEquals(self.schema['filed_under2'].objects(), ('Folder2',))

        eschema = self.schema.eschema('Folder2')

        for cstr in eschema.rdef('name').constraints:

            self.failUnless(hasattr(cstr, 'eid'))

    def test_add_drop_entity_type(self):

        self.mh.cmd_add_entity_type('Folder2')

        wf = self.mh.cmd_add_workflow(u'folder2 wf', 'Folder2')

        todo = wf.add_state(u'todo', initial=True)

        done = wf.add_state(u'done')

        wf.add_transition(u'redoit', done, todo)

        wf.add_transition(u'markasdone', todo, done)

        self.commit()

        eschema = self.schema.eschema('Folder2')

        self.mh.cmd_drop_entity_type('Folder2')

        self.failIf('Folder2' in self.schema)

        self.failIf(self.execute('CWEType X WHERE X name "Folder2"'))

        # test automatic workflow deletion

        self.failIf(self.execute('Workflow X WHERE NOT X workflow_of ET'))

        self.failIf(self.execute('State X WHERE NOT X state_of WF'))

        self.failIf(self.execute('Transition X WHERE NOT X transition_of WF'))

    def test_add_drop_relation_type(self):

        self.mh.cmd_add_entity_type('Folder2', auto=False)

        self.mh.cmd_add_relation_type('filed_under2')

        self.schema.rebuild_infered_relations()

        self.failUnless('filed_under2' in self.schema)

        self.assertEquals(sorted(str(e) for e in self.schema['filed_under2'].subjects()),

                          sorted(str(e) for e in self.schema.entities() if not e.final))

        self.assertEquals(self.schema['filed_under2'].objects(), ('Folder2',))

        self.mh.cmd_drop_relation_type('filed_under2')

        self.failIf('filed_under2' in self.schema)

    def test_add_relation_definition_nortype(self):

        self.mh.cmd_add_relation_definition('Personne', 'concerne2', 'Affaire')

        self.assertEquals(self.schema['concerne2'].subjects(),

                          ('Personne',))

        self.assertEquals(self.schema['concerne2'].objects(),

                          ('Affaire', ))

        self.assertEquals(self.schema['concerne2'].rdef('Personne', 'Affaire').cardinality,

                          '1*')

        self.mh.cmd_add_relation_definition('Personne', 'concerne2', 'Note')

        self.assertEquals(sorted(self.schema['concerne2'].objects()), ['Affaire', 'Note'])

        self.mh.create_entity('Personne', nom=u'tot')

        self.mh.create_entity('Affaire')

        self.mh.rqlexec('SET X concerne2 Y WHERE X is Personne, Y is Affaire')

        self.commit()

        self.mh.cmd_drop_relation_definition('Personne', 'concerne2', 'Affaire')

        self.failUnless('concerne2' in self.schema)

        self.mh.cmd_drop_relation_definition('Personne', 'concerne2', 'Note')

        self.failIf('concerne2' in self.schema)

    def test_drop_relation_definition_existant_rtype(self):

        self.assertEquals(sorted(str(e) for e in self.schema['concerne'].subjects()),

                          ['Affaire', 'Personne'])

        self.assertEquals(sorted(str(e) for e in self.schema['concerne'].objects()),

                          ['Affaire', 'Division', 'Note', 'Societe', 'SubDivision'])

        self.mh.cmd_drop_relation_definition('Personne', 'concerne', 'Affaire')

        self.assertEquals(sorted(str(e) for e in self.schema['concerne'].subjects()),

                          ['Affaire'])

        self.assertEquals(sorted(str(e) for e in self.schema['concerne'].objects()),

                          ['Division', 'Note', 'Societe', 'SubDivision'])

        self.mh.cmd_add_relation_definition('Personne', 'concerne', 'Affaire')

        self.assertEquals(sorted(str(e) for e in self.schema['concerne'].subjects()),

                          ['Affaire', 'Personne'])

        self.assertEquals(sorted(str(e) for e in self.schema['concerne'].objects()),

                          ['Affaire', 'Division', 'Note', 'Societe', 'SubDivision'])

        # trick: overwrite self.maxeid to avoid deletion of just reintroduced types

        self.maxeid = self.execute('Any MAX(X)')[0][0]

    def test_drop_relation_definition_with_specialization(self):

        self.assertEquals(sorted(str(e) for e in self.schema['concerne'].subjects()),

                          ['Affaire', 'Personne'])

        self.assertEquals(sorted(str(e) for e in self.schema['concerne'].objects()),

                          ['Affaire', 'Division', 'Note', 'Societe', 'SubDivision'])

        self.mh.cmd_drop_relation_definition('Affaire', 'concerne', 'Societe')

        self.assertEquals(sorted(str(e) for e in self.schema['concerne'].subjects()),

                          ['Affaire', 'Personne'])

        self.assertEquals(sorted(str(e) for e in self.schema['concerne'].objects()),

                          ['Affaire', 'Division', 'Note', 'SubDivision'])

        self.schema.rebuild_infered_relations() # need to be explicitly called once everything is in place

        self.assertEquals(sorted(str(e) for e in self.schema['concerne'].objects()),

                          ['Affaire', 'Note'])

        self.mh.cmd_add_relation_definition('Affaire', 'concerne', 'Societe')

        self.assertEquals(sorted(str(e) for e in self.schema['concerne'].subjects()),

                          ['Affaire', 'Personne'])

        self.assertEquals(sorted(str(e) for e in self.schema['concerne'].objects()),

                          ['Affaire', 'Note', 'Societe'])

        self.schema.rebuild_infered_relations() # need to be explicitly called once everything is in place

        self.assertEquals(sorted(str(e) for e in self.schema['concerne'].objects()),

                          ['Affaire', 'Division', 'Note', 'Societe', 'SubDivision'])

        # trick: overwrite self.maxeid to avoid deletion of just reintroduced types

        self.maxeid = self.execute('Any MAX(X)')[0][0]

    def test_rename_relation(self):

        self.skip('implement me')

    def test_change_relation_props_non_final(self):

        rschema = self.schema['concerne']

        card = rschema.rdef('Affaire', 'Societe').cardinality

        self.assertEquals(card, '**')

        try:

            self.mh.cmd_change_relation_props('Affaire', 'concerne', 'Societe',

                                              cardinality='?*')

            card = rschema.rdef('Affaire', 'Societe').cardinality

            self.assertEquals(card, '?*')

        finally:

            self.mh.cmd_change_relation_props('Affaire', 'concerne', 'Societe',

                                              cardinality='**')

    def test_change_relation_props_final(self):

        rschema = self.schema['adel']

        card = rschema.rdef('Personne', 'String').fulltextindexed

        self.assertEquals(card, False)

        try:

            self.mh.cmd_change_relation_props('Personne', 'adel', 'String',

                                              fulltextindexed=True)

            card = rschema.rdef('Personne', 'String').fulltextindexed

            self.assertEquals(card, True)

        finally:

            self.mh.cmd_change_relation_props('Personne', 'adel', 'String',

                                              fulltextindexed=False)

    def test_sync_schema_props_perms(self):

        cursor = self.mh.session

        cursor.set_pool()

        nbrqlexpr_start = cursor.execute('Any COUNT(X) WHERE X is RQLExpression')[0][0]

        migrschema['titre'].rdefs[('Personne', 'String')].order = 7

        migrschema['adel'].rdefs[('Personne', 'String')].order = 6

        migrschema['ass'].rdefs[('Personne', 'String')].order = 5

        migrschema['Personne'].description = 'blabla bla'

        migrschema['titre'].description = 'usually a title'

        migrschema['titre'].rdefs[('Personne', 'String')].description = 'title for this person'

        delete_concerne_rqlexpr = self._rrqlexpr_rset('delete', 'concerne')

        add_concerne_rqlexpr = self._rrqlexpr_rset('add', 'concerne')

        self.mh.cmd_sync_schema_props_perms(commit=False)

        self.assertEquals(cursor.execute('Any D WHERE X name "Personne", X description D')[0][0],

                          'blabla bla')

        self.assertEquals(cursor.execute('Any D WHERE X name "titre", X description D')[0][0],

                          'usually a title')

        self.assertEquals(cursor.execute('Any D WHERE X relation_type RT, RT name "titre",'

                                         'X from_entity FE, FE name "Personne",'

                                         'X description D')[0][0],

                          'title for this person')

        rinorder = [n for n, in cursor.execute(

            'Any N ORDERBY O WHERE X is CWAttribute, X relation_type RT, RT name N,'

            'X from_entity FE, FE name "Personne",'

            'X ordernum O')]

        expected = [u'nom', u'prenom', u'sexe', u'promo', u'ass', u'adel', u'titre',

                    u'web', u'tel', u'fax', u'datenaiss', u'test', 'description', u'firstname',

                    u'creation_date', 'cwuri', u'modification_date']

        self.assertEquals(rinorder, expected)

        # test permissions synchronization ####################################

        # new rql expr to add note entity

        eexpr = self._erqlexpr_entity('add', 'Note')

        self.assertEquals(eexpr.expression,

                          'X ecrit_part PE, U in_group G, '

                          'PE require_permission P, P name "add_note", P require_group G')

        self.assertEquals([et.name for et in eexpr.reverse_add_permission], ['Note'])

        self.assertEquals(eexpr.reverse_read_permission, ())

        self.assertEquals(eexpr.reverse_delete_permission, ())

        self.assertEquals(eexpr.reverse_update_permission, ())