Skip to content

chore: pytestify jobs #1686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open

chore: pytestify jobs #1686

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
314 changes: 165 additions & 149 deletions test/test_job.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,158 +1,174 @@
import os
import unittest
from datetime import datetime
from pathlib import Path

import pytest
import requests_mock

import tableauserverclient as TSC
from tableauserverclient.datetime_helpers import utc
from tableauserverclient.server.endpoint.exceptions import JobFailedException
from ._utils import read_xml_asset, mocked_time

GET_XML = "job_get.xml"
GET_BY_ID_XML = "job_get_by_id.xml"
GET_BY_ID_COMPLETED_XML = "job_get_by_id_completed.xml"
GET_BY_ID_FAILED_XML = "job_get_by_id_failed.xml"
GET_BY_ID_CANCELLED_XML = "job_get_by_id_cancelled.xml"
GET_BY_ID_INPROGRESS_XML = "job_get_by_id_inprogress.xml"
GET_BY_ID_WORKBOOK = "job_get_by_id_failed_workbook.xml"


class JobTests(unittest.TestCase):
def setUp(self) -> None:
self.server = TSC.Server("http://test", False)
self.server.version = "3.1"

# Fake signin
self.server._site_id = "dad65087-b08b-4603-af4e-2887b8aafc67"
self.server._auth_token = "j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM"

self.baseurl = self.server.jobs.baseurl

def test_get(self) -> None:
response_xml = read_xml_asset(GET_XML)
with requests_mock.mock() as m:
m.get(self.baseurl, text=response_xml)
all_jobs, pagination_item = self.server.jobs.get()
job = all_jobs[0]
created_at = datetime(2018, 5, 22, 13, 0, 29, tzinfo=utc)
started_at = datetime(2018, 5, 22, 13, 0, 37, tzinfo=utc)
ended_at = datetime(2018, 5, 22, 13, 0, 45, tzinfo=utc)

self.assertEqual(1, pagination_item.total_available)
self.assertEqual("2eef4225-aa0c-41c4-8662-a76d89ed7336", job.id)
self.assertEqual("Success", job.status)
self.assertEqual("50", job.priority)
self.assertEqual("single_subscription_notify", job.type)
self.assertEqual(created_at, job.created_at)
self.assertEqual(started_at, job.started_at)
self.assertEqual(ended_at, job.ended_at)

def test_get_by_id(self) -> None:
response_xml = read_xml_asset(GET_BY_ID_XML)
job_id = "2eef4225-aa0c-41c4-8662-a76d89ed7336"
with requests_mock.mock() as m:
m.get(f"{self.baseurl}/{job_id}", text=response_xml)
job = self.server.jobs.get_by_id(job_id)
updated_at = datetime(2020, 5, 13, 20, 25, 18, tzinfo=utc)

self.assertEqual(job_id, job.id)
self.assertEqual(updated_at, job.updated_at)
self.assertListEqual(job.notes, ["Job detail notes"])

def test_get_before_signin(self) -> None:
self.server._auth_token = None
self.assertRaises(TSC.NotSignedInError, self.server.jobs.get)

def test_cancel_id(self) -> None:
with requests_mock.mock() as m:
m.put(self.baseurl + "/ee8c6e70-43b6-11e6-af4f-f7b0d8e20760", status_code=204)
self.server.jobs.cancel("ee8c6e70-43b6-11e6-af4f-f7b0d8e20760")

def test_cancel_item(self) -> None:
from ._utils import mocked_time


TEST_ASSET_DIR = Path(__file__).parent / "assets"
GET_XML = TEST_ASSET_DIR / "job_get.xml"
GET_BY_ID_XML = TEST_ASSET_DIR / "job_get_by_id.xml"
GET_BY_ID_COMPLETED_XML = TEST_ASSET_DIR / "job_get_by_id_completed.xml"
GET_BY_ID_FAILED_XML = TEST_ASSET_DIR / "job_get_by_id_failed.xml"
GET_BY_ID_CANCELLED_XML = TEST_ASSET_DIR / "job_get_by_id_cancelled.xml"
GET_BY_ID_INPROGRESS_XML = TEST_ASSET_DIR / "job_get_by_id_inprogress.xml"
GET_BY_ID_WORKBOOK = TEST_ASSET_DIR / "job_get_by_id_failed_workbook.xml"


@pytest.fixture(scope="function")
def server():
"""Fixture to create a TSC.Server instance for testing."""
server = TSC.Server("http://test", False)

# Fake signin
server._site_id = "dad65087-b08b-4603-af4e-2887b8aafc67"
server._auth_token = "j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM"
server.version = "3.1"

return server


def test_get(server: TSC.Server) -> None:
response_xml = GET_XML.read_text()
with requests_mock.mock() as m:
m.get(server.jobs.baseurl, text=response_xml)
all_jobs, pagination_item = server.jobs.get()
job = all_jobs[0]
created_at = datetime(2018, 5, 22, 13, 0, 29, tzinfo=utc)
started_at = datetime(2018, 5, 22, 13, 0, 37, tzinfo=utc)
job = TSC.JobItem("ee8c6e70-43b6-11e6-af4f-f7b0d8e20760", "backgroundJob", "0", created_at, started_at, None, 0)
with requests_mock.mock() as m:
m.put(self.baseurl + "/ee8c6e70-43b6-11e6-af4f-f7b0d8e20760", status_code=204)
self.server.jobs.cancel(job)

def test_wait_for_job_finished(self) -> None:
# Waiting for an already finished job, directly returns that job's info
response_xml = read_xml_asset(GET_BY_ID_XML)
job_id = "2eef4225-aa0c-41c4-8662-a76d89ed7336"
with mocked_time(), requests_mock.mock() as m:
m.get(f"{self.baseurl}/{job_id}", text=response_xml)
job = self.server.jobs.wait_for_job(job_id)

self.assertEqual(job_id, job.id)
self.assertListEqual(job.notes, ["Job detail notes"])

def test_wait_for_job_completed(self) -> None:
# Waiting for a bridge (cloud) job completion
response_xml = read_xml_asset(GET_BY_ID_COMPLETED_XML)
job_id = "2eef4225-aa0c-41c4-8662-a76d89ed7336"
with mocked_time(), requests_mock.mock() as m:
m.get(f"{self.baseurl}/{job_id}", text=response_xml)
job = self.server.jobs.wait_for_job(job_id)

self.assertEqual(job_id, job.id)
self.assertListEqual(job.notes, ["Job detail notes"])

def test_wait_for_job_failed(self) -> None:
# Waiting for a failed job raises an exception
response_xml = read_xml_asset(GET_BY_ID_FAILED_XML)
job_id = "77d5e57a-2517-479f-9a3c-a32025f2b64d"
with mocked_time(), requests_mock.mock() as m:
m.get(f"{self.baseurl}/{job_id}", text=response_xml)
with self.assertRaises(JobFailedException):
self.server.jobs.wait_for_job(job_id)

def test_wait_for_job_timeout(self) -> None:
# Waiting for a job which doesn't terminate will throw an exception
response_xml = read_xml_asset(GET_BY_ID_INPROGRESS_XML)
job_id = "77d5e57a-2517-479f-9a3c-a32025f2b64d"
with mocked_time(), requests_mock.mock() as m:
m.get(f"{self.baseurl}/{job_id}", text=response_xml)
with self.assertRaises(TimeoutError):
self.server.jobs.wait_for_job(job_id, timeout=30)

def test_get_job_datasource_id(self) -> None:
response_xml = read_xml_asset(GET_BY_ID_FAILED_XML)
job_id = "777bf7c4-421d-4b2c-a518-11b90187c545"
with requests_mock.mock() as m:
m.get(f"{self.baseurl}/{job_id}", text=response_xml)
job = self.server.jobs.get_by_id(job_id)
self.assertEqual(job.datasource_id, "03b9fbec-81f6-4160-ae49-5f9f6d412758")

def test_get_job_workbook_id(self) -> None:
response_xml = read_xml_asset(GET_BY_ID_WORKBOOK)
job_id = "bb1aab79-db54-4e96-9dd3-461d8f081d08"
with requests_mock.mock() as m:
m.get(f"{self.baseurl}/{job_id}", text=response_xml)
job = self.server.jobs.get_by_id(job_id)
self.assertEqual(job.workbook_id, "5998aaaf-1abe-4d38-b4d9-bc53e85bdd13")

def test_get_job_workbook_name(self) -> None:
response_xml = read_xml_asset(GET_BY_ID_WORKBOOK)
job_id = "bb1aab79-db54-4e96-9dd3-461d8f081d08"
with requests_mock.mock() as m:
m.get(f"{self.baseurl}/{job_id}", text=response_xml)
job = self.server.jobs.get_by_id(job_id)
self.assertEqual(job.workbook_name, "Superstore")

def test_get_job_datasource_name(self) -> None:
response_xml = read_xml_asset(GET_BY_ID_FAILED_XML)
job_id = "777bf7c4-421d-4b2c-a518-11b90187c545"
with requests_mock.mock() as m:
m.get(f"{self.baseurl}/{job_id}", text=response_xml)
job = self.server.jobs.get_by_id(job_id)
self.assertEqual(job.datasource_name, "World Indicators")

def test_background_job_str(self) -> None:
job = TSC.BackgroundJobItem(
"ee8c6e70-43b6-11e6-af4f-f7b0d8e20760", datetime.now(), 1, "extractRefresh", "Failed"
)
assert not str(job).startswith("<<property")
assert not repr(job).startswith("<<property")
assert "BackgroundJobItem" in str(job)
ended_at = datetime(2018, 5, 22, 13, 0, 45, tzinfo=utc)

assert 1 == pagination_item.total_available
assert "2eef4225-aa0c-41c4-8662-a76d89ed7336" == job.id
assert "Success" == job.status
assert "50" == job.priority
assert "single_subscription_notify" == job.type
assert created_at == job.created_at
assert started_at == job.started_at
assert ended_at == job.ended_at


def test_get_by_id(server: TSC.Server) -> None:
response_xml = GET_BY_ID_XML.read_text()
job_id = "2eef4225-aa0c-41c4-8662-a76d89ed7336"
with requests_mock.mock() as m:
m.get(f"{server.jobs.baseurl}/{job_id}", text=response_xml)
job = server.jobs.get_by_id(job_id)
updated_at = datetime(2020, 5, 13, 20, 25, 18, tzinfo=utc)

assert job_id == job.id
assert updated_at == job.updated_at
assert job.notes == ["Job detail notes"]


def test_get_before_signin(server: TSC.Server) -> None:
server._auth_token = None
with pytest.raises(TSC.NotSignedInError):
server.jobs.get()


def test_cancel_id(server: TSC.Server) -> None:
with requests_mock.mock() as m:
m.put(server.jobs.baseurl + "/ee8c6e70-43b6-11e6-af4f-f7b0d8e20760", status_code=204)
server.jobs.cancel("ee8c6e70-43b6-11e6-af4f-f7b0d8e20760")


def test_cancel_item(server: TSC.Server) -> None:
created_at = datetime(2018, 5, 22, 13, 0, 29, tzinfo=utc)
started_at = datetime(2018, 5, 22, 13, 0, 37, tzinfo=utc)
job = TSC.JobItem("ee8c6e70-43b6-11e6-af4f-f7b0d8e20760", "backgroundJob", "0", created_at, started_at, None, 0)
with requests_mock.mock() as m:
m.put(server.jobs.baseurl + "/ee8c6e70-43b6-11e6-af4f-f7b0d8e20760", status_code=204)
server.jobs.cancel(job)


def test_wait_for_job_finished(server: TSC.Server) -> None:
# Waiting for an already finished job, directly returns that job's info
response_xml = GET_BY_ID_XML.read_text()
job_id = "2eef4225-aa0c-41c4-8662-a76d89ed7336"
with mocked_time(), requests_mock.mock() as m:
m.get(f"{server.jobs.baseurl}/{job_id}", text=response_xml)
job = server.jobs.wait_for_job(job_id)

assert job_id == job.id
assert job.notes == ["Job detail notes"]


def test_wait_for_job_completed(server: TSC.Server) -> None:
# Waiting for a bridge (cloud) job completion
response_xml = GET_BY_ID_COMPLETED_XML.read_text()
job_id = "2eef4225-aa0c-41c4-8662-a76d89ed7336"
with mocked_time(), requests_mock.mock() as m:
m.get(f"{server.jobs.baseurl}/{job_id}", text=response_xml)
job = server.jobs.wait_for_job(job_id)

assert job_id == job.id
assert job.notes == ["Job detail notes"]


def test_wait_for_job_failed(server: TSC.Server) -> None:
# Waiting for a failed job raises an exception
response_xml = GET_BY_ID_FAILED_XML.read_text()
job_id = "77d5e57a-2517-479f-9a3c-a32025f2b64d"
with mocked_time(), requests_mock.mock() as m:
m.get(f"{server.jobs.baseurl}/{job_id}", text=response_xml)
with pytest.raises(JobFailedException):
server.jobs.wait_for_job(job_id)


def test_wait_for_job_timeout(server: TSC.Server) -> None:
# Waiting for a job which doesn't terminate will throw an exception
response_xml = GET_BY_ID_INPROGRESS_XML.read_text()
job_id = "77d5e57a-2517-479f-9a3c-a32025f2b64d"
with mocked_time(), requests_mock.mock() as m:
m.get(f"{server.jobs.baseurl}/{job_id}", text=response_xml)
with pytest.raises(TimeoutError):
server.jobs.wait_for_job(job_id, timeout=30)


def test_get_job_datasource_id(server: TSC.Server) -> None:
response_xml = GET_BY_ID_FAILED_XML.read_text()
job_id = "777bf7c4-421d-4b2c-a518-11b90187c545"
with requests_mock.mock() as m:
m.get(f"{server.jobs.baseurl}/{job_id}", text=response_xml)
job = server.jobs.get_by_id(job_id)
assert job.datasource_id == "03b9fbec-81f6-4160-ae49-5f9f6d412758"


def test_get_job_workbook_id(server: TSC.Server) -> None:
response_xml = GET_BY_ID_WORKBOOK.read_text()
job_id = "bb1aab79-db54-4e96-9dd3-461d8f081d08"
with requests_mock.mock() as m:
m.get(f"{server.jobs.baseurl}/{job_id}", text=response_xml)
job = server.jobs.get_by_id(job_id)
assert job.workbook_id == "5998aaaf-1abe-4d38-b4d9-bc53e85bdd13"


def test_get_job_workbook_name(server: TSC.Server) -> None:
response_xml = GET_BY_ID_WORKBOOK.read_text()
job_id = "bb1aab79-db54-4e96-9dd3-461d8f081d08"
with requests_mock.mock() as m:
m.get(f"{server.jobs.baseurl}/{job_id}", text=response_xml)
job = server.jobs.get_by_id(job_id)
assert job.workbook_name == "Superstore"


def test_get_job_datasource_name(server: TSC.Server) -> None:
response_xml = GET_BY_ID_FAILED_XML.read_text()
job_id = "777bf7c4-421d-4b2c-a518-11b90187c545"
with requests_mock.mock() as m:
m.get(f"{server.jobs.baseurl}/{job_id}", text=response_xml)
job = server.jobs.get_by_id(job_id)
assert job.datasource_name == "World Indicators"


def test_background_job_str() -> None:
job = TSC.BackgroundJobItem("ee8c6e70-43b6-11e6-af4f-f7b0d8e20760", datetime.now(), 1, "extractRefresh", "Failed")
assert not str(job).startswith("<<property")
assert not repr(job).startswith("<<property")
assert "BackgroundJobItem" in str(job)
Loading