fix: service instance retrieve could filter to_be_delete (TencentBlueKing#202)

Author: xidons

sdks/paas-service/CHANGES.md

@@ -1,5 +1,8 @@
 # 版本历史
 
+## 2.0.1
+- Support querying service instance with parameter to_be_deleted 
+
 ## 2.0.0
 - 支持 Python 3.11，移除对 Python 3.6, 3.7 的支持
 

sdks/paas-service/paas_service/__init__.py

@@ -16,6 +16,6 @@
 We undertake not to change the open source license (MIT license) applicable
 to the current version of the project delivered to anyone in the future.
 """
-__version__ = '2.0.0'
+__version__ = '2.0.1'
 
 default_app_config = 'paas_service.apps.PaaSServiceConfig'

sdks/paas-service/paas_service/serializers.py

@@ -72,6 +72,10 @@ class Meta(object):
         exclude = ['config', 'credentials']
 
 
+class ServiceInstanceQuerySLZ(serializers.Serializer):
+    to_be_deleted = serializers.BooleanField(required=False, default=False)
+
+
 class ServiceInstanceBinderSLZ(serializers.Serializer):
     config = serializers.DictField(required=False, default=dict)
     credentials = serializers.DictField(required=True)

sdks/paas-service/paas_service/views.py

@@ -173,7 +173,11 @@ def provision(self, request, service_id, instance_id):
     @m_verified_client_required
     def retrieve(self, request, instance_id):
         """Retrieve an instance"""
-        instance = get_object_or_404(ServiceInstance, pk=instance_id, to_be_deleted=False)
+        slz = serializers.ServiceInstanceQuerySLZ(data=request.query_params)
+        slz.is_valid(raise_exception=True)
+        data = slz.validated_data
+
+        instance = get_object_or_404(ServiceInstance, pk=instance_id, to_be_deleted=data.get("to_be_deleted", False))
         instance.prerender(request)
         return Response(serializers.ServiceInstanceSLZ(instance).data)
 

sdks/paas-service/pyproject.toml

@@ -1,7 +1,7 @@
 [tool]
 [tool.poetry]
 name = "paas_service"
-version = "2.0.0"
+version = "2.0.1"
 description = "A Django application for developing BK-PaaS add-on services."
 readme = "README.md"
 authors = ["blueking <blueking@tencent.com>"]

sdks/paas-service/tests/test_apis.py

@@ -299,3 +299,51 @@ def test_retrieve_by_fields_when_not_found(self, rf, service, platform_client):
         response = view(request, service_id=service.pk)
         response.render()
         assert response.status_code == 404
+
+    def test_retrieve(self, rf, service, instance_with_credentials, platform_client):
+        view = SvcInstanceViewSet.as_view({'get': 'retrieve'})
+
+        request = rf.get(f"/instances/{instance_with_credentials.pk}")
+        request.client = platform_client
+
+        response = view(request, instance_id=instance_with_credentials.pk)
+        response.render()
+        assert response.status_code == 200
+        assert response.data["uuid"] == str(instance_with_credentials.uuid)
+
+    def test_retrieve_to_be_deleted(self, rf, service, instance_with_credentials, platform_client):
+        instance_with_credentials.to_be_deleted=True
+        instance_with_credentials.save()
+
+        view = SvcInstanceViewSet.as_view({'get': 'retrieve'})
+
+        request = rf.get(f"/instances/{instance_with_credentials.pk}/?to_be_deleted=true")
+        request.client = platform_client
+
+        response = view(request, instance_id=instance_with_credentials.pk)
+        response.render()
+        assert response.status_code == 200
+        assert response.data["uuid"] == str(instance_with_credentials.uuid)
+
+    def test_retrieve_when_not_found(self, rf, service, instance_with_credentials, platform_client):
+        instance_with_credentials.to_be_deleted=True
+        instance_with_credentials.save()
+
+        view = SvcInstanceViewSet.as_view({'get': 'retrieve'})
+
+        request = rf.get(f"/instances/{instance_with_credentials.pk}")
+        request.client = platform_client
+
+        response = view(request, instance_id=instance_with_credentials.pk)
+        response.render()
+        assert response.status_code == 404
+
+    def test_retrieve_to_be_deleted_when_not_found(self, rf, service, instance_with_credentials, platform_client):
+        view = SvcInstanceViewSet.as_view({'get': 'retrieve'})
+
+        request = rf.get(f"/instances/{instance_with_credentials.pk}/?to_be_deleted=true")
+        request.client = platform_client
+
+        response = view(request, instance_id=instance_with_credentials.pk)
+        response.render()
+        assert response.status_code == 404