Add decorated output test

IonBazan · May 11, 2022 · 41537c3 · 41537c3
1 parent 1b05bac
commit 41537c3
Show file tree

Hide file tree

Showing 6 changed files with 184 additions and 22 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -54,6 +54,8 @@ jobs:
           restore-keys: ${{ runner.os }}-composer-
       - name: Install Composer dependencies
         run: composer update -n --prefer-dist ${{ matrix.composer-flags }}
+      - name: Set default branch for tests
+        run: git config --global init.defaultBranch main
       - name: Run Tests
         run: vendor/bin/simple-phpunit --coverage-clover coverage.xml --coverage-text
       - name: Upload coverage to Codecov

diff --git a/tests/Formatter/FormatterTest.php b/tests/Formatter/FormatterTest.php
@@ -3,6 +3,7 @@
 namespace IonBazan\ComposerDiff\Tests\Formatter;
 
 use Composer\DependencyResolver\Operation\InstallOperation;
+use Composer\DependencyResolver\Operation\OperationInterface;
 use Composer\DependencyResolver\Operation\UninstallOperation;
 use Composer\DependencyResolver\Operation\UpdateOperation;
 use Composer\Package\PackageInterface;
@@ -43,29 +44,22 @@ public function testGetProjectUrlReturnsNullForInvalidOperation()
 
     /**
      * @param bool $withUrls
+     * @param bool $decorated
      *
      * @testWith   [false]
      *             [true]
+     *             [false, true]
+     *             [true, true]
      */
-    public function testItRendersTheListOfOperations($withUrls)
+    public function testItRendersTheListOfOperations($withUrls, $decorated = false)
     {
-        $output = new StreamOutput(fopen('php://memory', 'wb', false));
-        $formatter = $this->getFormatter($output, $this->getGenerators());
-        $prodPackages = array(
-            new InstallOperation($this->getPackage('a/package-1', '1.0.0')),
-            new InstallOperation($this->getPackage('a/no-link-1', '1.0.0')),
-            new UpdateOperation($this->getPackage('a/package-2', '1.0.0'), $this->getPackage('a/package-2', '1.2.0')),
-            new UpdateOperation($this->getPackage('a/package-3', '2.0.0'), $this->getPackage('a/package-3', '1.1.1')),
-            new UpdateOperation($this->getPackage('a/no-link-2', '2.0.0'), $this->getPackage('a/no-link-2', '1.1.1')),
-            new UpdateOperation($this->getPackage('php', '>=7.4.6'), $this->getPackage('php', '^8.0')),
+        $output = new StreamOutput(fopen('php://memory', 'wb', false), OutputInterface::VERBOSITY_NORMAL, $decorated);
+        $this->getFormatter($output, $this->getGenerators())->render(
+            $this->getEntries($this->getSampleProdOperations()),
+            $this->getEntries($this->getSampleDevOperations()),
+            $withUrls
         );
-        $devPackages = array(
-            new UpdateOperation($this->getPackage('a/package-5', 'dev-master', 'dev-master 1234567'), $this->getPackage('a/package-5', '1.1.1')),
-            new UninstallOperation($this->getPackage('a/package-4', '0.1.1')),
-            new UninstallOperation($this->getPackage('a/no-link-2', '0.1.1')),
-        );
-        $formatter->render($this->getEntries($prodPackages), $this->getEntries($devPackages), $withUrls);
-        $this->assertSame($this->getSampleOutput($withUrls), $this->getDisplay($output));
+        $this->assertSame($this->getSampleOutput($withUrls, $decorated), $this->getDisplay($output));
     }
 
     public function testItFailsWithInvalidOperation()
@@ -84,10 +78,11 @@ abstract protected function getFormatter(OutputInterface $output, GeneratorConta
 
     /**
      * @param bool $withUrls
+     * @param bool $decorated
      *
      * @return string
      */
-    abstract protected function getSampleOutput($withUrls);
+    abstract protected function getSampleOutput($withUrls, $decorated);
 
     /**
      * @return string
@@ -107,6 +102,14 @@ protected function getDisplay(OutputInterface $output)
         return stream_get_contents($output->getStream());
     }
 
+    /**
+     * @return bool
+     */
+    protected function supportsLinks()
+    {
+        return method_exists('Symfony\Component\Console\Formatter\OutputFormatterStyle', 'setHref');
+    }
+
     /**
      * @return MockObject|GeneratorContainer
      */
@@ -138,4 +141,31 @@ protected function getGenerators()
 
         return $generators;
     }
+
+    /**
+     * @return OperationInterface[]
+     */
+    private function getSampleProdOperations()
+    {
+        return array(
+            new InstallOperation($this->getPackage('a/package-1', '1.0.0')),
+            new InstallOperation($this->getPackage('a/no-link-1', '1.0.0')),
+            new UpdateOperation($this->getPackage('a/package-2', '1.0.0'), $this->getPackage('a/package-2', '1.2.0')),
+            new UpdateOperation($this->getPackage('a/package-3', '2.0.0'), $this->getPackage('a/package-3', '1.1.1')),
+            new UpdateOperation($this->getPackage('a/no-link-2', '2.0.0'), $this->getPackage('a/no-link-2', '1.1.1')),
+            new UpdateOperation($this->getPackage('php', '>=7.4.6'), $this->getPackage('php', '^8.0')),
+        );
+    }
+
+    /**
+     * @return OperationInterface[]
+     */
+    private function getSampleDevOperations()
+    {
+        return array(
+            new UpdateOperation($this->getPackage('a/package-5', 'dev-master', 'dev-master 1234567'), $this->getPackage('a/package-5', '1.1.1')),
+            new UninstallOperation($this->getPackage('a/package-4', '0.1.1')),
+            new UninstallOperation($this->getPackage('a/no-link-2', '0.1.1')),
+        );
+    }
 }
diff --git a/tests/Formatter/GitHubFormatterTest.php b/tests/Formatter/GitHubFormatterTest.php
@@ -8,7 +8,7 @@
 
 class GitHubFormatterTest extends FormatterTest
 {
-    protected function getSampleOutput($withUrls)
+    protected function getSampleOutput($withUrls, $decorated)
     {
         if ($withUrls) {
             return <<<OUTPUT

diff --git a/tests/Formatter/JsonFormatterTest.php b/tests/Formatter/JsonFormatterTest.php
@@ -88,7 +88,7 @@ public function testRenderSingle()
         )), $this->getDisplay($output));
     }
 
-    protected function getSampleOutput($withUrls)
+    protected function getSampleOutput($withUrls, $decorated)
     {
         if ($withUrls) {
             return self::formatOutput(array(

diff --git a/tests/Formatter/MarkdownListFormatterTest.php b/tests/Formatter/MarkdownListFormatterTest.php
@@ -8,9 +8,32 @@
 
 class MarkdownListFormatterTest extends FormatterTest
 {
-    protected function getSampleOutput($withUrls)
+    protected function getSampleOutput($withUrls, $decorated)
     {
         if ($withUrls) {
+            if ($decorated) {
+                return <<<OUTPUT
+Prod Packages
+=============
+
+ - Install [32m[a/package-1](https://example.com/r/a/package-1)[39m ([33m1.0.0[39m) [Compare](https://example.com/r/1.0.0)
+ - Install [32ma/no-link-1[39m ([33m1.0.0[39m) 
+ - Upgrade [32m[a/package-2](https://example.com/r/a/package-2)[39m ([33m1.0.0[39m => [33m1.2.0[39m) [Compare](https://example.com/c/1.0.0..1.2.0)
+ - Downgrade [32m[a/package-3](https://example.com/r/a/package-3)[39m ([33m2.0.0[39m => [33m1.1.1[39m) [Compare](https://example.com/c/2.0.0..1.1.1)
+ - Downgrade [32ma/no-link-2[39m ([33m2.0.0[39m => [33m1.1.1[39m) 
+ - Change [32mphp[39m ([33m>=7.4.6[39m => [33m^8.0[39m) 
+
+Dev Packages
+============
+
+ - Change [32m[a/package-5](https://example.com/r/a/package-5)[39m ([33mdev-master 1234567[39m => [33m1.1.1[39m) [Compare](https://example.com/c/dev-master..1.1.1)
+ - Uninstall [32m[a/package-4](https://example.com/r/a/package-4)[39m ([33m0.1.1[39m) [Compare](https://example.com/r/0.1.1)
+ - Uninstall [32ma/no-link-2[39m ([33m0.1.1[39m) 
+
+
+OUTPUT;
+            }
+
             return <<<OUTPUT
 Prod Packages
 =============
@@ -30,6 +53,29 @@ protected function getSampleOutput($withUrls)
  - Uninstall a/no-link-2 (0.1.1) 
 
 
+OUTPUT;
+        }
+
+        if ($decorated) {
+            return <<<OUTPUT
+Prod Packages
+=============
+
+ - Install [32ma/package-1[39m ([33m1.0.0[39m)
+ - Install [32ma/no-link-1[39m ([33m1.0.0[39m)
+ - Upgrade [32ma/package-2[39m ([33m1.0.0[39m => [33m1.2.0[39m)
+ - Downgrade [32ma/package-3[39m ([33m2.0.0[39m => [33m1.1.1[39m)
+ - Downgrade [32ma/no-link-2[39m ([33m2.0.0[39m => [33m1.1.1[39m)
+ - Change [32mphp[39m ([33m>=7.4.6[39m => [33m^8.0[39m)
+
+Dev Packages
+============
+
+ - Change [32ma/package-5[39m ([33mdev-master 1234567[39m => [33m1.1.1[39m)
+ - Uninstall [32ma/package-4[39m ([33m0.1.1[39m)
+ - Uninstall [32ma/no-link-2[39m ([33m0.1.1[39m)
+
+
 OUTPUT;
         }
 

diff --git a/tests/Formatter/MarkdownTableFormatterTest.php b/tests/Formatter/MarkdownTableFormatterTest.php
@@ -8,9 +8,51 @@
 
 class MarkdownTableFormatterTest extends FormatterTest
 {
-    protected function getSampleOutput($withUrls)
+    protected function getSampleOutput($withUrls, $decorated)
     {
         if ($withUrls) {
+            if ($decorated) {
+                if ($this->supportsLinks()) {
+                    return <<<OUTPUT
+| Prod Packages                                    | Operation  | Base    | Target | Link                                          |
+|--------------------------------------------------|------------|---------|--------|-----------------------------------------------|
+| []8;;https://example.com/r/a/package-1\\a/package-1]8;;\\](https://example.com/r/a/package-1) | [32mNew[39m        | -       | 1.0.0  | [Compare](https://example.com/r/1.0.0)        |
+| a/no-link-1                                      | [32mNew[39m        | -       | 1.0.0  |                                               |
+| []8;;https://example.com/r/a/package-2\\a/package-2]8;;\\](https://example.com/r/a/package-2) | [36mUpgraded[39m   | 1.0.0   | 1.2.0  | [Compare](https://example.com/c/1.0.0..1.2.0) |
+| []8;;https://example.com/r/a/package-3\\a/package-3]8;;\\](https://example.com/r/a/package-3) | [33mDowngraded[39m | 2.0.0   | 1.1.1  | [Compare](https://example.com/c/2.0.0..1.1.1) |
+| a/no-link-2                                      | [33mDowngraded[39m | 2.0.0   | 1.1.1  |                                               |
+| php                                              | [35mChanged[39m    | >=7.4.6 | ^8.0   |                                               |
+
+| Dev Packages                                     | Operation | Base               | Target | Link                                               |
+|--------------------------------------------------|-----------|--------------------|--------|----------------------------------------------------|
+| []8;;https://example.com/r/a/package-5\\a/package-5]8;;\\](https://example.com/r/a/package-5) | [35mChanged[39m   | dev-master 1234567 | 1.1.1  | [Compare](https://example.com/c/dev-master..1.1.1) |
+| []8;;https://example.com/r/a/package-4\\a/package-4]8;;\\](https://example.com/r/a/package-4) | [31mRemoved[39m   | 0.1.1              | -      | [Compare](https://example.com/r/0.1.1)             |
+| a/no-link-2                                      | [31mRemoved[39m   | 0.1.1              | -      |                                                    |
+
+
+OUTPUT;
+                }
+
+                return <<<OUTPUT
+| Prod Packages                                    | Operation  | Base    | Target | Link                                          |
+|--------------------------------------------------|------------|---------|--------|-----------------------------------------------|
+| [a/package-1](https://example.com/r/a/package-1) | [32mNew[39m        | -       | 1.0.0  | [Compare](https://example.com/r/1.0.0)        |
+| a/no-link-1                                      | [32mNew[39m        | -       | 1.0.0  |                                               |
+| [a/package-2](https://example.com/r/a/package-2) | [36mUpgraded[39m   | 1.0.0   | 1.2.0  | [Compare](https://example.com/c/1.0.0..1.2.0) |
+| [a/package-3](https://example.com/r/a/package-3) | [33mDowngraded[39m | 2.0.0   | 1.1.1  | [Compare](https://example.com/c/2.0.0..1.1.1) |
+| a/no-link-2                                      | [33mDowngraded[39m | 2.0.0   | 1.1.1  |                                               |
+| php                                              | [35mChanged[39m    | >=7.4.6 | ^8.0   |                                               |
+
+| Dev Packages                                     | Operation | Base               | Target | Link                                               |
+|--------------------------------------------------|-----------|--------------------|--------|----------------------------------------------------|
+| [a/package-5](https://example.com/r/a/package-5) | [35mChanged[39m   | dev-master 1234567 | 1.1.1  | [Compare](https://example.com/c/dev-master..1.1.1) |
+| [a/package-4](https://example.com/r/a/package-4) | [31mRemoved[39m   | 0.1.1              | -      | [Compare](https://example.com/r/0.1.1)             |
+| a/no-link-2                                      | [31mRemoved[39m   | 0.1.1              | -      |                                                    |
+
+
+OUTPUT;
+            }
+
             return <<<OUTPUT
 | Prod Packages                                    | Operation  | Base    | Target | Link                                          |
 |--------------------------------------------------|------------|---------|--------|-----------------------------------------------|
@@ -28,6 +70,48 @@ protected function getSampleOutput($withUrls)
 | a/no-link-2                                      | Removed   | 0.1.1              | -      |                                                    |
 
 
+OUTPUT;
+        }
+
+        if ($decorated) {
+            if ($this->supportsLinks()) {
+                return <<<OUTPUT
+| Prod Packages | Operation  | Base    | Target |
+|---------------|------------|---------|--------|
+| ]8;;https://example.com/r/a/package-1\a/package-1]8;;\   | [32mNew[39m        | -       | 1.0.0  |
+| a/no-link-1   | [32mNew[39m        | -       | 1.0.0  |
+| ]8;;https://example.com/r/a/package-2\a/package-2]8;;\   | [36mUpgraded[39m   | 1.0.0   | 1.2.0  |
+| ]8;;https://example.com/r/a/package-3\a/package-3]8;;\   | [33mDowngraded[39m | 2.0.0   | 1.1.1  |
+| a/no-link-2   | [33mDowngraded[39m | 2.0.0   | 1.1.1  |
+| php           | [35mChanged[39m    | >=7.4.6 | ^8.0   |
+
+| Dev Packages | Operation | Base               | Target |
+|--------------|-----------|--------------------|--------|
+| ]8;;https://example.com/r/a/package-5\a/package-5]8;;\  | [35mChanged[39m   | dev-master 1234567 | 1.1.1  |
+| ]8;;https://example.com/r/a/package-4\a/package-4]8;;\  | [31mRemoved[39m   | 0.1.1              | -      |
+| a/no-link-2  | [31mRemoved[39m   | 0.1.1              | -      |
+
+
+OUTPUT;
+            }
+
+            return <<<OUTPUT
+| Prod Packages | Operation  | Base    | Target |
+|---------------|------------|---------|--------|
+| a/package-1   | [32mNew[39m        | -       | 1.0.0  |
+| a/no-link-1   | [32mNew[39m        | -       | 1.0.0  |
+| a/package-2   | [36mUpgraded[39m   | 1.0.0   | 1.2.0  |
+| a/package-3   | [33mDowngraded[39m | 2.0.0   | 1.1.1  |
+| a/no-link-2   | [33mDowngraded[39m | 2.0.0   | 1.1.1  |
+| php           | [35mChanged[39m    | >=7.4.6 | ^8.0   |
+
+| Dev Packages | Operation | Base               | Target |
+|--------------|-----------|--------------------|--------|
+| a/package-5  | [35mChanged[39m   | dev-master 1234567 | 1.1.1  |
+| a/package-4  | [31mRemoved[39m   | 0.1.1              | -      |
+| a/no-link-2  | [31mRemoved[39m   | 0.1.1              | -      |
+
+
 OUTPUT;
         }