Example for doing a full schema unit test

[pmelab]

Since I was asked how to do it and realised we have no canonical example or documentation.

[klausi]

Looks good to me! PHPStan is failing because of #1157 , fixing that there.

[klausi]

We have a couple of exceptions in phpcs.xml.dist for the example module, so you also need to fix the paths there.

The other coding standard fixes should be straightforward.

[Kingdutch]

Instead of $this->query I think we should use $this->assertResults.

The benefits are that it bypasses the HTTP stack which is slightly faster. It also handles the response decoding for you and allows you to test for caching metadata.

Suggested change

	$response = $this->query('{ articles { total, items { title, author } } }');
	$content = json_decode($response->getContent(), TRUE);
	$this->assertEquals([
	'data' => [
	'articles' => [
	'total' => 3,
	'items' => [
	['title' => 'ONE', 'author' => 'A'],
	['title' => 'TWO', 'author' => 'B'],
	['title' => 'THREE', 'author' => 'A'],
	],
	],
	],
	], $content);
	$this->assertResults(
	'{ articles { total, items { title, author } } }',
	[],
	[
	'data' => [
	'articles' => [
	'total' => 3,
	'items' => [
	['title' => 'ONE', 'author' => 'A'],
	['title' => 'TWO', 'author' => 'B'],
	['title' => 'THREE', 'author' => 'A'],
	],
	],
	],
	]
	);

[pmelab]

You are right @Kingdutch ! 🤦 Thanks for the input.

[Kingdutch]

Another thought: should we be excluding this test from the test runs? If we're going to provide an example, it'd be good to just run the test, this way we also know when the documentation/example breaks :D Otherwise we may end up with someone copying a test that doesn't work in the first place.

[klausi]

Yep, we absolutely should execute this test! I think that is done with how we run phpunit on github actions (by just pointing at the graphql module), but I did not double-check.