charmcraft: perform LXD checks before use (CRAFT-420) #474
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
Invoke ensure_lxd_is_ready() interface before using LXD provider. This consolidates a couple of existing checks done elsewhere as well as a new one for ensuring the user has the necessary permissions to use LXD. Minor simplification of imports used in providers module to improve and update mocks accordingly. Example error: ``` $ /snap/bin/charmcraft pack LXD requires additional permissions. Please ensure that the user is in the 'lxd' group. (full execution logs in '/home/test1/snap/charmcraft/common/charmcraft-log-0xgcist7') ``` Signed-off-by: Chris Patterson <chris.patterson@canonical.com>
sergiusens
requested changes
Aug 2, 2021
charmcraft/providers.py
Outdated
| lxd.install() | ||
| except lxd.LXDInstallationError as error: | ||
| raise CommandError( | ||
| "Failed to install LXD. Please visit https://snapcraft.io/lxd for " |
There was a problem hiding this comment.
Remove Please, start with Visit -> https://discourse.ubuntu.com/t/tone-of-voice/18883
There was a problem hiding this comment.
Ah yes, I questioned it when I wrote it way back when and never did reconsider. 🤔 I think I just feel compelled to be polite 🤣 will fix (but note that this was just an indent change, not new text).
charmcraft/providers.py
Outdated
| raise CommandError( | ||
| "Failed to install LXD. Please visit https://snapcraft.io/lxd for " | ||
| "LXD is required, but not installed. Please visit https://snapcraft.io/lxd for " |
added 2 commits
August 2, 2021 19:01
Signed-off-by: Chris Patterson <chris.patterson@canonical.com>
sergiusens
approved these changes
Aug 3, 2021
facundobatista
approved these changes
Aug 3, 2021
| if not is_provider_available(): | ||
| if confirm_with_user( | ||
| "LXD is required, but not installed. Do you wish to install LXD " | ||
| "and configure it with the defaults?", |
There was a problem hiding this comment.
Not worth for this branch, but for the future: for readability in these cases please write the long message outside the if. Thanks!
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.
Invoke ensure_lxd_is_ready() interface before using LXD
provider. This consolidates a couple of existing checks
done elsewhere as well as a new one for ensuring the user
has the necessary permissions to use LXD.
Minor simplification of imports used in providers module
to improve and update mocks accordingly.
Example error:
Signed-off-by: Chris Patterson chris.patterson@canonical.com