ci(config): Update configuration files and .gitignore

guanguans · guanguans · commit 4061ea35bb06 · 2025-12-05T16:50:35.000+08:00
- Add '/public' to .gitignore to prevent public directory from being tracked.
- Introduce 'testbench:workbench:install' command in composer.json for easier installation.
- Modify SOAR_ENABLED and DSN_DISABLE settings in testbench.yaml for clarity.
- Sync public and storage directories with workbench for better asset management.

Signed-off-by: guanguans &lt;ityaozm@gmail.com&gt;
diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -548,9 +548,9 @@ composer checks:required
 composer test
 composer testbench soar:run
 composer testbench soar:score
-composer testbench:example-serve
 composer testbench:serve
 composer testbench:test
+composer testbench:user-serve
 ```
 
 ## 变更日志
diff --git a/README.md b/README.md
@@ -548,9 +548,9 @@ composer checks:required
 composer test
 composer testbench soar:run
 composer testbench soar:score
-composer testbench:example-serve
 composer testbench:serve
 composer testbench:test
+composer testbench:user-serve
 ```
 
 ## Changelog
diff --git a/composer.json b/composer.json
@@ -456,11 +456,6 @@
         "testbench": "@php vendor/bin/testbench --ansi -vv",
         "testbench:build": "@testbench workbench:build",
         "testbench:clear": "@testbench package:purge-skeleton",
-        "testbench:example-serve": [
-            "@composer-config:disable-process-timeout",
-            "@testbench:build",
-            "@php -S localhost:8123 laravel/public/index.php"
-        ],
         "testbench:optimize:image": "@testbench optimize:image",
         "testbench:optimize:image-dry-run": "@testbench:optimize:image --dry-run",
         "testbench:prepare": "@testbench package:discover",
@@ -473,6 +468,12 @@
             "@testbench:clear",
             "@pest"
         ],
+        "testbench:user-serve": [
+            "@composer-config:disable-process-timeout",
+            "@testbench:build",
+            "@php -S localhost:8123 workbench/public/index.php"
+        ],
+        "testbench:workbench:install": "@testbench workbench:install",
         "todo-lint": "! git --no-pager grep --extended-regexp --ignore-case 'todo|fixme' -- '*.php' ':!*.blade.php' ':(exclude)resources/'",
         "touch:database-sqlite": "@php -r \"file_exists('vendor/orchestra/testbench-core/laravel/database/database.sqlite') || touch('vendor/orchestra/testbench-core/laravel/database/database.sqlite');\"",
         "trufflehog": "trufflehog git https://github.com/guanguans/laravel-soar --only-verified",
diff --git a/testbench.yaml b/testbench.yaml
@@ -9,10 +9,10 @@ providers:
 
 env:
   APP_NAME: "Testbench"
-  SOAR_ENABLED: true
+  SOAR_ENABLED: (true)
   # SOAR_SUDO_PASSWORD: "password"
-  SOAR_TEST_DSN_DISABLE: true
-  SOAR_ONLINE_DSN_DISABLE: true
+  SOAR_TEST_DSN_DISABLE: (true)
+  SOAR_ONLINE_DSN_DISABLE: (true)
 
 migrations:
   - workbench/database/migrations
@@ -35,9 +35,13 @@ workbench:
     - create-sqlite-db
     - db-wipe
     - migrate-fresh
+    - public:link
   assets:
     - laravel-assets
   sync:
+    - from: public
+      to: workbench/public
+      reverse: true
     - from: storage
       to: workbench/storage
       reverse: true
diff --git a/tests/Feature/ConsoleTest.php b/tests/Feature/ConsoleTest.php
@@ -19,31 +19,45 @@
  * @see https://github.com/guanguans/laravel-soar
  */
 
+use Composer\Semver\Comparator;
 use Guanguans\LaravelSoar\Bootstrapper;
+use Illuminate\Console\Events\CommandFinished;
+use Illuminate\Foundation\Application;
 use Illuminate\Support\Arr;
-
-beforeEach(function (): void {
-    resolve(Bootstrapper::class)->boot();
-
-    $this->see = collect(Arr::first(Soar::arrayScores('select * from users')))
-        ->except(['ID', 'Fingerprint'])
-        ->keys()
-        ->push('Summary', 'Basic', 'Backtraces')
-        ->all();
-});
-
-it('can not output soar scores', function (): void {
-    config()->set('soar.except', ['output:all']);
-
-    $this->artisan('output:all')
-        // ->expectsOutput(OutputManager::class)
-        ->expectsOutputToContain(OutputManager::class)
-        ->assertOk();
+use Illuminate\Support\Facades\Event;
+use Workbench\App\Support\Utils;
+
+uses(WithConsoleEvents::class)
+    ->beforeEach(function (): void {
+        resolve(Bootstrapper::class)->boot();
+
+        $this->see = collect(Arr::first(Soar::arrayScores('select * from users')))
+            ->except(['ID', 'Fingerprint'])
+            ->keys()
+            ->push('Summary', 'Basic', 'Backtraces')
+            ->all();
+    });
+
+it('is a console output example', function (): void {
+    Event::fakeFor(function (): void {
+        $this->artisan('output:example')
+            // ->expectsOutput(Utils::CONSOLE_OUTPUT_PHRASE)
+            ->expectsOutputToContain(Utils::CONSOLE_OUTPUT_PHRASE)
+            ->assertOk();
+
+        // Event::assertDispatched(CommandFinished::class);
+    });
 })->group(__DIR__, __FILE__);
 
-it('can outputs console', function (): void {
-    $this->artisan('output:all')
-        // ->expectsOutput(OutputManager::class)
-        ->expectsOutputToContain(OutputManager::class)
-        ->assertOk();
-})->group(__DIR__, __FILE__);
+it('is a console output example with console events ', function (): void {
+    Event::fakeFor(function (): void {
+        $this->artisan('output:example')
+            // ->expectsOutput(Utils::CONSOLE_OUTPUT_PHRASE)
+            ->expectsOutputToContain(Utils::CONSOLE_OUTPUT_PHRASE)
+            ->assertOk();
+
+        Event::assertDispatched(CommandFinished::class);
+    });
+})
+    ->group(__DIR__, __FILE__)
+    ->skip(Comparator::lessThan(Application::VERSION, '11.0.0'));
diff --git a/tests/Feature/HttpTest.php b/tests/Feature/HttpTest.php
@@ -21,9 +21,8 @@
 
 use Guanguans\LaravelSoar\Bootstrapper;
 use Guanguans\LaravelSoar\Facades\Soar;
-use Guanguans\LaravelSoar\OutputManager;
-use Guanguans\LaravelSoar\Outputs\JsonOutput;
 use Illuminate\Support\Arr;
+use Workbench\App\Support\Utils;
 
 beforeEach(function (): void {
     resolve(Bootstrapper::class)->boot();
@@ -35,19 +34,19 @@
         ->all();
 });
 
-it('can output to all', function (): void {
+it('is a general output example', function (): void {
     $this
-        ->get('output/all-example')
+        ->get('general-example')
         ->assertOk()
         ->assertSee($this->see)
-        ->assertSee(OutputManager::class);
+        ->assertSee(Utils::GENERAL_OUTPUT_PHRASE);
 })->group(__DIR__, __FILE__);
 
-it('can output to json', function (): void {
+it('is a json output example', function (): void {
     $this
-        ->getJson('output/json-example')
+        ->getJson('json-example')
         ->assertOk()
         ->assertJsonStructure()
         ->assertSee($this->see)
-        ->assertSee(class_basename(JsonOutput::class));
+        ->assertSee(Utils::JSON_OUTPUT_PHRASE);
 })->group(__DIR__, __FILE__);
diff --git a/workbench/.gitignore b/workbench/.gitignore
@@ -1,3 +1,4 @@
 .env
 .env.dusk
+/public
 /storage
diff --git a/workbench/app/Support/Utils.php b/workbench/app/Support/Utils.php
@@ -22,11 +22,16 @@
 use Guanguans\LaravelSoar\Outputs\LaraDumpsOutput;
 use Guanguans\LaravelSoar\Outputs\LogOutput;
 use Guanguans\LaravelSoar\Outputs\RayOutput;
+use Illuminate\Support\Facades\Artisan;
 use Workbench\App\Models\User;
 use Workbench\Database\Factories\UserFactory;
 
 class Utils
 {
+    public const CONSOLE_OUTPUT_PHRASE = 'This is a console output example.';
+    public const GENERAL_OUTPUT_PHRASE = 'This is a general output example.';
+    public const JSON_OUTPUT_PHRASE = 'This is a json output example.';
+
     public static function extendOutputManager(null|array|string $outputs = null): void
     {
         $outputs ??= [
@@ -58,4 +63,25 @@ static function (OutputManager $outputManager) use ($outputs): OutputManager {
         UserFactory::new()->times(3)->create();
         User::query()->first();
     }
+
+    /**
+     * @see \Illuminate\Foundation\Console\StorageLinkCommand
+     */
+    public static function links(array $links, array $parameters = []): int
+    {
+        $originalLinks = config('filesystems.links', []);
+
+        config()->set('filesystems.links', $links);
+
+        $status = Artisan::call('storage:link', $parameters + [
+            '--ansi' => true,
+            '--verbose' => true,
+        ]);
+
+        config()->set('filesystems.links', $originalLinks);
+
+        // echo Artisan::output();
+
+        return $status;
+    }
 }
diff --git a/workbench/routes/api.php b/workbench/routes/api.php
@@ -13,8 +13,17 @@
  * @see https://github.com/guanguans/laravel-soar
  */
 
+use Guanguans\LaravelSoar\Outputs\ClockworkOutput;
+use Guanguans\LaravelSoar\Outputs\ConsoleOutput;
+use Guanguans\LaravelSoar\Outputs\DebugBarOutput;
+use Guanguans\LaravelSoar\Outputs\DumpOutput;
+use Guanguans\LaravelSoar\Outputs\JsonOutput;
+use Guanguans\LaravelSoar\Outputs\LaraDumpsOutput;
+use Guanguans\LaravelSoar\Outputs\LogOutput;
+use Guanguans\LaravelSoar\Outputs\RayOutput;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Route;
+use Workbench\App\Support\Utils;
 
 /*
 |--------------------------------------------------------------------------
@@ -30,3 +39,18 @@
 // Route::middleware('auth:sanctum')->get('/user', function (Request $request) {
 //     return $request->user();
 // });
+
+Route::get('json-example', static function (): array {
+    Utils::extendOutputManager([
+        ClockworkOutput::class,
+        ConsoleOutput::class,
+        DebugBarOutput::class,
+        // DumpOutput::class,
+        JsonOutput::class,
+        LaraDumpsOutput::class,
+        LogOutput::class,
+        RayOutput::class,
+    ]);
+
+    return ['phrase' => Utils::JSON_OUTPUT_PHRASE];
+});
diff --git a/workbench/routes/console.php b/workbench/routes/console.php
@@ -13,7 +13,6 @@
  * @see https://github.com/guanguans/laravel-soar
  */
 
-use Guanguans\LaravelSoar\OutputManager;
 use Illuminate\Foundation\Inspiring;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Artisan;
@@ -36,14 +35,23 @@
 */
 
 // Artisan::command('inspire', function () {
-//     $this->comment(Inspiring::quote());
+//     $this->components->comment(Inspiring::quote());
 // })->purpose('Display an inspiring quote');
 
-Artisan::command('output:all', function (): void {
+Artisan::command('output:example', function (): void {
     Utils::extendOutputManager();
 
     /** @var \Illuminate\Console\Command $this */
-    $this->info(OutputManager::class);
+    $this->components->info(Utils::CONSOLE_OUTPUT_PHRASE);
+});
+
+Artisan::command('public:link', function (): void {
+    Utils::links([
+        __DIR__.'/../'.basename($target = __DIR__.'/../../vendor/orchestra/testbench-core/laravel/public/') => $target,
+    ]);
+
+    /** @var \Illuminate\Console\Command $this */
+    $this->components->info('The [public] directory has been linked.');
 });
 
 Artisan::command('optimize:image {--dry-run : Only list found images}', function (): void {
diff --git a/workbench/routes/web.php b/workbench/routes/web.php
@@ -14,13 +14,7 @@
  * @see https://github.com/guanguans/laravel-soar
  */
 
-use Guanguans\LaravelSoar\OutputManager;
-use Guanguans\LaravelSoar\Outputs\JsonOutput;
-use Illuminate\Http\JsonResponse;
-use Illuminate\Http\Request;
-use Illuminate\Routing\Router;
 use Illuminate\Support\Facades\Route;
-use Symfony\Component\HttpFoundation\Response as SymfonyResponse;
 use Workbench\App\Support\Utils;
 
 /*
@@ -34,34 +28,16 @@
 |
 */
 
-Route::get('/', static fn () => view('welcome'));
+// Route::get('/', static fn () => view('welcome'));
 
-Route::get('/routes', static function () {
-    $routes = collect(Route::getRoutes()->get('GET'))->filter(
-        static fn (Illuminate\Routing\Route $route) => str($route->uri())->startsWith('output')
-    );
+Route::get('/', static fn () => view('routes', [
+    'routes' => collect(Route::getRoutes()->get('GET'))->filter(
+        static fn (Illuminate\Routing\Route $route) => str($route->uri())->endsWith('-example')
+    ),
+]));
 
-    return view('routes', ['routes' => $routes]);
-});
-
-Route::group([
-    'prefix' => 'output',
-    'middleware' => [
-        // static function (Request $request, Closure $next): SymfonyResponse {
-        //     Utils::extendOutputManager(JsonOutput::class);
-        //
-        //     return $next($request);
-        // },
-    ],
-], static function (Router $router): void {
-    $router->get('all-example', static function (): string {
-        Utils::extendOutputManager();
-
-        return OutputManager::class;
-    });
-    $router->get('json-example', static function (): JsonResponse {
-        Utils::extendOutputManager(JsonOutput::class);
+Route::get('general-example', static function (): string {
+    Utils::extendOutputManager();
 
-        return new JsonResponse(['output' => JsonOutput::class]);
-    });
+    return Utils::GENERAL_OUTPUT_PHRASE;
 });

-Original file line number
+Diff line change
@@ @@ -1,3 +1,4 @@ @@
 .env
 .env.dusk
 +/public
 /storage