Differential D1810 Diff 4948 src/tests/TestCaseTrait.php

Changeset View

Standalone View

src/tests/TestCaseTrait.php

	<?php			<?php

	namespace Tests;			namespace Tests;

	use App\Domain;			use App\Domain;
	use App\Transaction;			use App\Transaction;
	use App\User;			use App\User;
	use Carbon\Carbon;			use Carbon\Carbon;
	use Illuminate\Contracts\Console\Kernel;			use Illuminate\Contracts\Console\Kernel;
	use Illuminate\Support\Facades\Queue;			use Illuminate\Support\Facades\Queue;
	use PHPUnit\Framework\Assert;			use PHPUnit\Framework\Assert;

	trait TestCaseTrait			trait TestCaseTrait
	{			{
				/**
				* A domain that is hosted.
				*
				* @var \App\Domain
				*/
				protected $domainHosted;

				/**
				* The hosted domain owner.
				*
				* @var \App\User
				*/
				protected $domainOwner;

				/**
				* Some profile details for an owner of a domain
				*
				* @var array
				*/
				protected $domainOwnerSettings = [
				'first_name' => 'John',
				'last_name' => 'Doe',
				'organization' => 'Test Domain Owner',
				];

				/**
				* Some users for the hosted domain, ultimately including the owner.
				*
				* @var \App\User[]
				*/
				protected $domainUsers = [];

				/**
				* A specific user that is a regular user in the hosted domain.
				*/
				protected $jack;

				/**
				* A specific user that is a controller on the wallet to which the hosted domain is charged.
				*/
				protected $jane;

				/**
				* A specific user that has a second factor configured.
				*/
				protected $joe;

				/**
				* One of the domains that is available for public registration.
				*
				* @var \App\Domain
				*/
				protected $publicDomain;

				/**
				* A newly generated user in a public domain.
				*
				* @var \App\User
				*/
				protected $publicDomainUser;

				/**
				* A placeholder for a password that can be generated.
				*
				* Should be generated with `\App\Utils::generatePassphrase()`.
				*
				* @var string
				*/
				protected $userPassword;

				/**
				* Assert two numeric values are the same.
				*
				* @param int\|double\|float $a
				* @param int\|double\|float $b
				* @param string\|null $msg
				*/
				protected function assertEqual($a, $b, $msg = null)
				machniakUnsubmitted Done Inline Actions this will be confused with existing assertEquals(), and I don't see why not just use assertSame(). machniak: this will be confused with existing assertEquals(), and I don't see why not just use assertSame…
				{
				Assert::assertTrue(is_numeric($a), "Param #1 isn't numeric");
				Assert::assertTrue(is_numeric($b), "Param #2 isn't numeric");

				if (empty($msg)) {
				Assert::assertSame($a, $b);
				} else {
				Assert::assertSame($a, $b, $msg);
				}
				}

				/**
				* Assert that the entitlements for the user match the expected list of entitlements.
				*
				* @param \App\User $user The user for which the entitlements need to be pulled.
				* @param array $expected An array of expected \App\SKU titles.
				*/
	protected function assertUserEntitlements($user, $expected)			protected function assertUserEntitlements($user, $expected)
	{			{
	// Assert the user entitlements			// Assert the user entitlements
	$skus = $user->entitlements()->get()			$skus = $user->entitlements()->get()
	->map(function ($ent) {			->map(function ($ent) {
	return $ent->sku->title;			return $ent->sku->title;
	})			})
	->toArray();			->toArray();

	sort($skus);			sort($skus);

	Assert::assertSame($expected, $skus);			Assert::assertSame($expected, $skus);
	}			}

	/**			/**
				* Backdate entitlements to the desired target date.
				*
				* @param \App\Entitlement[] $entitlements
				* @param \Carbon\Carbon $targetDate
				*/
				protected function backdateEntitlements($entitlements, $targetDate)
				{
				foreach ($entitlements as $entitlement) {
				$entitlement->created_at = $targetDate;
				$entitlement->updated_at = $targetDate;
				$entitlement->save();

				$owner = $entitlement->wallet->domainOwner;
				$owner->created_at = $targetDate;
				$owner->save();
				}
				}

				/**
	* Creates the application.			* Creates the application.
	*			*
	* @return \Illuminate\Foundation\Application			* @return \Illuminate\Foundation\Application
	*/			*/
	public function createApplication()			public function createApplication()
	{			{
	$app = require __DIR__ . '/../bootstrap/app.php';			$app = require __DIR__ . '/../bootstrap/app.php';

	$app->make(Kernel::class)->bootstrap();			$app->make(Kernel::class)->bootstrap();

	return $app;			return $app;
	}			}

	/**			/**
	* Create a set of transaction log entries for a wallet			* Create a set of transaction log entries for a wallet
	*/			*/
	protected function createTestTransactions($wallet)			protected function createTestTransactions($wallet)
	{			{
	$result = [];			$result = [];
	$date = Carbon::now();			$date = Carbon::now();
	$debit = 0;			$debit = 0;
	$entitlementTransactions = [];			$entitlementTransactions = [];

	foreach ($wallet->entitlements as $entitlement) {			foreach ($wallet->entitlements as $entitlement) {
	if ($entitlement->cost) {			if ($entitlement->cost) {
	$debit += $entitlement->cost;			$debit += $entitlement->cost;
	$entitlementTransactions[] = $entitlement->createTransaction(			$entitlementTransactions[] = $entitlement->createTransaction(
	Transaction::ENTITLEMENT_BILLED,			Transaction::ENTITLEMENT_BILLED,
	$entitlement->cost			$entitlement->cost
	);			);
	}			}
	}			}

	$transaction = Transaction::create([			$transaction = Transaction::create(
				[
				machniakUnsubmitted Not Done Inline Actions I really don't like this extra newline. Our phpcs setup does not require this, maybe your editor? machniak: I really don't like this extra newline. Our phpcs setup does not require this, maybe your…
				vanmeeuwenAuthorUnsubmitted Done Inline Actions No, my reading habits do -- I read vertical space used much, much faster than horizontal space. vanmeeuwen: No, my reading habits do -- I read vertical space used much, much faster than horizontal space.
	'user_email' => 'jeroen@jeroen.jeroen',			'user_email' => 'jeroen@jeroen.jeroen',
	'object_id' => $wallet->id,			'object_id' => $wallet->id,
	'object_type' => \App\Wallet::class,			'object_type' => \App\Wallet::class,
	'type' => Transaction::WALLET_DEBIT,			'type' => Transaction::WALLET_DEBIT,
	'amount' => $debit,			'amount' => $debit,
	'description' => 'Payment',			'description' => 'Payment',
	]);			]
				);

	$result[] = $transaction;			$result[] = $transaction;

	Transaction::whereIn('id', $entitlementTransactions)->update(['transaction_id' => $transaction->id]);			Transaction::whereIn('id', $entitlementTransactions)->update(['transaction_id' => $transaction->id]);

	$transaction = Transaction::create([			$transaction = Transaction::create(
				[
	'user_email' => null,			'user_email' => null,
	'object_id' => $wallet->id,			'object_id' => $wallet->id,
	'object_type' => \App\Wallet::class,			'object_type' => \App\Wallet::class,
	'type' => Transaction::WALLET_CREDIT,			'type' => Transaction::WALLET_CREDIT,
	'amount' => 2000,			'amount' => 2000,
	'description' => 'Payment',			'description' => 'Payment',
	]);			]
				);

	$transaction->created_at = $date->next(Carbon::MONDAY);			$transaction->created_at = $date->next(Carbon::MONDAY);
	$transaction->save();			$transaction->save();

	$result[] = $transaction;			$result[] = $transaction;

	$types = [			$types = [
	Transaction::WALLET_AWARD,			Transaction::WALLET_AWARD,
	Transaction::WALLET_PENALTY,			Transaction::WALLET_PENALTY,
	];			];

	// The page size is 10, so we generate so many to have at least two pages			// The page size is 10, so we generate so many to have at least two pages
	$loops = 10;			$loops = 10;
	while ($loops-- > 0) {			while ($loops-- > 0) {
	$transaction = Transaction::create([			$transaction = Transaction::create(
				[
	'user_email' => 'jeroen.@jeroen.jeroen',			'user_email' => 'jeroen.@jeroen.jeroen',
	'object_id' => $wallet->id,			'object_id' => $wallet->id,
	'object_type' => \App\Wallet::class,			'object_type' => \App\Wallet::class,
	'type' => $types[count($result) % count($types)],			'type' => $types[count($result) % count($types)],
	'amount' => 11 * (count($result) + 1),			'amount' => 11 * (count($result) + 1),
	'description' => 'TRANS' . $loops,			'description' => 'TRANS' . $loops,
	]);			]
				);

	$transaction->created_at = $date->next(Carbon::MONDAY);			$transaction->created_at = $date->next(Carbon::MONDAY);
	$transaction->save();			$transaction->save();

	$result[] = $transaction;			$result[] = $transaction;
	}			}

	return $result;			return $result;
	}			}

				/**
				* Delete a test domain whatever it takes.
				*
				* @coversNothing
				*/
	protected function deleteTestDomain($name)			protected function deleteTestDomain($name)
	{			{
	Queue::fake();			Queue::fake();

	$domain = Domain::withTrashed()->where('namespace', $name)->first();			$domain = Domain::withTrashed()->where('namespace', $name)->first();

	if (!$domain) {			if (!$domain) {
	return;			return;
	}			}

	$job = new \App\Jobs\Domain\DeleteJob($domain->id);			$job = new \App\Jobs\Domain\DeleteJob($domain->id);
	$job->handle();			$job->handle();

	$domain->forceDelete();			$domain->forceDelete();
	}			}

				/**
				* Delete a test user whatever it takes.
				*
				* @coversNothing
				*/
	protected function deleteTestUser($email)			protected function deleteTestUser($email)
	{			{
	Queue::fake();			Queue::fake();

	$user = User::withTrashed()->where('email', $email)->first();			$user = User::withTrashed()->where('email', $email)->first();

	if (!$user) {			if (!$user) {
	return;			return;
	}			}

	$job = new \App\Jobs\User\DeleteJob($user->id);			$job = new \App\Jobs\User\DeleteJob($user->id);
	$job->handle();			$job->handle();

	$user->forceDelete();			$user->forceDelete();
	}			}

	/**			/**
				* Helper to access protected property of an object
				*/
				protected static function getObjectProperty($object, $property_name)
				{
				$reflection = new \ReflectionClass($object);
				$property = $reflection->getProperty($property_name);
				$property->setAccessible(true);

				return $property->getValue($object);
				}

				/**
	* Get Domain object by namespace, create it if needed.			* Get Domain object by namespace, create it if needed.
	* Skip LDAP jobs.			* Skip LDAP jobs.
				*
				* @coversNothing
	*/			*/
	protected function getTestDomain($name, $attrib = [])			protected function getTestDomain($name, $attrib = [])
	{			{
	// Disable jobs (i.e. skip LDAP oprations)			// Disable jobs (i.e. skip LDAP oprations)
	Queue::fake();			Queue::fake();
	return Domain::firstOrCreate(['namespace' => $name], $attrib);			return Domain::firstOrCreate(['namespace' => $name], $attrib);
	}			}

	/**			/**
	* Get User object by email, create it if needed.			* Get User object by email, create it if needed.
	* Skip LDAP jobs.			* Skip LDAP jobs.
				*
				* @coversNothing
	*/			*/
	protected function getTestUser($email, $attrib = [])			protected function getTestUser($email, $attrib = [])
	{			{
	// Disable jobs (i.e. skip LDAP oprations)			// Disable jobs (i.e. skip LDAP oprations)
	Queue::fake();			Queue::fake();
	$user = User::withTrashed()->where('email', $email)->first();			$user = User::withTrashed()->where('email', $email)->first();

	if (!$user) {			if (!$user) {
	return User::firstOrCreate(['email' => $email], $attrib);			return User::firstOrCreate(['email' => $email], $attrib);
	}			}

	if ($user->deleted_at) {			if ($user->deleted_at) {
	$user->restore();			$user->restore();
	}			}

	return $user;			return $user;
	}			}

	/**			/**
	* Helper to access protected property of an object
	*/
	protected static function getObjectProperty($object, $property_name)
	{
	$reflection = new \ReflectionClass($object);
	$property = $reflection->getProperty($property_name);
	$property->setAccessible(true);

	return $property->getValue($object);
	}

	/**
	* Call protected/private method of a class.			* Call protected/private method of a class.
	*			*
	* @param object $object Instantiated object that we will run method on.			* @param object $object Instantiated object that we will run method on.
	* @param string $methodName Method name to call			* @param string $methodName Method name to call
	* @param array $parameters Array of parameters to pass into method.			* @param array $parameters Array of parameters to pass into method.
	*			*
	* @return mixed Method return.			* @return mixed Method return.
	*/			*/
	protected function invokeMethod($object, $methodName, array $parameters = array())			protected function invokeMethod($object, $methodName, array $parameters = array())
	{			{
	$reflection = new \ReflectionClass(get_class($object));			$reflection = new \ReflectionClass(get_class($object));
	$method = $reflection->getMethod($methodName);			$method = $reflection->getMethod($methodName);
	$method->setAccessible(true);			$method->setAccessible(true);

	return $method->invokeArgs($object, $parameters);			return $method->invokeArgs($object, $parameters);
	}			}

				public function setUp(): void
				machniakUnsubmitted Not Done Inline Actions This will be applied to every test. I don't like it. Maybe it should be in a separate trait, that you'd add to tests you really need to. machniak: This will be applied to every test. I don't like it. Maybe it should be in a separate trait…
				vanmeeuwenAuthorUnsubmitted Done Inline Actions We can change it further when we have switched over most if not all tests to using volatile fixtures and not seeded contents, and split up multiple test functions per test class such that there's only one series of tests per class (currently all test functions assert the same start state). vanmeeuwen: We can change it further when we have switched over most if not all tests to using volatile…
				machniakUnsubmitted Not Done Inline Actions In my eyes this creates a mess right now. Isn't that breaking any existing tests? machniak: In my eyes this creates a mess right now. Isn't that breaking any existing tests?
				vanmeeuwenAuthorUnsubmitted Done Inline Actions Existing tests either use seeded content or set themselves up with a per-test domain/users/etc. In dev/testing though, all tests are intended to use one single set of 'fixtures' -- however many of those there may be, and in however many "sets" we may break them down so as to make tests run more efficiently, and to whichever extent we may indeed refactor tests such that fixtures setup and teardown can happen once per class rather than once per test. vanmeeuwen: Existing tests either use seeded content or set themselves up with a per-test domain/users/etc.
				{
				parent::setUp();

				$this->userPassword = \App\Utils::generatePassphrase();

				$this->domainHosted = $this->getTestDomain(
				'test.domain',
				[
				'type' => \App\Domain::TYPE_EXTERNAL,
				'status' => \App\Domain::STATUS_ACTIVE \| \App\Domain::STATUS_CONFIRMED \| \App\Domain::STATUS_VERIFIED
				]
				);

				$packageKolab = \App\Package::where('title', 'kolab')->first();

				$this->domainOwner = $this->getTestUser('john@test.domain', ['password' => $this->userPassword]);
				$this->domainOwner->assignPackage($packageKolab);
				$this->domainOwner->setSettings($this->domainOwnerSettings);

				// separate for regular user
				$this->jack = $this->getTestUser('jack@test.domain', ['password' => $this->userPassword]);

				// separate for wallet controller
				$this->jane = $this->getTestUser('jane@test.domain', ['password' => $this->userPassword]);

				$this->joe = $this->getTestUser('joe@test.domain', ['password' => $this->userPassword]);

				$this->domainUsers[] = $this->jack;
				$this->domainUsers[] = $this->jane;
				$this->domainUsers[] = $this->joe;
				$this->domainUsers[] = $this->getTestUser('jill@test.domain', ['password' => $this->userPassword]);

				foreach ($this->domainUsers as $user) {
				$this->domainOwner->assignPackage($packageKolab, $user);
				}

				$this->domainUsers[] = $this->domainOwner;

				// assign second factor to joe
				$this->joe->assignSku(\App\Sku::where('title', '2fa')->first());
				\App\Auth\SecondFactor::seed($this->joe->email);

				usort(
				$this->domainUsers,
				function ($a, $b) {
				return $a->email > $b->email;
				}
				);

				$this->domainHosted->assignPackage(
				\App\Package::where('title', 'domain-hosting')->first(),
				$this->domainOwner
				);

				$wallet = $this->domainOwner->wallets()->first();

				$wallet->addController($this->jane);

				$this->publicDomain = \App\Domain::where('type', \App\Domain::TYPE_PUBLIC)->first();
				$this->publicDomainUser = $this->getTestUser(
				'john@' . $this->publicDomain->namespace,
				['password' => $this->userPassword]
				);

				$this->publicDomainUser->assignPackage($packageKolab);
				}

				public function tearDown(): void
				{
				foreach ($this->domainUsers as $user) {
				if ($user == $this->domainOwner) {
				continue;
				}

				$this->deleteTestUser($user->email);
				}

				$this->deleteTestUser($this->domainOwner->email);
				$this->deleteTestDomain($this->domainHosted->namespace);

				$this->deleteTestUser($this->publicDomainUser->email);

				parent::tearDown();
				}
	}			}