add first cli tests

Author: tarekbadrsh

cli/cdevents/cli/configuration_handler.py

@@ -8,13 +8,13 @@
 from typing import Union
 
 from cdevents.cli.configuration_reader import ConfigurationReader
-from cdevents.cli.constants import DEAFULT_CONFIGURATION_FILE
+from cdevents.cli.constants import DEFAULT_CONFIGURATION_FILE
 from cdevents.cli.utils import DictUtils
 
 
 def get_default_configuration_file() -> str:
     """Returns the default configuration file path."""
-    return DEAFULT_CONFIGURATION_FILE
+    return DEFAULT_CONFIGURATION_FILE
 
 def new_default_configuration_handler() -> ConfigurationHandler:
     """Returnes a configuration handler with the default configuration file"""

cli/cdevents/cli/constants.py

@@ -3,7 +3,7 @@
 
 # configuration/configuration.yaml
 _CLI_CDEVENTS_DIR = Path(__file__).parent.parent
-DEAFULT_CONFIGURATION_FILE = str(Path(_CLI_CDEVENTS_DIR, "configuration", "configuration.yaml"))
+DEFAULT_CONFIGURATION_FILE = str(Path(_CLI_CDEVENTS_DIR, "configuration", "configuration.yaml"))
 LOGGING_CONFIGURATION_FILE = str(
     Path(_CLI_CDEVENTS_DIR, "configuration", "logging-configuration.yaml")
 )

cli/tests/configuration_test.yaml

@@ -0,0 +1,8 @@
+# N.B. The file is used for testing the configuration handler.
+# The content should reflect the content of the default configuration file cli/configuration/configuration.yaml
+---
+configuration:
+  source:
+    name: cde-cli
+  client:
+    host: http://localhost:8080

cli/tests/test_configuration_handler.py

@@ -0,0 +1,49 @@
+"""Module for tests related to configuration_handler."""
+import os
+from pathlib import Path
+
+import pytest
+
+from cdevents.cli.configuration_handler import ConfigurationHandler
+
+# pylint: disable=missing-function-docstring, protected-access, missing-class-docstring
+THIS_DIR: Path = Path(__file__).parent
+TEST_CONFIG_FILE: str = Path(THIS_DIR, "configuration_test.yaml").as_posix()
+
+
+@pytest.mark.unit
+def test_create_config_handler():
+
+    handler = ConfigurationHandler.create_new(TEST_CONFIG_FILE)
+    assert isinstance(handler, ConfigurationHandler)
+
+    assert handler.source.name == "cde-cli"
+    assert handler.client.host == "http://localhost:8080"
+
+
+@pytest.mark.unit
+def test_create_config_handler_with_override():
+
+    expected_source_name = "MySourceName"
+    expected_client_host = "http://myhost:5000"
+    override_config = {
+        "source": {
+            "name": expected_source_name,
+        },
+        "client": {
+            "host": expected_client_host,
+        },
+    }
+    handler = ConfigurationHandler.create_new(TEST_CONFIG_FILE, override_config=override_config)
+    assert isinstance(handler, ConfigurationHandler)
+
+    assert handler.source.name == expected_source_name
+    assert handler.client.host == expected_client_host
+
+
+@pytest.mark.unit
+def test_create_empty_override_dict():
+
+    expected = {}
+    actual = ConfigurationHandler.create_override_config()
+    assert expected == actual

cli/tests/test_configuration_reader.py

@@ -0,0 +1,99 @@
+"""Module testing ConfigurationReader"""
+import json
+import unittest
+from pathlib import Path
+from unittest.mock import patch
+
+import pytest
+import yaml
+
+from cdevents.cli.configuration_reader import ConfigurationReader
+
+# pylint: disable=missing-function-docstring, protected-access, missing-class-docstring
+TEST_DIR = Path(__file__).parent
+CONFIG_DIR: Path = Path(TEST_DIR, "configurations")
+
+YAML_CONFIG_1 = """---
+configuration:
+  source:
+    name: cde-cli
+  client:
+    host: http://localhost:8080
+"""
+DICT_CONFIG_1 = yaml.safe_load(YAML_CONFIG_1)
+
+JSON_CONFIG_1 = json.dumps(DICT_CONFIG_1)
+YAML_CONFIG_2 = """---
+configuration:
+  source:
+    name: mysource
+  client:
+    host: http://myhost:5000
+"""
+DICT_CONFIG_2 = {
+    "configuration": {
+        "source": {"name": "mysource"},
+        "client": {"host": "http://myhost:5000"},
+    },
+}
+
+DUMMY_PATH = "my/dummy/path/dummy.yaml"
+
+
+class TestConfigurationReader(unittest.TestCase):
+    # pylint: disable=unused-argument
+    def setUp(self) -> None:
+        self.reader = ConfigurationReader()
+
+    @pytest.mark.unit
+    @patch.object(Path, "exists", return_value=False)
+    def test_read_configuration_with_invalid_file_path_then_exception(self, mocked_exists):
+        with self.assertRaises(FileNotFoundError):
+            self.reader.read_configuration(Path(DUMMY_PATH))
+
+    @pytest.mark.unit
+    @patch.object(Path, "read_text", return_value=YAML_CONFIG_1)
+    @patch.object(Path, "exists", return_value=True)
+    def test_read_configuration_with_valid_yaml_file(self, mocked_exists, mocked_read_text):
+        self.reader.read_configuration(Path(DUMMY_PATH))
+        actual = self.reader.configuration
+        self.assertDictEqual(actual, DICT_CONFIG_1)
+
+    @pytest.mark.unit
+    @patch.object(Path, "read_text", return_value=JSON_CONFIG_1)
+    @patch.object(Path, "exists", return_value=True)
+    def test_read_configuration_with_valid_json_file(self, mocked_exists, mocked_read_text):
+        self.reader.read_configuration(Path("path/to/my/config.json"))
+        actual = self.reader.configuration
+        self.assertDictEqual(actual, DICT_CONFIG_1)
+
+    @pytest.mark.unit
+    @patch.object(Path, "exists", return_value=True)
+    def test_read_configuration_with_invalid_filetype_then_value_error(
+        self,
+        mocked_exists,
+    ):
+        with self.assertRaises(ValueError):
+            self.reader.read_configuration(Path("path/to/my/invalid_config.jsonX"))
+
+    @pytest.mark.unit
+    @patch.object(Path, "read_text", side_effect=[YAML_CONFIG_1, YAML_CONFIG_2])
+    @patch.object(Path, "exists", return_value=True)
+    def test_read_configuration_with_2_configs(self, mocked_exists, mocked_read_text):
+        """Second configuration overwrites previous."""
+        self.reader.read_configuration(Path(DUMMY_PATH))
+        actual = self.reader.configuration
+        self.assertDictEqual(actual, DICT_CONFIG_1)
+        self.reader.read_configuration(Path("dummy_config2.yml"))
+        actual_2 = self.reader.configuration
+        self.assertDictEqual(actual_2, DICT_CONFIG_2)
+
+    @pytest.mark.unit
+    def test_is_supported_suffix_with_valid_suffix(self):
+        self.assertTrue(ConfigurationReader._is_supported_json_suffix(Path("valid_suffix.json")))
+        self.assertTrue(ConfigurationReader._is_supported_yaml_suffix(Path("valid_suffix.yml")))
+        self.assertTrue(ConfigurationReader._is_supported_yaml_suffix(Path("valid_suffix.yAMl")))
+
+    @pytest.mark.unit
+    def test_is_supported_suffix_with_invalid_suffix(self):
+        self.assertFalse(ConfigurationReader._is_supported_yaml_suffix(Path("valid_suffix.berra")))

cli/tests/test_constants.py

@@ -0,0 +1,17 @@
+"""Tests for constants."""
+from pathlib import Path
+
+import pytest
+
+from cdevents.cli.constants import DEFAULT_CONFIGURATION_FILE, LOGGING_CONFIGURATION_FILE
+
+# pylint: disable=missing-function-docstring, missing-class-docstring
+
+@pytest.mark.unit
+def test_default_config_exist():
+    assert Path(DEFAULT_CONFIGURATION_FILE).exists()
+
+
+@pytest.mark.unit
+def test_logging_config_file_exist():
+    assert Path(LOGGING_CONFIGURATION_FILE).exists()

cli/tests/test_main.py

@@ -0,0 +1,15 @@
+import pytest
+from click.testing import CliRunner
+
+from cdevents.cli.__main__ import cli
+
+@pytest.fixture
+def runner() -> CliRunner:
+    return CliRunner()
+
+
+@pytest.mark.unit
+def test_cli_main(runner: CliRunner):
+
+    result = runner.invoke(cli, ["--help"])
+    assert result.exit_code == 0