From 29ded7bf6d3ca1d16e625f906399149236132fe1 Mon Sep 17 00:00:00 2001
From: Ching Kuo <igene@igene.tw>
Date: Thu, 1 Jul 2021 17:33:24 +0800
Subject: [PATCH] Enable Test Coverage and Add New Test

This commit enables code coverage and added unit tests for metrics
message verification.

Change-Id: I526c8ce8583f0df6cb0323e5ce6bc98ecf310f4f
---
 .gitignore                                    |  1 +
 oslo_metrics/message_type.py                  |  6 +-
 oslo_metrics/tests/test_message_validation.py | 71 +++++++++++++++++++
 test-requirements.txt                         |  1 +
 tox.ini                                       | 17 +++--
 5 files changed, 85 insertions(+), 11 deletions(-)
 create mode 100644 oslo_metrics/tests/test_message_validation.py

diff --git a/.gitignore b/.gitignore
index a61bd7e..3fa100e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -41,6 +41,7 @@ pip-log.txt
 .stestr/
 test.sock
 .venv
+cover/
 
 # Translations
 *.mo
diff --git a/oslo_metrics/message_type.py b/oslo_metrics/message_type.py
index e81f526..700ed98 100644
--- a/oslo_metrics/message_type.py
+++ b/oslo_metrics/message_type.py
@@ -17,11 +17,13 @@ import json
 
 
 class UnSupportedMetricActionError(Exception):
-    pass
+    def __init__(self, message=None):
+        self.message = message
 
 
 class MetricValidationError(Exception):
-    pass
+    def __init__(self, message=None):
+        self.message = message
 
 
 class MetricAction():
diff --git a/oslo_metrics/tests/test_message_validation.py b/oslo_metrics/tests/test_message_validation.py
new file mode 100644
index 0000000..6287e0d
--- /dev/null
+++ b/oslo_metrics/tests/test_message_validation.py
@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+"""
+test_message_validation
+--------------------
+Check that messages validation is working properly
+"""
+
+import json
+from oslo_metrics import message_type
+from oslotest import base
+
+
+class TestMetricValidation(base.BaseTestCase):
+    def setUp(self):
+        super(TestMetricValidation, self).setUp()
+
+    def assertRaisesWithMessage(self, message, func, *args, **kwargs):
+        try:
+            func(*args, **kwargs)
+            self.assertFail()
+        except Exception as e:
+            self.assertEqual(message, e.message)
+
+    def test_message_validation(self):
+        metric = dict()
+        message = "module should be specified"
+        self.assertRaisesWithMessage(
+            message, message_type.Metric.from_json, json.dumps(metric))
+
+        metric['module'] = "test"
+        message = "name should be specified"
+        self.assertRaisesWithMessage(
+            message, message_type.Metric.from_json, json.dumps(metric))
+
+        metric['name'] = "test"
+        message = "action should be specified"
+        self.assertRaisesWithMessage(
+            message, message_type.Metric.from_json, json.dumps(metric))
+
+        metric['action'] = "test"
+        message = "labels should be specified"
+        self.assertRaisesWithMessage(
+            message, message_type.Metric.from_json, json.dumps(metric))
+
+        metric['labels'] = "test_label"
+        message = "action need 'value' field"
+        self.assertRaisesWithMessage(
+            message, message_type.Metric.from_json, json.dumps(metric))
+
+        metric['action'] = {"value": "1"}
+        message = "action need 'action' field"
+        self.assertRaisesWithMessage(
+            message, message_type.Metric.from_json, json.dumps(metric))
+
+        metric['action']['action'] = "test"
+        message = "action should be choosen from ['inc', 'observe']"
+        self.assertRaisesWithMessage(
+            message, message_type.Metric.from_json, json.dumps(metric))
diff --git a/test-requirements.txt b/test-requirements.txt
index 0ca55ed..20bd7fe 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -6,3 +6,4 @@ oslotest>=3.2.0 # Apache-2.0
 # Bandit security code scanner
 bandit>=1.1.0,<1.6.0 # Apache-2.0
 stestr>=2.0.0 # Apache-2.0
+coverage!=4.4,>=4.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index 58b8196..5afd716 100644
--- a/tox.ini
+++ b/tox.ini
@@ -33,15 +33,14 @@ commands =
   rm -fr doc/build
   sphinx-build -W --keep-going -b html doc/source doc/build/html
 
-# NOTE(hberaud): Not yet activated
-#[testenv:cover]
-#setenv =
-#  PYTHON=coverage run --source oslo_cache --parallel-mode
-#commands =
-#  stestr run {posargs}
-#  coverage combine
-#  coverage html -d cover
-#  coverage xml -o cover/coverage.xml
+[testenv:cover]
+setenv =
+  PYTHON=coverage run --source oslo_metrics --parallel-mode
+commands =
+  stestr run {posargs}
+  coverage combine
+  coverage html -d cover
+  coverage xml -o cover/coverage.xml
 
 [flake8]
 show-source = True