Improvements to gradebook tests

sugarcrm-developers · Apr 6, 2018 · a02378b · a02378b
1 parent c27d7f6
commit a02378b
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 10 deletions.
diff --git a/package/src/custom/Extension/modules/Schedulers/Ext/ScheduledTasks/StudentGradebookJob.php b/package/src/custom/Extension/modules/Schedulers/Ext/ScheduledTasks/StudentGradebookJob.php
@@ -30,11 +30,12 @@ public function run($data)
             try {
                 //Call the external GradebookFake app to create a new record in it
                 $rm = $this->getRecordManager();
-                $success = $rm->createStudentRecord($bean->email1, $bean->first_name, $bean->last_name);
-                if ($success){
+                $success = $rm->createStudentRecord($bean->emailAddress->getPrimaryAddress($bean), $bean->first_name,
+                    $bean->last_name);
+                if ($success) {
                     $this->job->succeedJob();
                     return true;
-                } else{
+                } else {
                     $this->job->failJob("Record not successfully created in GradebookFake");
                     return false;
                 }
@@ -57,7 +58,7 @@ public function run($data)
      */
     protected function getContactBean($id)
     {
-        return BeanFactory::getBean('Contacts', $id);
+        return BeanFactory::retrieveBean('Contacts', $id);
     }
 
     /**

diff --git a/package/src/custom/modules/Contacts/Students_Gradebook.php b/package/src/custom/modules/Contacts/Students_Gradebook.php
@@ -20,7 +20,7 @@ public function addStudentToGradebook(&$bean, $event, $arguments)
         }
 
         //Check if this is a new student record or just an update to an existing record
-        if($arguments['isUpdate']){
+        if ($arguments['isUpdate']) {
             return;
         }
 
@@ -61,11 +61,19 @@ protected function scheduleJob(\SchedulersJob $job)
         return $jq->submitJob($job);
     }
 
+    /**
+     * Returns a new instance of the SchedulersJob class
+     * @return SchedulersJob
+     */
     protected function getSchedulersJob()
     {
         return new SchedulersJob();
     }
 
+    /**
+     * Returns a new instance of the SugarJobQueue class
+     * @return SugarJobQueue
+     */
     protected function getSugarJobQueue()
     {
         return new SugarJobQueue();

diff --git a/...hool/unit-php/Extension/modules/Schedulers/Ext/ScheduledTasks/StudentGradebookJobTest.php b/...hool/unit-php/Extension/modules/Schedulers/Ext/ScheduledTasks/StudentGradebookJobTest.php
@@ -40,7 +40,10 @@ protected function setUp()
         $this->student->id = Uuid::uuid1();
         $this->student->first_name = 'John';
         $this->student->last_name = 'Doe';
-        $this->student->email1 = 'jdoe@example.com';
+
+        $this->emailAddress = TestMockHelper::createMock($this, '\\SugarEmailAddress');
+        $this->student->emailAddress = $this->emailAddress;
+        $this->emailAddress->method('getPrimaryAddress')->willReturn('jdoe@example.com');
 
         // Create a new SchedulersJob and set the job's data to the student's id
         $this->job = TestMockHelper::createPartialMock($this, '\\SchedulersJob', ['succeedJob', 'failJob']);

diff --git a/package/src/custom/tests/School/unit-php/gradebook_fake/RecordManagerTest.php b/package/src/custom/tests/School/unit-php/gradebook_fake/RecordManagerTest.php
@@ -13,7 +13,7 @@ class RecordManagerTest extends TestCase
 {
     /**
      * Check that when valid params are sent to createStudentRecord, true is returned
-     * @covers ::createStudentRecord
+     * @covers Sugarcrm\Sugarcrm\custom\gradebook_fake\RecordManager::createStudentRecord
      */
     public function testRecordManagerValidParams(){
         $rm = new RecordManager();
@@ -23,7 +23,7 @@ public function testRecordManagerValidParams(){
     /**
      * Check that when the email address forceerror@example.com is used as a param for createStudentRecord, an
      * exception is thrown
-     * @covers ::createStudentRecord
+     * @covers Sugarcrm\Sugarcrm\custom\gradebook_fake\RecordManager::createStudentRecord
      */
     public function testRecordManagerForceException(){
         $rm = new RecordManager();

diff --git a/package/src/custom/tests/School/unit-php/phpunit.xml.dist b/package/src/custom/tests/School/unit-php/phpunit.xml.dist
@@ -39,8 +39,11 @@
         </testsuite>
     </testsuites>
     <filter>
-        <whitelist processUncoveredFilesFromWhitelist="false">
-            <directory suffix=".php">../../</directory>
+        <whitelist addUncoveredFilesFromWhitelist="false" processUncoveredFilesFromWhitelist="false">
+            <directory suffix=".php">../../..</directory>
+            <exclude>
+                <directory suffix=".php">../..</directory>
+            </exclude>
         </whitelist>
     </filter>
     <listeners>