Merge pull request #9 from TappNetwork/update_tests

Add test stubs

Author: swilla

.github/workflows/run-tests.yml

@@ -49,7 +49,7 @@ jobs:
           COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
         run: |
           composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
-          composer update --${{ matrix.stability }} --prefer-dist --no-interaction
+          composer update --${{ matrix.stability }} --prefer-dist --no-interaction --no-progress
 
       - name: List Installed Dependencies
         run: composer show -D

PUBLISH_TESTS.md

@@ -0,0 +1,224 @@
+# Test Integration Guide
+
+This guide explains how the test stubs integrate with your Laravel application.
+
+## How It Works
+
+When you run `php artisan filament-forum:install-tests`, the command copies test files from the plugin's `stubs/tests` directory to your application's `tests/Feature` directory.
+
+### Configuration Integration
+
+The tests automatically read from your application's configuration:
+
+```php
+// In the test files
+$userModel = config('filament-forum.user.model');
+$tenantModel = config('filament-forum.tenancy.model');
+```
+
+This means the tests will use **your** User and Tenant models, not the plugin's internal test models.
+
+## Test Structure
+
+### FilamentForumTest.php
+
+Tests basic forum functionality that works with or without tenancy:
+
+```php
+it('can create a forum', function () {
+    $user = $this->userModel::factory()->create();
+    $this->actingAs($user);
+    
+    $forum = Forum::factory()->create([
+        'name' => 'Test Forum',
+    ]);
+    
+    expect($forum->name)->toBe('Test Forum');
+});
+```
+
+### FilamentForumTenancyTest.php
+
+Tests multi-tenancy features and automatically skips if tenancy is disabled:
+
+```php
+beforeEach(function () {
+    if (! config('filament-forum.tenancy.enabled')) {
+        $this->markTestSkipped('Tenancy is not enabled');
+    }
+    // ...
+});
+```
+
+## Dynamic Tenant Column Names
+
+The tests use the plugin's helper methods to get the correct tenant relationship and column names:
+
+```php
+// Get the tenant relationship name (e.g., 'team', 'organization', 'company')
+$tenantRelationship = Forum::getTenantRelationshipName();
+
+// Get the tenant column name (e.g., 'team_id', 'organization_id', 'company_id')
+$tenantColumn = Forum::getTenantRelationshipName() . '_id';
+```
+
+This ensures tests work regardless of what you name your tenant model.
+
+## Example Scenarios
+
+### Scenario 1: Using Team Model
+
+```php
+// config/filament-forum.php
+'tenancy' => [
+    'enabled' => true,
+    'model' => App\Models\Team::class,
+],
+```
+
+Tests will:
+- Use `App\Models\Team::factory()` to create tenants
+- Look for `team_id` column in tables
+- Use `team()` relationship method
+
+### Scenario 2: Using Organization Model
+
+```php
+// config/filament-forum.php
+'tenancy' => [
+    'enabled' => true,
+    'model' => App\Models\Organization::class,
+],
+```
+
+Tests will:
+- Use `App\Models\Organization::factory()` to create tenants
+- Look for `organization_id` column in tables
+- Use `organization()` relationship method
+
+### Scenario 3: No Tenancy
+
+```php
+// config/filament-forum.php
+'tenancy' => [
+    'enabled' => false,
+],
+```
+
+Tests will:
+- Run all basic tests from `FilamentForumTest.php`
+- Skip all tests in `FilamentForumTenancyTest.php`
+
+## Customizing Tests
+
+The published tests are meant to be modified for your needs. Here are some common customizations:
+
+### Adding Custom Fields
+
+```php
+it('can create a forum with custom fields', function () {
+    $user = $this->userModel::factory()->create();
+    $this->actingAs($user);
+    
+    $forum = Forum::factory()->create([
+        'name' => 'Test Forum',
+        'slug' => 'test-forum',
+        'custom_field' => 'custom value', // Your custom field
+    ]);
+    
+    expect($forum->custom_field)->toBe('custom value');
+});
+```
+
+### Testing Custom Permissions
+
+```php
+it('respects forum permissions', function () {
+    $user = $this->userModel::factory()->create();
+    $admin = $this->userModel::factory()->create(['role' => 'admin']);
+    
+    $this->actingAs($user);
+    
+    $this->assertDatabaseMissing('forums', ['name' => 'Admin Forum']);
+    
+    $this->actingAs($admin);
+    
+    $forum = Forum::factory()->create(['name' => 'Admin Forum']);
+    
+    expect($forum)->toBeInstanceOf(Forum::class);
+});
+```
+
+### Testing with Multiple Tenants
+
+```php
+it('can handle multiple tenant memberships', function () {
+    $user = $this->userModel::factory()->create();
+    $tenant1 = $this->tenantModel::factory()->create();
+    $tenant2 = $this->tenantModel::factory()->create();
+    
+    // Add user to both tenants (implement based on your membership logic)
+    $user->teams()->attach([$tenant1->id, $tenant2->id]);
+    
+    $this->actingAs($user);
+    
+    // Test tenant switching
+    Filament::setTenant($tenant1);
+    expect(Filament::getTenant()->id)->toBe($tenant1->id);
+    
+    Filament::setTenant($tenant2);
+    expect(Filament::getTenant()->id)->toBe($tenant2->id);
+});
+```
+
+## Best Practices
+
+1. **Run tests after publishing**: Immediately after running `filament-forum:install-tests`, run the tests to verify they work with your setup
+2. **Customize for your needs**: The stubs are a starting point - modify them to match your application's requirements
+3. **Keep tests in sync**: When you upgrade the plugin, review the test stubs for any changes
+4. **Use factories**: Ensure your User and Tenant models have proper factories for reliable testing
+5. **Test edge cases**: Add tests for your specific business logic and edge cases
+
+## Troubleshooting
+
+### Tests fail with "Factory not found"
+
+Create factories for your models:
+
+```bash
+php artisan make:factory UserFactory --model=User
+php artisan make:factory TeamFactory --model=Team
+```
+
+### Tests fail with "Table not found"
+
+Run migrations in your test environment:
+
+```bash
+php artisan migrate --env=testing
+```
+
+Or configure in-memory SQLite in `phpunit.xml`:
+
+```xml
+<env name="DB_CONNECTION" value="sqlite"/>
+<env name="DB_DATABASE" value=":memory:"/>
+```
+
+Or add your test database in `phpunit.xml`:
+
+```xml
+<env name="APP_ENV" value="testing"/>
+<env name="DB_DATABASE" value="myapp_test"/>
+```
+
+### Tenancy tests always skip
+
+Verify configuration:
+
+```bash
+php artisan config:clear
+php artisan tinker
+>>> config('filament-forum.tenancy.enabled')
+=> true
+```

README.md

@@ -514,6 +514,35 @@ class UserMentionedNotification extends Notification
 }
 ```
 
+## Testing
+
+### Publishing Tests to Your Application
+
+You can publish ready-to-use test files to your application to test the Filament Forum functionality:
+
+```bash
+php artisan filament-forum:install-tests
+```
+
+This will copy test files to your `tests/Feature` directory:
+- `FilamentForumTest.php` - Basic forum and post functionality tests
+- `FilamentForumTenancyTest.php` - Multi-tenancy specific tests (automatically skipped if tenancy is disabled)
+
+The tests are written using [Pest](https://pestphp.com/) and automatically use your configured User and Tenant models from `config/filament-forum.php`.
+
+**Requirements:**
+- Pest testing framework: `composer require pestphp/pest --dev`
+- Model factories for your User model and Tenant model (if using tenancy)
+
+**Run the tests:**
+```bash
+php artisan test --filter=FilamentForum
+```
+
+See the published tests for more examples of how to test the plugin in your application.
+
+Read more about publishing tests [here](PUBLISH_TESTS.md).
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

…reate_favorite_forum_post_table.php.stub …ons/create_favorite_forum_post_table.phpdatabase/migrations/create_favorite_forum_post_table.php.stub renamed to database/migrations/create_favorite_forum_post_table.php database/migrations/create_favorite_forum_post_table.php.stub renamed to database/migrations/create_favorite_forum_post_table.php

@@ -36,4 +36,3 @@ public function down(): void
         Schema::dropIfExists('favorite_forum_post');
     }
 };
- 

…e_forum_comment_reactions_table.php.stub …create_forum_comment_reactions_table.phpdatabase/migrations/create_forum_comment_reactions_table.php.stub renamed to database/migrations/create_forum_comment_reactions_table.php database/migrations/create_forum_comment_reactions_table.php.stub renamed to database/migrations/create_forum_comment_reactions_table.php

@@ -21,13 +21,13 @@ public function up(): void
 
             $table->foreignId('forum_comment_id')->constrained()->cascadeOnDelete();
             $table->morphs('reactor');
-            
+
             if (config('database.default') === 'mysql') {
                 $table->string('type', 50)->collation('utf8mb4_bin');
             } else {
                 $table->string('type', 50);
             }
-            
+
             $table->timestamps();
 
             $table->unique(['forum_comment_id', 'reactor_type', 'reactor_id', 'type'], 'unique_comment_reaction');

…ons/create_forum_comments_table.php.stub …grations/create_forum_comments_table.phpdatabase/migrations/create_forum_comments_table.php.stub renamed to database/migrations/create_forum_comments_table.php database/migrations/create_forum_comments_table.php.stub renamed to database/migrations/create_forum_comments_table.php

@@ -33,4 +33,3 @@ public function down(): void
         Schema::dropIfExists('forum_post_views');
     }
 };
- 

…s/create_forum_post_views_table.php.stub …ations/create_forum_post_views_table.phpdatabase/migrations/create_forum_post_views_table.php.stub renamed to database/migrations/create_forum_post_views_table.php database/migrations/create_forum_post_views_table.php.stub renamed to database/migrations/create_forum_post_views_table.php

@@ -37,4 +37,3 @@ public function down(): void
         Schema::dropIfExists('forums');
     }
 };
- 

…ations/create_forum_posts_table.php.stub …/migrations/create_forum_posts_table.phpdatabase/migrations/create_forum_posts_table.php.stub renamed to database/migrations/create_forum_posts_table.php database/migrations/create_forum_posts_table.php.stub renamed to database/migrations/create_forum_posts_table.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace Tapp\FilamentForum\Console;
+
+use Illuminate\Console\Command;
+use Illuminate\Filesystem\Filesystem;
+
+class InstallTestsCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     */
+    protected $signature = 'filament-forum:install-tests
+                            {--force : Overwrite existing test files}';
+
+    /**
+     * The console command description.
+     */
+    protected $description = 'Install Filament Forum test files into your application';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): int
+    {
+        $filesystem = new Filesystem;
+
+        // Ensure tests directory exists
+        $filesystem->ensureDirectoryExists(base_path('tests/Feature'));
+
+        // Copy test files
+        $testFiles = [
+            'FilamentForumTest.php',
+            'FilamentForumTenancyTest.php',
+        ];
+
+        foreach ($testFiles as $testFile) {
+            $source = __DIR__.'/../../stubs/tests/Feature/'.$testFile;
+            $destination = base_path('tests/Feature/'.$testFile);
+
+            if (file_exists($destination) && ! $this->option('force')) {
+                if (! $this->confirm("The file {$testFile} already exists. Do you want to overwrite it?")) {
+                    $this->components->info("Skipped: {$testFile}");
+
+                    continue;
+                }
+            }
+
+            $filesystem->copy($source, $destination);
+            $this->components->info("Published: {$testFile}");
+        }
+
+        $this->newLine();
+        $this->components->info('Filament Forum tests published successfully!');
+        $this->newLine();
+
+        // Show next steps
+        $this->line('Next steps:');
+        $this->line('1. Make sure you have Pest installed: composer require pestphp/pest --dev');
+        $this->line('2. Run the tests: php artisan test --filter=FilamentForum');
+        $this->newLine();
+
+        // Check if tenancy is enabled and show relevant message
+        if (config('filament-forum.tenancy.enabled')) {
+            $tenantModel = config('filament-forum.tenancy.model');
+            $this->components->info("Tenancy is enabled with model: {$tenantModel}");
+            $this->line('Make sure your tenant model has a factory for the tenancy tests to work.');
+        } else {
+            $this->components->warn('Tenancy is not enabled. Tenancy tests will be skipped.');
+            $this->line('To enable tenancy, set filament-forum.tenancy.enabled to true in your config.');
+        }
+
+        $this->newLine();
+
+        return self::SUCCESS;
+    }
+}