ilTermsOfServiceFileSystemDocumentTest.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once 'Services/TermsOfService/classes/class.ilTermsOfServiceFileSystemDocument.php';

class ilTermsOfServiceFileSystemDocumentTest extends PHPUnit_Framework_TestCase
{
        protected $backupGlobals = false;

        protected $client_dir;

        protected $global_dir;

        protected $lng;

        protected $source_files = array();

        private function isVsfStreamInstalled()
        {
                return @include_once('vfsStream.php');
        }

        private function skipIfvfsStreamNotSupported()
        {
                if(!$this->isVsfStreamInstalled())
                {
                        $this->markTestSkipped('Requires vfsStream (http://vfs.bovigo.org)');
                }
        }

        public function setUp()
        {
                $this->lng = $this->getMockBuilder('ilLanguage')->disableOriginalConstructor()->getMock();
                $this->lng->expects($this->any())
                                  ->method('getLangKey')
                                  ->will($this->returnValue('de'));
                $this->lng->expects($this->any())
                                  ->method('getDefaultLanguage')
                                  ->will($this->returnValue('fr'));

                if($this->isVsfStreamInstalled())
                {
                        vfsStreamWrapper::register();
                        $root             = vfsStreamWrapper::setRoot(new vfsStreamDirectory('root'));
                        $customizing_dir  = vfsStream::newDirectory('Customizing')->at($root);
                        $this->client_dir = vfsStream::newDirectory('clients/default/agreement')->at($customizing_dir);
                        $this->global_dir = vfsStream::newDirectory('global/agreement')->at($customizing_dir);
                        $this->source_files = array(
                                vfsStream::url(implode('/', array('root', 'Customizing', 'clients', 'default', 'agreement', 'agreement_' . $this->lng->getLangKey() . '.html')))         => $this->lng->getLangKey(),
                                vfsStream::url(implode('/', array('root', 'Customizing', 'clients', 'default', 'agreement', 'agreement_' . $this->lng->getDefaultLanguage() . '.html'))) => $this->lng->getDefaultLanguage(),
                                vfsStream::url(implode('/', array('root', 'Customizing', 'clients', 'default', 'agreement', 'agreement_en.html')))                                       => 'en',
                                vfsStream::url(implode('/', array('root', 'Customizing', 'global', 'agreement', 'agreement_' . $this->lng->getLangKey() . '.html')))                     => $this->lng->getLangKey(),
                                vfsStream::url(implode('/', array('root', 'Customizing', 'global', 'agreement', 'agreement_' . $this->lng->getDefaultLanguage() . '.html')))             => $this->lng->getDefaultLanguage(),
                                vfsStream::url(implode('/', array('root', 'Customizing', 'global', 'agreement', 'agreement_en.html')))                                                   => 'en'
                        );
                }
        }

        public function testInstanceCanBeCreated()
        {
                $document = new ilTermsOfServiceFileSystemDocument($this->lng);
                $this->assertInstanceOf('ilTermsOfServiceSignableDocument', $document);
                $document->setSourceFiles($this->source_files);
                return $document;
        }

        public function testExceptionIsRaisedWhenNoSingableDocumentCouldBeFoundForCurrentLanguage()
        {
                $document = new ilTermsOfServiceFileSystemDocument($this->getMockBuilder('ilLanguage')->disableOriginalConstructor()->getMock());
                $document->setSourceFiles(array());
                $document->determine();
        }

        public function testClientDocumentCouldBeRetrievedByCurrentLanguage(ilTermsOfServiceFileSystemDocument $document)
        {
                $this->skipIfvfsStreamNotSupported();

                vfsStream::newFile('agreement_de.html', 0777)->withContent('phpunit')->at($this->client_dir);
                file_put_contents(vfsStream::url('root/Customizing/clients/default/agreement/agreement_de.html'), 'phpunit');

                $document->determine();
                $this->assertEquals('de', $document->getIso2LanguageCode());
                $this->assertTrue($document->hasContent());
                $this->assertEquals('phpunit', $document->getContent());
                $this->assertEquals(ilTermsOfServiceFileSystemDocument::SRC_TYPE_FILE_SYSTEM_PATH, $document->getSourceType());
                $this->assertEquals(vfsStream::url('root/Customizing/clients/default/agreement/agreement_de.html'), $document->getSource());
        }

        public function testClientDocumentCouldBeRetrievedByDefaultLanguage(ilTermsOfServiceFileSystemDocument $document)
        {
                $this->skipIfvfsStreamNotSupported();

                vfsStream::newFile('agreement_fr.html', 0777)->withContent('phpunit')->at($this->client_dir);
                file_put_contents(vfsStream::url('root/Customizing/clients/default/agreement/agreement_fr.html'), 'phpunit');

                $document->determine();
                $this->assertEquals('fr', $document->getIso2LanguageCode());
                $this->assertTrue($document->hasContent());
                $this->assertEquals('phpunit', $document->getContent());
                $this->assertEquals(ilTermsOfServiceFileSystemDocument::SRC_TYPE_FILE_SYSTEM_PATH, $document->getSourceType());
                $this->assertEquals(vfsStream::url('root/Customizing/clients/default/agreement/agreement_fr.html'), $document->getSource());
        }

        public function testClientDocumentCouldBeRetrievedByEnglishLanguage(ilTermsOfServiceFileSystemDocument $document)
        {
                $this->skipIfvfsStreamNotSupported();

                vfsStream::newFile('agreement_en.html', 0777)->withContent('phpunit')->at($this->client_dir);
                file_put_contents(vfsStream::url('root/Customizing/clients/default/agreement/agreement_en.html'), 'phpunit');

                $document->determine();
                $this->assertEquals('en', $document->getIso2LanguageCode());
                $this->assertTrue($document->hasContent());
                $this->assertEquals('phpunit', $document->getContent());
                $this->assertEquals(ilTermsOfServiceFileSystemDocument::SRC_TYPE_FILE_SYSTEM_PATH, $document->getSourceType());
                $this->assertEquals(vfsStream::url('root/Customizing/clients/default/agreement/agreement_en.html'), $document->getSource());
        }

        public function testGlobalDocumentCouldBeRetrievedByCurrentLanguage(ilTermsOfServiceFileSystemDocument $document)
        {
                $this->skipIfvfsStreamNotSupported();

                vfsStream::newFile('agreement_de.html', 0777)->withContent('phpunit')->at($this->client_dir);
                file_put_contents(vfsStream::url('root/Customizing/global/agreement/agreement_de.html'), 'phpunit');

                $document->determine();
                $this->assertEquals('de', $document->getIso2LanguageCode());
                $this->assertTrue($document->hasContent());
                $this->assertEquals('phpunit', $document->getContent());
                $this->assertEquals(ilTermsOfServiceFileSystemDocument::SRC_TYPE_FILE_SYSTEM_PATH, $document->getSourceType());
                $this->assertEquals(vfsStream::url('root/Customizing/global/agreement/agreement_de.html'), $document->getSource());
        }

        public function testGlobalDocumentCouldBeRetrievedByDefaultLanguage(ilTermsOfServiceFileSystemDocument $document)
        {
                $this->skipIfvfsStreamNotSupported();

                vfsStream::newFile('agreement_fr.html', 0777)->withContent('phpunit')->at($this->client_dir);
                file_put_contents(vfsStream::url('root/Customizing/global/agreement/agreement_fr.html'), 'phpunit');

                $document->determine();
                $this->assertEquals('fr', $document->getIso2LanguageCode());
                $this->assertTrue($document->hasContent());
                $this->assertEquals('phpunit', $document->getContent());
                $this->assertEquals(ilTermsOfServiceFileSystemDocument::SRC_TYPE_FILE_SYSTEM_PATH, $document->getSourceType());
                $this->assertEquals(vfsStream::url('root/Customizing/global/agreement/agreement_fr.html'), $document->getSource());
        }

        public function testGlobalDocumentCouldBeRetrievedByEnglishLanguage(ilTermsOfServiceFileSystemDocument $document)
        {
                $this->skipIfvfsStreamNotSupported();

                vfsStream::newFile('agreement_en.html', 0777)->withContent('phpunit')->at($this->client_dir);
                file_put_contents(vfsStream::url('root/Customizing/global/agreement/agreement_en.html'), 'phpunit');

                $document->determine();
                $this->assertEquals('en', $document->getIso2LanguageCode());
                $this->assertTrue($document->hasContent());
                $this->assertEquals('phpunit', $document->getContent());
                $this->assertEquals(ilTermsOfServiceFileSystemDocument::SRC_TYPE_FILE_SYSTEM_PATH, $document->getSourceType());
                $this->assertEquals(vfsStream::url('root/Customizing/global/agreement/agreement_en.html'), $document->getSource());
        }
}