330 lines
12 KiB
Python
330 lines
12 KiB
Python
# Copyright 2015 Google Inc. All rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import unittest2
|
|
|
|
|
|
class TestQueryResults(unittest2.TestCase):
|
|
PROJECT = 'project'
|
|
JOB_NAME = 'job_name'
|
|
JOB_NAME = 'test-synchronous-query'
|
|
JOB_TYPE = 'query'
|
|
QUERY = 'select count(*) from persons'
|
|
TOKEN = 'TOKEN'
|
|
|
|
def _getTargetClass(self):
|
|
from gcloud.bigquery.query import QueryResults
|
|
return QueryResults
|
|
|
|
def _makeOne(self, *args, **kw):
|
|
return self._getTargetClass()(*args, **kw)
|
|
|
|
def _makeResource(self, complete=False):
|
|
resource = {
|
|
'jobReference': {
|
|
'projectId': self.PROJECT,
|
|
'jobId': self.JOB_NAME,
|
|
},
|
|
'jobComplete': complete,
|
|
'errors': [],
|
|
'schema': {
|
|
'fields': [
|
|
{'name': 'full_name', 'type': 'STRING', 'mode': 'REQURED'},
|
|
{'name': 'age', 'type': 'INTEGER', 'mode': 'REQURED'},
|
|
],
|
|
},
|
|
}
|
|
|
|
if complete:
|
|
resource['totalRows'] = 1000
|
|
resource['rows'] = [
|
|
{'f': [
|
|
{'v': 'Phred Phlyntstone'},
|
|
{'v': 32},
|
|
]},
|
|
{'f': [
|
|
{'v': 'Bharney Rhubble'},
|
|
{'v': 33},
|
|
]},
|
|
{'f': [
|
|
{'v': 'Wylma Phlyntstone'},
|
|
{'v': 29},
|
|
]},
|
|
{'f': [
|
|
{'v': 'Bhettye Rhubble'},
|
|
{'v': 27},
|
|
]},
|
|
]
|
|
resource['pageToken'] = self.TOKEN
|
|
resource['totalBytesProcessed'] = 100000
|
|
resource['cacheHit'] = False
|
|
|
|
return resource
|
|
|
|
def _verifySchema(self, query, resource):
|
|
from gcloud.bigquery.table import SchemaField
|
|
if 'schema' in resource:
|
|
fields = resource['schema']['fields']
|
|
self.assertEqual(len(query.schema), len(fields))
|
|
for found, expected in zip(query.schema, fields):
|
|
self.assertTrue(isinstance(found, SchemaField))
|
|
self.assertEqual(found.name, expected['name'])
|
|
self.assertEqual(found.field_type, expected['type'])
|
|
self.assertEqual(found.mode, expected['mode'])
|
|
self.assertEqual(found.description,
|
|
expected.get('description'))
|
|
self.assertEqual(found.fields, expected.get('fields'))
|
|
else:
|
|
self.assertTrue(query.schema is None)
|
|
|
|
def _verifyRows(self, query, resource):
|
|
expected = resource.get('rows')
|
|
if expected is None:
|
|
self.assertEqual(query.rows, [])
|
|
else:
|
|
found = query.rows
|
|
self.assertEqual(len(found), len(expected))
|
|
for f_row, e_row in zip(found, expected):
|
|
self.assertEqual(f_row,
|
|
tuple([cell['v'] for cell in e_row['f']]))
|
|
|
|
def _verifyResourceProperties(self, query, resource):
|
|
self.assertEqual(query.cache_hit, resource.get('cacheHit'))
|
|
self.assertEqual(query.complete, resource.get('jobComplete'))
|
|
self.assertEqual(query.errors, resource.get('errors'))
|
|
self.assertEqual(query.page_token, resource.get('pageToken'))
|
|
self.assertEqual(query.total_rows, resource.get('totalRows'))
|
|
self.assertEqual(query.total_bytes_processed,
|
|
resource.get('totalBytesProcessed'))
|
|
|
|
if 'jobReference' in resource:
|
|
self.assertEqual(query.name, resource['jobReference']['jobId'])
|
|
else:
|
|
self.assertTrue(query.name is None)
|
|
|
|
self._verifySchema(query, resource)
|
|
self._verifyRows(query, resource)
|
|
|
|
def test_ctor(self):
|
|
client = _Client(self.PROJECT)
|
|
query = self._makeOne(self.QUERY, client)
|
|
self.assertEqual(query.query, self.QUERY)
|
|
self.assertTrue(query._client is client)
|
|
|
|
self.assertTrue(query.cache_hit is None)
|
|
self.assertTrue(query.complete is None)
|
|
self.assertTrue(query.errors is None)
|
|
self.assertTrue(query.name is None)
|
|
self.assertTrue(query.page_token is None)
|
|
self.assertEqual(query.rows, [])
|
|
self.assertTrue(query.schema is None)
|
|
self.assertTrue(query.total_rows is None)
|
|
self.assertTrue(query.total_bytes_processed is None)
|
|
|
|
self.assertTrue(query.default_dataset is None)
|
|
self.assertTrue(query.max_results is None)
|
|
self.assertTrue(query.preserve_nulls is None)
|
|
self.assertTrue(query.use_query_cache is None)
|
|
|
|
def test_job_wo_jobid(self):
|
|
client = _Client(self.PROJECT)
|
|
query = self._makeOne(self.QUERY, client)
|
|
self.assertTrue(query.job is None)
|
|
|
|
def test_job_w_jobid(self):
|
|
from gcloud.bigquery.job import QueryJob
|
|
SERVER_GENERATED = 'SERVER_GENERATED'
|
|
client = _Client(self.PROJECT)
|
|
query = self._makeOne(self.QUERY, client)
|
|
query._properties['jobReference'] = {
|
|
'projectId': self.PROJECT,
|
|
'jobId': SERVER_GENERATED,
|
|
}
|
|
job = query.job
|
|
self.assertTrue(isinstance(job, QueryJob))
|
|
self.assertEqual(job.query, self.QUERY)
|
|
self.assertTrue(job._client is client)
|
|
self.assertEqual(job.name, SERVER_GENERATED)
|
|
fetched_later = query.job
|
|
self.assertTrue(fetched_later is job)
|
|
|
|
def test_schema(self):
|
|
client = _Client(self.PROJECT)
|
|
query = self._makeOne(self.QUERY, client)
|
|
self._verifyResourceProperties(query, {})
|
|
resource = {
|
|
'schema': {
|
|
'fields': [
|
|
{'name': 'full_name', 'type': 'STRING', 'mode': 'REQURED'},
|
|
{'name': 'age', 'type': 'INTEGER', 'mode': 'REQURED'},
|
|
],
|
|
},
|
|
}
|
|
query._set_properties(resource)
|
|
self._verifyResourceProperties(query, resource)
|
|
|
|
def test_run_w_bound_client(self):
|
|
PATH = 'projects/%s/queries' % self.PROJECT
|
|
RESOURCE = self._makeResource(complete=False)
|
|
conn = _Connection(RESOURCE)
|
|
client = _Client(project=self.PROJECT, connection=conn)
|
|
query = self._makeOne(self.QUERY, client)
|
|
|
|
query.run()
|
|
|
|
self.assertEqual(len(conn._requested), 1)
|
|
req = conn._requested[0]
|
|
self.assertEqual(req['method'], 'POST')
|
|
self.assertEqual(req['path'], '/%s' % PATH)
|
|
SENT = {'query': self.QUERY}
|
|
self.assertEqual(req['data'], SENT)
|
|
self._verifyResourceProperties(query, RESOURCE)
|
|
|
|
def test_run_w_alternate_client(self):
|
|
PATH = 'projects/%s/queries' % self.PROJECT
|
|
RESOURCE = self._makeResource(complete=True)
|
|
DATASET = 'test_dataset'
|
|
conn1 = _Connection()
|
|
client1 = _Client(project=self.PROJECT, connection=conn1)
|
|
conn2 = _Connection(RESOURCE)
|
|
client2 = _Client(project=self.PROJECT, connection=conn2)
|
|
query = self._makeOne(self.QUERY, client1)
|
|
|
|
query.default_dataset = client2.dataset(DATASET)
|
|
query.max_results = 100
|
|
query.preserve_nulls = True
|
|
query.timeout_ms = 20000
|
|
query.use_query_cache = False
|
|
query.dry_run = True
|
|
|
|
query.run(client=client2)
|
|
|
|
self.assertEqual(len(conn1._requested), 0)
|
|
self.assertEqual(len(conn2._requested), 1)
|
|
req = conn2._requested[0]
|
|
self.assertEqual(req['method'], 'POST')
|
|
self.assertEqual(req['path'], '/%s' % PATH)
|
|
SENT = {
|
|
'query': self.QUERY,
|
|
'defaultDataset': {
|
|
'projectId': self.PROJECT,
|
|
'datasetId': DATASET,
|
|
},
|
|
'dryRun': True,
|
|
'maxResults': 100,
|
|
'preserveNulls': True,
|
|
'timeoutMs': 20000,
|
|
'useQueryCache': False,
|
|
}
|
|
self.assertEqual(req['data'], SENT)
|
|
self._verifyResourceProperties(query, RESOURCE)
|
|
|
|
def test_fetch_data_query_not_yet_run(self):
|
|
conn = _Connection()
|
|
client = _Client(project=self.PROJECT, connection=conn)
|
|
query = self._makeOne(self.QUERY, client)
|
|
self.assertRaises(ValueError, query.fetch_data)
|
|
|
|
def test_fetch_data_w_bound_client(self):
|
|
PATH = 'projects/%s/queries/%s' % (self.PROJECT, self.JOB_NAME)
|
|
BEFORE = self._makeResource(complete=False)
|
|
AFTER = self._makeResource(complete=True)
|
|
|
|
conn = _Connection(AFTER)
|
|
client = _Client(project=self.PROJECT, connection=conn)
|
|
query = self._makeOne(self.QUERY, client)
|
|
query._set_properties(BEFORE)
|
|
self.assertFalse(query.complete)
|
|
|
|
rows, total_rows, page_token = query.fetch_data()
|
|
|
|
self.assertTrue(query.complete)
|
|
self.assertEqual(len(rows), 4)
|
|
self.assertEqual(rows[0], ('Phred Phlyntstone', 32))
|
|
self.assertEqual(rows[1], ('Bharney Rhubble', 33))
|
|
self.assertEqual(rows[2], ('Wylma Phlyntstone', 29))
|
|
self.assertEqual(rows[3], ('Bhettye Rhubble', 27))
|
|
self.assertEqual(total_rows, AFTER['totalRows'])
|
|
self.assertEqual(page_token, AFTER['pageToken'])
|
|
|
|
self.assertEqual(len(conn._requested), 1)
|
|
req = conn._requested[0]
|
|
self.assertEqual(req['method'], 'GET')
|
|
self.assertEqual(req['path'], '/%s' % PATH)
|
|
|
|
def test_fetch_data_w_alternate_client(self):
|
|
PATH = 'projects/%s/queries/%s' % (self.PROJECT, self.JOB_NAME)
|
|
MAX = 10
|
|
TOKEN = 'TOKEN'
|
|
START = 2257
|
|
TIMEOUT = 20000
|
|
BEFORE = self._makeResource(complete=False)
|
|
AFTER = self._makeResource(complete=True)
|
|
|
|
conn1 = _Connection()
|
|
client1 = _Client(project=self.PROJECT, connection=conn1)
|
|
conn2 = _Connection(AFTER)
|
|
client2 = _Client(project=self.PROJECT, connection=conn2)
|
|
query = self._makeOne(self.QUERY, client1)
|
|
query._set_properties(BEFORE)
|
|
self.assertFalse(query.complete)
|
|
|
|
rows, total_rows, page_token = query.fetch_data(
|
|
client=client2, max_results=MAX, page_token=TOKEN,
|
|
start_index=START, timeout_ms=TIMEOUT)
|
|
|
|
self.assertTrue(query.complete)
|
|
self.assertEqual(len(rows), 4)
|
|
self.assertEqual(rows[0], ('Phred Phlyntstone', 32))
|
|
self.assertEqual(rows[1], ('Bharney Rhubble', 33))
|
|
self.assertEqual(rows[2], ('Wylma Phlyntstone', 29))
|
|
self.assertEqual(rows[3], ('Bhettye Rhubble', 27))
|
|
self.assertEqual(total_rows, AFTER['totalRows'])
|
|
self.assertEqual(page_token, AFTER['pageToken'])
|
|
|
|
self.assertEqual(len(conn1._requested), 0)
|
|
self.assertEqual(len(conn2._requested), 1)
|
|
req = conn2._requested[0]
|
|
self.assertEqual(req['method'], 'GET')
|
|
self.assertEqual(req['path'], '/%s' % PATH)
|
|
self.assertEqual(req['query_params'],
|
|
{'maxResults': MAX,
|
|
'pageToken': TOKEN,
|
|
'startIndex': START,
|
|
'timeoutMs': TIMEOUT})
|
|
|
|
|
|
class _Client(object):
|
|
|
|
def __init__(self, project='project', connection=None):
|
|
self.project = project
|
|
self.connection = connection
|
|
|
|
def dataset(self, name):
|
|
from gcloud.bigquery.dataset import Dataset
|
|
return Dataset(name, client=self)
|
|
|
|
|
|
class _Connection(object):
|
|
|
|
def __init__(self, *responses):
|
|
self._responses = responses
|
|
self._requested = []
|
|
|
|
def api_request(self, **kw):
|
|
from gcloud.exceptions import NotFound
|
|
self._requested.append(kw)
|
|
|
|
response, self._responses = self._responses[0], self._responses[1:]
|
|
return response
|