class EnvironmentValidator:
"""
Houses genric environment validation logic that may branch based on current
configurations, such as Bastion / OKTA / GOOGLE / ETC.
"""
def __init__(self, defaults: CLIDefaults):
self._defaults = defaults
self._out = Output(self._defaults.colors_enabled)
self._utils = Utils(self._defaults.colors_enabled)
def validate_all(self):
if self._defaults.provider == Provider.AWS_BASTION:
self.validate_environment_variables()
return self
def validate_environment_variables(self):
# If figgy is operating in a TEST environment, ignore this.
if os.environ.get(FIGGY_TESTS_ENABLED):
return self
invalid_vars = []
for env_var in RESTRICTED_ENV_VARS:
if os.environ.get(env_var):
invalid_vars.append(env_var)
if invalid_vars:
self._out.error_h2(
f'AWS Environment overrides detected.\n\n {invalid_vars} is currently set in your '
f'environment. AWS_* prefixed environment variables can interfere with figgy '
f'operations and may cause unpredictable behavior. Please unset all AWS_ prefixed ENV '
f'variables before continuing.')
self._out.print(
'\nTo unset the problematic variables, please run the following command(s) in your shell: '
'\n')
for var in invalid_vars:
self._out.print(f'unset {var}')
self._utils.error_exit("Invalid environment detected, exiting.")
return self
class Sync(ConfigCommand):
"""
Synchronizes local application configuration state as defined in the figgy.json file and the existing remote state
in the targeted environment. Also configures replication for designated shared parameters in the
figgy.json file.
"""
def __init__(self, ssm_init: SsmDao, config_init: ConfigDao,
repl_dao: ReplicationDao, colors_enabled: bool,
context: ConfigContext, get: Get, put: Put):
super().__init__(sync, colors_enabled, context)
self._config = config_init
self._ssm = ssm_init
self._repl = repl_dao
self._config_path = context.ci_config_path if context.ci_config_path else Utils.find_figgy_json(
)
self._utils = Utils(colors_enabled)
self._replication_only = context.replication_only
self._errors_detected = False
self.example = f"{self.c.fg_bl}{CLI_NAME} config {self.command_printable} " \
f"--env dev --config /path/to/config{self.c.rs}"
self._get: Get = get
self._put: Put = put
self._FILE_PREFIX = "file://"
self._out = Output(colors_enabled)
def _input_config_values(self, config_keys: Set[str]) -> None:
"""
Prompts the user for each of the passed in set of config values if any are missing from PS.
:param config_keys: Set[string] - config values to prompt the user to add.
"""
def validate_msg(ps_name: str):
self._out.success(f"Name Validated: [[{ps_name}]]")
return validate_msg
count = 0
for key in config_keys:
try:
if not self._get.get(key):
self._out.warn(
f"Fig: [[{key}]] missing from PS in environment: [[{self.run_env}]]."
)
self._put.put_param(key=key, display_hints=False)
count = count + 1
else:
validate_msg(key)
except ClientError:
validate_msg(key)
if count:
self._out.success(
f"[[{count}]] {'value' if count == 1 else 'values'} added successfully"
)
def _sync_keys(self, config_namespace: str, all_keys: Set):
"""
Looks for stray parameters (keys) under the namespace provided and prints out information about
missing parameters that are not defined in the figgy.json file
Args:
config_namespace: Namespace to query PS under.
all_keys: All keys that exist in figgy.json to compare against.
"""
self._out.notify(f"Checking for stray config names.")
# Find & Prune stray keys
ps_keys = set(
list(
map(lambda x: x['Name'],
self._ssm.get_all_parameters([config_namespace]))))
ps_only_keys = ps_keys.difference(all_keys)
UNUSED_CONFIG_DETECTED = f"%%red%%The following Names were found in PS but are not referenced in your configurations. \n" \
f"Use the %%rs%%%%blue%%`prune`%%rs%%%%red%% command to clean them up once all " \
f"deployed application versions no longer use these configurations: %%rs%%"
if len(ps_only_keys) > 0:
self._out.warn(
"The following Names were found in PS but are not referenced in your configurations. \n"
"Use the [[prune]] command to clean them up once all.")
for key in ps_only_keys:
self._out.print(f"Unused Parameter: [[{key}]]")
if not ps_only_keys:
self._out.success(f"No stray configurations found.")
def _sync_repl_configs(self,
config_repl: Dict,
namespace: str = None) -> None:
"""
Syncs replication configs from a defined "replicate_figs" block parsed from either the figgy.json file
or the data replication config json file.
Args:
config_repl: Dict of KV Pairs for a repl config. Source -> Dest
namespace: Optional namespace. Parsed from destination if not supplied.
"""
local_configs: List[ReplicationConfig] = ReplicationConfig.from_dict(
conf=config_repl,
type=ReplicationType(REPL_TYPE_APP),
run_env=self.run_env,
namespace=namespace)
for l_cfg in local_configs:
# Namespace will be missing for --replication-only syncs. Otherwise, with standard syncs, namespace is passed
# as a parameter here.
if not namespace:
namespace = l_cfg.namespace
if not l_cfg.destination.startswith(namespace):
self._out.error(
f"Replication config [[{l_cfg.source} -> {l_cfg.destination}]] has a destination that "
f"is not in your service namespace: [[{namespace}]]. This is invalid."
)
self.errors_detected = True
continue
remote_cfg = self._repl.get_config_repl(l_cfg.destination)
# Should never happen, except when someone manually deletes source / destination without going through CLI
missing_from_ps = self.__get_param_encrypted(l_cfg.source) is None
if not remote_cfg or remote_cfg != l_cfg or missing_from_ps:
try:
if self._can_replicate_from(
l_cfg.source
) and not remote_cfg or missing_from_ps:
self._repl.put_config_repl(l_cfg)
self._out.print(
f"[[Replication added:]] {l_cfg.source} -> {l_cfg.destination}"
)
elif self._can_replicate_from(l_cfg.source) and remote_cfg:
self._repl.put_config_repl(l_cfg)
self._out.notify(f"Replication updated.")
self._out.warn(
f"Removed: {remote_cfg.source} -> {remote_cfg.destination}"
)
self._out.success(
f"Added: {l_cfg.source} -> {l_cfg.destination}")
else:
self._errors_detected = True
# print(f"{self.c.fg_rd}You do not have permission to configure replication from source:"
# f"{self.c.rs} {key}")
except ClientError:
self._utils.validate(
False,
f"Error detected when attempting to store replication config "
f"for {l_cfg.destination}")
self._errors_detected = True
else:
self._out.success(
f"Replication Validated: [[{l_cfg.source} -> {l_cfg.destination}]]"
)
def _notify_of_data_repl_orphans(self, config_repl: Dict) -> None:
"""
Notify user of detected stray replication configurations when using the --replication-only flag.
:param config_repl: replication configuration block.
"""
strays: Set[ReplicationConfig] = set()
notify = False
for repl in config_repl:
namespace = self._utils.parse_namespace(config_repl[repl])
remote_cfgs = self._repl.get_all_configs(namespace)
if remote_cfgs:
for cfg in remote_cfgs:
if cfg.source not in list(config_repl.keys()) \
and cfg.type == REPL_TYPE_APP \
and not cfg.source.startswith(shared_ns) \
and not cfg.source.startswith(self.context.defaults.service_ns):
strays.add(cfg)
notify = True
for stray in strays:
print(
f"{self.c.fg_yl}stray replication mapping detected: {self.c.rs}"
f" {self.c.fg_bl}{stray.source} -> {stray.destination}{self.c.rs}."
)
if notify:
print(
f"To prune stray replication configs, "
f"delete the destination, THEN the source with the `figgy config delete` command"
)
def _sync_replication(self, config_repl: Dict, expected_destinations: Set,
namespace: str):
"""
Calls sync_repl_configs which adds/removes repl configs. Then searches for stray configurations and notifies
the user of detected stray configurations.
Args:
config_repl: Dict of KV Pairs for a repl config. Source -> Dest
expected_destinations: expected replication destinations, as defined in merge key sources,
or shared_figs
namespace: Namespace to sync replication configs to. E.g. /app/demo-time/
"""
self._out.notify(f"Validating replication for all parameters.")
self._sync_repl_configs(config_repl, namespace=namespace)
self._out.notify(f"\nChecking for stray replication configurations.")
remote_cfgs = self._repl.get_all_configs(namespace)
notify = True
if remote_cfgs:
for cfg in remote_cfgs:
if cfg.source not in list(config_repl.keys()) \
and cfg.destination not in list(config_repl.values()) \
and cfg.destination not in expected_destinations \
and (isinstance(cfg.source, list)
or cfg.source.startswith(shared_ns) or cfg.source.startswith(
self.context.defaults.service_ns)):
print(
f"{self.c.fg_rd}Stray replication mapping detected: {self.c.rs}"
f" {self.c.fg_bl}{cfg.source} -> {cfg.destination}{self.c.rs}."
)
notify = False
if notify:
self._out.success(
f"No stray replication configs found for: {namespace}")
else:
self._out.warn(f"{CLEANUP_REPLICA_ORPHANS}")
def _validate_merge_keys(self, destination: str, sources: Union[List, str],
namespace: str) -> bool:
"""
Validates merge key sources & destinations
Args:
destination: str -> Destination of merge key replication
sources: List or Str -> Source(e) of this merge key
namespace: application namespace
"""
if not destination.startswith(namespace):
print(
f"{self.c.fg_rd}Merge config: {self.c.rs}{self.c.fg_bl}{destination}{self.c.rs}{self.c.fg_rd} has a "
f"destination that is not in your service namespace: "
f"{self.c.rs}{self.c.fg_bl}{namespace}{self.c.rs}{self.c.fg_rd}. This is invalid.{self.c.rs}"
)
self.errors_detected = True
return False
if isinstance(sources, list):
for item in sources:
if item.startswith(MERGE_KEY_PREFIX):
self._utils.validate(
item.replace(MERGE_KEY_PREFIX,
"").startswith(namespace),
f"Source: {item} in merge config must begin with your namespace: {namespace}."
)
self.errors_detected = True
return False
else:
self._utils.validate(
sources.startswith(namespace),
f"Source {sources} in merge config must begin with your namespace: {namespace}"
)
self.errors_detected = True
return False
return True
def _sync_merge_keys(self, config_merge: Dict, namespace: str) -> None:
"""
Pushes merge key configs into replication config table.
Args:
config_merge: Dict of merge_parameters parsed from figcli.json file
namespace: namespace for app
"""
self._out.notify("Validating replication for all merge keys.")
for key in config_merge:
self._validate_merge_keys(key, config_merge[key], namespace)
config = self._repl.get_config_repl(key)
if not config or (config.source != config_merge[key]):
try:
repl_config = ReplicationConfig(
destination=key,
run_env=self.run_env,
namespace=namespace,
source=config_merge[key],
type=ReplicationType(REPL_TYPE_MERGE))
self._repl.put_config_repl(repl_config)
except ClientError:
self._utils.validate(
False,
f"Error detected when attempting to store replication config for {key}"
)
self._errors_detected = True
else:
self._out.success(
f"Merge key replication config validated: [[{key}]]")
def _validate_expected_names(self, all_names: Set, repl_conf: Dict,
merge_conf: Dict):
self._out.notify(f"Validating shared keys exist.")
print_resolution_message = False
merged_confs = {**repl_conf, **merge_conf}
for name in all_names:
if self.__get_param_encrypted(name) is None:
awaiting_repl = False
for cnf in merged_confs:
if name == cnf or name in list(repl_conf.values()):
self._out.print(
f"\nConfig value [[{name}]] is a destination for replication, but doesn't exist"
f" yet. If you commit now your build could fail. This will auto-resolve itself if all of "
f"its dependencies exist. This will probably resolve itself in a few seconds. "
f"Try re-running sync.")
awaiting_repl = True
break
if not awaiting_repl:
self._out.print(
f"Config value of [[{name}]] does not exist and is expected based on "
f"your defined configuration.")
print_resolution_message = True
self._errors_detected = True
if print_resolution_message:
self._out.error(f"{SHARED_NAME_RESOLUTION_MESSAGE}")
else:
self._out.success("Shared keys have been validated.")
def _can_replicate_from(self, source: str):
try:
if self.__get_param_encrypted(source) is not None:
return True
else:
self._out.warn(
f"Replication source: [[{source}]] is missing from ParameterStore. "
f"It must be added before config replication can be configured.\n"
)
self._input_config_values({source})
return True
except ClientError as e:
denied = "AccessDeniedException" == e.response['Error']['Code']
if denied and "AWSKMS; Status Code: 400;" in e.response['Error'][
'Message']:
self._out.error(
f"You do not have access to decrypt the value of Name: [[{source}]]"
)
elif denied:
self._out.error(
f"You do not have access to Parameter: [[{source}]]")
else:
raise
return False
def __get_param_encrypted(self, source: str) -> Optional[str]:
try:
return self._ssm.get_parameter_encrypted(source)
except ClientError as e:
denied = "AccessDeniedException" == e.response['Error']['Code']
if denied and "AWSKMS; Status Code: 400;" in e.response['Error'][
'Message']:
self._out.error(
f"You do not have access to decrypt the value of Name: [[{source}]]"
)
return None
elif denied:
self._utils.error_exit(
f"You do not have access to Parameter: {source}")
else:
raise
def _validate_replication_config(self,
config_repl: Dict,
app_conf: bool = True):
"""
Validates replication config blocks are valid / legal. Prevents people from setting up replication from
disallowed namespaces, etc. Exits with error if invalid config is discovered.
Args:
config_repl: Dict of KV Pairs for a repl config. Source -> Dest
app_conf: bool: T/F - True if this is an application config block in an application config (figgy.json).
False if other, which for now is only repl-configs for data teams.
"""
for key in config_repl:
if app_conf:
self._utils.validate(
re.match(
f'^/shared/.*$|^{self.context.defaults.service_ns}/.*$',
key) is not None,
f"The SOURCE of your replication configs must begin with `/shared/` or "
f"`{self.context.defaults.service_ns}/`. "
f"{key} is non compliant.")
self._utils.validate(
re.match(f'^{self.context.defaults.service_ns}/.*$',
config_repl[key]) is not None,
f"The DESTINATION of your replication configs must always begin with "
f"`{self.context.defaults.service_ns}/`")
def _find_missing_shared_figs(self, namespace: str, config_repl: Dict,
shared_names: set, merge_conf: Dict):
"""
Notifies the user if there is a parameter that has been shared into their namespace by an outside party
but they have not added it to the `shared_figs` block of their figgy.json
"""
all_repl_cfgs = self._repl.get_all_configs(namespace)
for cfg in all_repl_cfgs:
in_merge_conf = self._in_merge_value(cfg.destination, merge_conf)
if cfg.destination not in shared_names and cfg.type == REPL_TYPE_APP \
and cfg.destination not in config_repl.values() and not in_merge_conf:
print(
f"It appears that {self.c.fg_bl}{cfg.user}{self.c.rs} shared "
f"{self.c.fg_bl}{cfg.source}{self.c.rs} to {self.c.fg_bl}{cfg.destination}{self.c.rs} "
f"and you have not added {self.c.fg_bl}{cfg.destination}{self.c.rs} to the "
f"{self.c.fg_bl}{SHARED_KEY}{self.c.rs} section of your figgy.json. This is also not "
f"referenced in any defined merge parameter. Please add "
f"{self.c.fg_bl}{cfg.destination}{self.c.rs} to your figgy.json, or delete this parameter "
f"and the replication config with the prune command.")
def _in_merge_value(self, dest: str, merge_conf: Dict):
for key in merge_conf:
value = merge_conf[key]
# 'value' can be a list or a str, but the way 'in' operates, this works either way. #dynamic programming
for suffix in merge_suffixes:
if f"${'{'}{dest}{suffix}{'}'}" in value:
return True
return False
def _fill_repl_conf_variables(self, repl_conf: Dict) -> Dict:
repl_copy = {}
all_vars = []
for key, val in repl_conf.items():
all_vars = all_vars + re.findall(r'\${(\w+)}', key)
all_vars = all_vars + re.findall(r'\${(\w+)}', key)
all_vars = set(all_vars)
if all_vars:
print(
f"{self.c.fg_bl}{len(all_vars)} variables detected in: {self.c.rs}{self.c.fg_yl}"
f"{self._config_path}{self.c.rs}\n")
template_vals = {}
for var in all_vars:
print(f"Template variable: {self.c.fg_bl}{var}{self.c.rs} found.")
input_val = Input.input(
f"Please input a value for {self.c.fg_bl}{var}{self.c.rs}: ",
min_length=1)
template_vals[var] = input_val
for key, val in repl_conf.items():
updated_key = key
updated_val = val
for template_key, template_val in template_vals.items():
updated_key = updated_key.replace(f"${{{template_key}}}",
template_val)
updated_val = updated_val.replace(f"${{{template_key}}}",
template_val)
repl_copy[updated_key] = updated_val
repl_copy[updated_key] = updated_val
return repl_copy
def run_ci_sync(self) -> None:
"""
Orchestrates a standard `sync` command WITHOUT The `--replication-only` flag set.
"""
# Validate & parse figgy.json
config = self._utils.get_ci_config(self._config_path)
shared_names = set(
self._utils.get_config_key_safe(SHARED_KEY, config, default=[]))
repl_conf = self._utils.get_config_key_safe(REPLICATION_KEY,
config,
default={})
repl_from_conf = self._utils.get_config_key_safe(REPL_FROM_KEY,
config,
default={})
merge_conf = self._utils.get_config_key_safe(MERGE_KEY,
config,
default={})
config_keys = set(
self._utils.get_config_key_safe(CONFIG_KEY, config, default=[]))
namespace = self._utils.get_namespace(config)
merge_keys = set(merge_conf.keys())
all_keys = KeyUtils.find_all_expected_names(config_keys, shared_names,
merge_conf, repl_conf,
repl_from_conf, namespace)
repl_conf = KeyUtils.merge_repl_and_repl_from_blocks(
repl_conf, repl_from_conf, namespace)
# Add missing config values
self._out.notify(
f"Validating all configuration keys exist in ParameterStore.")
self._input_config_values(config_keys)
# Sync keys between PS / Local config
print()
self._sync_keys(namespace, all_keys)
print()
self._find_missing_shared_figs(namespace, repl_conf, shared_names,
merge_conf)
# Disabling requirement (for now) of replication to be in /replicated path
# print()
self._validate_replication_config(repl_conf, app_conf=True)
print()
# sync replication config
all_shared_keys = shared_names | set(merge_conf.keys())
self._sync_replication(repl_conf, all_shared_keys, namespace)
print()
self._sync_merge_keys(merge_conf, namespace)
print()
# validate expected keys exist
self._validate_expected_names(all_keys, repl_conf, merge_conf)
def run_repl_sync(self) -> None:
"""
Orchestrates sync when the user passes in the `--replication-only` flag.
"""
self._utils.validate(
os.path.exists(self._config_path),
f"Path {self._config_path} is invalid. "
f"That file does not exist.")
repl_conf = self._utils.get_repl_config(self._config_path)
repl_conf = self._fill_repl_conf_variables(repl_conf)
self._validate_replication_config(repl_conf, app_conf=False)
self._sync_repl_configs(repl_conf)
self._notify_of_data_repl_orphans(repl_conf)
@VersionTracker.notify_user
@AnonymousUsageTracker.track_command_usage
def execute(self):
print()
if self._replication_only:
self.run_repl_sync()
else:
self.run_ci_sync()
if self._errors_detected:
self._out.error_h2(
'Sync failed. Please address the outputted errors.')
else:
self._out.success_h2('Sync completed with no errors!')