create specific exceptions for release process

Author: nikophil

bin/create_release

@@ -4,6 +4,7 @@
 require __DIR__.'/../vendor/autoload.php';
 
 use SymfonyDocsBuilder\Phar\Compiler;
+use SymfonyDocsBuilder\Release\Exception\ReleaseFailed;
 use SymfonyDocsBuilder\Release\GithubApiHttpClientFactory;
 use SymfonyDocsBuilder\Release\Releaser;
 
@@ -21,6 +22,11 @@ try {
 
     $releaser->createRelease(...$argv);
 } catch (Exception $e) {
-    echo 'Failed to create a new release: ['.get_class($e).'] '.$e->getMessage().' at '.$e->getFile().':'.$e->getLine()."\n";
+    if ($e instanceof ReleaseFailed) {
+        echo $e->toString();
+    } else {
+        echo 'Failed to create a new release: ['.get_class($e).'] '.$e->getMessage().' at '.$e->getFile().':'.$e->getLine()."\n";
+    }
+
     exit(1);
 }

src/Release/Exception/DeleteReleaseFailed.php

@@ -0,0 +1,29 @@
+<?php declare(strict_types=1);
+
+namespace SymfonyDocsBuilder\Release\Exception;
+
+use Symfony\Contracts\HttpClient\Exception\HttpExceptionInterface;
+
+class DeleteReleaseFailed extends ReleaseFailed
+{
+    private $originException;
+
+    public function __construct(ReleaseFailed $originException, HttpExceptionInterface $previous)
+    {
+        $this->originException = $originException;
+
+        parent::__construct('Error while deleting release.', 0, $previous);
+    }
+
+    public function toString(): string
+    {
+        return sprintf(
+            "%s\n\nOriginal exception was: [%s]\n\t\"%s\"\n\tat %s:%s\n",
+            parent::toString(),
+            get_class($this->originException),
+            $this->originException->getMessage(),
+            $this->originException->getFile(),
+            $this->originException->getLine()
+        );
+    }
+}

src/Release/Exception/ReleaseFailed.php

@@ -0,0 +1,44 @@
+<?php declare(strict_types=1);
+
+namespace SymfonyDocsBuilder\Release\Exception;
+
+use Symfony\Contracts\HttpClient\Exception\HttpExceptionInterface;
+
+class ReleaseFailed extends \RuntimeException
+{
+    public static function whileCreatingDraft(HttpExceptionInterface $previous): self
+    {
+        if (401 === $previous->getCode()) {
+            $message = 'Error while trying to create release: Invalid token.';
+        } else {
+            $message = 'Error while trying to create release.';
+        }
+
+        return new self($message, 0, $previous);
+    }
+
+    public static function whileAttachingAssetToRelease(HttpExceptionInterface $previous): self
+    {
+        return new self('Error while adding asset to release.', 0, $previous);
+    }
+
+    public static function whilePublishingRelease(HttpExceptionInterface $previous): self
+    {
+        return new self('Error while publishing release. Maybe the tag name already exists?', 0, $previous);
+    }
+
+    public function toString(): string
+    {
+        return sprintf(
+            "Failed to create a new release: [%s]\n\t\"%s\"\n\tat %s:%s\n\nHttpException was: [%s]\n\t\"%s\"\n\tat %s:%s\n",
+            self::class,
+            $this->getMessage(),
+            $this->getFile(),
+            $this->getLine(),
+            get_class($this->getPrevious()),
+            $this->getPrevious()->getMessage(),
+            $this->getPrevious()->getFile(),
+            $this->getPrevious()->getLine()
+        );
+    }
+}

src/Release/Releaser.php

@@ -2,8 +2,10 @@
 
 namespace SymfonyDocsBuilder\Release;
 
+use Symfony\Contracts\HttpClient\Exception\HttpExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use SymfonyDocsBuilder\Phar\Compiler;
+use SymfonyDocsBuilder\Release\Exception\ReleaseFailed;
 
 class Releaser
 {
@@ -21,7 +23,7 @@ public function __construct(HttpClientInterface $client, Compiler $compiler)
         $this->compiler = $compiler;
     }
 
-    public function createRelease(string $tag, string $name = 'Symfony docs builder %s', string $description = 'Symfony docs builder %s')
+    public function createRelease(string $tag, string $name = 'Symfony docs builder %s', string $description = 'Symfony docs builder %s'): void
     {
         if (!preg_match('/^v\d+\.\d+\.\d+$/', $tag)) {
             throw new \RuntimeException(sprintf('"%s" is not a valid tag.', $tag));
@@ -53,15 +55,8 @@ private function createDraftRelease(string $tag, string $name, string $descripti
             );
 
             return (int) $response->toArray()['id'];
-        } catch (\RuntimeException $exception) {
-            if (401 === $exception->getCode()) {
-                $message = 'Error while trying to create release: Invalid token.';
-            } else {
-                $message = 'Error while trying to create release.';
-            }
-
-            // todo: create new exception which can be exploited in ./bin/create_release
-            throw new \RuntimeException($message, 0, $exception);
+        } catch (HttpExceptionInterface $exception) {
+            throw ReleaseFailed::whileCreatingDraft($exception);
         }
     }
 
@@ -81,9 +76,8 @@ private function addAssetToRelease(int $releaseId): void
                     'body'    => file_get_contents(__DIR__.'/../../docs.phar'),
                 ]
             );
-        } catch (\RuntimeException $exception) {
-            $this->deleteRelease($releaseId);
-            throw new \RuntimeException('Error while adding asset to release.', 0, $exception);
+        } catch (HttpExceptionInterface $exception) {
+            $this->deleteRelease($releaseId, ReleaseFailed::whileAttachingAssetToRelease($exception));
         }
     }
 
@@ -99,21 +93,22 @@ private function publishRelease(int $releaseId): void
                     ],
                 ]
             );
-        } catch (\RuntimeException $exception) {
-            $this->deleteRelease($releaseId);
-            throw new \RuntimeException('Error while publishing release. Maybe the tag name already exists?', 0, $exception);
+        } catch (HttpExceptionInterface $exception) {
+            $this->deleteRelease($releaseId, ReleaseFailed::whilePublishingRelease($exception));
         }
     }
 
-    private function deleteRelease(int $releaseId): void
+    private function deleteRelease(int $releaseId, ReleaseFailed $previous): void
     {
         try {
             $this->client->request(
                 'DELETE',
                 sprintf('https://api.github.com/repos/%s/%s/releases/%s', self::GITHUB_USER, self::GITHUB_REPO, $releaseId)
             );
-        } catch (\RuntimeException $exception) {
-            throw new \RuntimeException('Error while deleting release.', 0, $exception);
+        } catch (HttpExceptionInterface $exception) {
+            throw new DeleteReleaseFailed($previous, $exception);
         }
+
+        throw $previous;
     }
 }

tests/Release/ReleaserTest.php

@@ -6,6 +6,7 @@
 use Symfony\Component\HttpClient\MockHttpClient;
 use Symfony\Component\HttpClient\Response\MockResponse;
 use SymfonyDocsBuilder\Phar\Compiler;
+use SymfonyDocsBuilder\Release\Exception\ReleaseFailed;
 use SymfonyDocsBuilder\Release\Releaser;
 
 class ReleaserTest extends TestCase
@@ -63,7 +64,7 @@ public function testCreateReleaseThrowExceptionIf401IsReturned(): void
     {
         $releaser = new Releaser(new MockHttpClient([new MockResponse('', ['http_code' => 401])]), $this->createMock(Compiler::class));
 
-        $this->expectException(\RuntimeException::class);
+        $this->expectException(ReleaseFailed::class);
         $this->expectExceptionMessage('Error while trying to create release: Invalid token.');
 
         $releaser->createRelease('v1.0.0');
@@ -87,7 +88,7 @@ public function testReleaseIsDeletedIfAddAssetReturnsAnError(): void
             self::fail(sprintf("Unexpected request:\n- method: %s\n- url: %s", $method, $url));
         };
 
-        $this->expectException(\RuntimeException::class);
+        $this->expectException(ReleaseFailed::class);
         $this->expectExceptionMessage('Error while adding asset to release.');
 
         $releaser = new Releaser(new MockHttpClient($callback), $this->createMock(Compiler::class));