Improved installation failure with actionable message (#840)

Author: prajin-29

src/databricks/labs/ucx/install.py

@@ -216,9 +216,22 @@ def _run_configured(self):
         logger.info(msg)
 
     def _create_database(self):
-        if self._sql_backend is None:
-            self._sql_backend = StatementExecutionBackend(self._ws, self.current_config.warehouse_id)
-        deploy_schema(self._sql_backend, self.current_config.inventory_database)
+        try:
+            if self._sql_backend is None:
+                self._sql_backend = StatementExecutionBackend(self._ws, self.current_config.warehouse_id)
+            deploy_schema(self._sql_backend, self.current_config.inventory_database)
+        except BadRequest as err:
+            if "UNRESOLVED_COLUMN.WITH_SUGGESTION" in str(err):
+                msg = (
+                    "The UCX version is not matching with the installed version."
+                    "Kindly uninstall and reinstall UCX.\n"
+                    "Please Follow the Below Command to uninstall and Install UCX\n"
+                    "UCX Uninstall: databricks labs uninstall ucx.\n"
+                    "UCX Install: databricks labs install ucx"
+                )
+                raise BadRequest(msg) from err
+            msg = f"The UCX Installation Failed while creating database with the error: {err}"
+            raise BadRequest(msg) from err
 
     def _install_spark_config_for_hms_lineage(self):
         hms_lineage = HiveMetastoreLineageEnabler(ws=self._ws)

tests/unit/test_install.py

@@ -11,6 +11,7 @@
 from databricks.labs.blueprint.tui import MockPrompts
 from databricks.labs.blueprint.wheels import Wheels, find_project_root
 from databricks.sdk.errors import (
+    BadRequest,
     InvalidParameterValue,
     NotFound,
     OperationFailed,
@@ -1200,3 +1201,51 @@ def test_repair_run_result_state(ws, caplog):
     ws.jobs.list_runs.repair_run = None
     install.repair_run("assessment")
     assert "Please try after sometime" in caplog.text
+
+
+def test_create_database(ws, mocker, caplog):
+    install = WorkspaceInstaller(
+        ws,
+        sql_backend=None,
+        promtps=MockPrompts(
+            {
+                r".*PRO or SERVERLESS SQL warehouse.*": "1",
+                r".*": "",
+            }
+        ),
+    )
+    mocker.patch(
+        "databricks.labs.ucx.install.deploy_schema",
+        side_effect=BadRequest(
+            "[UNRESOLVED_COLUMN.WITH_SUGGESTION] A column, variable, or "
+            "function parameter with name `udf` cannot be resolved"
+        ),
+    )
+    mocker.patch("databricks.labs.ucx.framework.crawlers.SqlBackend.execute", return_value=None)
+    config_bytes = yaml.dump(WorkspaceConfig(inventory_database="testdb", warehouse_id="123").as_dict()).encode("utf8")
+    ws.workspace.download = lambda _: io.BytesIO(config_bytes)
+    with pytest.raises(BadRequest) as failure:
+        install._create_database()
+
+    assert "Kindly uninstall and reinstall UCX" in str(failure.value)
+
+
+def test_create_database_diff_error(ws, mocker, caplog):
+    install = WorkspaceInstaller(
+        ws,
+        sql_backend=MockBackend(),
+        promtps=MockPrompts(
+            {
+                r".*PRO or SERVERLESS SQL warehouse.*": "1",
+                r".*": "",
+            }
+        ),
+    )
+    mocker.patch("databricks.labs.ucx.install.deploy_schema", side_effect=BadRequest("Unknown Error"))
+    mocker.patch("databricks.labs.ucx.framework.crawlers.SqlBackend.execute", return_value=None)
+    config_bytes = yaml.dump(WorkspaceConfig(inventory_database="testdb", warehouse_id="123").as_dict()).encode("utf8")
+    ws.workspace.download = lambda _: io.BytesIO(config_bytes)
+    with pytest.raises(BadRequest) as failure:
+        install._create_database()
+
+    assert "The UCX Installation Failed" in str(failure.value)