[9.x] Return exit status instead of booleans from GeneratorCommand::handle() (#43915)

* test it should fail if name argument is a reserved word

* return exit status instead of bool values

- Failure: `1`
- Success: `0`

* replace array access with make calls

- makes it easier to test

* test it should generate the requested class

* fix styling

* fix typo

Author: imdhemy

src/Illuminate/Console/GeneratorCommand.php

@@ -3,6 +3,7 @@
 namespace Illuminate\Console;
 
 use Illuminate\Console\Concerns\CreatesMatchingTest;
+use Illuminate\Contracts\Container\BindingResolutionException;
 use Illuminate\Filesystem\Filesystem;
 use Illuminate\Support\Str;
 use Symfony\Component\Console\Input\InputArgument;
@@ -137,7 +138,7 @@ abstract protected function getStub();
     /**
      * Execute the console command.
      *
-     * @return bool|null
+     * @return int|void
      *
      * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
      */
@@ -149,7 +150,7 @@ public function handle()
         if ($this->isReservedName($this->getNameInput())) {
             $this->components->error('The name "'.$this->getNameInput().'" is reserved by PHP.');
 
-            return false;
+            return self::FAILURE;
         }
 
         $name = $this->qualifyClass($this->getNameInput());
@@ -164,7 +165,7 @@ public function handle()
              $this->alreadyExists($this->getNameInput())) {
             $this->components->error($this->type.' already exists.');
 
-            return false;
+            return self::FAILURE;
         }
 
         // Next, we will generate the path to the location where this class' file should get
@@ -183,6 +184,8 @@ public function handle()
         }
 
         $this->components->info($info.' created successfully.');
+
+        return self::SUCCESS;
     }
 
     /**
@@ -258,12 +261,14 @@ protected function alreadyExists($rawName)
      *
      * @param  string  $name
      * @return string
+     *
+     * @throws BindingResolutionException
      */
     protected function getPath($name)
     {
         $name = Str::replaceFirst($this->rootNamespace(), '', $name);
 
-        return $this->laravel['path'].'/'.str_replace('\\', '/', $name).'.php';
+        return $this->laravel->make('path').'/'.str_replace('\\', '/', $name).'.php';
     }
 
     /**
@@ -390,10 +395,12 @@ protected function rootNamespace()
      * Get the model for the default guard's user provider.
      *
      * @return string|null
+     *
+     * @throws BindingResolutionException
      */
     protected function userProviderModel()
     {
-        $config = $this->laravel['config'];
+        $config = $this->laravel->make('config');
 
         $provider = $config->get('auth.guards.'.$config->get('auth.defaults.guard').'.provider');
 

tests/Console/GeneratorCommandTest.php

@@ -0,0 +1,113 @@
+<?php
+
+namespace Illuminate\Tests\Console;
+
+use Illuminate\Config\Repository;
+use Illuminate\Console\GeneratorCommand;
+use Illuminate\Console\OutputStyle;
+use Illuminate\Console\View\Components\Factory;
+use Illuminate\Contracts\Filesystem\FileNotFoundException;
+use Illuminate\Contracts\Foundation\Application;
+use Illuminate\Filesystem\Filesystem;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Exception\RuntimeException;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Output\NullOutput;
+
+class GeneratorCommandTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function itShouldThrowIfNameIsNotPassedAsArgument(): void
+    {
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Not enough arguments (missing: "name").');
+
+        $sut = $this->getMockForAbstractClass(
+            GeneratorCommand::class,
+            [$this->createStub(Filesystem::class)],
+            'FooMakeCommand'
+        );
+        $sut->setLaravel(app());
+
+        $input = new ArrayInput([]);
+        $output = new NullOutput();
+
+        $sut->run($input, $output);
+    }
+
+    /**
+     * @test
+     */
+    public function itShouldFailIfNameArgumentIsReservedName(): void
+    {
+        $sut = $this->getMockForAbstractClass(
+            GeneratorCommand::class,
+            [$this->createStub(Filesystem::class)],
+            'FooMakeCommand'
+        );
+        $sut->setLaravel(app());
+
+        $input = new ArrayInput(['name' => 'class']);
+        $output = new NullOutput();
+
+        $this->assertSame(Command::FAILURE, $sut->run($input, $output));
+    }
+
+    /**
+     * @test
+     *
+     * @throws FileNotFoundException
+     */
+    public function itShouldGenerateTheRequestedClass(): void
+    {
+        $appPath = '/path/to/app';
+        $nameArgument = 'MyFoo';
+
+        $fileSystem = $this->createStub(Filesystem::class);
+        $stub = '<?php namespace DummyNamespace; class DummyClass {}';
+        $fileSystem->method('get')->willReturn($stub);
+
+        // @phpstan-ignore-next-line
+        $fileSystem->expects($this->once())->method('put')->with(
+            sprintf('%s//%s.php', $appPath, $nameArgument),
+            '<?php namespace App; class MyFoo {}'
+        )->willReturn(0);
+
+        $sut = $this->getMockForAbstractClass(
+            GeneratorCommand::class,
+            [$fileSystem],
+            'FooMakeCommand'
+        );
+
+        $laravel = $this->createStub(Application::class);
+        $config = new Repository();
+        $config->set('auth', [
+            'defaults'=> ['guard' => 'web'],
+            'guards' => ['web' => ['provider' => 'users']],
+            'providers' => ['users' => ['model' => 'App\User']],
+        ]);
+
+        $laravel->method('make')->willReturnOnConsecutiveCalls(
+            $this->createStub(OutputStyle::class),
+            $this->createStub(Factory::class),
+            $appPath,
+            null,
+            $config,
+            $config,
+            $config,
+        );
+        $laravel->method('getNamespace')->willReturn('App');
+
+        $sut->setLaravel($laravel);
+
+        $input = new ArrayInput(['name' => 'MyFoo']);
+        $output = new NullOutput();
+
+        $sut->run($input, $output);
+
+        $this->assertSame(Command::SUCCESS, $sut->handle());
+    }
+}