AddPluginCommand should not use master branch by default.

As default branch could be anything, don't explicity set master if
--branch param is omitted.

Also improves tests.

Fixes #58

Author: kabalin

docs/CHANGELOG.md

@@ -17,6 +17,9 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt
   [gha.dist.yml](https://github.com/moodlehq/moodle-plugin-ci/blob/master/gha.dist.yml)
   and add missing `NVM_DIR` line your plugin's GHA workflow file.
 
+### Changed
+- `moodle-plugin-ci add-plugin` command now uses default banch to checkout
+  instead of `master` if `--branch` param is not specified..
 
 ## [3.0.4] - 2021-01-29
 ### Fixed

docs/CLI.md

@@ -135,7 +135,7 @@ Queue up an additional plugin to be installed in the test site
 
 #### `project`
 
-GitHub project, EG: moodlehq/moodle-local_hub
+GitHub project, EG: moodlehq/moodle-local_hub, can't be used with --clone option
 
 * Is required: no
 * Is array: no
@@ -145,16 +145,16 @@ GitHub project, EG: moodlehq/moodle-local_hub
 
 #### `--branch|-b`
 
-The branch to checkout within the plugin
+The branch to checkout in plugin repo (if non-default)
 
 * Accept value: yes
 * Is value required: yes
 * Is multiple: no
-* Default: `'master'`
+* Default: `NULL`
 
 #### `--clone|-c`
 
-Git clone URL
+Git clone URL, can't be used with --project option
 
 * Accept value: yes
 * Is value required: yes

src/Command/AddPluginCommand.php

@@ -47,9 +47,9 @@ protected function configure()
     {
         $this->setName('add-plugin')
             ->setDescription('Queue up an additional plugin to be installed in the test site')
-            ->addArgument('project', InputArgument::OPTIONAL, 'GitHub project, EG: moodlehq/moodle-local_hub')
-            ->addOption('branch', 'b', InputOption::VALUE_REQUIRED, 'The branch to checkout within the plugin', 'master')
-            ->addOption('clone', 'c', InputOption::VALUE_REQUIRED, 'Git clone URL')
+            ->addArgument('project', InputArgument::OPTIONAL, 'GitHub project, EG: moodlehq/moodle-local_hub, can\'t be used with --clone option')
+            ->addOption('branch', 'b', InputOption::VALUE_REQUIRED, 'The branch to checkout in plugin repo (if non-default)', null)
+            ->addOption('clone', 'c', InputOption::VALUE_REQUIRED, 'Git clone URL, can\'t be used with --project option')
             ->addOption('storage', null, InputOption::VALUE_REQUIRED, 'Plugin storage directory', 'moodle-plugin-ci-plugins');
     }
 
@@ -82,8 +82,9 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $filesystem->mkdir($storage);
         $storageDir = realpath($validate->directory($storage));
 
+        $branch   = $branch !== null ? '--branch '.$branch : '';
         /** @psalm-suppress PossiblyInvalidArgument */
-        $cloneUrl = sprintf('git clone --depth 1 --branch %s %s', $branch, $cloneUrl);
+        $cloneUrl = sprintf('git clone --depth 1 %s %s', $branch, $cloneUrl);
         $process  = new Process($cloneUrl, $storageDir);
         $this->execute->mustRun($process);
 

src/Command/ExecuteTrait.php

@@ -34,6 +34,12 @@ trait ExecuteTrait
      */
     protected function initializeExecute(OutputInterface $output, ProcessHelper $helper)
     {
-        $this->execute = $this->execute ?: new Execute($output, $helper);
+        if (isset($this->execute)) {
+            // Define output and process helper.
+            $this->execute->setOutput($output);
+            $this->execute->setHelper($helper);
+        } else {
+            $this->execute = new Execute($output, $helper);
+        }
     }
 }

src/Process/Execute.php

@@ -12,7 +12,10 @@
 
 namespace MoodlePluginCI\Process;
 
+use Symfony\Component\Console\Helper\DebugFormatterHelper;
+use Symfony\Component\Console\Helper\HelperSet;
 use Symfony\Component\Console\Helper\ProcessHelper;
+use Symfony\Component\Console\Output\NullOutput;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Process\Exception\ProcessFailedException;
 use Symfony\Component\Process\Process;
@@ -25,12 +28,12 @@ class Execute
     /**
      * @var OutputInterface
      */
-    private $output;
+    protected $output;
 
     /**
      * @var ProcessHelper
      */
-    private $helper;
+    protected $helper;
 
     /**
      * Sleep for .2 seconds to avoid race conditions in Moodle scripts when running them in parallel.
@@ -41,9 +44,34 @@ class Execute
      */
     public $parallelWaitTime = 200000;
 
-    public function __construct(OutputInterface $output, ProcessHelper $helper)
+    public function __construct(?OutputInterface $output = null, ?ProcessHelper $helper = null)
     {
-        $this->output = $output;
+        $this->setOutput($output);
+        $this->setHelper($helper);
+    }
+
+    /**
+     * Output setter.
+     *
+     * @param OutputInterface|null $output
+     */
+    public function setOutput(?OutputInterface $output)
+    {
+        $this->output = $output ?? new NullOutput();
+    }
+
+    /**
+     * Process helper setter.
+     *
+     * @param OutputInterface|null $output
+     */
+    public function setHelper(?ProcessHelper $helper)
+    {
+        if (empty($helper)) {
+            $helper = new ProcessHelper();
+            // Looks like $helper->run is not possible without DebugFormatterHelper.
+            $helper->setHelperSet(new HelperSet([new DebugFormatterHelper()]));
+        }
         $this->helper = $helper;
     }
 

tests/Command/AddPluginCommandTest.php

@@ -16,6 +16,7 @@
 use MoodlePluginCI\Tests\Fake\Process\DummyExecute;
 use MoodlePluginCI\Tests\FilesystemTestCase;
 use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Tester\CommandTester;
 
 class AddPluginCommandTest extends FilesystemTestCase
@@ -51,12 +52,36 @@ public function testExecute()
     public function testExecuteWithClone()
     {
         $commandTester = $this->getCommandTester();
+        // Execute with verbosity, so process helper outputs command line.
         $commandTester->execute([
             '--clone'   => 'https://github.com/user/moodle-mod_foo.git',
             '--storage' => $this->tempDir.'/plugins',
-        ]);
+        ], ['verbosity' => OutputInterface::VERBOSITY_VERY_VERBOSE]);
+
+        $this->assertSame(0, $commandTester->getStatusCode());
+        $this->assertContains('git clone --depth 1  https://github.com/user/moodle-mod_foo.git',
+            $commandTester->getDisplay());
+        $this->assertTrue(is_dir($this->tempDir.'/plugins'));
+        $this->assertFileExists($this->tempDir.'/.env');
+        $this->assertSame(
+            sprintf("EXTRA_PLUGINS_DIR=%s/plugins\n", realpath($this->tempDir)),
+            file_get_contents($this->tempDir.'/.env')
+        );
+    }
+
+    public function testExecuteWithCloneAndBranch()
+    {
+        $commandTester = $this->getCommandTester();
+        // Execute with verbosity, so process helper outputs command line.
+        $commandTester->execute([
+            '--clone'   => 'https://github.com/user/moodle-mod_foo.git',
+            '--branch'  => 'dev',
+            '--storage' => $this->tempDir.'/plugins',
+        ], ['verbosity' => OutputInterface::VERBOSITY_VERY_VERBOSE]);
 
         $this->assertSame(0, $commandTester->getStatusCode());
+        $this->assertContains('git clone --depth 1 --branch dev https://github.com/user/moodle-mod_foo.git',
+            $commandTester->getDisplay());
         $this->assertTrue(is_dir($this->tempDir.'/plugins'));
         $this->assertFileExists($this->tempDir.'/.env');
         $this->assertSame(

tests/Fake/Process/DummyExecute.php

@@ -17,20 +17,26 @@
 
 class DummyExecute extends Execute
 {
-    /** @noinspection PhpMissingParentConstructorInspection */
-    public function __construct()
-    {
-        // Do nothing.
-    }
-
     public function run($cmd, $error = null)
     {
-        return new DummyProcess('dummy');
+        if ($cmd instanceof Process) {
+            // Get the command line from process.
+            $cmd = $cmd->getCommandLine();
+        }
+        $cmd = new DummyProcess($cmd);
+
+        return $this->helper->run($this->output, $cmd, $error);
     }
 
     public function mustRun($cmd, $error = null)
     {
-        return new DummyProcess('dummy');
+        if ($cmd instanceof Process) {
+            // Get the command line from process.
+            $cmd = $cmd->getCommandLine();
+        }
+        $cmd = new DummyProcess($cmd);
+
+        return $this->helper->mustRun($this->output, $cmd, $error);
     }
 
     public function runAll($processes)

tests/Fake/Process/DummyProcess.php

@@ -16,6 +16,18 @@
 
 class DummyProcess extends Process
 {
+    private $realcommandline;
+
+    public function __construct($commandline)
+    {
+        $this->realcommandline = $commandline;
+    }
+
+    public function getCommandLine()
+    {
+        return $this->realcommandline;
+    }
+
     public function getOutput()
     {
         return '';

tests/Process/ExecuteTest.php

@@ -14,11 +14,7 @@
 
 use MoodlePluginCI\Process\Execute;
 use MoodlePluginCI\Process\MoodleProcess;
-use Symfony\Component\Console\Helper\DebugFormatterHelper;
-use Symfony\Component\Console\Helper\HelperSet;
-use Symfony\Component\Console\Helper\ProcessHelper;
 use Symfony\Component\Console\Output\BufferedOutput;
-use Symfony\Component\Console\Output\NullOutput;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Process\Exception\ProcessFailedException;
 use Symfony\Component\Process\Process;
@@ -34,10 +30,7 @@ protected function setUp()
 
     public function testSetNodeEnv()
     {
-        $helper = new ProcessHelper();
-        $helper->setHelperSet(new HelperSet([new DebugFormatterHelper()]));
-
-        $execute = new Execute(new NullOutput(), $helper);
+        $execute = new Execute();
         $pathenv = getenv('PATH');
 
         // RUNTIME_NVM_BIN in undefined.
@@ -69,10 +62,7 @@ public function testSetNodeEnv()
 
     public function testRun()
     {
-        $helper = new ProcessHelper();
-        $helper->setHelperSet(new HelperSet([new DebugFormatterHelper()]));
-
-        $execute = new Execute(new NullOutput(), $helper);
+        $execute = new Execute();
         $process = $execute->run('env');
 
         $this->assertInstanceOf('Symfony\Component\Process\Process', $process);
@@ -83,10 +73,7 @@ public function testRun()
 
     public function testMustRun()
     {
-        $helper = new ProcessHelper();
-        $helper->setHelperSet(new HelperSet([new DebugFormatterHelper()]));
-
-        $execute = new Execute(new NullOutput(), $helper);
+        $execute = new Execute();
         $process = $execute->mustRun('env');
 
         $this->assertInstanceOf('Symfony\Component\Process\Process', $process);
@@ -97,17 +84,14 @@ public function testMustRun()
 
     public function testRunAllVerbose()
     {
-        $helper = new ProcessHelper();
-        $helper->setHelperSet(new HelperSet([new DebugFormatterHelper()]));
-
         /** @var Process[] $processes */
         $processes = [
             new Process('env'),
             new Process('env'),
         ];
 
         $output  = new BufferedOutput(OutputInterface::VERBOSITY_VERY_VERBOSE);
-        $execute = new Execute($output, $helper);
+        $execute = new Execute($output);
         $execute->runAll($processes);
 
         foreach ($processes as $process) {
@@ -120,17 +104,14 @@ public function testRunAllVerbose()
 
     public function testMustRunAll()
     {
-        $helper = new ProcessHelper();
-        $helper->setHelperSet(new HelperSet([new DebugFormatterHelper()]));
-
         /** @var Process[] $processes */
         $processes = [
             new Process('env'),
             new MoodleProcess('-r "echo \'PATH=\'.getenv(\'PATH\');"'),
             new Process('env'),
         ];
 
-        $execute = new Execute(new NullOutput(), $helper);
+        $execute = new Execute();
 
         $execute->parallelWaitTime = 1;
         $execute->mustRunAll($processes);
@@ -146,26 +127,22 @@ public function testMustRunAllFail()
     {
         $this->expectException(ProcessFailedException::class);
 
-        $helper = new ProcessHelper();
-        $helper->setHelperSet(new HelperSet([new DebugFormatterHelper()]));
-
         /** @var Process[] $processes */
         $processes = [
             new Process('php -r "echo 42;"'),
             new Process('php -r "syntax error"'),
             new Process('php -r "echo 42;"'),
         ];
 
-        $execute = new Execute(new NullOutput(), $helper);
-
+        $execute                   = new Execute();
         $execute->parallelWaitTime = 1;
         $execute->mustRunAll($processes);
     }
 
     public function testPassThrough()
     {
         $output  = new BufferedOutput(OutputInterface::VERBOSITY_VERY_VERBOSE);
-        $execute = new Execute($output, new ProcessHelper());
+        $execute = new Execute($output);
         $process = $execute->passThrough('php -r "echo 42;"');
 
         $this->assertInstanceOf('Symfony\Component\Process\Process', $process);