[TASK] Add exit code to cli commands

All cli commands will now return an exit code depending on whether
they found any problems:

- 0 : everything ok, nothing found
- 1 : found problems

Resolves: #619

Author: sypets

Classes/Command/DeleteChildrenWithNonExistingParentCommand.php

@@ -43,14 +43,18 @@ public function __construct(Integrity $integrity, IntegrityFix $integrityFix, ?s
 
     public function execute(InputInterface $input, OutputInterface $output): int
     {
+        $exitCode = 0;
         Bootstrap::initializeBackendAuthentication();
         $GLOBALS['LANG'] = GeneralUtility::makeInstance(LanguageServiceFactory::class)->createFromUserPreferences($GLOBALS['BE_USER']);
+        // this fetches all errors / warnings, including unrelated
         $res = $this->integrity->run();
         foreach ($res['warnings'] as $warning) {
             if ($warning instanceof NonExistingParentWarning) {
+                $exitCode = 1;
                 $this->integrityFix->deleteChildrenWithNonExistingParent($warning);
             }
         }
-        return 0;
+        // return with exit code !0 if errors found
+        return $exitCode;
     }
 }

Classes/Command/DeleteChildrenWithWrongPidCommand.php

@@ -43,14 +43,18 @@ public function __construct(Integrity $integrity, IntegrityFix $integrityFix, ?s
 
     public function execute(InputInterface $input, OutputInterface $output): int
     {
+        $exitCode = 0;
         Bootstrap::initializeBackendAuthentication();
         $GLOBALS['LANG'] = GeneralUtility::makeInstance(LanguageServiceFactory::class)->createFromUserPreferences($GLOBALS['BE_USER']);
+        // this fetches all errors / warnings, including unrelated
         $res = $this->integrity->run();
         foreach ($res['errors'] as $error) {
             if ($error instanceof WrongPidError) {
+                $exitCode = 1;
                 $this->integrityFix->deleteChildrenWithWrongPid($error);
             }
         }
-        return 0;
+        // return with exit code !0 if errors found
+        return $exitCode;
     }
 }

Classes/Command/FixContainerParentForConnectedModeCommand.php

@@ -40,12 +40,16 @@ public function __construct(Integrity $integrity, IntegrityFix $integrityFix, ?s
 
     public function execute(InputInterface $input, OutputInterface $output): int
     {
+        $exitCode = 0;
+        // this fetches all errors / warnings, including unrelated
         $res = $this->integrity->run();
         foreach ($res['errors'] as $error) {
             if ($error instanceof ChildInTranslatedContainerError) {
+                $exitCode = 1;
                 $this->integrityFix->changeContainerParentToDefaultLanguageContainer($error);
             }
         }
-        return 0;
+        // return with exit code !0 if errors found
+        return $exitCode;
     }
 }

Classes/Command/FixLanguageModeCommand.php

@@ -40,14 +40,18 @@ public function __construct(Integrity $integrity, IntegrityFix $integrityFix, ?s
 
     public function execute(InputInterface $input, OutputInterface $output): int
     {
+        $exitCode = 0;
+        // this fetches all errors / warnings, including unrelated
         $res = $this->integrity->run();
         $errors = [];
         foreach ($res['errors'] as $error) {
             if ($error instanceof WrongL18nParentError) {
+                $exitCode = 1;
                 $errors[] = $error;
             }
         }
         $this->integrityFix->languageMode($errors);
-        return 0;
+        // return with exit code !0 if errors found
+        return $exitCode;
     }
 }

Classes/Command/IntegrityCommand.php

@@ -51,7 +51,9 @@ public function execute(InputInterface $input, OutputInterface $output): int
         }
         if (count($res['warnings']) === 0 && count($res['errors']) === 0) {
             $io->success('Good Job, no errors/warnings!');
+            return 0;
         }
-        return 0;
+        // return with exit code !0 if errors found
+        return 1;
     }
 }

Classes/Command/SortingCommand.php

@@ -69,7 +69,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
                 $output->writeln('- all good, nothing to do here');
             }
         }
-
-        return self::SUCCESS;
+        // return with exit code !0 if errors found
+        return count($errors) > 0 ? 1 : 0;
     }
 }

Classes/Command/SortingInPageCommand.php

@@ -65,6 +65,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
         if (empty($errors)) {
             $output->writeln('migration finished');
         }
-        return 0;
+        // return with exit code !0 if errors found
+        return count($errors) > 0 ? 1 : 0;
     }
 }

README.md

@@ -208,6 +208,9 @@ bin/typo3 container:deleteChildrenWithWrongPid
 bin/typo3 container:deleteChildrenWithNonExistingParent
 ```
 
+Commands will generally exit with 0 on non-error and exit with !0 if an error was found, regardless of whether the
+problems were fixed or not.
+
 ## TODOs
 - Integrity proofs
 - List module actions