16344800892

Committed 17 Jul 2025 12:13PM UTC coverage: 66.494% (+6.6%) from 59.854%

Build # 16344800892

Build Type

push

github

Committed by

daycry

Commit Message

Add comprehensive unit tests for helpers and services

This commit introduces extensive unit tests for helper functions (auth, checkEndpoint, checkIp, email), libraries (CheckIpInRange, Logger), and service classes (AttemptHandler, ExceptionHandler, RequestLogger). Also fixes ReflectionProperty usage in ExceptionHandler to correctly pass the exception object. These tests improve code coverage and ensure reliability of authentication, endpoint, IP checking, email, logging, and exception handling features.

Run Details

1 of 1 new or added line in 1 file covered. (100.0%)

136 existing lines in 8 files now uncovered.

2177 of 3274 relevant lines covered (66.49%)

32.78 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.0

/src/Traits/BaseControllerTrait.php

<?php

declare(strict_types=1);

/**
 * This file is part of Daycry Auth.
 *
 * (c) Daycry <daycry9@proton.me>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace Daycry\Auth\Traits;

use CodeIgniter\Exceptions\ExceptionInterface;
use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\HTTP\RequestInterface;
use CodeIgniter\HTTP\ResponseInterface;
use Config\Mimes;
use Config\Services;
use Daycry\Auth\Libraries\Utils;
use Daycry\Auth\Services\AttemptHandler;
use Daycry\Auth\Services\ExceptionHandler;
use Daycry\Auth\Services\RequestLogger;
use Daycry\Encryption\Encryption;
use Psr\Log\LoggerInterface;

/**
 * BaseControllerTrait that delegates to specialized services
 *
 * This version follows Single Responsibility Principle by using dedicated services
 * for logging, attempt handling, and exception management.
 */
trait BaseControllerTrait
{
    use Validation;

    protected Encryption $encryption;
    protected RequestLogger $requestLogger;
    protected AttemptHandler $attemptHandler;
    protected ExceptionHandler $exceptionHandler;
    protected array $args;
    protected mixed $content = null;

    /**
     * Hook for early checks - can be overridden by implementing classes
     */
    protected function earlyChecks(): void
    {
        // Override in child classes if needed
    }

    /**
     * Initialize controller with services
     */
    public function initController(RequestInterface $request, ResponseInterface $response, LoggerInterface $logger): void
    {
        // Load required helpers
        helper(['security', 'auth']);

        // Initialize services
        $this->encryption       = new Encryption();
        $this->requestLogger    = new RequestLogger();
        $this->attemptHandler   = new AttemptHandler();
        $this->exceptionHandler = new ExceptionHandler();

        // Call parent initialization
        parent::initController($request, $response, $logger);

        // Set response format if method exists (for API controllers)
        if (method_exists($this, 'setFormat')) {
            $output = $this->request->negotiate('media', setting('Format.supportedResponseFormats'));
            $output = Mimes::guessExtensionFromType($output);
            $this->setFormat($output);
        }

        // Extract request parameters
        $this->args    = Utils::getAllParams();
        $this->content = $this->args['body'] ?? null;

        // Run early checks
        $this->earlyChecks();
    }

    /**
     * Cleanup and logging on destruction
     */
    public function __destruct()
    {
        if (isset($this->request) && $this->request) {
            $this->requestLogger->logRequest($this->response);

            if (! $this->requestLogger->isRequestAuthorized()) {
                $this->attemptHandler->handleInvalidAttempt($this->request);
            }
        }

        if (isset($this->validator) && $this->validator) {
            $this->validator->reset();
        }
    }

    /**
     * Get CSRF token for forms
     */
    protected function getToken(): array
    {
        return ['name' => csrf_token(), 'hash' => csrf_hash()];
    }

    /**
     * Main request handler with exception management
     */
    public function _remap(string $method, ...$params)
    {
        try {
            if (! method_exists($this, $method)) {
                throw PageNotFoundException::forPageNotFound();
            }

            // Validate attempts if enabled
            $this->attemptHandler->validateAttempts($this->response);

            // Execute the method
            $data = $this->{$method}(...$params);

            // Handle different response types
            if ($data instanceof ResponseInterface) {
                return $data;
            }

            // Return JSON for AJAX requests
            if (method_exists($this->request, 'isAJAX') && $this->request->isAJAX() && (is_array($data) || is_object($data))) {
                return $this->response->setJSON($data);
            }

            // Return regular response
            return $this->response->setBody($data);
        } catch (ExceptionInterface $ex) {
            return $this->exceptionHandler->handleException(
                $ex,
                $this->request,
                $this->response,
                $this->validator ?? null,
                $this,
            );
        }
    }

    /**
     * Mark request as unauthorized
     */
    protected function setRequestUnauthorized(): void
    {
        $this->requestLogger->setRequestAuthorized(false);
    }

    /**
     * Check if request is authorized
     */
    protected function isRequestAuthorized(): bool
    {
        return $this->requestLogger->isRequestAuthorized();
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/**
6	* This file is part of Daycry Auth.
7	*
8	* (c) Daycry <daycry9@proton.me>
9	*
10	* For the full copyright and license information, please view
11	* the LICENSE file that was distributed with this source code.
12	*/
13
14	namespace Daycry\Auth\Traits;
15
16	use CodeIgniter\Exceptions\ExceptionInterface;
17	use CodeIgniter\Exceptions\PageNotFoundException;
18	use CodeIgniter\HTTP\RequestInterface;
19	use CodeIgniter\HTTP\ResponseInterface;
20	use Config\Mimes;
21	use Config\Services;
22	use Daycry\Auth\Libraries\Utils;
23	use Daycry\Auth\Services\AttemptHandler;
24	use Daycry\Auth\Services\ExceptionHandler;
25	use Daycry\Auth\Services\RequestLogger;
26	use Daycry\Encryption\Encryption;
27	use Psr\Log\LoggerInterface;
28
29	/**
30	* BaseControllerTrait that delegates to specialized services
31	*
32	* This version follows Single Responsibility Principle by using dedicated services
33	* for logging, attempt handling, and exception management.
34	*/
35	trait BaseControllerTrait
36	{
37	use Validation;
38
39	protected Encryption $encryption;
40	protected RequestLogger $requestLogger;
41	protected AttemptHandler $attemptHandler;
42	protected ExceptionHandler $exceptionHandler;
43	protected array $args;
44	protected mixed $content = null;
45
46	/**
47	* Hook for early checks - can be overridden by implementing classes
48	*/
49	protected function earlyChecks(): void
50	{
51	// Override in child classes if needed
52	}	27✔
53
54	/**
55	* Initialize controller with services
56	*/
57	public function initController(RequestInterface $request, ResponseInterface $response, LoggerInterface $logger): void
58	{
59	// Load required helpers
60	helper(['security', 'auth']);	27✔
61
62	// Initialize services
63	$this->encryption = new Encryption();	27✔
64	$this->requestLogger = new RequestLogger();	27✔
65	$this->attemptHandler = new AttemptHandler();	27✔
66	$this->exceptionHandler = new ExceptionHandler();	27✔
67
68	// Call parent initialization
69	parent::initController($request, $response, $logger);	27✔
70
71	// Set response format if method exists (for API controllers)
72	if (method_exists($this, 'setFormat')) {	27✔
73	$output = $this->request->negotiate('media', setting('Format.supportedResponseFormats'));	×
UNCOV 74	$output = Mimes::guessExtensionFromType($output);	×
75	$this->setFormat($output);	×
76	}
77
78	// Extract request parameters
79	$this->args = Utils::getAllParams();	27✔
80	$this->content = $this->args['body'] ?? null;	27✔
81
82	// Run early checks
83	$this->earlyChecks();	27✔
84	}
85
86	/**
87	* Cleanup and logging on destruction
88	*/
89	public function __destruct()
90	{
91	if (isset($this->request) && $this->request) {	8✔
92	$this->requestLogger->logRequest($this->response);	8✔
93
94	if (! $this->requestLogger->isRequestAuthorized()) {	8✔
95	$this->attemptHandler->handleInvalidAttempt($this->request);	1✔
96	}
97	}
98
99	if (isset($this->validator) && $this->validator) {	8✔
UNCOV 100	$this->validator->reset();	×
101	}
102	}
103
104	/**
105	* Get CSRF token for forms
106	*/
107	protected function getToken(): array
108	{
109	return ['name' => csrf_token(), 'hash' => csrf_hash()];	4✔
110	}
111
112	/**
113	* Main request handler with exception management
114	*/
115	public function _remap(string $method, ...$params)
116	{
117	try {
118	if (! method_exists($this, $method)) {	2✔
119	throw PageNotFoundException::forPageNotFound();	1✔
120	}
121
122	// Validate attempts if enabled
123	$this->attemptHandler->validateAttempts($this->response);	1✔
124
125	// Execute the method
126	$data = $this->{$method}(...$params);	1✔
127
128	// Handle different response types
129	if ($data instanceof ResponseInterface) {	1✔
UNCOV 130	return $data;	×
131	}
132
133	// Return JSON for AJAX requests
134	if (method_exists($this->request, 'isAJAX') && $this->request->isAJAX() && (is_array($data) \|\| is_object($data))) {	1✔
UNCOV 135	return $this->response->setJSON($data);	×
136	}
137
138	// Return regular response
139	return $this->response->setBody($data);	1✔
140	} catch (ExceptionInterface $ex) {	1✔
141	return $this->exceptionHandler->handleException(	1✔
142	$ex,	1✔
143	$this->request,	1✔
144	$this->response,	1✔
145	$this->validator ?? null,	1✔
146	$this,	1✔
147	);	1✔
148	}
149	}
150
151	/**
152	* Mark request as unauthorized
153	*/
154	protected function setRequestUnauthorized(): void
155	{
156	$this->requestLogger->setRequestAuthorized(false);	2✔
157	}
158
159	/**
160	* Check if request is authorized
161	*/
162	protected function isRequestAuthorized(): bool
163	{
164	return $this->requestLogger->isRequestAuthorized();	1✔
165	}
166	}

daycry / auth / 16344800892

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous