Add a Logger class (bamarni#99)

PhpDevTools · Jul 8, 2022 · 09a868e · 09a868e
1 parent 5222278
commit 09a868e
Show file tree

Hide file tree

Showing 6 changed files with 189 additions and 23 deletions.
diff --git a/src/BinCommand.php b/src/BinCommand.php
@@ -7,6 +7,7 @@
 use Composer\Command\BaseCommand;
 use Composer\Factory;
 use Composer\IO\IOInterface;
+use Composer\IO\NullIO;
 use ReflectionClass;
 use ReflectionProperty;
 use Symfony\Component\Console\Application;
@@ -35,10 +36,21 @@ class BinCommand extends BaseCommand
 
  private const NAMESPACE_ARG = 'namespace';
 
+ /**
+ * @var Logger
+ */
+ private $logger;
+
+ public function __construct(?Logger $logger = null)
+ {
+ parent::__construct('bin');
+
+ $this->logger = $logger ?? new Logger(new NullIO());
+ }
+
  protected function configure(): void
  {
  $this
- ->setName('bin')
  ->setDescription('Run a command inside a bin namespace')
  ->setDefinition([
  new InputArgument(self::NAMESPACE_ARG, InputArgument::REQUIRED),
@@ -47,6 +59,22 @@ protected function configure(): void
  ->ignoreValidationErrors();
  }
 
+ public function setIO(IOInterface $io): void
+ {
+ parent::setIO($io);
+
+ $this->logger = new Logger($io);
+ }
+
+ public function getIO(): IOInterface
+ {
+ $io = parent::getIO();
+
+ $this->logger = new Logger($io);
+
+ return $io;
+ }
+
  public function isProxyCommand(): bool
  {
  return true;
@@ -57,7 +85,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
  $config = Config::fromComposer($this->requireComposer());
  $currentWorkingDir = getcwd();
 
- $this->log(
+ $this->logger->logDebug(
  sprintf(
  'Current working directory: <comment>%s</comment>',
  $currentWorkingDir
@@ -117,10 +145,7 @@ private function executeAllNamespaces(
  $namespaces = self::getBinNamespaces($binVendorRoot);
 
  if (count($namespaces) === 0) {
- $this->log(
- '<warning>Could not find any bin namespace.</warning>',
- false
- );
+ $this->logger->logStandard('<warning>Could not find any bin namespace.</warning>');
 
  // Is a valid scenario: the user may not have set up any bin
  // namespace yet
@@ -149,7 +174,7 @@ private function executeInNamespace(
  OutputInterface $output,
  ReflectionProperty $commandsReflection
  ): int {
- $this->log(
+ $this->logger->logDebug(
  sprintf(
  'Checking namespace <comment>%s</comment>',
  $namespace
@@ -159,12 +184,11 @@ private function executeInNamespace(
  try {
  self::createNamespaceDirIfDoesNotExist($namespace);
  } catch (CouldNotCreateNamespaceDir $exception) {
- $this->log(
+ $this->logger->logStandard(
  sprintf(
  '<warning>%s</warning>',
  $exception->getMessage()
- ),
- false
+ )
  );
 
  return self::FAILURE;
@@ -197,7 +221,7 @@ private function executeInNamespace(
 
  $namespaceInput = BinInputFactory::createNamespaceInput($input);
 
- $this->log(
+ $this->logger->logDebug(
  sprintf(
  'Running <info>`@composer %s`</info>.',
  $namespaceInput
@@ -249,7 +273,7 @@ private function configureBinLinksDir(Config $config): void
  )
  );
 
- $this->log(
+ $this->logger->logDebug(
  sprintf(
  'Configuring bin directory to <comment>%s</comment>.',
  $binDir
@@ -268,7 +292,7 @@ private function ensureComposerFileExists(): void
 
  file_put_contents($namespaceComposerFile, '{}');
 
- $this->log(
+ $this->logger->logDebug(
  sprintf(
  'Created the file <comment>%s</comment>.',
  $namespaceComposerFile
@@ -291,20 +315,11 @@ private function chdir(string $dir): void
  {
  chdir($dir);
 
- $this->log(
+ $this->logger->logDebug(
  sprintf(
  'Changed current directory to <comment>%s</comment>.',
  $dir
  )
  );
  }
-
- private function log(string $message, bool $debug = true): void
- {
- $verbosity = $debug
- ? IOInterface::VERBOSE
- : IOInterface::NORMAL;
-
- $this->getIO()->writeError('[bamarni-bin-plugin] '.$message, true, $verbosity);
- }
 }
diff --git a/src/Logger.php b/src/Logger.php
@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bamarni\Composer\Bin;
+
+use Composer\IO\IOInterface;
+
+final class Logger
+{
+ /**
+ * @var IOInterface
+ */
+ private $io;
+
+ public function __construct(IOInterface $io)
+ {
+ $this->io = $io;
+ }
+
+ public function logStandard(string $message): void
+ {
+ $this->log($message, false);
+ }
+
+ public function logDebug(string $message): void
+ {
+ $this->log($message, true);
+ }
+
+ private function log(string $message, bool $debug): void
+ {
+ $verbosity = $debug
+ ? IOInterface::VERBOSE
+ : IOInterface::NORMAL;
+
+ $this->io->writeError('[bamarni-bin-plugin] '.$message, true, $verbosity);
+ }
+}
diff --git a/tests/BinCommandTest.php b/tests/BinCommandTest.php
@@ -22,6 +22,9 @@
 use function realpath;
 use function sys_get_temp_dir;
 
+/**
+ * @covers \Bamarni\Composer\Bin\BinCommand
+ */
 class BinCommandTest extends TestCase
 {
  /**

diff --git a/tests/BinInputFactoryTest.php b/tests/BinInputFactoryTest.php
@@ -9,6 +9,9 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\StringInput;
 
+/**
+ * @covers \Bamarni\Composer\Bin\BinInputFactory
+ */
 final class BinInputFactoryTest extends TestCase
 {
  /**

diff --git a/tests/EndToEndTest.php b/tests/EndToEndTest.php
@@ -19,6 +19,7 @@
 
 /**
  * @group e2e
+ * @coversNothing
  */
 final class EndToEndTest extends TestCase
 {

diff --git a/tests/LoggerTest.php b/tests/LoggerTest.php
@@ -0,0 +1,105 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bamarni\Composer\Bin\Tests;
+
+use Bamarni\Composer\Bin\Logger;
+use Composer\IO\BufferIO;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Output\OutputInterface;
+use function array_diff;
+use const PHP_EOL;
+
+/**
+ * @covers \Bamarni\Composer\Bin\Logger
+ */
+final class LoggerTest extends TestCase
+{
+ private const VERBOSITIES = [
+ OutputInterface::VERBOSITY_QUIET,
+ OutputInterface::VERBOSITY_NORMAL,
+ OutputInterface::VERBOSITY_VERBOSE,
+ OutputInterface::VERBOSITY_VERY_VERBOSE,
+ OutputInterface::VERBOSITY_DEBUG,
+ ];
+
+ /**
+ * @dataProvider standardMessageProvider
+ */
+ public function test_it_can_log_standard_messages(
+ int $verbosity,
+ string $message,
+ string $expected
+ ): void {
+ $io = new BufferIO('', $verbosity);
+ $logger = new Logger($io);
+
+ $logger->logStandard($message);
+
+ self::assertSame($expected, $io->getOutput());
+ }
+
+ public static function standardMessageProvider(): iterable
+ {
+ $notLoggedVerbosities = [
+ OutputInterface::VERBOSITY_QUIET,
+ ];
+
+ $loggedVerbosities = array_diff(
+ self::VERBOSITIES,
+ $notLoggedVerbosities
+ );
+
+ $message = 'Hello world!';
+ $expected = '[bamarni-bin-plugin] Hello world!'.PHP_EOL;
+
+ foreach ($notLoggedVerbosities as $verbosity) {
+ yield [$verbosity, $message, ''];
+ }
+
+ foreach ($loggedVerbosities as $verbosity) {
+ yield [$verbosity, $message, $expected];
+ }
+ }
+
+ /**
+ * @dataProvider standardMessageProvider
+ */
+ public function test_it_can_log_debug_messages(
+ int $verbosity,
+ string $message,
+ string $expected
+ ): void {
+ $io = new BufferIO('', $verbosity);
+ $logger = new Logger($io);
+
+ $logger->logStandard($message);
+
+ self::assertSame($expected, $io->getOutput());
+ }
+
+ public static function debugMessageProvider(): iterable
+ {
+ $notLoggedVerbosities = [
+ OutputInterface::VERBOSITY_QUIET,
+ OutputInterface::VERBOSITY_NORMAL,
+ ];
+
+ $loggedVerbosities = array_diff(
+ self::VERBOSITIES,
+ $notLoggedVerbosities
+ );
+
+ $message = 'Hello world!';
+ $expected = '[bamarni-bin-plugin] Hello world!'.PHP_EOL;
+
+ foreach ($notLoggedVerbosities as $verbosity) {
+ yield [$verbosity, $message, ''];
+ }
+
+ foreach ($loggedVerbosities as $verbosity) {
+ yield [$verbosity, $message, $expected];
+ }
+ }
+}