Increased coverage.

Signed-off-by: Alex Skrypnyk <alex@drevops.com>

Author: AlexSkrypnyk

phpunit.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.5/phpunit.xsd"
          bootstrap="vendor/autoload.php"
          cacheDirectory=".logs/.phpunit.cache"
          executionOrder="depends,defects"

src/Commands/ArtifactCommand.php

@@ -185,7 +185,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     $this->loggerInit((string) $this->getName(), $input, $output);
 
     $remote = $input->getArgument('remote');
-    if (empty($remote) || !is_string($remote)) {
+    if (!is_string($remote) || empty(trim($remote))) {
       throw new \RuntimeException('Remote argument must be a non-empty string');
     }
 
@@ -259,7 +259,9 @@ protected function doExecute(): void {
     catch (GitException $exception) {
       $result = $exception->getRunnerResult();
       if (!$result) {
+        // @codeCoverageIgnoreStart
         throw new \Exception('Unknown error occurred', $exception->getCode(), $exception);
+        // @codeCoverageIgnoreEnd
       }
 
       $error = $result->getOutputAsString();
@@ -268,13 +270,13 @@ protected function doExecute(): void {
       }
     }
     catch (\Exception $exception) {
-      // Capture message and allow to rollback.
+      // Capture message to allow showing a report.
       $error = $exception->getMessage();
     }
 
     $this->showReport(is_null($error));
 
-    if ($this->needCleanup) {
+    if ($this->needCleanup && is_null($error)) {
       $this->logger->notice('Cleaning up');
       $this->repo->resetToPreviousCommit();
       $this->repo->restoreGitignoreToCustom();
@@ -310,8 +312,8 @@ protected function resolveOptions(string $url, array $options): void {
     }
 
     $this->remoteUrl = $url;
-    $this->remoteName = self::GIT_REMOTE_NAME;
     $this->now = empty($options['now']) ? time() : (int) $options['now'];
+    $this->remoteName = sprintf('%s-%s', self::GIT_REMOTE_NAME, $this->now);
     $this->showChanges = !empty($options['show-changes']);
     $this->needCleanup = empty($options['no-cleanup']);
     $this->isDryRun = !empty($options['dry-run']);
@@ -343,7 +345,9 @@ protected function resolveOptions(string $url, array $options): void {
 
       $contents = file_get_contents($gitignore);
       if (!$contents) {
+        // @codeCoverageIgnoreStart
         throw new \Exception('Unable to load contents of ' . $gitignore);
+        // @codeCoverageIgnoreEnd
       }
 
       $this->logger->debug('-----Custom .gitignore---------');
@@ -436,11 +440,12 @@ protected function setMode(string $mode, array $options): void {
    * Check that there all requirements are met in order to to run this command.
    */
   protected function checkRequirements(): void {
-    // @todo Refactor this into more generic implementation.
     $this->logger->notice('Checking requirements');
 
     if (!$this->fsIsCommandAvailable('git')) {
+      // @codeCoverageIgnoreStart
       throw new \RuntimeException('Git command is not available');
+      // @codeCoverageIgnoreEnd
     }
 
     $this->logger->notice('All requirements were met');
@@ -472,7 +477,9 @@ protected function getTokenSafebranch(): string {
     $replacement = preg_replace('/[^a-z0-9-]/i', '-', strtolower($name));
 
     if (empty($replacement)) {
+      // @codeCoverageIgnoreStart
       throw new \Exception('Safe branch name is empty');
+      // @codeCoverageIgnoreEnd
     }
 
     return $replacement;

src/Traits/FilesystemTrait.php

@@ -58,56 +58,16 @@ protected function fsSetRootDir(?string $path = NULL): static {
    *   script was started from or current working directory.
    */
   protected function fsGetRootDir(): string {
-    if (isset($this->fsRootDir)) {
-      return $this->fsRootDir;
-    }
-
-    if (isset($_SERVER['PWD']) && is_string($_SERVER['PWD']) && !empty($_SERVER['PWD'])) {
-      return $_SERVER['PWD'];
-    }
-
-    return (string) getcwd();
-  }
-
-  /**
-   * Set current working directory.
-   *
-   * It is important to note that this should be called in pair with
-   * cwdRestore().
-   *
-   * @param string $dir
-   *   Path to the current directory.
-   *
-   * @return static
-   *   The called object.
-   */
-  protected function fsSetCwd(string $dir): static {
-    chdir($dir);
-    $this->fsOriginalCwdStack[] = $dir;
-
-    return $this;
-  }
-
-  /**
-   * Set current working directory to a previously saved path.
-   *
-   * It is important to note that this should be called in pair with cwdSet().
-   */
-  protected function fsCwdRestore(): void {
-    $dir = array_shift($this->fsOriginalCwdStack);
-    if ($dir) {
-      chdir($dir);
+    if (!isset($this->fsRootDir)) {
+      if (isset($_SERVER['PWD']) && is_string($_SERVER['PWD']) && !empty($_SERVER['PWD'])) {
+        $this->fsRootDir = $_SERVER['PWD'];
+      }
+      else {
+        $this->fsRootDir = (string) getcwd();
+      }
     }
-  }
 
-  /**
-   * Get current working directory.
-   *
-   * @return string
-   *   Full path of current working directory.
-   */
-  protected function fsCwdGet(): string {
-    return (string) getcwd();
+    return $this->fsRootDir;
   }
 
   /**
@@ -139,14 +99,14 @@ protected function fsIsCommandAvailable(string $command): bool {
    */
   protected function fsGetAbsolutePath(string $file, ?string $root = NULL): string {
     if ($this->fs->isAbsolutePath($file)) {
-      return $this->fsRealpath($file);
+      return static::fsRealpath($file);
     }
 
     $root = $root ? $root : $this->fsGetRootDir();
-    $root = $this->fsRealpath($root);
+    $root = static::fsRealpath($root);
     $file = $root . DIRECTORY_SEPARATOR . $file;
 
-    return $this->fsRealpath($file);
+    return static::fsRealpath($file);
   }
 
   /**
@@ -192,16 +152,16 @@ protected function fsAssertPathsExist($paths, bool $strict = TRUE): bool {
    *
    * @see https://stackoverflow.com/a/29372360/712666
    */
-  protected function fsRealpath(string $path): string {
+  protected static function fsRealpath(string $path): string {
     // Whether $path is unix or not.
-    $unipath = $path === '' || $path[0] !== '/';
+    $is_unix_path = $path === '' || $path[0] !== '/';
     $unc = str_starts_with($path, '\\\\');
 
     // Attempt to detect if path is relative in which case, add cwd.
-    if (!str_contains($path, ':') && $unipath && !$unc) {
+    if (!str_contains($path, ':') && $is_unix_path && !$unc) {
       $path = getcwd() . DIRECTORY_SEPARATOR . $path;
       if ($path[0] === '/') {
-        $unipath = FALSE;
+        $is_unix_path = FALSE;
       }
     }
 
@@ -225,21 +185,21 @@ protected function fsRealpath(string $path): string {
     }
 
     $path = implode(DIRECTORY_SEPARATOR, $absolutes);
+    // Put initial separator that could have been lost.
+    $path = $is_unix_path ? $path : '/' . $path;
+    $path = $unc ? '\\\\' . $path : $path;
 
     // Resolve any symlinks.
-    if (function_exists('readlink') && file_exists($path) && linkinfo($path) > 0) {
+    if (function_exists('readlink') && file_exists($path) && is_link($path) > 0) {
       $path = readlink($path);
 
       if (!$path) {
+        // @codeCoverageIgnoreStart
         throw new \Exception(sprintf('Could not resolve symlink for path: %s', $path));
+        // @codeCoverageIgnoreEnd
       }
     }
 
-    // Put initial separator that could have been lost.
-    $path = $unipath ? $path : '/' . $path;
-
-    $path = $unc ? '\\\\' . $path : $path;
-
     if (str_starts_with($path, sys_get_temp_dir())) {
       $tmp_realpath = realpath(sys_get_temp_dir());
       if ($tmp_realpath) {

tests/Functional/BranchModeTest.php

@@ -79,17 +79,15 @@ public function testCleanupAfterSuccess(): void {
   }
 
   public function testCleanupAfterFailure(): void {
-    $this->gitCreateFixtureCommits(2);
-
-    $this->assertArtifactCommandSuccess();
-    $this->gitAssertFixtureCommits(2, $this->dst, 'testbranch', ['Deployment commit']);
+    $this->gitCreateFixtureCommits(1);
 
-    $this->gitCreateFixtureCommits(3, 2);
-    // Trigger erroneous build by pushing to the same branch.
-    $this->assertArtifactCommandFailure();
+    $output = $this->assertArtifactCommandFailure([
+      '--mode' => ArtifactCommand::MODE_BRANCH,
+      '--branch' => '*invalid',
+    ]);
 
-    $this->gitAssertCurrentBranch($this->src, $this->currentBranch);
-    $this->gitAssertRemoteNotExists($this->src, $this->remoteName);
+    $this->assertStringContainsString('Incorrect value "*invalid" specified for git remote branch', $output);
+    $this->gitAssertCurrentBranch($this->src, $this->gitGetGlobalDefaultBranch());
   }
 
   public function testGitignore(): void {

tests/Functional/ForcePushModeTest.php

@@ -106,8 +106,7 @@ public function testCleanupAfterFailure(): void {
     $output = $this->assertArtifactCommandFailure(['--branch' => '*invalid']);
 
     $this->assertStringContainsString('Incorrect value "*invalid" specified for git remote branch', $output);
-    $this->gitAssertCurrentBranch($this->src, $this->currentBranch);
-    $this->gitAssertRemoteNotExists($this->src, $this->remoteName);
+    $this->gitAssertCurrentBranch($this->src, $this->gitGetGlobalDefaultBranch());
   }
 
   public function testGitignore(): void {

tests/Functional/FunctionalTestBase.php

@@ -21,17 +21,13 @@ abstract class FunctionalTestBase extends UnitTestBase {
 
   /**
    * Fixture source repository directory.
-   *
-   * @var string
    */
-  protected $src;
+  protected string $src;
 
   /**
    * Fixture remote repository directory.
-   *
-   * @var string
    */
-  protected $dst;
+  protected string $dst;
 
   /**
    * Remote name.
@@ -92,7 +88,7 @@ protected function setUp(): void {
    * {@inheritdoc}
    */
   protected function tearDown(): void {
-    if ($this->fs->exists($this->fixtureDir)) {
+    if ($this->fixtureDir && $this->fs->exists($this->fixtureDir)) {
       $this->fs->remove($this->fixtureDir);
     }
   }
@@ -168,15 +164,18 @@ protected function runArtifactCommand(?array $args = [], bool $expect_fail = FAL
       $input = [
         '--root' => $this->fixtureDir,
         '--now' => $this->now,
-        '--src' => $this->src,
         'remote' => $this->dst,
       ];
 
-      if ($this->mode) {
+      if (!empty($this->src)) {
+        $input['--src'] = $this->src;
+      }
+
+      if (!empty($this->mode)) {
         $input['--mode'] = $this->mode;
       }
 
-      $input += $args;
+      $input = $args + $input;
     }
 
     return $this->consoleApplicationRun($input, [], $expect_fail);

tests/Functional/GeneralTest.php

@@ -61,6 +61,39 @@ public function testShowChanges(): void {
     $this->assertFilesNotExist($this->dst, 'f1');
   }
 
+  public function testSrcDefault(): void {
+    $this->gitCreateFixtureCommits(1);
+
+    $old_fixture_dir = $this->fixtureDir;
+    $this->fixtureDir = $this->src;
+
+    $this->src = '';
+
+    $output = $this->runArtifactCommand(['--dry-run' => TRUE]);
+
+    $this->assertStringContainsString('Source repository:     ' . $this->fixtureDir, $output);
+
+    $this->assertStringContainsString('Cowardly refusing to push to remote. Use without --dry-run to perform an actual push.', $output);
+
+    $this->fixtureDir = $old_fixture_dir;
+  }
+
+  public function testModeInvalid(): void {
+    $this->gitCreateFixtureCommits(1);
+
+    $output = $this->assertArtifactCommandFailure(['--mode' => 'invalid']);
+
+    $this->assertStringContainsString('Invalid mode provided. Allowed modes are: force-push, branch', $output);
+  }
+
+  public function testRemoteInvalid(): void {
+    $this->gitCreateFixtureCommits(1);
+
+    $output = $this->assertArtifactCommandFailure(['remote' => 'git://user/repo']);
+
+    $this->assertStringContainsString('Invalid remote URL provided: git://user/repo', $output);
+  }
+
   public function testNoCleanup(): void {
     $this->gitCreateFixtureCommits(1);