testAlarm.py 26.8 KB
Newer Older
Sebastien Robin's avatar
Sebastien Robin committed
1 2
##############################################################################
#
3
# Copyright (c) 2006 Nexedi SARL and Contributors. All Rights Reserved.
Sebastien Robin's avatar
Sebastien Robin committed
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
#          Sebastien Robin <seb@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability 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
# garantees 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################

29
import unittest
30
import transaction
Sebastien Robin's avatar
Sebastien Robin committed
31 32 33

from Testing import ZopeTestCase
from Products.ERP5Type.tests.ERP5TypeTestCase import ERP5TypeTestCase
34 35 36
from AccessControl.SecurityManagement import newSecurityManager, \
        getSecurityManager, setSecurityManager
from AccessControl import Unauthorized
Sebastien Robin's avatar
Sebastien Robin committed
37 38 39 40 41 42 43 44
from DateTime import DateTime
from zLOG import LOG
from Products.ERP5Type.DateUtils import addToDate

class TestAlarm(ERP5TypeTestCase):
  """
  This is the list of test

Aurel's avatar
Aurel committed
45
  test setNextStartDate :
Sebastien Robin's avatar
Sebastien Robin committed
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
  - every hour
  - at 6, 10, 15, 21 every day
  - every day at 10
  - every 3 days at 14 and 15 and 17
  - every monday and friday, at 6 and 15
  - every 1st and 15th every month, at 12 and 14
  - every 1st day of every 2 month, at 6
  """

  # Different variables used for this test
  run_all_test = 1
  source_company_id = 'Nexedi'
  destination_company_id = 'Coramy'
  component_id = 'brick'
  sales_order_id = '1'
  quantity = 10
  base_price = 0.7832
63
  # year/month/day hour:minute:second
64
  date_format = '%i/%i/%i %i:%i:%d GMT+0100'
Sebastien Robin's avatar
Sebastien Robin committed
65

Sebastien Robin's avatar
Sebastien Robin committed
66 67 68
  def getTitle(self):
    return "Alarm"

69
  def afterSetUp(self):
Sebastien Robin's avatar
Sebastien Robin committed
70 71
    self.login()

72
  def newAlarm(self, **kw):
Sebastien Robin's avatar
Sebastien Robin committed
73 74 75 76
    """
    Create an empty alarm
    """
    a_tool = self.getAlarmTool()
77
    return a_tool.newContent(**kw)
Sebastien Robin's avatar
Sebastien Robin committed
78 79 80 81 82 83 84

  def login(self, quiet=0, run=run_all_test):
    uf = self.getPortal().acl_users
    uf._doAddUser('seb', '', ['Manager'], [])
    user = uf.getUserById('seb').__of__(uf)
    newSecurityManager(None, user)

Jérome Perrin's avatar
Jérome Perrin committed
85 86 87 88 89 90 91 92 93 94

  def test_01_HasEverything(self, quiet=0, run=run_all_test):
    # Test if portal_alarms was created
    if not run: return
    if not quiet:
      ZopeTestCase._print('\nTest Has Everything ')
      LOG('Testing... ',0,'testHasEverything')
    self.assertNotEquals(self.portal._getOb('portal_alarms', None), None)
    self.assertNotEquals(self.portal.portal_types.getTypeInfo('Alarm Tool'), None)

Sebastien Robin's avatar
Sebastien Robin committed
95 96 97 98 99 100 101 102 103 104
  def test_02_Initialization(self, quiet=0, run=run_all_test):
    """
    Test some basic things right after the creation
    """
    if not run: return
    if not quiet:
      message = 'Test Initialization'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
    alarm = self.newAlarm()
105
    transaction.commit()
106
    self.tic()
Sebastien Robin's avatar
Sebastien Robin committed
107 108 109
    now = DateTime()
    date = addToDate(now,day=1)
    alarm.setPeriodicityStartDate(date)
110 111 112
    self.assertEquals(alarm.getAlarmDate(), None)
    alarm.setEnabled(True)
    self.assertEquals(alarm.getAlarmDate(), date)
Sebastien Robin's avatar
Sebastien Robin committed
113 114 115 116 117 118 119 120 121
    alarm.setNextAlarmDate(current_date=now) # This should not do change the alarm date
    self.assertEquals(alarm.getAlarmDate(),date)

  def test_03_EveryHour(self, quiet=0, run=run_all_test):
    if not run: return
    if not quiet:
      message = 'Test Every Hour'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
122
    alarm = self.newAlarm(enabled=True)
Sebastien Robin's avatar
Sebastien Robin committed
123
    now = DateTime()
124
    date = addToDate(now, day=2)
Sebastien Robin's avatar
Sebastien Robin committed
125 126
    alarm.setPeriodicityStartDate(date)
    alarm.setPeriodicityHourFrequency(1)
127
    transaction.commit()
128
    self.tic()
Aurel's avatar
Aurel committed
129
    alarm.setNextAlarmDate(current_date=now)
130
    self.assertEquals(alarm.getAlarmDate(), date)
Sebastien Robin's avatar
Sebastien Robin committed
131 132 133
    LOG(message + ' now :',0,now)
    now = addToDate(now,day=2)
    LOG(message + ' now :',0,now)
Aurel's avatar
Aurel committed
134
    alarm.setNextAlarmDate(current_date=now)
Sebastien Robin's avatar
Sebastien Robin committed
135 136 137
    next_date = addToDate(date,hour=1)
    self.assertEquals(alarm.getAlarmDate(),next_date)
    now = addToDate(now,hour=1,minute=5)
Aurel's avatar
Aurel committed
138
    alarm.setNextAlarmDate(current_date=now)
Sebastien Robin's avatar
Sebastien Robin committed
139 140 141 142 143 144 145 146 147
    next_date = addToDate(next_date,hour=1)
    self.assertEquals(alarm.getAlarmDate(),next_date)

  def test_04_Every3Hours(self, quiet=0, run=run_all_test):
    if not run: return
    if not quiet:
      message = 'Test Every 3 Hours'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
148
    alarm = self.newAlarm(enabled=True)
149
    now = DateTime().toZone('UTC')
Sebastien Robin's avatar
Sebastien Robin committed
150 151 152 153 154
    hour_to_remove = now.hour() % 3
    now = addToDate(now,hour=-hour_to_remove)
    date = addToDate(now,day=2)
    alarm.setPeriodicityStartDate(date)
    alarm.setPeriodicityHourFrequency(3)
155
    transaction.commit()
156
    self.tic()
Aurel's avatar
Aurel committed
157
    alarm.setNextAlarmDate(current_date=now)
Sebastien Robin's avatar
Sebastien Robin committed
158 159 160 161
    self.assertEquals(alarm.getAlarmDate(),date)
    LOG(message + ' now :',0,now)
    now = addToDate(now,day=2)
    LOG(message + ' now :',0,now)
Aurel's avatar
Aurel committed
162
    alarm.setNextAlarmDate(current_date=now)
Sebastien Robin's avatar
Sebastien Robin committed
163 164 165
    next_date = addToDate(date,hour=3)
    self.assertEquals(alarm.getAlarmDate(),next_date)
    now = addToDate(now,hour=3,minute=7,second=4)
Aurel's avatar
Aurel committed
166
    alarm.setNextAlarmDate(current_date=now)
Sebastien Robin's avatar
Sebastien Robin committed
167 168 169 170 171 172 173 174 175
    next_date = addToDate(next_date,hour=3)
    self.assertEquals(alarm.getAlarmDate(),next_date)

  def test_05_SomeHours(self, quiet=0, run=run_all_test):
    if not run: return
    if not quiet:
      message = 'Test Some Hours'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
176 177 178 179 180 181

    right_first_date = DateTime(self.date_format  % (2006,10,6,15,00,00))
    now = DateTime(self.date_format               % (2006,10,6,15,00,00))
    right_second_date = DateTime(self.date_format % (2006,10,6,21,00,00))
    right_third_date = DateTime(self.date_format  % (2006,10,7,06,00,00))
    right_fourth_date = DateTime(self.date_format % (2006,10,7,10,00,00))
182
    alarm = self.newAlarm(enabled=True)
Sebastien Robin's avatar
Sebastien Robin committed
183 184 185
    hour_list = (6,10,15,21)
    alarm.setPeriodicityStartDate(now)
    alarm.setPeriodicityHourList(hour_list)
186
    transaction.commit()
187
    self.tic()
Sebastien Robin's avatar
Sebastien Robin committed
188
    self.assertEquals(alarm.getAlarmDate(),right_first_date)
Aurel's avatar
Aurel committed
189
    alarm.setNextAlarmDate(current_date=right_first_date)
Sebastien Robin's avatar
Sebastien Robin committed
190
    self.assertEquals(alarm.getAlarmDate(),right_second_date)
Aurel's avatar
Aurel committed
191
    alarm.setNextAlarmDate(current_date=right_second_date)
Sebastien Robin's avatar
Sebastien Robin committed
192
    self.assertEquals(alarm.getAlarmDate(),right_third_date)
Aurel's avatar
Aurel committed
193
    alarm.setNextAlarmDate(current_date=right_third_date)
Sebastien Robin's avatar
Sebastien Robin committed
194 195 196 197 198 199 200 201
    self.assertEquals(alarm.getAlarmDate(),right_fourth_date)

  def test_06_EveryDayOnce(self, quiet=0, run=run_all_test):
    if not run: return
    if not quiet:
      message = 'Every Day Once'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
202 203 204 205 206

    now = DateTime(self.date_format               % (2006,10,6,10,00,00))
    right_first_date = DateTime(self.date_format  % (2006,10,6,10,00,00))
    right_second_date = DateTime(self.date_format % (2006,10,7,10,00,00))
    right_third_date = DateTime(self.date_format  % (2006,10,8,10,00,00))
207
    alarm = self.newAlarm(enabled=True)
Sebastien Robin's avatar
Sebastien Robin committed
208 209 210
    alarm.setPeriodicityStartDate(now)
    alarm.setPeriodicityDayFrequency(1)
    alarm.setPeriodicityHourList((10,))
211
    transaction.commit()
212
    self.tic()
Sebastien Robin's avatar
Sebastien Robin committed
213
    self.assertEquals(alarm.getAlarmDate(),right_first_date)
Aurel's avatar
Aurel committed
214
    alarm.setNextAlarmDate(current_date=right_first_date)
Sebastien Robin's avatar
Sebastien Robin committed
215
    self.assertEquals(alarm.getAlarmDate(),right_second_date)
Aurel's avatar
Aurel committed
216
    alarm.setNextAlarmDate(current_date=right_second_date)
Sebastien Robin's avatar
Sebastien Robin committed
217 218 219 220 221 222 223 224 225
    self.assertEquals(alarm.getAlarmDate(),right_third_date)

  def test_07_Every3DaysSomeHours(self, quiet=0, run=run_all_test):
    """- every 3 days at 14 and 15 and 17"""
    if not run: return
    if not quiet:
      message = 'Every 3 Days Some Hours'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
226 227 228 229 230

    right_first_date = DateTime(self.date_format % (2006,10,6,14,00,00))
    right_second_date = DateTime(self.date_format  % (2006,10,6,15,00,00))
    right_third_date = DateTime(self.date_format  % (2006,10,6,17,00,00))
    right_fourth_date = DateTime(self.date_format  % (2006,10,9,14,00,00))
231
    alarm = self.newAlarm(enabled=True)
Sebastien Robin's avatar
Sebastien Robin committed
232 233 234
    alarm.setPeriodicityStartDate(right_first_date)
    alarm.setPeriodicityDayFrequency(3)
    alarm.setPeriodicityHourList((14,15,17))
235
    transaction.commit()
236
    self.tic()
Sebastien Robin's avatar
Sebastien Robin committed
237
    self.assertEquals(alarm.getAlarmDate(),right_first_date)
Aurel's avatar
Aurel committed
238
    alarm.setNextAlarmDate(current_date=right_first_date)
Sebastien Robin's avatar
Sebastien Robin committed
239
    self.assertEquals(alarm.getAlarmDate(),right_second_date)
240 241 242 243 244 245 246 247 248 249 250 251 252
    alarm.setNextAlarmDate(current_date=right_second_date)
    self.assertEquals(alarm.getAlarmDate(),right_third_date)
    alarm.setNextAlarmDate(current_date=right_third_date)
    self.assertEquals(alarm.getAlarmDate(),right_fourth_date)

  def test_07a_Every4DaysSomeHours(self, quiet=0, run=run_all_test):
    """- every 4 days at 14 and 15 and 17"""
    if not run: return
    if not quiet:
      message = 'Every 4 Days Some Hours'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)

253 254 255 256 257
    right_first_date = DateTime(self.date_format % (2006,10,7,13,00,00))
    right_second_date = DateTime(self.date_format  % (2006,10,8,14,00,00))
    right_third_date = DateTime(self.date_format  % (2006,10,8,15,00,00))
    right_fourth_date = DateTime(self.date_format  % (2006,10,8,17,00,00))
    right_fifth_date = DateTime(self.date_format  % (2006,10,12,14,00,00))
258
    alarm = self.newAlarm(enabled=True)
259 260 261
    alarm.setPeriodicityStartDate(right_first_date)
    alarm.setPeriodicityDayFrequency(4)
    alarm.setPeriodicityHourList((14,15,17))
262
    transaction.commit()
263 264 265 266
    self.tic()
    self.assertEquals(alarm.getAlarmDate(),right_first_date)
    alarm.setNextAlarmDate(current_date=right_first_date)
    self.assertEquals(alarm.getAlarmDate(),right_second_date)
Aurel's avatar
Aurel committed
267
    alarm.setNextAlarmDate(current_date=right_second_date)
Sebastien Robin's avatar
Sebastien Robin committed
268
    self.assertEquals(alarm.getAlarmDate(),right_third_date)
Aurel's avatar
Aurel committed
269
    alarm.setNextAlarmDate(current_date=right_third_date)
Sebastien Robin's avatar
Sebastien Robin committed
270
    self.assertEquals(alarm.getAlarmDate(),right_fourth_date)
271 272
    alarm.setNextAlarmDate(current_date=right_fourth_date)
    self.assertEquals(alarm.getAlarmDate(),right_fifth_date)
Sebastien Robin's avatar
Sebastien Robin committed
273 274 275 276 277 278 279 280

  def test_08_SomeWeekDaysSomeHours(self, quiet=0, run=run_all_test):
    """- every monday and friday, at 6 and 15"""
    if not run: return
    if not quiet:
      message = 'Some Week Days Some Hours'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
281 282

    right_first_date = DateTime(self.date_format  % (2006,9,27,6,00,00))
283 284 285 286
    right_second_date = DateTime(self.date_format  % (2006,9,29,6,00,00))
    right_third_date = DateTime(self.date_format  % (2006,9,29,15,00,00))
    right_fourth_date = DateTime(self.date_format  % (2006,10,2,6,00,00))
    right_fifth_date = DateTime(self.date_format  % (2006,10,2,15,00,00))
287
    alarm = self.newAlarm(enabled=True)
288
    transaction.commit()
289
    self.tic()
Sebastien Robin's avatar
Sebastien Robin committed
290 291 292 293 294 295 296 297 298 299 300 301
    alarm.setPeriodicityStartDate(right_first_date)
    alarm.setPeriodicityWeekDayList(('Monday','Friday'))
    alarm.setPeriodicityHourList((6,15))
    self.checkDate(alarm, right_first_date, right_second_date, right_third_date, right_fourth_date)

  def checkDate(self,alarm,*args):
    """
    the basic test
    """
    for date in args[:-1]:
      LOG('checkDate, checking date...:',0,date)
      self.assertEquals(alarm.getAlarmDate(),date)
Aurel's avatar
Aurel committed
302
      alarm.setNextAlarmDate(current_date=date)
Sebastien Robin's avatar
Sebastien Robin committed
303 304 305 306 307 308 309 310 311
    self.assertEquals(alarm.getAlarmDate(),args[-1])

  def test_09_SomeMonthDaysSomeHours(self, quiet=0, run=run_all_test):
    """- every 1st and 15th every month, at 12 and 14"""
    if not run: return
    if not quiet:
      message = 'Some Month Days Some Hours'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
312 313 314 315 316

    right_first_date = DateTime(self.date_format  % (2006,10,01,12,00,00))
    right_second_date = DateTime(self.date_format  % (2006,10,01,14,00,00))
    right_third_date = DateTime(self.date_format  % (2006,10,15,12,00,00))
    right_fourth_date = DateTime(self.date_format  % (2006,10,15,14,00,00))
317
    alarm = self.newAlarm(enabled=True)
Sebastien Robin's avatar
Sebastien Robin committed
318 319 320
    alarm.setPeriodicityStartDate(right_first_date)
    alarm.setPeriodicityMonthDayList((1,15))
    alarm.setPeriodicityHourList((12,14))
321
    transaction.commit()
322
    self.tic()
Sebastien Robin's avatar
Sebastien Robin committed
323 324 325 326 327 328 329 330 331
    self.checkDate(alarm, right_first_date, right_second_date, right_third_date, right_fourth_date)

  def test_10_OnceEvery2Month(self, quiet=0, run=run_all_test):
    """- every 1st day of every 2 month, at 6"""
    if not run: return
    if not quiet:
      message = 'Once Every 2 Month'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
332 333 334 335

    right_first_date = DateTime(self.date_format  % (2006,10,01,6,00,00))
    right_second_date = DateTime(self.date_format  % (2006,12,01,6,00,00))
    right_third_date = DateTime(self.date_format  % (2007,2,01,6,00,00))
336
    alarm = self.newAlarm(enabled=True)
Sebastien Robin's avatar
Sebastien Robin committed
337 338 339 340
    alarm.setPeriodicityStartDate(right_first_date)
    alarm.setPeriodicityMonthDayList((1,))
    alarm.setPeriodicityMonthFrequency(2)
    alarm.setPeriodicityHourList((6,))
341
    transaction.commit()
342
    self.tic()
Sebastien Robin's avatar
Sebastien Robin committed
343 344 345 346 347 348 349 350
    self.checkDate(alarm, right_first_date, right_second_date, right_third_date)

  def test_11_EveryDayOnceWeek41And42(self, quiet=0, run=run_all_test):
    if not run: return
    if not quiet:
      message = 'Every Day Once Week 41 And 43'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
351 352 353 354 355

    right_first_date = DateTime(self.date_format  % (2006,10,1,6,00,00))
    right_second_date = DateTime(self.date_format  % (2006,10,9,6,00,00))
    right_third_date = DateTime(self.date_format  % (2006,10,10,6,00,00))
    right_fourth_date = DateTime(self.date_format  % (2006,10,11,6,00,00))
356
    alarm = self.newAlarm(enabled=True)
Sebastien Robin's avatar
Sebastien Robin committed
357 358 359
    alarm.setPeriodicityStartDate(right_first_date)
    alarm.setPeriodicityHourList((6,))
    alarm.setPeriodicityWeekList((41,43))
360
    transaction.commit()
361
    self.tic()
Sebastien Robin's avatar
Sebastien Robin committed
362 363
    self.checkDate(alarm, right_first_date, right_second_date, right_third_date,right_fourth_date)

Aurel's avatar
Aurel committed
364 365 366 367 368 369
  def test_12_Every5Minutes(self, quiet=0, run=run_all_test):
    if not run: return
    if not quiet:
      message = 'Test Every 5 Minutes'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
370
    alarm = self.newAlarm(enabled=True)
Aurel's avatar
Aurel committed
371 372 373 374 375 376
    now = DateTime()
    minute_to_remove = now.minute() % 5
    now = addToDate(now,minute=-minute_to_remove)
    date = addToDate(now,day=2)
    alarm.setPeriodicityStartDate(date)
    alarm.setPeriodicityMinuteFrequency(5)
377
    transaction.commit()
378
    self.tic()
Aurel's avatar
Aurel committed
379 380 381 382 383 384 385 386 387 388 389 390
    alarm.setNextAlarmDate(current_date=now)
    self.assertEquals(alarm.getAlarmDate(),date)
    LOG(message + ' now :',0,now)
    now = addToDate(now,day=2)
    LOG(message + ' now :',0,now)
    alarm.setNextAlarmDate(current_date=now)
    next_date = addToDate(date,minute=5)
    self.assertEquals(alarm.getAlarmDate(),next_date)
    now = addToDate(now,minute=5,second=14)
    alarm.setNextAlarmDate(current_date=now)
    next_date = addToDate(next_date,minute=5)
    self.assertEquals(alarm.getAlarmDate(),next_date)
Sebastien Robin's avatar
Sebastien Robin committed
391

392 393 394 395 396 397
  def test_13_EveryMinute(self, quiet=0, run=run_all_test):
    if not run: return
    if not quiet:
      message = 'Test Every Minute'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
398
    alarm = self.newAlarm(enabled=True)
399 400 401 402
    now = DateTime()
    date = addToDate(now,hour=2)
    alarm.setPeriodicityStartDate(now)
    alarm.setPeriodicityMinuteFrequency(1)
403
    transaction.commit()
404 405 406 407
    self.tic()
    alarm.setNextAlarmDate(current_date=date)
    self.assertEquals(alarm.getAlarmDate(),date)

408 409 410 411 412 413
  def test_14_NewActiveProcess(self, quiet=0, run=run_all_test):
    if not run: return
    if not quiet:
      message = 'Test New Active Process'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
414
    alarm = self.newAlarm(enabled=True)
415 416 417
    active_process = alarm.newActiveProcess()
    self.assertEquals('Active Process', active_process.getPortalType())
    self.assertEquals(alarm, active_process.getCausalityValue())
418
    transaction.commit()
419 420
    self.tic()
    self.assertEquals(active_process, alarm.getLastActiveProcess())
421 422 423 424 425 426 427

  def test_15_FailedAlarmsDoNotBlockFutureAlarms(self, quiet=0, run=run_all_test):
    if not run: return
    if not quiet:
      message = 'Test Failed Alarms Do Not Block Future Alarms'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
428
    try:
429 430 431 432 433 434 435
      sense_method_id = 'Alarm_testSenseMethod'
      skin_folder_id = 'custom'
      skin_folder = self.getPortal().portal_skins[skin_folder_id]
      skin_folder.manage_addProduct['PythonScripts'].manage_addPythonScript(id=sense_method_id)
      # Make the sense method fail
      skin_folder[sense_method_id].ZPythonScript_edit('*args,**kw', 'raise Exception')
      del skin_folder
436
      alarm = self.newAlarm(enabled=True)
437
      transaction.commit()
438
      self.tic()
439 440 441 442
      now = DateTime()
      alarm.setActiveSenseMethodId(sense_method_id)
      self.assertEquals(alarm.isActive(), 0)
      alarm.activeSense()
443
      transaction.commit()
444 445 446 447 448 449 450 451 452 453 454 455 456
      try:
        self.tic()
      except RuntimeError:
        pass
      else:
        raise Exception, 'Tic did not raise though activity was supposed to fail'
      # Check that the alarm is not considered active, although there is a remaining activity.
      self.assertEquals(alarm.hasActivity(), 1)
      self.assertEquals(alarm.isActive(), 0)
      self.assertEquals(alarm.getLastActiveProcess(), None)
      # Make the sense method succeed and leave a trace
      self.getPortal().portal_skins[skin_folder_id][sense_method_id].ZPythonScript_edit('*args,**kw', 'context.newActiveProcess()')
      alarm.activeSense()
457
      transaction.commit()
458 459 460 461 462 463 464 465 466 467 468 469 470
      # Note: this call to tic will fail, because the previous message is still there
      # This behaviour is logical if we consider that we want to keep errors
      # in order to know that an error occured.
      try:
        self.tic()
      except RuntimeError:
        pass
      else:
        raise Exception, 'Tic did not raise though activity was supposed to fail'
      # Chen that the second alarm execution did happen
      self.assertNotEquals(alarm.getLastActiveProcess(), None)
    finally:
      self.portal.portal_activities.manageClearActivities(keep=0)
471

472 473
  def test_16_uncatalog(self, quiet=0, run=run_all_test):
    """
474
    Check that deleting an alarm uncatalogs it.
475 476 477 478 479 480
    """
    if not run: return
    if not quiet:
      message = 'Test Uncatalog'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ', 0, message)
481
    alarm = self.newAlarm(enabled=True)
482
    transaction.commit()
483 484 485 486 487
    self.tic()

    now = DateTime()
    date = addToDate(now, day=1)
    alarm.setPeriodicityStartDate(date)
488
    transaction.commit()
489 490 491 492 493
    self.tic()
    self.assertEquals(alarm.getAlarmDate(), date)

    # This should not do change the alarm date
    alarm.setNextAlarmDate(current_date=now)
494
    transaction.commit()
495 496 497 498 499 500 501
    self.tic()
    self.assertEquals(alarm.getAlarmDate(), date)

    # Delete the alarm
    a_tool = self.getAlarmTool()
    alarm_uid = alarm.getUid()
    a_tool.manage_delObjects(uids=[alarm_uid])
502
    transaction.commit()
503 504 505 506 507 508
    self.tic()
    # Check that related entry was removed
    sql_connection = self.getSQLConnection()
    sql = 'select * from alarm where uid=%s' % alarm_uid
    result = sql_connection.manage_test(sql)
    self.assertEquals(0, len(result))
509

510 511 512 513 514 515 516 517 518 519 520
  def test_17_tic(self, quiet=0, run=run_all_test):
    """
    Make sure that the tic method on alarm is working
    """
    if not run: return
    if not quiet:
      message = 'Test AlarmTool Tic'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ', 0, message)
    alarm = self.newAlarm()
    alarm.setEnabled(True)
521
    transaction.commit()
522 523 524 525 526 527 528 529 530 531 532 533
    self.tic()

    sense_method_id = 'Alarm_testSenseMethodForTic'
    skin_folder_id = 'custom'
    skin_folder = self.getPortal().portal_skins[skin_folder_id]
    skin_folder.manage_addProduct['PythonScripts']\
        .manage_addPythonScript(id=sense_method_id)
    # Make the sense method fail
    skin_folder[sense_method_id].ZPythonScript_edit('*args,**kw', 
          'context.setDescription("a")')
    del skin_folder
    alarm.setActiveSenseMethodId(sense_method_id)
534
    transaction.commit()
535 536 537 538
    self.tic()
    alarm_tool = self.getPortal().portal_alarms
    # Nothing should happens yet
    alarm_tool.tic()
539 540
    transaction.commit()
    self.tic()
541 542
    self.assertTrue(alarm.getDescription() in (None, ''))
    now = DateTime()
543
    date = addToDate(now, day=-1)
544 545
    alarm.setPeriodicityStartDate(date)
    alarm.setPeriodicityMinuteFrequency(1)
546
    transaction.commit()
547 548
    self.tic()
    alarm_tool.tic()
549 550
    transaction.commit()
    self.tic()
551 552
    self.assertEquals(alarm.getDescription(), 'a')

553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
  def test_18_alarm_activities_execution_order(self, quiet=0, run=run_all_test):
    """
    Make sure active process created by an alarm get the rigth tag
    """
    if not run: return
    if not quiet:
      message = 'Test Activities execution order'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ', 0, message)

    alarm = self.newAlarm()
    # Create script that generate active process
    sense_method_id = 'Alarm_createActiveProcessSenseMethod'
    skin_folder_id = 'custom'
    skin_folder = self.getPortal().portal_skins[skin_folder_id]
    skin_folder.manage_addProduct['PythonScripts']\
        .manage_addPythonScript(id=sense_method_id)
    skin_folder[sense_method_id].ZPythonScript_edit('*args,**kw', 
          'context.newActiveProcess()')
    # update alarm properties
    alarm.edit(alarm_notification_mode="always",
               active_sense_method_id=sense_method_id,
               enabled=True)
576
    transaction.commit()
577 578
    self.tic()
    alarm.activeSense()
579
    transaction.commit()
580 581 582 583 584 585 586 587 588 589 590 591
    messages_list = self.getActivityTool().getMessageList()
    self.assertEquals(2, len(messages_list))
    # check tags after activeSense
    for m in messages_list:
      if m.method_id == 'notify':
        self.assertEquals(m.activity_kw.get('after_tag'), '1')
      elif m.method_id == sense_method_id:
        self.assertEquals(m.activity_kw.get('tag'), '1')
      else:
        raise AssertionError, m.method_id
    # execute alarm sense script and check tags
    self.getActivityTool().manageInvoke(alarm.getPhysicalPath(),sense_method_id)
592
    transaction.commit()
593 594 595 596 597 598 599 600 601
    messages_list = self.getActivityTool().getMessageList()
    for m in messages_list:
      if m.method_id == 'notify':
        self.assertEquals(m.activity_kw.get('after_tag'), '1')
      elif m.method_id == 'immediateReindexObject':
        self.assertEquals(m.activity_kw.get('tag'), '1')
      else:
        raise AssertionError, m.method_id

602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
  def test_19_ManualInvocation(self, quiet=0, run=run_all_test):
    """
    test if an alarm can be invoked directly by the user securely,
    and if the results are identical when allowed.
    """
    if not run: return
    if not quiet:
      message = 'Test manual invocation'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ', 0, message)

    alarm = self.newAlarm()
    # Create script that generate active process
    sense_method_id = 'Alarm_setBogusLocalProperty'
    skin_folder_id = 'custom'
    skin_folder = self.getPortal().portal_skins[skin_folder_id]
    skin_folder.manage_addProduct['PythonScripts']\
        .manage_addPythonScript(id=sense_method_id)
    skin_folder[sense_method_id].ZPythonScript_edit('*args,**kw', 
          'context.setProperty("bogus", str(context.showPermissions()))')

    # update alarm properties
    alarm.edit(active_sense_method_id=sense_method_id,
               enabled=False)
    transaction.commit()
    self.tic()

    # Make a normal user.
    uf = self.getPortal().acl_users
    uf._doAddUser('normal', '', ['Member', 'Auditor'], [])
    user = uf.getUserById('normal').__of__(uf)
633
    
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
    # Check the pre-conditions.
    self.assertEquals(alarm.getProperty('bogus', None), None)
    self.assertEquals(alarm.getEnabled(), False)
    sm = getSecurityManager()
    newSecurityManager(None, user)

    # Non-managers must not be able to invoke a disabled alarm.
    self.assertRaises(Unauthorized, alarm.activeSense)
    self.assertRaises(Unauthorized, alarm.activeSense, fixit=1)

    # Non-managers must not be able to invoke the automatic fixation.
    setSecurityManager(sm)
    alarm.setEnabled(True)
    self.assertEquals(alarm.getEnabled(), True)
    newSecurityManager(None, user)
    self.assertRaises(Unauthorized, alarm.activeSense, fixit=1)

    # Now, check that everybody can invoke an enabled alarm manually.
    setSecurityManager(sm)
    correct_answer = str(alarm.showPermissions())
    self.assertNotEquals(correct_answer, None)

    alarm.activeSense()
    transaction.commit()
    self.tic()
    self.assertEquals(alarm.getProperty('bogus', None), correct_answer)
    alarm.setProperty('bogus', None)
    self.assertEquals(alarm.getProperty('bogus', None), None)

    newSecurityManager(None, user)
    alarm.activeSense()
    transaction.commit()
    self.tic()
    self.assertEquals(alarm.getProperty('bogus', None), correct_answer)
    setSecurityManager(sm)
    alarm.setProperty('bogus', None)

    # Check that Manager can invoke an alarm freely.
    alarm.activeSense(fixit=1)
    transaction.commit()
    self.tic()
    self.assertEquals(alarm.getProperty('bogus', None), correct_answer)
    alarm.setProperty('bogus', None)
    self.assertEquals(alarm.getProperty('bogus', None), None)

    alarm.setEnabled(False)
    self.assertEquals(alarm.getEnabled(), False)

    alarm.activeSense()
    transaction.commit()
    self.tic()
    self.assertEquals(alarm.getProperty('bogus', None), correct_answer)
    alarm.setProperty('bogus', None)
    self.assertEquals(alarm.getProperty('bogus', None), None)

    alarm.activeSense(fixit=1)
    transaction.commit()
    self.tic()
    self.assertEquals(alarm.getProperty('bogus', None), correct_answer)
    alarm.setProperty('bogus', None)
    self.assertEquals(alarm.getProperty('bogus', None), None)

696 697 698 699 700 701 702 703 704
  def test_20_UndefinedPeriodicityStartDate(self, quiet=0, run=run_all_test):
    """
    Test that getAlarmDate does not crash when PeriodicityStartDate is not set.
    """
    if not run: return
    if not quiet:
      message = 'Test undefined PeriodicityStartDate'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ',0,message)
705
    alarm = self.newAlarm(enabled=True)
706 707 708 709
    # Test sanity check.
    self.assertEqual(alarm.getPeriodicityStartDate(), None)
    # Actual test.
    self.assertEquals(alarm.getAlarmDate(), None)
710

711 712 713 714
def test_suite():
  suite = unittest.TestSuite()
  suite.addTest(unittest.makeSuite(TestAlarm))
  return suite
Sebastien Robin's avatar
Sebastien Robin committed
715