--- /dev/null
+# Keep sorted
+import base64
+from collections import defaultdict
+import glob
+from hyper import HTTP20Connection
+#import inspect
+import json
+import logging
+import os
+import pytest
+import re
+
+#############
+# CONSTANTS #
+#############
+
+# Endpoint
+ADML_HOST = 'localhost'
+ADML_PORT = '8074'
+ADML_ENDPOINT = ADML_HOST + ':' + ADML_PORT
+ADML_URI_PREFIX = ''
+
+# Headers
+CONTENT_LENGTH = 'content-length'
+
+# Flow calculation throw admlf (ADML Flow) fixture:
+# flow = admlf.getId()
+#
+# For sequenced tests, the id is just a monotonically increased number from 1.
+# For parallel tests, this id is sequenced from 1 for every worker, then, globally,
+# this is a handicap to manage flow ids (tests ids) for ADML FSM (finite state machine).
+# We consider a base multiplier of 10000, so collisions would take place when workers
+# reserves more than 10000 flows. With a 'worst-case' assumption of `5 flows per test case`,
+# you should cover up to 5000 per worker. Anyway, feel free to increase this value,
+# specially if you are thinking in use pytest and ADML Agent for system tests.
+FLOW_BASE_MULTIPLIER = 10000
+
+######################
+# CLASSES & FIXTURES #
+######################
+
+class Sequencer(object):
+ def __init__(self, request):
+ self.sequence = 0
+ self.request = request
+
+ def __wid(self):
+ """
+ Returns the worker id, or 'master' if not parallel execution is done
+ """
+ wid = 'master'
+ if hasattr(self.request.config, 'slaveinput'):
+ wid = self.request.config.slaveinput['slaveid']
+
+ return wid
+
+ def getId(self):
+ """
+ Returns the next identifier value (monotonically increased in every call)
+ """
+ self.sequence += 1
+
+ wid = self.__wid()
+ if wid == "master":
+ return self.sequence
+
+ # Workers are named: wd0, wd1, wd2, etc.
+ wid_number = int(re.findall(r'\d+', wid)[0])
+
+ return FLOW_BASE_MULTIPLIER * wid_number + self.sequence
+
+
+
+@pytest.fixture(scope='session')
+def admlf(request):
+ """
+ ADML Flow
+ """
+ return Sequencer(request)
+
+
+
+# Logging
+class MyLogger:
+
+ # CRITICAL ERROR WARNING INFO DEBUG NOSET
+ def setLevelInfo(): logging.getLogger().setLevel(logging.INFO)
+ def setLevelDebug(): logging.getLogger().setLevel(logging.DEBUG)
+
+ def error(message): logging.getLogger().error(message)
+ def warning(message): logging.getLogger().warning(message)
+ def info(message): logging.getLogger().info(message)
+ def debug(message): logging.getLogger().debug(message)
+
+@pytest.fixture(scope='session')
+def mylogger():
+ return MyLogger
+
+MyLogger.logger = logging.getLogger('CT')
+
+# Base64 encoding:
+@pytest.fixture(scope='session')
+def b64_encode():
+ def encode(message):
+ message_bytes = message.encode('ascii')
+ base64_bytes = base64.b64encode(message_bytes)
+ return base64_bytes.decode('ascii')
+ return encode
+
+# Base64 decoding:
+@pytest.fixture(scope='session')
+def b64_decode():
+ def decode(base64_message):
+ base64_bytes = base64_message.encode('ascii')
+ message_bytes = base64.b64decode(base64_bytes)
+ return message_bytes.decode('ascii')
+ return decode
+
+# HTTP communication:
+class RestClient(object):
+ """A client helper to perform rest operations: GET, POST.
+
+ Attributes:
+ endpoint: server endpoint to make the HTTP2.0 connection
+ """
+
+ def __init__(self, endpoint):
+ """Return a RestClient object for ADML endpoint."""
+ self._endpoint = endpoint
+ self._ip = self._endpoint.split(':')[0]
+ self._connection = HTTP20Connection(host=self._endpoint)
+
+ def _log_http(self, kind, method, url, body, headers):
+ length = len(body) if body else 0
+ MyLogger.info(
+ '{} {}{} {} headers: {!s} data: {}:{!a}'.format(
+ method, self._endpoint, url, kind, headers, length, body))
+
+ def _log_request(self, method, url, body, headers):
+ self._log_http('REQUEST', method, url, body, headers)
+
+ def _log_response(self, method, url, response):
+ self._log_http(
+ 'RESPONSE:{}'.format(response["status"]), method, url,
+ response["body"], response["headers"])
+
+ #def log_event(self, level, log_msg):
+ # # Log caller function name and formated message
+ # MyLogger.logger.log(level, inspect.getouterframes(inspect.currentframe())[1].function + ': {!a}'.format(log_msg))
+
+ def parse(self, response):
+ response_body = response.read(decode_content=True).decode('utf-8')
+ if len(response_body) != 0:
+ response_body_dict = json.loads(response_body)
+ else:
+ response_body_dict = ''
+ response_data = { "status":response.status, "body":response_body_dict, "headers":response.headers }
+ return response_data
+
+ def request(self, requestMethod, requestUrl, requestBody=None, requestHeaders=None):
+ """
+ Returns response data dictionary with 'status', 'body' and 'headers'
+ """
+ requestBody = RestClient._pad_body_and_length(requestBody, requestHeaders)
+ self._log_request(requestMethod, requestUrl, requestBody, requestHeaders)
+ self._connection.request(method=requestMethod, url=requestUrl, body=requestBody, headers=requestHeaders)
+ response = self.parse(self._connection.get_response())
+ self._log_response(requestMethod, requestUrl, response)
+ return response
+
+ def _pad_body_and_length(requestBody, requestHeaders):
+ """Pad the body and adjust content-length if needed.
+ When the length of the body is multiple of 1024 this function appends
+ one space to the body and increases by one the content-length.
+
+ This is a workaround for hyper issue 355 [0].
+ The issue has been fixed but it has not been released yet.
+
+ [0]: https://github.com/Lukasa/hyper/issues/355
+
+ EXAMPLE
+ >>> body, headers = ' '*1024, { 'content-length':'41' }
+ >>> body = RestClient._pad_body_and_length(body, headers)
+ >>> ( len(body), headers['content-length'] )
+ (1025, '42')
+ """
+ if requestBody and 0 == (len(requestBody) % 1024):
+ logging.warning( "RestClient.request:" +
+ " padding body because" +
+ " its length ({})".format(len(requestBody)) +
+ " is multiple of 1024")
+ requestBody += " "
+ content_length = CONTENT_LENGTH
+ if requestHeaders and content_length in requestHeaders:
+ length = int(requestHeaders[content_length])
+ requestHeaders[content_length] = str(length+1)
+ return requestBody
+
+ def get(self, requestUrl):
+ return self.request('GET', requestUrl)
+
+ def post(self, requestUrl, requestBody = None, requestHeaders={'content-type': 'application/json'}):
+ return self.request('POST', requestUrl, requestBody, requestHeaders)
+
+ def postDict(self, requestUrl, requestBody = None, requestHeaders={'content-type': 'application/json'}):
+ """
+ Accepts request body as python dictionary
+ """
+ requestBodyJson = None
+ if requestBody: requestBodyJson = json.dumps(requestBody, indent=None, separators=(',', ':'))
+ return self.request('POST', requestUrl, requestBodyJson, requestHeaders)
+
+
+ #def delete(self, requestUrl):
+ # return self.request('DELETE', requestUrl)
+
+ def __assert_received_expected(self, received, expected, what):
+ match = (received == expected)
+ log = "Received {what}: {received} | Expected {what}: {expected}".format(received=received, expected=expected, what=what)
+ if match: MyLogger.info(log)
+ else: MyLogger.error(log)
+
+ assert match
+
+ def check_response_status(self, received, expected, **kwargs):
+ """
+ received: status code received (got from response data parsed, field 'status')
+ expected: status code expected
+ """
+ self.__assert_received_expected(received, expected, "status code")
+
+ #def check_expected_cause(self, response, **kwargs):
+ # """
+ # received: response data parsed where field 'body'->'cause' is analyzed
+ # kwargs: aditional regexp to match expected cause
+ # """
+ # if "expected_cause" in kwargs:
+ # received_content = response["body"]
+ # received_cause = received_content.get("cause", "")
+ # regular_expr_cause = kwargs["expected_cause"]
+ # regular_expr_flag = kwargs.get("regular_expression_flag", 0)
+ # matchObj = re.match(regular_expr_cause, received_cause, regular_expr_flag)
+ # log = 'Test error cause: "{}"~=/{}/.'.format(received_cause, regular_expr_cause)
+ # if matchObj: MyLogger.info(log)
+ # else: MyLogger.error(log)
+ #
+ # assert matchObj is not None
+
+ def check_response_body(self, received, expected, inputJsonString = False):
+ """
+ received: body content received (got from response data parsed, field 'body')
+ expected: body content expected
+ inputJsonString: input parameters as json string (default are python dictionaries)
+ """
+ if inputJsonString:
+ # Decode json:
+ received = json.loads(received)
+ expected = json.loads(expected)
+
+ self.__assert_received_expected(received, expected, "body")
+
+ def check_response_headers(self, received, expected):
+ """
+ received: headers received (got from response data parsed, field 'headers')
+ expected: headers expected
+ """
+ self.__assert_received_expected(received, expected, "headers")
+
+ def assert_response__status_body_headers(self, response, status, bodyDict, headersDict = None):
+ """
+ response: Response parsed data
+ status: numeric status code
+ body: body dictionary to match with
+ headers: headers dictionary to match with (by default, not checked: internally length and content-type application/json is verified)
+ """
+ self.check_response_status(response["status"], status)
+ self.check_response_body(response["body"], bodyDict)
+ if headersDict: self.check_response_headers(response["headers"], headersDict)
+
+
+ def close(self):
+ self._connection.close()
+
+
+# ADML Client simple fixture
+@pytest.fixture(scope='session')
+def admlc():
+ admlc = RestClient(ADML_ENDPOINT)
+ yield admlc
+ admlc.close()
+ print("ADMLC Teardown")
+
+@pytest.fixture(scope='session')
+def resources():
+ resourcesDict={}
+ MyLogger.info("Gathering test suite resources ...")
+ for resource in glob.glob('resources/*'):
+ f = open(resource, "r")
+ name = os.path.basename(resource)
+ resourcesDict[name] = f.read()
+ f.close()
+
+ def get_resources(key, **kwargs):
+ # Be careful with templates containing curly braces:
+ # https://stackoverflow.com/questions/5466451/how-can-i-print-literal-curly-brace-characters-in-python-string-and-also-use-fo
+ resource = resourcesDict[key]
+
+ if kwargs:
+ args = defaultdict (str, kwargs)
+ resource = resource.format_map(args)
+
+ return resource
+
+ yield get_resources
+
+################
+# Experimental #
+################
+
+REQUEST_BODY_DIAMETER_HEX = '''
+{{
+ "diameterHex":"{diameterHex}"
+}}'''
+
+REQUEST_BODY_NODE = {
+ "name":"{name}"
+}
+
+
+PARAMS = [
+ (ADML_URI_PREFIX, '/decode', REQUEST_BODY_DIAMETER_HEX, ADML_ENDPOINT),
+]
+
+# Share RestClient connection for all the tests: session-scoped fixture
+@pytest.fixture(scope="session", params=PARAMS)
+def request_data(request):
+ admlc = RestClient(request.param[3])
+ def get_request_data(**kwargs):
+ args = defaultdict (str, kwargs)
+ uri_prefix = request.param[0]
+ request_uri_suffix=request.param[1]
+ formatted_uri=uri_prefix + request_uri_suffix.format_map(args)
+ request_body=request.param[2]
+ formatted_request_body=request_body.format_map(args)
+ return formatted_uri,formatted_request_body,admlc
+
+ yield get_request_data
+ admlc.close()
+ print("RestClient Teardown")
+
+# Fixture usage example: requestUrl,requestBody,admlc = request_data(diameterHex="<hex content>")
+
projects / anna.git / blobdiff