From 217ef6ba6c52788f4363b998b6da08863fea5cd9 Mon Sep 17 00:00:00 2001 From: Chad Smith Date: Thu, 10 Feb 2022 13:18:00 -0700 Subject: cloud-id: publish /run/cloud-init/cloud-id- files (#1244) Once a valid datasource is detected, publish the following artifacts to expedite cloud-identification without having to invoke cloud-id from shell scripts or sheling out from python. These files can also be relied on in systemd ConditionPathExists directives to limit execution of services and units to specific clouds. /run/cloud-init/cloud-id: - A symlink with content that is the canonical cloud-id of the datasource detected. This content is the same lower-case value as the output of /usr/bin/cloud-id. /run/cloud-init/cloud-id-: - A single file which will contain the canonical cloud-id encoded in the filename --- tests/integration_tests/modules/test_combined.py | 26 ++++++++++++++ tests/unittests/sources/test_init.py | 46 ++++++++++++++++++++++-- 2 files changed, 70 insertions(+), 2 deletions(-) (limited to 'tests') diff --git a/tests/integration_tests/modules/test_combined.py b/tests/integration_tests/modules/test_combined.py index 43aa809e..7a9a6e27 100644 --- a/tests/integration_tests/modules/test_combined.py +++ b/tests/integration_tests/modules/test_combined.py @@ -222,6 +222,16 @@ class TestCombined: == parsed_datasource ) + def test_cloud_id_file_symlink(self, class_client: IntegrationInstance): + cloud_id = class_client.execute("cloud-id").stdout + expected_link_output = ( + "'/run/cloud-init/cloud-id' -> " + f"'/run/cloud-init/cloud-id-{cloud_id}'" + ) + assert expected_link_output == str( + class_client.execute("stat -c %N /run/cloud-init/cloud-id") + ) + def _check_common_metadata(self, data): assert data["base64_encoded_keys"] == [] assert data["merged_cfg"] == "redacted for non-root user" @@ -249,6 +259,10 @@ class TestCombined: v1_data = data["v1"] assert v1_data["cloud_name"] == "unknown" assert v1_data["platform"] == "lxd" + assert v1_data["cloud_id"] == "lxd" + assert f"{v1_data['cloud_id']}" == client.read_from_file( + "/run/cloud-init/cloud-id-lxd" + ) assert ( v1_data["subplatform"] == "seed-dir (/var/lib/cloud/seed/nocloud-net)" @@ -270,6 +284,10 @@ class TestCombined: v1_data = data["v1"] assert v1_data["cloud_name"] == "unknown" assert v1_data["platform"] == "lxd" + assert v1_data["cloud_id"] == "lxd" + assert f"{v1_data['cloud_id']}" == client.read_from_file( + "/run/cloud-init/cloud-id-lxd" + ) assert any( [ "/var/lib/cloud/seed/nocloud-net" in v1_data["subplatform"], @@ -291,6 +309,11 @@ class TestCombined: v1_data = data["v1"] assert v1_data["cloud_name"] == "aws" assert v1_data["platform"] == "ec2" + # Different regions will show up as ec2-(gov|china) + assert v1_data["cloud_id"].startswith("ec2") + assert f"{v1_data['cloud_id']}" == client.read_from_file( + "/run/cloud-init/cloud-id-ec2" + ) assert v1_data["subplatform"].startswith("metadata") assert ( v1_data["availability_zone"] == client.instance.availability_zone @@ -310,6 +333,9 @@ class TestCombined: v1_data = data["v1"] assert v1_data["cloud_name"] == "gce" assert v1_data["platform"] == "gce" + assert f"{v1_data['cloud_id']}" == client.read_from_file( + "/run/cloud-init/cloud-id-gce" + ) assert v1_data["subplatform"].startswith("metadata") assert v1_data["availability_zone"] == client.instance.zone assert v1_data["instance_id"] == client.instance.instance_id diff --git a/tests/unittests/sources/test_init.py b/tests/unittests/sources/test_init.py index 745a7fa6..ce8fc970 100644 --- a/tests/unittests/sources/test_init.py +++ b/tests/unittests/sources/test_init.py @@ -378,7 +378,11 @@ class TestDataSource(CiTestCase): "dist": ["ubuntu", "20.04", "focal"], } with mock.patch("cloudinit.util.system_info", return_value=sys_info): - datasource.get_data() + with mock.patch( + "cloudinit.sources.canonical_cloud_id", + return_value="canonical_cloud_id", + ): + datasource.get_data() json_file = self.tmp_path(INSTANCE_JSON_FILE, tmp) content = util.load_file(json_file) expected = { @@ -390,6 +394,7 @@ class TestDataSource(CiTestCase): "_beta_keys": ["subplatform"], "availability-zone": "myaz", "availability_zone": "myaz", + "cloud_id": "canonical_cloud_id", "cloud-name": "subclasscloudname", "cloud_name": "subclasscloudname", "distro": "ubuntu", @@ -562,7 +567,11 @@ class TestDataSource(CiTestCase): datasource.sensitive_metadata_keys, ) with mock.patch("cloudinit.util.system_info", return_value=sys_info): - datasource.get_data() + with mock.patch( + "cloudinit.sources.canonical_cloud_id", + return_value="canonical-cloud-id", + ): + datasource.get_data() sensitive_json_file = self.tmp_path(INSTANCE_JSON_SENSITIVE_FILE, tmp) content = util.load_file(sensitive_json_file) expected = { @@ -583,6 +592,7 @@ class TestDataSource(CiTestCase): "_beta_keys": ["subplatform"], "availability-zone": "myaz", "availability_zone": "myaz", + "cloud_id": "canonical-cloud-id", "cloud-name": "subclasscloudname", "cloud_name": "subclasscloudname", "distro": "ubuntu", @@ -666,6 +676,38 @@ class TestDataSource(CiTestCase): {"ec2stuff": "is good"}, instance_data["ds"]["ec2_metadata"] ) + def test_persist_instance_data_writes_canonical_cloud_id_and_symlink(self): + """canonical-cloud-id class attribute is set, persist to json.""" + tmp = self.tmp_dir() + datasource = DataSourceTestSubclassNet( + self.sys_cfg, self.distro, Paths({"run_dir": tmp}) + ) + cloud_id_link = os.path.join(tmp, "cloud-id") + cloud_id_file = os.path.join(tmp, "cloud-id-my-cloud") + cloud_id2_file = os.path.join(tmp, "cloud-id-my-cloud2") + for filename in (cloud_id_file, cloud_id_link, cloud_id2_file): + self.assertFalse( + os.path.exists(filename), "Unexpected link found {filename}" + ) + with mock.patch( + "cloudinit.sources.canonical_cloud_id", return_value="my-cloud" + ): + datasource.get_data() + self.assertEqual("my-cloud\n", util.load_file(cloud_id_link)) + # A symlink with the generic /run/cloud-init/cloud-id link is present + self.assertTrue(util.is_link(cloud_id_link)) + # When cloud-id changes, symlink and content change + with mock.patch( + "cloudinit.sources.canonical_cloud_id", return_value="my-cloud2" + ): + datasource.persist_instance_data() + self.assertEqual("my-cloud2\n", util.load_file(cloud_id2_file)) + # Previous cloud-id- file removed + self.assertFalse(os.path.exists(cloud_id_file)) + # Generic link persisted which contains canonical-cloud-id as content + self.assertTrue(util.is_link(cloud_id_link)) + self.assertEqual("my-cloud2\n", util.load_file(cloud_id_link)) + def test_persist_instance_data_writes_network_json_when_set(self): """When network_data.json class attribute is set, persist to json.""" tmp = self.tmp_dir() -- cgit v1.2.3