Merge "GQL: Add architecture tests for the reuse domain"

Author: jenkins-bot

extension-repo.json

@@ -957,6 +957,7 @@
 		"Wikibase\\Repo\\Tests\\Domains\\Crud\\": "repo/domains/crud/tests/phpunit/",
 		"Wikibase\\Repo\\Tests\\Domains\\Crud\\Architecture\\": "repo/domains/crud/tests/architecture/",
 		"Wikibase\\Repo\\Tests\\Domains\\Reuse\\": "repo/domains/reuse/tests/phpunit/",
+		"Wikibase\\Repo\\Tests\\Domains\\Reuse\\Architecture\\": "repo/domains/reuse/tests/architecture/",
 		"Wikibase\\Lib\\Tests\\": "lib/tests/phpunit/",
 		"Wikibase\\Lib\\Tests\\Unit\\": "lib/tests/phpunit/unit/",
 		"Wikibase\\Lib\\Tests\\Changes\\": "lib/packages/wikibase/changes/tests/",

phpstan.neon

@@ -7,6 +7,10 @@ services:
 		class: Wikibase\Repo\Tests\Domains\Search\Architecture\ArchitectureTest
 		tags:
 			- phpat.test
+	-
+		class: Wikibase\Repo\Tests\Domains\Reuse\Architecture\ArchitectureTest
+		tags:
+			- phpat.test
 	-
 		class: Wikibase\Repo\Tests\Architecture\ArchitectureTest
 		tags:
@@ -26,6 +30,8 @@ parameters:
 		- ./repo/domains/crud/tests/architecture/
 		- ./repo/domains/search/src/
 		- ./repo/domains/search/tests/architecture/
+		- ./repo/domains/reuse/src/
+		- ./repo/domains/reuse/tests/architecture/
 		- ./repo/rest-api/src/
 		- ./repo/rest-api/tests/architecture/
 

prpl-ruleset.xml

@@ -39,6 +39,7 @@
 				<element key="repo/domains/crud/tests/architecture" value="Wikibase\Repo\Tests\Domains\Crud\Architecture"/>
 				<element key="repo/domains/reuse/src" value="Wikibase\Repo\Domains\Reuse"/>
 				<element key="repo/domains/reuse/tests/phpunit" value="Wikibase\Repo\Tests\Domains\Reuse"/>
+				<element key="repo/domains/reuse/tests/architecture" value="Wikibase\Repo\Tests\Domains\Reuse\Architecture"/>
 			</property>
 		</properties>
 	</rule>

repo/domains/reuse/tests/architecture/ArchitectureTest.php

@@ -0,0 +1,113 @@
+<?php declare( strict_types=1 );
+
+namespace Wikibase\Repo\Tests\Domains\Reuse\Architecture;
+
+use PHPat\Selector\Selector;
+use PHPat\Test\Builder\Rule;
+use PHPat\Test\PHPat;
+use Wikibase\DataModel\Services\Lookup\PropertyDataTypeLookup;
+use Wikibase\DataModel\Services\Lookup\PropertyDataTypeLookupException;
+use Wikibase\DataModel\Services\Statement\StatementGuidParser;
+
+/**
+ * @coversNothing
+ *
+ * @license GPL-2.0-or-later
+ */
+class ArchitectureTest {
+
+	private const REUSE_DOMAIN = 'Wikibase\Repo\Domains\Reuse';
+	private const DOMAIN_MODEL = self::REUSE_DOMAIN . '\Domain\Model';
+	private const DOMAIN_SERVICES = self::REUSE_DOMAIN . '\Domain\Services';
+	private const USE_CASES = self::REUSE_DOMAIN . '\Application\UseCases';
+
+	public function testDomainModel(): Rule {
+		return PHPat::rule()
+			->classes( Selector::inNamespace( self::DOMAIN_MODEL ) )
+			->canOnlyDependOn()
+			->classes( ...$this->allowedDomainModelDependencies() );
+	}
+
+	/**
+	 * Domain models may depend on:
+	 *  - DataModel namespaces containing entities and their parts
+	 *  - other classes from their own namespace
+	 */
+	private function allowedDomainModelDependencies(): array {
+		return [
+			...$this->dataModelNamespaces(),
+			Selector::inNamespace( self::DOMAIN_MODEL ),
+		];
+	}
+
+	public function testDomainServices(): Rule {
+		return PHPat::rule()
+			->classes( Selector::inNamespace( self::DOMAIN_SERVICES ) )
+			->canOnlyDependOn()
+			->classes( ...$this->allowedDomainServicesDependencies() );
+	}
+
+	/**
+	 * Domain services may depend on:
+	 *  - the domain models namespace and everything it depends on
+	 *  - some hand-picked DataModel services
+	 *  - other classes from their own namespace
+	 */
+	private function allowedDomainServicesDependencies(): array {
+		return [
+			...$this->allowedDomainModelDependencies(),
+			...$this->allowedDataModelServices(),
+			Selector::inNamespace( self::DOMAIN_SERVICES ),
+		];
+	}
+
+	public function testUseCases(): Rule {
+		return PHPat::rule()
+			->classes( Selector::inNamespace( self::USE_CASES ) )
+			->canOnlyDependOn()
+			->classes( ...$this->allowedUseCasesDependencies() );
+	}
+
+	/**
+	 * Use cases may depend on:
+	 *  - the domain services namespace and everything it depends on
+	 *  - other classes from their own namespace
+	 */
+	private function allowedUseCasesDependencies(): array {
+		return [
+			...$this->allowedDomainServicesDependencies(),
+			Selector::inNamespace( self::USE_CASES ),
+		];
+	}
+
+	private function allowedDataModelServices(): array {
+		return [
+			Selector::classname( PropertyDataTypeLookup::class ),
+			Selector::classname( PropertyDataTypeLookupException::class ),
+			Selector::classname( StatementGuidParser::class ),
+		];
+	}
+
+	private function dataModelNamespaces(): array {
+		return [
+			// These are listed in such a complicated way so that only DataModel entities and their parts are allowed without the
+			// namespaces nested within DataModel like e.g. Wikibase\DataModel\Serializers.
+			...array_map(
+				fn( string $escapedNamespace ) => Selector::classname(
+					'/^' . preg_quote( $escapedNamespace ) . '\\\\\w+$/',
+					true
+				),
+				[
+					'Wikibase\DataModel',
+					'Wikibase\DataModel\Entity',
+					'Wikibase\DataModel\Exception',
+					'Wikibase\DataModel\Snak',
+					'Wikibase\DataModel\Statement',
+					'Wikibase\DataModel\Term',
+				]
+			),
+			Selector::inNamespace( 'DataValues' ),
+		];
+	}
+
+}

repo/tests/architecture/ArchitectureTest.php

@@ -68,6 +68,8 @@ private function allowedCrossDomainClasses(): array {
 			Selector::inNamespace( self::REGEX_DOMAIN_READMODEL, true ),
 			// search domain models (we don't have readmodels there)
 			Selector::inNamespace( 'Wikibase\Repo\Domains\Search\Domain\Model' ),
+			// reuse domain models (we don't have readmodels there)
+			Selector::inNamespace( 'Wikibase\Repo\Domains\Reuse\Domain\Model' ),
 		];
 	}