Use withConsecutive/willReturnOnConsecutiveCalls instead of the depre…

…cated at matcher
imbo · Aug 9, 2020 · 74cd07f · 74cd07f
1 parent d54e5a2
commit 74cd07f
Show file tree

Hide file tree

Showing 12 changed files with 171 additions and 293 deletions.
diff --git a/src/CliCommand/AddPublicKey.php b/src/CliCommand/AddPublicKey.php
@@ -43,7 +43,7 @@ public function __construct() {
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output) {
+    protected function execute(InputInterface $input, OutputInterface $output) : int {
         $adapter = $this->getAclAdapter();
         $publicKey = $input->getArgument('publicKey');
 
@@ -82,6 +82,8 @@ protected function execute(InputInterface $input, OutputInterface $output) {
         $output->writeln('Public key:  ' . $publicKey);
         $output->writeln('Private key: ' . $privateKey);
         $output->writeln('ACL rules added: ' . count($aclRules));
+
+        return self::SUCCESS;
     }
 
     /**
@@ -105,6 +107,7 @@ private function askForResources(InputInterface $input, OutputInterface $output)
         );
 
         $type = $this->getHelper('question')->ask($input, $output, $question);
+
         switch ($type) {
             case self::RESOURCES_READ_ONLY:
                 return Resource::getReadOnlyResources();
@@ -163,6 +166,7 @@ private function askForCustomResources(InputInterface $input, OutputInterface $o
 
             return $resources;
         });
+        $question->setMaxAttempts(1);
 
         return $this->getHelper('question')->ask($input, $output, $question);
     }
@@ -190,6 +194,7 @@ private function askForUsers(InputInterface $input, OutputInterface $output) {
 
             return array_search('*', $users) === false ? $users : '*';
         });
+        $question->setMaxAttempts(1);
 
         return $this->getHelper('question')->ask($input, $output, $question);
     }
@@ -222,6 +227,7 @@ private function askForPrivateKey(InputInterface $input, OutputInterface $output
             'What do you want the private key to be (leave blank to generate)',
             $privateKeyGenerator->generate()
         );
+        $question->setMaxAttempts(1);
 
         return $this->getHelper('question')->ask($input, $output, $question);
     }

diff --git a/src/CliCommand/GeneratePrivateKey.php b/src/CliCommand/GeneratePrivateKey.php
@@ -27,8 +27,9 @@ public function __construct() {
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output) {
+    protected function execute(InputInterface $input, OutputInterface $output) : int {
         $output->writeln($this->generate());
+        return self::SUCCESS;
     }
 
     /**

diff --git a/tests/Behat/FeatureContextTest.php b/tests/Behat/FeatureContextTest.php
@@ -76,16 +76,15 @@ public function testCanSetAnApiClient() : void {
 
         $client = $this->createMock(ClientInterface::class);
         $client
-            ->expects($this->at(0))
             ->method('getConfig')
-            ->with('handler')
-            ->willReturn($handlerStack);
-
-        $client
-            ->expects($this->at(1))
-            ->method('getConfig')
-            ->with('base_uri')
-            ->willReturn('http://localhost:8080');
+            ->withConsecutive(
+                ['handler'],
+                ['base_uri'],
+            )
+            ->willReturnOnConsecutiveCalls(
+                $handlerStack,
+                'http://localhost:8080',
+            );
 
         $context = new FeatureContext();
         $this->assertSame($context, $context->setClient($client));

diff --git a/tests/CliCommand/AddPublicKeyTest.php b/tests/CliCommand/AddPublicKeyTest.php
@@ -104,8 +104,6 @@ public function testWillNotAcceptEmptyUserSpecification() : void {
         $commandTester->setInputs([
             '0',
             '',
-            '*',
-            'n',
         ]);
 
         $this->expectException(RuntimeException::class);
@@ -122,9 +120,6 @@ public function testWillNotAcceptEmptyCustomResourceSpecification() : void {
         $commandTester->setInputs([
             '4',
             '',
-            'foo.bar,bar.foo',
-            '*',
-            'n'
         ]);
         $this->expectException(RuntimeException::class);
         $this->expectExceptionMessageMatches('/must specify at least one resource/');

diff --git a/tests/EventListener/AuthenticateTest.php b/tests/EventListener/AuthenticateTest.php
@@ -62,13 +62,13 @@ protected function getEventMock($config = null) : Event {
      */
     public function testThrowsExceptionWhenAuthInfoIsMissing() : void {
         $this->headers
-            ->expects($this->at(0))
+            ->expects($this->once())
             ->method('has')
             ->with('x-imbo-authenticate-timestamp')
             ->willReturn(false);
 
         $this->headers
-            ->expects($this->at(1))
+            ->expects($this->once())
             ->method('get')
             ->with('x-imbo-authenticate-timestamp')
             ->willReturn(null);
@@ -82,22 +82,23 @@ public function testThrowsExceptionWhenAuthInfoIsMissing() : void {
      */
     public function testThrowsExceptionWhenSignatureIsMissing() : void {
         $this->headers
-            ->expects($this->at(0))
-            ->method('has')
-            ->with('x-imbo-authenticate-timestamp')
-            ->willReturn(true);
-
-        $this->headers
-            ->expects($this->at(1))
             ->method('has')
-            ->with('x-imbo-authenticate-signature')
+            ->withConsecutive(
+                ['x-imbo-authenticate-timestamp'],
+                ['x-imbo-authenticate-signature'],
+            )
             ->willReturn(true);
 
         $this->headers
-            ->expects($this->at(2))
             ->method('get')
-            ->with('x-imbo-authenticate-timestamp')
-            ->willReturn(gmdate('Y-m-d\TH:i:s\Z'));
+            ->withConsecutive(
+                ['x-imbo-authenticate-timestamp', null],
+                ['x-imbo-authenticate-signature', null],
+            )
+            ->willReturnOnConsecutiveCalls(
+                gmdate('Y-m-d\TH:i:s\Z'),
+                null,
+            );
 
         $this->expectExceptionObject(new RuntimeException('Missing authentication signature', 400));
         $this->listener->authenticate($this->event);
@@ -109,19 +110,14 @@ public function testThrowsExceptionWhenSignatureIsMissing() : void {
      */
     public function testThrowsExceptionWhenTimestampIsInvalid() : void {
         $this->headers
-            ->expects($this->at(0))
             ->method('has')
-            ->with('x-imbo-authenticate-timestamp')
+            ->withConsecutive(
+                ['x-imbo-authenticate-timestamp'],
+                ['x-imbo-authenticate-signature'],
+            )
             ->willReturn(true);
 
         $this->headers
-            ->expects($this->at(1))
-            ->method('has')
-            ->with('x-imbo-authenticate-signature')
-            ->willReturn(true);
-
-        $this->headers
-            ->expects($this->at(2))
             ->method('get')
             ->with('x-imbo-authenticate-timestamp')
             ->willReturn('some string');
@@ -136,19 +132,14 @@ public function testThrowsExceptionWhenTimestampIsInvalid() : void {
      */
     public function testThrowsExceptionWhenTimestampHasExpired() : void {
         $this->headers
-            ->expects($this->at(0))
             ->method('has')
-            ->with('x-imbo-authenticate-timestamp')
+            ->withConsecutive(
+                ['x-imbo-authenticate-timestamp'],
+                ['x-imbo-authenticate-signature'],
+            )
             ->willReturn(true);
 
         $this->headers
-            ->expects($this->at(1))
-            ->method('has')
-            ->with('x-imbo-authenticate-signature')
-            ->willReturn(true);
-
-        $this->headers
-            ->expects($this->at(2))
             ->method('get')
             ->with('x-imbo-authenticate-timestamp')
             ->willReturn('2010-07-10T20:02:10Z');
@@ -162,28 +153,23 @@ public function testThrowsExceptionWhenTimestampHasExpired() : void {
      */
     public function testThrowsExceptionWhenSignatureDoesNotMatch() : void {
         $this->headers
-            ->expects($this->at(0))
-            ->method('has')
-            ->with('x-imbo-authenticate-timestamp')
-            ->willReturn(true);
-
-        $this->headers
-            ->expects($this->at(1))
             ->method('has')
-            ->with('x-imbo-authenticate-signature')
+            ->withConsecutive(
+                ['x-imbo-authenticate-timestamp'],
+                ['x-imbo-authenticate-signature'],
+            )
             ->willReturn(true);
 
         $this->headers
-            ->expects($this->at(2))
             ->method('get')
-            ->with('x-imbo-authenticate-timestamp')
-            ->willReturn(gmdate('Y-m-d\TH:i:s\Z'));
-
-        $this->headers
-            ->expects($this->at(3))
-            ->method('get')
-            ->with('x-imbo-authenticate-signature')
-            ->willReturn('foobar');
+            ->withConsecutive(
+                ['x-imbo-authenticate-timestamp'],
+                ['x-imbo-authenticate-signature'],
+            )
+            ->willReturnOnConsecutiveCalls(
+                gmdate('Y-m-d\TH:i:s\Z'),
+                'foobar',
+            );
 
         $this->request
             ->expects($this->once())
@@ -221,28 +207,23 @@ public function testApprovesValidSignature() : void {
             ->willReturn($privateKey);
 
         $this->headers
-            ->expects($this->at(0))
-            ->method('has')
-            ->with('x-imbo-authenticate-timestamp')
-            ->willReturn(true);
-
-        $this->headers
-            ->expects($this->at(1))
             ->method('has')
-            ->with('x-imbo-authenticate-signature')
+            ->withConsecutive(
+                ['x-imbo-authenticate-timestamp'],
+                ['x-imbo-authenticate-signature'],
+            )
             ->willReturn(true);
 
         $this->headers
-            ->expects($this->at(2))
-            ->method('get')
-            ->with('x-imbo-authenticate-timestamp')
-            ->willReturn($timestamp);
-
-        $this->headers
-            ->expects($this->at(3))
             ->method('get')
-            ->with('x-imbo-authenticate-signature')
-            ->willReturn($signature);
+            ->withConsecutive(
+                ['x-imbo-authenticate-timestamp'],
+                ['x-imbo-authenticate-signature'],
+            )
+            ->willReturnOnConsecutiveCalls(
+                $timestamp,
+                $signature,
+            );
 
         $this->request
             ->expects($this->once())
@@ -292,34 +273,31 @@ public function testApprovesValidSignatureWithAuthInfoFromQueryParameters() : vo
             ->willReturn($privateKey);
 
         $this->headers
-            ->expects($this->at(0))
             ->method('has')
             ->with('x-imbo-authenticate-timestamp')
             ->willReturn(false);
 
         $this->headers
-            ->expects($this->at(1))
-            ->method('get')
-            ->with('x-imbo-authenticate-timestamp', $timestamp)
-            ->willReturn($timestamp);
-
-        $this->headers
-            ->expects($this->at(2))
-            ->method('get')
-            ->with('x-imbo-authenticate-signature', $signature)
-            ->willReturn($signature);
-
-        $this->query
-            ->expects($this->at(0))
             ->method('get')
-            ->with('timestamp')
-            ->willReturn($timestamp);
+            ->withConsecutive(
+                ['x-imbo-authenticate-timestamp', $timestamp],
+                ['x-imbo-authenticate-signature', $signature],
+            )
+            ->willReturnOnConsecutiveCalls(
+                $timestamp,
+                $signature,
+            );
 
         $this->query
-            ->expects($this->at(1))
             ->method('get')
-            ->with('signature')
-            ->willReturn($signature);
+            ->withConsecutive(
+                ['timestamp'],
+                ['signature'],
+            )
+            ->willReturnOnConsecutiveCalls(
+                $timestamp,
+                $signature,
+            );
 
         $this->request
             ->expects($this->once())
@@ -463,34 +441,31 @@ public function testApprovesSignaturesWhenConfigurationForcesProtocol(string $se
             ->willReturn('key');
 
         $this->headers
-            ->expects($this->at(0))
             ->method('has')
             ->with('x-imbo-authenticate-timestamp')
             ->willReturn(false);
 
         $this->headers
-            ->expects($this->at(1))
-            ->method('get')
-            ->with('x-imbo-authenticate-timestamp', $timestamp)
-            ->willReturn($timestamp);
-
-        $this->headers
-            ->expects($this->at(2))
             ->method('get')
-            ->with('x-imbo-authenticate-signature', $signature)
-            ->willReturn($signature);
-
-        $this->query
-            ->expects($this->at(0))
-            ->method('get')
-            ->with('timestamp')
-            ->willReturn($timestamp);
+            ->withConsecutive(
+                ['x-imbo-authenticate-timestamp', $timestamp],
+                ['x-imbo-authenticate-signature', $signature],
+            )
+            ->willReturnOnConsecutiveCalls(
+                $timestamp,
+                $signature,
+            );
 
         $this->query
-            ->expects($this->at(1))
             ->method('get')
-            ->with('signature')
-            ->willReturn($signature);
+            ->withConsecutive(
+                ['timestamp'],
+                ['signature'],
+            )
+            ->willReturnOnConsecutiveCalls(
+                $timestamp,
+                $signature,
+            );
 
         $this->request
             ->expects($this->once())