add test for core

Author: tarekbadrsh

cli/cdevents/cli/cdevents_command.py

@@ -12,7 +12,7 @@
 
 
 class CDeventsCommand(ABC):
-    """Abstract base class for all Hostlog commands."""
+    """Abstract base class for all CDevents commands."""
 
     def __init__(self, config_handler: ConfigurationHandler = None):
         """Initializes base class.

cli/setup.cfg

@@ -30,6 +30,7 @@ packages = find_namespace:
 zip_safe = False
 include_package_data = True
 install_requires =
+	pytest
 	click>=8.0.4
 	pyyaml>=6.0
 	click-option-group

cli/tests/__init__.py

@@ -0,0 +1 @@
+"""Tests for core package."""

cli/tests/test_utils.py

@@ -0,0 +1,99 @@
+"""Testing for module utils."""
+from datetime import datetime
+from unittest import mock
+
+import pytest
+
+from cdevents.cli.utils import DictUtils, time_stamp
+
+# pylint: disable=missing-function-docstring, protected-access, missing-class-docstring
+@pytest.mark.unit
+def test_merge_dicts_1():
+    source = {"a": 66}
+    target = {"b": 77, "c": 88}
+    expected = {"a": 66, "b": 77, "c": 88}
+    merge_and_test(source, target, expected)
+
+
+@pytest.mark.unit
+def test_merge_dicts_2():
+    source = {"a": 66}
+    target = {"a": 77}
+    expected = {"a": 77}
+    merge_and_test(source, target, expected)
+
+
+@pytest.mark.unit
+def test_merge_dicts_3():
+    source = {}
+    target = {"a": 77}
+    expected = {"a": 77}
+    merge_and_test(source, target, expected)
+
+
+@pytest.mark.unit
+def test_merge_dicts_3_1():
+    target = {}
+    source = {"a": 77}
+    expected = {"a": 77}
+    merge_and_test(source, target, expected)
+
+
+@pytest.mark.unit
+def test_merge_dicts_4():
+    source = {"a": {"aa": 11, "aaa": {"aaaa": 111}}}
+    target = {"b": {"bb": 22, "bbb": {"bbbb": 222}}}
+    expected = {
+        "a": {"aa": 11, "aaa": {"aaaa": 111}},
+        "b": {"bb": 22, "bbb": {"bbbb": 222}},
+    }
+    merge_and_test(source, target, expected)
+
+
+@pytest.mark.unit
+def test_merge_dicts_5():
+    source = {
+        "a": {"aa": 12, "aaa": {"aaaa": 222, "bbb": 333}},
+        "b": 4,
+        "c": [8, 9],
+        "d": [1],
+    }
+    target = {
+        "a": {"aa": 11, "aaa": {"aaaa": 111}},
+        "b": 5,
+        "c": [1, 2, 3],
+        "d": {"v": 1},
+    }
+    expected = {
+        "a": {"aa": 11, "aaa": {"aaaa": 111, "bbb": 333}},
+        "b": 5,
+        "c": [1, 2, 3, 8, 9],
+        "d": {"v": 1},
+    }
+    merge_and_test(source, target, expected)
+
+
+def merge_and_test(source, target, expected):
+    DictUtils.merge_dicts(source, target)
+    assert target == expected
+
+
+# FIXME: add test for times_tamep
+# VALID_TIME_STAMP_REGEX=
+EXPECTED_DATETIME = datetime(
+    year=2022,
+    month=1,
+    day=12,
+    hour=10,
+    minute=44,
+    second=23,
+)
+EXPECTED_TIMESTAMP = "20220112T104423000"
+
+
+@pytest.mark.unit
+@mock.patch("cdevents.cli.utils._utcnow")
+def test_time_stamp(mock_utcnow):
+    mock_utcnow.return_value = EXPECTED_DATETIME
+    actual = time_stamp("T")
+    assert actual == EXPECTED_TIMESTAMP

cli/tests/test_version.py

@@ -0,0 +1,16 @@
+import re
+
+import pytest
+
+from cdevents.cli import __version__
+
+# From https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+VALID_SEMVER_REGEX = (
+    r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)"
+    r"(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"
+)
+
+
+@pytest.mark.unit
+def test_version_is_semantic():
+    assert re.fullmatch(VALID_SEMVER_REGEX, __version__)

core/setup.cfg

@@ -30,6 +30,7 @@ packages = find_namespace:
 zip_safe = False
 include_package_data = True
 install_requires =
+    pytest
     PyYAML
 	requests
 	cloudevents

core/tests/__init__.py

@@ -0,0 +1 @@
+"""Tests for core package."""

core/tests/test_events.py

@@ -0,0 +1,72 @@
+
+
+from pickle import NONE
+from cdevents.core import event_type
+import pytest
+
+from cdevents.core.events import Events
+
+
+@pytest.mark.unit
+def test_create_event():
+    event = Events().create_event(event_type="event_type", extensions={"test": "test"})
+    assert event is not None
+    assert event._attributes["type"] == "event_type"
+    assert event._attributes["extensions"] == {"test": "test"}
+
+@pytest.mark.unit
+def test_create_artifact_event():
+    event = Events().create_artifact_event(event_type.ArtifactPackagedEventV1, id="_id", name="_name", version="_version", data={"artifact": "_artifact"})
+    assert event is not None
+    assert event._attributes["type"] == event_type.ArtifactPackagedEventV1
+    assert event._attributes["extensions"] == {"artifactid": "_id", "artifactname": "_name", "artifactversion": "_version"}
+    assert event.data == {"artifact": "_artifact"}
+
+@pytest.mark.unit
+def test_create_branch_event():
+    event = Events().create_branch_event(event_type.BranchCreatedEventV1, id="_id", name="_name", repoid="_repoid", data={"branch": "_branch"})
+    assert event is not None
+    assert event._attributes["type"] == event_type.BranchCreatedEventV1
+    assert event._attributes["extensions"] == {"branchid": "_id", "branchname": "_name", "branchrepositoryid": "_repoid"}
+    assert event.data == {"branch": "_branch"}
+
+@pytest.mark.unit
+def test_create_build_event():
+    event = Events().create_build_event(event_type.BuildFinishedEventV1, id="_id", name="_name", artifact="_artifact", data={"build": "_build"})
+    assert event is not None
+    assert event._attributes["type"] == event_type.BuildFinishedEventV1
+    assert event._attributes["extensions"] == {"buildid": "_id", "buildname": "_name", "buildartifactid": "_artifact"}
+    assert event.data == {"build": "_build"}
+
+@pytest.mark.unit
+def test_create_environment_event():
+    event = Events().create_environment_event(event_type.EnvironmentCreatedEventV1, id="_id", name="_name", repo="_repo", data={"environment": "_environment"})
+    assert event is not None
+    assert event._attributes["type"] == event_type.EnvironmentCreatedEventV1
+    assert event._attributes["extensions"] == {"envId": "_id", "envname": "_name", "envrepourl": "_repo"}
+    assert event.data == {"environment": "_environment"} 
+
+@pytest.mark.unit
+def test_create_pipelinerun_event():
+    event = Events().create_pipelinerun_event(event_type.PipelineRunFinishedEventV1, id="_id", name="_name", status="_status", url="_url", errors="_errors", data={"pipelinerun": "_pipelinerun"})
+    assert event is not None
+    assert event._attributes["type"] == event_type.PipelineRunFinishedEventV1
+    assert event._attributes["extensions"] ==  {"pipelinerunid": "_id", "pipelinerunname": "_name", "pipelinerunstatus": "_status", "pipelinerunurl": "_url", "pipelinerunerrors": "_errors"}
+    assert event.data == {"pipelinerun": "_pipelinerun"}
+
+@pytest.mark.unit
+def test_create_service_event():
+    event = Events().create_service_event(event_type.ServiceDeployedEventV1, envid="_envid", name="_name", version="_version", data={"service": "_service"})
+    assert event is not None
+    assert event._attributes["type"] == event_type.ServiceDeployedEventV1
+    assert event._attributes["extensions"] == {"serviceenvid": "_envid", "servicename": "_name", "serviceversion": "_version"}
+    assert event.data == {"service": "_service"}
+
+
+@pytest.mark.unit
+def test_create_taskrun_event():
+    event = Events().create_taskrun_event(event_type.TaskRunFinishedEventV1, id="_id", name="_name", pipelineid="_pipelineid", data={"taskrun": "_taskrun"})
+    assert event is not None
+    assert event._attributes["type"] == event_type.TaskRunFinishedEventV1
+    assert event._attributes["extensions"] == {"taskrunid": "_id", "taskrunname": "_name", "taskrunpipelineid": "_pipelineid"}
+    assert event.data == {"taskrun": "_taskrun"}

core/tests/test_version.py

@@ -0,0 +1,16 @@
+import re
+
+import pytest
+
+from cdevents.core import __version__
+
+# From https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+VALID_SEMVER_REGEX = (
+    r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)"
+    r"(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"
+)
+
+
+@pytest.mark.unit
+def test_version_is_semantic():
+    assert re.fullmatch(VALID_SEMVER_REGEX, __version__)

pytest.ini

@@ -0,0 +1,7 @@
+[pytest]
+testpaths =
+    cli/tests
+    core/tests
+markers =
+    unit: mark for unit tests
+    integration: integration tests