feature(php): Display the exception details

Now, we display the exception details about the error occ command (create and import). Signed-off-by: Baptiste Fotia <[email protected]>
arawa · Oct 27, 2023 · 85ef0df · 85ef0df
1 parent 0ed8c17
commit 85ef0df
Show file tree

Hide file tree

Showing 6 changed files with 107 additions and 18 deletions.
diff --git a/lib/Commands/Create.php b/lib/Commands/Create.php
@@ -14,6 +14,10 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class Create extends Command {
+
+	public const OUTPUT_FORMAT_PLAIN = 'plain';
+	public const OUTPUT_FORMAT_JSON_PRETTY = 'json_pretty';
+
 	public function __construct(private SpaceManager $spaceManager,
 		private AdminGroup $adminGroup,
 		private UserPresenceChecker $userChecker,
@@ -22,11 +26,25 @@ public function __construct(private SpaceManager $spaceManager,
 	}
 
 	protected function configure(): void {
+		$this
+			->addOption(
+				'output',
+				null,
+				InputOption::VALUE_OPTIONAL,
+				'Output format (plain, json or json_pretty, default is plain)',
+				self::OUTPUT_FORMAT_PLAIN
+			);
+
 		$this
 			->setName('workspace:create')
 			->setDescription('This command allows you to create a workspace')
 			->addArgument('name', InputArgument::REQUIRED, 'The name of your workspace.')
-			->addOption('user-workspace-manager', 'uwm', InputOption::VALUE_REQUIRED, 'The user will be workspace manager of your workspace. Please, use its uid or email address');
+			->addOption(
+				'user-workspace-manager',
+				'uwm',
+				InputOption::VALUE_REQUIRED,
+				'The user will be workspace manager of your workspace. Please, use its uid or email address'
+			);
 
 		parent::configure();
 	}
@@ -36,9 +54,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 		$spacename = $input->getArgument('name');
 
 		if ($input->hasParameterOption('--user-workspace-manager')) {
-			$this->userChecker->checkUserExist(
-				$input->getOption('user-workspace-manager')
-			);
+			$pattern = $input->getOption('user-workspace-manager');
+			if (!$this->userChecker->checkUserExist($pattern)) {
+				throw new \Exception("The $pattern user or email is not exist.");
+			}
 		}
 
 		$workspace = $this->spaceManager->create($spacename);
@@ -51,7 +70,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 			);
 		}
 
-		return $workspace['id_space'];
+		$output->writeln($this->formatOutput($input, $workspace));
+
+		return 0;
 	}
 
 	private function addUserToAdminGroupManager(string $username, array $workspace): bool {
@@ -61,4 +82,22 @@ private function addUserToAdminGroupManager(string $username, array $workspace):
 
 		return true;
 	}
+
+	private function formatOutput(InputInterface $input, array $items): string {
+		switch ($input->getOption('output')) {
+			case self::OUTPUT_FORMAT_JSON_PRETTY:
+				return json_encode($items, JSON_PRETTY_PRINT);
+				break;
+			case self::OUTPUT_FORMAT_PLAIN:
+				if (!is_array($items)) {
+					return (string)$items;
+				} else {
+					return json_encode($items);
+				}
+				break;
+			default:
+				return json_encode($items);
+				break;
+		}
+	}
 }
diff --git a/lib/Commands/Import.php b/lib/Commands/Import.php
@@ -45,9 +45,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
 		$dataFormated = $this->csvCreatingWorkspaces->parser($path);
 
-		foreach ($dataFormated as $data) {
-			$this->workspaceCheckService->isExist($data['workspace_name']);
-			$this->userChecker->checkUserExist($data['user_uid']);
+		$message = $this->getSpacenamesDuplicated($dataFormated);
+		$message .= $this->getUsersArentExist($dataFormated);
+
+		if (!empty($message)) {
+			throw new \Exception($message);
 		}
 
 		foreach ($dataFormated as $data) {
@@ -59,6 +61,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 			$this->adminGroup->addUser($user, $groupname);
 		}
 
+		$output->writeln("The import is done.");
+
 		return 0;
 	}
 
@@ -69,4 +73,45 @@ protected function configure(): void {
 			->addArgument('path', InputArgument::REQUIRED, 'The path of the csv file.');
 		parent::configure();
 	}
+
+	private function getSpacenamesDuplicated(array $dataResponse): ?string {
+		$workspacesAreNotExist = [];
+		$message = "";
+
+		foreach ($dataResponse as $data) {
+			if ($this->workspaceCheckService->isExist($data['workspace_name'])) {
+				$workspacesAreNotExist[] = $data['workspace_name'];
+			}
+		}
+
+		if (!empty($workspacesAreNotExist)) {
+			$workspacesAreNotExist = array_map(fn ($spacename) => "  - $spacename\n", $workspacesAreNotExist);
+			$message .= "Workspace names below already exist :\n" . implode('', $workspacesAreNotExist);
+			$message .= "\n";
+
+			return $message;
+		}
+
+		return null;
+	}
+
+	private function getUsersArentExist(array $dataResponse): ?string {
+		$usersAreNotExist = [];
+		$message = "";
+
+		foreach ($dataResponse as $data) {
+			if (!$this->userChecker->checkUserExist($data['user_uid'])) {
+				$usersAreNotExist[] = $data['user_uid'];
+			}
+		}
+
+		if (!empty($usersAreNotExist)) {
+			$usersAreNotExist = array_map(fn ($username) => "  - $username\n", $usersAreNotExist);
+			$message .= "Users below aren't known :\n" . implode('', $usersAreNotExist);
+
+			return $message;
+		}
+
+		return null;
+	}
 }
diff --git a/lib/Controller/WorkspaceController.php b/lib/Controller/WorkspaceController.php
@@ -30,6 +30,7 @@
 use OCA\Workspace\Exceptions\BadRequestException;
 use OCA\Workspace\Exceptions\CreateGroupException;
 use OCA\Workspace\Exceptions\CreateWorkspaceException;
+use OCA\Workspace\Exceptions\WorkspaceNameExistException;
 use OCA\Workspace\Service\Group\GroupFormatter;
 use OCA\Workspace\Service\Group\ManagersWorkspace;
 use OCA\Workspace\Service\Group\UserGroup;
@@ -92,7 +93,10 @@ public function createWorkspace(string $spaceName,
 		}
 
 		$this->workspaceCheck->containSpecialChar($spaceName);
-		$this->workspaceCheck->isExist($spaceName);
+
+		if ($this->workspaceCheck->isExist($spaceName)) {
+			throw new WorkspaceNameExistException("The $spaceName space name already exist", Http::STATUS_CONFLICT);
+		}
 
 		$spaceName = $this->deleteBlankSpaceName($spaceName);
 

diff --git a/lib/Service/Workspace/WorkspaceCheckService.php b/lib/Service/Workspace/WorkspaceCheckService.php
@@ -25,9 +25,7 @@
 namespace OCA\Workspace\Service\Workspace;
 
 use OCA\Workspace\Exceptions\BadRequestException;
-use OCA\Workspace\Exceptions\WorkspaceNameExistException;
 use OCA\Workspace\Service\SpaceService;
-use OCP\AppFramework\Http;
 
 class WorkspaceCheckService {
 	public function __construct(private SpaceService $spaceService) {
@@ -50,13 +48,12 @@ public function containSpecialChar(string $spacename): void {
 
 	/**
 	 * Check if the space name exist in groupfolders or workspace
-	 * @throws WorkspaceNameExistException
 	 */
-	public function isExist(string $spacename): void {
+	public function isExist(string $spacename): bool {
 		if ($this->spaceService->checkSpaceNameExist($spacename)) {
-			throw new WorkspaceNameExistException('The ' . $spacename . ' space name already exist', Http::STATUS_CONFLICT);
+			return true;
 		}
 
-		return;
+		return false;
 	}
 }
diff --git a/lib/Space/SpaceManager.php b/lib/Space/SpaceManager.php
@@ -28,6 +28,7 @@
 use OCA\Workspace\Db\SpaceMapper;
 use OCA\Workspace\Exceptions\BadRequestException;
 use OCA\Workspace\Exceptions\CreateWorkspaceException;
+use OCA\Workspace\Exceptions\WorkspaceNameExistException;
 use OCA\Workspace\Helper\GroupfolderHelper;
 use OCA\Workspace\Service\Group\GroupFormatter;
 use OCA\Workspace\Service\Group\UserGroup;
@@ -56,7 +57,10 @@ public function create(string $spacename): array {
 		}
 
 		$this->workspaceCheck->containSpecialChar($spacename);
-		$this->workspaceCheck->isExist($spacename);
+
+		if ($this->workspaceCheck->isExist($spacename)) {
+			throw new WorkspaceNameExistException("The $spacename space name already exist", Http::STATUS_CONFLICT);
+		}
 
 		$spacename = $this->deleteBlankSpaceName($spacename);
 

diff --git a/lib/User/UserPresenceChecker.php b/lib/User/UserPresenceChecker.php
@@ -12,8 +12,8 @@ public function __construct(private IUserManager $userManager,
 	public function checkUserExist(string $pattern): bool {
 		$user = $this->userFinder->findUser($pattern);
 		if (is_null($user)) {
-			throw new \Exception("The $pattern user or email is not exist.", 1);
+			return false;
 		}
-		return false;
+		return true;
 	}
 }