import os # noqa: E402
import random # noqa: E402
from parsons import VAN # noqa: E402
from parsons import logger # noqa: E402
# Setup
# If variables specified above, sets them as environmental variables
for name, value in config_vars.items():
if value.strip() != "":
os.environ[name] = value
van = VAN(db=os.environ["VAN_DB_NAME"])
# Get details on the saved list we're pulling from and the folder we're uploading to
saved_list = van.get_saved_list(os.environ["VAN_SAVED_LIST_ID"])
folder = van.get_folder(os.environ["VAN_FOLDER_ID"])
# If you're receiving errors when trying to call this method related to permissions, you may want to
# reach out to [email protected] to make sure your API key has the correct permissions.
saved_list_download = van.download_saved_list(os.environ["VAN_SAVED_LIST_ID"])
# Generate a random sample of VAN IDs from the list
saved_list_sample_ids = random.sample(
saved_list_download["VanID"],
int(os.environ["VAN_SAMPLE_LIST_SIZE"]),
)
# Create a new sample list from the sampled IDs that only includes the VanID column
saved_list_sample = saved_list_download.cut("VanID").select_rows(
lambda row: row["VanID"] in saved_list_sample_ids)
class TestSavedLists(unittest.TestCase):
def setUp(self):
self.van = VAN(os.environ['VAN_API_KEY'], db="MyVoters", raise_for_status=False)
def tearDown(self):
pass
@requests_mock.Mocker()
def test_get_saved_lists(self, m):
json = {'count': 1, 'items': [
{"savedListId": 517612,
"listCount": 974656,
"name": "LikelyParents(16andunder)_DWID_S... - MN",
"doorCount": 520709,
"description": "null"
}
], 'nextPageLink': None}
m.get(self.van.connection.uri + 'savedLists', json=json)
expected = ['savedListId', 'listCount', 'name', 'doorCount', 'description']
self.assertTrue(validate_list(expected, self.van.get_saved_lists()))
@requests_mock.Mocker()
def test_get_saved_list(self, m):
saved_list_id = 517612
json = {"savedListId": 517612,
"listCount": 974656,
"name": "LikelyParents(16andunder)_DWID_S... - MN",
"doorCount": 520709,
"description": "null"
}
m.get(self.van.connection.uri + f'savedLists/{saved_list_id}', json=json)
# expected = ['savedListId', 'listCount', 'name', 'doorCount', 'description']
self.assertEqual(self.van.get_saved_list(saved_list_id), json)
def test_upload_saved_list(self):
cloud_storage.post_file = mock.MagicMock()
cloud_storage.post_file.return_value = 'https://box.com/my_file.zip'
self.van.connection._soap_client = mock.MagicMock()
self.van.get_folders = mock.MagicMock()
self.van.get_folders.return_value = [{'folderId': 1}]
tbl = Table([['VANID'], ['1'], ['2'], ['3']])
self.van.upload_saved_list(
tbl, 'GOTV List', 1, replace=True, url_type='S3', bucket='tmc-scratch')
assert self.van.connection._soap_client.service.CreateAndStoreSavedList.called
@requests_mock.Mocker()
def test_upload_saved_list_rest(self):
cloud_storage.post_file = mock.MagicMock()
cloud_storage.post_file.return_value = 'https://box.com/my_file.zip'
self.van.get_folders = mock.MagicMock()
self.van.get_folders.return_value = [{'folderId': 1}]
tbl = Table([['VANID'], ['1'], ['2'], ['3']])
response = self.van.upload_saved_list_rest(
tbl=tbl, url_type="S3",
folder_id=1, list_name="GOTV List", description="parsons test list",
callback_url="https://webhook.site/69ab58c3-a3a7-4ed8-828c-1ea850cb4160",
columns=["VANID"], id_column="VANID",
bucket="tmc-scratch",
overwrite=517612
)
self.assertIn("jobId", response)
@requests_mock.Mocker()
def test_get_folders(self, m):
json = {u'count': 2,
u'items': [
{
u'folderId': 5046,
u'name': u'#2018_MN_active_universe'
},
{u'folderId': 2168,
u'name': u'API Generated Lists'
}
], u'nextPageLink': None}
m.get(self.van.connection.uri + 'folders', json=json)
expected = ['folderId', 'name']
self.assertTrue(validate_list(expected, self.van.get_folders()))
@requests_mock.Mocker()
def test_get_folder(self, m):
folder_id = 5046
json = {"folderId": 5046, "name": "#2018_MN_active_universe"}
m.get(self.van.connection.uri + f'folders/{folder_id}', json=json)
self.assertEqual(json, self.van.get_folder(folder_id))
@requests_mock.Mocker()
def test_export_job_types(self, m):
json = {u'count': 1, u'items':
[{u'exportJobTypeId': 4, u'name': u'SavedListExport'}],
u'nextPageLink': None}
m.get(self.van.connection.uri + 'exportJobTypes', json=json)
expected = ['exportJobTypeId', 'name']
self.assertTrue(validate_list(expected, self.van.get_export_job_types()))
@requests_mock.Mocker()
def test_export_job_create(self, m):
saved_list_id = 517612
json = {"status": "Completed",
"errorCode": "null",
"exportJobGuid": "bf4d1297-1c77-3fb2-03bd-f0acda122d37",
"activistCodes": "null",
"canvassFileRequestId": 448,
"dateExpired": "2018-09-08T16:04:00Z",
"surveyQuestions": "null",
"webhookUrl": "https://www.nothing.com/",
"downloadUrl": "https://ngpvan.blob.core.windows.net/canvass-files-savedlistexport/bf4d1297-1c77-3fb2-03bd-f0acda122d37_2018-09-08T13:03:27.7191831-04:00.csv", # noqa: E501
"savedListId": 517612,
"districtFields": "null",
"canvassFileRequestGuid": "bf4d1297-1c77-3fb2-03bd-f0acda122d37",
"customFields": "null",
"type": 4,
"exportJobId": 448}
m.post(self.van.connection.uri + 'exportJobs', json=json, status_code=201)
# expected = [
# 'status',
# 'errorCode',
# 'exportJobGuid',
# 'activistCodes',
# 'canvassFileRequestId',
# 'dateExpired',
# 'surveyQuestions',
# 'webhookUrl',
# 'downloadUrl',
# 'savedListId',
# 'districtFields',
# 'canvassFileRequestGuid',
# 'customFields',
# 'type',
# 'exportJobId']
self.assertEqual(json, self.van.export_job_create(saved_list_id))
@requests_mock.Mocker()
def test_get_export_job(self, m):
export_job_id = 448
json = {"status": "Completed",
"errorCode": "null",
"exportJobGuid": "bf4d1297-1c77-3fb2-03bd-f0acda122d37",
"activistCodes": "null",
"canvassFileRequestId": 448,
"dateExpired": "2018-09-08T16:04:00Z",
"surveyQuestions": "null",
"webhookUrl": "https://www.nothing.com/",
"downloadUrl": "https://ngpvan.blob.core.windows.net/canvass-files-savedlistexport/bf4d1297-1c77-3fb2-03bd-f0acda122d37_2018-09-08T13:03:27.7191831-04:00.csv", # noqa: E501
"savedListId": 517612,
"districtFields": "null",
"canvassFileRequestGuid": "bf4d1297-1c77-3fb2-03bd-f0acda122d37",
"customFields": "null",
"type": 4,
"exportJobId": 448}
# expected = [
# 'status',
# 'errorCode',
# 'exportJobGuid',
# 'activistCodes',
# 'canvassFileRequestId',
# 'dateExpired',
# 'surveyQuestions',
# 'webhookUrl',
# 'downloadUrl',
# 'savedListId',
# 'districtFields',
# 'canvassFileRequestGuid',
# 'customFields',
# 'type',
# 'exportJobId']
m.get(self.van.connection.uri + f'exportJobs/{export_job_id}', json=json)
self.assertEqual(json, self.van.get_export_job(export_job_id))