cleanup tests : write a spec bloc.

Author: SebSept

tests/functional/OLATest.php

@@ -56,7 +56,36 @@
 use User;
 
 /**
- * Test Plan / Spec
+ * OLA functional specifications (extracted from test plan below)
+ *
+ * - multiple OLA can be associated to a ticket (no more just a single tto and a single ttr)
+ * - ola due dates cannot be set manually anymore in a ticket
+ * - the same ola can be associated multiple times to a ticket, if one is completed.
+ * - old form params are still supported (olas_id_tto, olas_id_ttr)
+ * - ola must be associated with a group (if the group has the ability to be assigned to a ticket)
+ * - ola previously created (without group) can be associated to tickets
+ * - ola can be associated to ticket by rule and form at the same time
+ * - completion :
+ *      - tto :
+ *          - when ticket is "taken into account" (add task, add followup) by a user of the ola group
+ *          - when a user of the dedicated group assign itself (or it's group) to the ticket.
+ *          - when a group associated to ola is removed from ticket assigned group
+ *      - ttr :
+ *          - when the ticket is closed or solved
+ *          - when a group associated to ola is removed from ticket assigned group
+ * - due time delaying :
+ *      - ttr : when the ticket status is WAITING
+ *      - tto : when the ticket status is WAITING and ticket is not assigned to group
+ * - due_time is not updated on ticket's date update
+ * - ticket is late if :
+ *      - end_time is defined and > due_time
+ *      - end_time is not defined & due_time is passed
+ *      - ticket status is not WAITING
+ */
+
+/**
+ * Test Plan
+ *
  * - ola waiting_start is set to current time on ticket creation with waiting status : @see self::testOlaWaitingStartIsSetOnTicketCreationWithWaitingStatus()
  * - ola data are retrieved : @see self::testGetOLAData()
  * - ola can be associated and deassociate to a ticket :
@@ -89,10 +118,9 @@
  *              - on ticket update : @see self::testInitialOlaTtoValuesOnUpdate()
  *
  *          - completion :
- *              - is done when the dedicated group is assigned to the ticket : @see self::testOlaTtoIsCompleteWhenTicketIsAssignedToDedicatedGroup()
- *              - is done when a user of the dedicated group is assigned to the ticket by a user of the ola group       : @see self::testOlaTtoIsCompleteWhenTicketIsAssignedToUserInDedicatedGroupByUserOfOlaGroup()
+ *              - is done when a user of the dedicated group is assigned to the ticket by a user of the ola group : @see self::testOlaTtoIsCompleteWhenTicketIsAssignedToUserInDedicatedGroupByUserOfOlaGroup()
  *              - is not done when a user of the dedicated group is assigned to the ticket by foreign user of the ola group : @see self::testOlaTtoIsCompleteWhenTicketIsAssignedToUserInDedicatedGroupByUserOfAnotherGroup()
- *              - is not done when a non dedicated group is assigned to the ticket : @see self::testOlaIsNotCompleteWhenTicketIsAssignedToNonDedicatedGroup()
+ *              - is not done when a non-dedicated group is assigned to the ticket : @see self::testOlaIsNotCompleteWhenTicketIsAssignedToNonDedicatedGroup()
  *              - is not done when a user not in the dedicated group is assigned to the ticket : @see self::testOlaTtoIsNotCompleteWhenTicketIsAssignedToUserNotInDedicatedGroup()
  *              - is done when a group associated to ola is removed from ticket assigned group :
  *                  - @see self::testOlaTtoIsCompleteWhenGroupAssociatedToOlaIsRemovedFromTicketAssignedGroup()
@@ -101,12 +129,17 @@
  *                  - @see self::testOlaTtoIsCompleteWhenUserOfGroupAssociatedToOlaTakesTicketIntoAccountWithATask()
  *              - is not done when ticket is updated(add task, add followup) by a user not in the ola group : @see self::testOlaTtoIsNotCompleteWhenUserNotOfGroupAssociatedToOlaTakesTicketIntoAccount()
  *
- *          - delay (ticket has been paused) : // @todo peut-être qu'on en peut lister ici que les tests qui ont un sens au niveau spec et pas les tests qui sont des vérifications liées (ex les vérifs sur waiting_time sont des implications) -> oui ou plutot faire plusieurs assertions dans le meme test.
+ *          - delay (ticket has been paused) :
  *              - due time is delayed if the ticket status is WAITING and ticket is not assigned to group: @see self::testOlaTTODueTimeIsDelayedWhileTicketStatusIsWaitingAndNotAssignedToOlaGroup()
- *              - waiting time is not incremented while the ticket is WAITING and not assigned to ola group @see self::testOlaTTOWaitingTimeIsIncrementedWhileTicketStatusIsWaitingAndNotAssignedToOlaGroup()
+ *              - waiting time is incremented while the ticket is WAITING and not assigned to ola group @see self::testOlaTTOWaitingTimeIsIncrementedWhileTicketStatusIsWaitingAndNotAssignedToOlaGroup()
  *              - due time is not delayed if the ticket status is WAITING and ticket is assigned to group: @see self::testOlaTTODueTimeIsNotDelayedWhileTicketStatusIsWaitingAndAssignedToOlaGroup()
  *              - waiting time is not incremented while the ticket is WAITING and assigned to ola group @see self::testOlaTTOWaitingTimeIsNotIncrementedWhileTicketStatusIsWaitingAndAssignedToOlaGroup()
  *
+ *          - ticket is late if : (business logic extracted from CommonITILObject::generateSLAOLAComputation())*
+ *                 - end_time is defined and > due_time - @see self::testOlaTtoIsLateWhenEndTimeIsAfterDueTime()
+ *                 - end_time is not defined & due_time is passed - @see self::testOlaTtoIsLateWhenDueTimeIsPassed()
+ *                 - ticket status is not WAITING (1): @see self::testOlaTtoIsNotLateWhenTicketStatusIsNotWaiting()
+ *
  *          - ola can be associated by rule and form at the same time @see self::testOlaCanBeAssociatedByRulesAndByForm()
  *          - due_time is not updated on ticket date update @see self::testOlaTtoDueTimeIsNotUpdatedOnTicketDateUpdate()
  *
@@ -124,19 +157,12 @@
  *              - ttr due time is delayed if the ticket status is WAITING : @see self::testOlaTtrDueTimeIsDelayedWhileTicketStatusIsWaiting
  *              - ttr waiting time is incremented while the ticket status is WAITING : @see self::testOlaTTRWaitingTimeIsIncrementedWhileTicketStatusIsWaiting()
  *
- *          - ticket is late if : (business logic extracted from CommonITILObject::generateSLAOLAComputation())*
- *              - tto : (note that takeintoaccountdate is replaced by end_time)
- *                - end_time is defined and > due_time - @see self::testOlaTtoIsLateWhenEndTimeIsAfterDueTime()
- *                - end_time is not defined & due_time is passed - @see self::testOlaTtoIsLateWhenDueTimeIsPassed()
- *                - ticket status is not WAITING (1): @see self::testOlaTtoIsNotLateWhenTicketStatusIsNotWaiting()
- *
- *              - ttr : exactly the same tests as above, duplication to be prepared for future changes
+ *          - ticket is late if : exactly the same tests as for tto (duplication to be prepared for future changes)
  *                 - end_time is defined and > due_time - @see self::testOlaTtrIsLateWhenEndTimeIsAfterDueTime()
  *                 - end_time is not defined & due_time is passed - @see self::testOlaTtrIsLateWhenDueTimeIsPassed()
  *                 - ticket status is not WAITING (1): @see self::testOlaTtrIsNotLateWhenTicketStatusIsNotWating()
  *
  *          - due_time is not updated on ticket date update @see self::testOlaTtrDueTimeIsNotUpdatedOnTicketDateUpdate()
- *          - when completion is done, the associated group is removed from ticket assignees : not implemented, seems not relevant atm
  */
 
 class OLATest extends DbTestCase
@@ -846,7 +872,7 @@ public function testOlaTtoIsNotCompleteWhenTicketIsAssignedToUserNotInDedicatedG
         $ola_data = $ticket->getOlasData()[0];
         assert(null === $ola_data['end_time'], 'End time should not be set when OLA is assigned to ticket.');
 
-        // act - assign ticket to a user of dedicated group
+        // act - assign ticket to a user not in the dedicated group
         $ticket = $this->updateItem(Ticket::class, $ticket->getID(), ['_users_id_assign' => $user->getID()]);
         assert($ticket->isUser(CommonITILActor::ASSIGN, $user->getID()), 'Ticket should be assigned to a user of ola dedicated group.');
 
@@ -1416,18 +1442,20 @@ public function testOlaTtoIsNotLateWhenTicketStatusIsNotWaiting(): void
         $this->assertFalse((bool) $ola_data['is_late'], 'OLA should not be late when ticket is just created.');
 
         // act : wait for ola to be late, set ticket status to WAITING
-        $this->updateItem(Ticket::class, $ticket->getID(), ['status' => CommonITILObject::WAITING]);
-
         $later = $now
             ->add($this->getDefaultOlaTtoDelayInterval())
             ->modify('+1 hour') // add 1 hour to ensure end time is after due time
             ->format('Y-m-d H:i:s');
         $this->setCurrentTime($later);
         $this->runOlaCron();
 
-        // assert - check ola is not late
+        // assert - check ola is late if ticket is not waiting and not late if ticket is in WAITING status
         $ticket = $this->reloadItem($ticket);
         $ola_data = $ticket->getOlasData()[0];
+        $this->assertEquals(1, $ola_data['is_late']);
+
+        $ticket = $this->updateItem(Ticket::class, $ticket->getID(), ['status' => CommonITILObject::WAITING]);
+        $ola_data = $ticket->getOlasData()[0];
         $this->assertEquals(0, $ola_data['is_late'], 'OLA should not be late when ticket is WAITING (even if due time is passed and end time is not set)');
     }