fspringveldt / silverstripe-porter

tests/PHP/CreateModuleCommandTest.php

<?php

namespace SilverStripe\Porter\Tests;

use PHPUnit\Framework\TestCase;
use SilverStripe\Assets\Filesystem;
use SilverStripe\Porter\Commands\CreateModuleCommand;
use Symfony\Component\Console\Tester\CommandTester;
use Symfony\Component\Yaml\Exception\RuntimeException;

/**
 * Class CreateModuleCommandTest
 */
class CreateModuleCommandTest extends TestCase
{
    protected static $fixture_file = '';

    /**
     * @var CreateModuleCommand
     */
    private $command;

    protected function setUp()
    {
        parent::setUp();
        $this->command = new CreateModuleCommand();
    }

    public function testCommandIsConfiguredCorrectly()
    {
        $this->assertEquals('create-module', $this->command->getName());
        $this->assertContains(
            'Sets up a new SilverStripe module skeleton at',
            $this->command->getDescription()
        );
        $def = $this->command->getDefinition();
        $this->assertTrue($def->hasArgument(CreateModuleCommand::ARGUMENTS_MODULE_NAME));
        $this->assertTrue($def->hasArgument(CreateModuleCommand::ARGUMENTS_MODULE_NAMESPACE));
        $this->assertTrue($def->hasOption(CreateModuleCommand::OPTIONS_NON_VENDOR));
        $this->assertTrue($def->hasOption(CreateModuleCommand::OPTIONS_SS3));
        $this->assertTrue($def->hasOption(CreateModuleCommand::OPTIONS_TRAVIS_CI));
        $this->assertTrue($def->hasOption(CreateModuleCommand::OPTIONS_CIRCLE_CI));
    }

    /**
     * @expectedException RuntimeException
     * @expectedExceptionMessage Invalid module name given. Use the format module/name
     */
    public function testInvalidModuleNmeThrowsException()

This method seems to be duplicated in your project.

    {
        $tester = new CommandTester($this->command);
        $input = [
            'module-name' => 'foo',
            'module-namespace' => 'Foo'
        ];
        $tester->execute($input);
    }

    /**
     * @expectedException RuntimeException
     * @expectedExceptionMessage It seems your namespace is formed incorrectly.
     */
    public function testInvalidNameSpaceThrowsException()

This method seems to be duplicated in your project.

    {
        $tester = new CommandTester($this->command);
        $input = [
            'module-name' => 'foo/bar',
            'module-namespace' => 'Foo'
        ];
        $tester->execute($input);
    }

    /**
     *
     */
    public function testComposerVariablesGetsSet()
    {
        $tester = new CommandTester($this->command);
        $input = [
            'module-name' => 'foo/bar',
            'module-namespace' => 'Foo\\\\Bar'
        ];
        $tester->execute($input);
        $composerContents = $this->command->getComposerFileContents();
        $this->assertNotContains('$moduleName', $composerContents);
        $this->assertNotContains('$namespace', $composerContents);
        $this->assertNotContains('$moduleType', $composerContents);
        $this->deleteDirectory($this->command->getTargetPath());
    }

    public function testCopySkeleton()
    {
        $tester = new CommandTester($this->command);
        $input = [
            'module-name' => 'foo/bar',
            'module-namespace' => 'Foo\\\\bar',
            '--withCircleCI' => true
        ];
        $tester->execute($input);

        $targetPath = $this->command->getTargetPath();
        $sourceComposer = file_get_contents(
            $this->command->getSourcePath() .
            DIRECTORY_SEPARATOR . 'composer.json'
        );
        $this->assertTrue(is_dir($targetPath));
        $this->assertTrue(
            is_dir(
                $targetPath . DIRECTORY_SEPARATOR . '.circleci'
            )
        );
        $this->assertNotEquals(
            $sourceComposer,
            $this->command->getComposerFileContents()
        );
        $this->deleteDirectory($this->command->getTargetPath());
    }

    public function testPreCopyOptions()
    {
        $tester = new CommandTester($this->command);
        $input = [
            'module-name' => 'foo/bar',
            'module-namespace' => 'Foo\\\\Bar',
        ];
        $tester->execute($input);
        $this->assertContains(
            'silverstripe-vendormodule',
            $this->command->getComposerFileContents()
        );
        $this->deleteDirectory($this->command->getTargetPath());

        $input['--nonVendor'] = true;
        $tester->execute($input);
        $this->assertContains(
            'silverstripe-module',
            $this->command->getComposerFileContents()
        );
        $this->deleteDirectory($this->command->getTargetPath());
        $input['--ss3'] = true;
        $tester->execute($input);
        $this->assertContains(
            '3.6',
            $this->command->getComposerFileContents()
        );
        $this->assertFileExists(
            $this->command->getTargetPath() .
            DIRECTORY_SEPARATOR . '_config.php'
        );
        $this->deleteDirectory($this->command->getTargetPath());
    }

    public function testPostCopyOptions()
    {
        $tester = new CommandTester($this->command);
        $input = [
            'module-name' => 'foo/bar',
            'module-namespace' => 'Foo\\\\Bar',
        ];
        $tester->execute($input);
        $this->assertFileNotExists(
            $this->command->getTargetPath() .
            DIRECTORY_SEPARATOR . '.travis.yml'
        );
        $this->assertDirectoryNotExists(
            $this->command->getTargetPath() .
            DIRECTORY_SEPARATOR . '.circleci'
        );
        $this->deleteDirectory($this->command->getTargetPath());

        $input['--withTravisCI'] = true;
        $tester->execute($input);
        $this->assertFileExists(
            $this->command->getTargetPath() .
            DIRECTORY_SEPARATOR . '.travis.yml'
        );
        $this->deleteDirectory($this->command->getTargetPath());
        $input['--withCircleCI'] = true;
        $tester->execute($input);
        $this->assertDirectoryExists(
            $this->command->getTargetPath() .
            DIRECTORY_SEPARATOR . '.circleci'
        );
        $this->deleteDirectory($this->command->getTargetPath());
    }

    /**
     * Recursively deletes a directory
     * @param $dir
     * @return bool
     */
    private function deleteDirectory($dir)

The parameter $dir is not used and could be removed.

    {
        $this->command->getFilesystem()->remove($this->command->getTargetPath());
    }
}