def __init__(self, protocol, host, port, base_resource=None):
"""
Class constructor. Init default headers
:param protocol: API Protocol
:param host: API Host
:param port: API Port
:param base_resource: base uri resource (if exists)
:return: None
"""
self.init_headers()
self.rest_client = RestClient(protocol, host, port, base_resource)
def __init__(self,
protocol,
host,
port,
base_resource=None,
auth_token=None):
"""
Class constructor. Init default headers
:param protocol: API Protocol
:param host: API Host
:param port: API Port
:param base_resource: base uri resource (if exists)
:param auth_token: Pep Proxy auth token (only if required)
:return: None
"""
self.init_headers(auth_token=auth_token)
self.rest_client = RestClient(protocol, host, port, base_resource)
def __init__(self, protocol, host, port, base_resource=None):
"""
Class constructor. Init default headers
:param protocol: API Protocol
:param host: API Host
:param port: API Port
:param base_resource: base uri resource (if exists)
:return: None
"""
self.init_headers()
self.rest_client = RestClient(protocol, host, port, base_resource)
def __init__(self, protocol, host, port, base_resource=None, auth_token=None):
"""
Class constructor. Init default headers
:param protocol: API Protocol
:param host: API Host
:param port: API Port
:param base_resource: base uri resource (if exists)
:param auth_token: Pep Proxy auth token (only if required)
:return: None
"""
self.init_headers(auth_token=auth_token)
self.rest_client = RestClient(protocol, host, port, base_resource)
class NgsiAdapterClient:
headers = dict()
def __init__(self, protocol, host, port, base_resource=None):
"""
Class constructor. Init default headers
:param protocol: API Protocol
:param host: API Host
:param port: API Port
:param base_resource: base uri resource (if exists)
:return: None
"""
self.init_headers()
self.rest_client = RestClient(protocol, host, port, base_resource)
def init_headers(self,
content_type=HEADER_REPRESENTATION_TEXTPLAIN,
transaction_id=generate_transaction_id()):
"""
Init header to values (or default values)
:param content_type: Content-Type header value. By default text/plain
:param transaction_id: txId header value. By default, generated value by Utils.generate_transaction_id()
:return: None
"""
if content_type is None:
if HEADER_CONTENT_TYPE in self.headers:
del (self.headers[HEADER_CONTENT_TYPE])
else:
self.headers.update({HEADER_CONTENT_TYPE: content_type})
if transaction_id is None:
if HEADER_TRANSACTION_ID in self.headers:
del (self.headers[HEADER_TRANSACTION_ID])
else:
self.headers.update({HEADER_TRANSACTION_ID: transaction_id})
def set_headers(self, headers):
"""
Set header.
:param headers: Headers to be used by next request (dict)
:return: None
"""
self.headers = headers
def send_raw_data(self, raw_data, probe_name, entity_id, entity_type):
"""
Execute a well-formed POST request. All parameters are mandatory
:param raw_data: Raw probe data to send (string, text/plain)
:param probe_name: Parser to be used (string)
:param entity_id: Entity ID (string)
:param entity_type: Entity Type (string)
:return: HTTP Request response ('Requests' lib)
"""
logger.info(
"Sending raw data to NGSI-Adapter [Probe: %s, EntityId: %, EntityType: %s",
probe_name, entity_id, entity_type)
parameters = dict()
parameters.update({NGSI_ADAPTER_PARAMETER_ID: entity_id})
parameters.update({NGSI_ADAPTER_PARAMETER_TYPE: entity_type})
return self.rest_client.post(uri_pattern=NGSI_ADAPTER_URI_PARSER,
body=raw_data,
headers=self.headers,
parametersn=parameters,
probe_name=probe_name)
def send_raw_data_custom(self,
raw_data,
probe_name=None,
entity_id=None,
entity_type=None,
http_method=HTTP_VERB_POST):
"""
Execute a 'send_data' request (POST request by default). Should support all testing cases.
The generated request could be malformed (Testing purpose)
Parameters with None value will not be in the generated request (missing parameter).
:param raw_data: Raw probe data to send (string, text/plain)
:param probe_name: Parser to be used (string)
:param entity_id: Entity ID (string)
:param entity_type: Entity Type (string)
:param http_method: send raw data is a HTTP POST request but, for testing purposes could be interesting to use
another HTTP verb. By default is defined to 'post'
:return: HTTP Request response ('Requests' lib)
"""
logger.info(
"Sending raw data to NGSI-Adapter (custom operation for testing purpose)"
)
parameters = dict()
if entity_id is not None:
parameters.update({NGSI_ADAPTER_PARAMETER_ID: entity_id})
if entity_type is not None:
parameters.update({NGSI_ADAPTER_PARAMETER_TYPE: entity_type})
if probe_name is not None:
return self.rest_client.launch_request(
uri_pattern=NGSI_ADAPTER_URI_PARSER,
body=raw_data,
method=http_method,
headers=self.headers,
parameters=parameters,
probe_name=probe_name)
else:
return self.rest_client.launch_request(
uri_pattern=NGSI_ADAPTER_URI_BASE,
body=raw_data,
method=http_method,
headers=self.headers,
parameters=parameters)
class NgsiAdapterClient:
headers = dict()
def __init__(self, protocol, host, port, base_resource=None):
"""
Class constructor. Init default headers
:param protocol: API Protocol
:param host: API Host
:param port: API Port
:param base_resource: base uri resource (if exists)
:return: None
"""
self.init_headers()
self.rest_client = RestClient(protocol, host, port, base_resource)
def init_headers(self, content_type=HEADER_REPRESENTATION_TEXTPLAIN, transaction_id=generate_transaction_id()):
"""
Init header to values (or default values)
:param content_type: Content-Type header value. By default text/plain
:param transaction_id: txId header value. By default, generated value by Utils.generate_transaction_id()
:return: None
"""
if content_type is None:
if HEADER_CONTENT_TYPE in self.headers:
del(self.headers[HEADER_CONTENT_TYPE])
else:
self.headers.update({HEADER_CONTENT_TYPE: content_type})
if transaction_id is None:
if HEADER_TRANSACTION_ID in self.headers:
del(self.headers[HEADER_TRANSACTION_ID])
else:
self.headers.update({HEADER_TRANSACTION_ID: transaction_id})
def set_headers(self, headers):
"""
Set header.
:param headers: Headers to be used by next request (dict)
:return: None
"""
self.headers = headers
def send_raw_data(self, raw_data, probe_name, entity_id, entity_type):
"""
Execute a well-formed POST request. All parameters are mandatory
:param raw_data: Raw probe data to send (string, text/plain)
:param probe_name: Parser to be used (string)
:param entity_id: Entity ID (string)
:param entity_type: Entity Type (string)
:return: HTTP Request response ('Requests' lib)
"""
logger.info("Sending raw data to NGSI-Adapter [Probe: %s, EntityId: %, EntityType: %s", probe_name,
entity_id, entity_type)
parameters = dict()
parameters.update({NGSI_ADAPTER_PARAMETER_ID: entity_id})
parameters.update({NGSI_ADAPTER_PARAMETER_TYPE: entity_type})
return self.rest_client.post(uri_pattern=NGSI_ADAPTER_URI_PARSER, body=raw_data, headers=self.headers,
parametersn=parameters, probe_name=probe_name)
def send_raw_data_custom(self, raw_data, probe_name=None, entity_id=None, entity_type=None,
http_method=HTTP_VERB_POST):
"""
Execute a 'send_data' request (POST request by default). Should support all testing cases.
The generated request could be malformed (Testing purpose)
Parameters with None value will not be in the generated request (missing parameter).
:param raw_data: Raw probe data to send (string, text/plain)
:param probe_name: Parser to be used (string)
:param entity_id: Entity ID (string)
:param entity_type: Entity Type (string)
:param http_method: send raw data is a HTTP POST request but, for testing purposes could be interesting to use
another HTTP verb. By default is defined to 'post'
:return: HTTP Request response ('Requests' lib)
"""
logger.info("Sending raw data to NGSI-Adapter (custom operation for testing purpose)")
parameters = dict()
if entity_id is not None:
parameters.update({NGSI_ADAPTER_PARAMETER_ID: entity_id})
if entity_type is not None:
parameters.update({NGSI_ADAPTER_PARAMETER_TYPE: entity_type})
if probe_name is not None:
return self.rest_client.launch_request(uri_pattern=NGSI_ADAPTER_URI_PARSER, body=raw_data,
method=http_method, headers=self.headers, parameters=parameters,
probe_name=probe_name)
else:
return self.rest_client.launch_request(uri_pattern=NGSI_ADAPTER_URI_BASE, body=raw_data,
method=http_method, headers=self.headers, parameters=parameters)
