#271: Implemented checking SCS content for completeness and correctness

doc/changes/unreleased.md

@@ -12,6 +12,7 @@ Additionally the release includes a CLI for populating the Secure Configuration
 * #263: Added functions for handling a set of options for SCS CLI
 * #267: Implemented modify operations for the SCS
 * #269: Implemented showing SCS content
+* #271: Implemented checking SCS content
 
 ## Refactorings
 

exasol/nb_connector/cli/commands/check.py

@@ -6,6 +6,7 @@
 from exasol.nb_connector.cli.groups import cli
 from exasol.nb_connector.cli.options import SCS_OPTIONS
 from exasol.nb_connector.cli.param_wrappers import add_params
+from exasol.nb_connector.cli.processing import processing
 
 
 @cli.command()
@@ -24,4 +25,5 @@ def check(scs_file: Path, connect: bool):
     Optionally also verify if a connection to the configured Exasol database
     instance is successful.
     """
-    pass
+    result = processing.check_scs(scs_file, connect)
+    sys.exit(result)

exasol/nb_connector/cli/processing/processing.py

@@ -23,6 +23,9 @@
     get_option_set,
     get_scs,
 )
+from exasol.nb_connector.connections import open_pyexasol_connection
+from exasol.nb_connector.itde_manager import bring_itde_up
+from exasol.nb_connector.secret_store import Secrets
 
 LOG = logging.getLogger(__name__)
 
@@ -63,6 +66,35 @@ def save(
     return 0
 
 
+def verify_connection(scs: Secrets) -> int:
+    if BackendSelector(scs).use_itde:
+        # Question: Is it OK, to let bring_itde_up modify the SCS content, here?
+        False and bring_itde_up(scs)
+        report.warning(f"Bring up ITDE currently disabled")
+        return 1
+    try:
+        open_pyexasol_connection(scs).execute("SELECT 1 FROM DUAL").fetchone()
+    except Exception as ex:
+        report.error(f"Failed to connect to the configured database {ex}")
+        return 1
+    report.success("Connection to the configured database instance was successful.")
+    return 0
+
+
+def check_scs(scs_file: Path, connect: bool) -> int:
+    """
+    Check the SCS content for completeness.  Infer the required keys from
+    backend and use_itde if these are contained in the SCS already.
+
+    If parameter `connect` is True then also verify if a connection to the
+    configured Exasol database instance is successful.
+    """
+    options = get_option_set(scs_file)
+    if not options or not options.check():
+        return 1
+    return 0 if not connect else verify_connection(options.scs)
+
+
 def show_scs_content(scs_file: Path) -> int:
     """
     If the SCS contains a proper backend selection, then show the SCS

test/unit/cli/test_cli.py

@@ -1,6 +1,11 @@
+import getpass
 import itertools
+from typing import Iterator
 import os
 from inspect import cleandoc
+from pathlib import Path
+from test.utils.integration_test_utils import sample_db_file
+from unittest.mock import Mock
 
 import click
 import pytest
@@ -16,9 +21,15 @@ def assert_error(result: click.testing.Result, message: str):
     assert message in result.output
 
 
+def assert_success(result: click.testing.Result, message: str):
+    assert result.exit_code == 0
+    assert message in result.output
+
+
 @pytest.mark.parametrize(
     "args",
     [
+        (commands.check, []),
         (commands.configure, ["onprem"]),
         (commands.configure, ["saas"]),
         (commands.configure, ["docker-db"]),
@@ -30,6 +41,20 @@ def test_missing_scs_file(args):
     assert_error(result, "Error: Missing argument 'SCS_FILE'")
 
 
+@pytest.fixture
+def scs_file() -> Iterator[Path]:
+    with sample_db_file() as scs_file:
+        yield scs_file
+
+
+def test_check_ask_for_master_password(monkeypatch, scs_file):
+    mock = Mock(return_value="interactive password")
+    monkeypatch.setattr(getpass, "getpass", mock)
+    result = CliRunner().invoke(commands.check, [str(scs_file)])
+    assert mock.called
+    assert_error(result, f"{scs_file} does not contain any backend")
+
+
 @pytest.fixture
 def scs_with_env(secrets, monkeypatch) -> Secrets:
     """
@@ -137,5 +162,7 @@ def cmd_args():
         monkeypatch.setitem(os.environ, env_var, f"secret {i+1}")
     result = CliRunner().invoke(commands.configure, cmd_args())
     assert result.exit_code == 0
+    result = CliRunner().invoke(commands.check, [scs_file])
+    assert_success(result, f"Configuration is complete")
     result = CliRunner().invoke(commands.show, [scs_file])
     assert cleandoc(expected_show) in result.output