feature symfony#60024 [Console] Add support for invokable commands in LockableTrait (yceruto)

This PR was merged into the 7.3 branch.

Discussion
----------

[Console] Add support for invokable commands in `LockableTrait`

| Q             | A
| ------------- | ---
| Branch?       | 7.3
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Issues        | -
| License       | MIT

This enables invokable commands to use `LockableTrait` without extending the `Command` class:
```php
use Symfony\Component\Console\Command\LockableTrait;

#[AsCommand(name: 'foo:lock')]
class FooLockCommand
{
    use LockableTrait;

    public function __invoke(): int
    {
        if (!$this->lock()) {
            return Command::FAILURE;
        }

        // exclusive logic starts here...

        $this->release();

        return Command::SUCCESS;
    }
}
```
Ref: https://symfony.com/doc/current/console/lockable_trait.html

Commits
-------

5595a32 Add support for invokable commands in LockableTrait

Author: fabpot

src/Symfony/Component/Console/CHANGELOG.md

@@ -11,6 +11,7 @@ CHANGELOG
  * Add support for help definition via `AsCommand` attribute
  * Deprecate methods `Command::getDefaultName()` and `Command::getDefaultDescription()` in favor of the `#[AsCommand]` attribute
  * Add support for Markdown format in `Table`
+ * Add support for `LockableTrait` in invokable commands
 
 7.2
 ---

src/Symfony/Component/Console/Command/LockableTrait.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Console\Command;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Exception\LogicException;
 use Symfony\Component\Lock\LockFactory;
 use Symfony\Component\Lock\LockInterface;
@@ -48,10 +49,20 @@ private function lock(?string $name = null, bool $blocking = false): bool
                 $store = new FlockStore();
             }
 
-            $this->lockFactory = (new LockFactory($store));
+            $this->lockFactory = new LockFactory($store);
         }
 
-        $this->lock = $this->lockFactory->createLock($name ?: $this->getName());
+        if (!$name) {
+            if ($this instanceof Command) {
+                $name = $this->getName();
+            } elseif ($attribute = (new \ReflectionClass($this::class))->getAttributes(AsCommand::class)) {
+                $name = $attribute[0]->newInstance()->name;
+            } else {
+                throw new LogicException(\sprintf('Lock name missing: provide it via "%s()", #[AsCommand] attribute, or by extending Command class.', __METHOD__));
+            }
+        }
+
+        $this->lock = $this->lockFactory->createLock($name);
         if (!$this->lock->acquire($blocking)) {
             $this->lock = null;
 

src/Symfony/Component/Console/Tests/Command/LockableTraitTest.php

@@ -12,6 +12,7 @@
 namespace Symfony\Component\Console\Tests\Command;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Tester\CommandTester;
 use Symfony\Component\Lock\LockFactory;
 use Symfony\Component\Lock\SharedLockInterface;
@@ -28,6 +29,7 @@ public static function setUpBeforeClass(): void
         require_once self::$fixturesPath.'/FooLockCommand.php';
         require_once self::$fixturesPath.'/FooLock2Command.php';
         require_once self::$fixturesPath.'/FooLock3Command.php';
+        require_once self::$fixturesPath.'/FooLock4InvokableCommand.php';
     }
 
     public function testLockIsReleased()
@@ -80,4 +82,25 @@ public function testCustomLockFactoryIsUsed()
         $lockFactory->expects(static::once())->method('createLock')->willReturn($lock);
         $this->assertSame(1, $tester->execute([]));
     }
+
+    public function testLockInvokableCommandReturnsFalseIfAlreadyLockedByAnotherCommand()
+    {
+        $command = new Command('foo:lock4');
+        $command->setCode(new \FooLock4InvokableCommand());
+
+        if (SemaphoreStore::isSupported()) {
+            $store = new SemaphoreStore();
+        } else {
+            $store = new FlockStore();
+        }
+
+        $lock = (new LockFactory($store))->createLock($command->getName());
+        $lock->acquire();
+
+        $tester = new CommandTester($command);
+        $this->assertSame(Command::FAILURE, $tester->execute([]));
+
+        $lock->release();
+        $this->assertSame(Command::SUCCESS, $tester->execute([]));
+    }
 }

src/Symfony/Component/Console/Tests/Fixtures/FooLock4InvokableCommand.php

@@ -0,0 +1,22 @@
+<?php
+
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Command\LockableTrait;
+
+#[AsCommand(name: 'foo:lock4')]
+class FooLock4InvokableCommand
+{
+    use LockableTrait;
+
+    public function __invoke(): int
+    {
+        if (!$this->lock()) {
+            return Command::FAILURE;
+        }
+
+        $this->release();
+
+        return Command::SUCCESS;
+    }
+}