testing docs (#68)

Author: XbNz

resources/views/docs/1/testing/_index.md

@@ -0,0 +1,4 @@
+---
+title: Testing
+order: 5
+---

resources/views/docs/1/testing/basics.md

@@ -0,0 +1,30 @@
+---
+title: Basics
+order: 99
+---
+# Understanding fake test doubles
+When working with a NativePHP application, you may encounter an elevated level of difficulty when writing tests for your code.
+This is because NativePHP relies on an Electron/Tauri application to be open at all times, listening to HTTP requests. Obviously,
+emulating this in a test environment can be cumbersome. You will often hit an HTTP error, and this is normal. This is where
+NativePHP's fake test doubles come in.
+
+```php
+use Native\Laravel\Facades\Window;
+
+#[\PHPUnit\Framework\Attributes\Test]
+public function example(): void
+{
+    Window::fake();
+
+    $this->get('/whatever-action');
+
+    Window::assertOpened('window-name');
+}
+```
+
+## Where have I seen this before?
+
+If you've ever written tests for a Laravel application, you may have seen the `*::fake()` method available on
+all sorts of facades. Under the hood, these methods are swapping the real implementation and behavior – in NativePHP's case,
+an HTTP call that forces us to keep the server up and running, in turn degrading the ability to write expressive tests – with a fake one 
+that follows the same API. This means you do not have to change any of your code to write great tests.

resources/views/docs/1/testing/child-process.md

@@ -0,0 +1,31 @@
+---
+title: Child Process
+order: 100
+---
+# Fake Child Processes
+
+## Example test case
+
+```php
+use Native\Laravel\Facades\ChildProcess;
+
+#[\PHPUnit\Framework\Attributes\Test]
+public function example(): void
+{
+    ChildProcess::fake();
+
+    $this->get('/whatever-action');
+
+    ChildProcess::assertGet('background-worker');
+    ChildProcess::assertMessage(fn (string $message, string|null $alias) => $message === '{"some-payload":"for-the-worker"}' && $alias === null);
+}
+```
+
+## Available assertions
+- `assertGet`
+- `assertStarted`
+- `assertPhp`
+- `assertArtisan`
+- `assertStop`
+- `assertRestart`
+- `assertMessage`

resources/views/docs/1/testing/global-shortcut.md

@@ -0,0 +1,29 @@
+---
+title: Global Shortcut
+order: 100
+---
+# Fake Global Shortcuts
+
+## Example test case
+
+```php
+use Native\Laravel\Facades\GlobalShortcut;
+
+#[\PHPUnit\Framework\Attributes\Test]
+public function example(): void
+{
+    GlobalShortcut::fake();
+
+    $this->get('/whatever-action');
+
+    GlobalShortcut::assertKey('CmdOrCtrl+,');
+    GlobalShortcut::assertRegisteredCount(1);
+    GlobalShortcut::assertEvent(OpenPreferencesEvent::class);
+}
+```
+
+## Available assertions
+- `assertKey`
+- `assertRegisteredCount`
+- `assertUnregisteredCount`
+- `assertEvent`

resources/views/docs/1/testing/power-monitor.md

@@ -0,0 +1,28 @@
+---
+title: Power Monitor
+order: 100
+---
+# Fake Power Monitor
+
+## Example test case
+
+```php
+use Native\Laravel\Facades\PowerMonitor;
+
+#[\PHPUnit\Framework\Attributes\Test]
+public function example(): void
+{
+    PowerMonitor::fake();
+
+    $this->get('/whatever-action');
+
+    PowerMonitor::assertGetSystemIdleState('...');
+}
+```
+
+## Available assertions
+- `assertGetSystemIdleState`
+- `assertGetSystemIdleStateCount`
+- `assertGetSystemIdleTimeCount`
+- `assertGetCurrentThermalStateCount`
+- `assertIsOnBatteryPowerCount`

resources/views/docs/1/testing/queue-worker.md

@@ -0,0 +1,26 @@
+---
+title: Queue Worker
+order: 100
+---
+# Fake Queue Worker
+
+## Example test case
+
+```php
+use Native\Laravel\Facades\QueueWorker;
+use Native\Laravel\DTOs\QueueConfig;
+
+#[\PHPUnit\Framework\Attributes\Test]
+public function example(): void
+{
+    QueueWorker::fake();
+
+    $this->get('/whatever-action');
+
+    QueueWorker::assertUp(fn (QueueConfig $config) => $config->alias === 'custom');
+}
+```
+
+## Available assertions
+- `assertUp`
+- `assertDown`

resources/views/docs/1/testing/windows.md

@@ -0,0 +1,58 @@
+---
+title: Windows
+order: 100
+---
+# Fake Windows
+
+## Example test case
+
+```php
+use Native\Laravel\Facades\Window;
+use Illuminate\Support\Facades\Http;
+
+ #[\PHPUnit\Framework\Attributes\Test]
+public function example(): void
+{
+    Http::fake();
+    Window::fake();
+
+    $this->get('/whatever-action');
+
+    Window::assertOpened(fn (string $windowId) => Str::startsWith($windowId, ['window-name']));
+    Window::assertClosed('window-name');
+    Window::assertHidden('window-name');
+}
+```
+
+## Available assertions
+- `assertOpened`
+- `assertClosed`
+- `assertHidden`
+
+## Asserting against a window instance (advanced)
+
+```php
+use Illuminate\Support\Facades\Http;
+use Native\Laravel\Facades\Window;
+use Native\Laravel\Windows\Window as WindowImplementation;
+use Mockery;
+
+#[\PHPUnit\Framework\Attributes\Test]
+public function example(): void
+{
+    Http::fake();
+    Window::fake();
+    Window::alwaysReturnWindows([
+        $mockWindow = Mockery::mock(WindowImplementation::class)->makePartial(),
+    ]);
+
+    $mockWindow->shouldReceive('route')->once()->with('action')->andReturnSelf();
+    $mockWindow->shouldReceive('transparent')->once()->andReturnSelf();
+    $mockWindow->shouldReceive('height')->once()->with(500)->andReturnSelf();
+    $mockWindow->shouldReceive('width')->once()->with(775)->andReturnSelf();
+    $mockWindow->shouldReceive('minHeight')->once()->with(500)->andReturnSelf();
+    $mockWindow->shouldReceive('minWidth')->once()->with(775)->andReturnSelf();
+
+    $this->get(route('action'));
+}
+```