def samconfig_parameters(cmd_names, config_dir=None, env=None, **kwargs):
"""
ContextManager to write a new SAM Config and remove the file after the contextmanager exists
Parameters
----------
cmd_names : list(str)
Name of the full commnad split as a list: ["generate-event", "s3", "put"]
config_dir : str
Path where the SAM config file should be written to. Defaults to os.getcwd()
env : str
Optional name of the config environment. This is currently unused
kwargs : dict
Parameter names and values to be written to the file.
Returns
-------
Path to the config file
"""
env = env or DEFAULT_ENV
section = "parameters"
samconfig = SamConfig(config_dir=config_dir)
try:
for k, v in kwargs.items():
samconfig.put(cmd_names, section, k, v, env=env)
samconfig.flush()
yield samconfig.path()
finally:
Path(samconfig.path()).unlink()
class TestSamConfig(TestCase):
def setUp(self):
self.config_dir = os.getcwd()
self.samconfig = SamConfig(self.config_dir)
def tearDown(self):
if self.samconfig.exists():
os.remove(self.samconfig.path())
def _setup_config(self):
self.samconfig.put(cmd_names=["local", "start", "api"],
section="parameters",
key="port",
value=5401)
self.samconfig.flush()
self._check_config_file()
def _check_config_file(self):
self.assertTrue(self.samconfig.exists())
self.assertTrue(self.samconfig.sanity_check())
self.assertEqual(SAM_CONFIG_VERSION,
self.samconfig.document.get(VERSION_KEY))
def test_init(self):
self.assertEqual(self.samconfig.filepath,
Path(self.config_dir, DEFAULT_CONFIG_FILE_NAME))
def test_param_overwrite(self):
self.samconfig.put(cmd_names=["myCommand"],
section="mySection",
key="port",
value=5401,
env="myEnv")
self.samconfig.flush()
self._check_config_file()
self.assertEqual({"port": 5401},
self.samconfig.get_all(cmd_names=["myCommand"],
section="mySection",
env="myEnv"))
self.samconfig.document = {}
self.samconfig.put(cmd_names=["myCommand"],
section="mySection",
key="port",
value=5402,
env="myEnv")
self.samconfig.flush()
self._check_config_file()
self.assertEqual({"port": 5402},
self.samconfig.get_all(cmd_names=["myCommand"],
section="mySection",
env="myEnv"))
self.samconfig.document = {}
self.assertEqual({"port": 5402},
self.samconfig.get_all(cmd_names=["myCommand"],
section="mySection",
env="myEnv"))
def test_add_params_from_different_env(self):
self.samconfig.put(cmd_names=["myCommand"],
section="mySection",
key="port",
value=5401,
env="myEnvA")
self.samconfig.flush()
self._check_config_file()
self.assertEqual({"port": 5401},
self.samconfig.get_all(cmd_names=["myCommand"],
section="mySection",
env="myEnvA"))
self.samconfig.document = {}
self.samconfig.put(cmd_names=["myCommand"],
section="mySection",
key="port",
value=5402,
env="myEnvB")
self.samconfig.flush()
self._check_config_file()
self.assertEqual({"port": 5401},
self.samconfig.get_all(cmd_names=["myCommand"],
section="mySection",
env="myEnvA"))
self.assertEqual({"port": 5402},
self.samconfig.get_all(cmd_names=["myCommand"],
section="mySection",
env="myEnvB"))
def test_add_params_from_different_cmd_names(self):
self.samconfig.put(cmd_names=["myCommand1"],
section="mySection",
key="port",
value="ABC",
env="myEnv")
self.samconfig.flush()
self._check_config_file()
self.assertEqual({"port": "ABC"},
self.samconfig.get_all(cmd_names=["myCommand1"],
section="mySection",
env="myEnv"))
self.samconfig.document = {}
self.samconfig.put(cmd_names=["myCommand2", "mySubCommand"],
section="mySection",
key="port",
value="DEF",
env="myEnv")
self.samconfig.flush()
self._check_config_file()
self.assertEqual({"port": "ABC"},
self.samconfig.get_all(cmd_names=["myCommand1"],
section="mySection",
env="myEnv"))
self.assertEqual(
{"port": "DEF"},
self.samconfig.get_all(cmd_names=["myCommand2", "mySubCommand"],
section="mySection",
env="myEnv"),
)
def test_add_params_from_different_sections(self):
self.samconfig.put(cmd_names=["myCommand"],
section="mySection1",
key="testKey1",
value=True,
env="myEnv")
self.samconfig.flush()
self._check_config_file()
self.assertEqual({"testKey1": True},
self.samconfig.get_all(cmd_names=["myCommand"],
section="mySection1",
env="myEnv"))
self.samconfig.document = {}
self.samconfig.put(cmd_names=["myCommand"],
section="mySection2",
key="testKey2",
value=False,
env="myEnv")
self.samconfig.flush()
self._check_config_file()
self.assertEqual(
{"testKey1": True},
self.samconfig.get_all(cmd_names=["myCommand"],
section="mySection1",
env="myEnv"),
)
self.assertEqual(
{"testKey2": False},
self.samconfig.get_all(cmd_names=["myCommand"],
section="mySection2",
env="myEnv"),
)
def test_add_params_from_different_keys(self):
self.samconfig.put(cmd_names=["myCommand"],
section="mySection",
key="testKey1",
value=True,
env="myEnv")
self.samconfig.flush()
self._check_config_file()
self.assertEqual({"testKey1": True},
self.samconfig.get_all(cmd_names=["myCommand"],
section="mySection",
env="myEnv"))
self.samconfig.document = {}
self.samconfig.put(cmd_names=["myCommand"],
section="mySection",
key="testKey2",
value=321,
env="myEnv")
self.samconfig.flush()
self._check_config_file()
self.assertEqual(
{
"testKey1": True,
"testKey2": 321
},
self.samconfig.get_all(cmd_names=["myCommand"],
section="mySection",
env="myEnv"),
)
def test_check_config_get(self):
self._setup_config()
self.assertEqual({"port": 5401},
self.samconfig.get_all(
cmd_names=["local", "start", "api"],
section="parameters"))
def test_check_config_exists(self):
self._setup_config()
self.assertTrue(self.samconfig.exists())
def test_check_sanity(self):
self.assertTrue(self.samconfig.sanity_check())
def test_check_version_non_supported_type(self):
self._setup_config()
self.samconfig.document.remove(VERSION_KEY)
self.samconfig.document.add(VERSION_KEY, "aadeff")
with self.assertRaises(SamConfigVersionException):
self.samconfig.sanity_check()
def test_check_version_no_version_exists(self):
self._setup_config()
self.samconfig.document.remove(VERSION_KEY)
with self.assertRaises(SamConfigVersionException):
self.samconfig.sanity_check()
def test_check_version_float(self):
self._setup_config()
self.samconfig.document.remove(VERSION_KEY)
self.samconfig.document.add(VERSION_KEY, 0.2)
self.samconfig.sanity_check()
def test_write_config_file_non_standard_version(self):
self._setup_config()
self.samconfig.document.remove(VERSION_KEY)
self.samconfig.document.add(VERSION_KEY, 0.2)
self.samconfig.put(cmd_names=["local", "start", "api"],
section="parameters",
key="skip_pull_image",
value=True)
self.samconfig.sanity_check()
self.assertEqual(self.samconfig.document.get(VERSION_KEY), 0.2)
class TestSamConfig(TestCase):
def setUp(self):
self.config_dir = os.getcwd()
self.samconfig = SamConfig(self.config_dir)
def tearDown(self):
if self.samconfig.exists():
os.remove(self.samconfig.path())
def _setup_config(self):
self.samconfig.put(cmd_names=["local", "start", "api"],
section="parameters",
key="port",
value=5401)
self.samconfig.flush()
self.assertTrue(self.samconfig.exists())
self.assertTrue(self.samconfig.sanity_check())
self.assertEqual(SAM_CONFIG_VERSION,
self.samconfig.document.get(VERSION_KEY))
def test_init(self):
self.assertEqual(self.samconfig.filepath,
Path(self.config_dir, DEFAULT_CONFIG_FILE_NAME))
def test_check_config_get(self):
self._setup_config()
self.assertEqual({"port": 5401},
self.samconfig.get_all(
cmd_names=["local", "start", "api"],
section="parameters"))
def test_check_config_exists(self):
self._setup_config()
self.assertTrue(self.samconfig.exists())
def test_check_sanity(self):
self.assertTrue(self.samconfig.sanity_check())
def test_check_version_non_supported_type(self):
self._setup_config()
self.samconfig.document.remove(VERSION_KEY)
self.samconfig.document.add(VERSION_KEY, "aadeff")
with self.assertRaises(SamConfigVersionException):
self.samconfig.sanity_check()
def test_check_version_no_version_exists(self):
self._setup_config()
self.samconfig.document.remove(VERSION_KEY)
with self.assertRaises(SamConfigVersionException):
self.samconfig.sanity_check()
def test_check_version_float(self):
self._setup_config()
self.samconfig.document.remove(VERSION_KEY)
self.samconfig.document.add(VERSION_KEY, 0.2)
self.samconfig.sanity_check()
def test_write_config_file_non_standard_version(self):
self._setup_config()
self.samconfig.document.remove(VERSION_KEY)
self.samconfig.document.add(VERSION_KEY, 0.2)
self.samconfig.put(cmd_names=["local", "start", "api"],
section="parameters",
key="skip_pull_image",
value=True)
self.samconfig.sanity_check()
self.assertEqual(self.samconfig.document.get(VERSION_KEY), 0.2)