Improve code coverage (#2923)

app/Actions/Oauth/Oauth.php

@@ -21,6 +21,10 @@
 use Laravel\Socialite\Contracts\User as ContractsUser;
 use Laravel\Socialite\Facades\Socialite;
 
+/**
+ * @codeCoverageIgnore
+ * This code is untestable as it is tightly coupled with the Socialite facade.
+ */
 class Oauth
 {
 	public const OAUTH_REGISTER = 'register';

app/Assets/BaseSizeVariantNamingStrategy.php

@@ -48,7 +48,9 @@ protected function generateExtension(SizeVariantType $sizeVariant): string
 		}
 
 		if ($this->extension === '') {
+			// @codeCoverageIgnoreStart
 			throw new MissingValueException('extension');
+			// @codeCoverageIgnoreEnd
 		}
 
 		return $this->extension;

app/Assets/Helpers.php

@@ -135,8 +135,10 @@ public function getSymbolByQuantity(float $bytes): string
 		$exp = intval(floor(log($bytes) / log(1024.0)));
 
 		if ($exp >= sizeof($symbols)) {
+			// @codeCoverageIgnoreStart
 			// if the number is too large, we fall back to the largest available symbol
 			$exp = sizeof($symbols) - 1;
+			// @codeCoverageIgnoreEnd
 		}
 
 		return sprintf('%.2f %s', ($bytes / pow(1024, $exp)), $symbols[$exp]);

app/DTO/ArrayableDTO.php

@@ -34,11 +34,15 @@ public function toArray(): array
 			$propertyValue = $prop->getValue($this);
 			if (is_object($propertyValue)) {
 				if ($propertyValue instanceof Arrayable) {
+					// @codeCoverageIgnoreStart
 					$propertyValue = $propertyValue->toArray();
+				// @codeCoverageIgnoreEnd
 				} elseif ($propertyValue instanceof \BackedEnum) {
 					$propertyValue = $propertyValue->value;
 				} else {
+					// @codeCoverageIgnoreStart
 					throw new LycheeLogicException(sprintf('Unable to convert %s into an array', get_class($propertyValue)));
+					// @codeCoverageIgnoreEnd
 				}
 			}
 			$result[$prop->getName()] = $propertyValue;

app/Factories/AlbumFactory.php

@@ -11,7 +11,6 @@
 use App\Contracts\Models\AbstractAlbum;
 use App\Enum\SmartAlbumType;
 use App\Exceptions\Internal\InvalidSmartIdException;
-use App\Exceptions\Internal\LycheeAssertionError;
 use App\Models\Album;
 use App\Models\BaseAlbumImpl;
 use App\Models\Extensions\BaseAlbum;
@@ -140,8 +139,7 @@ public function findAbstractAlbumsOrFail(array $albumIDs, bool $withRelations =
 
 		$smartAlbums = [];
 		foreach ($smartAlbumIDs as $smartID) {
-			$smartAlbumType = SmartAlbumType::tryFrom($smartID)
-				?? throw LycheeAssertionError::createFromUnexpectedException(new InvalidSmartIdException($smartID));
+			$smartAlbumType = SmartAlbumType::from($smartID);
 			$smartAlbums[] = $this->createSmartAlbum($smartAlbumType, $withRelations);
 		}
 

app/Http/Controllers/Admin/Maintenance/Cleaning.php

@@ -66,16 +66,20 @@ public function check(CleaningRequest $request): CleaningState
 		$cleaning_state = new CleaningState($request->path(), false);
 
 		if (!is_dir($request->path())) {
+			// @codeCoverageIgnoreStart This should not happen. path is very constrained by Lychee config.
 			Log::warning('directory ' . $request->path() . ' not found!');
 			$cleaning_state->is_not_empty = false;
 
 			return $cleaning_state;
+			// @codeCoverageIgnoreEnd
 		}
 
 		if (!(new \FilesystemIterator($request->path()))->valid()) {
+			// @codeCoverageIgnoreStart This should not happen. path is very constrained by Lychee config.
 			$cleaning_state->is_not_empty = false;
 
 			return $cleaning_state;
+			// @codeCoverageIgnoreEnd
 		}
 
 		$files_found = false;

app/Http/Controllers/Admin/Maintenance/RegisterController.php

@@ -29,7 +29,9 @@ public function __invoke(RegisterRequest $request): RegisterData
 		$verify = resolve(Verify::class);
 		$is_supporter = $verify->is_supporter();
 		if ($is_supporter) {
+			// @codeCoverageIgnoreStart Tested locally, not testable in CICD.
 			return new RegisterData(true);
+			// @codeCoverageIgnoreEnd
 		}
 
 		// Not valid, reset the key.

app/Http/Controllers/OauthController.php

@@ -39,6 +39,8 @@ public function __construct(
 	 * @param string $provider
 	 *
 	 * @return Redirector|RedirectResponse
+	 *
+	 * @codeCoverageIgnore
 	 */
 	public function redirected(string $provider)
 	{
@@ -63,6 +65,8 @@ public function redirected(string $provider)
 	 * @param string $provider
 	 *
 	 * @return HttpFoundationRedirectResponse
+	 *
+	 * @codeCoverageIgnore
 	 */
 	public function authenticate(string $provider)
 	{
@@ -81,6 +85,8 @@ public function authenticate(string $provider)
 	 * @param string $provider
 	 *
 	 * @return HttpFoundationRedirectResponse
+	 *
+	 * @codeCoverageIgnore
 	 */
 	public function register(string $provider)
 	{

app/Http/Requests/Maintenance/FullTreeUpdateRequest.php

@@ -11,7 +11,7 @@
 use App\Http\Requests\BaseApiRequest;
 use App\Models\Configs;
 use App\Policies\SettingsPolicy;
-use App\Rules\AlbumIDRule;
+use App\Rules\RandomIDRule;
 use Illuminate\Support\Facades\Gate;
 
 class FullTreeUpdateRequest extends BaseApiRequest
@@ -34,10 +34,10 @@ public function rules(): array
 		return [
 			'albums' => 'required|array|min:1',
 			'albums.*' => 'required|array',
-			'albums.*.id' => ['required', new AlbumIDRule(false)],
+			'albums.*.id' => ['required', new RandomIDRule(false)],
 			'albums.*._lft' => 'required|integer|min:1',
 			'albums.*._rgt' => 'required|integer|min:1',
-			'albums.*.parent_id' => [new AlbumIDRule(true)],
+			'albums.*.parent_id' => [new RandomIDRule(true)],
 		];
 	}
 

app/Http/Resources/Rights/SettingsRightsResource.php

@@ -19,7 +19,6 @@ class SettingsRightsResource extends Data
 {
 	public bool $can_edit;
 	public bool $can_see_logs;
-	public bool $can_clear_logs;
 	public bool $can_see_diagnostics;
 	public bool $can_update;
 	public bool $can_access_dev_tools;
@@ -28,7 +27,6 @@ public function __construct()
 	{
 		$this->can_edit = Gate::check(SettingsPolicy::CAN_EDIT, [Configs::class]);
 		$this->can_see_logs = Gate::check(SettingsPolicy::CAN_SEE_LOGS, [Configs::class]);
-		$this->can_clear_logs = Gate::check(SettingsPolicy::CAN_CLEAR_LOGS, [Configs::class]);
 		$this->can_see_diagnostics = Gate::check(SettingsPolicy::CAN_SEE_DIAGNOSTICS, [Configs::class]);
 		$this->can_update = Gate::check(SettingsPolicy::CAN_UPDATE, [Configs::class]);
 		$this->can_access_dev_tools = Gate::check(SettingsPolicy::CAN_ACCESS_DEV_TOOLS, [Configs::class]);

app/Legacy/Legacy.php

@@ -60,18 +60,22 @@ private static function translateLegacyID(int $id, string $tableName, Request $r
 					' instead of new ID ' . $newID .
 					' from ' . $referer;
 				if (!Configs::getValueAsBool('legacy_id_redirection')) {
+					// @codeCoverageIgnoreStart
 					$msg .= ' (translation disabled by configuration)';
 					throw new ConfigurationException($msg);
+					// @codeCoverageIgnoreEnd
 				}
 				Log::warning(__METHOD__ . ':' . __LINE__ . $msg);
 
 				return $newID;
 			}
 
+			// @codeCoverageIgnoreStart
 			return null;
 		} catch (\InvalidArgumentException $e) {
 			throw new QueryBuilderException($e);
 		}
+		// @codeCoverageIgnoreEnd
 	}
 
 	/**

app/Legacy/V1/Controllers/Administration/DiagnosticsController.php

@@ -89,7 +89,9 @@ private function formatErrors(array $array): array
 			};
 			$ret[] = $prefix . $elem->message;
 			foreach ($elem->details as $detail) {
+				// @codeCoverageIgnoreStart
 				$ret[] = '         ' . $detail;
+				// @codeCoverageIgnoreEnd
 			}
 		}
 
@@ -109,9 +111,11 @@ public function view(): View
 	{
 		try {
 			return view('diagnostics', $this->get());
+			// @codeCoverageIgnoreStart
 		} catch (BindingResolutionException $e) {
 			throw new FrameworkException('Laravel\'s view component', $e);
 		}
+		// @codeCoverageIgnoreEnd
 	}
 
 	/**
@@ -135,7 +139,9 @@ public function getSize(Space $space): array
 	public function getFullAccessPermissions(AlbumQueryPolicy $albumQueryPolicy): View
 	{
 		if (!$this->isAuthorized() && config('app.debug') !== true) {
+			// @codeCoverageIgnoreStart
 			throw new UnauthorizedException();
+			// @codeCoverageIgnoreEnd
 		}
 
 		$data1 = AccessPermission::query()
@@ -191,6 +197,7 @@ public function getFullAccessPermissions(AlbumQueryPolicy $albumQueryPolicy): Vi
 			->orderBy(APC::BASE_ALBUM_ID)
 			->get()
 			->map(function ($e) {
+				// @codeCoverageIgnoreStart
 				$e->is_link_required = $e->is_link_required === 1;
 				$e->grants_download = $e->grants_download === 1;
 				$e->grants_upload = $e->grants_upload === 1;
@@ -199,6 +206,7 @@ public function getFullAccessPermissions(AlbumQueryPolicy $albumQueryPolicy): Vi
 				$e->grants_full_photo_access = $e->grants_full_photo_access === 1;
 
 				return $e;
+				// @codeCoverageIgnoreEnd
 			});
 
 		return view('access-permissions', ['data1' => json_encode($data1, JSON_PRETTY_PRINT), 'data2' => json_encode($data2, JSON_PRETTY_PRINT)]);

app/Legacy/V1/Controllers/Administration/SettingsController.php

@@ -187,6 +187,8 @@ public function setNSFWVisible(SetNSFWVisibilityRequest $request): void
 	 * @return void
 	 *
 	 * @throws InvalidConfigOption
+	 *
+	 * @codeCoverageIgnore
 	 */
 	public function setAlbumDecoration(SetAlbumDecorationRequest $request): void
 	{
@@ -368,9 +370,11 @@ public function setCSS(SetCSSSettingRequest $request): void
 		/** @var string $css */
 		$css = $request->getSettingValue();
 		if (Storage::disk('dist')->put('user.css', $css) === false) {
+			// @codeCoverageIgnoreStart
 			if (Storage::disk('dist')->get('user.css') !== $css) {
 				throw new InsufficientFilesystemPermissions('Could not save CSS');
 			}
+			// @codeCoverageIgnoreEnd
 		}
 	}
 
@@ -384,6 +388,8 @@ public function setCSS(SetCSSSettingRequest $request): void
 	 * @return void
 	 *
 	 * @throws InsufficientFilesystemPermissions
+	 *
+	 * @codeCoverageIgnore
 	 */
 	public function setJS(SetJSSettingRequest $request): void
 	{
@@ -442,12 +448,16 @@ public function saveAll(GetSetAllSettingsRequest $request): void
 			$value ??= '';
 			try {
 				Configs::set($key, $value);
+				// @codeCoverageIgnoreStart
 			} catch (InvalidConfigOption $e) {
 				$lastException = $e;
 			}
+			// @codeCoverageIgnoreEnd
 		}
 		if ($lastException !== null) {
+			// @codeCoverageIgnoreStart
 			throw $lastException;
+			// @codeCoverageIgnoreEnd
 		}
 	}
 }

app/Legacy/V1/Controllers/Administration/SharingController.php

@@ -63,6 +63,8 @@ public function add(AddSharesRequest $request): void
 	 * @param SetSharesByAlbumRequest $request
 	 *
 	 * @return void
+	 *
+	 * @codeCoverageIgnore Legacy stuff
 	 */
 	public function setByAlbum(SetSharesByAlbumRequest $request): void
 	{
@@ -102,7 +104,8 @@ private function updateLinks(array $userIds, array $albumIDs): void
 					APC::GRANTS_DOWNLOAD => Configs::getValueAsBool('grants_download'),
 					APC::GRANTS_FULL_PHOTO_ACCESS => Configs::getValueAsBool('grants_full_photo_access'),
 				],
-				false);
+				false
+			);
 		}
 	}
 
@@ -118,6 +121,8 @@ private function updateLinks(array $userIds, array $albumIDs): void
 	 * @return void
 	 *
 	 * @throws QueryBuilderException
+	 *
+	 * @codeCoverageIgnore Legacy stuff
 	 */
 	public function delete(DeleteSharingRequest $request): void
 	{

app/Legacy/V1/Controllers/Administration/UserController.php

@@ -76,9 +76,11 @@ public function setEmail(SetEmailRequest $request): void
 			}
 
 			$user->save();
+			// @codeCoverageIgnoreStart
 		} catch (\InvalidArgumentException $e) {
 			throw new FrameworkException('Laravel\'s notification module', $e);
 		}
+		// @codeCoverageIgnoreEnd
 	}
 
 	/**

app/Legacy/V1/Controllers/AlbumController.php

@@ -105,12 +105,14 @@ public function addTagAlbum(AddTagAlbumRequest $request, CreateTagAlbum $create)
 	 */
 	public function get(GetAlbumRequest $request): AlbumResource|TagAlbumResource|SmartAlbumResource
 	{
+		// @codeCoverageIgnoreStart
 		return match (true) {
 			$request->album() instanceof BaseSmartAlbum => SmartAlbumResource::make($request->album()),
 			$request->album() instanceof TagAlbum => TagAlbumResource::make($request->album()),
 			$request->album() instanceof Album => AlbumResource::make($request->album()),
 			default => throw new LycheeLogicException('This should not happen'),
 		};
+		// @codeCoverageIgnoreEnd
 	}
 
 	/**
@@ -276,6 +278,8 @@ public function setLicense(SetAlbumLicenseRequest $request): void
 	 *
 	 * @throws MediaFileOperationException
 	 * @throws ModelDBException
+	 *
+	 * @codeCoverageIgnore
 	 */
 	public function setTrack(SetAlbumTrackRequest $request): void
 	{
@@ -290,6 +294,8 @@ public function setTrack(SetAlbumTrackRequest $request): void
 	 * @return void
 	 *
 	 * @throws ModelDBException
+	 *
+	 * @codeCoverageIgnore
 	 */
 	public function deleteTrack(DeleteTrackRequest $request): void
 	{
@@ -353,6 +359,8 @@ public function move(MoveAlbumsRequest $request, Move $move): void
 	 * @return void
 	 *
 	 * @throws ModelDBException
+	 *
+	 * @codeCoverageIgnore
 	 */
 	public function setNSFW(SetAlbumNSFWRequest $request): void
 	{

app/Legacy/V1/Controllers/ImportController.php

@@ -16,7 +16,6 @@
 use App\Legacy\V1\Requests\Import\ImportFromUrlRequest;
 use App\Legacy\V1\Requests\Import\ImportServerRequest;
 use App\Legacy\V1\Resources\Models\PhotoResource;
-use App\Models\Photo;
 use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
 use Illuminate\Routing\Controller;
 use Illuminate\Support\Facades\Auth;
@@ -47,7 +46,7 @@
  * types are consistent and the best of both worlds: a streamed collection.
  * In other words, the streamed response should immediately send back a
  * `[`-character to the client (the beginning of the collection), then
- * send back a JSONized {@link Photo} as soon as it has been imported
+ * send back a JSONized {@link \App\Models\Photo} as soon as it has been imported
  * (element of the collection, and send a final `]`-character (the end of
  * the collection).
  *
@@ -91,6 +90,8 @@ public function server(ImportServerRequest $request, FromServer $fromServer): St
 
 	/**
 	 * @return void
+	 *
+	 * @codeCoverageIgnore
 	 */
 	public function serverCancel(CancelImportServerRequest $request): void
 	{