Change webhook to eventstream (#1011)

Author: mkanoor

.gitleaks.toml

@@ -5,5 +5,5 @@ description = "Global Allowlist"
 paths = [
         '''tests\/unit\/data''', 
         '''tools\/docker\/redis-tls''',
-        '''tests\/integration\/api\/test_webhook.py'''
+        '''tests\/integration\/api\/test_event_stream_ecdsa.py'''
 ]

sonar-project.properties

@@ -0,0 +1,34 @@
+# Complete documentation with many more options at:
+# https://docs.sonarqube.org/latest/analysis/analysis-parameters/
+
+## The unique project identifier. This is mandatory.
+# Do not duplicate or reuse!
+# Available characters: [a-zA-Z0-9_:\.\-]
+# Must have least one non-digit.
+# Recommended format: <group>:<project>
+sonar.projectKey=ansible_eda-server
+
+sonar.organization=ansible
+
+# Customize what paths to scan. Default is .
+sonar.sources=.
+
+# Verbose name of project displayed in WUI. Default is set to the projectKey. This field is optional.
+sonar.projectName=eda-server
+
+# Version of project. This field is optional.
+#sonar.projectVersion=1.0
+
+# Tell sonar scanner where coverage files exist
+#sonar.python.coverage.reportPaths=coverage.xml
+
+sonar.issue.ignore.multicriteria=e1
+# Ignore "should be a variable"
+#sonar.issue.ignore.multicriteria.e1.ruleKey=python:S1192
+sonar.issue.ignore.multicriteria.e1.resourceKey=**/migrations/**/*
+
+# Only scan with python3
+sonar.python.version=3.9,3.10,3.11
+
+# Ignore code dupe for the migrations
+sonar.cpd.exclusions=**/migrations/*.py

src/aap_eda/api/constants.py

@@ -14,36 +14,4 @@
 
 # EDA_SERVER_VAULT_LABEL is reserved for system vault password identifiers
 EDA_SERVER_VAULT_LABEL = "EDA_SERVER"
-
-PG_NOTIFY_TEMPLATE_RULEBOOK_NAME = "_PG_NOTIFY_TEMPLATE_RULEBOOK_"
-PG_NOTIFY_TEMPLATE_RULEBOOK_DATA = """
----
-- name: PG Notify Template Event Stream
-  hosts: all
-  sources:
-    - name: my_range
-      ansible.eda.range:
-        limit: 5
-      complementary_source:
-        type: ansible.eda.pg_listener
-        name: Postgres Listener
-        args:
-          dsn: "{{ EDA_PG_NOTIFY_DSN }}"
-          channels:
-            - "{{ EDA_PG_NOTIFY_CHANNEL }}"
-      extra_vars:
-        EDA_PG_NOTIFY_DSN: "{{ settings.PG_NOTIFY_DSN }}"
-        EDA_PG_NOTIFY_CHANNEL: "{{ event_stream.channel_name }}"
-      encrypt_vars:
-        - EDA_PG_NOTIFY_DSN
-  rules:
-    - name: Post event
-      condition: true
-      action:
-        pg_notify:
-          dsn: "{{ EDA_PG_NOTIFY_DSN }}"
-          channel: "{{ EDA_PG_NOTIFY_CHANNEL }}"
-          event: "{{ event }}"
-"""
-
 SOURCE_MAPPING_ERROR_KEY = "rulebook"

src/aap_eda/api/webhook_authentication.py renamed to src/aap_eda/api/event_stream_authentication.py

@@ -11,7 +11,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-"""Module providing all webhook authentication types."""
+"""Module providing all event stream authentication types."""
 
 import base64
 import hashlib
@@ -37,16 +37,16 @@
 DEFAULT_TIMEOUT = 30
 
 
-class WebhookAuthentication(ABC):
-    """Base class for Webhook Authentication."""
+class EventStreamAuthentication(ABC):
+    """Base class for EventStream Authentication."""
 
     @abstractmethod
     def authenticate(self, body: Optional[bytes]):
         """Implement the authenticate maethod with body."""
 
 
 @dataclass
-class HMACAuthentication(WebhookAuthentication):
+class HMACAuthentication(EventStreamAuthentication):
     """HMAC Parameters."""
 
     signature: str
@@ -87,7 +87,7 @@ def authenticate(self, body: bytes):
 
 
 @dataclass
-class TokenAuthentication(WebhookAuthentication):
+class TokenAuthentication(EventStreamAuthentication):
     """Token Authentication."""
 
     token: str
@@ -102,7 +102,7 @@ def authenticate(self, _body=None):
 
 
 @dataclass
-class MTLSAuthentication(WebhookAuthentication):
+class MTLSAuthentication(EventStreamAuthentication):
     """mTLS Authentication."""
 
     subject: str
@@ -117,8 +117,8 @@ def authenticate(self, _body=None):
 
 
 @dataclass
-class BasicAuthentication(WebhookAuthentication):
-    """Token Authentication."""
+class BasicAuthentication(EventStreamAuthentication):
+    """Basic Authentication."""
 
     password: str
     username: str
@@ -139,7 +139,7 @@ def authenticate(self, _body=None):
 
 
 @dataclass
-class Oauth2JwtAuthentication(WebhookAuthentication):
+class Oauth2JwtAuthentication(EventStreamAuthentication):
     """OAuth2 JWT Authentication."""
 
     jwks_url: str
@@ -187,7 +187,7 @@ def authenticate(self, _body=None):
 
 
 @dataclass
-class Oauth2Authentication(WebhookAuthentication):
+class Oauth2Authentication(EventStreamAuthentication):
     """OAuth2 Authentication."""
 
     introspection_url: str
@@ -225,7 +225,7 @@ def authenticate(self, _body=None):
 
 
 @dataclass
-class EcdsaAuthentication(WebhookAuthentication):
+class EcdsaAuthentication(EventStreamAuthentication):
     """ECDSA Authentication."""
 
     public_key: str

src/aap_eda/api/exceptions.py

@@ -97,38 +97,9 @@ class InvalidWebsocketHost(APIException):
     )
 
 
-class MissingEventStreamRulebook(APIException):
+class InvalidEventStreamSource(APIException):
     status_code = status.HTTP_500_INTERNAL_SERVER_ERROR
     default_detail = (
-        "Configuration Error: Event stream template rulebook not found"
-    )
-
-
-class MissingEventStreamRulebookKeys(APIException):
-    status_code = status.HTTP_500_INTERNAL_SERVER_ERROR
-    default_detail = (
-        "Configuration Error: Event stream template rulebook is missing "
-        "required keys in complementary_source: type, name and args"
-    )
-
-
-class MissingEventStreamRulebookSource(APIException):
-    status_code = status.HTTP_500_INTERNAL_SERVER_ERROR
-    default_detail = (
-        "Configuration Error: Event stream template rulebook is missing "
-        "required complementary_source"
-    )
-
-
-class InvalidEventStreamRulebook(APIException):
-    status_code = status.HTTP_500_INTERNAL_SERVER_ERROR
-    default_detail = (
-        "Configuration Error: Event stream template rulebook is invalid"
-    )
-
-
-class InvalidWebhookSource(APIException):
-    status_code = status.HTTP_500_INTERNAL_SERVER_ERROR
-    default_detail = (
-        "Configuration Error: Webhook source could not be updated in ruleset"
+        "Configuration Error: Event Stream source could not be "
+        "updated in ruleset"
     )

src/aap_eda/api/filters/__init__.py

@@ -31,7 +31,6 @@
 )
 from .team import OrganizationTeamFilter, TeamFilter
 from .user import UserFilter
-from .webhook import WebhookFilter
 
 __all__ = (
     # project
@@ -52,13 +51,11 @@
     "ActivationInstanceLogFilter",
     # user
     "UserFilter",
-    # event_stream
-    "EventStreamFilter",
     # organization
     "OrganizationFilter",
     # team
     "TeamFilter",
     "OrganizationTeamFilter",
-    # Webhook
-    "WebhookFilter",
+    # EventStream
+    "EventStreamFilter",
 )

src/aap_eda/api/filters/event_stream.py

@@ -21,7 +21,7 @@ class EventStreamFilter(django_filters.FilterSet):
     name = django_filters.CharFilter(
         field_name="name",
         lookup_expr="istartswith",
-        label="Filter by event source name.",
+        label="Filter by event stream name.",
     )
 
     class Meta:

src/aap_eda/api/filters/webhook.py

@@ -38,11 +38,7 @@
     EdaCredentialCreateSerializer,
     EdaCredentialSerializer,
 )
-from .event_stream import (
-    EventStreamCreateSerializer,
-    EventStreamOutSerializer,
-    EventStreamSerializer,
-)
+from .event_stream import EventStreamInSerializer, EventStreamOutSerializer
 from .organization import (
     OrganizationCreateSerializer,
     OrganizationRefSerializer,
@@ -80,7 +76,6 @@
     UserListSerializer,
     UserSerializer,
 )
-from .webhook import WebhookInSerializer, WebhookOutSerializer
 
 __all__ = (
     # auth
@@ -123,10 +118,6 @@
     "EdaCredentialCreateSerializer",
     # decision environment
     "DecisionEnvironmentSerializer",
-    # event streams
-    "EventStreamSerializer",
-    "EventStreamCreateSerializer",
-    "EventStreamOutSerializer",
     # organizations
     "OrganizationSerializer",
     "OrganizationCreateSerializer",
@@ -138,7 +129,7 @@
     "TeamCreateSerializer",
     "TeamUpdateSerializer",
     "TeamDetailSerializer",
-    # webhooks
-    "WebhookInSerializer",
-    "WebhookOutSerializer",
+    # event streams
+    "EventStreamInSerializer",
+    "EventStreamOutSerializer",
 )