forked from tableau/server-client-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_request_option.py
More file actions
232 lines (196 loc) · 11.3 KB
/
test_request_option.py
File metadata and controls
232 lines (196 loc) · 11.3 KB
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
import unittest
import os
import re
import requests
import requests_mock
import tableauserverclient as TSC
TEST_ASSET_DIR = os.path.join(os.path.dirname(__file__), 'assets')
PAGINATION_XML = os.path.join(TEST_ASSET_DIR, 'request_option_pagination.xml')
PAGE_NUMBER_XML = os.path.join(TEST_ASSET_DIR, 'request_option_page_number.xml')
PAGE_SIZE_XML = os.path.join(TEST_ASSET_DIR, 'request_option_page_size.xml')
FILTER_EQUALS = os.path.join(TEST_ASSET_DIR, 'request_option_filter_equals.xml')
FILTER_TAGS_IN = os.path.join(TEST_ASSET_DIR, 'request_option_filter_tags_in.xml')
FILTER_MULTIPLE = os.path.join(TEST_ASSET_DIR, 'request_option_filter_tags_in.xml')
class RequestOptionTests(unittest.TestCase):
def setUp(self):
self.server = TSC.Server('http://test')
# Fake signin
self.server.version = "3.10"
self.server._site_id = 'dad65087-b08b-4603-af4e-2887b8aafc67'
self.server._auth_token = 'j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM'
self.baseurl = '{0}/{1}'.format(self.server.sites.baseurl, self.server._site_id)
def test_pagination(self):
with open(PAGINATION_XML, 'rb') as f:
response_xml = f.read().decode('utf-8')
with requests_mock.mock() as m:
m.get(self.baseurl + '/views?pageNumber=1&pageSize=10', text=response_xml)
req_option = TSC.RequestOptions().page_size(10)
all_views, pagination_item = self.server.views.get(req_option)
self.assertEqual(1, pagination_item.page_number)
self.assertEqual(10, pagination_item.page_size)
self.assertEqual(33, pagination_item.total_available)
self.assertEqual(10, len(all_views))
def test_page_number(self):
with open(PAGE_NUMBER_XML, 'rb') as f:
response_xml = f.read().decode('utf-8')
with requests_mock.mock() as m:
m.get(self.baseurl + '/views?pageNumber=3', text=response_xml)
req_option = TSC.RequestOptions().page_number(3)
all_views, pagination_item = self.server.views.get(req_option)
self.assertEqual(3, pagination_item.page_number)
self.assertEqual(100, pagination_item.page_size)
self.assertEqual(210, pagination_item.total_available)
self.assertEqual(10, len(all_views))
def test_page_size(self):
with open(PAGE_SIZE_XML, 'rb') as f:
response_xml = f.read().decode('utf-8')
with requests_mock.mock() as m:
m.get(self.baseurl + '/views?pageSize=5', text=response_xml)
req_option = TSC.RequestOptions().page_size(5)
all_views, pagination_item = self.server.views.get(req_option)
self.assertEqual(1, pagination_item.page_number)
self.assertEqual(5, pagination_item.page_size)
self.assertEqual(33, pagination_item.total_available)
self.assertEqual(5, len(all_views))
def test_filter_equals(self):
with open(FILTER_EQUALS, 'rb') as f:
response_xml = f.read().decode('utf-8')
with requests_mock.mock() as m:
m.get(self.baseurl + '/workbooks?filter=name:eq:RESTAPISample', text=response_xml)
req_option = TSC.RequestOptions()
req_option.filter.add(TSC.Filter(TSC.RequestOptions.Field.Name,
TSC.RequestOptions.Operator.Equals, 'RESTAPISample'))
matching_workbooks, pagination_item = self.server.workbooks.get(req_option)
self.assertEqual(2, pagination_item.total_available)
self.assertEqual('RESTAPISample', matching_workbooks[0].name)
self.assertEqual('RESTAPISample', matching_workbooks[1].name)
def test_filter_equals_shorthand(self):
with open(FILTER_EQUALS, 'rb') as f:
response_xml = f.read().decode('utf-8')
with requests_mock.mock() as m:
m.get(self.baseurl + '/workbooks?filter=name:eq:RESTAPISample', text=response_xml)
matching_workbooks = self.server.workbooks.filter(name='RESTAPISample').order_by("name")
self.assertEqual(2, matching_workbooks.total_available)
self.assertEqual('RESTAPISample', matching_workbooks[0].name)
self.assertEqual('RESTAPISample', matching_workbooks[1].name)
def test_filter_tags_in(self):
with open(FILTER_TAGS_IN, 'rb') as f:
response_xml = f.read().decode('utf-8')
with requests_mock.mock() as m:
m.get(self.baseurl + '/workbooks?filter=tags:in:[sample,safari,weather]', text=response_xml)
req_option = TSC.RequestOptions()
req_option.filter.add(TSC.Filter(TSC.RequestOptions.Field.Tags, TSC.RequestOptions.Operator.In,
['sample', 'safari', 'weather']))
matching_workbooks, pagination_item = self.server.workbooks.get(req_option)
self.assertEqual(3, pagination_item.total_available)
self.assertEqual(set(['weather']), matching_workbooks[0].tags)
self.assertEqual(set(['safari']), matching_workbooks[1].tags)
self.assertEqual(set(['sample']), matching_workbooks[2].tags)
def test_filter_tags_in_shorthand(self):
with open(FILTER_TAGS_IN, 'rb') as f:
response_xml = f.read().decode('utf-8')
with requests_mock.mock() as m:
m.get(self.baseurl + '/workbooks?filter=tags:in:[sample,safari,weather]', text=response_xml)
matching_workbooks = self.server.workbooks.filter(tags__in=['sample', 'safari', 'weather'])
self.assertEqual(3, matching_workbooks.total_available)
self.assertEqual(set(['weather']), matching_workbooks[0].tags)
self.assertEqual(set(['safari']), matching_workbooks[1].tags)
self.assertEqual(set(['sample']), matching_workbooks[2].tags)
def test_invalid_shorthand_option(self):
with self.assertRaises(ValueError):
self.server.workbooks.filter(nonexistant__in=['sample', 'safari'])
def test_multiple_filter_options(self):
with open(FILTER_MULTIPLE, 'rb') as f:
response_xml = f.read().decode('utf-8')
# To ensure that this is deterministic, run this a few times
with requests_mock.mock() as m:
# Sometimes pep8 requires you to do things you might not otherwise do
url = ''.join((self.baseurl, '/workbooks?pageNumber=1&pageSize=100&',
'filter=name:eq:foo,tags:in:[sample,safari,weather]'))
m.get(url, text=response_xml)
req_option = TSC.RequestOptions()
req_option.filter.add(TSC.Filter(TSC.RequestOptions.Field.Tags, TSC.RequestOptions.Operator.In,
['sample', 'safari', 'weather']))
req_option.filter.add(TSC.Filter(TSC.RequestOptions.Field.Name, TSC.RequestOptions.Operator.Equals, 'foo'))
for _ in range(100):
matching_workbooks, pagination_item = self.server.workbooks.get(req_option)
self.assertEqual(3, pagination_item.total_available)
# Test req_options if url already has query params
def test_double_query_params(self):
with requests_mock.mock() as m:
m.get(requests_mock.ANY)
url = self.baseurl + "/views?queryParamExists=true"
opts = TSC.RequestOptions()
opts.filter.add(TSC.Filter(TSC.RequestOptions.Field.Tags,
TSC.RequestOptions.Operator.In,
['stocks', 'market']))
opts.sort.add(TSC.Sort(TSC.RequestOptions.Field.Name,
TSC.RequestOptions.Direction.Asc))
resp = self.server.workbooks.get_request(url, request_object=opts)
self.assertTrue(re.search('queryparamexists=true', resp.request.query))
self.assertTrue(re.search('filter=tags%3ain%3a%5bstocks%2cmarket%5d', resp.request.query))
self.assertTrue(re.search('sort=name%3aasc', resp.request.query))
# Test req_options for versions below 3.7
def test_filter_sort_legacy(self):
self.server.version = "3.6"
with requests_mock.mock() as m:
m.get(requests_mock.ANY)
url = self.baseurl + "/views?queryParamExists=true"
opts = TSC.RequestOptions()
opts.filter.add(TSC.Filter(TSC.RequestOptions.Field.Tags,
TSC.RequestOptions.Operator.In,
['stocks', 'market']))
opts.sort.add(TSC.Sort(TSC.RequestOptions.Field.Name,
TSC.RequestOptions.Direction.Asc))
resp = self.server.workbooks.get_request(url, request_object=opts)
self.assertTrue(re.search('queryparamexists=true', resp.request.query))
self.assertTrue(re.search('filter=tags:in:%5bstocks,market%5d', resp.request.query))
self.assertTrue(re.search('sort=name:asc', resp.request.query))
def test_vf(self):
with requests_mock.mock() as m:
m.get(requests_mock.ANY)
url = self.baseurl + "/views/456/data"
opts = TSC.PDFRequestOptions()
opts.vf("name1#", "value1")
opts.vf("name2$", "value2")
opts.page_type = TSC.PDFRequestOptions.PageType.Tabloid
resp = self.server.workbooks.get_request(url, request_object=opts)
self.assertTrue(re.search('vf_name1%23=value1', resp.request.query))
self.assertTrue(re.search('vf_name2%24=value2', resp.request.query))
self.assertTrue(re.search('type=tabloid', resp.request.query))
# Test req_options for versions beloe 3.7
def test_vf_legacy(self):
self.server.version = "3.6"
with requests_mock.mock() as m:
m.get(requests_mock.ANY)
url = self.baseurl + "/views/456/data"
opts = TSC.PDFRequestOptions()
opts.vf("name1@", "value1")
opts.vf("name2$", "value2")
opts.page_type = TSC.PDFRequestOptions.PageType.Tabloid
resp = self.server.workbooks.get_request(url, request_object=opts)
self.assertTrue(re.search('vf_name1@=value1', resp.request.query))
self.assertTrue(re.search('vf_name2\\$=value2', resp.request.query))
self.assertTrue(re.search('type=tabloid', resp.request.query))
def test_all_fields(self):
with requests_mock.mock() as m:
m.get(requests_mock.ANY)
url = self.baseurl + "/views/456/data"
opts = TSC.RequestOptions()
opts._all_fields = True
resp = self.server.users.get_request(url, request_object=opts)
self.assertTrue(re.search('fields=_all_', resp.request.query))
def test_multiple_filter_options_shorthand(self):
with open(FILTER_MULTIPLE, 'rb') as f:
response_xml = f.read().decode('utf-8')
# To ensure that this is deterministic, run this a few times
with requests_mock.mock() as m:
# Sometimes pep8 requires you to do things you might not otherwise do
url = ''.join((self.baseurl, '/workbooks?pageNumber=1&pageSize=100&',
'filter=name:eq:foo,tags:in:[sample,safari,weather]'))
m.get(url, text=response_xml)
for _ in range(100):
matching_workbooks = self.server.workbooks.filter(
tags__in=['sample', 'safari', 'weather'], name='foo'
)
self.assertEqual(3, matching_workbooks.total_available)