def configure(self) -> CLIDefaults:
"""
Orchestrates the --configure option. Writes selections to a defaults file in user's home dir.
This default files stores the following information:
user: User Name for SSO integrations
role: The user's preferred default role if --role is not specified
env: The user's preferred eefault environment if --env is not specified
valid_roles: A list of roles the user has access to based on the returned SAML assertion from the SSO provider
valid_envs: A list of environments the user has access to based on the returned SAML assertion
assumable_roles: Maintains a mapping of accountId -> environment name -> role name so the we can authenticate
the user with the appropriate AWS accounts based on their returned SAML assertion.
"""
Utils.wipe_vaults() or Utils.wipe_defaults(
) or Utils.wipe_config_cache()
defaults: CLIDefaults = self._setup.get_defaults()
defaults = self._setup.configure_auth(defaults)
defaults = self._setup.configure_extras(defaults)
self._setup.save_defaults(defaults)
self.c = TerminalFactory(Utils.is_mac()).instance().get_colors()
defaults = self._setup.configure_roles(current_defaults=defaults)
defaults = self._setup.configure_preferences(defaults)
defaults = self._setup.configure_figgy_defaults(defaults)
self._setup.save_defaults(defaults)
print(f"\n{self.c.fg_gr}Setup successful! Enjoy figgy!{self.c.rs}")
return defaults
def get_or_prompt(self,
key: Enum,
get_it: Callable,
colors_enabled=Utils.is_mac(),
force_prompt=False,
desc: str = None) -> str:
"""
Retrieves a value from the config_file based on the provided ENUM's value.
If the value is unset, executes the get_it() method provided to retrieve the value, then returns it.
If the user selects something _other_ than the default, overwrite the original value in the config file
:param key: Enum representing the config value to fetch
:param get_it: Method to execute if `config` is not in the configured config_file
:param colors_enabled: Whether or not to enable colored output for the prompt if a config is found in config_file
:param optional description to provide context when user is prompted.
:return: String value from the config file, or the result of get_it()
"""
c = TerminalFactory(colors_enabled).instance().get_colors()
val = self.get_property(key)
selection = None
if val or force_prompt:
if not force_prompt:
print(f"\n\n{c.fg_bl}Default value found:{c.rs}")
print(f"Key: {c.fg_gr}{key.value}{c.rs}")
print(f"Value: {c.fg_gr}{val}{c.rs}")
if desc:
print(f"Description: {desc}")
selection = Input.y_n_input(f"Continue with `{val}`? ",
default_yes=True)
if not selection or force_prompt:
original_val = val
val = get_it()
if isinstance(val, bool):
val = "true" if val else "false"
if val != original_val:
print(
f"\n\nYou selected to overwrite the default. Updating default value:"
f"\nKey: {c.fg_gr}{key.value}{c.rs}"
f"\nFrom: {c.fg_yl}{original_val}{c.rs}"
f"\nTo: {c.fg_gr}{val}{c.rs}"
f"\nIn file {c.fg_bl}{self.config_file}{c.rs}")
self.set(key, val)
else:
val = get_it()
return val
class Upgrade(MaintenanceCommand):
"""
Drives the --version command
"""
def __init__(self, maintenance_context: MaintenanceContext,
config_service: Optional[ConfigService]):
super().__init__(version, maintenance_context.defaults.colors_enabled,
maintenance_context)
self.tracker = VersionTracker(self.context.defaults, config_service)
self.upgrade_mgr = UpgradeManager(
maintenance_context.defaults.colors_enabled)
self._utils = Utils(
colors_enabled=maintenance_context.defaults.colors_enabled)
self._out = Output(
colors_enabled=maintenance_context.defaults.colors_enabled)
def upgrade(self):
latest_version: FiggyVersionDetails = self.tracker.get_version()
install_success, upgrade_it = False, True
if self.upgrade_mgr.is_pip_install():
self._out.error(
f"Figgy appears to have been installed with pip. Please upgrade [[{CLI_NAME}]] with "
f"`pip` instead.")
self._out.print(
f"\n\n[[Try this command]]: pip install figgy-cli --upgrade")
self._out.print(
f"\n\nPip based [[{CLI_NAME}]] installations do not support automatic upgrades and "
f"instead require pip-managed upgrades; however, Homebrew, one-line, and manual "
f"installations support auto-upgrade. Please consider installing figgy through one "
f"of these other methods to take advantage of this feature. "
f"It will save you time, help keep you up-to-date, and enable important features like "
f"release-rollbacks and canary releases! "
f"[[https://www.figgy.dev/docs/getting-started/install/]]")
sys.exit(0)
install_path = self.upgrade_mgr.install_path
if not install_path:
self._utils.error_exit(
f"Unable to detect local figgy installation. Please reinstall figgy and follow one "
f"of the recommended installation procedures.")
if latest_version.version == VERSION:
self._out.success(
f'You are currently using the latest version of [[{CLI_NAME}]]: [[{VERSION}]]'
)
upgrade_it = False
elif self.tracker.upgrade_available():
self._out.notify_h2(
f"New version: [[{latest_version.version}]] is more recent than your version: [[{VERSION}]]"
)
upgrade_it = True
elif not self.tracker.cloud_version_compatible_with_upgrade():
self._out.notify_h2(
f"Version [[{self.tracker.get_version().version}]] of the Figgy CLI is available but your "
f"current version of Figgy Cloud ([[{self.tracker.current_cloud_version()}]]) is not compatible."
f" Your administrator must first update FiggyCloud to at least version: "
f"[[{self.tracker.required_cloud_version()}]] before you can upgrade Figgy."
)
upgrade_it = False
else:
self._out.notify_h2(
f"Your version: [[{VERSION}]] is more recent then the current recommended version "
f"of {CLI_NAME}: [[{latest_version.version}]]")
upgrade_it = Input.y_n_input(
f'Would you like to revert to the current recommended version '
f'of {CLI_NAME}?')
if upgrade_it:
if self._utils.is_mac():
self._out.print(
f"\nMacOS auto-upgrade is supported. Performing auto-upgrade."
)
install_success = self.install_mac(latest_version)
elif self._utils.is_linux():
self._out.print(
f"\nLinux auto-upgrade is supported. Performing auto-upgrade."
)
install_success = self.install_linux(latest_version)
elif self._utils.is_windows():
self._out.print(
f"\nWindows auto-upgrade is supported. Performing auto-upgrade."
)
install_success = self.install_windows(latest_version)
if install_success:
self._out.success(
f"Installation successful! Exiting. Rerun `[[{CLI_NAME}]]` "
f"to use the latest version!")
else:
self._out.warn(
f"\nUpgrade may not have been successful. Check by re-running "
f"[[`{CLI_NAME}` --version]] to see if it was. If it wasn't, please reinstall [[`{CLI_NAME}`]]. "
f"See {INSTALL_URL}.")
def install_mac(self, latest_version: FiggyVersionDetails) -> bool:
install_path = '/usr/local/bin/figgy'
if self.upgrade_mgr.is_brew_install():
self._out.notify_h2(f"Homebrew installation detected!")
print(
f"This upgrade process will not remove your brew installation but will instead unlink it. "
f"Going forward you will no longer need homebrew to manage {CLI_NAME}. Continuing is recommended.\n"
)
selection = Input.y_n_input(f"Continue? ", default_yes=True)
else:
selection = True
if selection:
self.upgrade_mgr.install_onedir(install_path,
latest_version.version, MAC)
return True
else:
self._out.print(
f'\n[[Auto-upgrade aborted. To upgrade through brew run:]] \n'
f'-> brew upgrade figtools/figgy/figgy')
self._out.warn(
f"\n\nYou may continue to manage [[{CLI_NAME}]] through Homebrew, but doing so will "
f"limit some upcoming functionality around canary releases, rollbacks, and dynamic "
f"version-swapping.")
return False
def install_linux(self, latest_version: FiggyVersionDetails) -> bool:
install_path = self.upgrade_mgr.install_path
self.upgrade_mgr.install_onedir(install_path, latest_version.version,
LINUX)
return True
def install_windows(self, latest_version: FiggyVersionDetails) -> bool:
install_path = self.upgrade_mgr.install_path
self.upgrade_mgr.install_onedir(install_path, latest_version.version,
WINDOWS)
return True
@AnonymousUsageTracker.track_command_usage
def execute(self):
self.upgrade()
