Add support to escape special characters in query filter for api v35.0+ (#711)

For api v35.0+, vCD requires special characters viz. ( ) ; , to be escaped if used as value in query filter.
In _AbstractQuery, we escape the special characters in encoded filter value.

Additional changes,
* Replaced usage of quote_plus to quote, since quote_plus will replace spaces with + and thus can cause the filter value to distort.
* Encoded all usage of qfilter in get_typed_query, since this field should be encoded by caller.

Author: rocknes

pyvcloud/vcd/api_extension.py

@@ -82,9 +82,9 @@ def _get_extension_record(self,
         :raise MultipleRecordsException: if more than one service with the
             given name and namespace are found.
         """
-        qfilter = 'name==%s' % urllib.parse.quote_plus(name)
+        qfilter = 'name==%s' % urllib.parse.quote(name)
         if namespace is not None:
-            qfilter += ';namespace==%s' % urllib.parse.quote_plus(namespace)
+            qfilter += ';namespace==%s' % urllib.parse.quote(namespace)
         try:
             ext = self.client.get_typed_query(
                 ResourceType.ADMIN_SERVICE.value,

pyvcloud/vcd/client.py

@@ -1827,24 +1827,50 @@ def __init__(self,
         self._include_links = include_links
         self._page = 1
 
-        self._filter = qfilter
-        if equality_filter is not None:
-            if self._filter is not None:
+        is_below_v35_query = float(client.get_api_version()) < float(ApiVersion.VERSION_35.value)  # noqa: E501
+        if is_below_v35_query:
+            self._filter = qfilter
+        else:
+            self._filter = self._escape_special_characters(qfilter)
+
+        if equality_filter:
+            if self._filter:
                 self._filter += ';'
             else:
                 self._filter = ''
             self._filter += equality_filter[0]
             self._filter += '=='
-            if float(client.get_api_version()) < float(ApiVersion.VERSION_35.value):  # noqa: E501
+            if is_below_v35_query:
                 self._filter += equality_filter[1]
             else:
-                self._filter += urllib.parse.quote(equality_filter[1])
+                self._filter += self._escape_special_characters(
+                    urllib.parse.quote(equality_filter[1]))
 
         self._sort_desc = sort_desc
         self._sort_asc = sort_asc
 
         self.fields = fields
 
+    def _escape_special_characters(self, single_encoded_value_string):
+        """Escape vCD query specific special characters viz. ( ) ; ,.
+
+        This method accepts a url encoded string and replaces encoded
+        instances of ( ) ; , with their escaped version.
+
+        :param str single_encoded_value_string: string to be processed
+
+        :return: string with vCD query specific special characters escaped
+
+        :rtype: str
+        """
+        val = single_encoded_value_string
+        if val:
+            val = val.replace('%28', '%5C%28')
+            val = val.replace('%29', '%5C%29')
+            val = val.replace('%2C', '%5C%2C')
+            val = val.replace('%3B', '%5C%3B')
+        return val
+
     def execute(self):
         """Executes query and returns results.
 

pyvcloud/vcd/external_network.py

@@ -13,6 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import urllib
+
 from pyvcloud.vcd.client import E
 from pyvcloud.vcd.client import E_VMEXT
 from pyvcloud.vcd.client import EntityType
@@ -562,7 +564,7 @@ def list_associated_direct_org_vdc_networks(self, filter=None):
         :raises: EntityNotFoundException: if any direct org vDC network
          cannot be found.
         """
-        query_filter = 'connectedTo==' + self.name
+        query_filter = 'connectedTo==' + urllib.parse.quote(self.name)
         if filter:
             query_filter += ';' + filter
         query = self.client.get_typed_query(
@@ -585,7 +587,7 @@ def list_vsphere_network(self, filter=None):
         :rtype: list
         """
         out_list = []
-        query_filter = 'networkName==' + self.name
+        query_filter = 'networkName==' + urllib.parse.quote(self.name)
         if filter:
             query_filter += ';' + filter
         query = self.client.get_typed_query(

pyvcloud/vcd/org.py

@@ -1059,7 +1059,7 @@ def list_users(self, name_filter=None):
         if self.client.is_sysadmin():
             resource_type = ResourceType.ADMIN_USER.value
             org_filter = 'org==%s' % \
-                urllib.parse.quote_plus(self.resource.get('href'))
+                urllib.parse.quote(self.resource.get('href'))
         query = self.client.get_typed_query(
             resource_type,
             query_result_format=QueryResultFormat.RECORDS,
@@ -1168,7 +1168,7 @@ def list_roles(self, name_filter=None):
         if self.client.is_sysadmin():
             resource_type = ResourceType.ADMIN_ROLE.value
             org_filter = 'org==%s' % \
-                urllib.parse.quote_plus(self.resource.get('href'))
+                urllib.parse.quote(self.resource.get('href'))
 
         query = self.client.get_typed_query(
             resource_type,

pyvcloud/vcd/platform.py

@@ -1013,7 +1013,7 @@ def get_port_group_moref_types(self, vim_server_name, port_group_name):
         :raises: EntityNotFoundException: if any port group name cannot be
         found.
         """
-        vcfilter = 'vcName==%s' % urllib.parse.quote_plus(vim_server_name)
+        vcfilter = 'vcName==%s' % urllib.parse.quote(vim_server_name)
         query = self.client.get_typed_query(
             ResourceType.PORT_GROUP.value,
             qfilter=vcfilter,
@@ -1041,7 +1041,7 @@ def list_available_port_group_names(self, vim_server_name):
         :raises: EntityNotFoundException: if any port group name cannot be
         found.
         """
-        vcfilter = 'vcName==%s' % urllib.parse.quote_plus(vim_server_name)
+        vcfilter = 'vcName==%s' % urllib.parse.quote(vim_server_name)
         query = self.client.get_typed_query(
             ResourceType.PORT_GROUP.value,
             qfilter=vcfilter,

pyvcloud/vcd/system.py

@@ -18,6 +18,7 @@
 from pyvcloud.vcd.client import NSMAP
 from pyvcloud.vcd.client import QueryResultFormat
 from pyvcloud.vcd.client import RelationType
+from pyvcloud.vcd.client import ResourceType
 from pyvcloud.vcd.exceptions import EntityNotFoundException
 from pyvcloud.vcd.exceptions import InvalidParameterException
 from pyvcloud.vcd.utils import get_admin_href
@@ -129,7 +130,7 @@ def list_provider_vdc_storage_profiles(self, name=None):
             name_filter = ('name', name)
 
         q = self.client.get_typed_query(
-            'providerVdcStorageProfile',
+            ResourceType.PROVIDER_VDC_STORAGE_PROFILE.value,
             query_result_format=QueryResultFormat.RECORDS,
             equality_filter=name_filter)
 

pyvcloud/vcd/task.py

@@ -125,7 +125,7 @@ def list_tasks(self,
         """
         query_filter = ''
         for f in filter_status_list:
-            query_filter += 'status==%s,' % urllib.parse.quote_plus(f)
+            query_filter += 'status==%s,' % urllib.parse.quote(f)
         if len(query_filter) > 0:
             query_filter = query_filter[:-1]
         sort_asc = None

pyvcloud/vcd/vdc.py

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import urllib
+
 from lxml import etree
 
 from pyvcloud.vcd.acl import Acl
@@ -155,7 +157,7 @@ def query_vm_by_name(self, name):
         :raises: MultipleRecordsException: if more than one VM with the
             provided name are found.
         """
-        vdc_filter = ('vdc==%s' % self.href)
+        vdc_filter = ('vdc==%s' % urllib.parse.quote(self.href))
         name_filter = ('name', name)
         query_obj = self.client.get_typed_query(
             ResourceType.ADMIN_VM.value,
@@ -166,7 +168,7 @@ def query_vm_by_name(self, name):
 
     def get_vapp_href(self, name):
         name_filter = ('name', name)
-        vdc_filter = 'vdc==%s' % self.href
+        vdc_filter = 'vdc==%s' % urllib.parse.quote(self.href)
         resource_type = ResourceType.VAPP.value
         if self.client.is_sysadmin():
             resource_type = ResourceType.ADMIN_VAPP.value

system_tests/nsxt_tests.py

@@ -34,7 +34,7 @@ def test_0010_register_nsxt(self):
         platform = Platform(TestNSXT._client)
 
         manager_name = Environment._config['nsxt']['manager_name']
-        query_filter = 'name==%s' % urllib.parse.quote_plus(manager_name)
+        query_filter = 'name==%s' % urllib.parse.quote(manager_name)
         query = TestNSXT._client.get_typed_query(
             ResourceType.NSXT_MANAGER.value,
             query_result_format=QueryResultFormat.REFERENCES,