boost-tasks/tests/SuperProject.phpt

<?php

use Tester\Assert;
use BoostTasks\SuperProject;
use BoostTasks\SuperProject_SubModule;
use BoostTasks\TempDirectory;
use BoostTasks\RepoBase;
use BoostTasks\Process;

require_once(__DIR__.'/bootstrap.php');

class SuperProjectTest extends TestBase {
    function testCreateSuperProject() {
        $x = new SuperProject(array(
            'path' => __DIR__,
            'superproject-branch' => 'super-branch',
            'submodule-branch' => 'sub-branch',
        ));

        Assert::same(__DIR__, $x->path);
        Assert::same('boost', $x->module);
        Assert::same('super-branch', $x->branch);
        Assert::same('sub-branch', $x->submodule_branch);
        // TODO: This fails on the server:
        //Assert::false($x->enable_push);
    }

    function testIncompleteSuperProject() {
        Assert::exception(function() {
            $x = new SuperProject(array());
        }, 'RuntimeException');

        Assert::exception(function() {
            $x = new SuperProject(array(
                'superproject-branch' => 'super-branch',
                'submodule-branch' => 'sub-branch',
            ));
        }, 'RuntimeException');

        Assert::exception(function() {
            $x = new SuperProject(array(
                'path' => __DIR__,
                'submodule-branch' => 'sub-branch',
            ));
        }, 'RuntimeException');

        Assert::exception(function() {
            $x = new SuperProject(array(
                'path' => __DIR__,
                'superproject-branch' => 'super-branch',
            ));
        }, 'RuntimeException');
    }

    function testSubmoduleWithRelativeUrl() {
        $x = new SuperProject_Submodule('vmd', array(
            'path' => 'libs/vmd',
            'url' => '../vmd.git',
            'fetchRecurseSubmodules' => 'on-demand',
        ));

        Assert::same('libs/vmd', $x->path);
        Assert::same('vmd', $x->boost_name);
        Assert::same('boostorg/vmd', $x->github_name);
    }

    function testSubmoduleWithBoostorgUrl() {
        $x = new SuperProject_Submodule('flip/flop', array(
            'path' => 'libs/flop',
            'url' => 'https://github.com/boostorg/flip.git',
        ));

        Assert::same('libs/flop', $x->path);
        Assert::same('flip/flop', $x->boost_name);
        Assert::same('boostorg/flip', $x->github_name);
    }

    function testSubmoduleWithRejectedUrl() {
        $x = new SuperProject_Submodule('flip/flop', array(
            'path' => 'libs/flop',
            'url' => 'https://github.com/danieljames/flip.git',
        ));

        Assert::same('libs/flop', $x->path);
        Assert::same('flip/flop', $x->boost_name);
        Assert::null($x->github_name);
    }

    function testcommitHashes() {
        $temp_directory = new TempDirectory();
        $repo_paths = Array(
            'super1' => "{$temp_directory->path}/super1",
            'sub1' => "{$temp_directory->path}/sub1",
            'sub2' => "{$temp_directory->path}/sub2",
        );

        foreach($repo_paths as $module_path) {
            mkdir($module_path);
            file_put_contents("{$module_path}/empty-file.txt", "{$module_path}\n");
            $repo = new RepoBase($module_path);
            $repo->command("init");
            $repo->command("config user.email testing@example.com");
            $repo->command("config user.name Testing");
            $repo->command("add .");
            $repo->command("commit -m 'Initial commit'");
        }

        // Old git doesn't let you add a submodule if you don't have an origin remote,
        // so we clone the super project, so that the clone has an origin.
        Process::run("git clone -q super1 super", $temp_directory->path);
        $repo_paths['super'] = "{$temp_directory->path}/super";
        $super_repo = new RepoBase($repo_paths['super']);
        $super_repo->command("config user.email testing@example.com");
        $super_repo->command("config user.name Testing");

        // Add submodules.
        $super_repo->command("submodule add '../sub1' libs/sub1");
        $super_repo->command("submodule add '../sub2' libs/sub2");
        $super_repo->command("commit -m 'add submodules'");

        $hashes = array();
        foreach($repo_paths as $name => $module_path) {
            $repo = new RepoBase($module_path);
            $hashes[$name] = $repo->readLines('rev-parse master')->current();
        }

        $super_project = new SuperProject(array(
            'superproject-branch' => 'master',
            'path' => "{$temp_directory->path}/working-repo",
            'submodule-branch' => 'master',
            'remote_url' => $repo_paths['super'],
        ));

        // Normally called by attemptAndPush.
        $super_project->setupCleanCheckout();

        $submodules = $super_project->getSubmodules();
        $submodules['boostorg/sub1']->updated_hash_value = $hashes['sub1'];
        $super_project->commitHashes($submodules);
        Assert::same(
            $hashes['super'],
            $super_project->readLines('rev-parse master')->current()
        );

        $submodules = $super_project->getSubmodules();
        $submodules['boostorg/sub1']->updated_hash_value = $hashes['sub2'];
        $super_project->commitHashes($submodules);
        $hash2 = $super_project->readLines('rev-parse master')->current();
        Assert::notSame(
            $hashes['super'],
            $hash2
        );

        $submodules = $super_project->getSubmodules();
        $submodules['boostorg/sub1']->updated_hash_value = $hashes['sub2'];
        $submodules['boostorg/sub2']->updated_hash_value = $hashes['sub2'];
        $super_project->commitHashes($submodules);
        Assert::same(
            $hash2,
            $super_project->readLines('rev-parse master')->current()
        );

        $submodules = $super_project->getSubmodules();
        $submodules['boostorg/sub1']->updated_hash_value = $hashes['sub2'];
        $submodules['boostorg/sub2']->updated_hash_value = $hashes['sub1'];
        $super_project->commitHashes($submodules);
        $hash3 = $super_project->readLines('rev-parse master')->current();
        Assert::notSame(
            $hash2,
            $hash3
        );
    }

    function testCommitMessages() {
        $x = new SuperProject(array(
            'path' => __DIR__,
            'superproject-branch' => 'super-branch',
            'submodule-branch' => 'sub-branch',
        ));

        Assert::same(
            'Update world from sub-branch',
            $x->getUpdateMessage(array('world')));

        Assert::same(
            'Update bash, bish, bosh from sub-branch',
            $x->getUpdateMessage(array('bish', 'bash', 'bosh')));

        Assert::same(
            "Update 7 submodules from sub-branch\n\n".
            "Update bang, bash, bish, bosh, sir, thank you, wham.\n",
            $x->getUpdateMessage(
                array('bish', 'bash', 'bosh', 'wham', 'bang',
                    'thank you', 'sir')));

        Assert::same(
            "Update 8 submodules from sub-branch\n\n".
            "Update five potatoes, four, more, one potato, seven potatoes, six\n".
            "potatoes, three potatoes, two potatoes.\n",
            $x->getUpdateMessage(
                array('one potato', 'two potatoes', 'three potatoes',
                'four', 'five potatoes', 'six potatoes', 'seven potatoes',
                'more')));

        Assert::same(
            "Update 1 submodule from sub-branch\n\n".
            "Update silly long submodule name that wouldn't really happen in the real\n".
            "world.\n",
            $x->getUpdateMessage(
                array("silly long submodule name that wouldn't really happen in the real world")));
    }
}

$test = new SuperProjectTest();
$test->run();