Fix rest_client's expected_success for non int status
rest_client's expected_success() method expect expected_code
and read_code as int and compare both.
But if read_code is non int then this method will not compare anything
and pass falsely.
condition "if read_code < 400:" makes comparision of both status code but
return the results. But if read_code is not int then this condition is
alse and it make this method pass wihtout any compariosion.
It is written in doc string that read_code should be int but if anyone try
to send non int then it might be false pass.
self.expected_success(200, '202') - pass. This is false pass.
read_code is usually a status code return from API which can be fetched as
string via dict element like resp['status'].
Some user tried to access that and faced the issue, one example of this
wrong usage is:
If01461617020f39b4da554b127e7b5e5fd704645
Change-Id: I3f4c58bdbb172805514831103927d3464d65d7f3
Closes-Bug: #1571443
diff --git a/tempest/lib/common/rest_client.py b/tempest/lib/common/rest_client.py
index d001d27..af19835 100644
--- a/tempest/lib/common/rest_client.py
+++ b/tempest/lib/common/rest_client.py
@@ -220,6 +220,10 @@
:raises exceptions.InvalidHttpSuccessCode: if the read code isn't an
expected http success code
"""
+ if not isinstance(read_code, int):
+ raise TypeError("'read_code' must be an int instead of (%s)"
+ % type(read_code))
+
assert_msg = ("This function only allowed to use for HTTP status"
"codes which explicitly defined in the RFC 7231 & 4918."
"{0} is not a defined Success Code!"
diff --git a/tempest/tests/lib/test_rest_client.py b/tempest/tests/lib/test_rest_client.py
index 90651b0..ca2c201 100644
--- a/tempest/tests/lib/test_rest_client.py
+++ b/tempest/tests/lib/test_rest_client.py
@@ -636,6 +636,24 @@
self.assertRaises(AssertionError, self.rest_client.expected_success,
expected_code, read_code)
+ def test_non_success_read_code_as_string(self):
+ expected_code = 202
+ read_code = '202'
+ self.assertRaises(TypeError, self.rest_client.expected_success,
+ expected_code, read_code)
+
+ def test_non_success_read_code_as_list(self):
+ expected_code = 202
+ read_code = [202]
+ self.assertRaises(TypeError, self.rest_client.expected_success,
+ expected_code, read_code)
+
+ def test_non_success_expected_code_as_non_int(self):
+ expected_code = ['201', 202]
+ read_code = 202
+ self.assertRaises(AssertionError, self.rest_client.expected_success,
+ expected_code, read_code)
+
class TestResponseBody(base.TestCase):