/.dev/tests/Classes/Model/PHARModule.php

<?php
// vim: set ts=4 sw=4 sts=4 et:

/**
 * LiteCommerce
 * 
 * NOTICE OF LICENSE
 * 
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to licensing@litecommerce.com so we can send you a copy immediately.
 * 
 * @category   LiteCommerce
 * @package    Tests
 * @subpackage Classes
 * @author     Creative Development LLC <info@cdev.ru> 
 * @copyright  Copyright (c) 2010 Creative Development LLC <info@cdev.ru>. All rights reserved
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @version    GIT: $Id: 4e4c1b003097e114eb642039e1c6efeee627580d $
 * @link       http://www.litecommerce.com/
 * @see        ____file_see____
 * @since      3.0.0
 */

class XLite_Tests_Model_PHARModule extends XLite_Tests_TestCase
{

    public function setUp()
    {
        parent::setUp();

        \Includes\Utils\FileManager::mkdirRecursive(LC_LOCAL_REPOSITORY);
    }

    private function getFile($file)
    {
        return dirname(__FILE__) . LC_DS . 'phars' . LC_DS . $file;
    }


    public function testBadConstruct()
    {
        \Includes\Utils\FileManager::mkdirRecursive(LC_LOCAL_REPOSITORY);

        @copy($this->getFile('bad.phar'), LC_LOCAL_REPOSITORY . 'bad.phar');

        $phar = new \XLite\Model\PHARModule('bad.phar');

        $message = $phar->getError();

        $this->assertEquals(
            $message,
            'internal corruption of phar "' . LC_LOCAL_REPOSITORY . 'bad.phar' . '" (truncated entry)',
            'must be corrupted PHAR'
        );

        @unlink(LC_LOCAL_REPOSITORY . 'bad.phar');

        $phar = new \XLite\Model\PHARModule('bad-bad-bad-name.phar');

        $message = $phar->getError();
        $status  = $phar->getStatus();

        $this->assertTrue(is_null($message) && 'error' === $status, 'Wrong error when addons catalog/file does not exist');
    }

    public function testGoodConstruct()
    {
        copy($this->getFile('good.phar'), LC_LOCAL_REPOSITORY . 'good.phar');

        $message = '';

        try {

            $phar = new \XLite\Model\PHARModule('good.phar');

        } catch (Exception $e) {

            $message = $e->getMessage();
        }

        $this->assertEquals('', $message, 'There must be no exceptions in the "Good" module');
        $this->assertTrue(is_object($phar) && !is_null($phar), 'PHAR object was not constructed');

        $phar->cleanUp();

        unlink(LC_LOCAL_REPOSITORY . 'good.phar');
    }

    public function testCheck()
    {
        // NO ini file checking
        copy($this->getFile('no_ini.phar'), LC_LOCAL_REPOSITORY . 'no_ini.phar');
        $phar = new \XLite\Model\PHARModule('no_ini.phar');
        $phar->check();

        $this->assertEquals($phar->getStatus(), 'wrong_structure', 'Wrong status for no INI file');

        $phar->cleanUp();
        unlink(LC_LOCAL_REPOSITORY . 'no_ini.phar');

        // NO catalogs checking
        copy($this->getFile('no_dir.phar'), LC_LOCAL_REPOSITORY . 'no_dir.phar');
        $phar = new \XLite\Model\PHARModule('no_dir.phar');
        $phar->check();

        $this->assertEquals($phar->getStatus(), 'wrong_structure', 'Wrong status for no DIR file');

        $phar->cleanUp();
        unlink(LC_LOCAL_REPOSITORY . 'no_dir.phar');

        // Corrupted INI checking
        copy($this->getFile('corrupted_ini.phar'), LC_LOCAL_REPOSITORY . 'corrupted_ini.phar');
        $phar = new \XLite\Model\PHARModule('corrupted_ini.phar');
        $phar->check();

        $this->assertEquals($phar->getStatus(), 'ini_corrupted', 'Wrong status for corrupted INI file');

        $phar->cleanUp();
        unlink(LC_LOCAL_REPOSITORY . 'corrupted_ini.phar');

        // Wrong INI checking
        copy($this->getFile('wrong_ini.phar'), LC_LOCAL_REPOSITORY . 'wrong_ini.phar');
        $phar = new \XLite\Model\PHARModule('wrong_ini.phar');
        $phar->check();

        $this->assertEquals($phar->getStatus(), 'wrong_specification', 'Wrong status for wrong INI file');

        $phar->cleanUp();
        unlink(LC_LOCAL_REPOSITORY . 'wrong_ini.phar');

        // Already installed module checking
        copy($this->getFile('already.phar'), LC_LOCAL_REPOSITORY . 'already.phar');
        $phar = new \XLite\Model\PHARModule('already.phar');
        $phar->check();

        $this->assertEquals($phar->getStatus(), 'wrong_install', 'Wrong status for already installed module');

        $phar->cleanUp();
        unlink(LC_LOCAL_REPOSITORY . 'already.phar');
    }

    public function testDeploy()
    {
        // Deploying only classes directory module
        copy($this->getFile('test_module.phar'), LC_LOCAL_REPOSITORY . 'test_module.phar');

        $phar = new \XLite\Model\PHARModule('test_module.phar');

        $phar->check();

        $this->assertEquals('ok', $phar->getStatus(), 'Good module must be validated');

        $phar->deploy();

        $phar->cleanUp();

        $dir = LC_CLASSES_DIR . 'XLite' . LC_DS . 'Module' . LC_DS . 'CDev' . LC_DS . 'Good';

        $this->assertTrue(is_dir($dir), 'Classes catalog was not created');

        $files = array(
            'CHANGELOG',
            'Main.php',
            'install.php',
            'install.yaml',
        );

        foreach ($files as $file) {
            $this->assertTrue(is_file($dir . LC_DS . $file));
        }

        \Includes\Utils\FileManager::unlinkRecursive($dir);

        unlink(LC_LOCAL_REPOSITORY . 'test_module.phar');
    }

    public function testDeploy2()
    {
        // Deploying classes and skins directories module
        copy($this->getFile('test_module2.phar'), LC_LOCAL_REPOSITORY . 'test_module2.phar');

        $phar = new \XLite\Model\PHARModule('test_module2.phar');

        $phar->check();

        $this->assertEquals('ok', $phar->getStatus(), 'new Bestsellers module must be validated');

        $phar->deploy();

        $phar->cleanUp();

        $classesDir = LC_CLASSES_DIR . 'XLite' . LC_DS . 'Module' . LC_DS . 'TestAuthor';

        $skins = array(
            LC_SKINS_DIR . 'admin' . LC_DS . 'en' . LC_DS . 'modules' . LC_DS . 'TestAuthor',
            LC_SKINS_DIR . 'drupal' . LC_DS . 'en' . LC_DS . 'modules' . LC_DS . 'TestAuthor',
        );

        $this->assertTrue(is_dir($classesDir . LC_DS . 'Bestsellers'), 'Classes catalog was not created');

        foreach ($skins as $skin) {
            $this->assertTrue(is_dir($skin . LC_DS . 'Bestsellers'), $skin . ' was not created');
        }

        \Includes\Utils\FileManager::unlinkRecursive($classesDir);

        foreach ($skins as $skin) {
            \Includes\Utils\FileManager::unlinkRecursive($skin);
        }

        unlink(LC_LOCAL_REPOSITORY . 'test_module2.phar');
    }


    public function testCleanUp()
    {


    }

}