From 7b24d6e2dcbe71272645b04657b9354612e8a8fa Mon Sep 17 00:00:00 2001 From: Thomas Haller Date: Tue, 3 Dec 2019 10:58:31 +0100 Subject: [PATCH] cloud-setup: mark environment variables that are supported configuration "nm-cloud-setup" can by configured via environment variables. Mark all the names of such variables with NMCS_ENV_VARIABLE() macro. This allows to grep for them. --- clients/cloud-setup/main.c | 2 +- clients/cloud-setup/nm-cloud-setup-utils.h | 6 ++++++ clients/cloud-setup/nmcs-provider-ec2.c | 9 ++++++--- 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/clients/cloud-setup/main.c b/clients/cloud-setup/main.c index 994a9fe0e6..8250945c47 100644 --- a/clients/cloud-setup/main.c +++ b/clients/cloud-setup/main.c @@ -594,7 +594,7 @@ main (int argc, const char *const*argv) gs_unref_object NMClient *nmc = NULL; gs_unref_hashtable GHashTable *config_dict = NULL; - _nm_logging_enabled_init (g_getenv ("NM_CLOUD_SETUP_LOG")); + _nm_logging_enabled_init (g_getenv (NMCS_ENV_VARIABLE ("NM_CLOUD_SETUP_LOG"))); _LOGD ("nm-cloud-setup %s starting...", NM_DIST_VERSION); diff --git a/clients/cloud-setup/nm-cloud-setup-utils.h b/clients/cloud-setup/nm-cloud-setup-utils.h index fa36d38985..0fc12bc47d 100644 --- a/clients/cloud-setup/nm-cloud-setup-utils.h +++ b/clients/cloud-setup/nm-cloud-setup-utils.h @@ -7,6 +7,12 @@ /*****************************************************************************/ +/* mark names for variables that can be used as configuration. Search + * for NMCS_ENV_VARIABLE() to find all honored environment variables. */ +#define NMCS_ENV_VARIABLE(var) ""var"" + +/*****************************************************************************/ + extern volatile NMLogLevel _nm_logging_configured_level; static inline gboolean diff --git a/clients/cloud-setup/nmcs-provider-ec2.c b/clients/cloud-setup/nmcs-provider-ec2.c index 54686fdf6e..b6ac5a4c95 100644 --- a/clients/cloud-setup/nmcs-provider-ec2.c +++ b/clients/cloud-setup/nmcs-provider-ec2.c @@ -24,9 +24,12 @@ _ec2_base (void) again: base = g_atomic_pointer_get (&base_cached); if (G_UNLIKELY (!base)) { + /* The base URI can be set via environment variable. - * This is only for testing, not really to be configurable! */ - base = g_getenv ("NM_CLOUD_SETUP_EC2_HOST"); + * This is mainly for testing, it's not usually supposed to be configured. + * Consider this private API! */ + base = g_getenv (NMCS_ENV_VARIABLE ("NM_CLOUD_SETUP_EC2_HOST")); + if ( base && base[0] && !strchr (base, '/')) { @@ -546,7 +549,7 @@ nmcs_provider_ec2_class_init (NMCSProviderEC2Class *klass) NMCSProviderClass *provider_class = NMCS_PROVIDER_CLASS (klass); provider_class->_name = "ec2"; - provider_class->_env_provider_enabled = "NM_CLOUD_SETUP_EC2"; + provider_class->_env_provider_enabled = NMCS_ENV_VARIABLE ("NM_CLOUD_SETUP_EC2"); provider_class->detect = detect; provider_class->get_config = get_config; }