INTERNAL: Fix check for when custom template file is present

Author: bgreenb

common/src/stack/command/stack/commands/report/vm/__init__.py

@@ -91,13 +91,19 @@ def run(self, param, args):
 
 			template_conf = Path(template_loc)
 			env = Environment()
-			ast = env.parse(template_conf.read_text())
-			var_list = meta.find_undeclared_variables(ast)
 
-			if template_conf.is_file() and req_vars.issubset(var_list):
+			# Check if the template exists
+			# and has the required variables
+			if template_conf.is_file():
+				ast = env.parse(template_conf.read_text())
+				var_list = meta.find_undeclared_variables(ast)
+			else:
+				raise CommandError(self, f'Unable to find template file: {template_conf}')
+
+			if req_vars.issubset(var_list):
 				libvirt_template = jinja2.Template(template_conf.read_text(), lstrip_blocks=True, trim_blocks=True)
 			else:
-				raise CommandError(self, f'Unable to parse or missing variables for template file: {template_conf}')
+				raise CommandError(self, f'Missing required template variables for libvirt config file: {template_conf}')
 
 			# If the hypervisor param is set
 			# ignore any VM not belonging to the

test-framework/test-suites/integration/files/report/vm_config_bad_template.j2

@@ -0,0 +1,50 @@
+<domain type="kvm">
+	<name>{{ name }}</name>
+	<memory>{{ memory }}</memory>
+	<vcpu>{{ cpucount }}</vcpu>
+	<os>
+		<type arch="x86_64">hvm</type>
+	</os>
+	<features>
+		<acpi/>
+		<apic/>
+		{% if os == 'sles' %}
+		<vmport state="off"/>
+		{% endif %}
+	</features>
+	<clock offset="utc">
+		<timer name="rtc" tickpolicy="catchup"/>
+		<timer name="pit" tickpolicy="delay"/>
+		<timer name="hpet" present="no"/>
+	</clock>
+	<on_poweroff>destroy</on_poweroff>
+	<on_reboot>restart</on_reboot>
+	<on_crash>restart</on_crash>
+	<pm>
+		<suspend-to-mem enabled="no"/>
+		<suspend-to-disk enabled="no"/>
+	</pm>
+	<devices>
+		{% if os == 'redhat' %}
+		<emulator>/usr/libexec/qemu-kvm</emulator>
+		{% endif %}
+		{% if os == 'sles' %}
+		<emulator>/usr/bin/qemu-kvm</emulator>
+		{% endif %}
+		<serial type="pty">
+			<target port="0"/>
+		</serial>
+		<serial type="pty">
+			<target port="1"/>
+		</serial>
+		<input bus="ps2" type="mouse"/>
+		<graphics autoport="yes" keymap="en-us" type="vnc" port="-1"/>
+		<video>
+			<model heads="1" vram="9216" type="cirrus"/>
+		</video>
+		<rng model="virtio">
+			<backend model="random">/dev/random</backend>
+			<address type="pci" domain="0x0000" bus="0x00" slot="0x0c" function="0x0"/>
+		</rng>
+	</devices>
+</domain>

test-framework/test-suites/integration/tests/report/test_report_vm.py

@@ -221,6 +221,11 @@ def test_report_vm_no_kickstartable(
 		host_os,
 		test_file
 	):
+		"""
+		Test for a virtual machine with its kickstartable attribute
+		set to false, the bootorder excludes the network interfaces
+		"""
+
 		expect_output = Path(test_file(f'report/vm_config_no_kickstart_{host_os}.txt')).read_text()
 
 		conf = host.run('stack report vm vm-backend-0-3')
@@ -249,6 +254,10 @@ def test_report_vm_custom_template(
 		host_os,
 		test_file
 	):
+		"""
+		Test report vm uses the custom jinja2 template set as an attribute
+		"""
+
 		expect_output = Path(test_file(f'report/vm_config_simple_{host_os}.txt')).read_text()
 		custom_config = Path(test_file(f'report/vm_config_custom_template.j2'))
 
@@ -277,6 +286,11 @@ def test_report_vm_bad_template(
 		host_os,
 		test_file
 	):
+		"""
+		Test report vm raises an error for a template
+		missing required jinja2 variables
+		"""
+
 		custom_config = Path(test_file(f'report/vm_config_bad_template.j2'))
 
 		set_template_attr = host.run(f'stack set host attr vm-backend-0-3 attr=vm_config_location value={custom_config}')
@@ -285,3 +299,25 @@ def test_report_vm_bad_template(
 		conf = host.run('stack report vm vm-backend-0-3 bare=y')
 		assert conf.rc != 0
 
+		assert "Missing required template variables" in conf.stderr
+
+	def test_report_vm_no_template(
+		self,
+		add_hypervisor,
+		add_vm_multiple,
+		host,
+		host_os,
+		test_file
+	):
+		"""
+		Test an error is raised when the custom template file cannot be found
+		"""
+
+		set_template_attr = host.run(f'stack set host attr vm-backend-0-3 attr=vm_config_location value=/export/fake_template.j2')
+		assert set_template_attr.rc == 0
+
+		conf = host.run('stack report vm vm-backend-0-3 bare=y')
+		assert conf.rc != 0
+
+		assert "Unable to find template file" in conf.stderr
+