def test_online_query_product_single_page_results(self):
cisco_eox_api = CiscoEoxApi()
cisco_eox_api.load_client_credentials()
cisco_eox_api.create_temporary_access_token()
assert cisco_eox_api.get_eox_records() == []
assert cisco_eox_api.amount_of_pages() == 0
assert cisco_eox_api.get_current_page() == 0
assert cisco_eox_api.amount_of_total_records() == 0
assert cisco_eox_api.get_page_record_count() == 0
jresult = cisco_eox_api.query_product(self.TEST_QUERY, 1)
assert "EOXRecord" in jresult
assert "PaginationResponseRecord" in jresult
assert len(jresult["EOXRecord"]) == 1
assert cisco_eox_api.get_eox_records() == jresult["EOXRecord"]
assert cisco_eox_api.amount_of_pages() == 1
assert cisco_eox_api.get_current_page() == 1
assert cisco_eox_api.amount_of_total_records() == 1
assert cisco_eox_api.get_page_record_count() == 1
assert cisco_eox_api.has_api_error() is False
assert cisco_eox_api.get_api_error_message() == "no error"
assert cisco_eox_api.get_error_description(
jresult["EOXRecord"][0]) == ""
assert cisco_eox_api.get_error_description(
jresult["EOXRecord"][0]) == ""
assert self.EXPECTED_VALID_TEST_QUERY_RESPONSE == jresult
assert cisco_eox_api.get_eox_records(
) == self.EXPECTED_VALID_TEST_QUERY_RESPONSE["EOXRecord"]
def test_offline_query_product_multiple_page_results(self, monkeypatch):
class MockSessionPageOne:
_first_call = False
def get(self, *args, **kwargs):
r = Response()
r.status_code = 200
if not self._first_call:
with open("app/ciscoeox/tests/data/cisco_eox_response_page_1_of_2.json") as f:
r._content = f.read().encode("utf-8")
self._first_call = True
else:
with open("app/ciscoeox/tests/data/cisco_eox_response_page_2_of_2.json") as f:
r._content = f.read().encode("utf-8")
return r
monkeypatch.setattr(requests, "Session", MockSessionPageOne)
cisco_eox_api = CiscoEoxApi()
monkeypatch.setattr(cisco_eox_api, "create_temporary_access_token", lambda force_new_token=True: mock_access_token_generation())
cisco_eox_api.load_client_credentials()
cisco_eox_api.create_temporary_access_token()
assert cisco_eox_api.get_eox_records() == []
assert cisco_eox_api.amount_of_pages() == 0
assert cisco_eox_api.get_current_page() == 0
assert cisco_eox_api.amount_of_total_records() == 0
assert cisco_eox_api.get_page_record_count() == 0
jresult = cisco_eox_api.query_product(self.TEST_QUERY, 1)
assert "EOXRecord" in jresult
assert "PaginationResponseRecord" in jresult
assert len(jresult["EOXRecord"]) == 2
assert cisco_eox_api.get_eox_records() == jresult["EOXRecord"]
assert cisco_eox_api.amount_of_pages() == 2
assert cisco_eox_api.get_current_page() == 1
assert cisco_eox_api.amount_of_total_records() == 3
assert cisco_eox_api.get_page_record_count() == 2
assert cisco_eox_api.has_api_error() is False
assert cisco_eox_api.get_api_error_message() == "no error"
assert cisco_eox_api.get_error_description(jresult["EOXRecord"][0]) == ""
assert cisco_eox_api.get_error_description(jresult["EOXRecord"][0]) == ""
jresult = cisco_eox_api.query_product(self.TEST_QUERY, 2)
assert "EOXRecord" in jresult
assert "PaginationResponseRecord" in jresult
assert len(jresult["EOXRecord"]) == 1
assert cisco_eox_api.get_eox_records() == jresult["EOXRecord"]
assert cisco_eox_api.amount_of_pages() == 2
assert cisco_eox_api.get_current_page() == 2
assert cisco_eox_api.amount_of_total_records() == 3
assert cisco_eox_api.get_page_record_count() == 1
assert cisco_eox_api.has_api_error() is False
assert cisco_eox_api.get_api_error_message() == "no error"
assert cisco_eox_api.get_error_description(jresult["EOXRecord"][0]) == ""
assert cisco_eox_api.get_error_description(jresult["EOXRecord"][0]) == ""
def test_offline_query_product_multiple_page_results(self, monkeypatch):
def mock_response_page_1():
r = Response()
r.status_code = 200
with open("app/ciscoeox/tests/data/cisco_eox_response_page_1_of_2.json") as f:
r._content = f.read().encode("utf-8")
return r
def mock_response_page_2():
r = Response()
r.status_code = 200
with open("app/ciscoeox/tests/data/cisco_eox_response_page_2_of_2.json") as f:
r._content = f.read().encode("utf-8")
return r
monkeypatch.setattr(requests, "get", lambda x, headers: mock_response_page_1())
cisco_eox_api = CiscoEoxApi()
monkeypatch.setattr(cisco_eox_api, "create_temporary_access_token", lambda force_new_token=True: mock_access_token_generation())
cisco_eox_api.load_client_credentials()
cisco_eox_api.create_temporary_access_token()
assert cisco_eox_api.get_eox_records() == []
assert cisco_eox_api.amount_of_pages() == 0
assert cisco_eox_api.get_current_page() == 0
assert cisco_eox_api.amount_of_total_records() == 0
assert cisco_eox_api.get_page_record_count() == 0
jresult = cisco_eox_api.query_product(self.TEST_QUERY, 1)
assert "EOXRecord" in jresult
assert "PaginationResponseRecord" in jresult
assert len(jresult["EOXRecord"]) == 2
assert cisco_eox_api.get_eox_records() == jresult["EOXRecord"]
assert cisco_eox_api.amount_of_pages() == 2
assert cisco_eox_api.get_current_page() == 1
assert cisco_eox_api.amount_of_total_records() == 3
assert cisco_eox_api.get_page_record_count() == 2
assert cisco_eox_api.has_api_error() is False
assert cisco_eox_api.get_api_error_message() == "no error"
assert cisco_eox_api.get_error_description(jresult["EOXRecord"][0]) == ""
assert cisco_eox_api.get_error_description(jresult["EOXRecord"][0]) == ""
monkeypatch.setattr(requests, "get", lambda x, headers: mock_response_page_2())
jresult = cisco_eox_api.query_product(self.TEST_QUERY, 2)
assert "EOXRecord" in jresult
assert "PaginationResponseRecord" in jresult
assert len(jresult["EOXRecord"]) == 1
assert cisco_eox_api.get_eox_records() == jresult["EOXRecord"]
assert cisco_eox_api.amount_of_pages() == 2
assert cisco_eox_api.get_current_page() == 2
assert cisco_eox_api.amount_of_total_records() == 3
assert cisco_eox_api.get_page_record_count() == 1
assert cisco_eox_api.has_api_error() is False
assert cisco_eox_api.get_api_error_message() == "no error"
assert cisco_eox_api.get_error_description(jresult["EOXRecord"][0]) == ""
assert cisco_eox_api.get_error_description(jresult["EOXRecord"][0]) == ""
def test_online_query_product_single_page_results(self):
cisco_eox_api = CiscoEoxApi()
cisco_eox_api.load_client_credentials()
cisco_eox_api.create_temporary_access_token()
assert cisco_eox_api.get_eox_records() == []
assert cisco_eox_api.amount_of_pages() == 0
assert cisco_eox_api.get_current_page() == 0
assert cisco_eox_api.amount_of_total_records() == 0
assert cisco_eox_api.get_page_record_count() == 0
jresult = cisco_eox_api.query_product(self.TEST_QUERY, 1)
assert "EOXRecord" in jresult
assert "PaginationResponseRecord" in jresult
assert len(jresult["EOXRecord"]) == 1
assert cisco_eox_api.get_eox_records() == jresult["EOXRecord"]
assert cisco_eox_api.amount_of_pages() == 1
assert cisco_eox_api.get_current_page() == 1
assert cisco_eox_api.amount_of_total_records() == 1
assert cisco_eox_api.get_page_record_count() == 1
assert cisco_eox_api.has_api_error() is False
assert cisco_eox_api.get_api_error_message() == "no error"
assert cisco_eox_api.get_error_description(jresult["EOXRecord"][0]) == ""
assert cisco_eox_api.get_error_description(jresult["EOXRecord"][0]) == ""
assert self.EXPECTED_VALID_TEST_QUERY_RESPONSE == jresult
assert cisco_eox_api.get_eox_records() == self.EXPECTED_VALID_TEST_QUERY_RESPONSE["EOXRecord"]
def test_offline_query_product_single_page_results(self, monkeypatch):
def mock_response():
r = Response()
r.status_code = 200
with open(
"app/ciscoeox/tests/data/cisco_eox_response_page_1_of_1.json"
) as f:
r._content = f.read().encode("utf-8")
return r
monkeypatch.setattr(requests, "get",
lambda x, headers: mock_response())
cisco_eox_api = CiscoEoxApi()
monkeypatch.setattr(
cisco_eox_api,
"create_temporary_access_token",
lambda force_new_token=True: mock_access_token_generation())
cisco_eox_api.load_client_credentials()
cisco_eox_api.create_temporary_access_token()
assert cisco_eox_api.get_eox_records() == []
assert cisco_eox_api.amount_of_pages() == 0
assert cisco_eox_api.get_current_page() == 0
assert cisco_eox_api.amount_of_total_records() == 0
assert cisco_eox_api.get_page_record_count() == 0
jresult = cisco_eox_api.query_product(self.TEST_QUERY, 1)
assert "EOXRecord" in jresult
assert "PaginationResponseRecord" in jresult
assert len(jresult["EOXRecord"]) == 3
assert cisco_eox_api.get_eox_records() == jresult["EOXRecord"]
assert cisco_eox_api.amount_of_pages() == 1
assert cisco_eox_api.get_current_page() == 1
assert cisco_eox_api.amount_of_total_records() == 3
assert cisco_eox_api.get_page_record_count() == 3
assert cisco_eox_api.has_api_error() is False
assert cisco_eox_api.get_api_error_message() == "no error"
assert cisco_eox_api.get_error_description(
jresult["EOXRecord"][0]) == ""
assert cisco_eox_api.get_error_description(
jresult["EOXRecord"][0]) == ""
def query_cisco_eox_api(query_string, blacklist, create_missing=False):
"""
execute a query against the Cisco API and updates the local database if the product
is not defined as blacklisted.
:param query_string: query that is executed
:param blacklist: list of strings that shouldn't be imported to the database
:param create_missing:
:return:
"""
eoxapi = CiscoEoxApi()
eoxapi.load_client_credentials()
results = []
try:
max_pages = 999
current_page = 1
result_pages = 0
while current_page <= max_pages:
logger.info("Executing API query '%s' on page '%d" %
(query_string, current_page))
eoxapi.query_product(product_id=query_string, page=current_page)
if current_page == 1:
result_pages = eoxapi.amount_of_pages()
logger.info("Initial query returns %d page(s)" % result_pages)
records = eoxapi.get_eox_records()
# check for errors
if eoxapi.has_error(records[0]):
logger.info(
"Query '%s' returns no valid values: %s" %
(query_string, eoxapi.get_error_description(records[0])))
else:
# check that the query has valid results
if eoxapi.get_valid_record_count() > 0:
# processing records
for record in records:
result_record = {}
pid = record['EOLProductID']
result_record["PID"] = pid
result_record["created"] = False
result_record["updated"] = False
result_record["message"] = None
logger.info("processing product '%s'..." % pid)
# check if record is product of the blacklist
if pid not in blacklist:
res = update_local_db_based_on_record(
record, create_missing)
res["blacklist"] = False
result_record.update(res)
else:
logger.info(
"Product '%s' blacklisted... no further processing"
% pid)
result_record.update({"blacklist": True})
results.append(result_record)
else:
logger.warn("Query '%s' returns no valid values" %
query_string)
if current_page == result_pages:
break
else:
current_page += 1
except ConnectionFailedException:
logger.error("connection for query failed: %s" % query_string,
exc_info=True)
raise
except CiscoApiCallFailed:
logger.fatal("query failed: %s" % query_string, exc_info=True)
raise
return results
