Fix and refactor module Admin\Accounts part I

5 files changed, 278 insertions, 0 deletions

diff --git a/tests/unit/Lib/MailerTest.php b/tests/unit/Lib/MailerTest.php
new file mode 100644
index 000000000..038c7ef4c
--- /dev/null
+++ b/tests/unit/Lib/MailerTest.php
@@ -0,0 +1,62 @@
+<?php
+/*
+ * Tests for the Zotlabs\LibM̀ailer class.
+ *
+ * SPDX-FileCopyrightText: 2024 Hubzilla Community
+ * SPDX-FileContributor: Harald Eilertsen
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+namespace Zotlabs\Tests\Unit\Lib;
+
+use App;
+use phpmock\phpunit\PHPMock;
+use Zotlabs\Lib\Mailer;
+use Zotlabs\Tests\Unit\UnitTestCase;
+
+class MailerTest extends UnitTestCase {
+
+	use PHPMock;
+
+	public function test_optional_params_replaced_by_defaults(): void {
+		$hostname = App::get_hostname();
+		$recipient = 'recipient@somesite.test';
+		$subject = 'A test email';
+		$body = <<<EOF
+			Dear recipient,
+
+			This is an test email message for you.
+
+			Sincerely,
+			Hubzilla
+			EOF;
+
+		//
+		// Catch calls to the php mail function, and verify
+		// that it is called with the args we're expecting
+		//
+		$this->getFunctionMock('Zotlabs\Lib', 'mail')
+			->expects($this->once())
+			->with(
+				$this->identicalTo($recipient),
+				$this->identicalTo($subject),
+				$this->identicalTo($body),
+				$this->identicalTo(<<<EOF
+					From:  <Administrator@{$hostname}>
+					Reply-To:  <noreply@{$hostname}>
+					Content-Type: text/plain; charset=UTF-8
+					EOF
+				)
+			)
+			->willReturn(true);
+
+		$mailer = new Mailer([
+			'toEmail' => $recipient,
+			'messageSubject' => $subject,
+			'textVersion' => $body,
+		]);
+
+		$mailer->deliver();
+	}
+}
diff --git a/tests/unit/Module/AdminAccountsTest.php b/tests/unit/Module/AdminAccountsTest.php
new file mode 100644
index 000000000..2c76f2779
--- /dev/null
+++ b/tests/unit/Module/AdminAccountsTest.php
@@ -0,0 +1,173 @@
+<?php
+/*
+ * SPDX-FileCopyrightText: 2024 Hubzilla Community
+ * SPDX-FileContributor: Harald Eilertsen
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+namespace Zotlabs\Tests\Unit\Module;
+
+use PHPUnit\Framework\Attributes\Before;
+
+class AdminAccountsTest extends TestCase {
+
+	protected $stub_check_security;
+	protected $stub_is_site_admin;
+	protected $stub_goaway;
+	protected $stub_notice;
+
+	protected array $notice;
+
+	/**
+	 * Set up the stubs common for the tests.
+	 */
+	#[Before]
+	public function setup_stubs(): void {
+		$this->stub_check_form_security();
+		$this->stub_is_site_admin();
+		$this->stub_goaway();
+		$this->stub_notice();
+	}
+
+	public function test_blocking_accounts_marks_selected_accounts_as_blocked(): void {
+		$params = [
+			'user' => [ 42 ],
+			'blocked' => [ false ],
+			'page_accounts_block' => true,
+		];
+
+		try {
+			$this->post('admin/accounts', [], $params);
+		} catch (RedirectException $redirect) {
+			$this->assertEquals(z_root() . '/admin/accounts', $redirect->getMessage());
+		}
+
+		$account = get_account_by_id(42);
+		$this->assertEquals(ACCOUNT_BLOCKED, $account['account_flags'] & ACCOUNT_BLOCKED);
+
+		$this->assertEquals('1 account blocked/unblocked', $this->notice[0]);
+	}
+
+	public function test_unblocking_accounts_clears_the_blocked_flag(): void {
+		// Pass two users to the module, one that is not blocked,
+		// and one that is.
+		$params = [
+			'user' => [ 42, 44 ],
+			'blocked' => [ false, true ],
+			'page_accounts_block' => true,
+		];
+
+		try {
+			$this->post('admin/accounts', [], $params);
+		} catch (RedirectException $redirect) {
+			$this->assertEquals(z_root() . '/admin/accounts', $redirect->getMessage());
+		}
+
+		// We expect the previously unblocked account to be blocked.
+		$account = get_account_by_id(42);
+		$this->assertEquals(ACCOUNT_BLOCKED, $account['account_flags'] & ACCOUNT_BLOCKED);
+
+		// We expect the previously blocked account to be unblocked.
+		$blocked_account = get_account_by_id(44);
+		$this->assertEquals(0, $blocked_account['account_flags'] & ACCOUNT_BLOCKED);
+
+		$this->assertEquals('2 account blocked/unblocked', $this->notice[0]);
+	}
+
+	public function test_deleting_accouns_remove_them_from_db(): void {
+		$params = [
+			'user' => [ 42, 44 ],
+			'page_accounts_delete' => true,
+		];
+
+		try {
+			$this->post('admin/accounts', [], $params);
+		} catch (RedirectException $redirect) {
+			$this->assertEquals(z_root() . '/admin/accounts', $redirect->getMessage());
+		}
+
+		$this->assertEquals(null, get_account_by_id(42));
+		$this->assertEquals(null, get_account_by_id(44));
+	}
+
+	public function test_approving_pending_accounts_clears_pending_flag(): void {
+
+		// Catch calls to the php mail function
+		//
+		// This is just to get it out of the way, we don't care about
+		// how many times it's called, or with what args here.
+		$this->getFunctionMock('Zotlabs\Lib', 'mail')
+			->expects($this->any())
+			->willReturn(true);
+
+		$params = [
+			'pending' => [
+				$this->fixtures['register'][0]['reg_hash'],
+				$this->fixtures['register'][1]['reg_hash']
+		   	],
+			'page_accounts_approve' => true,
+		];
+
+		try {
+			$this->post('admin/accounts', [], $params);
+		} catch (RedirectException $redirect) {
+			$this->assertEquals(z_root() . '/admin/accounts', $redirect->getMessage());
+		}
+
+		foreach ([45, 46] as $id) {
+			$account = get_account_by_id($id);
+			$this->assertEquals(0, $account['account_flags'] & ACCOUNT_PENDING);
+		}
+	}
+
+	/**
+	 * Stub the check_form_security_token_ForbiddenOnErr.
+	 */
+	protected function stub_check_form_security(): void {
+		$this->stub_check_security =
+			$this->getFunctionMock('Zotlabs\Module\Admin', 'check_form_security_token_redirectOnErr')
+				->expects($this->once())
+				->with(
+					$this->identicalTo('/admin/accounts'),
+					$this->identicalTo('admin_accounts'))
+				->willReturn(true);
+	}
+
+	/**
+	 * Stub the call to is_site_admin in the Admin main module.
+	 */
+	protected function stub_is_site_admin(): void {
+		$this->stub_is_site_admin =
+			$this->getFunctionMock('Zotlabs\Module', 'is_site_admin')
+				->expects($this->once())
+				->willReturn(true);
+	}
+
+	/**
+	 * Stub the goaway function.
+	 *
+	 * Will throw an RedirectException with the URL being redirected to
+	 * as the exception message.
+	 *
+	 * @throws RedirectException
+	 */
+	protected function stub_goaway(): void {
+		$this->stub_goaway =
+			$this->getFunctionMock('Zotlabs\Module\Admin', 'goaway')
+				->expects($this->once())
+				->willReturnCallback(function (string $uri) {
+					throw new RedirectException($uri);
+				});
+	}
+
+	protected function stub_notice(): void {
+		$this->notice = [];
+		$this->stub_notice =
+			$this->getFunctionMock('Zotlabs\Module\Admin', 'notice')
+				->expects($this->any())
+				->willReturnCallback(function (string $arg) {
+					$this->notice[] = $arg;
+				});
+	}
+}
diff --git a/tests/unit/UnitTestCase.php b/tests/unit/UnitTestCase.php
index 79f0ec440..e3cd22b63 100644
--- a/tests/unit/UnitTestCase.php
+++ b/tests/unit/UnitTestCase.php
@@ -75,6 +75,14 @@ class UnitTestCase extends TestCase {
 	}
 
 	/**
+	 * Initialize the global App properties.
+	 */
+	#[Before]
+	protected function init_app(): void {
+		\App::set_hostname('hubzilla.test');
+	}
+
+	/**
 	 * Roll back test database to it's original state, cleaning up
 	 * any changes from the test.
 	 *
diff --git a/tests/unit/includes/dba/_files/account.yml b/tests/unit/includes/dba/_files/account.yml
index b7a49529e..9c3d00ec8 100644
--- a/tests/unit/includes/dba/_files/account.yml
+++ b/tests/unit/includes/dba/_files/account.yml
@@ -11,3 +11,18 @@ account:
     account_language: "de"
     account_level: 5
     account_flags: 1
+  -
+    account_id: 44
+    account_email: "blocked@example.org"
+    account_level: 5
+    account_flags: 2
+  -
+    account_id: 45
+    account_email: "pending@example.org"
+    account_level: 5
+    account_flags: 0x10
+  -
+    account_id: 46
+    account_email: "unverified@example.org"
+    account_level: 5
+    account_flags: 0x11
diff --git a/tests/unit/includes/dba/_files/register.yml b/tests/unit/includes/dba/_files/register.yml
new file mode 100644
index 000000000..2ef1a5365
--- /dev/null
+++ b/tests/unit/includes/dba/_files/register.yml
@@ -0,0 +1,20 @@
+---
+register:
+  -
+    reg_vital: 1
+    reg_flags: 0x10
+    reg_did2: 'verified@example.com'
+    reg_email: 'verified@example.com'
+    reg_hash: '123'
+    reg_uid: 45
+    reg_pass: 'verify'
+    reg_stuff: ''
+  -
+    reg_vital: 1
+    reg_flags: 0x11
+    reg_did2: 'unverified@example.com'
+    reg_email: 'unverified@example.com'
+    reg_hash: '666'
+    reg_uid: 46
+    reg_pass: 'verify'
+    reg_stuff: ''