getSize() < 100000) { $testProviderArray[] = [$file->getPathname()]; } } } return $testProviderArray; } /** * This test loads the test cases specified in .php files under cases/ and looks at the whole set of * Definitions and References produced. It reads the expected results from associated .json files * and compares to the actual result. If they don't match, the test fails and it writes the new baseline * to the .json file. * @group validation * @dataProvider validationTestProvider * @param $testCaseFile */ public function testDefinitionsAndReferences($testCaseFile) { $fileContents = file_get_contents($testCaseFile); $actualValues = $this->getActualTestValues($testCaseFile, $fileContents); $outputFile = getExpectedValuesFile($testCaseFile); if (!file_exists($outputFile)) { file_put_contents($outputFile, json_encode($actualValues, JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES)); } $expectedValues = (array)json_decode(file_get_contents($outputFile)); try { $this->assertEquals($expectedValues['definitions'], $actualValues['definitions']); $this->assertEquals((array)$expectedValues['references'], (array)$actualValues['references'], sprintf('references match in "%s"', $outputFile)); } catch (\Throwable $e) { $outputFile = getExpectedValuesFile($testCaseFile); file_put_contents($outputFile, json_encode($actualValues, JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES)); throw $e; } } private function getActualTestValues($filename, $fileContents): array { $index = new Index(); $parser = new PhpParser\Parser(); $docBlockFactory = DocBlockFactory::createInstance(); $definitionResolver = new DefinitionResolver($index); $document = new PhpDocument($filename, $fileContents, $index, $parser, $docBlockFactory, $definitionResolver); $actualRefs = $index->getReferences(); $actualDefs = $this->getTestValuesFromDefs($document->getDefinitions()); // There's probably a more PHP-typical way to do this. Need to compare the objects parsed from json files // to the real objects. $refsAndDefs = array( 'references' => json_decode(json_encode($actualRefs)), 'definitions' => json_decode(json_encode($actualDefs)) ); // Turn references into relative paths $testCasesDir = realpath(__DIR__ . '/cases'); foreach ($refsAndDefs['references'] as $key => $list) { $fixedPathRefs = array_map(function ($ref) use ($testCasesDir) { $ref = str_replace($testCasesDir, '.', $ref); $ref = str_replace(DIRECTORY_SEPARATOR, '/', $ref); return $ref; }, $list); $refsAndDefs['references']->$key = $fixedPathRefs; } // Turn def locations into relative paths foreach ($refsAndDefs['definitions'] as $key => $def) { if ($def !== null && $def->symbolInformation !== null && $def->symbolInformation->location !== null && $def->symbolInformation->location->uri !== null) { $def->symbolInformation->location->uri = str_replace($testCasesDir, '.', $def->symbolInformation->location->uri); $def->symbolInformation->location->uri = str_replace(DIRECTORY_SEPARATOR, '/', $def->symbolInformation->location->uri); } } return $refsAndDefs; } /** * @param $definitions Definition[] * @return array|\array[] */ private function getTestValuesFromDefs($definitions): array { $propertyNames = get_class_vars(Definition::class); $defsForAssert = []; foreach ($definitions as $definition) { $fqn = $definition->fqn; foreach ($propertyNames as $propertyName => $value) { if ($propertyName === 'symbolInformation') { // Range is very often different - don't check it, for now unset($definition->$propertyName->location->range); } elseif ($propertyName === 'extends') { $definition->$propertyName = $definition->$propertyName ?? []; } elseif ($propertyName === 'type' && $definition->type !== null) { $defsForAssert[$fqn]['type__tostring'] = (string)$definition->type; } $defsForAssert[$fqn][$propertyName] = $definition->$propertyName; } } return $defsForAssert; } } function getExpectedValuesFile($testCaseFile): string { return $testCaseFile . '.expected.json'; }