test.erp5.testLiveUpgrader.py 14.2 KB
Newer Older
Rafael Monnerat's avatar
Rafael Monnerat committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
##############################################################################
#
# Copyright (c) 2002-2011 Nexedi SA and Contributors. All Rights Reserved.
#                     Rafael Monnerat <rafael@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsibility of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# guarantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
##############################################################################


from Products.ERP5Type.tests.ERP5TypeLiveTestCase import ERP5TypeLiveTestCase
from Products.ERP5Type.tests.utils import createZODBPythonScript

class TestLiveUpgrader(ERP5TypeLiveTestCase):
  """
    Configurator Mixin Class
  """
  def afterSetUp(self):
    self.login(user_name='test_configurator_user')
    self.upgrade_object_test_id = "upgrade_object_test"
    self.erp5_site_global_id = getattr(self.portal, 'erp5_site_global_id', None)
    self.beforeTearDown()
    self.portal.portal_activities.unsubscribe()

  def beforeTearDown(self):
    """ Restore original state """
    self.portal.portal_activities.subscribe()
    custom = self.portal.portal_skins.custom

    for script_id in ['ERP5Site_getUpgraderSignature', 'ERP5Site_getUpgraderSignature']: 
      if script_id in custom.objectIds():
        custom.manage_delObjects([script_id])

    if self.upgrade_object_test_id in self.portal.portal_categories.objectIds():
       self.portal.portal_categories.manage_delObjects([self.upgrade_object_test_id])

    if self.upgrade_object_test_id in self.portal.portal_gadgets.objectIds():
       self.portal.portal_gadgets.manage_delObjects([self.upgrade_object_test_id])

    self.portal._updateProperty('erp5_site_global_id', self.erp5_site_global_id)
    
    property_sheet_list = self.portal.portal_types.Person.getTypePropertySheetList()
    new_property_sheet_list = [ i for i in property_sheet_list if i !="Account" ]
    self.portal.portal_types.Person.setTypePropertySheetList(new_property_sheet_list)
    self.assertFalse("Account" in self.portal.portal_types.Person.getTypePropertySheetList())

66
    self.tic()
Rafael Monnerat's avatar
Rafael Monnerat committed
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
    ERP5TypeLiveTestCase.beforeTearDown(self)

  def test_UpgradeSignatureAPI(self):
    """
      test If the script that defines the signature follow
      the API defined here. This will prevent mistakes
      or change API Definition.
    """
    signature_key_list = ('alarm_dict',
                          'workflow_chain_dict',
                          'required_bt5_id_list',
                          'upgradable_bt5_id_list',
                          'update_catalog_bt5_id_list',
                          'before_triggered_bt5_id_dict',
                          'after_triggered_bt5_id_dict',
                          'reinstalable_bt5_id_list',
                          'keep_original_dict',
                          'object_action_dict',
                          'integrity_verification_script_id_list',
                          'catalog_filter_dict',
                          'update_role_portal_type_list',
                          'portal_type_property_sheet_list',
                          'erp5_site_property_dict',
                          'upgrade_object_class_list',
                          'recatalog',
                          'alarm_tool_configuration_list'
    )
    signature = self.portal.ERP5Site_getUpgraderSignature()
95
    self.assertEqual(sorted(signature_key_list), sorted(signature.keys()))
Rafael Monnerat's avatar
Rafael Monnerat committed
96 97 98 99 100 101

  def test_StandardUpgraderSignature(self):
    """ Test default behaviours provided by default ERP5Site_getUpgraderSignature
    """
    signature = self.portal.ERP5Site_getUpgraderSignature()
    # By default we do not recatalog the instance
102
    self.assertEqual(signature['recatalog'], False)
Rafael Monnerat's avatar
Rafael Monnerat committed
103 104

    # By default we do not upgrade manually the workflow
105
    self.assertEqual(signature['workflow_chain_dict'], None)
Rafael Monnerat's avatar
Rafael Monnerat committed
106 107

    # By Default we do not upgrade Catalog Filters
108
    self.assertEqual(signature['catalog_filter_dict'], None)
Rafael Monnerat's avatar
Rafael Monnerat committed
109 110

    # By Default there is no extra properties to set.
111
    self.assertEqual(signature['erp5_site_property_dict'], {})
Rafael Monnerat's avatar
Rafael Monnerat committed
112 113

    # Do not enable alarms by default
114
    self.assertEqual(signature['alarm_tool_configuration_list'], ())
Rafael Monnerat's avatar
Rafael Monnerat committed
115 116 117 118 119

    # By default we upgrade software, products, bt5 and so on.
    self.assertTrue(signature['alarm_dict']["bt5_upgrader"])
    self.assertTrue(signature['alarm_dict']["finalize_upgrader"])

120 121 122 123
    # By default there is nothing to fix on skin Selection.
    # (rafael) Is it really necessary?
    self.assertFalse(self.portal.ERP5Site_setupUpgraderSkinSelection())

Rafael Monnerat's avatar
Rafael Monnerat committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
  def testUpgradeObjectWorkflowState(self):
    """
      Create a test to ERP5Site_upgradeObjectList which aims to update
      Objects which are in bad workflow state or have a bad property.
      
      Signature API:

        { BUSINESS_TEMPLATE_TITLE : (
	                 (OBJECT_PATH,
	                  SCRIPT TO COLLECT INFORMATION,
                          RETURN EXPECTED THAT INDICATES THE OBJECT IS BROKEN, 
			  SCRIPT USED TO FIX ),
	                 ),
        }
    """
    signature_code = {'erp5_core':( ('portal_categories/%s' % self.upgrade_object_test_id,
                                     'getValidationState', 
                                     'embedded', 
                                     'publish'),)}
    createZODBPythonScript(self.getPortal().portal_skins.custom,
                                   'ERP5Site_getUpgraderSignature', "item=None",
                                    "return " + str(signature_code))
146
    self.commit()
147 148
    self.assertEqual(self.portal.ERP5Site_getUpgraderSignature(), signature_code)
    self.assertEqual(self.portal.ERP5Site_upgradeObjectList(), [])
Rafael Monnerat's avatar
Rafael Monnerat committed
149 150
    test_object = self.portal.portal_categories.newContent(id=self.upgrade_object_test_id,
                                             portal_type="Base Category")
151
    self.assertEqual(test_object.getValidationState(), 'embedded')
Rafael Monnerat's avatar
Rafael Monnerat committed
152 153
    self.assertNotEquals(self.portal.ERP5Site_upgradeObjectList(), [])
    self.assertNotEquals(self.portal.ERP5Site_upgradeObjectList(upgrade="1"), [])
154
    self.assertEqual(test_object.getValidationState(), 'published')
Rafael Monnerat's avatar
Rafael Monnerat committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170

  def testUpgradeObjectClass(self):
    """
      Verify if all objects from one class are migrated to
      another class.
    """
    to_class_as_string = 'Products.ERP5Type.Document.Folder.Folder'
    signature_code = ( ('portal_gadgets', 
                        'ERP5Site_testUpgradeObjectClass',
                        to_class_as_string, 
                        'Products.ERP5Type.Document.Gadget.Gadget', 
                        'ERP5Site_testUpgradeObjectClass'), )

    createZODBPythonScript(self.getPortal().portal_skins.custom,
                                   'ERP5Site_getUpgraderSignature', "item=None",
                                    "return " + str(signature_code))
171
    self.commit()
172
    self.assertEqual(self.portal.ERP5Site_getUpgraderSignature(), signature_code)
Rafael Monnerat's avatar
Rafael Monnerat committed
173
    # Nothing to upgrade
174
    self.assertEqual(self.portal.ERP5Site_upgradeObjectClass(), [])
Rafael Monnerat's avatar
Rafael Monnerat committed
175 176 177 178

    # Create one broken object
    gadget = self.portal.portal_gadgets.newContent(portal_type="Gadget", 
                                                   id=self.upgrade_object_test_id)
179
    self.tic()
Rafael Monnerat's avatar
Rafael Monnerat committed
180 181 182 183 184 185 186 187 188 189

    createZODBPythonScript(self.getPortal().portal_skins.custom,
                         "test_upgradeObject", 'x', 'return [1]')
    test_script = self.getPortal().portal_skins.custom.test_upgradeObject
    self.portal.portal_gadgets.upgradeObjectClass(
                                 test_script,
                                 gadget.__class__,
                                 to_class_as_string,
                                 test_script)

190
    self.commit()
Rafael Monnerat's avatar
Rafael Monnerat committed
191
    self.assertNotEquals(self.portal.ERP5Site_upgradeObjectClass(), [])
192
    self.assertEqual(self.portal.ERP5Site_upgradeObjectClass(upgrade=1),
Rafael Monnerat's avatar
Rafael Monnerat committed
193
                        [(gadget.getRelativeUrl(), 'ERP5 Gadget')])
194
    self.tic()
195
    self.assertEqual(self.portal.ERP5Site_upgradeObjectClass(), [])
Rafael Monnerat's avatar
Rafael Monnerat committed
196 197 198 199 200 201 202 203 204 205 206 207

  def test_UpgradeGlobalPropertyList(self):
    """
     Verify if the upgrade is needed
    """
    if getattr(self.portal, 'erp5_site_global_id', None) is not None:
      self.portal._updateProperty('erp5_site_global_id', "SOME_KEY")

    signature_code = {'erp5_site_global_id': self.upgrade_object_test_id}
    createZODBPythonScript(self.getPortal().portal_skins.custom,
                                   'ERP5Site_getUpgraderSignature', "item=None",
                                    "return " + str(signature_code))
208
    self.commit()
209 210
    self.assertEqual(self.portal.ERP5Site_getUpgraderSignature(), signature_code)
    self.assertEqual(self.portal.ERP5Site_upgradeGlobalPropertyList(), 
Rafael Monnerat's avatar
Rafael Monnerat committed
211 212
                      ["Upgrade Required for Global Properties."])

213
    self.assertEqual(["Upgrade Executed for Global Properties (erp5_site_global_id)."], 
Rafael Monnerat's avatar
Rafael Monnerat committed
214 215
                      self.portal.ERP5Site_upgradeGlobalPropertyList(upgrade=1))

216
    self.tic()
217 218
    self.assertEqual(self.portal.ERP5Site_upgradeGlobalPropertyList(), [])
    self.assertEqual(getattr(self.portal, 'erp5_site_global_id', None),
Rafael Monnerat's avatar
Rafael Monnerat committed
219 220 221 222 223 224 225 226 227 228 229 230
                      self.upgrade_object_test_id)

  def test_UpgradeWorkflowChain(self):
    """
     Upgrade the workflow chain if required.
    """
    workflow_tool = self.portal.portal_workflow
    workflow_dict = workflow_tool.getWorkflowChainDict()
    signature_code = workflow_dict
    createZODBPythonScript(self.getPortal().portal_skins.custom,
                                   'ERP5Site_getUpgraderSignature', "item=None",
                                    "return " + str(signature_code))
231
    self.commit()
Rafael Monnerat's avatar
Rafael Monnerat committed
232

233
    self.assertEqual(self.portal.ERP5Site_upgradeWorkflowChain(), [])
Rafael Monnerat's avatar
Rafael Monnerat committed
234 235 236 237 238 239

    original_person_chain = workflow_dict["chain_Person"]
    # Modify installed workflow chain.
    workflow_dict["chain_Person"] = ''
    workflow_tool.manage_changeWorkflows(default_chain = '', 
                                         props = workflow_dict)
240
    self.assertEqual(workflow_tool.getWorkflowChainDict()["chain_Person"],
Rafael Monnerat's avatar
Rafael Monnerat committed
241
                      "")
242
    self.assertEqual(self.portal.ERP5Site_upgradeWorkflowChain(),
Rafael Monnerat's avatar
Rafael Monnerat committed
243 244
                      ["Upgrade Required for Workflow Chain."])

245
    self.assertEqual(self.portal.ERP5Site_upgradeWorkflowChain(upgrade=1),
Rafael Monnerat's avatar
Rafael Monnerat committed
246
                      ["Upgrade Executed for Workflow Chain."])
247
    self.tic()
248 249
    self.assertEqual(self.portal.ERP5Site_upgradeWorkflowChain(),[])
    self.assertEqual(workflow_tool.getWorkflowChainDict()["chain_Person"],
Rafael Monnerat's avatar
Rafael Monnerat committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263
                      original_person_chain)

  def test_RunVerificationScriptDontRaise(self):
    """ Test if the script ERP5Site_runVerificationScript is 
        bullet of proof, and always return a result.
    """
    createZODBPythonScript(self.getPortal().portal_skins.custom,
                                   'ERP5Site_raise', "",
                                    "raise ValueError('Error')")
    createZODBPythonScript(self.getPortal().portal_skins.custom,
                                   'ERP5Site_return', "",
                                   "return ['A']")

    failure = self.portal.ERP5Site_runVerificationScript("ERP5Site_raise")
264
    self.assertTrue("Script ERP5Site_raise fail to run" in failure,
Rafael Monnerat's avatar
Rafael Monnerat committed
265
                    "'Script ERP5Site_raise fail to run not' in %s" % failure)
266
    self.assertEqual('ERP5Site_return : \n - A ',
Rafael Monnerat's avatar
Rafael Monnerat committed
267 268 269 270 271 272 273 274 275 276
       self.portal.ERP5Site_runVerificationScript("ERP5Site_return"))

  def test_UpgradePortalTypePropertySheet(self):
    """
      Test for Upgrate Portal Type Property Sheet script.
    """
    signature_code = (('Account', ["Person"]), )
    createZODBPythonScript(self.getPortal().portal_skins.custom,
                                   'ERP5Site_getUpgraderSignature', "item=None",
                                    "return " + str(signature_code))
277
    self.commit()
278 279
    self.assertEqual(self.portal.ERP5Site_getUpgraderSignature(), signature_code)
    self.assertEqual(self.portal.ERP5Site_upgradePortalTypePropertySheet(),
Rafael Monnerat's avatar
Rafael Monnerat committed
280
                      ["Person doesn't has Account associated."])
281
    self.assertEqual(self.portal.ERP5Site_upgradePortalTypePropertySheet(upgrade=1),
Rafael Monnerat's avatar
Rafael Monnerat committed
282
                      ["Associate PropertySheet Account into Portal Type Person."])
283
    self.tic()
284
    self.assertEqual(self.portal.ERP5Site_upgradePortalTypePropertySheet(), [])
Rafael Monnerat's avatar
Rafael Monnerat committed
285 286 287 288 289 290 291 292 293 294 295


  def test_recreateActivities(self):
    """
      The activities should be recreated after upgrade products.
    """
    object_to_test = self.portal.portal_simulation
    createZODBPythonScript(self.getPortal().portal_skins.custom,
                   'ERP5Site_testRecreateActivityScript', "",
                   "context.manage_addProperty('custom_property_without_meaning', 'I was there', 'string')")

296
    self.commit()
Rafael Monnerat's avatar
Rafael Monnerat committed
297 298
    object_to_test.activate().ERP5Site_testRecreateActivityScript()

299
    self.commit()
Rafael Monnerat's avatar
Rafael Monnerat committed
300 301 302
    # Verify if the final activity is created.
    self.assertTrue(object_to_test.hasActivity(method_id="ERP5Site_testRecreateActivityScript"))
    self.portal.portal_activities.activate().ERP5Site_clearActivities()
303
    self.commit()
Rafael Monnerat's avatar
Rafael Monnerat committed
304 305
    self.assertTrue(object_to_test.hasActivity(method_id="ERP5Site_testRecreateActivityScript"))
    self.assertTrue(self.portal.portal_activities.hasActivity(method_id='ERP5Site_clearActivities'))
306
    self.tic()
Rafael Monnerat's avatar
Rafael Monnerat committed
307 308
    self.assertFalse(object_to_test.hasActivity(method_id="ERP5Site_testRecreateActivityScript"))
    self.assertFalse(self.portal.portal_activities.hasActivity(method_id='ERP5Site_clearActivities'))
309
    self.assertEqual(object_to_test.getProperty('custom_property_without_meaning'),
Rafael Monnerat's avatar
Rafael Monnerat committed
310
                      'I was there')