ilStudyProgrammeProgressCalculationTest.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2015 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */

use PHPUnit\Framework\TestCase;

require_once(__DIR__ . "/mocks.php");

class ilStudyProgrammeProgressCalculationTest extends TestCase
{
    protected $backupGlobals = false;

    protected function setUp() : void
    {
        require_once("./Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");
        PHPUnit\Framework\Error\Deprecated::$enabled = false;

        global $DIC;
        if (!$DIC) {
            include_once("./Services/PHPUnit/classes/class.ilUnitUtil.php");
            ilUnitUtil::performInitialisation();
        }

        $this->root = ilObjStudyProgramme::createInstance();
        $this->root->putInTree(ROOT_FOLDER_ID);
        $this->root->object_factory = new ilObjectFactoryWrapperMock();
        $this->root->setStatus(ilStudyProgrammeSettings::STATUS_ACTIVE)
                   ->update();

        global $DIC;
        $tree = $DIC['tree'];
        $this->tree = $tree;

        global $DIC;
        $ilUser = $DIC['ilUser'];
        $this->user = $ilUser;
    }

    protected function tearDown() : void
    {
        if ($this->root) {
            $this->root->delete();
        }
    }

    protected function newUser()
    {
        $user = new ilObjUser();
        $user->create();
        return $user;
    }

    protected function setUpNodes($top, $data)
    {
        if (!array_key_exists("points", $data)) {
            throw new Exception("Expected to find 'points' in data array.");
        }

        $top->setPoints($data["points"]);

        foreach ($data as $node_name => $data2) {
            if ($node_name == "points") {
                continue;
            }
            if (isset($this->$node_name)) {
                throw new Exception("Node $node_name already exists.");
            }

            if ($data2 == null) {
                $this->$node_name = new ilStudyProgrammeLeafMock();
                $top->addLeaf($this->$node_name);
            } else {
                $this->$node_name = ilObjStudyProgramme::createInstance();
                $this->$node_name->object_factory = new ilObjectFactoryWrapperMock();
                $top->addNode($this->$node_name);
                $this->setUpNodes($this->$node_name, $data2);
                $this->$node_name->setStatus(ilStudyProgrammeSettings::STATUS_ACTIVE)
                                 ->update();
            }
        }
    }

    public function testProgress1()
    {
        $this->setUpNodes($this->root, array( "points" => 200
        , "node1" => array( "points" => 100
                , "leaf11" => null
                , "leaf12" => null
                )
        , "node2" => array( "points" => 100
                , "leaf21" => null
                , "leaf22" => null
                )
        ));

        $user = $this->newUser();
        $user_id = $user->getId();
        $ass = $this->root->assignUser($user->getId(), 6);
        $ass_id = $ass->getId();

        $this->leaf11->markCompletedFor($user_id);
        $this->leaf21->markCompletedFor($user_id);

        $this->assertEquals(ilStudyProgrammeProgress::STATUS_COMPLETED, $this->root->getProgressForAssignment($ass_id)->getStatus());
        $this->assertEquals(ilStudyProgrammeProgress::STATUS_COMPLETED, $this->node1->getProgressForAssignment($ass_id)->getStatus());
        $this->assertEquals(ilStudyProgrammeProgress::STATUS_COMPLETED, $this->node2->getProgressForAssignment($ass_id)->getStatus());
    }

    public function testProgress2()
    {
        $this->setUpNodes($this->root, array( "points" => 200
        , "node1" => array( "points" => 100
                , "leaf11" => null
                , "leaf12" => null
                )
        , "node2" => array( "points" => 100
                , "leaf21" => null
                , "leaf22" => null
                )
        ));

        $user = $this->newUser();
        $user_id = $user->getId();
        $ass = $this->root->assignUser($user->getId(), 6);
        $ass_id = $ass->getId();

        $this->node1->getProgressForAssignment($ass_id)
                    ->markAccredited($this->user->getId());
        $this->leaf21->markCompletedFor($user_id);

        $this->assertEquals(ilStudyProgrammeProgress::STATUS_COMPLETED, $this->root->getProgressForAssignment($ass_id)->getStatus());
        $this->assertEquals(ilStudyProgrammeProgress::STATUS_ACCREDITED, $this->node1->getProgressForAssignment($ass_id)->getStatus());
        $this->assertEquals(ilStudyProgrammeProgress::STATUS_COMPLETED, $this->node2->getProgressForAssignment($ass_id)->getStatus());
    }

    public function testProgress3()
    {
        $this->setUpNodes($this->root, array( "points" => 200
        , "node1" => array( "points" => 100
                , "leaf11" => null
                , "leaf12" => null
                )
        , "node2" => array( "points" => 100
                , "leaf21" => null
                , "leaf22" => null
                )
        ));

        $user = $this->newUser();
        $user_id = $user->getId();
        $ass = $this->root->assignUser($user->getId(), 6);
        $ass_id = $ass->getId();

        $this->node1->getProgressForAssignment($ass_id)
                    ->markNotRelevant(6);
        $this->root->getProgressForAssignment($ass_id)
                   ->setRequiredAmountOfPoints(100, 6);
        $this->leaf21->markCompletedFor($user_id);

        $this->assertEquals(ilStudyProgrammeProgress::STATUS_COMPLETED, $this->root->getProgressForAssignment($ass_id)->getStatus());
        $this->assertEquals(ilStudyProgrammeProgress::STATUS_NOT_RELEVANT, $this->node1->getProgressForAssignment($ass_id)->getStatus());
        $this->assertEquals(ilStudyProgrammeProgress::STATUS_COMPLETED, $this->node2->getProgressForAssignment($ass_id)->getStatus());
    }

    public function testProgress4()
    {
        $this->setUpNodes($this->root, array( "points" => 200
        , "node1" => array( "points" => 100
                , "leaf11" => null
                , "leaf12" => null
                )
        , "node2" => array( "points" => 100
                , "leaf21" => null
                , "leaf22" => null
                )
        ));

        $user = $this->newUser();
        $user_id = $user->getId();
        $ass = $this->root->assignUser($user->getId(), 6);
        $ass_id = $ass->getId();

        $this->node1->getProgressForAssignment($ass_id)
                    ->markNotRelevant(6);
        $this->leaf11->markCompletedFor($user_id);
        $this->leaf21->markCompletedFor($user_id);

        $this->assertEquals(ilStudyProgrammeProgress::STATUS_IN_PROGRESS, $this->root->getProgressForAssignment($ass_id)->getStatus());
        $this->assertEquals(ilStudyProgrammeProgress::STATUS_NOT_RELEVANT, $this->node1->getProgressForAssignment($ass_id)->getStatus());
        $this->assertEquals(ilStudyProgrammeProgress::STATUS_COMPLETED, $this->node2->getProgressForAssignment($ass_id)->getStatus());
    }

    public function testInitialProgressOnOptionalNodes()
    {
        $this->setUpNodes($this->root, array( "points" => 0
        , "node1" => array( "points" => 100
                , "leaf11" => null
                , "leaf12" => null
                )
        , "node2" => array( "points" => 100
                , "leaf21" => null
                , "leaf22" => null
                )
        ));

        $user = $this->newUser();
        $user_id = $user->getId();
        $ass = $this->root->assignUser($user->getId(), 6);
        $ass_id = $ass->getId();

        $this->assertEquals(ilStudyProgrammeProgress::STATUS_IN_PROGRESS, $this->root->getProgressForAssignment($ass_id)->getStatus());

        $this->leaf11->markCompletedFor($user_id);

        $this->assertEquals(ilStudyProgrammeProgress::STATUS_COMPLETED, $this->root->getProgressForAssignment($ass_id)->getStatus());
    }
}