feat: 增加webhook请求调试方法 --story=126514126

# Reviewed, transaction id: 54982

Author: guohelu

config/default.py

@@ -238,8 +238,7 @@
     INSTALLED_APPS = locals().get("INSTALLED_APPS", [])
     INSTALLED_APPS += ("django_celery_beat", "django_celery_results")
     CELERY_ENABLE_UTC = False
-    CELERY_TASK_SERIALIZER = "pickle"
-    CELERY_ACCEPT_CONTENT = ["json", "pickle", "msgpack", "yaml"]
+    CELERY_TASK_SERIALIZER = "json"
     CELERYBEAT_SCHEDULER = "django_celery_beat.schedulers.DatabaseScheduler"
 
 TEMPLATE_DATA_SALT = "821a11587ea434eb85c2f5327a90ae54"

dist/bkflow_django_webhook-1.2.0rc3-py2.py3-none-any.whl

@@ -130,3 +130,12 @@ class TemplateLabelQuerySerializer(serializers.Serializer):
     label_ids = serializers.ListField(
         child=serializers.IntegerField(), allow_empty=True, required=True, help_text="标签ID列表"
     )
+
+
+class WebhookConfigQuerySerializer(serializers.Serializer):
+    webhook_config = serializers.JSONField(help_text="webhook配置", required=True)
+
+    def validate_webhook_config(self, value):
+        if not value.get("url"):
+            raise serializers.ValidationError("缺少请求地址")
+        return value

dist/bkflow_django_webhook-1.2.0rc5-py2.py3-none-any.whl

@@ -43,6 +43,7 @@
     TaskTemplateSerializer,
     TopCollectionTaskTemplateSerializer,
     TemplateLabelQuerySerializer,
+    WebhookConfigQuerySerializer,
 )
 from gcloud.core.apis.drf.viewsets.base import GcloudModelViewSet
 from gcloud.iam_auth import IAMMeta, res_factory
@@ -53,6 +54,7 @@
 from gcloud.user_custom_config.constants import TASKTMPL_ORDERBY_OPTIONS
 from gcloud.utils.webhook import apply_webhook_configs, get_webhook_configs, clear_scope_webhooks
 from gcloud.core.apis.drf.exceptions import ValidationException
+from webhook.api import verify_webhook_endpoint
 
 logger = logging.getLogger("root")
 manager = TemplateManager(template_model_cls=TaskTemplate)
@@ -88,6 +90,9 @@ class TaskTemplatePermission(IamPermission):
         "update_template_labels": IamPermissionInfo(
             IAMMeta.FLOW_EDIT_ACTION, res_factory.resources_for_flow_obj, HAS_OBJECT_PERMISSION
         ),
+        "verify_webhook_configuration": IamPermissionInfo(
+            IAMMeta.FLOW_EDIT_ACTION, res_factory.resources_for_flow_obj, HAS_OBJECT_PERMISSION
+        ),
     }
 
 
@@ -414,3 +419,21 @@ def update_template_labels(self, request, *args, **kwargs):
             return Response({"detail": ErrorDetail(message, err_code.REQUEST_PARAM_INVALID.code)}, exception=True)
 
         return Response({"name": template.name, "label_ids": label_ids})
+
+    @swagger_auto_schema(method="POST", operation_summary="验证Webhook配置", request_body=WebhookConfigQuerySerializer)
+    @action(methods=["POST"], detail=False)
+    def verify_webhook_configuration(self, request, *args, **kwargs):
+        serializer = WebhookConfigQuerySerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+        webhook_config = serializer.validated_data["webhook_config"]
+        try:
+            verify_result = verify_webhook_endpoint(webhook_config)
+        except Exception as e:
+            message = str(e)
+            return Response({"detail": ErrorDetail(message, err_code.REQUEST_PARAM_INVALID.code)}, exception=True)
+
+        if not verify_result.ok:
+            message = str(verify_result.json_response())
+            return Response({"detail": ErrorDetail(message, err_code.REQUEST_PARAM_INVALID.code)}, exception=True)
+
+        return Response(status=status.HTTP_200_OK)

gcloud/core/apis/drf/serilaziers/task_template.py

@@ -105,4 +105,4 @@ bk-notice-sdk==1.3.0
 croniter==1.4.1
 
 # bkflow feel
-./dist/bkflow_django_webhook-1.2.0rc3-py2.py3-none-any.whl
+./dist/bkflow_django_webhook-1.2.0rc5-py2.py3-none-any.whl