feat(apigw_manager/drf): add grant resource permission and import docs (#219)

Author: wklken

.github/workflows/apigw-manager.yml

@@ -32,7 +32,7 @@ jobs:
 
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
+        python -m pip install pip -U
         python -m pip install . 'tox-gh-actions==3.2.0' -r requirements_tox.txt
         python -m pip uninstall -y tox-pyenv-redux
       working-directory: sdks/apigw-manager

sdks/apigw-manager/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "apigw-manager"
-version = "4.0.1"
+version = "4.0.2"
 description = "The SDK for managing blueking gateway resource."
 readme = "README.md"
 authors = ["blueking <blueking@tencent.com>"]
@@ -10,11 +10,26 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
 ]
 
+[project]
+name = "apigw-manager"
+description = "The SDK for managing blueking gateway resource."
+license = "MIT"
+dynamic = ["version", "classifiers", "dependencies"]
+readme = "README.md"
+authors = [{name = "blueking", email = "blueking@tencent.com"}]
+requires-python = '>=3.8,<3.13'
+
 
 [project.urls]
 Homepage = "https://github.com/TencentBlueKing/bkpaas-python-sdk/"
 Repository = "https://github.com/TencentBlueKing/bkpaas-python-sdk/"
 
+[project.optional-dependencies]
+cryptography = ['cryptography (>=3.1.1)', 'pyjwt (>=2.0.0)']
+drf = ["django", 'cryptography', 'pyjwt', 'djangorestframework (>=3.10.3)', 'drf-spectacular (<=0.27.2)']
+django = ["django", 'pyjwt']
+demo = ['django-environ (>=0.8.1)', "django", 'PyMySQL (>=1.0.2,<2.0.0)', 'pyjwt']
+kubernetes = ['kubernetes']
 [tool.poetry.dependencies]
 python = ">=3.8,<3.13"
 setuptools = ">=21.0.0"

sdks/apigw-manager/src/apigw_manager/drf/management/commands/data/definition.yaml

@@ -47,13 +47,24 @@ stages:
       {% endfor %}
     {% endif %}
 
-{% if settings.BK_APIGW_GRANT_PERMISSION_DIMENSION_GATEWAY_APP_CODES %}
+{% if settings.BK_APIGW_GRANT_PERMISSION_DIMENSION_GATEWAY_APP_CODES or settings.BK_APIGW_GRANT_PERMISSION_DIMENSION_RESOURCE_APP_CODES %}
 grant_permissions:
   {% for app_code in settings.BK_APIGW_GRANT_PERMISSION_DIMENSION_GATEWAY_APP_CODES %}
   - bk_app_code: "{{ app_code }}"
     grant_dimension: "gateway"
   {% endfor %}
+  {% for app_code, resource_names in settings.BK_APIGW_GRANT_PERMISSION_DIMENSION_RESOURCE_APP_CODES.items %}
+  - bk_app_code: "{{ app_code }}"
+    grant_dimension: "resource"
+    resource_names:
+      {% for resource_name in resource_names %}
+      - "{{ resource_name }}"
+      {% endfor %}
+  {% endfor %}
 {% endif %}
 
 related_apps:
   - "{{ settings.BK_APP_CODE }}"
+
+resource_docs:
+  basedir: "{{ settings.BK_APIGW_RESOURCE_DOCS_BASE_DIR }}"

sdks/apigw-manager/src/apigw_manager/drf/management/commands/sync_drf_apigateway.py

@@ -60,21 +60,31 @@ def handle(self, *args, **kwargs):
             f"--doc_language={settings.BK_APIGW_RELEASE_DOC_LANGUAGE}",
         )
 
-        self.stdout.write(
-            f"call create_version_and_release_apigw with definition: {definition_file_path}, stage: {settings.BK_APIGW_STAGE_NAME}"
-        )
+        # if BK_APIGW_RESOURCE_DOCS_BASE_DIR is not empty, then sync the resource docs
+        if hasattr(settings, "BK_APIGW_RESOURCE_DOCS_BASE_DIR") and settings.BK_APIGW_RESOURCE_DOCS_BASE_DIR:
+            self.stdout.write(f"call sync_resource_docs_by_archive with definition: {definition_file_path}")
+            call_command(
+                "sync_resource_docs_by_archive",
+                f"--gateway-name={gateway_name}",
+                f"--file={definition_file_path}",
+                "--safe-mode",
+            )
+
+        self.stdout.write(f"call grant_apigw_permissions with definition: {definition_file_path}")
         call_command(
-            "create_version_and_release_apigw",
+            "grant_apigw_permissions",
             f"--gateway-name={gateway_name}",
             f"--file={definition_file_path}",
-            f"--stage={settings.BK_APIGW_STAGE_NAME}",
         )
 
-        self.stdout.write(f"call grant_apigw_permissions with definition: {definition_file_path}")
+        self.stdout.write(
+            f"call create_version_and_release_apigw with definition: {definition_file_path}, stage: {settings.BK_APIGW_STAGE_NAME}"
+        )
         call_command(
-            "grant_apigw_permissions",
+            "create_version_and_release_apigw",
             f"--gateway-name={gateway_name}",
             f"--file={definition_file_path}",
+            f"--stage={settings.BK_APIGW_STAGE_NAME}",
         )
 
         self.stdout.write(f"call fetch_apigw_public_key {gateway_name}")

sdks/apigw-manager/tox.ini

@@ -3,6 +3,7 @@ minversion = 3.23.0
 isolated_build = True
 envlist = py{38,39,310,311,312}-django{3,4,5}-pyjwt{2}
 
+
 [gh-actions]
 python =
     3.8: py38