Merge branch 'master' of https://github.com/archtechx/tenancy into add-skip-failing-options-to-migrate

src/Commands/Down.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Commands;
+
+use Illuminate\Foundation\Console\DownCommand;
+use Stancl\Tenancy\Concerns\HasATenantsOption;
+
+class Down extends DownCommand
+{
+    use HasATenantsOption;
+
+    protected $signature = 'tenants:down
+         {--redirect= : The path that users should be redirected to}
+         {--retry= : The number of seconds after which the request may be retried}
+         {--refresh= : The number of seconds after which the browser may refresh}
+         {--secret= : The secret phrase that may be used to bypass maintenance mode}
+         {--status=503 : The status code that should be used when returning the maintenance mode response}';
+
+    protected $description = 'Put tenants into maintenance mode.';
+
+    public function handle(): int
+    {
+        // The base down command is heavily used. Instead of saving the data inside a file,
+        // the data is stored the tenant database, which means some Laravel features
+        // are not available with tenants.
+
+        $payload = $this->getDownDatabasePayload();
+
+        // This runs for all tenants if no --tenants are specified
+        tenancy()->runForMultiple($this->getTenants(), function ($tenant) use ($payload) {
+            $this->line("Tenant: {$tenant['id']}");
+            $tenant->putDownForMaintenance($payload);
+        });
+
+        $this->comment('Tenants are now in maintenance mode.');
+
+        return 0;
+    }
+
+    /** Get the payload to be placed in the "down" file. */
+    protected function getDownDatabasePayload(): array
+    {
+        return [
+            'except' => $this->excludedPaths(),
+            'redirect' => $this->redirectPath(),
+            'retry' => $this->getRetryTime(),
+            'refresh' => $this->option('refresh'),
+            'secret' => $this->option('secret'),
+            'status' => (int) ($this->option('status') ?? 503),
+        ];
+    }
+}

src/Commands/Install.php

@@ -8,24 +8,11 @@ use Illuminate\Console\Command;
 
 class Install extends Command
 {
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
     protected $signature = 'tenancy:install';
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
     protected $description = 'Install stancl/tenancy.';
 
-    /**
-     * Execute the console command.
-     */
-    public function handle()
+    public function handle(): void
     {
         $this->comment('Installing stancl/tenancy...');
         $this->callSilent('vendor:publish', [

src/Commands/Link.php

@@ -15,30 +15,15 @@ class Link extends Command
 {
     use HasATenantsOption;
 
-    /**
-     * The console command signature.
-     *
-     * @var string
-     */
     protected $signature = 'tenants:link
                 {--tenants=* : The tenant(s) to run the command for. Default: all}
                 {--relative : Create the symbolic link using relative paths}
                 {--force : Recreate existing symbolic links}
                 {--remove : Remove symbolic links}';
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
     protected $description = 'Create or remove tenant symbolic links.';
 
-    /**
-     * Execute the console command.
-     *
-     * @return void
-     */
-    public function handle()
+    public function handle(): void
     {
         $tenants = $this->getTenants();
 
@@ -64,8 +49,8 @@ class Link extends Command
     {
         CreateStorageSymlinksAction::handle(
             $tenants,
-            $this->option('relative') ?? false,
-            $this->option('force') ?? false,
+            (bool) ($this->option('relative') ?? false),
+            (bool) ($this->option('force') ?? false),
         );
 
         $this->info('The links have been created.');

src/Commands/Migrate.php

@@ -17,7 +17,7 @@ use Stancl\Tenancy\Events\MigratingDatabase;
 
 class Migrate extends MigrateCommand
 {
-    use HasATenantsOption, DealsWithMigrations, ExtendsLaravelCommand;
+    use HasATenantsOption, ExtendsLaravelCommand;
 
     protected $description = 'Run migrations for tenant(s)';
 
@@ -35,10 +35,7 @@ class Migrate extends MigrateCommand
         $this->specifyParameters();
     }
 
-    /**
-     * Execute the console command.
-     */
-    public function handle()
+    public function handle(): int
     {
         foreach (config('tenancy.migration_parameters') as $parameter => $value) {
             if (! $this->input->hasParameterOption($parameter)) {
@@ -47,7 +44,7 @@ class Migrate extends MigrateCommand
         }
 
         if (! $this->confirmToProceed()) {
-            return;
+            return 1;
         }
 
         try {

src/Commands/MigrateFresh.php

@@ -5,19 +5,13 @@ declare(strict_types=1);
 namespace Stancl\Tenancy\Commands;
 
 use Illuminate\Console\Command;
-use Stancl\Tenancy\Concerns\DealsWithMigrations;
 use Stancl\Tenancy\Concerns\HasATenantsOption;
 use Symfony\Component\Console\Input\InputOption;
 
 final class MigrateFresh extends Command
 {
-    use HasATenantsOption, DealsWithMigrations;
+    use HasATenantsOption;
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
     protected $description = 'Drop all tables and re-run all migrations for tenant(s)';
 
     public function __construct()
@@ -29,12 +23,9 @@ final class MigrateFresh extends Command
         $this->setName('tenants:migrate-fresh');
     }
 
-    /**
-     * Execute the console command.
-     */
-    public function handle()
+    public function handle(): void
     {
-        tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
+        tenancy()->runForMultiple($this->getTenants(), function ($tenant) {
             $this->info('Dropping tables.');
             $this->call('db:wipe', array_filter([
                 '--database' => 'tenant',

src/Commands/Rollback.php

@@ -6,7 +6,6 @@ namespace Stancl\Tenancy\Commands;
 
 use Illuminate\Database\Console\Migrations\RollbackCommand;
 use Illuminate\Database\Migrations\Migrator;
-use Stancl\Tenancy\Concerns\DealsWithMigrations;
 use Stancl\Tenancy\Concerns\ExtendsLaravelCommand;
 use Stancl\Tenancy\Concerns\HasATenantsOption;
 use Stancl\Tenancy\Events\DatabaseRolledBack;
@@ -14,25 +13,10 @@ use Stancl\Tenancy\Events\RollingBackDatabase;
 
 class Rollback extends RollbackCommand
 {
-    use HasATenantsOption, DealsWithMigrations, ExtendsLaravelCommand;
+    use HasATenantsOption, ExtendsLaravelCommand;
 
-    protected static function getTenantCommandName(): string
-    {
-        return 'tenants:rollback';
-    }
-
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
     protected $description = 'Rollback migrations for tenant(s).';
 
-    /**
-     * Create a new command instance.
-     *
-     * @return void
-     */
     public function __construct(Migrator $migrator)
     {
         parent::__construct($migrator);
@@ -40,10 +24,7 @@ class Rollback extends RollbackCommand
         $this->specifyTenantSignature();
     }
 
-    /**
-     * Execute the console command.
-     */
-    public function handle()
+    public function handle(): int
     {
         foreach (config('tenancy.migration_parameters') as $parameter => $value) {
             if (! $this->input->hasParameterOption($parameter)) {
@@ -52,10 +33,10 @@ class Rollback extends RollbackCommand
         }
 
         if (! $this->confirmToProceed()) {
-            return;
+            return 1;
         }
 
-        tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
+        tenancy()->runForMultiple($this->getTenants(), function ($tenant) {
             $this->line("Tenant: {$tenant->getTenantKey()}");
 
             event(new RollingBackDatabase($tenant));
@@ -65,5 +46,12 @@ class Rollback extends RollbackCommand
 
             event(new DatabaseRolledBack($tenant));
         });
+
+        return 0;
+    }
+
+    protected static function getTenantCommandName(): string
+    {
+        return 'tenants:rollback';
     }
 }

src/Commands/Run.php

@@ -6,33 +6,24 @@ namespace Stancl\Tenancy\Commands;
 
 use Illuminate\Console\Command;
 use Illuminate\Contracts\Console\Kernel;
+use Stancl\Tenancy\Concerns\HasATenantsOption;
 use Symfony\Component\Console\Input\ArgvInput;
 use Symfony\Component\Console\Output\ConsoleOutput;
 
 class Run extends Command
 {
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
+    use HasATenantsOption;
+
     protected $description = 'Run a command for tenant(s)';
 
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
     protected $signature = 'tenants:run {commandname : The artisan command.}
                             {--tenants=* : The tenant(s) to run the command for. Default: all}';
 
-    /**
-     * Execute the console command.
-     */
-    public function handle()
+    public function handle(): void
     {
-        $argvInput = $this->ArgvInput();
-        tenancy()->runForMultiple($this->option('tenants'), function ($tenant) use ($argvInput) {
+        $argvInput = $this->argvInput();
+
+        tenancy()->runForMultiple($this->getTenants(), function ($tenant) use ($argvInput) {
             $this->line("Tenant: {$tenant->getTenantKey()}");
 
             $this->getLaravel()
@@ -41,17 +32,17 @@ class Run extends Command
         });
     }
 
-    /**
-     * Get command as ArgvInput instance.
-     */
-    protected function ArgvInput(): ArgvInput
+    protected function argvInput(): ArgvInput
     {
+        /** @var string $commandname */
+        $commandname = $this->argument('commandname');
+
         // Convert string command to array
-        $subCommand = explode(' ', $this->argument('commandname'));
+        $subcommand = explode(' ', $commandname);
 
         // Add "artisan" as first parameter because ArgvInput expects "artisan" as first parameter and later removes it
-        array_unshift($subCommand, 'artisan');
+        array_unshift($subcommand, 'artisan');
 
-        return new ArgvInput($subCommand);
+        return new ArgvInput($subcommand);
     }
 }

src/Commands/Seed.php

@@ -14,29 +14,16 @@ class Seed extends SeedCommand
 {
     use HasATenantsOption;
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
     protected $description = 'Seed tenant database(s).';
 
     protected $name = 'tenants:seed';
 
-    /**
-     * Create a new command instance.
-     *
-     * @return void
-     */
     public function __construct(ConnectionResolverInterface $resolver)
     {
         parent::__construct($resolver);
     }
 
-    /**
-     * Execute the console command.
-     */
-    public function handle()
+    public function handle(): int
     {
         foreach (config('tenancy.seeder_parameters') as $parameter => $value) {
             if (! $this->input->hasParameterOption($parameter)) {
@@ -45,10 +32,10 @@ class Seed extends SeedCommand
         }
 
         if (! $this->confirmToProceed()) {
-            return;
+            return 1;
         }
 
-        tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
+        tenancy()->runForMultiple($this->getTenants(), function ($tenant) {
             $this->line("Tenant: {$tenant->getTenantKey()}");
 
             event(new SeedingDatabase($tenant));
@@ -58,5 +45,7 @@ class Seed extends SeedCommand
 
             event(new DatabaseSeeded($tenant));
         });
+
+        return 0;
     }
 }

src/Commands/TenantList.php

@@ -5,39 +5,28 @@ declare(strict_types=1);
 namespace Stancl\Tenancy\Commands;
 
 use Illuminate\Console\Command;
+use Illuminate\Database\Eloquent\Model;
 use Stancl\Tenancy\Contracts\Tenant;
 
 class TenantList extends Command
 {
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
     protected $signature = 'tenants:list';
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
     protected $description = 'List tenants.';
 
-    /**
-     * Execute the console command.
-     */
-    public function handle()
+    public function handle(): void
     {
         $this->info('Listing all tenants.');
-        tenancy()
-            ->query()
-            ->cursor()
-            ->each(function (Tenant $tenant) {
-                if ($tenant->domains) {
-                    $this->line("[Tenant] {$tenant->getTenantKeyName()}: {$tenant->getTenantKey()} @ " . implode('; ', $tenant->domains->pluck('domain')->toArray() ?? []));
-                } else {
-                    $this->line("[Tenant] {$tenant->getTenantKeyName()}: {$tenant->getTenantKey()}");
-                }
-            });
+
+        $tenants = tenancy()->query()->cursor();
+
+        foreach ($tenants as $tenant) {
+            /** @var Model&Tenant $tenant */
+            if ($tenant->domains) {
+                $this->line("[Tenant] {$tenant->getTenantKeyName()}: {$tenant->getTenantKey()} @ " . implode('; ', $tenant->domains->pluck('domain')->toArray() ?? []));
+            } else {
+                $this->line("[Tenant] {$tenant->getTenantKeyName()}: {$tenant->getTenantKey()}");
+            }
+        }
     }
 }

src/Commands/Up.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Commands;
+
+use Illuminate\Console\Command;
+use Stancl\Tenancy\Concerns\HasATenantsOption;
+
+class Up extends Command
+{
+    use HasATenantsOption;
+
+    protected $signature = 'tenants:up';
+
+    protected $description = 'Put tenants out of maintenance mode.';
+
+    public function handle(): void
+    {
+        tenancy()->runForMultiple($this->getTenants(), function ($tenant) {
+            $this->line("Tenant: {$tenant['id']}");
+            $tenant->bringUpFromMaintenance();
+        });
+
+        $this->comment('Tenants are now out of maintenance mode.');
+    }
+}