Integration tests

.travis.yml

@@ -1,20 +1,69 @@
 stages:
-- name: test
+- name: Test PackageGenerator
+- name: Run PHPUnit
 - name: Build & Post on GitHub
   if: branch = master
 jobs:
   include:
-  - stage: test
+  - stage: Test PackageGenerator
     language: php
     php: '7.1'
     os: linux
     before_script:
     - composer install
-  - stage: test
+  - stage: Test PackageGenerator
     language: node_js
     node_js: '9'
     before_install:
     - yarn global add grunt-cli
+  - stage: Run PHPUnit
+    sudo: required
+    language: php
+    php: '7.1'
+    services:
+    - docker
+    env:
+    - SUGAR_VERSION=7.11 SUGAR_EDITION=Ent
+    before_script:
+    - composer install
+    - cd package
+    - "./pack.php -v $(date +'%Y%m%d-%H.%M.%S')"
+    - cd ../scripts
+    - sudo service mysql stop
+    script:
+      - ./SetupEnvAndRunPHPUnitTests.sh $DEV_COMMUNITY_USERNAME $DEV_COMMUNITY_PASSWORD $SUGAR_VERSION $SUGAR_EDITION $GITHUB_USERNAME $GITHUB_PASSWORD workspace/sugardocker
+  - stage: Run PHPUnit
+    sudo: required
+    language: php
+    php: '7.1'
+    services:
+    - docker
+    env:
+    - SUGAR_VERSION=7.11 SUGAR_EDITION=Pro
+    before_script:
+    - composer install
+    - cd package
+    - "./pack.php -v $(date +'%Y%m%d-%H.%M.%S')"
+    - cd ../scripts
+    - sudo service mysql stop
+    script:
+      - ./SetupEnvAndRunPHPUnitTests.sh $DEV_COMMUNITY_USERNAME $DEV_COMMUNITY_PASSWORD $SUGAR_VERSION $SUGAR_EDITION $GITHUB_USERNAME $GITHUB_PASSWORD workspace/sugardocker
+  - stage: Run PHPUnit
+    sudo: required
+    language: php
+    php: '7.1'
+    services:
+    - docker
+    env:
+    - SUGAR_VERSION=7.11 SUGAR_EDITION=Ult
+    before_script:
+    - composer install
+    - cd package
+    - "./pack.php -v $(date +'%Y%m%d-%H.%M.%S')"
+    - cd ../scripts
+    - sudo service mysql stop
+    script:
+      - ./SetupEnvAndRunPHPUnitTests.sh $DEV_COMMUNITY_USERNAME $DEV_COMMUNITY_PASSWORD $SUGAR_VERSION $SUGAR_EDITION $GITHUB_USERNAME $GITHUB_PASSWORD workspace/sugardocker
   - stage: Build & Post on GitHub
     language: php
     php: '7.1'

package/pack.php

@@ -23,7 +23,7 @@
 
 $packageID = "ProfessorM";
 $packageLabel = "Professor M School for Gifted Coders";
-$supportedVersionRegex = '7\\..*$';
+$supportedVersionRegex = '(8\..*|7\.(9|10|11)\..*)';
 
 /*
  * Determine the version of the zip

package/src/custom/Extension/modules/Schedulers/Ext/ScheduledTasks/StudentGradebookJob.php

@@ -0,0 +1,72 @@
+<?php
+
+use Sugarcrm\Sugarcrm\custom\gradebook_fake\RecordManager;
+
+class StudentGradebookJob implements RunnableSchedulerJob
+{
+
+    /**
+     * @var SchedulersJob
+     */
+    protected $job;
+    /**
+     * @param SchedulersJob $job
+     */
+    public function setJob(SchedulersJob $job)
+    {
+        $this->job = $job;
+    }
+
+    /**
+     * This function defines the job that adds a new student to the GradebookFake app
+     * @param string $data The id for the new Student (contact) record
+     * @return bool true if a record was successfully created in the GradebookFake app
+     */
+    public function run($data)
+    {
+        if (!empty($data)) {
+            $bean = $this->getContactBean($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){
+                    $this->job->succeedJob();
+                    return true;
+                } else{
+                    $this->job->failJob("Record not successfully created in GradebookFake");
+                    return false;
+                }
+            } catch (Exception $e) {
+                $this->job->failJob($e->getMessage());
+
+                return false;
+            }
+
+        }
+
+        $this->job->failJob("Job had no data");
+        return false;
+    }
+
+    /**
+     * Get the Contact (Student) bean for the given id
+     * @param $id The id for which you want to retrieve a Contact (Student) bean
+     * @return null|SugarBean
+     */
+    protected function getContactBean($id)
+    {
+        return BeanFactory::getBean('Contacts', $id);
+    }
+
+    /**
+     * Get the Record Manager for the GradebookFake app
+     * @return RecordManager The Record Manager for the GradebookFake app
+     */
+    protected function getRecordManager()
+    {
+        return new RecordManager();
+    }
+
+}

package/src/custom/modules/Contacts/Students_Gradebook.php

@@ -1,7 +1,5 @@
 <?php
 
-if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
-
 /**
  * Class Students_Gradebook
  * Handles creating a job for the Sugar Job Queue that adds a new student to the GradebookFake app
@@ -15,30 +13,61 @@ class Students_Gradebook
      * @param $event The current event
      * @param $arguments Additional information related to the event
      */
-    function AddStudentToGradebook(&$bean, $event, $arguments)
+    public function addStudentToGradebook(&$bean, $event, $arguments)
     {
+        if ($event !== 'after_save') {
+            return;
+        }
+
         //Check if this is a new student record or just an update to an existing record
-        if(!$arguments['isUpdate']){
-
-            require_once('include/SugarQueue/SugarJobQueue.php');
-
-            //create the new job
-            $job = new SchedulersJob();
-            //job name
-            $job->name = "Add New Student to Gradebook Job";
-            //data we are passing to the job
-            $job->data = $bean->id;
-            //function to call
-            $job->target = "function::AddStudentToGradebookJob";
-
-            global $current_user;
-            //set the user the job runs as
-            $job->assigned_user_id = $current_user->id;
-
-            //push into the queue to run
-            $jq = new SugarJobQueue();
-            $jobid = $jq->submitJob($job);
+        if($arguments['isUpdate']){
+            return;
         }
 
+        $job = $this->defineJob($bean);
+
+        $this->scheduleJob($job);
+    }
+
+    /**
+     * Define the job that adds a new student to the GradebookFake app
+     * @param SugarBean $bean The Student (Contact) bean
+     * @return SchedulersJob The job that was defined
+     */
+    protected function defineJob(\SugarBean $bean)
+    {
+        //create the new job
+        $job = $this->getSchedulersJob();
+        //job name
+        $job->name = "Add New Student to Gradebook Job";
+        //data we are passing to the job
+        $job->data = $bean->id;
+        //function to call
+        $job->target = "class::StudentGradebookJob";
+        //set the user the job runs as
+        $job->assigned_user_id = $GLOBALS['current_user']->id;
+
+        return $job;
+    }
+
+    /**
+     * Schedule the job to run by submitting it to the Sugar Job Queue
+     * @param SchedulersJob $job The job to submit
+     * @return string Response from submitting the job
+     */
+    protected function scheduleJob(\SchedulersJob $job)
+    {
+        $jq = $this->getSugarJobQueue();
+        return $jq->submitJob($job);
+    }
+
+    protected function getSchedulersJob()
+    {
+        return new SchedulersJob();
+    }
+
+    protected function getSugarJobQueue()
+    {
+        return new SugarJobQueue();
     }
 }

package/src/custom/tests/School/unit-php/Extension/modules/Schedulers/Ext/ScheduledTasks/StudentGradebookJobTest.php

@@ -0,0 +1,124 @@
+<?php
+
+namespace Sugarcrm\SugarcrmTestsUnit\modules\Schedulers\Ext\ScheduledTasks;
+
+use Sugarcrm\SugarcrmTestsUnit\TestMockHelper;
+use Sugarcrm\Sugarcrm\Util\Uuid;
+
+require_once 'custom/Extension/modules/Schedulers/Ext/ScheduledTasks/StudentGradebookJob.php';
+/**
+ * @coversDefaultClass \StudentGradebookJob
+ */
+class StudentGradebookJobTest extends \PHPUnit\Framework\TestCase
+{
+    /**
+     * @var a partial mock of a Student (Contact) with an id, first name, last name, and email
+     */
+    private $student;
+
+    /**
+     * @var a partial mock of SchedulersJob
+     */
+    private $job;
+
+    /**
+     * @var a partial mock of RecordManager
+     */
+    private $rm;
+
+    /**
+     * @var a partial mock of StudentGradebookJob
+     */
+    private $sgJob;
+
+    protected function setUp()
+    {
+        parent::setUp();
+
+        // Create a new Student (Contact) with an id, first name, last name, and email
+        $this->student = TestMockHelper::createPartialMock($this, '\\Contact', []);
+        $this->student->id = Uuid::uuid1();
+        $this->student->first_name = 'John';
+        $this->student->last_name = 'Doe';
+        $this->student->email1 = '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']);
+        $this->job->data = $this->student->id;
+
+        // Create a mock of the Gradebook's RecordManager
+        $this->rm = TestMockHelper::createPartialMock($this, '\\Sugarcrm\\Sugarcrm\\custom\\gradebook_fake\\RecordManager', ['createStudentRecord']);
+
+        // Create a mock of the StudentGradebookJob. getContactBean will return the mock student we created.
+        // getRecordManager returns the mock RecordManager we created
+        $this->sgJob = TestMockHelper::createPartialMock($this, '\\StudentGradebookJob', ['getContactBean', 'getRecordManager']);
+        $this->sgJob->method('getContactBean')->willReturn($this->student);
+        $this->sgJob->method('getRecordManager')->willReturn($this->rm);
+
+        // Set the job to be our mock job
+        $this->sgJob->setJob($this->job);
+    }
+
+    /**
+     * @covers ::run
+     */
+    public function testRun_JobSucceeds()
+    {
+        $this->job->expects($this->once())->method('succeedJob');
+        $this->job->expects($this->never())->method('failJob');
+
+        $this->rm->expects($this->once())->method('createStudentRecord')->willReturn(true);
+
+        $actual = $this->sgJob->run($this->job->data);
+
+        $this->assertTrue($actual);
+    }
+
+    /**
+     * @covers ::run
+     */
+    public function testRun_RecordManagerReturnsFalse_JobFails()
+    {
+        $this->job->expects($this->never())->method('succeedJob');
+        $this->job->expects($this->once())->method('failJob')->with("Record not successfully created in GradebookFake");
+
+        $this->rm->expects($this->once())->method('createStudentRecord')->willReturn(false);
+
+        $actual = $this->sgJob->run($this->job->data);
+
+        $this->assertFalse($actual);
+    }
+
+    /**
+     * @covers ::run
+     */
+    public function testRun_RecordManagerThrowsException_JobFails()
+    {
+        $exceptionMessage = "An exception occurred";
+
+        $this->job->expects($this->never())->method('succeedJob');
+        $this->job->expects($this->once())->method('failJob')->with($exceptionMessage);
+
+        $this->rm->expects($this->once())->method('createStudentRecord')->willThrowException(new \Exception($exceptionMessage));
+
+        $actual = $this->sgJob->run($this->job->data);
+
+        $this->assertFalse($actual);
+    }
+
+    /**
+     * @covers ::run
+     */
+    public function testRun_NoData_JobFails()
+    {
+        $this->job->expects($this->never())->method('succeedJob');
+        $this->job->expects($this->once())->method('failJob')->with("Job had no data");
+
+        $this->rm->expects($this->never())->method('createStudentRecord');
+
+        $actual = $this->sgJob->run('');
+
+        $this->assertFalse($actual);
+    }
+
+}