Skip to content

chore: pytestify test_database #1655

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

Merged
jacalata merged 1 commit into from
Oct 17, 2025
Merged

chore: pytestify test_database #1655

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
217 changes: 108 additions & 109 deletions test/test_database.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,113 +1,112 @@
import unittest
from pathlib import Path

import pytest
import requests_mock

import tableauserverclient as TSC
from ._utils import read_xml_asset, asset

GET_XML = "database_get.xml"
POPULATE_PERMISSIONS_XML = "database_populate_permissions.xml"
UPDATE_XML = "database_update.xml"
GET_DQW_BY_CONTENT = "dqw_by_content_type.xml"


class DatabaseTests(unittest.TestCase):
def setUp(self):
self.server = TSC.Server("http://test", False)
# Fake signin
self.server._site_id = "dad65087-b08b-4603-af4e-2887b8aafc67"
self.server._auth_token = "j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM"
self.server.version = "3.5"

self.baseurl = self.server.databases.baseurl

def test_get(self):
response_xml = read_xml_asset(GET_XML)
with requests_mock.mock() as m:
m.get(self.baseurl, text=response_xml)
all_databases, pagination_item = self.server.databases.get()

self.assertEqual(5, pagination_item.total_available)
self.assertEqual("5ea59b45-e497-4827-8809-bfe213236f75", all_databases[0].id)
self.assertEqual("hyper", all_databases[0].connection_type)
self.assertEqual("hyper_0.hyper", all_databases[0].name)

self.assertEqual("23591f2c-4802-4d6a-9e28-574a8ea9bc4c", all_databases[1].id)
self.assertEqual("sqlserver", all_databases[1].connection_type)
self.assertEqual("testv1", all_databases[1].name)
self.assertEqual("9324cf6b-ba72-4b8e-b895-ac3f28d2f0e0", all_databases[1].contact_id)
self.assertEqual(True, all_databases[1].certified)

def test_update(self):
response_xml = read_xml_asset(UPDATE_XML)
with requests_mock.mock() as m:
m.put(self.baseurl + "/23591f2c-4802-4d6a-9e28-574a8ea9bc4c", text=response_xml)
single_database = TSC.DatabaseItem("test")
single_database.contact_id = "9324cf6b-ba72-4b8e-b895-ac3f28d2f0e0"
single_database._id = "23591f2c-4802-4d6a-9e28-574a8ea9bc4c"
single_database.certified = True
single_database.certification_note = "Test"
single_database = self.server.databases.update(single_database)

self.assertEqual("23591f2c-4802-4d6a-9e28-574a8ea9bc4c", single_database.id)
self.assertEqual("9324cf6b-ba72-4b8e-b895-ac3f28d2f0e0", single_database.contact_id)
self.assertEqual(True, single_database.certified)
self.assertEqual("Test", single_database.certification_note)

def test_populate_permissions(self):
with open(asset(POPULATE_PERMISSIONS_XML), "rb") as f:
response_xml = f.read().decode("utf-8")
with requests_mock.mock() as m:
m.get(self.baseurl + "/0448d2ed-590d-4fa0-b272-a2a8a24555b5/permissions", text=response_xml)
single_database = TSC.DatabaseItem("test")
single_database._id = "0448d2ed-590d-4fa0-b272-a2a8a24555b5"

self.server.databases.populate_permissions(single_database)
permissions = single_database.permissions

self.assertEqual(permissions[0].grantee.tag_name, "group")
self.assertEqual(permissions[0].grantee.id, "5e5e1978-71fa-11e4-87dd-7382f5c437af")
self.assertDictEqual(
permissions[0].capabilities,
{
TSC.Permission.Capability.ChangePermissions: TSC.Permission.Mode.Deny,
TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow,
},
)

self.assertEqual(permissions[1].grantee.tag_name, "user")
self.assertEqual(permissions[1].grantee.id, "7c37ee24-c4b1-42b6-a154-eaeab7ee330a")
self.assertDictEqual(
permissions[1].capabilities,
{
TSC.Permission.Capability.Write: TSC.Permission.Mode.Allow,
},
)

def test_populate_data_quality_warning(self):
with open(asset(GET_DQW_BY_CONTENT), "rb") as f:
response_xml = f.read().decode("utf-8")
with requests_mock.mock() as m:
m.get(
self.server.databases._data_quality_warnings.baseurl + "/94441d26-9a52-4a42-b0fb-3f94792d1aac",
text=response_xml,
)
single_database = TSC.DatabaseItem("test")
single_database._id = "94441d26-9a52-4a42-b0fb-3f94792d1aac"

self.server.databases.populate_dqw(single_database)
dqws = single_database.dqws
first_dqw = dqws.pop()
self.assertEqual(first_dqw.id, "c2e0e406-84fb-4f4e-9998-f20dd9306710")
self.assertEqual(first_dqw.warning_type, "WARNING")
self.assertEqual(first_dqw.message, "Hello, World!")
self.assertEqual(first_dqw.owner_id, "eddc8c5f-6af0-40be-b6b0-2c790290a43f")
self.assertEqual(first_dqw.active, True)
self.assertEqual(first_dqw.severe, True)
self.assertEqual(str(first_dqw.created_at), "2021-04-09 18:39:54+00:00")
self.assertEqual(str(first_dqw.updated_at), "2021-04-09 18:39:54+00:00")

def test_delete(self):
with requests_mock.mock() as m:
m.delete(self.baseurl + "/0448d2ed-590d-4fa0-b272-a2a8a24555b5", status_code=204)
self.server.databases.delete("0448d2ed-590d-4fa0-b272-a2a8a24555b5")

TEST_ASSET_DIR = Path(__file__).parent / "assets"

GET_XML = TEST_ASSET_DIR / "database_get.xml"
POPULATE_PERMISSIONS_XML = TEST_ASSET_DIR / "database_populate_permissions.xml"
UPDATE_XML = TEST_ASSET_DIR / "database_update.xml"
GET_DQW_BY_CONTENT = TEST_ASSET_DIR / "dqw_by_content_type.xml"


@pytest.fixture(scope="function")
def server() -> TSC.Server:
server = TSC.Server("http://test", False)
# Fake signin
server._site_id = "dad65087-b08b-4603-af4e-2887b8aafc67"
server._auth_token = "j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM"
server.version = "3.5"

return server


def test_get(server):
response_xml = GET_XML.read_text()
with requests_mock.mock() as m:
m.get(server.databases.baseurl, text=response_xml)
all_databases, pagination_item = server.databases.get()

assert 5 == pagination_item.total_available
assert "5ea59b45-e497-4827-8809-bfe213236f75" == all_databases[0].id
assert "hyper" == all_databases[0].connection_type
assert "hyper_0.hyper" == all_databases[0].name

assert "23591f2c-4802-4d6a-9e28-574a8ea9bc4c" == all_databases[1].id
assert "sqlserver" == all_databases[1].connection_type
assert "testv1" == all_databases[1].name
assert "9324cf6b-ba72-4b8e-b895-ac3f28d2f0e0" == all_databases[1].contact_id
assert all_databases[1].certified


def test_update(server):
response_xml = UPDATE_XML.read_text()
with requests_mock.mock() as m:
m.put(server.databases.baseurl + "/23591f2c-4802-4d6a-9e28-574a8ea9bc4c", text=response_xml)
single_database = TSC.DatabaseItem("test")
single_database.contact_id = "9324cf6b-ba72-4b8e-b895-ac3f28d2f0e0"
single_database._id = "23591f2c-4802-4d6a-9e28-574a8ea9bc4c"
single_database.certified = True
single_database.certification_note = "Test"
single_database = server.databases.update(single_database)

assert "23591f2c-4802-4d6a-9e28-574a8ea9bc4c" == single_database.id
assert "9324cf6b-ba72-4b8e-b895-ac3f28d2f0e0" == single_database.contact_id
assert single_database.certified
assert "Test" == single_database.certification_note


def test_populate_permissions(server):
response_xml = POPULATE_PERMISSIONS_XML.read_text()
with requests_mock.mock() as m:
m.get(server.databases.baseurl + "/0448d2ed-590d-4fa0-b272-a2a8a24555b5/permissions", text=response_xml)
single_database = TSC.DatabaseItem("test")
single_database._id = "0448d2ed-590d-4fa0-b272-a2a8a24555b5"

server.databases.populate_permissions(single_database)
permissions = single_database.permissions

assert permissions[0].grantee.tag_name == "group"
assert permissions[0].grantee.id == "5e5e1978-71fa-11e4-87dd-7382f5c437af"
assert permissions[0].capabilities == {
TSC.Permission.Capability.ChangePermissions: TSC.Permission.Mode.Deny,
TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow,
}

assert permissions[1].grantee.tag_name == "user"
assert permissions[1].grantee.id == "7c37ee24-c4b1-42b6-a154-eaeab7ee330a"
assert permissions[1].capabilities == {
TSC.Permission.Capability.Write: TSC.Permission.Mode.Allow,
}


def test_populate_data_quality_warning(server):
response_xml = GET_DQW_BY_CONTENT.read_text()
with requests_mock.mock() as m:
m.get(
server.databases._data_quality_warnings.baseurl + "/94441d26-9a52-4a42-b0fb-3f94792d1aac",
text=response_xml,
)
single_database = TSC.DatabaseItem("test")
single_database._id = "94441d26-9a52-4a42-b0fb-3f94792d1aac"

server.databases.populate_dqw(single_database)
dqws = single_database.dqws
first_dqw = dqws.pop()
assert first_dqw.id == "c2e0e406-84fb-4f4e-9998-f20dd9306710"
assert first_dqw.warning_type == "WARNING"
assert first_dqw.message, "Hello == World!"
assert first_dqw.owner_id == "eddc8c5f-6af0-40be-b6b0-2c790290a43f"
assert first_dqw.active
assert first_dqw.severe
assert str(first_dqw.created_at) == "2021-04-09 18:39:54+00:00"
assert str(first_dqw.updated_at) == "2021-04-09 18:39:54+00:00"


def test_delete(server):
with requests_mock.mock() as m:
m.delete(server.databases.baseurl + "/0448d2ed-590d-4fa0-b272-a2a8a24555b5", status_code=204)
server.databases.delete("0448d2ed-590d-4fa0-b272-a2a8a24555b5")
Loading