test: Remove useless files, change exception class names, adjust configuration settings, and refactor notification methods.

guanguans · guanguans · commit e0c923874d45 · 2024-04-23T16:28:20.000+08:00
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -13,8 +13,8 @@
       <directory suffix=".php">src/</directory>
     </include>
     <exclude>
-      <!--<directory>src/Support/</directory>-->
-      <!--<file>src/Channels/DdChannel.php</file>-->
+      <directory>src/Rectors/</directory>
+      <file>src/Support/helpers.php</file>
     </exclude>
   </coverage>
   <testsuites>
diff --git a/src/Channels/MailChannel.php b/src/Channels/MailChannel.php
@@ -24,10 +24,10 @@ class MailChannel extends Channel
     public function report(string $report): void
     {
         tap(Mail::driver($this->config->get('mailer')), function (Mailer $mailer): void {
-            collect($this->config)
+            collect($this->config->all())
                 ->except(['mailer'])
                 ->each(static function ($value, string $key) use ($mailer): void {
-                    $mailer->{Str::studly($key)}($value);
+                    $mailer->{Str::camel($key)}($value);
                 });
         })->send($this->createMail($report));
     }
diff --git a/src/ExceptionNotifyManager.php b/src/ExceptionNotifyManager.php
@@ -151,7 +151,7 @@ protected function attempt(string $key, int $maxAttempts, int $decaySeconds = 60
         });
     }
 
-    protected function createDriver($driver)
+    protected function createDriver($driver): Channel
     {
         if (isset($this->customCreators[$driver])) {
             return $this->callCustomCreator($driver);
diff --git a/src/Exceptions/Exception.php b/src/Exceptions/Exception.php
diff --git a/src/Support/helpers.php b/src/Support/helpers.php
@@ -15,6 +15,8 @@
 
 if (!\function_exists('make')) {
     /**
+     * @codeCoverageIgnore
+     *
      * @psalm-param string|array<string, mixed> $abstract
      *
      * @param mixed $abstract
diff --git a/tests/Channels/MailChannelTest.php b/tests/Channels/MailChannelTest.php
@@ -14,7 +14,7 @@
 use Guanguans\LaravelExceptionNotify\ExceptionNotifyManager;
 
 it('can report', function (): void {
-    expect($this->app->make(ExceptionNotifyManager::class)->driver('dump'))
+    expect($this->app->make(ExceptionNotifyManager::class)->driver('mail'))
         ->report('report')
-        ->toBe('report');
+        ->toBeNull();
 })->group(__DIR__, __FILE__);
diff --git a/tests/Channels/NotifyChannelTest.php b/tests/Channels/NotifyChannelTest.php
@@ -11,57 +11,9 @@
  * @see https://github.com/guanguans/laravel-exception-notify
  */
 
-use Guanguans\LaravelExceptionNotify\Channels\BarkChannel;
-use Guanguans\LaravelExceptionNotify\Channels\ChanifyChannel;
-use Guanguans\LaravelExceptionNotify\Channels\DingTalkChannel;
-use Guanguans\LaravelExceptionNotify\Channels\DiscordChannel;
-use Guanguans\LaravelExceptionNotify\Channels\FeiShuChannel;
-use Guanguans\LaravelExceptionNotify\Channels\PushDeerChannel;
-use Guanguans\LaravelExceptionNotify\Channels\QqChannelBotChannel;
-use Guanguans\LaravelExceptionNotify\Channels\ServerChanChannel;
-use Guanguans\LaravelExceptionNotify\Channels\SlackChannel;
-use Guanguans\LaravelExceptionNotify\Channels\TelegramChannel;
-use Guanguans\LaravelExceptionNotify\Channels\WeWorkChannel;
-use Guanguans\LaravelExceptionNotify\Channels\XiZhiChannel;
-use Guanguans\LaravelExceptionNotify\ExceptionNotifyManager;
-use Guanguans\Notify\Clients\Client;
-use Guanguans\Notify\Contracts\MessageInterface;
-use Illuminate\Notifications\Channels\MailChannel;
-use Illuminate\Support\Str;
+use Guanguans\LaravelExceptionNotify\Channels\NotifyChannel;
+use Illuminate\Config\Repository;
 
-it('can report', function (): void {
-    expect(new BarkChannel(
-        Mockery::spy(Client::class)->allows('send')->once()->getMock()
-    ))->report('report')->toBeNull();
-})->group(__DIR__, __FILE__)->skip();
-
-it('can create message', function (): void {
-    $collection = collect([
-        BarkChannel::class,
-        ChanifyChannel::class,
-        DingTalkChannel::class,
-        DiscordChannel::class,
-        FeiShuChannel::class,
-        MailChannel::class,
-        PushDeerChannel::class,
-        QqChannelBotChannel::class,
-        ServerChanChannel::class,
-        SlackChannel::class,
-        TelegramChannel::class,
-        WeWorkChannel::class,
-        XiZhiChannel::class,
-    ])->transform(function (string $channelClass): MessageInterface {
-        $channelName = (string) Str::of(class_basename($channelClass))
-            ->beforeLast('Channel')
-            ->lcfirst();
-
-        $channel = $this
-            ->app
-            ->make(ExceptionNotifyManager::class)
-            ->driver($channelName);
-
-        return (fn () => $this->createMessage('report'))->call($channel);
-    });
-
-    expect($collection)->each->toBeInstanceOf(MessageInterface::class);
-})->group(__DIR__, __FILE__)->skip();
+it('will throw `InvalidArgumentException`', function (): void {
+    new NotifyChannel(new Repository([]));
+})->group(__DIR__, __FILE__)->throws(\Guanguans\LaravelExceptionNotify\Exceptions\InvalidArgumentException::class);
diff --git a/tests/CollectorManagerTest.php b/tests/CollectorManagerTest.php
diff --git a/tests/ExceptionNotifyManagerTest.php b/tests/ExceptionNotifyManagerTest.php
@@ -11,6 +11,7 @@
  * @see https://github.com/guanguans/laravel-exception-notify
  */
 
+use Guanguans\LaravelExceptionNotify\Contracts\Channel;
 use Guanguans\LaravelExceptionNotify\ExceptionNotifyManager;
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Support\Str;
@@ -32,13 +33,13 @@
 
 it('can report if', function (): void {
     expect(app(ExceptionNotifyManager::class))
-        ->reportIf(true, new \Guanguans\LaravelExceptionNotify\Exceptions\Exception)->toBeNull();
+        ->reportIf(true, new \Guanguans\LaravelExceptionNotify\Exceptions\RuntimeException)->toBeNull();
 })->group(__DIR__, __FILE__);
 
 it('can report', function (): void {
     config()->set('exception-notify.enabled', false);
     expect(app(ExceptionNotifyManager::class))
-        ->report(new \Guanguans\LaravelExceptionNotify\Exceptions\Exception)->toBeNull();
+        ->report(new \Guanguans\LaravelExceptionNotify\Exceptions\RuntimeException)->toBeNull();
 
     config()->set('exception-notify.enabled', true);
     $mockApplication = Mockery::spy(Illuminate\Foundation\Application::class);
@@ -47,7 +48,7 @@
 
     /** @noinspection PhpVoidFunctionResultUsedInspection */
     expect(new ExceptionNotifyManager($mockApplication))
-        ->report(new \Guanguans\LaravelExceptionNotify\Exceptions\Exception)->toBeNull();
+        ->report(new \Guanguans\LaravelExceptionNotify\Exceptions\RuntimeException)->toBeNull();
 
     config()->set('exception-notify.enabled', true);
     $mockApplication = Mockery::mock(Application::class);
@@ -56,26 +57,26 @@
 
     /** @noinspection PhpVoidFunctionResultUsedInspection */
     expect(new ExceptionNotifyManager($mockApplication))
-        ->report(new \Guanguans\LaravelExceptionNotify\Exceptions\Exception)->toBeNull();
+        ->report(new \Guanguans\LaravelExceptionNotify\Exceptions\RuntimeException)->toBeNull();
 })->group(__DIR__, __FILE__);
 
 it('should not report', function (): void {
     config()->set('exception-notify.enabled', false);
-    expect(app(ExceptionNotifyManager::class))->shouldReport(new \Guanguans\LaravelExceptionNotify\Exceptions\Exception)->toBeFalse();
+    expect(app(ExceptionNotifyManager::class))->shouldReport(new \Guanguans\LaravelExceptionNotify\Exceptions\RuntimeException)->toBeFalse();
 
     config()->set('exception-notify.enabled', true);
     config()->set('exception-notify.env', ['production', 'local']);
-    expect(app(ExceptionNotifyManager::class))->shouldReport(new \Guanguans\LaravelExceptionNotify\Exceptions\Exception)->toBeFalse();
+    expect(app(ExceptionNotifyManager::class))->shouldReport(new \Guanguans\LaravelExceptionNotify\Exceptions\RuntimeException)->toBeFalse();
 
     config()->set('exception-notify.enabled', true);
     config()->set('exception-notify.env', '*');
     config()->set('exception-notify.except', [Exception::class]);
-    expect(app(ExceptionNotifyManager::class))->shouldReport(new \Guanguans\LaravelExceptionNotify\Exceptions\Exception)->toBeFalse();
+    expect(app(ExceptionNotifyManager::class))->shouldReport(new \Guanguans\LaravelExceptionNotify\Exceptions\RuntimeException)->toBeFalse();
 
     config()->set('exception-notify.enabled', true);
     config()->set('exception-notify.env', '*');
     config()->set('exception-notify.except', []);
-    expect(app(ExceptionNotifyManager::class))->shouldReport(new \Guanguans\LaravelExceptionNotify\Exceptions\Exception)->toBeTrue();
+    expect(app(ExceptionNotifyManager::class))->shouldReport(new \Guanguans\LaravelExceptionNotify\Exceptions\RuntimeException)->toBeTrue();
 })->group(__DIR__, __FILE__);
 
 it('can get default driver', function (): void {
@@ -92,3 +93,17 @@
         ->call(app(ExceptionNotifyManager::class))->toBeTrue()
         ->call(app(ExceptionNotifyManager::class))->toBeFalse();
 })->group(__DIR__, __FILE__);
+
+it('will throw `InvalidArgumentException`', function (): void {
+    app(ExceptionNotifyManager::class)->driver('foo');
+})->group(__DIR__, __FILE__)->throws(\Guanguans\LaravelExceptionNotify\Exceptions\InvalidArgumentException::class);
+
+it('can create custom driver', function (): void {
+    app(ExceptionNotifyManager::class)->extend('foo', function () {
+        return new class implements Channel {
+            public function report(string $report): void {}
+        };
+    });
+
+    expect(app(ExceptionNotifyManager::class))->driver('foo')->toBeInstanceOf(Channel::class);
+})->group(__DIR__, __FILE__);
diff --git a/tests/FeatureTest.php b/tests/FeatureTest.php
@@ -15,7 +15,7 @@
 use Illuminate\Http\UploadedFile;
 
 it('can report exception', function (): void {
-    ExceptionNotify::report(new \Guanguans\LaravelExceptionNotify\Exceptions\Exception('What happened?'), ['lark']);
+    ExceptionNotify::report(new \Guanguans\LaravelExceptionNotify\Exceptions\RuntimeException('What happened?'), ['lark']);
     $this
         ->post('report-exception?foo=bar', [
             'bar' => 'baz',
diff --git a/tests/Pipes/PipeTest.php b/tests/Pipes/PipeTest.php
@@ -25,7 +25,7 @@
             collect(app(CollectorManager::class))
                 ->transform(static function (Collector $collector): Collector {
                     if ($collector instanceof ExceptionAware) {
-                        $collector->setException(new \Guanguans\LaravelExceptionNotify\Exceptions\Exception);
+                        $collector->setException(new \Guanguans\LaravelExceptionNotify\Exceptions\RuntimeException);
                     }
 
                     return $collector;
diff --git a/tests/Support/ExceptionContextTest.php b/tests/Support/ExceptionContextTest.php
@@ -16,7 +16,7 @@
 use Guanguans\LaravelExceptionNotify\Support\ExceptionContext;
 
 it('can get marked exception context', function (): void {
-    expect(ExceptionContext::getMarked(new \Guanguans\LaravelExceptionNotify\Exceptions\Exception))->toBeArray();
+    expect(ExceptionContext::getMarked(new \Guanguans\LaravelExceptionNotify\Exceptions\RuntimeException))->toBeArray();
 
     try {
         eval('throw new Exception("eval");');
diff --git a/tests/Support/HeplersTest.php b/tests/Support/HeplersTest.php
@@ -22,11 +22,6 @@
     // ->and(env_explode('ENV_EXPLODE_NULL'))->toBeNull()
 })->group(__DIR__, __FILE__);
 
-it('can return Stringable', function (): void {
-    expect(str())->toBeInstanceOf(Stringable::class)
-        ->and(str('foo'))->toBeInstanceOf(Illuminate\Support\Stringable::class);
-})->group(__DIR__, __FILE__);
-
 it('can human milliseconds', function (): void {
     expect([
         human_milliseconds(0.5),
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -30,6 +30,7 @@
 use Guanguans\LaravelExceptionNotify\Collectors\RequestServerCollector;
 use Guanguans\LaravelExceptionNotify\Collectors\RequestSessionCollector;
 use Guanguans\LaravelExceptionNotify\ExceptionNotifyServiceProvider;
+use Guanguans\LaravelExceptionNotify\Exceptions\RuntimeException;
 use Guanguans\LaravelExceptionNotify\Facades\ExceptionNotify;
 use Guanguans\LaravelExceptionNotify\Pipes\AddKeywordPipe;
 use Guanguans\LaravelExceptionNotify\Pipes\FixPrettyJsonPipe;
@@ -67,8 +68,8 @@ protected function getPackageProviders($app): array
     protected function defineEnvironment($app): void
     {
         config()->set('exception-notify.job.queue', 'exception-notify');
-        config()->set('exception-notify.channels.mail.dsn', 'smtp://53xxx11@qq.com:kixxxxxxxxgg@smtp.qq.com:465?verify_peer=0');
-        config()->set('exception-notify.channels.mail.from', '53xxx11@qq.com');
+        // config()->set('exception-notify.channels.mail.dsn', 'smtp://53xxx11@qq.com:kixxxxxxxxgg@smtp.qq.com:465?verify_peer=0');
+        // config()->set('exception-notify.channels.mail.from', '53xxx11@qq.com');
         config()->set('exception-notify.channels.mail.to', '53xxx11@qq.com');
         config()->set('exception-notify.collectors', [
             ApplicationCollector::class,
@@ -88,7 +89,7 @@ protected function defineEnvironment($app): void
             RequestServerCollector::class,
             RequestSessionCollector::class,
         ]);
-        config()->set('exception-notify.channels.null.pipes', [
+        config()->set('exception-notify.channels.log.pipes', [
             hydrate_pipe(AddKeywordPipe::class, 'keyword'),
             SprintfHtmlPipe::class,
             SprintfMarkdownPipe::class,
@@ -101,11 +102,11 @@ protected function defineEnvironment($app): void
     protected function defineRoutes($router): void
     {
         $router->any('report-exception', static fn () => tap(response('report-exception'), static function (): void {
-            ExceptionNotify::report(new \Guanguans\LaravelExceptionNotify\Exceptions\Exception('What happened?'), ['lark', 'dump']);
+            ExceptionNotify::report(new RuntimeException('What happened?'), ['lark', 'dump']);
         }));
 
         $router->any('exception', static fn () => tap(response('exception'), static function (): void {
-            throw new \Guanguans\LaravelExceptionNotify\Exceptions\RuntimeException('What happened?');
+            throw new RuntimeException('What happened?');
         }));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -24,10 +24,10 @@ class MailChannel extends Channel`
`24`	`24`	`public function report(string $report): void`
`25`	`25`	`{`
`26`	`26`	`tap(Mail::driver($this->config->get('mailer')), function (Mailer $mailer): void {`
`27`		`- collect($this->config)`
	`27`	`+ collect($this->config->all())`
`28`	`28`	`->except(['mailer'])`
`29`	`29`	`->each(static function ($value, string $key) use ($mailer): void {`
`30`		`- $mailer->{Str::studly($key)}($value);`
	`30`	`+ $mailer->{Str::camel($key)}($value);`
`31`	`31`	`});`
`32`	`32`	`})->send($this->createMail($report));`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -151,7 +151,7 @@ protected function attempt(string $key, int $maxAttempts, int $decaySeconds = 60`
`151`	`151`	`});`
`152`	`152`	`}`
`153`	`153`
`154`		`- protected function createDriver($driver)`
	`154`	`+ protected function createDriver($driver): Channel`
`155`	`155`	`{`
`156`	`156`	`if (isset($this->customCreators[$driver])) {`
`157`	`157`	`return $this->callCustomCreator($driver);`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@`
`15`	`15`
`16`	`16`	`if (!\function_exists('make')) {`
`17`	`17`	`/**`
	`18`	`+ * @codeCoverageIgnore`
	`19`	`+ *`
`18`	`20`	`* @psalm-param string\|array<string, mixed> $abstract`
`19`	`21`	`*`
`20`	`22`	`* @param mixed $abstract`