add build and env obj

Author: tarekbadrsh

cli/cdevents/cli/build.py

@@ -9,8 +9,7 @@
 from cdevents.cli.utils import add_disclaimer_text, print_function_args
 from cdevents.cli.cdevents_command import CDeventsCommand
 
-from cdevents.core.events import Events
-from cdevents.core import event_type
+from cdevents.core.build import Build, BuildType
 
 # pylint: disable=unused-argument
 def common_build_options(function):
@@ -58,10 +57,10 @@ def started(
     data: List[str] = None,
 ):
     print_function_args()
-    e = Events()
-    new_event = e.create_build_event(event_type.BuildStartedEventV1, id, name, artifact, data)
+    build = Build(build_type=BuildType.BuildStartedEventV1, id=id, name=name, artifact=artifact)
+    build_event = build.create_event(data)
     cdevents_command = CDeventsCommand()
-    cdevents_command.run(new_event)
+    cdevents_command.run(build_event)
 
 @click.command(help=add_disclaimer_text("Build Finished CloudEvent."))
 @common_build_options
@@ -72,10 +71,10 @@ def finished(
     data: List[str] = None,
 ):
     print_function_args()
-    e = Events()
-    new_event = e.create_build_event(event_type.BuildFinishedEventV1, id, name, artifact, data)
+    build = Build(build_type=BuildType.BuildFinishedEventV1, id=id, name=name, artifact=artifact)
+    build_event = build.create_event(data)
     cdevents_command = CDeventsCommand()
-    cdevents_command.run(new_event)
+    cdevents_command.run(build_event)
 
 @click.command(help=add_disclaimer_text("PipelineRun Queued CloudEvent."))
 @common_build_options
@@ -86,7 +85,7 @@ def queued(
     data: List[str] = None,
 ):
     print_function_args()
-    e = Events()
-    new_event = e.create_build_event(event_type.BuildQueuedEventV1, id, name, artifact, data)
+    build = Build(build_type=BuildType.BuildQueuedEventV1, id=id, name=name, artifact=artifact)
+    build_event = build.create_event(data)
     cdevents_command = CDeventsCommand()
-    cdevents_command.run(new_event)
+    cdevents_command.run(build_event)

cli/cdevents/cli/env.py

@@ -9,8 +9,7 @@
 from cdevents.cli.utils import add_disclaimer_text, print_function_args
 from cdevents.cli.cdevents_command import CDeventsCommand
 
-from cdevents.core.events import Events
-from cdevents.core import event_type
+from cdevents.core.env import Env, EnvType
 
 # pylint: disable=unused-argument
 def common_env_options(function):
@@ -57,10 +56,10 @@ def created(
     data: List[str] = None,
 ):
     print_function_args()
-    e = Events()
-    new_event = e.create_environment_event(event_type.EnvironmentCreatedEventV1, id, name, repo, data)
+    env = Env(build_type=EnvType.EnvironmentCreatedEventV1, id=id, name=name, repo=repo)
+    env_event = env.create_event(data)
     cdevents_command = CDeventsCommand()
-    cdevents_command.run(new_event)
+    cdevents_command.run(env_event)
 
 
 @click.command(help=add_disclaimer_text("Environment Deleted CloudEvent."))
@@ -72,10 +71,10 @@ def deleted(
     data: List[str] = None,
 ):
     print_function_args()
-    e = Events()
-    new_event = e.create_environment_event(event_type.EnvironmentDeletedEventV1, id, name, repo, data)
+    env = Env(env_type=EnvType.EnvironmentDeletedEventV1, id=id, name=name, repo=repo)
+    env_event = env.create_event(data)
     cdevents_command = CDeventsCommand()
-    cdevents_command.run(new_event)
+    cdevents_command.run(env_event)
 
 @click.command(help=add_disclaimer_text("Environment Modified CloudEvent."))
 @common_env_options
@@ -86,7 +85,7 @@ def modified(
     data: List[str] = None,
 ):
     print_function_args()
-    e = Events()
-    new_event = e.create_environment_event(event_type.EnvironmentModifiedEventV1, id, name, repo, data)
+    env = Env(env_type=EnvType.EnvironmentModifiedEventV1, id=id, name=name, repo=repo)
+    env_event = env.create_event(data)
     cdevents_command = CDeventsCommand()
-    cdevents_command.run(new_event)
+    cdevents_command.run(env_event)

core/cdevents/core/artifact.py

@@ -9,7 +9,7 @@ class ArtifactType(Enum):
 
 
 class Artifact(Events):
-    """Events."""
+    """Artifact."""
 
     def __init__(self, artifact_type: ArtifactType, id: str, name: str, version: str):
         """Initializes class.

core/cdevents/core/branch.py

@@ -9,7 +9,7 @@ class BranchType(Enum):
 
 
 class Branch(Events):
-    """Events."""
+    """Brach."""
 
     def __init__(self, branch_type: BranchType, id: str, name: str, repoid: str):
         """Initializes class.

core/cdevents/core/build.py

@@ -0,0 +1,38 @@
+"""build"""
+
+from enum import Enum
+from cdevents.core.events import Events
+
+class BuildType(Enum):
+    BuildStartedEventV1  :str = "cd.build.started.v1"
+    BuildQueuedEventV1   :str = "cd.build.queued.v1"
+    BuildFinishedEventV1 :str = "cd.build.finished.v1"
+
+
+class Build(Events):
+    """build."""
+
+    def __init__(self, build_type: BuildType, id: str, name: str, artifact: str):
+        """Initializes class.
+        """
+        self._event_type = build_type
+        self._id = id
+        self._name = name
+        self._artifact = artifact
+    
+    def create_extensions(self):
+        """Create extensions.
+        """
+        extensions = {
+            "buildid": self._id,
+            "buildname": self._name,
+            "buildartifactid": self._artifact,
+        }
+        return extensions
+    
+    def create_event(self, data: dict={}):
+        """Create build event.
+        """
+        extensions = self.create_extensions()
+        event = super().create_event(event_type=self._event_type.value, extensions=extensions, data=data)
+        return event

core/cdevents/core/env.py

@@ -0,0 +1,38 @@
+"""env"""
+
+from enum import Enum
+from cdevents.core.events import Events
+
+class EnvType(Enum):
+    EnvironmentCreatedEventV1  :str = "cd.environment.created.v1"
+    EnvironmentModifiedEventV1 :str = "cd.environment.modified.v1"
+    EnvironmentDeletedEventV1  :str = "cd.environment.deleted.v1"
+
+
+class Env(Events):
+    """Env."""
+
+    def __init__(self, env_type: EnvType, id: str, name: str, repo: str):
+        """Initializes class.
+        """
+        self._event_type = env_type
+        self._id = id
+        self._name = name
+        self._repo = repo
+    
+    def create_extensions(self):
+        """Create extensions.
+        """
+        extensions = {
+            "envId": self._id,
+            "envname": self._name,
+            "envrepourl": self._repo,
+        }
+        return extensions
+    
+    def create_event(self, data: dict={}):
+        """Create env event.
+        """
+        extensions = self.create_extensions()
+        event = super().create_event(event_type=self._event_type.value, extensions=extensions, data=data)
+        return event

core/cdevents/core/event_type.py

@@ -2,31 +2,13 @@
 
 # pylint: TODO: 
 
-# # Artifact Events
-# ArtifactPackagedEventV1  :str = "cd.artifact.packaged.v1"
-# ArtifactPublishedEventV1 :str = "cd.artifact.published.v1"
-
-# Branch Events
-BranchCreatedEventV1 :str = "cd.repository.branch.created.v1"
-BranchDeletedEventV1 :str = "cd.repository.branch.deleted.v1"
-
-# Build Events
-BuildStartedEventV1  :str = "cd.build.started.v1"
-BuildQueuedEventV1   :str = "cd.build.queued.v1"
-BuildFinishedEventV1 :str = "cd.build.finished.v1"
-
 # Change Events
 ChangeCreatedEventV1   :str = "cd.repository.change.created.v1"
 ChangeUpdatedEventV1   :str = "cd.repository.change.updated.v1"
 ChangeReviewedEventV1  :str = "cd.repository.change.reviewed.v1"
 ChangeMergedEventV1    :str = "cd.repository.change.merged.v1"
 ChangeAbandonedEventV1 :str = "cd.repository.change.abandoned.v1"
 
-# Environment Events
-EnvironmentCreatedEventV1  :str = "cd.environment.created.v1"
-EnvironmentModifiedEventV1 :str = "cd.environment.modified.v1"
-EnvironmentDeletedEventV1  :str = "cd.environment.deleted.v1"
-
 # PipelineRun events
 PipelineRunStartedEventV1  :str = "cd.pipelinerun.started.v1"
 PipelineRunFinishedEventV1 :str = "cd.pipelinerun.finished.v1"

core/cdevents/core/events.py

@@ -22,46 +22,6 @@ def create_event(self, event_type: str, extensions:dict, data = {}) -> CloudEven
 
         return event
 
-    # def create_branch_event(self, event_type: str , id: str, name: str, repoid: str, data = {}) -> CloudEvent:
-    #     """Create branch event.
-    #     """
-        
-    #     extensions = {
-    #         "branchid": id,
-    #         "branchname": name,
-    #         "branchrepositoryid": repoid,
-    #     }
-    #     event = self.create_event(event_type, extensions, data)
-
-    #     return event
-
-
-    def create_build_event(self, event_type: str , id: str, name: str, artifact: str, data = {}) -> CloudEvent:
-        """Create build event.
-        """
-        
-        extensions = {
-            "buildid": id,
-            "buildname": name,
-            "buildartifactid": artifact,
-        }
-        event = self.create_event(event_type, extensions, data)
-
-        return event
-
-    def create_environment_event(self, event_type: str , id: str, name: str, repo: str, data = {}) -> CloudEvent:
-        """Create environment event.
-        """
-            
-        extensions = {
-            "envId": id,
-            "envname": name,
-            "envrepourl": repo,
-        }
-        event = self.create_event(event_type, extensions, data)
-
-        return event
-
     def create_pipelinerun_event(self, event_type: str , id: str, name: str, status: str, url: str, errors: str, data = {}) -> CloudEvent:
         """Create pipelinerun event.
         """

core/tests/test_artifact.py

@@ -7,7 +7,7 @@ def test_artifact_packaged_v1():
     artifact = Artifact(artifact_type=ArtifactType.ArtifactPackagedEventV1, id="_id", name="_name", version="_version")
     artifact_event = artifact.create_event(data={"key1": "value1"})
     assert artifact_event is not None
-    assert artifact_event._attributes["type"] == "cd.artifact.packaged.v1"
+    assert artifact_event._attributes["type"] == ArtifactType.ArtifactPackagedEventV1.value
     assert artifact_event._attributes["extensions"] == {"artifactid": "_id", "artifactname": "_name", "artifactversion": "_version"}
     assert artifact_event.data == {"key1": "value1"}
 
@@ -16,7 +16,7 @@ def test_artifact_published_v1():
     artifact = Artifact(artifact_type=ArtifactType.ArtifactPublishedEventV1, id="_id", name="_name", version="_version")
     artifact_event = artifact.create_event(data={"key1": "value1"})
     assert artifact_event is not None
-    assert artifact_event._attributes["type"] == "cd.artifact.published.v1"
+    assert artifact_event._attributes["type"] ==ArtifactType.ArtifactPublishedEventV1.value
     assert artifact_event._attributes["extensions"] == {"artifactid": "_id", "artifactname": "_name", "artifactversion": "_version"}
     assert artifact_event.data == {"key1": "value1"}
 

core/tests/test_branch.py

@@ -7,7 +7,7 @@ def test_repository_branch_created():
     branch = Branch(branch_type=BranchType.BranchCreatedEventV1, id="_id", name="_name", repoid="_repoid")
     branch_event = branch.create_event(data={"key1": "value1"})
     assert branch_event is not None
-    assert branch_event._attributes["type"] == "cd.repository.branch.created.v1"
+    assert branch_event._attributes["type"] == BranchType.BranchCreatedEventV1.value
     assert branch_event._attributes["extensions"] == {"branchid": "_id", "branchname": "_name", "branchrepositoryid": "_repoid"}
     assert branch_event.data == {"key1": "value1"}
 
@@ -16,6 +16,6 @@ def test_repository_branch_deleted():
     branch = Branch(branch_type=BranchType.BranchDeletedEventV1, id="_id", name="_name", repoid="_repoid")
     branch_event = branch.create_event(data={"key1": "value1"})
     assert branch_event is not None
-    assert branch_event._attributes["type"] == "cd.repository.branch.deleted.v1"
+    assert branch_event._attributes["type"] == BranchType.BranchDeletedEventV1.value
     assert branch_event._attributes["extensions"] == {"branchid": "_id", "branchname": "_name", "branchrepositoryid": "_repoid"}
     assert branch_event.data == {"key1": "value1"}