server-client-python/test/test_webhook.py at 5d9b1711a626c6a50f32f247ec21f1a5dc441d3c · jorwoods/server-client-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
from pathlib import Path

import pytest
import requests_mock

import tableauserverclient as TSC
from tableauserverclient.server import RequestFactory
from tableauserverclient.models import WebhookItem

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

GET_XML = TEST_ASSET_DIR / "webhook_get.xml"
CREATE_XML = TEST_ASSET_DIR / "webhook_create.xml"
CREATE_REQUEST_XML = TEST_ASSET_DIR / "webhook_create_request.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.6"

    return server


def test_get(server: TSC.Server) -> None:
    response_xml = GET_XML.read_text()
    with requests_mock.mock() as m:
        m.get(server.webhooks.baseurl, text=response_xml)
        webhooks, _ = server.webhooks.get()
        assert len(webhooks) == 1
        webhook = webhooks[0]

        assert webhook.url == "url"
        assert webhook.event == "datasource-created"
        assert webhook.owner_id == "webhook_owner_luid"
        assert webhook.name == "webhook-name"
        assert webhook.id == "webhook-id"


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


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


def test_delete_missing_id(server: TSC.Server) -> None:
    with pytest.raises(ValueError):
        server.webhooks.delete("")


def test_test(server: TSC.Server) -> None:
    with requests_mock.mock() as m:
        m.get(server.webhooks.baseurl + "/ee8c6e70-43b6-11e6-af4f-f7b0d8e20760/test", status_code=200)
        server.webhooks.test("ee8c6e70-43b6-11e6-af4f-f7b0d8e20760")


def test_create(server: TSC.Server) -> None:
    response_xml = CREATE_XML.read_text()
    with requests_mock.mock() as m:
        m.post(server.webhooks.baseurl, text=response_xml)
        webhook_model = TSC.WebhookItem()
        webhook_model.name = "Test Webhook"
        webhook_model.url = "https://ifttt.com/maker-url"
        webhook_model.event = "datasource-created"

        new_webhook = server.webhooks.create(webhook_model)

        assert new_webhook.id is not None


def test_request_factory():
    webhook_request_expected = CREATE_REQUEST_XML.read_text()

    webhook_item = WebhookItem()
    webhook_item._set_values("webhook-id", "webhook-name", "url", "api-event-name", None)
    webhook_request_actual = "{}\n".format(RequestFactory.Webhook.create_req(webhook_item).decode("utf-8"))
    # windows does /r/n for linebreaks, remove the extra char if it is there
    assert webhook_request_expected.replace("\r", "") == webhook_request_actual