Console command

Author: GwendolenLynch

README.md

@@ -20,3 +20,22 @@ $ composer require --dev camelot/smtp-dev-server
 
 Use
 ---
+
+To start the server, simply run:
+
+```console
+$ vendor/bin/smtp-dev-server
+```
+
+This will output all incoming request data to STDOUT.
+
+**NOTE:** Currently the server will also log transactions to `./var/log/smtp.log`
+
+Options
+-------
+
+```
+  -i, --ip=IP      TCP/IP address [default: "127.0.0.1"]
+  -p, --port=PORT  Port [default: 2525]
+  -h, --help       Show help
+```

bin/smtp-dev-server

@@ -0,0 +1,66 @@
+#!/usr/bin/env php
+<?php
+
+use Camelot\SmtpDevServer\Server;
+use Monolog\Handler\StreamHandler;
+use Monolog\Level;
+use Monolog\Logger;
+use Symfony\Component\Console\Descriptor\TextDescriptor;
+use Symfony\Component\Console\Input\ArgvInput;
+use Symfony\Component\Console\Input\InputDefinition;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\ConsoleOutput;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+$run = function (): void {
+    if (is_file(dirname(__DIR__) . '/vendor/autoload.php')) {
+        require_once dirname(__DIR__) . '/vendor/autoload.php';
+        $logDir = dirname(__DIR__) . '/var/log/smtp.log';
+    } elseif (is_file(dirname(__DIR__, 3) . '/autoload.php')) {
+        require_once dirname(__DIR__, 3) . '/autoload.php';
+        $logDir = dirname(__DIR__, 3) . '/var/log/smtp.log';
+    } else {
+        throw new LogicException('Composer autoload is missing. Try running "composer install".');
+    }
+
+    $inputDefinition = new InputDefinition();
+    $inputDefinition->addOption(new InputOption('ip', 'i', InputOption::VALUE_REQUIRED, 'TCP/IP address', '127.0.0.1'));
+    $inputDefinition->addOption(new InputOption('port', 'p', InputOption::VALUE_REQUIRED, 'Port', 2525));
+    $inputDefinition->addOption(new InputOption('help', 'h', InputOption::VALUE_NONE, 'Show help'));
+
+    $input = new ArgvInput(null, $inputDefinition);
+    $output = new ConsoleOutput();
+    $io = new SymfonyStyle($input, $output);
+
+    if ($input->getOption('help')) {
+        $io->writeln(
+            <<<'EOF'
+
+                The <info>smtp-dev-server</info> command runs a "fake" SMTP server for development testing needs.
+
+                EOF
+        );
+        $descriptor = new TextDescriptor();
+        $descriptor->describe($output, $inputDefinition);
+        $io->writeln(PHP_EOL);
+
+        return;
+    }
+
+    $host = $input->getOption('ip');
+    $port = $input->getOption('port');
+
+    $io->title("Starting SMTP server on {$host} {$port}");
+
+    $logger = new Logger('smtp');
+    $logger->pushHandler(new StreamHandler($logDir, Level::Debug));
+    $server = new Server($host, $port, $logger);
+    $server->start();
+    $io->info('Waiting for connections');
+
+    $server->listen(function ($clientId, $message) use ($io): void {
+        $io->writeln(trim($message));
+    });
+};
+
+$run();

src/Command/SmtpServerCommand.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Camelot\SmtpDevServer\Command;
+
+use Camelot\SmtpDevServer\Server;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+#[AsCommand(
+    name: 'smtp:server:start',
+    description: 'Start an SMTP server.',
+)]
+class SmtpServerCommand extends Command
+{
+    private ?LoggerInterface $logger;
+
+    public function __construct(?LoggerInterface $logger = null)
+    {
+        parent::__construct();
+        $this->logger = $logger;
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->addOption('ip', 'i', InputOption::VALUE_REQUIRED, 'TCP/IP address', 'localhost')
+            ->addOption('port', 'p', InputOption::VALUE_REQUIRED, 'Port', 2525)
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $ip = $input->getOption('ip');
+        $port = $input->getOption('port');
+
+        $io = new SymfonyStyle($input, $output);
+        $io->title("Starting SMTP server on {$ip} {$port}");
+
+        $server = new Server($ip, $port, $this->logger);
+        $server->start();
+        $io->info('Waiting for connections …');
+
+        $server->listen(function ($clientId, $message) use ($output): void {
+            $output->writeln(trim($message));
+        });
+
+        return Command::SUCCESS;
+    }
+}

src/Server.php

@@ -27,7 +27,7 @@ final class Server
     /** @var SmtpSocket[] */
     private array $sockets = [];
 
-    public function __construct(string $host, int $port = 2525, LoggerInterface $logger = null)
+    public function __construct(string $host = 'localhost', int $port = 2525, LoggerInterface $logger = null)
     {
         if (!str_contains($host, '://')) {
             $host = 'tcp://' . $host . ($port ? ':' . $port : '');