fix: Calling commit and _json_body make raising an exception when any datapoints are not added. (influxdata#772)

ocworld · web-flow · commit 6f73ea12d7d9 · 2020-04-10T12:33:14.000-05:00
* If any SerialHelper is not generated, calling the commit function makes raising an exception because _datapoints is not allocated.

It is hard to find the reason of this error. it is because reviewing influxdb-python's code is needed.

I think that it is important that is producing predictable results. Results when calling first time is needed to equal to calling resetting datapoints in json_body.

So, I've fixed that if not initialized when calling _json_body() function, _datapoints is reset to avoid raising error.

In Unittest, the setup function is added. When calling setup function firstly, __initialized__ is False and _datapoints is not assigned. But, because of this commit, it is OK.

Contacts: Keunhyun Oh &lt;keunhyun.oh@ahnlab.com&gt;

* fix build fail

Contacts: Keunhyun Oh &lt;keunhyun.oh@ahnlab.com&gt;

* fix build fail

Contacts: Keunhyun Oh &lt;keunhyun.oh@ahnlab.com&gt;

* fix build fail

Contacts: Keunhyun Oh &lt;keunhyun.oh@ahnlab.com&gt;

* Update helper_test.py

* Update helper_test.py

* Update helper_test.py
diff --git a/influxdb/helper.py b/influxdb/helper.py
@@ -174,6 +174,8 @@ def _json_body_(cls):
         :return: JSON body of these datapoints.
         """
         json = []
+        if not cls.__initialized__:
+            cls._reset_()
         for series_name, data in six.iteritems(cls._datapoints):
             for point in data:
                 json_point = {
diff --git a/influxdb/influxdb08/helper.py b/influxdb/influxdb08/helper.py
@@ -139,6 +139,8 @@ def _json_body_(cls):
         :return: JSON body of the datapoints.
         """
         json = []
+        if not cls.__initialized__:
+            cls._reset_()
         for series_name, data in six.iteritems(cls._datapoints):
             json.append({'name': series_name,
                          'columns': cls._fields,
diff --git a/influxdb/tests/helper_test.py b/influxdb/tests/helper_test.py
@@ -47,6 +47,14 @@ class Meta:
 
         TestSeriesHelper.MySeriesHelper = MySeriesHelper
 
+    def setUp(self):
+        """Check that MySeriesHelper has empty datapoints."""
+        super(TestSeriesHelper, self).setUp()
+        self.assertEqual(
+            TestSeriesHelper.MySeriesHelper._json_body_(),
+            [],
+            'Resetting helper in teardown did not empty datapoints.')
+
     def tearDown(self):
         """Deconstruct the TestSeriesHelper object."""
         super(TestSeriesHelper, self).tearDown()
