-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[Console] Add a stream helper #53518
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
src/Symfony/Bridge/Monolog/Tests/Command/ServerLogCommandTest.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Bridge\Monolog\Tests\Command; | ||
|
|
||
| use Monolog\Level; | ||
| use Monolog\LogRecord; | ||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Bridge\Monolog\Command\ServerLogCommand; | ||
| use Symfony\Component\Console\Helper\HelperSet; | ||
| use Symfony\Component\Console\Helper\StreamHelper; | ||
| use Symfony\Component\Console\Tester\CommandTester; | ||
|
|
||
| class ServerLogCommandTest extends TestCase | ||
| { | ||
| public function testServerLogSuccess() | ||
| { | ||
| $command = $this->createCommand(); | ||
| $commandTester = new CommandTester($command); | ||
|
|
||
| $record = new LogRecord( | ||
| new \DateTimeImmutable('2024-01-02 18:05'), | ||
| 'console', | ||
| Level::Info, | ||
| 'test log command', | ||
| ); | ||
| $recordFormatted = $record->toArray(); | ||
| $input = base64_encode(serialize($recordFormatted))."\n"; | ||
|
|
||
| $commandTester->setInputs([$input]); | ||
|
|
||
| $commandTester->execute([]); | ||
|
|
||
| $commandTester->assertCommandIsSuccessful(); | ||
|
|
||
| $output = $commandTester->getDisplay(); | ||
| $this->assertStringContainsString('18:05:00 INFO [console] test log command', $output); | ||
| } | ||
|
|
||
| private function createCommand(): ServerLogCommand | ||
| { | ||
| $command = new ServerLogCommand(); | ||
| $command->setHelperSet(new HelperSet([new StreamHelper()])); | ||
|
|
||
| return $command; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Console\Helper; | ||
|
|
||
| use Symfony\Component\Console\Exception\RuntimeException; | ||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Input\StreamableInputInterface; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
| use Symfony\Component\Console\Style\SymfonyStyle; | ||
|
|
||
| /** | ||
| * This class provides helpers to interact with the socket stream server. | ||
| * | ||
| * @author Louis-Marie Gaborit <lm.gabo@gmail.com> | ||
| */ | ||
| class StreamHelper extends Helper | ||
| { | ||
| /** | ||
| * @var resource|null | ||
| */ | ||
| private $inputStream; | ||
|
|
||
| /** | ||
| * @var resource|null | ||
| */ | ||
| private $socket; | ||
|
|
||
| private static bool $stty = true; | ||
| private static bool $stdinIsInteractive; | ||
|
|
||
| private function start(string $host): void | ||
| { | ||
| if (!$this->socket = stream_socket_server($host, $errno, $errstr)) { | ||
| throw new RuntimeException(sprintf('Server start failed on "%s": ', $host).$errstr.' '.$errno); | ||
| } | ||
| } | ||
|
|
||
| public function listen(InputInterface $input, OutputInterface $output, string $host, callable $callback): void | ||
| { | ||
| if ($input instanceof StreamableInputInterface && $stream = $input->getStream()) { | ||
| $this->inputStream = $stream; | ||
| } elseif (null === $this->socket) { | ||
| if (!str_contains($host, '://')) { | ||
| $host = 'tcp://'.$host; | ||
| } | ||
|
|
||
| $this->start($host); | ||
| } | ||
|
|
||
| $io = new SymfonyStyle($input, $output); | ||
| $errorIo = $io->getErrorStyle(); | ||
|
|
||
| $errorIo->success(sprintf('Server listening on %s', $host)); | ||
| $errorIo->comment('Quit the server with CONTROL-C.'); | ||
|
|
||
| foreach ($this->getMessages() as $clientId => $message) { | ||
| $callback($clientId, $message); | ||
| } | ||
| } | ||
|
|
||
| public function getName(): string | ||
| { | ||
| return 'stream'; | ||
| } | ||
|
|
||
| private function getMessages(): iterable | ||
| { | ||
| if (null !== $inputStream = $this->inputStream) { | ||
| while (!feof($inputStream)) { | ||
| $stream = fgets($inputStream); | ||
| yield (int) $stream => $stream; | ||
| } | ||
| } else { | ||
| $sockets = [(int) $this->socket => $this->socket]; | ||
| $write = []; | ||
|
|
||
| while (true) { | ||
| $read = $sockets; | ||
| stream_select($read, $write, $write, null); | ||
|
|
||
| foreach ($read as $stream) { | ||
| if ($this->socket === $stream) { | ||
| $stream = stream_socket_accept($this->socket); | ||
| $sockets[(int) $stream] = $stream; | ||
| } elseif (feof($stream)) { | ||
| unset($sockets[(int) $stream]); | ||
| fclose($stream); | ||
| } else { | ||
| yield (int) $stream => fgets($stream); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For this test, I can only use html because value of the dump doesn't be available in the command result. I seems that it be prompt in php stream not in the command.
@ogizanagi Could you help me to add cli format in this test ?