Always return an int for Symfony Command execute method #40793
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phil-davis
commented
May 17, 2023
| @@ -82,7 +82,6 @@ protected function execute(InputInterface $input, OutputInterface $output) { | |||
| $groupPrincipalBackend = new GroupPrincipalBackend( | |||
| $this->groupManager | |||
| ); | |||
| $config = \OC::$server->getConfig(); | |||
There was a problem hiding this comment.
$config was unused.
phil-davis
commented
May 17, 2023
| @@ -134,6 +134,7 @@ public function execute(InputInterface $input, OutputInterface $output) { | |||
| } | |||
| } | |||
| $cursor->closeCursor(); | |||
| return 0; | |||
There was a problem hiding this comment.
The execute method did not have an explicit return 0 (but in Symfony 4 that works - it breaks in Symfony 5)
phil-davis
commented
May 17, 2023
| @@ -70,5 +70,6 @@ protected function execute(InputInterface $input, OutputInterface $output) { | |||
| ]); | |||
| }); | |||
| $t->render(); | |||
| return 0; | |||
There was a problem hiding this comment.
Another place to explicitly return 0 at the end of the method.
phil-davis
commented
May 17, 2023
| @@ -252,11 +252,12 @@ protected function execute(InputInterface $input, OutputInterface $output) { | |||
| '@phan-var \Symfony\Component\Console\Helper\QuestionHelper $dialog'; | |||
| $continue = $dialog->ask($input, $output, new Question('<question>Continue with the conversion (y/n)? [n] </question>', false)); | |||
| if ($continue !== 'y') { | |||
| return; | |||
| return 0; | |||
There was a problem hiding this comment.
The user has interactively answered "no". We are doing what the user said, so return 0 (which is success - we successfully did what the user said)
phil-davis
commented
May 17, 2023
| } | ||
| } | ||
| $intersectingTables = \array_intersect($toTables, $fromTables); | ||
| $this->convertDB($fromDB, $toDB, $intersectingTables, $input, $output); | ||
| return 0; |
There was a problem hiding this comment.
Return 0 (success) at the end of execute
phil-davis
commented
May 17, 2023
| @@ -82,20 +82,20 @@ protected function execute(InputInterface $input, OutputInterface $output) { | |||
| $output->writeln('This command requires the --path, --privateKey and --certificate.'); | |||
| $output->writeln('Example: ./occ integrity:sign-app --path="/Users/lukasreschke/Programming/myapp/" --privateKey="/Users/lukasreschke/private/myapp.key" --certificate="/Users/lukasreschke/public/mycert.crt"'); | |||
| $output->writeln('For more information please consult the documentation: '. $documentationUrl); | |||
| return null; | |||
| return 1; | |||
There was a problem hiding this comment.
null is not a proper return value. There is a problem, so return 1
phil-davis
commented
May 17, 2023
| $privateKeyPath = $input->getOption('privateKey'); | ||
| $keyBundlePath = $input->getOption('certificate'); | ||
| $path = $input->getOption('path'); | ||
| if ($privateKeyPath === null || $keyBundlePath === null || $path === null) { | ||
| $output->writeln('--privateKey, --certificate and --path are required.'); | ||
| return null; | ||
| return 1; |
There was a problem hiding this comment.
null is not a proper return value. There is a problem, so return 1
jvillafanez
reviewed
May 17, 2023
jvillafanez
approved these changes
May 17, 2023
phil-davis
force-pushed
the
symfony-command-execute
branch
from
6b52904
to
9c6c466
Compare
|
Kudos, SonarCloud Quality Gate passed! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Symfony 5 requires that the Symfony Command
executemethod always returns anintIt is "sort of" optional for Symfony 4, but actually we should always return an
intThis PR:
intintis now returned. That will fix potential problems with some commands.How Has This Been Tested?
CI
Types of changes
Checklist: