[schema migration] import refactoring to fix #1109558 and enhances things on the way
the main pb demonstrated by #1109558 was due to the fact that in-memory schema
was updated in commit_event of operations. This is undesired in most cases,
since we want the modification to be taken into account in the interval between
the modification detection and the commit_event.
I've fixed this by merging in-memory schema / database alteration operations
for most important changes, doing in-memory schema changes as they are detected
and implementing a revertcommit_event method to revert them if necessary (with
exception for removal of stuff from the schema, where this is simply done in a
postcommit_event methods).
Also, I've benefited from this to support reverting of database alteration for
some operations (more to be done there), and to move so system source alteration
code to the native source code for a nicer design.
There may be some more stuff in syncschema.py that would benefit from similar
changes, but most important things are done (at least to close #1109558, w/
unittest_syncschema and unittest_migration green).
# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr## This file is part of CubicWeb.## CubicWeb is free software: you can redistribute it and/or modify it under the# terms of the GNU Lesser General Public License as published by the Free# Software Foundation, either version 2.1 of the License, or (at your option)# any later version.## CubicWeb 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 Lesser General Public License for more# details.## You should have received a copy of the GNU Lesser General Public License along# with CubicWeb. If not, see <http://www.gnu.org/licenses/>.fromlogilab.common.testlibimportTestCase,unittest_mainfromcubicwebimportValidationErrorfromcubicweb.devtools.testlibimportCubicWebTCfromcubicweb.server.sqlutilsimportSQL_PREFIXfromcubicweb.devtools.repotestimportschema_eids_idx,restore_schema_eids_idxdefteardown_module(*args):delSchemaModificationHooksTC.schema_eidsclassSchemaModificationHooksTC(CubicWebTC):reset_schema=True@classmethoddefinit_config(cls,config):super(SchemaModificationHooksTC,cls).init_config(config)# we have to read schema from the database to get eid for schema entitiesconfig._cubes=Nonecls.repo.fill_schema()cls.schema_eids=schema_eids_idx(cls.repo.schema)@classmethoddef_refresh_repo(cls):super(SchemaModificationHooksTC,cls)._refresh_repo()restore_schema_eids_idx(cls.repo.schema,cls.schema_eids)defindex_exists(self,etype,attr,unique=False):self.session.set_pool()dbhelper=self.session.pool.source('system').dbhelpersqlcursor=self.session.pool['system']returndbhelper.index_exists(sqlcursor,SQL_PREFIX+etype,SQL_PREFIX+attr,unique=unique)def_set_perms(self,eid):self.execute('SET X read_permission G WHERE X eid %(x)s, G is CWGroup',{'x':eid})self.execute('SET X add_permission G WHERE X eid %(x)s, G is CWGroup, G name "managers"',{'x':eid})self.execute('SET X delete_permission G WHERE X eid %(x)s, G is CWGroup, G name "owners"',{'x':eid})def_set_attr_perms(self,eid):self.execute('SET X read_permission G WHERE X eid %(x)s, G is CWGroup',{'x':eid})self.execute('SET X update_permission G WHERE X eid %(x)s, G is CWGroup, G name "managers"',{'x':eid})deftest_base(self):schema=self.repo.schemaself.session.set_pool()dbhelper=self.session.pool.source('system').dbhelpersqlcursor=self.session.pool['system']self.failIf(schema.has_entity('Societe2'))self.failIf(schema.has_entity('concerne2'))# schema should be update on insertion (after commit)eeid=self.execute('INSERT CWEType X: X name "Societe2", X description "", X final FALSE')[0][0]self._set_perms(eeid)self.execute('INSERT CWRType X: X name "concerne2", X description "", X final FALSE, X symmetric FALSE')self.failIf(schema.has_entity('Societe2'))self.failIf(schema.has_entity('concerne2'))# have to commit before adding definition relationsself.commit()self.failUnless(schema.has_entity('Societe2'))self.failUnless(schema.has_relation('concerne2'))attreid=self.execute('INSERT CWAttribute X: X cardinality "11", X defaultval "noname", '' X indexed TRUE, X relation_type RT, X from_entity E, X to_entity F ''WHERE RT name "name", E name "Societe2", F name "String"')[0][0]self._set_attr_perms(attreid)concerne2_rdef_eid=self.execute('INSERT CWRelation X: X cardinality "**", X relation_type RT, X from_entity E, X to_entity E ''WHERE RT name "concerne2", E name "Societe2"')[0][0]self._set_perms(concerne2_rdef_eid)self.failIf('name'inschema['Societe2'].subject_relations())self.failIf('concerne2'inschema['Societe2'].subject_relations())self.failIf(self.index_exists('Societe2','name'))self.commit()self.failUnless('name'inschema['Societe2'].subject_relations())self.failUnless('concerne2'inschema['Societe2'].subject_relations())self.failUnless(self.index_exists('Societe2','name'))# now we should be able to insert and query Societe2s2eid=self.execute('INSERT Societe2 X: X name "logilab"')[0][0]self.execute('Societe2 X WHERE X name "logilab"')self.execute('SET X concerne2 X WHERE X name "logilab"')rset=self.execute('Any X WHERE X concerne2 Y')self.assertEquals(rset.rows,[[s2eid]])# check that when a relation definition is deleted, existing relations are deletedrdefeid=self.execute('INSERT CWRelation X: X cardinality "**", X relation_type RT, '' X from_entity E, X to_entity E ''WHERE RT name "concerne2", E name "CWUser"')[0][0]self._set_perms(rdefeid)self.commit()self.execute('DELETE CWRelation X WHERE X eid %(x)s',{'x':concerne2_rdef_eid})self.commit()self.failUnless('concerne2'inschema['CWUser'].subject_relations())self.failIf('concerne2'inschema['Societe2'].subject_relations())self.failIf(self.execute('Any X WHERE X concerne2 Y'))# schema should be cleaned on delete (after commit)self.execute('DELETE CWEType X WHERE X name "Societe2"')self.execute('DELETE CWRType X WHERE X name "concerne2"')self.failUnless(self.index_exists('Societe2','name'))self.failUnless(schema.has_entity('Societe2'))self.failUnless(schema.has_relation('concerne2'))self.commit()self.failIf(self.index_exists('Societe2','name'))self.failIf(schema.has_entity('Societe2'))self.failIf(schema.has_entity('concerne2'))self.failIf('concerne2'inschema['CWUser'].subject_relations())deftest_is_instance_of_insertions(self):seid=self.execute('INSERT Transition T: T name "subdiv"')[0][0]is_etypes=[etypeforetype,inself.execute('Any ETN WHERE X eid %s, X is ET, ET name ETN'%seid)]self.assertEquals(is_etypes,['Transition'])instanceof_etypes=[etypeforetype,inself.execute('Any ETN WHERE X eid %s, X is_instance_of ET, ET name ETN'%seid)]self.assertEquals(sorted(instanceof_etypes),['BaseTransition','Transition'])snames=[nameforname,inself.execute('Any N WHERE S is BaseTransition, S name N')]self.failIf('subdiv'insnames)snames=[nameforname,inself.execute('Any N WHERE S is_instance_of BaseTransition, S name N')]self.failUnless('subdiv'insnames)deftest_perms_synchronization_1(self):schema=self.repo.schemaself.assertEquals(schema['CWUser'].get_groups('read'),set(('managers','users')))self.failUnless(self.execute('Any X, Y WHERE X is CWEType, X name "CWUser", Y is CWGroup, Y name "users"')[0])self.execute('DELETE X read_permission Y WHERE X is CWEType, X name "CWUser", Y name "users"')self.assertEquals(schema['CWUser'].get_groups('read'),set(('managers','users',)))self.commit()self.assertEquals(schema['CWUser'].get_groups('read'),set(('managers',)))self.execute('SET X read_permission Y WHERE X is CWEType, X name "CWUser", Y name "users"')self.commit()self.assertEquals(schema['CWUser'].get_groups('read'),set(('managers','users',)))deftest_perms_synchronization_2(self):schema=self.repo.schema['in_group'].rdefs[('CWUser','CWGroup')]self.assertEquals(schema.get_groups('read'),set(('managers','users','guests')))self.execute('DELETE X read_permission Y WHERE X relation_type RT, RT name "in_group", Y name "guests"')self.assertEquals(schema.get_groups('read'),set(('managers','users','guests')))self.commit()self.assertEquals(schema.get_groups('read'),set(('managers','users')))self.execute('SET X read_permission Y WHERE X relation_type RT, RT name "in_group", Y name "guests"')self.assertEquals(schema.get_groups('read'),set(('managers','users')))self.commit()self.assertEquals(schema.get_groups('read'),set(('managers','users','guests')))deftest_nonregr_user_edit_itself(self):ueid=self.session.user.eidgroupeids=[eidforeid,inself.execute('CWGroup G WHERE G name in ("managers", "users")')]self.execute('DELETE X in_group Y WHERE X eid %s'%ueid)self.execute('SET X surname "toto" WHERE X eid %s'%ueid)self.execute('SET X in_group Y WHERE X eid %s, Y name "managers"'%ueid)self.commit()eeid=self.execute('Any X WHERE X is CWEType, X name "CWEType"')[0][0]self.execute('DELETE X read_permission Y WHERE X eid %s'%eeid)self.execute('SET X final FALSE WHERE X eid %s'%eeid)self.execute('SET X read_permission Y WHERE X eid %s, Y eid in (%s, %s)'%(eeid,groupeids[0],groupeids[1]))self.commit()self.execute('Any X WHERE X is CWEType, X name "CWEType"')# schema modification hooks tests #########################################deftest_uninline_relation(self):self.session.set_pool()dbhelper=self.session.pool.source('system').dbhelpersqlcursor=self.session.pool['system']self.failUnless(self.schema['state_of'].inlined)try:self.execute('SET X inlined FALSE WHERE X name "state_of"')self.failUnless(self.schema['state_of'].inlined)self.commit()self.failIf(self.schema['state_of'].inlined)self.failIf(self.index_exists('State','state_of'))rset=self.execute('Any X, Y WHERE X state_of Y')self.assertEquals(len(rset),2)# user statesexcept:importtracebacktraceback.print_exc()finally:self.execute('SET X inlined TRUE WHERE X name "state_of"')self.failIf(self.schema['state_of'].inlined)self.commit()self.failUnless(self.schema['state_of'].inlined)self.failUnless(self.index_exists('State','state_of'))rset=self.execute('Any X, Y WHERE X state_of Y')self.assertEquals(len(rset),2)deftest_indexed_change(self):self.session.set_pool()dbhelper=self.session.pool.source('system').dbhelpersqlcursor=self.session.pool['system']try:self.execute('SET X indexed FALSE WHERE X relation_type R, R name "name"')self.failUnless(self.schema['name'].rdef('Workflow','String').indexed)self.failUnless(self.index_exists('Workflow','name'))self.commit()self.failIf(self.schema['name'].rdef('Workflow','String').indexed)self.failIf(self.index_exists('Workflow','name'))finally:self.execute('SET X indexed TRUE WHERE X relation_type R, R name "name"')self.failIf(self.schema['name'].rdef('Workflow','String').indexed)self.failIf(self.index_exists('Workflow','name'))self.commit()self.failUnless(self.schema['name'].rdef('Workflow','String').indexed)self.failUnless(self.index_exists('Workflow','name'))deftest_unique_change(self):self.session.set_pool()dbhelper=self.session.pool.source('system').dbhelpersqlcursor=self.session.pool['system']try:self.execute('INSERT CWConstraint X: X cstrtype CT, DEF constrained_by X ''WHERE CT name "UniqueConstraint", DEF relation_type RT, DEF from_entity E,''RT name "name", E name "Workflow"')self.failIf(self.schema['Workflow'].has_unique_values('name'))self.failIf(self.index_exists('Workflow','name',unique=True))self.commit()self.failUnless(self.schema['Workflow'].has_unique_values('name'))self.failUnless(self.index_exists('Workflow','name',unique=True))finally:self.execute('DELETE DEF constrained_by X WHERE X cstrtype CT, ''CT name "UniqueConstraint", DEF relation_type RT, DEF from_entity E,''RT name "name", E name "Workflow"')self.failUnless(self.schema['Workflow'].has_unique_values('name'))self.failUnless(self.index_exists('Workflow','name',unique=True))self.commit()self.failIf(self.schema['Workflow'].has_unique_values('name'))self.failIf(self.index_exists('Workflow','name',unique=True))deftest_required_change_1(self):self.execute('SET DEF cardinality "?1" ''WHERE DEF relation_type RT, DEF from_entity E,''RT name "title", E name "Bookmark"')self.commit()# should now be able to add bookmark without titleself.execute('INSERT Bookmark X: X path "/view"')self.commit()deftest_required_change_2(self):self.execute('SET DEF cardinality "11" ''WHERE DEF relation_type RT, DEF from_entity E,''RT name "surname", E name "CWUser"')self.commit()# should not be able anymore to add cwuser without surnameself.assertRaises(ValidationError,self.create_user,"toto")self.execute('SET DEF cardinality "?1" ''WHERE DEF relation_type RT, DEF from_entity E,''RT name "surname", E name "CWUser"')self.commit()deftest_add_attribute_to_base_class(self):attreid=self.execute('INSERT CWAttribute X: X cardinality "11", X defaultval "noname", X indexed TRUE, X relation_type RT, X from_entity E, X to_entity F ''WHERE RT name "messageid", E name "BaseTransition", F name "String"')[0][0]assertself.execute('SET X read_permission Y WHERE X eid %(x)s, Y name "managers"',{'x':attreid})self.commit()self.schema.rebuild_infered_relations()self.failUnless('Transition'inself.schema['messageid'].subjects())self.failUnless('WorkflowTransition'inself.schema['messageid'].subjects())self.execute('Any X WHERE X is_instance_of BaseTransition, X messageid "hop"')deftest_change_fulltextindexed(self):req=self.request()target=req.create_entity(u'Email',messageid=u'1234',subject=u'rick.roll@dance.com')self.commit()rset=req.execute('Any X WHERE X has_text "rick.roll"')self.assertIn(target.eid,[item[0]foriteminrset])assertreq.execute('SET A fulltextindexed FALSE ''WHERE E is CWEType, E name "Email", A is CWAttribute,''A from_entity E, A relation_type R, R name "subject"')self.commit()rset=req.execute('Any X WHERE X has_text "rick.roll"')self.failIf(rset)assertreq.execute('SET A fulltextindexed TRUE ''WHERE A from_entity E, A relation_type R, ''E name "Email", R name "subject"')self.commit()rset=req.execute('Any X WHERE X has_text "rick.roll"')self.assertIn(target.eid,[item[0]foriteminrset])deftest_change_fulltext_container(self):req=self.request()target=req.create_entity(u'EmailAddress',address=u'rick.roll@dance.com')target.set_relations(reverse_use_email=req.user)self.commit()rset=req.execute('Any X WHERE X has_text "rick.roll"')self.assertIn(req.user.eid,[item[0]foriteminrset])assertself.execute('SET R fulltext_container NULL ''WHERE R name "use_email"')self.commit()rset=self.execute('Any X WHERE X has_text "rick.roll"')self.assertIn(target.eid,[item[0]foriteminrset])assertself.execute('SET R fulltext_container "subject" ''WHERE R name "use_email"')self.commit()rset=req.execute('Any X WHERE X has_text "rick.roll"')self.assertIn(req.user.eid,[item[0]foriteminrset])deftest_update_constraint(self):rdef=self.schema['Transition'].rdef('type')cstr=rdef.constraint_by_type('StaticVocabularyConstraint')ifnotgetattr(cstr,'eid',None):self.skip('start me alone')# bug in schema reloading, constraint's eid not restoredself.execute('SET X value %(v)s WHERE X eid %(x)s',{'x':cstr.eid,'v':u"u'normal', u'auto', u'new'"})self.execute('INSERT CWConstraint X: X value %(value)s, X cstrtype CT, EDEF constrained_by X ''WHERE CT name %(ct)s, EDEF eid %(x)s',{'ct':'SizeConstraint','value':u'max=10','x':rdef.eid})self.commit()cstr=rdef.constraint_by_type('StaticVocabularyConstraint')self.assertEquals(cstr.values,(u'normal',u'auto',u'new'))self.execute('INSERT Transition T: T name "hop", T type "new"')if__name__=='__main__':unittest_main()