feat(apigw_manager/plugin): 新增 bk-access-token-source 插件 (#238)

Author: F-cq

sdks/apigw-manager/src/apigw_manager/plugin/config.py

@@ -572,7 +572,7 @@ class HeadersConfig:
     remove: List[str]
 
 
-def build_response_rewrite_validation(
+def build_response_rewrite(
         status_code: int,
         body: str,
         vars: Optional[str],
@@ -648,7 +648,7 @@ def build_response_rewrite_validation(
     }
 
 
-def build_redirect_validation(
+def build_redirect(
     uri: str,
     ret_code: int = 302,
 ) -> Dict[str, str]:
@@ -682,6 +682,37 @@ def build_redirect_validation(
     }
 
 
+def build_bk_access_token_source(
+    source: str,
+) -> Dict[str, str]:
+    """generate bk-access-token-source plugin config
+
+    Args:
+        source (str): access_token 来源。Defaults to bearer.
+
+    Raises:
+        ValueError: source must be bearer or api_key
+
+    Returns:
+        {
+            "type": "bk-access-token-source",
+            "yaml": "source: bearer\n"
+        }
+    """
+
+    if source not in ["bearer", "api_key"]:
+        raise ValueError("source must be bearer or api_key.")
+
+    return {
+        "type": "bk-access-token-source",
+        "yaml": yaml_dump(
+            {
+                "source": source,
+            }
+        ),
+    }
+
+
 def _check_percentage(percentage: int, location: str):
     if percentage and not (0 < percentage <= 100):
         raise ValueError(f"The percentage of {location} must be greater than 0 and less than or equal to 100")

sdks/apigw-manager/tests/apigw_manager/plugin/test_config.py

@@ -18,8 +18,9 @@
     build_api_breaker,
     build_fault_injection,
     build_request_validation,
-    build_response_rewrite_validation,
-    build_redirect_validation,
+    build_response_rewrite,
+    build_redirect,
+    build_bk_access_token_source,
     build_stage_plugin_config_for_definition_yaml,
     UnhealthyConfig,
     HealthyConfig,
@@ -565,15 +566,15 @@ def test_build_request_validation(
             ),
         ]
     )
-    def test_build_response_rewrite_validation(
+    def test_build_response_rewrite(
         self, status_code, body, vars, body_base64, headers, will_error, expected
     ):
         if will_error:
             with pytest.raises(ValueError):
-                build_response_rewrite_validation(status_code, body, vars, body_base64, headers)
+                build_response_rewrite(status_code, body, vars, body_base64, headers)
             return
 
-        assert build_response_rewrite_validation(status_code, body, vars, body_base64, headers) == expected
+        assert build_response_rewrite(status_code, body, vars, body_base64, headers) == expected
 
     @pytest.mark.parametrize(
         "uri, ret_code, will_error, expected",
@@ -595,15 +596,51 @@ def test_build_response_rewrite_validation(
             ),
         ]
     )
-    def test_build_redirect_validation(
+    def test_build_redirect(
         self, uri, ret_code, will_error, expected
     ):
         if will_error:
             with pytest.raises(ValueError):
-                build_redirect_validation(uri, ret_code)
+                build_redirect(uri, ret_code)
             return
 
-        assert build_redirect_validation(uri, ret_code) == expected
+        assert build_redirect(uri, ret_code) == expected
+
+    @pytest.mark.parametrize(
+        "source, will_error, expected",
+        [
+            (
+                "bearer",
+                False,
+                {
+                    "type": "bk-access-token-source",
+                    "yaml": "source: bearer\n"
+                },
+            ),
+            (
+                "api_key",
+                False,
+                {
+                    "type": "bk-access-token-source",
+                    "yaml": "source: api_key\n"
+                },
+            ),
+            (
+                "test",
+                True,
+                None,
+            ),
+        ]
+    )
+    def test_build_redirect(
+        self, source, will_error, expected
+    ):
+        if will_error:
+            with pytest.raises(ValueError):
+                build_bk_access_token_source(source)
+            return
+
+        assert build_bk_access_token_source(source) == expected
 
 
 class TestBuildStagePluginConfigForDefinitionYaml: