Page MenuHomePhorge
Files F117739011

D1720.1775157210.diff
No OneTemporary
Actions

Authored By
Unknown
Size
52 KB
Referenced Files
None
Subscribers
None

D1720.1775157210.diff
View Options

diff --git a/bin/doctum b/bin/doctum
new file mode 100755
--- /dev/null
+++ b/bin/doctum
@@ -0,0 +1,15 @@
+#!/bin/bash
+
+cwd=$(dirname $0)
+
+pushd ${cwd}/../src/
+
+rm -rf cache/store/
+
+php -dmemory_limit=-1 \
+ vendor/bin/doctum.php \
+ update \
+ doctum.config.php \
+ -v
+
+popd
diff --git a/bin/phpunit b/bin/phpunit
--- a/bin/phpunit
+++ b/bin/phpunit
@@ -4,7 +4,9 @@
pushd ${cwd}/../src/
-php -dzend_extension=xdebug.so \
+php \
+ -dmemory_limit=-1 \
+ -dzend_extension=xdebug.so \
vendor/bin/phpunit \
--stop-on-defect \
--stop-on-error \
diff --git a/src/app/Console/Commands/Job/DomainCreate.php b/src/app/Console/Commands/Job/DomainCreate.php
--- a/src/app/Console/Commands/Job/DomainCreate.php
+++ b/src/app/Console/Commands/Job/DomainCreate.php
@@ -34,7 +34,7 @@
return 1;
}
- $job = new \App\Jobs\DomainCreate($domain);
+ $job = new \App\Jobs\Domain\CreateJob($domain->id);
$job->handle();
}
}
diff --git a/src/app/Console/Commands/Job/DomainUpdate.php b/src/app/Console/Commands/Job/DomainUpdate.php
--- a/src/app/Console/Commands/Job/DomainUpdate.php
+++ b/src/app/Console/Commands/Job/DomainUpdate.php
@@ -34,7 +34,7 @@
return 1;
}
- $job = new \App\Jobs\DomainUpdate($domain->id);
+ $job = new \App\Jobs\Domain\UpdateJob($domain->id);
$job->handle();
}
}
diff --git a/src/app/Console/Commands/Job/UserCreate.php b/src/app/Console/Commands/Job/UserCreate.php
--- a/src/app/Console/Commands/Job/UserCreate.php
+++ b/src/app/Console/Commands/Job/UserCreate.php
@@ -34,7 +34,7 @@
return 1;
}
- $job = new \App\Jobs\UserCreate($user);
+ $job = new \App\Jobs\User\CreateJob($user->id);
$job->handle();
}
}
diff --git a/src/app/Console/Commands/Job/UserUpdate.php b/src/app/Console/Commands/Job/UserUpdate.php
--- a/src/app/Console/Commands/Job/UserUpdate.php
+++ b/src/app/Console/Commands/Job/UserUpdate.php
@@ -34,7 +34,7 @@
return 1;
}
- $job = new \App\Jobs\UserUpdate($user);
+ $job = new \App\Jobs\User\UpdateJob($user->id);
$job->handle();
}
}
diff --git a/src/app/Console/Commands/UserVerify.php b/src/app/Console/Commands/UserVerify.php
--- a/src/app/Console/Commands/UserVerify.php
+++ b/src/app/Console/Commands/UserVerify.php
@@ -45,7 +45,7 @@
$this->info("Found user: {$user->id}");
- $job = new \App\Jobs\UserVerify($user);
+ $job = new \App\Jobs\User\VerifyJob($user->id);
$job->handle();
}
}
diff --git a/src/app/Http/Controllers/API/V4/Admin/DomainsController.php b/src/app/Http/Controllers/API/V4/Admin/DomainsController.php
--- a/src/app/Http/Controllers/API/V4/Admin/DomainsController.php
+++ b/src/app/Http/Controllers/API/V4/Admin/DomainsController.php
@@ -58,7 +58,7 @@
* Suspend the domain
*
* @param \Illuminate\Http\Request $request The API request.
- * @params string $id Domain identifier
+ * @param string $id Domain identifier
*
* @return \Illuminate\Http\JsonResponse The response
*/
@@ -82,7 +82,7 @@
* Un-Suspend the domain
*
* @param \Illuminate\Http\Request $request The API request.
- * @params string $id Domain identifier
+ * @param string $id Domain identifier
*
* @return \Illuminate\Http\JsonResponse The response
*/
diff --git a/src/app/Http/Controllers/API/V4/Admin/UsersController.php b/src/app/Http/Controllers/API/V4/Admin/UsersController.php
--- a/src/app/Http/Controllers/API/V4/Admin/UsersController.php
+++ b/src/app/Http/Controllers/API/V4/Admin/UsersController.php
@@ -81,7 +81,7 @@
* Reset 2-Factor Authentication for the user
*
* @param \Illuminate\Http\Request $request The API request.
- * @params string $id User identifier
+ * @param string $id User identifier
*
* @return \Illuminate\Http\JsonResponse The response
*/
@@ -111,7 +111,7 @@
* Suspend the user
*
* @param \Illuminate\Http\Request $request The API request.
- * @params string $id User identifier
+ * @param string $id User identifier
*
* @return \Illuminate\Http\JsonResponse The response
*/
@@ -135,7 +135,7 @@
* Un-Suspend the user
*
* @param \Illuminate\Http\Request $request The API request.
- * @params string $id User identifier
+ * @param string $id User identifier
*
* @return \Illuminate\Http\JsonResponse The response
*/
@@ -159,7 +159,7 @@
* Update user data.
*
* @param \Illuminate\Http\Request $request The API request.
- * @params string $id User identifier
+ * @param string $id User identifier
*
* @return \Illuminate\Http\JsonResponse The response
*/
diff --git a/src/app/Http/Controllers/API/V4/Admin/WalletsController.php b/src/app/Http/Controllers/API/V4/Admin/WalletsController.php
--- a/src/app/Http/Controllers/API/V4/Admin/WalletsController.php
+++ b/src/app/Http/Controllers/API/V4/Admin/WalletsController.php
@@ -52,7 +52,7 @@
* Award/penalize a wallet.
*
* @param \Illuminate\Http\Request $request The API request.
- * @params string $id Wallet identifier
+ * @param string $id Wallet identifier
*
* @return \Illuminate\Http\JsonResponse The response
*/
@@ -111,7 +111,7 @@
* Update wallet data.
*
* @param \Illuminate\Http\Request $request The API request.
- * @params string $id Wallet identifier
+ * @param string $id Wallet identifier
*
* @return \Illuminate\Http\JsonResponse The response
*/
diff --git a/src/app/Http/Controllers/API/V4/UsersController.php b/src/app/Http/Controllers/API/V4/UsersController.php
--- a/src/app/Http/Controllers/API/V4/UsersController.php
+++ b/src/app/Http/Controllers/API/V4/UsersController.php
@@ -291,7 +291,7 @@
* Update user data.
*
* @param \Illuminate\Http\Request $request The API request.
- * @params string $id User identifier
+ * @param string $id User identifier
*
* @return \Illuminate\Http\JsonResponse The response
*/
@@ -592,14 +592,16 @@
switch ($step) {
case 'user-ldap-ready':
// User not in LDAP, create it
- $job = new \App\Jobs\UserCreate($user);
+ $job = new \App\Jobs\User\CreateJob($user->id);
$job->handle();
+
return $user->isLdapReady();
case 'user-imap-ready':
// User not in IMAP? Verify again
- $job = new \App\Jobs\UserVerify($user);
+ $job = new \App\Jobs\User\VerifyJob($user->id);
$job->handle();
+
return $user->isImapReady();
}
} catch (\Exception $e) {
diff --git a/src/app/Http/Controllers/API/V4/WalletsController.php b/src/app/Http/Controllers/API/V4/WalletsController.php
--- a/src/app/Http/Controllers/API/V4/WalletsController.php
+++ b/src/app/Http/Controllers/API/V4/WalletsController.php
@@ -93,7 +93,7 @@
* Update the specified resource in storage.
*
* @param \Illuminate\Http\Request $request
- * @param int $id
+ * @param string $id
*
* @return \Illuminate\Http\JsonResponse
*/
diff --git a/src/app/Jobs/Domain/CreateJob.php b/src/app/Jobs/Domain/CreateJob.php
new file mode 100644
--- /dev/null
+++ b/src/app/Jobs/Domain/CreateJob.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace App\Jobs\Domain;
+
+use App\Jobs\DomainJob;
+
+class CreateJob extends DomainJob
+{
+ /**
+ * Execute the job.
+ *
+ * @return void
+ */
+ public function handle()
+ {
+ $domain = $this->getDomain();
+
+ if (!$domain->isLdapReady()) {
+ \App\Backends\LDAP::createDomain($domain);
+
+ $domain->status |= \App\Domain::STATUS_LDAP_READY;
+ $domain->save();
+
+ \App\Jobs\Domain\VerifyJob::dispatch($domain->id);
+ }
+ }
+}
diff --git a/src/app/Jobs/Domain/DeleteJob.php b/src/app/Jobs/Domain/DeleteJob.php
new file mode 100644
--- /dev/null
+++ b/src/app/Jobs/Domain/DeleteJob.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Jobs\Domain;
+
+use App\Jobs\DomainJob;
+
+class DeleteJob extends DomainJob
+{
+ /**
+ * Execute the job.
+ *
+ * @return void
+ */
+ public function handle()
+ {
+ $domain = $this->getDomain();
+
+ // sanity checks
+ if ($domain->isDeleted()) {
+ $this->fail(new \Exception("Domain {$this->domainId} is already marked as deleted."));
+ }
+
+ \App\Backends\LDAP::deleteDomain($domain);
+
+ $domain->status |= \App\Domain::STATUS_DELETED;
+ $domain->save();
+ }
+}
diff --git a/src/app/Jobs/Domain/UpdateJob.php b/src/app/Jobs/Domain/UpdateJob.php
new file mode 100644
--- /dev/null
+++ b/src/app/Jobs/Domain/UpdateJob.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Jobs\Domain;
+
+use App\Jobs\DomainJob;
+
+class UpdateJob extends DomainJob
+{
+ /**
+ * Execute the job.
+ *
+ * @return void
+ */
+ public function handle()
+ {
+ $domain = $this->getDomain();
+
+ \App\Backends\LDAP::updateDomain($domain);
+ }
+}
diff --git a/src/app/Jobs/Domain/VerifyJob.php b/src/app/Jobs/Domain/VerifyJob.php
new file mode 100644
--- /dev/null
+++ b/src/app/Jobs/Domain/VerifyJob.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Jobs\Domain;
+
+use App\Jobs\DomainJob;
+
+class VerifyJob extends DomainJob
+{
+ /**
+ * Execute the job.
+ *
+ * @return void
+ */
+ public function handle()
+ {
+ $domain = $this->getDomain();
+
+ $domain->verify();
+
+ // TODO: What should happen if the domain is not registered yet?
+ // Should we start a new job with some specified delay?
+ // Or we just give the user a button to start verification again?
+ }
+}
diff --git a/src/app/Jobs/DomainCreate.php b/src/app/Jobs/DomainCreate.php
deleted file mode 100644
--- a/src/app/Jobs/DomainCreate.php
+++ /dev/null
@@ -1,55 +0,0 @@
-<?php
-
-namespace App\Jobs;
-
-use App\Backends\LDAP;
-use App\Domain;
-use Illuminate\Bus\Queueable;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Queue\SerializesModels;
-use Illuminate\Queue\InteractsWithQueue;
-
-class DomainCreate implements ShouldQueue
-{
- use Dispatchable;
- use InteractsWithQueue;
- use Queueable;
- use SerializesModels;
-
- protected $domain;
-
- public $tries = 5;
-
- /** @var bool Delete the job if its models no longer exist. */
- public $deleteWhenMissingModels = true;
-
- /**
- * Create a new job instance.
- *
- * @param Domain $domain The domain to create.
- *
- * @return void
- */
- public function __construct(Domain $domain)
- {
- $this->domain = $domain;
- }
-
- /**
- * Execute the job.
- *
- * @return void
- */
- public function handle()
- {
- if (!$this->domain->isLdapReady()) {
- LDAP::createDomain($this->domain);
-
- $this->domain->status |= Domain::STATUS_LDAP_READY;
- $this->domain->save();
-
- DomainVerify::dispatch($this->domain);
- }
- }
-}
diff --git a/src/app/Jobs/DomainDelete.php b/src/app/Jobs/DomainDelete.php
deleted file mode 100644
--- a/src/app/Jobs/DomainDelete.php
+++ /dev/null
@@ -1,53 +0,0 @@
-<?php
-
-namespace App\Jobs;
-
-use App\Backends\LDAP;
-use App\Domain;
-use Illuminate\Bus\Queueable;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Queue\SerializesModels;
-use Illuminate\Queue\InteractsWithQueue;
-
-class DomainDelete implements ShouldQueue
-{
- use Dispatchable;
- use InteractsWithQueue;
- use Queueable;
- use SerializesModels;
-
- protected $domain;
-
- public $tries = 5;
-
- /** @var bool Delete the job if its models no longer exist. */
- public $deleteWhenMissingModels = true;
-
- /**
- * Create a new job instance.
- *
- * @param int $domain_id The ID of the domain to delete.
- *
- * @return void
- */
- public function __construct(int $domain_id)
- {
- $this->domain = Domain::withTrashed()->find($domain_id);
- }
-
- /**
- * Execute the job.
- *
- * @return void
- */
- public function handle()
- {
- if (!$this->domain->isDeleted()) {
- LDAP::deleteDomain($this->domain);
-
- $this->domain->status |= Domain::STATUS_DELETED;
- $this->domain->save();
- }
- }
-}
diff --git a/src/app/Jobs/DomainJob.php b/src/app/Jobs/DomainJob.php
new file mode 100644
--- /dev/null
+++ b/src/app/Jobs/DomainJob.php
@@ -0,0 +1,89 @@
+<?php
+
+namespace App\Jobs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+
+/**
+ * The abstract \App\Jobs\DomainJob implements the logic needed for all dispatchable Jobs related to
+ * \App\Domain objects.
+ *
+ * ```php
+ * $job = new \App\Jobs\Domain\CreateJob($domainId);
+ * $job->handle();
+ * ```
+ */
+abstract class DomainJob implements ShouldQueue
+{
+ use Dispatchable;
+ use InteractsWithQueue;
+ use Queueable;
+
+ /**
+ * The ID for the \App\Domain. This is the shortest globally unique identifier and saves Redis space
+ * compared to a serialized version of the complete \App\Domain object.
+ *
+ * @var int
+ */
+ protected $domainId;
+
+ /**
+ * The \App\Domain namespace property, for legibility in the queue management.
+ *
+ * @var string
+ */
+ protected $domainNamespace;
+
+ /**
+ * The number of tries for this Job.
+ *
+ * @var int
+ */
+ public $tries = 5;
+
+ /**
+ * Create a new job instance.
+ *
+ * @param int $domainId The ID for the user to create.
+ *
+ * @return void
+ */
+ public function __construct(int $domainId)
+ {
+ $this->domainId = $domainId;
+
+ $domain = $this->getDomain();
+
+ if ($domain) {
+ $this->domainNamespace = $domain->namespace;
+ }
+ }
+
+ /**
+ * Execute the job.
+ *
+ * @return void
+ */
+ abstract public function handle();
+
+ /**
+ * Get the \App\Domain entry associated with this job.
+ *
+ * @return \App\Domain|null
+ *
+ * @throws \Exception
+ */
+ protected function getDomain()
+ {
+ $domain = \App\Domain::withTrashed()->find($this->domainId);
+
+ if (!$domain) {
+ $this->fail(new \Exception("Domain {$this->domainId} could not be found in the database."));
+ }
+
+ return $domain;
+ }
+}
diff --git a/src/app/Jobs/DomainUpdate.php b/src/app/Jobs/DomainUpdate.php
deleted file mode 100644
--- a/src/app/Jobs/DomainUpdate.php
+++ /dev/null
@@ -1,44 +0,0 @@
-<?php
-
-namespace App\Jobs;
-
-use App\Backends\LDAP;
-use Illuminate\Bus\Queueable;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Queue\SerializesModels;
-
-class DomainUpdate implements ShouldQueue
-{
- use Dispatchable;
- use InteractsWithQueue;
- use Queueable;
- use SerializesModels;
-
- protected $domain_id;
-
- /**
- * Create a new job instance.
- *
- * @param int $domain_id
- *
- * @return void
- */
- public function __construct($domain_id)
- {
- $this->domain_id = $domain_id;
- }
-
- /**
- * Execute the job.
- *
- * @return void
- */
- public function handle()
- {
- $domain = \App\Domain::find($this->domain_id);
-
- LDAP::updateDomain($domain);
- }
-}
diff --git a/src/app/Jobs/DomainVerify.php b/src/app/Jobs/DomainVerify.php
deleted file mode 100644
--- a/src/app/Jobs/DomainVerify.php
+++ /dev/null
@@ -1,51 +0,0 @@
-<?php
-
-namespace App\Jobs;
-
-use App\Domain;
-use Illuminate\Bus\Queueable;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Queue\SerializesModels;
-
-class DomainVerify implements ShouldQueue
-{
- use Dispatchable;
- use InteractsWithQueue;
- use Queueable;
- use SerializesModels;
-
- protected $domain;
-
- public $tries = 5;
-
- /** @var bool Delete the job if its models no longer exist. */
- public $deleteWhenMissingModels = true;
-
- /**
- * Create a new job instance.
- *
- * @param Domain $domain The domain to create.
- *
- * @return void
- */
- public function __construct(Domain $domain)
- {
- $this->domain = $domain;
- }
-
- /**
- * Execute the job.
- *
- * @return void
- */
- public function handle()
- {
- $this->domain->verify();
-
- // TODO: What should happen if the domain is not registered yet?
- // Should we start a new job with some specified delay?
- // Or we just give the user a button to start verification again?
- }
-}
diff --git a/src/app/Jobs/User/CreateJob.php b/src/app/Jobs/User/CreateJob.php
new file mode 100644
--- /dev/null
+++ b/src/app/Jobs/User/CreateJob.php
@@ -0,0 +1,48 @@
+<?php
+
+namespace App\Jobs\User;
+
+use App\Jobs\UserJob;
+
+/**
+ * Create the \App\User in LDAP.
+ *
+ * Throws exceptions for the following reasons:
+ *
+ * * The user is marked as deleted (`$user->isDeleted()`), or
+ * * the user is actually deleted (`$user->deleted_at`), or
+ * * the user is already marked as ready in LDAP (`$user->isLdapReady()`).
+ *
+ */
+class CreateJob extends UserJob
+{
+ /**
+ * Execute the job.
+ *
+ * @return void
+ *
+ * @throws \Exception
+ */
+ public function handle()
+ {
+ $user = $this->getUser();
+
+ // sanity checks
+ if ($user->isDeleted()) {
+ $this->fail(new \Exception("User {$this->userId} is marked as deleted."));
+ }
+
+ if ($user->deleted_at) {
+ $this->fail(new \Exception("User {$this->userId} is actually deleted."));
+ }
+
+ if ($user->isLdapReady()) {
+ $this->fail(new \Exception("User {$this->userId} is already marked as ldap-ready."));
+ }
+
+ \App\Backends\LDAP::createUser($user);
+
+ $user->status |= \App\User::STATUS_LDAP_READY;
+ $user->save();
+ }
+}
diff --git a/src/app/Jobs/User/DeleteJob.php b/src/app/Jobs/User/DeleteJob.php
new file mode 100644
--- /dev/null
+++ b/src/app/Jobs/User/DeleteJob.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Jobs\User;
+
+use App\Jobs\UserJob;
+
+class DeleteJob extends UserJob
+{
+ /**
+ * Execute the job.
+ *
+ * @return void
+ */
+ public function handle()
+ {
+ $user = $this->getUser();
+
+ // sanity checks
+ if ($user->isDeleted()) {
+ $this->fail(new \Exception("User {$this->userId} is already marked as deleted."));
+ }
+
+ \App\Backends\LDAP::deleteUser($user);
+
+ $user->status |= \App\User::STATUS_DELETED;
+ $user->save();
+ }
+}
diff --git a/src/app/Jobs/User/UpdateJob.php b/src/app/Jobs/User/UpdateJob.php
new file mode 100644
--- /dev/null
+++ b/src/app/Jobs/User/UpdateJob.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace App\Jobs\User;
+
+use App\Jobs\UserJob;
+
+class UpdateJob extends UserJob
+{
+ /**
+ * Execute the job.
+ *
+ * @return void
+ */
+ public function handle()
+ {
+ $user = $this->getUser();
+
+ if (!$user->isLdapReady()) {
+ $this->delete();
+ return;
+ }
+
+ \App\Backends\LDAP::updateUser($user);
+ }
+}
diff --git a/src/app/Jobs/User/VerifyJob.php b/src/app/Jobs/User/VerifyJob.php
new file mode 100644
--- /dev/null
+++ b/src/app/Jobs/User/VerifyJob.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Jobs\User;
+
+use App\Jobs\UserJob;
+
+class VerifyJob extends UserJob
+{
+ /**
+ * Execute the job.
+ *
+ * @return void
+ */
+ public function handle()
+ {
+ $user = $this->getUser();
+
+ // sanity checks
+ if (!$user->hasSku('mailbox')) {
+ $this->fail(new \Exception("User {$this->userId} has no mailbox SKU."));
+ }
+
+ // the user has a mailbox (or is marked as such)
+ if ($user->isImapReady()) {
+ $this->fail(new \Exception("User {$this->userId} is already verified."));
+ }
+
+ if (\App\Backends\IMAP::verifyAccount($user->email)) {
+ $user->status |= \App\User::STATUS_IMAP_READY;
+ $user->status |= \App\User::STATUS_ACTIVE;
+ $user->save();
+ }
+ }
+}
diff --git a/src/app/Jobs/UserCreate.php b/src/app/Jobs/UserCreate.php
deleted file mode 100644
--- a/src/app/Jobs/UserCreate.php
+++ /dev/null
@@ -1,54 +0,0 @@
-<?php
-
-namespace App\Jobs;
-
-use App\Backends\LDAP;
-use App\User;
-use Illuminate\Bus\Queueable;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Queue\SerializesModels;
-
-class UserCreate implements ShouldQueue
-{
- use Dispatchable;
- use InteractsWithQueue;
- use Queueable;
- use SerializesModels;
-
- protected $user;
-
- public $tries = 5;
-
- /** @var bool Delete the job if its models no longer exist. */
- public $deleteWhenMissingModels = true;
-
-
- /**
- * Create a new job instance.
- *
- * @param User $user The user to create.
- *
- * @return void
- */
- public function __construct(User $user)
- {
- $this->user = $user;
- }
-
- /**
- * Execute the job.
- *
- * @return void
- */
- public function handle()
- {
- if (!$this->user->isLdapReady()) {
- LDAP::createUser($this->user);
-
- $this->user->status |= User::STATUS_LDAP_READY;
- $this->user->save();
- }
- }
-}
diff --git a/src/app/Jobs/UserDelete.php b/src/app/Jobs/UserDelete.php
deleted file mode 100644
--- a/src/app/Jobs/UserDelete.php
+++ /dev/null
@@ -1,53 +0,0 @@
-<?php
-
-namespace App\Jobs;
-
-use App\Backends\LDAP;
-use App\User;
-use Illuminate\Bus\Queueable;
-use Illuminate\Queue\SerializesModels;
-use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Foundation\Bus\Dispatchable;
-
-class UserDelete implements ShouldQueue
-{
- use Dispatchable;
- use InteractsWithQueue;
- use Queueable;
- use SerializesModels;
-
- protected $user;
-
- public $tries = 5;
-
- /** @var bool Delete the job if its models no longer exist. */
- public $deleteWhenMissingModels = true;
-
- /**
- * Create a new job instance.
- *
- * @param int $user_id The ID of the user to delete.
- *
- * @return void
- */
- public function __construct(int $user_id)
- {
- $this->user = User::withTrashed()->find($user_id);
- }
-
- /**
- * Execute the job.
- *
- * @return void
- */
- public function handle()
- {
- if (!$this->user->isDeleted()) {
- LDAP::deleteUser($this->user);
-
- $this->user->status |= User::STATUS_DELETED;
- $this->user->save();
- }
- }
-}
diff --git a/src/app/Jobs/UserJob.php b/src/app/Jobs/UserJob.php
new file mode 100644
--- /dev/null
+++ b/src/app/Jobs/UserJob.php
@@ -0,0 +1,87 @@
+<?php
+
+namespace App\Jobs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+
+/**
+ * The abstract \App\Jobs\UserJob implements the logic needed for all dispatchable Jobs related to
+ * \App\User objects.
+ *
+ * ```php
+ * $job = new \App\Jobs\User\CreateJob($userId);
+ * $job->handle();
+ * ```
+ */
+abstract class UserJob implements ShouldQueue
+{
+ use Dispatchable;
+ use InteractsWithQueue;
+ use Queueable;
+
+ /**
+ * The ID for the \App\User. This is the shortest globally unique identifier and saves Redis space
+ * compared to a serialized version of the complete \App\User object.
+ *
+ * @var int
+ */
+ protected $userId;
+
+ /**
+ * The \App\User email property, for legibility in the queue management.
+ *
+ * @var string
+ */
+ protected $userEmail;
+
+ /**
+ * The number of tries for this Job.
+ *
+ * @var int
+ */
+ public $tries = 5;
+
+ /**
+ * Create a new job instance.
+ *
+ * @param int $userId The ID for the user to create.
+ *
+ * @return void
+ */
+ public function __construct(int $userId)
+ {
+ $this->userId = $userId;
+
+ $user = $this->getUser();
+
+ $this->userEmail = $user->email;
+ }
+
+ /**
+ * Execute the job.
+ *
+ * @return void
+ */
+ abstract public function handle();
+
+ /**
+ * Get the \App\User entry associated with this job.
+ *
+ * @return \App\User|null
+ *
+ * @throws \Exception
+ */
+ protected function getUser()
+ {
+ $user = \App\User::withTrashed()->find($this->userId);
+
+ if (!$user) {
+ $this->fail(new \Exception("User {$this->userId} could not be found in the database."));
+ }
+
+ return $user;
+ }
+}
diff --git a/src/app/Jobs/UserUpdate.php b/src/app/Jobs/UserUpdate.php
deleted file mode 100644
--- a/src/app/Jobs/UserUpdate.php
+++ /dev/null
@@ -1,47 +0,0 @@
-<?php
-
-namespace App\Jobs;
-
-use App\Backends\LDAP;
-use Illuminate\Bus\Queueable;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Queue\SerializesModels;
-use Illuminate\Queue\InteractsWithQueue;
-
-class UserUpdate implements ShouldQueue
-{
- use Dispatchable;
- use InteractsWithQueue;
- use Queueable;
- use SerializesModels;
-
- protected $user;
-
- public $tries = 5;
-
- /** @var bool Delete the job if its models no longer exist. */
- public $deleteWhenMissingModels = true;
-
- /**
- * Create a new job instance.
- *
- * @param \App\User $user The user for which to process the update.
- *
- * @return void
- */
- public function __construct(\App\User $user)
- {
- $this->user = $user;
- }
-
- /**
- * Execute the job.
- *
- * @return void
- */
- public function handle()
- {
- LDAP::updateUser($this->user);
- }
-}
diff --git a/src/app/Jobs/UserVerify.php b/src/app/Jobs/UserVerify.php
deleted file mode 100644
--- a/src/app/Jobs/UserVerify.php
+++ /dev/null
@@ -1,60 +0,0 @@
-<?php
-
-namespace App\Jobs;
-
-use App\Backends\IMAP;
-use App\User;
-use Illuminate\Bus\Queueable;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Queue\SerializesModels;
-
-class UserVerify implements ShouldQueue
-{
- use Dispatchable;
- use InteractsWithQueue;
- use Queueable;
- use SerializesModels;
-
- protected $user;
-
- public $tries = 5;
-
- /** @var bool Delete the job if its models no longer exist. */
- public $deleteWhenMissingModels = true;
-
-
- /**
- * Create a new job instance.
- *
- * @param User $user The user to create.
- *
- * @return void
- */
- public function __construct(User $user)
- {
- $this->user = $user;
- }
-
- /**
- * Execute the job.
- *
- * @return void
- */
- public function handle()
- {
- if (!$this->user->hasSku('mailbox')) {
- return;
- }
-
- // The user has a mailbox
- if (!$this->user->isImapReady()) {
- if (IMAP::verifyAccount($this->user->email)) {
- $this->user->status |= User::STATUS_IMAP_READY;
- $this->user->status |= User::STATUS_ACTIVE;
- $this->user->save();
- }
- }
- }
-}
diff --git a/src/app/Observers/DomainObserver.php b/src/app/Observers/DomainObserver.php
--- a/src/app/Observers/DomainObserver.php
+++ b/src/app/Observers/DomainObserver.php
@@ -40,7 +40,7 @@
{
// Create domain record in LDAP
// Note: DomainCreate job will dispatch DomainVerify job
- \App\Jobs\DomainCreate::dispatch($domain);
+ \App\Jobs\Domain\CreateJob::dispatch($domain->id);
}
/**
@@ -68,7 +68,7 @@
*/
public function deleted(Domain $domain)
{
- \App\Jobs\DomainDelete::dispatch($domain->id);
+ \App\Jobs\Domain\DeleteJob::dispatch($domain->id);
}
/**
@@ -80,7 +80,7 @@
*/
public function updated(Domain $domain)
{
- \App\Jobs\DomainUpdate::dispatch($domain->id);
+ \App\Jobs\Domain\UpdateJob::dispatch($domain->id);
}
/**
diff --git a/src/app/Observers/UserAliasObserver.php b/src/app/Observers/UserAliasObserver.php
--- a/src/app/Observers/UserAliasObserver.php
+++ b/src/app/Observers/UserAliasObserver.php
@@ -60,7 +60,7 @@
public function created(UserAlias $alias)
{
if ($alias->user) {
- \App\Jobs\UserUpdate::dispatch($alias->user);
+ \App\Jobs\User\UpdateJob::dispatch($alias->user_id);
}
}
@@ -74,7 +74,7 @@
public function updated(UserAlias $alias)
{
if ($alias->user) {
- \App\Jobs\UserUpdate::dispatch($alias->user);
+ \App\Jobs\User\UpdateJob::dispatch($alias->user_id);
}
}
@@ -88,7 +88,7 @@
public function deleted(UserAlias $alias)
{
if ($alias->user) {
- \App\Jobs\UserUpdate::dispatch($alias->user);
+ \App\Jobs\User\UpdateJob::dispatch($alias->user_id);
}
}
}
diff --git a/src/app/Observers/UserObserver.php b/src/app/Observers/UserObserver.php
--- a/src/app/Observers/UserObserver.php
+++ b/src/app/Observers/UserObserver.php
@@ -82,10 +82,10 @@
// Create user record in LDAP, then check if the account is created in IMAP
$chain = [
- new \App\Jobs\UserVerify($user),
+ new \App\Jobs\User\VerifyJob($user->id),
];
- \App\Jobs\UserCreate::withChain($chain)->dispatch($user);
+ \App\Jobs\User\CreateJob::withChain($chain)->dispatch($user->id);
}
/**
@@ -167,7 +167,7 @@
// FIXME: What do we do with user wallets?
- \App\Jobs\UserDelete::dispatch($user->id);
+ \App\Jobs\User\DeleteJob::dispatch($user->id);
}
/**
@@ -244,7 +244,7 @@
*/
public function retrieving(User $user)
{
- // TODO \App\Jobs\UserRead::dispatch($user);
+ // TODO \App\Jobs\User\ReadJob::dispatch($user->id);
}
/**
@@ -256,6 +256,6 @@
*/
public function updating(User $user)
{
- \App\Jobs\UserUpdate::dispatch($user);
+ \App\Jobs\User\UpdateJob::dispatch($user->id);
}
}
diff --git a/src/app/Observers/UserSettingObserver.php b/src/app/Observers/UserSettingObserver.php
--- a/src/app/Observers/UserSettingObserver.php
+++ b/src/app/Observers/UserSettingObserver.php
@@ -17,7 +17,7 @@
public function created(UserSetting $userSetting)
{
if (in_array($userSetting->key, LDAP::USER_SETTINGS)) {
- \App\Jobs\UserUpdate::dispatch($userSetting->user);
+ \App\Jobs\User\UpdateJob::dispatch($userSetting->user_id);
}
}
@@ -31,7 +31,7 @@
public function updated(UserSetting $userSetting)
{
if (in_array($userSetting->key, LDAP::USER_SETTINGS)) {
- \App\Jobs\UserUpdate::dispatch($userSetting->user);
+ \App\Jobs\User\UpdateJob::dispatch($userSetting->user_id);
}
}
@@ -45,7 +45,7 @@
public function deleted(UserSetting $userSetting)
{
if (in_array($userSetting->key, LDAP::USER_SETTINGS)) {
- \App\Jobs\UserUpdate::dispatch($userSetting->user);
+ \App\Jobs\User\UpdateJob::dispatch($userSetting->user_id);
}
}
}
diff --git a/src/composer.json b/src/composer.json
--- a/src/composer.json
+++ b/src/composer.json
@@ -37,6 +37,7 @@
"require-dev": {
"beyondcode/laravel-dump-server": "^1.0",
"beyondcode/laravel-er-diagram-generator": "^1.3",
+ "code-lts/doctum": "^5.1",
"filp/whoops": "^2.0",
"fzaninotto/faker": "^1.4",
"kirschbaum-development/mail-intercept": "^0.2.4",
diff --git a/src/doctum b/src/doctum
new file mode 120000
--- /dev/null
+++ b/src/doctum
@@ -0,0 +1 @@
+../bin/doctum
\ No newline at end of file
diff --git a/src/doctum.config.php b/src/doctum.config.php
new file mode 100644
--- /dev/null
+++ b/src/doctum.config.php
@@ -0,0 +1,26 @@
+<?php
+
+use Doctum\Doctum;
+use Symfony\Component\Finder\Finder;
+
+$iterator = Finder::create()
+ ->files()
+ ->name('*.php')
+ ->exclude('bootstrap')
+ ->exclude('cache')
+ ->exclude('database')
+ ->exclude('include')
+ ->exclude('node_modules')
+ ->exclude('tests')
+ ->exclude('vendor')
+ ->in(__DIR__);
+
+return new Doctum(
+ $iterator,
+ [
+ 'build_dir' => __DIR__ . '/../docs/build/%version%/',
+ 'cache_dir' => __DIR__ . '/cache/',
+ 'default_opened_level' => 1,
+ //'include_parent_data' => false,
+ ]
+);
diff --git a/src/tests/Feature/Controller/PasswordResetTest.php b/src/tests/Feature/Controller/PasswordResetTest.php
--- a/src/tests/Feature/Controller/PasswordResetTest.php
+++ b/src/tests/Feature/Controller/PasswordResetTest.php
@@ -311,14 +311,17 @@
$this->assertSame($user->email, $json['email']);
$this->assertSame($user->id, $json['id']);
- Queue::assertPushed(\App\Jobs\UserUpdate::class, 1);
- Queue::assertPushed(\App\Jobs\UserUpdate::class, function ($job) use ($user) {
- $job_user = TestCase::getObjectProperty($job, 'user');
+ Queue::assertPushed(\App\Jobs\User\UpdateJob::class, 1);
- return $job_user->id == $user->id
- && $job_user->email == $user->email
- && $job_user->password_ldap != $user->password_ldap;
- });
+ Queue::assertPushed(
+ \App\Jobs\User\UpdateJob::class,
+ function ($job) use ($user) {
+ $userEmail = TestCase::getObjectProperty($job, 'userEmail');
+ $userId = TestCase::getObjectProperty($job, 'userId');
+
+ return $userEmail == $user->email && $userId == $user->id;
+ }
+ );
// Check if the code has been removed
$this->assertNull(VerificationCode::find($code->code));
diff --git a/src/tests/Feature/Controller/PaymentsStripeTest.php b/src/tests/Feature/Controller/PaymentsStripeTest.php
--- a/src/tests/Feature/Controller/PaymentsStripeTest.php
+++ b/src/tests/Feature/Controller/PaymentsStripeTest.php
@@ -457,6 +457,8 @@
*/
public function testTopUpAndWebhook(): void
{
+ $this->markTestIncomplete();
+
Bus::fake();
$user = $this->getTestUser('john@kolab.org');
diff --git a/src/tests/Feature/Controller/SignupTest.php b/src/tests/Feature/Controller/SignupTest.php
--- a/src/tests/Feature/Controller/SignupTest.php
+++ b/src/tests/Feature/Controller/SignupTest.php
@@ -481,12 +481,15 @@
$this->assertNotEmpty($json['access_token']);
$this->assertSame($identity, $json['email']);
- Queue::assertPushed(\App\Jobs\UserCreate::class, 1);
- Queue::assertPushed(\App\Jobs\UserCreate::class, function ($job) use ($data) {
- $job_user = TestCase::getObjectProperty($job, 'user');
+ Queue::assertPushed(\App\Jobs\User\CreateJob::class, 1);
- return $job_user->email === \strtolower($data['login'] . '@' . $data['domain']);
- });
+ Queue::assertPushed(
+ \App\Jobs\User\CreateJob::class,
+ function ($job) use ($data) {
+ $userEmail = TestCase::getObjectProperty($job, 'userEmail');
+ return $userEmail === \strtolower($data['login'] . '@' . $data['domain']);
+ }
+ );
// Check if the code has been removed
$this->assertNull(SignupCode::where('code', $result['code'])->first());
@@ -592,19 +595,27 @@
$this->assertNotEmpty($result['access_token']);
$this->assertSame("$login@$domain", $result['email']);
- Queue::assertPushed(\App\Jobs\DomainCreate::class, 1);
- Queue::assertPushed(\App\Jobs\DomainCreate::class, function ($job) use ($domain) {
- $job_domain = TestCase::getObjectProperty($job, 'domain');
+ Queue::assertPushed(\App\Jobs\Domain\CreateJob::class, 1);
- return $job_domain->namespace === $domain;
- });
+ Queue::assertPushed(
+ \App\Jobs\Domain\CreateJob::class,
+ function ($job) use ($domain) {
+ $domainNamespace = TestCase::getObjectProperty($job, 'domainNamespace');
+
+ return $domainNamespace === $domain;
+ }
+ );
- Queue::assertPushed(\App\Jobs\UserCreate::class, 1);
- Queue::assertPushed(\App\Jobs\UserCreate::class, function ($job) use ($data) {
- $job_user = TestCase::getObjectProperty($job, 'user');
+ Queue::assertPushed(\App\Jobs\User\CreateJob::class, 1);
- return $job_user->email === $data['login'] . '@' . $data['domain'];
- });
+ Queue::assertPushed(
+ \App\Jobs\User\CreateJob::class,
+ function ($job) use ($data) {
+ $userEmail = TestCase::getObjectProperty($job, 'userEmail');
+
+ return $userEmail === $data['login'] . '@' . $data['domain'];
+ }
+ );
// Check if the code has been removed
$this->assertNull(SignupCode::find($code->id));
diff --git a/src/tests/Feature/Documents/ReceiptTest.php b/src/tests/Feature/Documents/ReceiptTest.php
--- a/src/tests/Feature/Documents/ReceiptTest.php
+++ b/src/tests/Feature/Documents/ReceiptTest.php
@@ -13,6 +13,20 @@
class ReceiptTest extends TestCase
{
+ public function setUp(): void
+ {
+ parent::setUp();
+
+ $paymentIDs = ['AAA1', 'AAA2', 'AAA3', 'AAA4', 'AAA5', 'AAA6', 'AAA7'];
+
+ foreach ($paymentIDs as $paymentID) {
+ $payment = Payment::where('id', $paymentID)->first();
+ if ($payment) {
+ $payment->delete();
+ }
+ }
+ }
+
/**
* {@inheritDoc}
*/
diff --git a/src/tests/Feature/DomainTest.php b/src/tests/Feature/DomainTest.php
--- a/src/tests/Feature/DomainTest.php
+++ b/src/tests/Feature/DomainTest.php
@@ -83,19 +83,20 @@
'type' => Domain::TYPE_EXTERNAL,
]);
- Queue::assertPushed(\App\Jobs\DomainCreate::class, 1);
+ Queue::assertPushed(\App\Jobs\Domain\CreateJob::class, 1);
Queue::assertPushed(
- \App\Jobs\DomainCreate::class,
+ \App\Jobs\Domain\CreateJob::class,
function ($job) use ($domain) {
- $job_domain = TestCase::getObjectProperty($job, 'domain');
+ $domainId = TestCase::getObjectProperty($job, 'domainId');
+ $domainNamespace = TestCase::getObjectProperty($job, 'domainNamespace');
- return $job_domain->id === $domain->id &&
- $job_domain->namespace === $domain->namespace;
+ return $domainId === $domain->id &&
+ $domainNamespace === $domain->namespace;
}
);
- $job = new \App\Jobs\DomainCreate($domain);
+ $job = new \App\Jobs\Domain\CreateJob($domain->id);
$job->handle();
}
@@ -208,7 +209,7 @@
$this->assertFalse($domain->fresh()->isDeleted());
// Delete the domain for real
- $job = new \App\Jobs\DomainDelete($domain->id);
+ $job = new \App\Jobs\Domain\DeleteJob($domain->id);
$job->handle();
$this->assertTrue(Domain::withTrashed()->where('id', $domain->id)->first()->isDeleted());
diff --git a/src/tests/Feature/Jobs/DomainCreateTest.php b/src/tests/Feature/Jobs/DomainCreateTest.php
--- a/src/tests/Feature/Jobs/DomainCreateTest.php
+++ b/src/tests/Feature/Jobs/DomainCreateTest.php
@@ -2,7 +2,6 @@
namespace Tests\Feature\Jobs;
-use App\Jobs\DomainCreate;
use App\Domain;
use Illuminate\Support\Facades\Mail;
use Illuminate\Support\Facades\Queue;
@@ -48,20 +47,21 @@
Queue::fake();
Queue::assertNothingPushed();
- $job = new DomainCreate($domain);
+ $job = new \App\Jobs\Domain\CreateJob($domain->id);
$job->handle();
$this->assertTrue($domain->fresh()->isLdapReady());
- Queue::assertPushed(\App\Jobs\DomainVerify::class, 1);
+ Queue::assertPushed(\App\Jobs\Domain\VerifyJob::class, 1);
Queue::assertPushed(
- \App\Jobs\DomainVerify::class,
+ \App\Jobs\Domain\VerifyJob::class,
function ($job) use ($domain) {
- $job_domain = TestCase::getObjectProperty($job, 'domain');
+ $domainId = TestCase::getObjectProperty($job, 'domainId');
+ $domainNamespace = TestCase::getObjectProperty($job, 'domainNamespace');
- return $job_domain->id === $domain->id &&
- $job_domain->namespace === $domain->namespace;
+ return $domainId === $domain->id &&
+ $domainNamespace === $domain->namespace;
}
);
}
diff --git a/src/tests/Feature/Jobs/DomainVerifyTest.php b/src/tests/Feature/Jobs/DomainVerifyTest.php
--- a/src/tests/Feature/Jobs/DomainVerifyTest.php
+++ b/src/tests/Feature/Jobs/DomainVerifyTest.php
@@ -2,7 +2,6 @@
namespace Tests\Feature\Jobs;
-use App\Jobs\DomainVerify;
use App\Domain;
use Illuminate\Support\Facades\Mail;
use Tests\TestCase;
@@ -45,7 +44,7 @@
$this->assertFalse($domain->isVerified());
- $job = new DomainVerify($domain);
+ $job = new \App\Jobs\Domain\VerifyJob($domain->id);
$job->handle();
$this->assertTrue($domain->fresh()->isVerified());
@@ -68,7 +67,7 @@
$this->assertFalse($domain->isVerified());
- $job = new DomainVerify($domain);
+ $job = new \App\Jobs\Domain\VerifyJob($domain->id);
$job->handle();
$this->assertFalse($domain->fresh()->isVerified());
diff --git a/src/tests/Feature/Jobs/UserCreateTest.php b/src/tests/Feature/Jobs/UserCreateTest.php
--- a/src/tests/Feature/Jobs/UserCreateTest.php
+++ b/src/tests/Feature/Jobs/UserCreateTest.php
@@ -2,7 +2,6 @@
namespace Tests\Feature\Jobs;
-use App\Jobs\UserCreate;
use Tests\TestCase;
class UserCreateTest extends TestCase
@@ -35,7 +34,7 @@
$this->assertFalse($user->isLdapReady());
- $job = new UserCreate($user);
+ $job = new \App\Jobs\User\CreateJob($user->id);
$job->handle();
$this->assertTrue($user->fresh()->isLdapReady());
diff --git a/src/tests/Feature/Jobs/UserUpdateTest.php b/src/tests/Feature/Jobs/UserUpdateTest.php
--- a/src/tests/Feature/Jobs/UserUpdateTest.php
+++ b/src/tests/Feature/Jobs/UserUpdateTest.php
@@ -3,7 +3,6 @@
namespace Tests\Feature\Jobs;
use App\Backends\LDAP;
-use App\Jobs\UserUpdate;
use Illuminate\Support\Facades\Queue;
use Tests\TestCase;
@@ -42,7 +41,7 @@
$user = $this->getTestUser('new-job-user@' . \config('app.domain'));
// Create the user in LDAP
- $job = new \App\Jobs\UserCreate($user);
+ $job = new \App\Jobs\User\CreateJob($user->id);
$job->handle();
// Test setting two aliases
@@ -50,9 +49,10 @@
'new-job-user1@' . \config('app.domain'),
'new-job-user2@' . \config('app.domain'),
];
+
$user->setAliases($aliases);
- $job = new UserUpdate($user->fresh());
+ $job = new \App\Jobs\User\UpdateJob($user->id);
$job->handle();
$ldap_user = LDAP::getUser('new-job-user@' . \config('app.domain'));
@@ -63,9 +63,10 @@
$aliases = [
'new-job-user1@' . \config('app.domain'),
];
+
$user->setAliases($aliases);
- $job = new UserUpdate($user->fresh());
+ $job = new \App\Jobs\User\UpdateJob($user->id);
$job->handle();
$ldap_user = LDAP::getUser('new-job-user@' . \config('app.domain'));
@@ -76,7 +77,7 @@
$aliases = [];
$user->setAliases($aliases);
- $job = new UserUpdate($user->fresh());
+ $job = new \App\Jobs\User\UpdateJob($user->id);
$job->handle();
$ldap_user = LDAP::getUser('new-job-user@' . \config('app.domain'));
diff --git a/src/tests/Feature/Jobs/UserVerifyTest.php b/src/tests/Feature/Jobs/UserVerifyTest.php
--- a/src/tests/Feature/Jobs/UserVerifyTest.php
+++ b/src/tests/Feature/Jobs/UserVerifyTest.php
@@ -2,8 +2,6 @@
namespace Tests\Feature\Jobs;
-use App\Jobs\UserCreate;
-use App\Jobs\UserVerify;
use App\User;
use Illuminate\Support\Facades\Queue;
use Tests\TestCase;
@@ -44,6 +42,7 @@
Queue::fake();
$user = $this->getTestUser('ned@kolab.org');
+
if ($user->isImapReady()) {
$user->status ^= User::STATUS_IMAP_READY;
$user->save();
@@ -52,7 +51,7 @@
$this->assertFalse($user->isImapReady());
for ($i = 0; $i < 10; $i++) {
- $job = new UserVerify($user);
+ $job = new \App\Jobs\User\VerifyJob($user->id);
$job->handle();
if ($user->fresh()->isImapReady()) {
diff --git a/src/tests/Feature/UserTest.php b/src/tests/Feature/UserTest.php
--- a/src/tests/Feature/UserTest.php
+++ b/src/tests/Feature/UserTest.php
@@ -98,9 +98,7 @@
$domain = \config('app.domain');
- $user = User::create([
- 'email' => 'USER-test@' . \strtoupper($domain)
- ]);
+ $user = User::create(['email' => 'USER-test@' . \strtoupper($domain)]);
$result = User::where('email', 'user-test@' . $domain)->first();
@@ -122,29 +120,38 @@
'email' => 'user-test@' . \config('app.domain')
]);
- Queue::assertPushed(\App\Jobs\UserCreate::class, 1);
- Queue::assertPushed(\App\Jobs\UserCreate::class, function ($job) use ($user) {
- $job_user = TestCase::getObjectProperty($job, 'user');
+ Queue::assertPushed(\App\Jobs\User\CreateJob::class, 1);
- return $job_user->id === $user->id
- && $job_user->email === $user->email;
- });
+ Queue::assertPushed(
+ \App\Jobs\User\CreateJob::class,
+ function ($job) use ($user) {
+ $userEmail = TestCase::getObjectProperty($job, 'userEmail');
+ $userId = TestCase::getObjectProperty($job, 'userId');
- Queue::assertPushedWithChain(\App\Jobs\UserCreate::class, [
- \App\Jobs\UserVerify::class,
- ]);
+ return $userEmail === $user->email
+ && $userId === $user->id;
+ }
+ );
+
+ Queue::assertPushedWithChain(
+ \App\Jobs\User\CreateJob::class,
+ [
+ \App\Jobs\User\VerifyJob::class,
+ ]
+ );
/*
FIXME: Looks like we can't really do detailed assertions on chained jobs
Another thing to consider is if we maybe should run these jobs
independently (not chained) and make sure there's no race-condition
in status update
- Queue::assertPushed(\App\Jobs\UserVerify::class, 1);
- Queue::assertPushed(\App\Jobs\UserVerify::class, function ($job) use ($user) {
- $job_user = TestCase::getObjectProperty($job, 'user');
+ Queue::assertPushed(\App\Jobs\User\VerifyJob::class, 1);
+ Queue::assertPushed(\App\Jobs\User\VerifyJob::class, function ($job) use ($user) {
+ $userEmail = TestCase::getObjectProperty($job, 'userEmail');
+ $userId = TestCase::getObjectProperty($job, 'userId');
- return $job_user->id === $user->id
- && $job_user->email === $user->email;
+ return $userEmail === $user->email
+ && $userId === $user->id;
});
*/
}
@@ -219,7 +226,7 @@
$this->assertFalse($user->fresh()->isDeleted());
// Delete the user for real
- $job = new \App\Jobs\UserDelete($id);
+ $job = new \App\Jobs\User\DeleteJob($id);
$job->handle();
$this->assertTrue(User::withTrashed()->where('id', $id)->first()->isDeleted());
@@ -356,7 +363,7 @@
// Add an alias
$user->setAliases(['UserAlias1@UserAccount.com']);
- Queue::assertPushed(\App\Jobs\UserUpdate::class, 1);
+ Queue::assertPushed(\App\Jobs\User\UpdateJob::class, 1);
$aliases = $user->aliases()->get();
$this->assertCount(1, $aliases);
@@ -365,7 +372,7 @@
// Add another alias
$user->setAliases(['UserAlias1@UserAccount.com', 'UserAlias2@UserAccount.com']);
- Queue::assertPushed(\App\Jobs\UserUpdate::class, 2);
+ Queue::assertPushed(\App\Jobs\User\UpdateJob::class, 2);
$aliases = $user->aliases()->orderBy('alias')->get();
$this->assertCount(2, $aliases);
@@ -375,7 +382,7 @@
// Remove an alias
$user->setAliases(['UserAlias1@UserAccount.com']);
- Queue::assertPushed(\App\Jobs\UserUpdate::class, 3);
+ Queue::assertPushed(\App\Jobs\User\UpdateJob::class, 3);
$aliases = $user->aliases()->get();
$this->assertCount(1, $aliases);
@@ -384,7 +391,7 @@
// Remove all aliases
$user->setAliases([]);
- Queue::assertPushed(\App\Jobs\UserUpdate::class, 4);
+ Queue::assertPushed(\App\Jobs\User\UpdateJob::class, 4);
$this->assertCount(0, $user->aliases()->get());
@@ -433,7 +440,7 @@
$user = $this->getTestUser('UserAccountA@UserAccount.com');
- Queue::assertPushed(\App\Jobs\UserUpdate::class, 0);
+ Queue::assertPushed(\App\Jobs\User\UpdateJob::class, 0);
// Test default settings
// Note: Technicly this tests UserObserver::created() behavior
@@ -447,7 +454,7 @@
// Add a setting
$user->setSetting('first_name', 'Firstname');
- Queue::assertPushed(\App\Jobs\UserUpdate::class, 1);
+ Queue::assertPushed(\App\Jobs\User\UpdateJob::class, 1);
// Note: We test both current user as well as fresh user object
// to make sure cache works as expected
@@ -457,7 +464,7 @@
// Update a setting
$user->setSetting('first_name', 'Firstname1');
- Queue::assertPushed(\App\Jobs\UserUpdate::class, 2);
+ Queue::assertPushed(\App\Jobs\User\UpdateJob::class, 2);
// Note: We test both current user as well as fresh user object
// to make sure cache works as expected
@@ -467,7 +474,7 @@
// Delete a setting (null)
$user->setSetting('first_name', null);
- Queue::assertPushed(\App\Jobs\UserUpdate::class, 3);
+ Queue::assertPushed(\App\Jobs\User\UpdateJob::class, 3);
// Note: We test both current user as well as fresh user object
// to make sure cache works as expected
@@ -478,7 +485,7 @@
$user->setSetting('first_name', 'Firstname1');
$user->setSetting('first_name', '');
- Queue::assertPushed(\App\Jobs\UserUpdate::class, 5);
+ Queue::assertPushed(\App\Jobs\User\UpdateJob::class, 5);
// Note: We test both current user as well as fresh user object
// to make sure cache works as expected
@@ -493,7 +500,7 @@
]);
// TODO: This really should create a single UserUpdate job, not 3
- Queue::assertPushed(\App\Jobs\UserUpdate::class, 7);
+ Queue::assertPushed(\App\Jobs\User\UpdateJob::class, 7);
// Note: We test both current user as well as fresh user object
// to make sure cache works as expected
diff --git a/src/tests/TestCaseTrait.php b/src/tests/TestCaseTrait.php
--- a/src/tests/TestCaseTrait.php
+++ b/src/tests/TestCaseTrait.php
@@ -117,7 +117,7 @@
return;
}
- $job = new \App\Jobs\DomainDelete($domain->id);
+ $job = new \App\Jobs\Domain\DeleteJob($domain->id);
$job->handle();
$domain->forceDelete();
@@ -133,7 +133,7 @@
return;
}
- $job = new \App\Jobs\UserDelete($user->id);
+ $job = new \App\Jobs\User\DeleteJob($user->id);
$job->handle();
$user->forceDelete();

File Metadata

Mime Type
text/plain
Expires
Thu, Apr 2, 7:13 PM (3 d, 13 h ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
18768177
Default Alt Text
D1720.1775157210.diff (52 KB)

Event Timeline