azure/errors: add host reporting for dhcp errors (#2167)

- Add host_only flag to _report_failure() to allow caller to only
  report the failure to host.  This is for cases where we don't want
  _report_failure() to attempt DHCP or we expect that we may recover
  from the reported error (there is no issue reporting multiple times
  to host, whereas fabric reports will immediately fail the VM
  provisioning).

- Add ReportableErrorDhcpLease() to report lease failures.

- Add ReportableErrorDhcpInterfaceNotFound() to report errors where the
  DHCP interface hasn't been found yet.

- Add TestReportFailure class with new test coverage.  Will migrate other
  _report_failure() tests in the future as they currently depend on
  TestAzureDataSource/CiTestCase.

Future work will add the interface name to supporting data, but as that
information is not available with iface=None, another PR will explicitly
add a call to net.find_fallback_nic() to specify it.

Signed-off-by: Chris Patterson <cpatterson@microsoft.com>

1 files changed, 15 insertions, 0 deletions

diff --git a/cloudinit/sources/azure/errors.py b/cloudinit/sources/azure/errors.py
index 5c4ad7db..ca902a03 100644
--- a/cloudinit/sources/azure/errors.py
+++ b/cloudinit/sources/azure/errors.py
@@ -84,6 +84,21 @@ class ReportableError(Exception):
         return self.as_encoded_report()
 
 
+class ReportableErrorDhcpInterfaceNotFound(ReportableError):
+    def __init__(self, duration: float) -> None:
+        super().__init__("failure to find DHCP interface")
+
+        self.supporting_data["duration"] = duration
+
+
+class ReportableErrorDhcpLease(ReportableError):
+    def __init__(self, duration: float, interface: Optional[str]) -> None:
+        super().__init__("failure to obtain DHCP lease")
+
+        self.supporting_data["duration"] = duration
+        self.supporting_data["interface"] = interface
+
+
 class ReportableErrorUnhandledException(ReportableError):
     def __init__(self, exception: Exception) -> None:
         super().__init__("unhandled exception")