Merge pull request #467 from ramunasd/extension_niceness

[consumption] add process niceness extension

Author: makasim

pkg/enqueue/Consumption/Extension/NicenessExtension.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Enqueue\Consumption\Extension;
+
+use Enqueue\Consumption\Context;
+use Enqueue\Consumption\EmptyExtensionTrait;
+use Enqueue\Consumption\ExtensionInterface;
+
+class NicenessExtension implements ExtensionInterface
+{
+    use EmptyExtensionTrait;
+
+    /**
+     * @var int
+     */
+    protected $niceness = 0;
+
+    /**
+     * @param int $niceness
+     *
+     * @throws \InvalidArgumentException
+     */
+    public function __construct($niceness)
+    {
+        if (false === is_int($niceness)) {
+            throw new \InvalidArgumentException(sprintf(
+                'Expected niceness value is int but got: "%s"',
+                is_object($niceness) ? get_class($niceness) : gettype($niceness)
+            ));
+        }
+
+        $this->niceness = $niceness;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function onStart(Context $context)
+    {
+        if (0 !== $this->niceness) {
+            $changed = @proc_nice($this->niceness);
+            if (!$changed) {
+                throw new \InvalidArgumentException(sprintf(
+                    'Cannot change process niceness, got warning: "%s"',
+                    error_get_last()['message']
+                ));
+            }
+        }
+    }
+}

pkg/enqueue/Symfony/Consumption/LimitsExtensionsCommandTrait.php

@@ -5,6 +5,7 @@
 use Enqueue\Consumption\Extension\LimitConsumedMessagesExtension;
 use Enqueue\Consumption\Extension\LimitConsumerMemoryExtension;
 use Enqueue\Consumption\Extension\LimitConsumptionTimeExtension;
+use Enqueue\Consumption\Extension\NicenessExtension;
 use Enqueue\Consumption\ExtensionInterface;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -20,7 +21,8 @@ protected function configureLimitsExtensions()
         $this
             ->addOption('message-limit', null, InputOption::VALUE_REQUIRED, 'Consume n messages and exit')
             ->addOption('time-limit', null, InputOption::VALUE_REQUIRED, 'Consume messages during this time')
-            ->addOption('memory-limit', null, InputOption::VALUE_REQUIRED, 'Consume messages until process reaches this memory limit in MB');
+            ->addOption('memory-limit', null, InputOption::VALUE_REQUIRED, 'Consume messages until process reaches this memory limit in MB')
+            ->addOption('niceness', null, InputOption::VALUE_REQUIRED, 'Set process niceness');
     }
 
     /**
@@ -58,6 +60,11 @@ protected function getLimitsExtensions(InputInterface $input, OutputInterface $o
             $extensions[] = new LimitConsumerMemoryExtension($memoryLimit);
         }
 
+        $niceness = $input->getOption('niceness');
+        if ($niceness) {
+            $extensions[] = new NicenessExtension($niceness);
+        }
+
         return $extensions;
     }
 }

pkg/enqueue/Tests/Consumption/Extension/NicenessExtensionTest.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Enqueue\Tests\Consumption\Extension;
+
+use Enqueue\Consumption\Context;
+use Enqueue\Consumption\Extension\NicenessExtension;
+use Interop\Queue\PsrConsumer;
+use Interop\Queue\PsrContext;
+use Interop\Queue\PsrProcessor;
+use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
+
+class NicenessExtensionTest extends TestCase
+{
+    public function testCouldBeConstructedWithRequiredArguments()
+    {
+        new NicenessExtension(0);
+    }
+
+    public function testShouldThrowExceptionOnInvalidArgument()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        new NicenessExtension('1');
+    }
+
+    public function testShouldThrowWarningOnInvalidArgument()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('proc_nice(): Only a super user may attempt to increase the priority of a process');
+
+        $extension = new NicenessExtension(-1);
+        $extension->onStart($this->createContext());
+    }
+
+    /**
+     * @return Context
+     */
+    protected function createContext()
+    {
+        $context = new Context($this->createMock(PsrContext::class));
+        $context->setLogger($this->createMock(LoggerInterface::class));
+        $context->setPsrConsumer($this->createMock(PsrConsumer::class));
+        $context->setPsrProcessor($this->createMock(PsrProcessor::class));
+
+        return $context;
+    }
+}

pkg/enqueue/Tests/Symfony/Client/ConsumeMessagesCommandTest.php

@@ -61,14 +61,15 @@ public function testShouldHaveExpectedOptions()
 
         $options = $command->getDefinition()->getOptions();
 
-        $this->assertCount(7, $options);
+        $this->assertCount(8, $options);
         $this->assertArrayHasKey('memory-limit', $options);
         $this->assertArrayHasKey('message-limit', $options);
         $this->assertArrayHasKey('time-limit', $options);
         $this->assertArrayHasKey('setup-broker', $options);
         $this->assertArrayHasKey('idle-timeout', $options);
         $this->assertArrayHasKey('receive-timeout', $options);
         $this->assertArrayHasKey('skip', $options);
+        $this->assertArrayHasKey('niceness', $options);
     }
 
     public function testShouldHaveExpectedArguments()

pkg/enqueue/Tests/Symfony/Consumption/ConsumeMessagesCommandTest.php

@@ -29,12 +29,13 @@ public function testShouldHaveExpectedOptions()
 
         $options = $command->getDefinition()->getOptions();
 
-        $this->assertCount(5, $options);
+        $this->assertCount(6, $options);
         $this->assertArrayHasKey('memory-limit', $options);
         $this->assertArrayHasKey('message-limit', $options);
         $this->assertArrayHasKey('time-limit', $options);
         $this->assertArrayHasKey('idle-timeout', $options);
         $this->assertArrayHasKey('receive-timeout', $options);
+        $this->assertArrayHasKey('niceness', $options);
     }
 
     public function testShouldHaveExpectedAttributes()

pkg/enqueue/Tests/Symfony/Consumption/ContainerAwareConsumeMessagesCommandTest.php

@@ -33,13 +33,14 @@ public function testShouldHaveExpectedOptions()
 
         $options = $command->getDefinition()->getOptions();
 
-        $this->assertCount(6, $options);
+        $this->assertCount(7, $options);
         $this->assertArrayHasKey('memory-limit', $options);
         $this->assertArrayHasKey('message-limit', $options);
         $this->assertArrayHasKey('time-limit', $options);
         $this->assertArrayHasKey('queue', $options);
         $this->assertArrayHasKey('idle-timeout', $options);
         $this->assertArrayHasKey('receive-timeout', $options);
+        $this->assertArrayHasKey('niceness', $options);
     }
 
     public function testShouldHaveExpectedAttributes()

pkg/enqueue/Tests/Symfony/Consumption/LimitsExtensionsCommandTraitTest.php

@@ -5,6 +5,7 @@
 use Enqueue\Consumption\Extension\LimitConsumedMessagesExtension;
 use Enqueue\Consumption\Extension\LimitConsumerMemoryExtension;
 use Enqueue\Consumption\Extension\LimitConsumptionTimeExtension;
+use Enqueue\Consumption\Extension\NicenessExtension;
 use Enqueue\Tests\Symfony\Consumption\Mock\LimitsExtensionsCommand;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Tester\CommandTester;
@@ -17,10 +18,11 @@ public function testShouldAddExtensionsOptions()
 
         $options = $trait->getDefinition()->getOptions();
 
-        $this->assertCount(3, $options);
+        $this->assertCount(4, $options);
         $this->assertArrayHasKey('memory-limit', $options);
         $this->assertArrayHasKey('message-limit', $options);
         $this->assertArrayHasKey('time-limit', $options);
+        $this->assertArrayHasKey('niceness', $options);
     }
 
     public function testShouldAddMessageLimitExtension()
@@ -57,7 +59,8 @@ public function testShouldAddTimeLimitExtension()
 
     public function testShouldThrowExceptionIfTimeLimitExpressionIsNotValid()
     {
-        $this->setExpectedException(\Exception::class, 'Failed to parse time string (time is not valid) at position');
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage('Failed to parse time string (time is not valid) at position');
 
         $command = new LimitsExtensionsCommand('name');
 
@@ -104,4 +107,18 @@ public function testShouldAddThreeLimitExtensions()
         $this->assertInstanceOf(LimitConsumptionTimeExtension::class, $result[1]);
         $this->assertInstanceOf(LimitConsumerMemoryExtension::class, $result[2]);
     }
+
+    public function testShouldAddNicenessExtension()
+    {
+        $command = new LimitsExtensionsCommand('name');
+        $tester = new CommandTester($command);
+        $tester->execute([
+            '--niceness' => 1,
+        ]);
+
+        $result = $command->getExtensions();
+        $this->assertCount(1, $result);
+
+        $this->assertInstanceOf(NicenessExtension::class, $result[0]);
+    }
 }