def test_run_success_with_include_entities(self):
zendesk_task = ZendeskTicketsIncrementalExportTask()
url = "https://test.zendesk.com/api/v2/incremental/tickets/cursor.json?start_time=1&include=foo"
responses.add(
responses.GET,
url=url,
json={
"end_of_stream": True,
"after_url": "foo",
"after_cursor": "foo",
"tickets": [{
"ticket_id": 1,
"ticket_desc": "bar"
}],
"foo": [{
"key": "value"
}],
},
headers={"retry-after": "1"},
status=200,
)
tickets = zendesk_task.run(
subdomain="test",
email_address="*****@*****.**",
api_token="abc",
start_time=1,
include_entities=["foo"],
)
assert isinstance(tickets["tickets"], list)
assert {"ticket_id": 1, "ticket_desc": "bar"} in tickets["tickets"]
assert isinstance(tickets["foo"], list)
assert {"key": "value"} in tickets["foo"]
def test_run_with_start_time(self, caplog):
zendesk_task = ZendeskTicketsIncrementalExportTask(api_token="abc",
start_time=123)
with responses.RequestsMock() as rsps:
rsps.add(
responses.GET,
url=
"https://test.zendesk.com/api/v2/incremental/tickets/cursor.json?start_time=123",
json={
"end_of_stream": True,
"after_url": "foo",
"after_cursor": "foo",
"tickets": [],
},
headers={"retry-after": "1"},
status=200,
)
assert zendesk_task.api_token == "abc"
assert zendesk_task.start_time == 123
zendesk_task.run(
subdomain="test",
email_address="*****@*****.**",
)
def test_run_without_start_time_and_cursor_raises(self):
zendesk_task = ZendeskTicketsIncrementalExportTask()
msg_match = "Both `start_time` and `cursor` are missing."
with pytest.raises(ValueError, match=msg_match):
zendesk_task.run(api_token="abc",
subdomain="foo",
email_address="*****@*****.**")
def test_construciton_zendesk_tickets_incremental_export_no_values(self):
zendesk_task = ZendeskTicketsIncrementalExportTask()
assert zendesk_task.subdomain is None
assert zendesk_task.api_token is None
assert zendesk_task.api_token_env_var is None
assert zendesk_task.email_address is None
assert zendesk_task.start_time is None
assert zendesk_task.cursor is None
assert zendesk_task.exclude_deleted is False
assert zendesk_task.include_entities is None
def test_run_api_call_fail_raises(self):
zendesk_task = ZendeskTicketsIncrementalExportTask()
responses.add(
responses.GET,
url=
"https://test.zendesk.com/api/v2/incremental/tickets/cursor.json?start_time=123",
json={
"end_of_stream": False,
"after_url": "foo",
"after_cursor": "foo",
"tickets": [],
},
headers={"retry-after": "1"},
status=123,
)
msg_match = "Zendesk API call failed!"
with pytest.raises(FAIL, match=msg_match):
zendesk_task.run(
subdomain="test",
email_address="*****@*****.**",
api_token="abc",
start_time=123,
)
def test_construction_zendesk_tickets_incremental_export_with_values(self):
zendesk_task = ZendeskTicketsIncrementalExportTask(
subdomain="foo",
email_address="*****@*****.**",
api_token="secret",
api_token_env_var="secret_env_var",
start_time=123,
cursor="abc",
exclude_deleted=True,
include_entities=["a", "b"],
)
assert zendesk_task.subdomain == "foo"
assert zendesk_task.email_address == "*****@*****.**"
assert zendesk_task.api_token == "secret"
assert zendesk_task.api_token_env_var == "secret_env_var"
assert zendesk_task.start_time == 123
assert zendesk_task.cursor == "abc"
assert zendesk_task.exclude_deleted is True
assert zendesk_task.include_entities == ["a", "b"]
def test_run_without_email_address_raises(self):
zendesk_task = ZendeskTicketsIncrementalExportTask()
msg_match = "`email_address` is missing."
with pytest.raises(ValueError, match=msg_match):
zendesk_task.run(api_token="abc", subdomain="foo")
def test_run_without_api_token_and_missing_api_token_env_var_raises(self):
zendesk_task = ZendeskTicketsIncrementalExportTask(
api_token_env_var="abc")
msg_match = "`api_token` is missing and `api_token_env_var` not found."
with pytest.raises(ValueError, match=msg_match):
zendesk_task.run()
def test_run_without_api_token_and_api_token_env_var_raises(self):
zendesk_task = ZendeskTicketsIncrementalExportTask()
msg_match = "Both `api_token` and `api_token_env_var` are missing."
with pytest.raises(ValueError, match=msg_match):
zendesk_task.run()