[rpc] Rename Env RPC methods. Refs #153

	Env.filter_groups -> Env.Group.filter
	Env.filter_properties -> Env.Property.filter
	Env.filter_values -> Env.Value.filter

docs/source/modules/tcms.xmlrpc.api.env.group.rst

@@ -0,0 +1,7 @@
+tcms\.xmlrpc\.api\.env\.group module
+====================================
+
+.. automodule:: tcms.xmlrpc.api.env.group
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/modules/tcms.xmlrpc.api.env.property.rst

@@ -0,0 +1,7 @@
+tcms\.xmlrpc\.api\.env\.property module
+=======================================
+
+.. automodule:: tcms.xmlrpc.api.env.property
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/modules/tcms.xmlrpc.api.env.rst

@@ -1,7 +1,17 @@
-tcms\.xmlrpc\.api\.env module
-=============================
+tcms\.xmlrpc\.api\.env package
+==============================
 
 .. automodule:: tcms.xmlrpc.api.env
     :members:
     :undoc-members:
     :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   tcms.xmlrpc.api.env.group
+   tcms.xmlrpc.api.env.property
+   tcms.xmlrpc.api.env.value
+

docs/source/modules/tcms.xmlrpc.api.env.value.rst

@@ -0,0 +1,7 @@
+tcms\.xmlrpc\.api\.env\.value module
+====================================
+
+.. automodule:: tcms.xmlrpc.api.env.value
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/modules/tcms.xmlrpc.api.rst

@@ -6,14 +6,20 @@ tcms\.xmlrpc\.api package
     :undoc-members:
     :show-inheritance:
 
+Subpackages
+-----------
+
+.. toctree::
+
+    tcms.xmlrpc.api.env
+
 Submodules
 ----------
 
 .. toctree::
 
    tcms.xmlrpc.api.auth
    tcms.xmlrpc.api.build
-   tcms.xmlrpc.api.env
    tcms.xmlrpc.api.product
    tcms.xmlrpc.api.tag
    tcms.xmlrpc.api.testcase

tcms/settings/common.py

@@ -255,7 +255,9 @@
 MODERNRPC_METHODS_MODULES = [
         'tcms.xmlrpc.api.auth',
         'tcms.xmlrpc.api.build',
-        'tcms.xmlrpc.api.env',
+        'tcms.xmlrpc.api.env.group',
+        'tcms.xmlrpc.api.env.property',
+        'tcms.xmlrpc.api.env.value',
         'tcms.xmlrpc.api.product',
         'tcms.xmlrpc.api.testcase',
         'tcms.xmlrpc.api.testcaserun',

tcms/xmlrpc/api/env/__init__.py

@@ -0,0 +1,3 @@
+""" """
+# Note: empty doc-string because otherwise Sphinx will not pick this up
+# when rendering the documentation

tcms/xmlrpc/api/env/group.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+
+from modernrpc.core import rpc_method
+
+from tcms.management.models import TCMSEnvGroup
+from tcms.xmlrpc.utils import parse_bool_value
+
+
+@rpc_method(name='Env.Group.filter')
+def filter(query):
+    """
+    .. function:: XML-RPC Env.Group.filter(query)
+
+        Perform a search and return the resulting list of
+        :class:`tcms.management.models.TCMSEnvGroup` objects.
+
+        :param query: Field lookups for :class:`tcms.management.models.TCMSEnvGroup`
+        :type query: dict
+        :returns: List of serialized :class:`tcms.management.models.TCMSEnvGroup` objects
+        :rtype: list(dict)
+    """
+    if 'is_active' in query:
+        query['is_active'] = parse_bool_value(query['is_active'])
+    return TCMSEnvGroup.to_xmlrpc(query)

tcms/xmlrpc/api/env/property.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+from modernrpc.core import rpc_method
+
+from tcms.management.models import TCMSEnvProperty
+from tcms.xmlrpc.utils import parse_bool_value
+
+
+@rpc_method(name='Env.Property.filter')
+def filter(query):
+    """
+    .. function:: XML-RPC Env.Property.filter(query)
+
+        Performs a search and returns the resulting list of environment properties.
+
+        :param query: Field lookups for :class:`tcms.management.models.TCMSEnvProperty`
+        :type query: dict
+        :returns: List of serialized :class:`tcms.management.models.TCMSEnvProperty` objects
+        :rtype: list(dict)
+    """
+    if 'is_active' in query:
+        query['is_active'] = parse_bool_value(query['is_active'])
+    return TCMSEnvProperty.to_xmlrpc(query)

tcms/xmlrpc/api/env/value.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+from modernrpc.core import rpc_method
+
+from tcms.management.models import TCMSEnvValue
+from tcms.xmlrpc.utils import parse_bool_value
+
+
+@rpc_method(name='Env.Value.filter')
+def filter(query):
+    """
+    .. function:: XML-RPC Env.Value.filter(query)
+
+        Performs a search and returns the resulting list of environment values.
+
+        :param query: Field lookups for :class:`tcms.management.models.TCMSEnvValue`
+        :type query: dict
+        :returns: List of serialized :class:`tcms.management.models.TCMSEnvValue` objects
+        :rtype: list(dict)
+    """
+    if 'is_active' in query:
+        query['is_active'] = parse_bool_value(query['is_active'])
+    return TCMSEnvValue.to_xmlrpc(query)

tcms/xmlrpc/tests/test_logging.py

@@ -20,22 +20,22 @@ def assertArgsNotLogged(self, rpc_method):
 
     @patch('tcms.xmlrpc.handlers.settings.DEBUG', new=False)
     def test_logging_with_authenticated_user(self):
-        log_count = XmlRpcLog.objects.filter(user=self.api_user, method='Env.filter_groups').count()
+        log_count = XmlRpcLog.objects.filter(user=self.api_user, method='Env.Group.filter').count()
 
-        self.rpc_client.Env.filter_groups({})
-        new_count = XmlRpcLog.objects.filter(user=self.api_user, method='Env.filter_groups').count()
+        self.rpc_client.Env.Group.filter({})
+        new_count = XmlRpcLog.objects.filter(user=self.api_user, method='Env.Group.filter').count()
 
         self.assertEqual(new_count, log_count + 1)
 
     @patch('tcms.xmlrpc.handlers.settings.DEBUG', new=False)
     def test_logging_with_anonymous_user(self):
         log_count = XmlRpcLog.objects.filter(user__username='Anonymous',
-                                             method='Env.filter_groups').count()
+                                             method='Env.Group.filter').count()
 
         self.rpc_client.Auth.logout()
-        self.rpc_client.Env.filter_groups({})
+        self.rpc_client.Env.Group.filter({})
         new_count = XmlRpcLog.objects.filter(user__username='Anonymous',
-                                             method='Env.filter_groups').count()
+                                             method='Env.Group.filter').count()
 
         self.assertEqual(new_count, log_count + 1)