ilCtrlStructureReaderTest Class Reference

Inheritance diagram for ilCtrlStructureReaderTest:

Collaboration diagram for ilCtrlStructureReaderTest:

Public Member Functions
	testSmoke ()
	testReadSmoke ()
	testReadClassScriptIsAsExpected ()
	testReadClassChildsIsAsExpected ()
	testReadRemovesDuplicateCallsInDatabase ()
	testReadRemovesDuplicateFilesInDatabaseIfCompPrefixIsSet ()
	testShouldDescendToDirectory ()
	testFilesInDir ()
	testIsInterestingFile ()
	testGetGUIClassNameFromClassPath ()
	testGetIlCtrlCallsNoContent ()
	testGetIlCtrlCallsWithContent ()
	testGetIlCtrlIsCalledByNoContent ()
	testGetIlCtrlIsCalledByWithContent ()
	testContainsClassDefinitionFor ()
	testDoesNotContainClassDefinitionFor ()
	testGetIlCtrlCallsWithNamespaces ()
	testGetIlCtrlIsCalledByWithNamespaces ()

Protected Member Functions
	setUp ()

Detailed Description

Definition at line 20 of file ilCtrlStructureReaderTest.php.

Member Function Documentation

setUp()

ilCtrlStructureReaderTest::setUp ( )

protected

Definition at line 22 of file ilCtrlStructureReaderTest.php.

                               : void
    {
        $this->db = $this->createMock(\ilDBInterface::class);
        $this->reader = (new class() extends ilCtrlStructureReader {
            public function _shouldDescendToDirectory(string $dir)
            {
                return $this->shouldDescendToDirectory($dir);
            }
            public function _getFilesIn(string $dir)
            {
                return $this->getFilesIn($dir);
            }
            public function _isInterestingFile(string $file)
            {
                return $this->isInterestingFile($file);
            }
            public function _getGUIClassNameFromClassPath(string $file)
            {
                return $this->getGUIClassNameFromClassPath($file);
            }
            public function _getIlCtrlCalls(string $content)
            {
                return $this->getIlCtrlCalls($content);
            }
            public function _getIlCtrlIsCalledBy(string $content)
            {
                return $this->getIlCtrlIsCalledBy($content);
            }
            public function _containsClassDefinitionFor(string $class, string $content)
            {
                return $this->containsClassDefinitionFor($class, $content);
            }
            protected function getILIASAbsolutePath() : string
            {
                return "";
            }
            public function _readDirTo(string $a_cdir, \ilCtrlStructure $cs = null) : \ilCtrlStructure
            {
                return $this->readDirTo($a_cdir, $cs ?? new \ilCtrlStructure());
            }
            protected function normalizePath(string $path) : string
            {
                return $path;
            }
        })
            ->withDB($this->db);
    }

testContainsClassDefinitionFor()

ilCtrlStructureReaderTest::testContainsClassDefinitionFor

(

)

Definition at line 323 of file ilCtrlStructureReaderTest.php.

    {

testDoesNotContainClassDefinitionFor()

ilCtrlStructureReaderTest::testDoesNotContainClassDefinitionFor

(

)

Definition at line 335 of file ilCtrlStructureReaderTest.php.

Referenced by testGetIlCtrlCallsWithNamespaces().

    {
        $res = $this->reader->_containsClassDefinitionFor(

Here is the caller graph for this function:

testFilesInDir()

ilCtrlStructureReaderTest::testFilesInDir

(

)

Definition at line 186 of file ilCtrlStructureReaderTest.php.

References $result.

    {
        $dir = __DIR__ . "/test_dir";
        $expected = [
            ["class.ilMyTestingGUI.php", "$dir/class.ilMyTestingGUI.php"],
            ["test_file", "$dir/sub_test_dir/test_file"]
        ];
        $result = iterator_to_array($this->reader->_getFilesIn($dir));
        sort($expected);
        sort($result);
        $this->assertEquals($expected, $result);
    }

testGetGUIClassNameFromClassPath()

ilCtrlStructureReaderTest::testGetGUIClassNameFromClassPath

(

)

Definition at line 210 of file ilCtrlStructureReaderTest.php.

    {
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("/my/dir/ilSCORM13Player.php"));
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("\\my\\dir\\ilSCORM13Player.php"));
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("c:\\my\\dir\\ilSCORM13Player.php"));
        $this->assertEquals("ilscorm13playergui", $this->reader->_getGUIClassNameFromClassPath("/my/dir/class.ilSCORM13PlayerGUI.php"));
        $this->assertEquals("ilscorm13playergui", $this->reader->_getGUIClassNameFromClassPath("\\my\\dir\\class.ilSCORM13PlayerGUI.php"));
        $this->assertEquals("ilscorm13playergui", $this->reader->_getGUIClassNameFromClassPath("c:\\my\\dir\\class.ilSCORM13PlayerGUI.php"));
        $this->assertEquals("ilmytestinggui", $this->reader->_getGUIClassNameFromClassPath("/my/dir/class.ilMyTestingGUI.php"));
        $this->assertEquals("ilmytestinggui", $this->reader->_getGUIClassNameFromClassPath("\\my\\dir\\class.ilMyTestingGUI.php"));
        $this->assertEquals("ilmytestinggui", $this->reader->_getGUIClassNameFromClassPath("c:\\my\\dir\\class.ilMyTestingGUI.php"));
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("/my/dir/foo.php"));
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("\\my\\dir\\foo.php"));
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("c:\\my\\dir\\foo.php"));
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("/my/dir/picture.png"));
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("\\my\\dir\\picture.png"));
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("c:\\my\\dir\\picture.png"));
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("/my/dir/icon.svg"));
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("\\my\\dir\\icon.svg"));
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("c:\\my\\dir\\icon.svg"));
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("/my/dir/data.json"));
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("\\my\\dir\\data.json"));
        $this->assertNull($this->reader->_getGUIClassNameFromClassPath("c:\\my\\dir\\data.json"));
    }

testGetIlCtrlCallsNoContent()

ilCtrlStructureReaderTest::testGetIlCtrlCallsNoContent

(

)

Definition at line 235 of file ilCtrlStructureReaderTest.php.

References PHP.

    {
        $gen = $this->reader->_getIlCtrlCalls(
            <<<"PHP"
class SomeRandomClass {
}
PHP
        );
        $this->assertNull($gen);
    }

testGetIlCtrlCallsWithContent()

ilCtrlStructureReaderTest::testGetIlCtrlCallsWithContent

(

)

Definition at line 246 of file ilCtrlStructureReaderTest.php.

References PHP.

    {
        list($parent, $children) = $this->reader->_getIlCtrlCalls(
            <<<"PHP"
<?php
/* Copyright (c) 2020 ILIAS open source, Extended GPL, see docs/LICENSE */


require_once "./Services/Container/classes/class.ilContainerGUI.php";

class ilObjCourseGUI extends ilContainerGUI
{
}
PHP
        );
        $expected = [
            "ilcourseregistrationgui",
            "ilcourseobjectivesgui",
            "ilobjcoursegroupinggui",
            "ilinfoscreengui",
            "illearningprogressgui",

testGetIlCtrlCallsWithNamespaces()

ilCtrlStructureReaderTest::testGetIlCtrlCallsWithNamespaces

(

)

Definition at line 348 of file ilCtrlStructureReaderTest.php.

References $res, PHP, and testDoesNotContainClassDefinitionFor().

                      {
}
PHP
        );
        $this->assertTrue($res);
    }

    public function testDoesNotContainClassDefinitionFor()
    {
        $res = $this->reader->_containsClassDefinitionFor(
            "SomeRandomClass",
            <<<"PHP"
class fooSomeRandomClass {
}
PHP
        );
        $this->assertFalse($res);
    }


    public function testGetIlCtrlCallsWithNamespaces() : void
    {
        list($parent, $children) = $this->reader->_getIlCtrlCalls(

Here is the call graph for this function:

testGetIlCtrlIsCalledByNoContent()

ilCtrlStructureReaderTest::testGetIlCtrlIsCalledByNoContent

(

)

Definition at line 279 of file ilCtrlStructureReaderTest.php.

    {

testGetIlCtrlIsCalledByWithContent()

ilCtrlStructureReaderTest::testGetIlCtrlIsCalledByWithContent

(

)

Definition at line 290 of file ilCtrlStructureReaderTest.php.

References PHP.

    {
        $gen = $this->reader->_getIlCtrlIsCalledBy(
            <<<"PHP"
class SomeRandomClass {
}
PHP
        );
        $this->assertNull($gen);
    }

    public function testGetIlCtrlIsCalledByWithContent()
    {
        list($parent, $children) = $this->reader->_getIlCtrlIsCalledBy(
            <<<"PHP"
<?php
/* Copyright (c) 2020 ILIAS open source, Extended GPL, see docs/LICENSE */


require_once "./Services/Container/classes/class.ilContainerGUI.php";

class ilObjCourseGUI extends ilContainerGUI

testGetIlCtrlIsCalledByWithNamespaces()

ilCtrlStructureReaderTest::testGetIlCtrlIsCalledByWithNamespaces

(

)

Definition at line 373 of file ilCtrlStructureReaderTest.php.

                                                            : void

testIsInterestingFile()

ilCtrlStructureReaderTest::testIsInterestingFile

(

)

Definition at line 199 of file ilCtrlStructureReaderTest.php.

    {
        $this->assertFalse($this->reader->_isInterestingFile("ilSCORM13Player.php"));
        $this->assertTrue($this->reader->_isInterestingFile("class.ilSCORM13PlayerGUI.php"));
        $this->assertTrue($this->reader->_isInterestingFile("class.ilMyTestingGUI.php"));
        $this->assertFalse($this->reader->_isInterestingFile("foo.php"));
        $this->assertFalse($this->reader->_isInterestingFile("picture.png"));
        $this->assertFalse($this->reader->_isInterestingFile("icon.svg"));
        $this->assertFalse($this->reader->_isInterestingFile("data.json"));
    }

testReadClassChildsIsAsExpected()

ilCtrlStructureReaderTest::testReadClassChildsIsAsExpected

(

)

Definition at line 96 of file ilCtrlStructureReaderTest.php.

References $result.

    {
        $dir = __DIR__ . "/test_dir/";
        $result = $this->reader->_readDirTo($dir);

        $expected_class_childs = [
           "ilmytestinggui" => [
                "ilmyothertestinggui"
            ],
            "ilmythirdtestinggui" => [
                "ilmytestinggui"
            ]
        ];
        $this->assertEquals(
            $expected_class_childs,
            iterator_to_array($result->getClassChildren())
        );
    }

testReadClassScriptIsAsExpected()

ilCtrlStructureReaderTest::testReadClassScriptIsAsExpected

(

)

Definition at line 82 of file ilCtrlStructureReaderTest.php.

References $result.

    {
        $dir = __DIR__ . "/test_dir";
        $result = $this->reader->_readDirTo($dir);

        $expected_class_script = [
           "ilmytestinggui" => "$dir/class.ilMyTestingGUI.php"
        ];
        $this->assertEquals(
            $expected_class_script,
            iterator_to_array($result->getClassScripts())
        );
    }

testReadRemovesDuplicateCallsInDatabase()

ilCtrlStructureReaderTest::testReadRemovesDuplicateCallsInDatabase

(

)

Definition at line 115 of file ilCtrlStructureReaderTest.php.

References Vendor\Package\$f, and $result.

    {
        $this->expectException(\Exception::class);

        $dir = __DIR__ . "/test_dir/";

        $this->reader->comp_prefix = "";
        $ctrl_structure = new \ilCtrlStructure([
           "ilmytestinggui" => "/some/other/dir/class.ilMyTestingGUI.php"
        ]);
        $this->db
            ->method("quote")
            ->will($this->returnCallback(function ($v, $_) {
                return "\"$v\"";
            }));
        $this->db
            ->method("equals")
            ->will($this->returnCallback(function ($f, $v, $_, $__) {
                return "$f = \"$v\"";
            }));
        $this->db->expects($this->exactly(4))
            ->method("manipulate")
            ->withConsecutive(
                ["DELETE FROM ctrl_classfile WHERE comp_prefix = \"\""],
                ["DELETE FROM ctrl_classfile WHERE comp_prefix = \"\""],
                ["DELETE FROM ctrl_calls WHERE comp_prefix = \"\""],
                ["DELETE FROM ctrl_calls WHERE comp_prefix IS NULL"]
            );

        $result = $this->reader->_readDirTo($dir, $ctrl_structure);
    }

testReadRemovesDuplicateFilesInDatabaseIfCompPrefixIsSet()

ilCtrlStructureReaderTest::testReadRemovesDuplicateFilesInDatabaseIfCompPrefixIsSet

(

)

Definition at line 147 of file ilCtrlStructureReaderTest.php.

References Vendor\Package\$f, and $result.

    {
        $this->expectException(\Exception::class);

        $dir = __DIR__ . "/test_dir/";
        $my_comp_prefix = "mcp";

        $this->reader->comp_prefix = $my_comp_prefix;
        $ctrl_structure = new \ilCtrlStructure([
           "ilmytestinggui" => "/some/other/dir/class.ilMyTestingGUI.php"
        ]);
        $this->db
            ->method("quote")
            ->will($this->returnCallback(function ($v, $_) {
                return "\"$v\"";
            }));
        $this->db
            ->method("equals")
            ->will($this->returnCallback(function ($f, $v, $_, $__) {
                return "$f = \"$v\"";
            }));
        $this->db->expects($this->exactly(2))
            ->method("manipulate")
            ->withConsecutive(
                ["DELETE FROM ctrl_classfile WHERE comp_prefix = \"$my_comp_prefix\""],
                ["DELETE FROM ctrl_calls WHERE comp_prefix = \"$my_comp_prefix\""]
            );

        $result = $this->reader->_readDirTo($dir, $ctrl_structure);
    }

testReadSmoke()

ilCtrlStructureReaderTest::testReadSmoke

(

)

Definition at line 75 of file ilCtrlStructureReaderTest.php.

References $result.

    {
        $dir = __DIR__ . "/test_dir";
        $result = $this->reader->_readDirTo($dir);
        $this->assertInstanceOf(\ilCtrlStructure::class, $result);
    }

testShouldDescendToDirectory()

ilCtrlStructureReaderTest::testShouldDescendToDirectory

(

)

Definition at line 178 of file ilCtrlStructureReaderTest.php.

    {
        $this->assertTrue($this->reader->_shouldDescendToDirectory("/foo"));
        $this->assertTrue($this->reader->_shouldDescendToDirectory("/bar"));
        $this->assertFalse($this->reader->_shouldDescendToDirectory("/data"));
        $this->assertFalse($this->reader->_shouldDescendToDirectory("/Customizing"));
    }

testSmoke()

ilCtrlStructureReaderTest::testSmoke

(

)

Definition at line 70 of file ilCtrlStructureReaderTest.php.

    {
        $this->assertInstanceOf(ilCtrlStructureReader::class, $this->reader);
    }

---

The documentation for this class was generated from the following file:

• Services/UICore/test/ilCtrlStructureReaderTest.php