Use jsonutils from oslo.serialization

Sahara should use jsonutils from oslo_serialization because
it support all functions from json. Also added
hacking check for that.

Change-Id: I8c286ad947b92d6552b17cfa7ef80ba1beb5b51b
Closes-bug: 1442120

HACKING.rst

@@ -44,3 +44,9 @@ Logs
 - [S373] LOG.debug never used for translations
 
 - [S374] You used a deprecated log level
+
+Importing json
+--------------
+
+- [S375] It's more preferable to use ``jsonutils`` from ``oslo_serialization``
+         instead of ``json`` for operating with ``json`` objects.

sahara/db/templates/api.py

@@ -13,12 +13,12 @@
 # limitations under the License.
 
 import copy
-import json
 import os
 import uuid
 
 import jsonschema
 from oslo_config import cfg
+from oslo_serialization import jsonutils as json
 import six
 
 from sahara import conductor

sahara/plugins/cdh/client/http_client.py

@@ -23,13 +23,13 @@
 # We also change some importings to use Sahara inherited classes.
 
 import cookielib
-import json
 import posixpath
 import types
 import urllib
 import urllib2
 
 from oslo_log import log as logging
+from oslo_serialization import jsonutils as json
 import six
 
 from sahara.i18n import _LW

sahara/plugins/cdh/client/resource.py

@@ -22,12 +22,12 @@
 # To satisfy the pep8 and python3 tests, we did some changes to the codes.
 # We also change some importings to use Sahara inherited classes.
 
-import json
 import posixpath
 import socket
 import urllib2
 
 from oslo_log import log as logging
+from oslo_serialization import jsonutils as json
 import six
 
 from sahara import context

sahara/plugins/cdh/client/services.py

@@ -22,8 +22,7 @@
 # To satisfy the pep8 and python3 tests, we did some changes to the codes.
 # We also change some importings to use Sahara inherited classes.
 
-import json
-
+from oslo_serialization import jsonutils as json
 import six
 
 from sahara.plugins.cdh.client import role_config_groups

sahara/plugins/cdh/client/types.py

@@ -24,9 +24,9 @@
 
 import copy
 import datetime
-import json
 import time
 
+from oslo_serialization import jsonutils as json
 import six
 
 from sahara import context

sahara/plugins/cdh/v5/config_helper.py

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import json
+from oslo_serialization import jsonutils as json
 
 from sahara.plugins import provisioning as p
 from sahara.utils import files as f

sahara/plugins/cdh/v5/resources/cdh_config.py

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import json
+from oslo_serialization import jsonutils as json
 
 from sahara.plugins.cdh.client import api_client
 

sahara/plugins/cdh/v5_3_0/config_helper.py

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import json
+from oslo_serialization import jsonutils as json
 
 from sahara.plugins import provisioning as p
 from sahara.utils import files as f

sahara/plugins/cdh/v5_3_0/resources/cdh_config.py

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import json
+from oslo_serialization import jsonutils as json
 
 from sahara.plugins.cdh.client import api_client
 

sahara/plugins/hdp/versions/version_1_3_2/versionhandler.py

@@ -13,10 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import json
-
 from oslo_config import cfg
 from oslo_log import log as logging
+from oslo_serialization import jsonutils as json
 import pkg_resources as pkg
 
 from sahara import context

sahara/plugins/hdp/versions/version_2_0_6/versionhandler.py

@@ -13,10 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import json
-
 from oslo_config import cfg
 from oslo_log import log as logging
+from oslo_serialization import jsonutils as json
 import pkg_resources as pkg
 import six
 

sahara/plugins/mapr/base/base_node_manager.py

@@ -13,10 +13,10 @@
 # under the License.
 
 
-import json
 import random
 
 from oslo_log import log as logging
+from oslo_serialization import jsonutils as json
 from oslo_utils import timeutils
 
 from sahara import context

sahara/plugins/mapr/domain/service.py

@@ -13,7 +13,7 @@
 # under the License.
 
 
-import json
+from oslo_serialization import jsonutils as json
 
 from sahara import context
 import sahara.exceptions as e

sahara/service/edp/oozie/oozie.py

@@ -13,9 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import json
 import re
 
+from oslo_serialization import jsonutils as json
 from six.moves.urllib import parse as urlparse
 
 import sahara.exceptions as ex

sahara/service/trusts.py

@@ -13,10 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import json
-
 from oslo_config import cfg
 from oslo_log import log as logging
+from oslo_serialization import jsonutils as json
 import six
 
 from sahara import conductor as c

sahara/tests/integration/tests/gating/test_mapr_gating.py

@@ -12,13 +12,13 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-import json
 import random
 import string
 import time
 import uuid
 
 import fixtures
+from oslo_serialization import jsonutils as json
 import six
 
 from sahara.tests.integration.tests import base as b

sahara/tests/scenario/base.py

@@ -16,7 +16,6 @@
 from __future__ import print_function
 import functools
 import glob
-import json
 import logging
 import os
 import sys
@@ -24,6 +23,7 @@ import time
 import traceback
 
 import fixtures
+from oslo_serialization import jsonutils as json
 from oslo_utils import timeutils
 import prettytable
 import six

sahara/tests/unit/db/templates/test_update.py

@@ -13,12 +13,12 @@
 # limitations under the License.
 
 import copy
-import json
 import tempfile
 import uuid
 
 import jsonschema
 import mock
+from oslo_serialization import jsonutils as json
 from oslo_utils import uuidutils
 
 from sahara import context

sahara/tests/unit/service/edp/test_json_api_examples.py

@@ -14,10 +14,10 @@
 # limitations under the License.
 
 import itertools
-import json
 import os
 import uuid
 
+from oslo_serialization import jsonutils as json
 import testtools
 
 from sahara.service.validations.edp import data_source

sahara/tests/unit/utils/test_hacking.py

@@ -49,3 +49,18 @@ class HackingTestCase(testtools.TestCase):
 
         self.assertEqual(0, len(list(checks.dict_constructor_with_list_copy(
             "      self._render_dict(xml, data_el, data.__dict__)"))))
+
+    def test_use_jsonutils(self):
+        self.assertEqual(0, len(list(checks.use_jsonutils(
+            "import json    # noqa", "path"))))
+        self.assertEqual(0, len(list(checks.use_jsonutils(
+            "from oslo_serialization import jsonutils as json", "path"))))
+        self.assertEqual(0, len(list(checks.use_jsonutils(
+            "import jsonschema", "path"))))
+        self.assertEqual(0, len(list(checks.use_jsonutils(
+            "import json", "sahara/openstack/common/utils.py"))))
+
+        self.assertEqual(1, len(list(checks.use_jsonutils(
+            "import json", "path"))))
+        self.assertEqual(1, len(list(checks.use_jsonutils(
+            "import json as jsonutils", "path"))))

sahara/utils/hacking/checks.py

@@ -13,6 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import pep8
 
 import re
 import tokenize
@@ -97,6 +98,25 @@ def dict_constructor_with_list_copy(logical_line):
                'constructor with a sequence of key-value pairs.')
 
 
+def use_jsonutils(logical_line, filename):
+    """Check to prevent importing json in sahara code.
+
+    S375
+    """
+    if pep8.noqa(logical_line):
+        return
+    ignore_dirs = ["sahara/openstack/common"]
+    for dir in ignore_dirs:
+        if dir in filename:
+            return
+    invalid_line = re.compile(r"(import\s+json)")
+    valid_line = re.compile(r"(import\s+jsonschema)")
+    if (re.match(invalid_line, logical_line) and
+            not re.match(valid_line, logical_line)):
+        yield(0, "S375: Use jsonutils from oslo_serialization instead"
+                 " of json")
+
+
 def factory(register):
     register(import_db_only_in_conductor)
     register(hacking_no_author_attr)
@@ -109,3 +129,4 @@ def factory(register):
     register(logging_checks.validate_log_translations)
     register(logging_checks.no_translate_debug_logs)
     register(logging_checks.accepted_log_levels)
+    register(use_jsonutils)

sahara/utils/openstack/base.py

@@ -13,9 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import json
-
 from oslo_config import cfg
+from oslo_serialization import jsonutils as json
 from six.moves.urllib import parse as urlparse
 
 from sahara import context