add check to the doctor that the 'six' python package is installed on… #2612
Conversation
This file contains hidden or 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
rosen-vladimirov
suggested changes
Mar 15, 2017
lib/services/doctor-service.ts
Outdated
| let sixPackagesFoundCount = parseInt(queryForSixPackage); | ||
| if (sixPackagesFoundCount === 0) { | ||
| hasInvalidPackages = true; | ||
| this.$logger.error("Python 'six' package not found. Please install it by running 'pip install six' from the terminal."); |
There was a problem hiding this comment.
Can you follow the same structure of messages as the others warnings:
this.$logger.warn("Python 'six' package not found.").
this.$logger.out("<information why do I need this package and what issues will occur in case I do not install it>. <information how to install this package>");The concept is - warning message (in yellow) that something is missing and additional information how will this affect me and how to fix the issue (text will be in the default terminal color).
For example I do not know what's the idea of this package and I will not install it on my machine without evidence that I need it.
lib/services/doctor-service.ts
Outdated
| this.$logger.error("Python 'six' package not found. Please install it by running 'pip install six' from the terminal."); | ||
| } | ||
| } catch (error) { | ||
| this.$logger.error("Cannot retrieve python installed packages. Please, make sure you have both 'python' and 'pip' installed."); |
There was a problem hiding this comment.
Same as above - logger.warn + logger.out.
Additionally it's a good practice to add the real error to the trace logs:
this.$logger.trace(`Error while validating Python packages. Error is: ${error.message}`);
Plamen5kov
reviewed
Mar 17, 2017
yyosifov
force-pushed
the
yosifov/add-six-check-to-doctor
branch
from
535ddb0 to
8c74f3a
Compare
rosen-vladimirov
approved these changes
Mar 20, 2017
|
run ci |
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.
When Python is installed on Mac via Brew it's missing the "six" python package, which is installed by default when using the default Python installer for Mac. The "six" python package is required from the CLI in order to work properly.
So, we added the check for "six" python package presence in the TNS Doctor so that it detects the missing piece and gives advice how to fix your environment.