Merge pull request php-vcr#342 from php-vcr/phpstan-for-tests

Phpstan for tests

Author: JeroenVanOort

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml,neon}]
+indent_size = 2

phpstan.neon

@@ -2,6 +2,7 @@ parameters:
  level: 7
  paths:
  - src
+ - tests/VCR
  # Can remove reportUnmatchedIgnoredErrors option after php 7.2 is no longer supported
  reportUnmatchedIgnoredErrors: false
  ignoreErrors:
@@ -18,6 +19,8 @@ parameters:
  - '/Parameter #2 \$eventName of method Symfony\\Contracts\\EventDispatcher\\EventDispatcherInterface::dispatch\(\) expects string\|null, VCR\\Event\\Event given./'
  # PHPStan cannot deal with manually defined constants - can be removed once php 7.2 no longer supported
  - '#Constant CURLPROXY_HTTPS not found.#'
+ - '#Call to an undefined method (VCR\\Util\\|)SoapClient::GetCityWeatherByZIP\(\)\.#'
+ - '#Call to an undefined method org\\bovigo\\vfs\\vfsStreamContent::hasChild\(\)\.#'
 includes:
  - vendor/thecodingmachine/phpstan-strict-rules/phpstan-strict-rules.neon
  - vendor/phpstan/phpstan-beberlei-assert/extension.neon

src/VCR/Request.php

@@ -40,7 +40,7 @@ class Request
  protected $curlOptions = [];
 
  /**
- * @param array<string,string> $headers
+ * @param array<string,string|null> $headers
  */
  public function __construct(string $method, ?string $url, array $headers = [])
  {

src/VCR/Storage/Blackhole.php

@@ -33,8 +33,10 @@ public function key(): int
  throw new \BadMethodCallException('Not implemented');
  }
 
- public function next(): void
+ /** @return array<mixed>|null */
+ public function next(): ?array
  {
+ return null;
  }
 
  public function rewind(): void

src/VCR/Storage/Storage.php

@@ -15,7 +15,7 @@ interface Storage extends \Iterator
  /**
  * Stores an array of data.
  *
- * @param array<string,array<string,mixed>> $recording array to store in storage
+ * @param array<string,string|null|array<string,mixed>> $recording array to store in storage
  */
  public function storeRecording(array $recording): void;
 

src/VCR/VCR.php

@@ -12,6 +12,7 @@
  * @method static void turnOn()
  * @method static void turnOff()
  * @method static void eject()
+ * @mixin Videorecorder
  */
 class VCR
 {
@@ -37,7 +38,7 @@ class VCR
  */
  public static function __callStatic(string $method, array $parameters)
  {
- $callable = [VCRFactory::get('VCR\Videorecorder'), $method];
+ $callable = [VCRFactory::get(Videorecorder::class), $method];
 
  Assertion::isCallable($callable);
 

tests/VCR/CassetteTest.php

@@ -29,8 +29,8 @@ public function testGetName(): void
  public function testDontOverwriteRecord(): void
  {
  $request = new Request('GET', 'https://example.com');
- $response1 = new Response(200, [], 'sometest');
- $response2 = new Response(200, [], 'sometest');
+ $response1 = new Response('200', [], 'sometest');
+ $response2 = new Response('200', [], 'sometest');
  $this->cassette->record($request, $response1);
  $this->cassette->record($request, $response2);
 
@@ -40,7 +40,7 @@ public function testDontOverwriteRecord(): void
  public function testPlaybackAlreadyRecordedRequest(): void
  {
  $request = new Request('GET', 'https://example.com');
- $response = new Response(200, [], 'sometest');
+ $response = new Response('200', [], 'sometest');
  $this->cassette->record($request, $response);
 
  $this->assertEquals($response->toArray(), $this->cassette->playback($request)->toArray());
@@ -56,7 +56,7 @@ public function testHasResponseNotFound(): void
  public function testHasResponseFound(): void
  {
  $request = new Request('GET', 'https://example.com');
- $response = new Response(200, [], 'sometest');
+ $response = new Response('200', [], 'sometest');
  $this->cassette->record($request, $response);
 
  $this->assertTrue($this->cassette->hasResponse($request), 'Expected true if request was found.');

tests/VCR/CodeTransform/AbstractCodeTransformTest.php

@@ -2,18 +2,24 @@
 
 namespace VCR\CodeTransform;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
 class AbstractCodeTransformTest extends TestCase
 {
+ /**
+ * @param string[] $methods
+ *
+ * @return AbstractCodeTransform&MockObject
+ */
  protected function getFilter(array $methods = [])
  {
  $defaults = array_merge(
  ['transformCode'],
  $methods
  );
 
- $filter = $this->getMockBuilder('\VCR\CodeTransform\AbstractCodeTransform')
+ $filter = $this->getMockBuilder(AbstractCodeTransform::class)
  ->setMethods($defaults)
  ->getMockForAbstractClass();
 

tests/VCR/CodeTransform/CurlCodeTransformTest.php

@@ -9,7 +9,7 @@ class CurlCodeTransformTest extends TestCase
  /**
  * @dataProvider codeSnippetProvider
  */
- public function testTransformCode($expected, $code): void
+ public function testTransformCode(string $expected, string $code): void
  {
  $codeTransform = new class() extends CurlCodeTransform {
  // A proxy to access the protected transformCode method.
@@ -22,7 +22,8 @@ public function publicTransformCode(string $code): string
  $this->assertEquals($expected, $codeTransform->publicTransformCode($code));
  }
 
- public function codeSnippetProvider()
+ /** @return array<string[]> */
+ public function codeSnippetProvider(): array
  {
  return [
  ['\VCR\LibraryHooks\CurlHook::curl_init(', 'CURL_INIT ('],

tests/VCR/CodeTransform/SoapCodeTransformTest.php

@@ -9,7 +9,7 @@ class SoapCodeTransformTest extends TestCase
  /**
  * @dataProvider codeSnippetProvider
  */
- public function testTransformCode($expected, $code): void
+ public function testTransformCode(string $expected, string $code): void
  {
  $codeTransform = new class() extends SoapCodeTransform {
  // A proxy to access the protected transformCode method.
@@ -22,7 +22,8 @@ public function publicTransformCode(string $code): string
  $this->assertEquals($expected, $codeTransform->publicTransformCode($code));
  }
 
- public function codeSnippetProvider()
+ /** @return array<string[]> */
+ public function codeSnippetProvider(): array
  {
  return [
  ['new \VCR\Util\SoapClient(', 'new \SoapClient('],