def test_GetResponseExportFile_fail_bad_zip_file(self, get_func):
get_func.return_value = MockResponse(status_code=200, data="")
qualtrics = Qualtrics("234", "123")
responseExportId = qualtrics.GetResponseExportFile("kkkkkkkk")
self.assertIsNone(responseExportId)
self.assertEqual(qualtrics.last_error_message,
"File is not a zip file")
def test_not_a_json_document_google_com(self):
qualtrics = Qualtrics(self.user, "123")
qualtrics.url = "https://google.com"
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertEquals(qualtrics.last_error_message, "Unexpected response from Qualtrics: not a JSON document")
self.assertIsNone(qualtrics.json_response)
self.assertIsNone(result)
def test_GetResponseExportProgress_fail_2(self):
qualtrics = Qualtrics("234", "123")
status, msg = qualtrics.GetResponseExportProgress("sdfasdfdsf")
self.assertEqual(status, "servfail")
self.assertEqual(msg, "Unrecognized X-API-TOKEN.")
self.assertEqual(qualtrics.last_error_message,
"Unrecognized X-API-TOKEN.")
def test_CreateResponseExport_fail_2(self):
qualtrics = Qualtrics("234", "123")
responseExportId = qualtrics.CreateResponseExport(
"csv", self.survey_id)
self.assertIsNone(responseExportId)
self.assertEqual(qualtrics.last_error_message,
"Unrecognized X-API-TOKEN.")
def setUp(self):
self.user = os.environ["QUALTRICS_USER"]
self.token = os.environ["QUALTRICS_TOKEN"]
self.library_id = os.environ["QUALTRICS_LIBRARY_ID"]
self.survey_id = os.environ.get("QUALTRICS_SURVEY_ID", None)
self.message_id = os.environ.get("QUALTRICS_MESSAGE_ID", None)
self.response_id = os.environ.get("QUALTRICS_RESPONSE_ID", None)
self.qualtrics = Qualtrics(self.user, self.token)
def test_CreateResponseExport_mailformed_response(self, get_func):
get_func.return_value = MockResponse(status_code=200, data="")
qualtrics = Qualtrics("234", "123")
responseExportId = qualtrics.CreateResponseExport(
"csv", self.survey_id)
self.assertIsNone(responseExportId)
self.assertIn("Mailformed response from server:",
qualtrics.last_error_message)
def test_ssl_error_1(self):
# This only works on Notre Dame VPN
qualtrics = Qualtrics(self.user, "123")
qualtrics.url = "https://vecnet-ingest.crc.nd.edu/"
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertIn("CERTIFICATE_VERIFY_FAILED", qualtrics.last_error_message)
qualtrics.requests_kwargs = {"verify": False}
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertNotIn("CERTIFICATE_VERIFY_FAILED", qualtrics.last_error_message)
def test_not_a_json_document_google_com(self):
qualtrics = Qualtrics(self.user, "123")
qualtrics.url = "https://google.com"
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertEquals(
qualtrics.last_error_message,
"Unexpected response from Qualtrics: not a JSON document")
self.assertIsNone(qualtrics.json_response)
self.assertIsNone(result)
def test_ssl_error_2(self):
# This may fail is 129.74.247.12 is down or certificate error is corrected
qualtrics = Qualtrics(self.user, "123")
qualtrics.url = "https://129.74.247.12/"
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
# Error: hostname '129.74.247.12' doesn't match either of '*.vecnet.org', 'vecnet.org'
self.assertIn("129.74.247.12", qualtrics.last_error_message)
qualtrics.requests_kwargs = {"verify": False}
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertNotIn("CERTIFICATE_VERIFY_FAILED", qualtrics.last_error_message)
def main(argv):
kwargs = {}
iterator = iter(argv)
executable = iterator.next() # argv[0]
try:
command = iterator.next() # argv[1]
except StopIteration:
print "The name of the API call to be made is required"
return None
user = None
if "QUALTRICS_USER" not in os.environ:
user = raw_input("Enter Qualtrics username: "******"QUALTRICS_TOKEN" not in os.environ:
token = raw_input("Enter Qualtrics token: ")
qualtrics = Qualtrics(user, token)
method = getattr(qualtrics, command)
if not method:
print "%s API call is not implement" % method
return None
for option in argv:
try:
arg, value = option.split("=")
kwargs[arg] = value
except ValueError:
# Ignore parameter in wrong format
pass
return method(**kwargs)
def setUp(self):
self.user = os.environ["QUALTRICS_USER"]
self.token = os.environ["QUALTRICS_TOKEN"]
self.library_id = os.environ["QUALTRICS_LIBRARY_ID"]
self.survey_id = os.environ.get("QUALTRICS_SURVEY_ID", None)
self.message_id = os.environ.get("QUALTRICS_MESSAGE_ID", None)
self.response_id = os.environ.get("QUALTRICS_RESPONSE_ID", None)
self.qualtrics = Qualtrics(self.user, self.token)
def test_ssl_error_2(self):
# This may fail is 129.74.247.12 is down or certificate error is corrected
qualtrics = Qualtrics(self.user, "123")
qualtrics.url = "https://129.74.247.12/"
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
# Error: hostname '129.74.247.12' doesn't match either of '*.vecnet.org', 'vecnet.org'
self.assertIn("129.74.247.12", qualtrics.last_error_message)
qualtrics.requests_kwargs = {"verify": False}
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertNotIn("CERTIFICATE_VERIFY_FAILED",
qualtrics.last_error_message)
def test_ssl_error_1(self):
# This only works on Notre Dame VPN
qualtrics = Qualtrics(self.user, "123")
qualtrics.url = "https://vecnet-ingest.crc.nd.edu/"
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertIn("CERTIFICATE_VERIFY_FAILED",
qualtrics.last_error_message)
qualtrics.requests_kwargs = {"verify": False}
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertNotIn("CERTIFICATE_VERIFY_FAILED",
qualtrics.last_error_message)
def test_GetResponseExportFile_fail_2(self):
qualtrics = Qualtrics("234", "123")
result = qualtrics.GetResponseExportFile("kkkkkkkk")
self.assertEqual(result, None)
self.assertEqual(qualtrics.last_error_message,
"Unrecognized X-API-TOKEN.")
class TestQualtrics(unittest.TestCase):
def setUp(self):
self.user = os.environ["QUALTRICS_USER"]
self.token = os.environ["QUALTRICS_TOKEN"]
self.library_id = os.environ["QUALTRICS_LIBRARY_ID"]
self.survey_id = os.environ.get("QUALTRICS_SURVEY_ID", None)
self.message_id = os.environ.get("QUALTRICS_MESSAGE_ID", None)
self.response_id = os.environ.get("QUALTRICS_RESPONSE_ID", None)
self.qualtrics = Qualtrics(self.user, self.token)
def test_str(self):
self.assertEqual(str(self.qualtrics), self.user)
def test_creation_errors(self):
panel_id = self.qualtrics.createPanel(LibraryID="",
Name="Hello",
User="******")
self.assertIsNone(panel_id)
self.assertIsNotNone(self.qualtrics.last_error_message)
# message can be "Incorrect Username or Password" or "User Account Disabled"
# self.assertEqual(self.qualtrics.last_error_message, "Incorrect Username or Password")
# We can't really test for invalid token error, because Qualtrics disables account
# if there are too many failed login attempts.
# For example:
# "Too many failed login attempts. Your account has been disabled for 10 minutes."
# self.assertEqual(message, "Invalid token")
# Create panel with non-existing library id
panel_id = self.qualtrics.createPanel(LibraryID="", Name="Hello")
self.assertIsNone(panel_id)
self.assertEqual(
self.qualtrics.last_error_message,
"Invalid request. Missing or invalid parameter LibraryID.")
def test_create_and_delete(self):
# Note you may need to login and logout to see new panel in Qualtrics interface
panel_id = self.qualtrics.createPanel(
LibraryID=self.library_id,
Name="Test Panel created by pyqualtrics library (DELETE ME)")
self.assertIsNotNone(panel_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
count = self.qualtrics.getPanelMemberCount(self.library_id, panel_id)
self.assertEqual(count, 0)
# random_prefix is required because you can't send same survey to the same email twice
random_prefix = ''.join(
random.choice(string.ascii_uppercase + string.digits)
for _ in range(6))
recipient_id = self.qualtrics.addRecipient(
self.library_id,
panel_id,
FirstName="Fake",
LastName="Subject",
Email="*****@*****.**" % random_prefix,
ExternalDataRef=None,
Language="EN",
ED={"SubjectID": "123"})
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(recipient_id)
recipient = self.qualtrics.getRecipient(LibraryID=self.library_id,
RecipientID=recipient_id)
self.assertEqual(recipient["FirstName"], "Fake")
self.assertEqual(recipient["LastName"], "Subject")
self.assertEqual(recipient["Language"], "EN")
self.assertIsNone(recipient["ExternalDataReference"])
self.assertEqual(recipient["EmbeddedData"]["SubjectID"], "123")
count = self.qualtrics.getPanelMemberCount(self.library_id, panel_id)
self.assertEqual(count, 1)
if self.survey_id is not None and self.message_id is not None:
# Test email delivery if SurveyID and MessageID have been provided
distribution_id = self.qualtrics.sendSurveyToIndividual(
SendDate="2015-12-12 19:48:28",
FromEmail="*****@*****.**",
FromName="PyQualtrics Library",
MessageID=self.message_id,
MessageLibraryID=self.library_id,
Subject="Why, hello there",
SurveyID=self.survey_id,
PanelID=panel_id,
PanelLibraryID=self.library_id,
RecipientID=recipient_id)
self.assertIsNotNone(distribution_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
result = self.qualtrics.getDistributions(
LibraryID=self.library_id,
SurveyID=self.survey_id,
DistributionID=distribution_id)
self.assertIsNotNone(result)
xml = self.qualtrics.getSurvey(SurveyID=self.survey_id)
self.assertIsNotNone(xml)
self.assertIsNone(self.qualtrics.json_response)
self.assertIsNone(self.qualtrics.last_error_message)
data = self.qualtrics.getLegacyResponseData(
SurveyID=self.survey_id)
self.assertIsNotNone(data)
self.assertIsNotNone(self.qualtrics.json_response)
self.assertIsNone(self.qualtrics.last_error_message)
if self.response_id is not None and self.survey_id is not None:
response = self.qualtrics.getResponse(SurveyID=self.survey_id,
ResponseID=self.response_id)
self.assertIsNotNone(response)
self.assertIsNone(self.qualtrics.last_error_message)
response = self.qualtrics.getResponse(SurveyID=self.survey_id,
ResponseID="abc")
self.assertIsNone(response)
self.assertEqual(
self.qualtrics.last_error_message,
"Invalid request. Missing or invalid parameter ResponseID."
) # noqa
result = self.qualtrics.removeRecipient(LibraryID=self.library_id,
PanelID=panel_id,
RecipientID=recipient_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertEqual(result, True)
count = self.qualtrics.getPanelMemberCount(self.library_id, panel_id)
self.assertEqual(count, 0)
result = self.qualtrics.deletePanel(LibraryID=self.library_id,
PanelID=panel_id)
self.assertEqual(result, True)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
def test_send_survey_to_panel(self):
panel_id = self.qualtrics.createPanel(
LibraryID=self.library_id,
Name="Test Panel for send_survey_to_panel pyqualtrics (DELETE ME)")
# random_prefix is required because you can't send same survey to the same email twice
random_prefix = ''.join(
random.choice(string.ascii_uppercase + string.digits)
for _ in range(6))
recipient_id = self.qualtrics.addRecipient(
self.library_id,
panel_id,
FirstName="Panel",
LastName="Subject",
Email="*****@*****.**" % random_prefix,
ExternalDataRef=None,
Language="EN",
ED={"SubjectID": "123"})
email_distribution_id = self.qualtrics.sendSurveyToPanel(
SendDate="2015-12-12 19:48:28",
FromEmail="*****@*****.**",
FromName="PyQualtrics Library",
MessageID=self.message_id,
MessageLibraryID=self.library_id,
Subject="Why, hello there - sendSurveyToPanel",
SurveyID=self.survey_id,
PanelID=panel_id,
PanelLibraryID=self.library_id,
SentFromAddress=None,
LinkType="Multiple",
)
self.assertIsNotNone(email_distribution_id)
self.qualtrics.deletePanel(self.library_id, panel_id)
def test_get_panels(self):
result = self.qualtrics.getPanels(self.library_id)
self.assertIsNotNone(result)
def test_panel_errors(self):
result = self.qualtrics.removeRecipient(LibraryID=self.library_id,
PanelID="",
RecipientID="")
self.assertEqual(result, False)
self.assertEqual(
self.qualtrics.last_error_message,
"Invalid request. Missing or invalid parameter RecipientID.")
def test_deletion_errors(self):
result = self.qualtrics.deletePanel(LibraryID="",
PanelID="",
User="******")
self.assertEqual(result, False)
self.assertIsNotNone(self.qualtrics.last_error_message)
# Different error messages can be returned
# "Incorrect Username or Password"
# "Account Locked"
# We can't really test for invalid token error, because Qualtrics disables account
# if there are too many failed login attempts
# For example:
# "Too many failed login attempts. Your account has been disabled for 10 minutes."
result = self.qualtrics.deletePanel(LibraryID="", PanelID="Hello")
self.assertEqual(result, False)
self.assertEqual(
self.qualtrics.last_error_message,
"Invalid request. Missing or invalid parameter LibraryID.")
def test_json_import(self):
panel_id = self.qualtrics.importJsonPanel(
self.library_id,
Name="Panel for testing JSON Import",
panel=[{
"Email": "*****@*****.**",
"FirstName": "PyQualtrics",
"LastName": "Library"
}, {
"Email": "*****@*****.**",
"FirstName": "PyQualtrics2",
"LastName": "Library2"
}])
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(panel_id)
self.assertIsNotNone(self.qualtrics.json_response)
count = self.qualtrics.getPanelMemberCount(self.library_id, panel_id)
self.assertEqual(count, 2)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
subjects = self.qualtrics.getPanel(self.library_id, panel_id)
self.assertEqual(len(subjects), 2)
self.assertEqual(subjects[0]["LastName"], "Library")
self.assertEqual(subjects[1]["FirstName"], "PyQualtrics2")
new_panel_id = self.qualtrics.importJsonPanel(
self.library_id,
Name="Panel for testing JSON Import",
PanelID=panel_id,
panel=[{
"Email": "*****@*****.**",
"FirstName": "PyQualtrics",
"LastName": "Library3"
}, {
"Email": "*****@*****.**",
"FirstName": "PyQualtrics2",
"LastName": "Library4"
}])
count = self.qualtrics.getPanelMemberCount(self.library_id, panel_id)
self.assertEqual(count, 4)
self.assertEqual(new_panel_id, panel_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
# This one should not be successful
result = self.qualtrics.importJsonPanel(
self.library_id,
Name="Panel for testing JSON Import",
PanelID=panel_id,
headers=["FirstName", "LastName"],
panel=[{
"FirstName": "PyQualtrics",
"LastName": "Library3"
}, {
"FirstName": "PyQualtrics2",
"LastName": "Library4"
}])
self.assertEqual(result, None)
self.assertEqual(
self.qualtrics.last_error_message,
"Invalid request. Missing or invalid parameter Email.")
count = self.qualtrics.getPanelMemberCount(self.library_id, panel_id)
self.assertEqual(count, 4)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
result = self.qualtrics.deletePanel(LibraryID=self.library_id,
PanelID=panel_id)
self.assertEqual(result, True)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
def test_json_import_with_embedded_data(self):
panel_id = self.qualtrics.importJsonPanel(
self.library_id,
Name="Panel for testing JSON Import",
panel=[
{
"Email": "*****@*****.**",
"FirstName": "PyQualtrics",
"LastName": "Library",
"SubjectID": "SUBJ0001"
}, # noqa
{
"Email": "*****@*****.**",
"FirstName": "PyQualtrics2",
"LastName": "Library2"
}
],
headers=[
"Email", "FirstName", "LastName", "ExternalRef", "SubjectID"
],
AllED=1)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(panel_id)
self.assertIsNotNone(self.qualtrics.json_response)
count = self.qualtrics.getPanelMemberCount(self.library_id, panel_id)
self.assertEqual(count, 2)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
subjects = self.qualtrics.getPanel(self.library_id, panel_id)
self.assertEqual(len(subjects), 2)
self.assertEqual(subjects[0]["LastName"], "Library")
self.assertEqual(subjects[1]["FirstName"], "PyQualtrics2")
self.assertEqual(subjects[0]["EmbeddedData"]["SubjectID"], "SUBJ0001")
result = self.qualtrics.deletePanel(LibraryID=self.library_id,
PanelID=panel_id)
self.assertEqual(result, True)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
def test_import_survey_errors(self):
# Survey contents is invalid
result = self.qualtrics.importSurvey(
ImportFormat="QSF",
Name="Test survey import (DELETE ME - 1)",
FileContents="123")
self.assertFalse(result)
self.assertEqual(
self.qualtrics.last_error_message,
"Error parsing file: The file does not appear to be a valid survey"
)
# Unknown survey format
result = self.qualtrics.importSurvey(
ImportFormat="_",
Name="Test survey import (DELETE ME - 2)",
FileContents="123")
self.assertFalse(result)
self.assertEqual(
self.qualtrics.last_error_message,
"Invalid request. Missing or invalid parameter ImportFormat.")
def test_import_survey(self):
survey_id = self.qualtrics.importSurvey(
ImportFormat="QSF",
Name="Test survey import (DELETE ME - 3)",
FileContents=open(os.path.join(base_dir,
"pyqualtrics.qsf")).read())
self.assertIsNotNone(survey_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIn(survey_id, self.qualtrics.getSurveys())
self.assertIsNone(self.qualtrics.last_error_message)
result = self.qualtrics.activateSurvey(SurveyID=survey_id)
self.assertTrue(result)
result = self.qualtrics.deactivateSurvey(SurveyID=survey_id)
self.assertTrue(result)
result = self.qualtrics.deleteSurvey(SurveyID=survey_id)
self.assertTrue(result)
def test_import_survey_from_url(self):
survey_id = self.qualtrics.importSurvey(
ImportFormat="QSF",
Name="Test survey import (DELETE ME - curatend)",
# URL="https://curate.nd.edu/downloads/xs55m903893",
URL=
"https://github.com/Baguage/pyqualtrics/raw/master/tests/pyqualtrics.qsf",
)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(survey_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIn(survey_id, self.qualtrics.getSurveys())
self.assertIsNone(self.qualtrics.last_error_message)
result = self.qualtrics.deleteSurvey(SurveyID=survey_id)
self.assertTrue(result)
def test_delete_survey_fails(self):
self.assertFalse(self.qualtrics.deleteSurvey(SurveyID="123"))
def test_activate_survey_fails(self):
self.assertFalse(self.qualtrics.activateSurvey(SurveyID="123"))
self.assertFalse(self.qualtrics.deactivateSurvey(SurveyID="123"))
def test_single_response_html(self):
result = self.qualtrics.getSingleResponseHTML(
SurveyID=self.survey_id, ResponseID=self.response_id)
self.assertIsNotNone(result)
self.assertTrue("DOCTYPE html PUBLIC" in result)
def test_get_legacy_response_data(self):
"""
WARNING!!!
This test requires a partially completed response in "getLegacyData test" survey (SV_8pqqcl4sy2316ZL),
and it will closed after 6 month (max timeout allowed by Qualtrics). Thus every 6 month new
partially completed response should be created.
Use link https://nd.qualtrics.com/jfe/form/SV_8pqqcl4sy2316ZL and answer "Male". Don't answer the second question
:return:
"""
# Get completed responses
responses = self.qualtrics.getLegacyResponseData(
SurveyID=self.survey_id)
self.assertIsNotNone(responses)
self.assertEqual(len(responses), 3)
key, response = responses.popitem(last=False)
self.assertEqual(response["SubjectID"], "PY0001")
# Note if response was imported to Qualtrics, Finished is a string, not a number
self.assertEqual(response["Finished"], '1')
self.assertEqual(response["Q1"], 1)
self.assertEqual(response["Q2"], 3)
key, response = responses.popitem(last=False)
self.assertEqual(response["SubjectID"], "")
self.assertEqual(response["Finished"], '1')
self.assertEqual(response["Q1"], 1)
self.assertEqual(response["Q2"], 3)
key, response = responses.popitem(last=False)
self.assertEqual(response["SubjectID"], "TEST0001")
self.assertEqual(response["Finished"], '1')
self.assertEqual(response["Q1"], 2)
self.assertEqual(response["Q2"], 1)
# Note that responses in progress do not have ResponseID, they have Survey Session ID instead
# When response is completed, Survey Session ID is gone and new ResponseID is assigned
responses = self.qualtrics.getLegacyResponseData(
SurveyID=self.survey_id, ResponsesInProgress=1)
self.assertIsNotNone(responses)
self.assertEqual(len(responses), 1)
for survey_session_id, response in responses.iteritems():
self.assertEqual(response["SubjectID"], "")
self.assertEqual(response["Finished"], 0)
self.assertEqual(response["Q1"], 1)
self.assertEqual(response["Q2"], "")
def test_get_legacy_response_data_wrong_last_response_id(self):
responses = self.qualtrics.getLegacyResponseData(
SurveyID=self.survey_id, LastResponseID="123")
self.assertEqual(responses, None)
self.assertEqual(
self.qualtrics.last_error_message,
"Invalid request. Missing or invalid parameter LastResponseID.")
def test_get_response(self):
response = self.qualtrics.getResponse(SurveyID=self.survey_id,
ResponseID=self.response_id)
self.assertIsNotNone(response)
self.assertEqual(response["SubjectID"], "PY0001")
self.assertEqual(response["Finished"], '1')
self.assertEqual(response["Q1"], 1)
self.assertEqual(response["Q2"], 3)
def test_create_distribution(self):
panel_id = self.qualtrics.createPanel(
self.library_id, "(DELETE ME) Panel for testing distributions")
distribution_id = self.qualtrics.createDistribution(
SurveyID=self.survey_id,
PanelID=panel_id,
Description="Test distribution",
PanelLibraryID=self.library_id)
self.qualtrics.deletePanel(self.library_id, panel_id)
self.assertIsNotNone(distribution_id)
self.assertIsNone(self.qualtrics.last_error_message)
def test_generate_unique_survey_link(self):
panel_id = self.qualtrics.createPanel(
self.library_id, "(DELETE ME) Panel for testing unique links")
distribution_id = self.qualtrics.createDistribution(
SurveyID=self.survey_id,
PanelID=panel_id,
Description="Test distribution",
PanelLibraryID=self.library_id)
link1 = self.qualtrics.generate_unique_survey_link(
SurveyID=self.survey_id,
LibraryID=self.library_id,
PanelID=panel_id,
DistributionID=distribution_id,
FirstName="Py",
LastName="Qualtrics",
Email="*****@*****.**",
)
self.assertIsNotNone(link1)
self.assertIsNone(self.qualtrics.last_error_message)
link2 = self.qualtrics.generate_unique_survey_link(
SurveyID=self.survey_id,
LibraryID=self.library_id,
PanelID=panel_id,
DistributionID=distribution_id,
FirstName="Py",
LastName="Qualtrics",
Email="*****@*****.**",
)
self.assertIsNotNone(link2)
self.assertNotEquals(link1, link2)
self.assertIsNone(self.qualtrics.last_error_message)
link3 = self.qualtrics.generate_unique_survey_link(
SurveyID=self.survey_id,
LibraryID=self.library_id,
PanelID=panel_id,
DistributionID=distribution_id,
FirstName="Py",
LastName="Qualtrics",
Email="*****@*****.**",
EmbeddedData={"SubjectID": "TEST0001"})
self.assertIsNotNone(link3)
self.assertNotEquals(link1, link3)
self.assertNotEquals(link2, link3)
self.assertIsNone(self.qualtrics.last_error_message)
link4 = self.qualtrics.generate_unique_survey_link(
SurveyID="",
LibraryID=self.library_id,
PanelID=panel_id,
DistributionID=distribution_id,
FirstName="Py",
LastName="Qualtrics",
Email="*****@*****.**",
)
self.assertIsNone(link4)
self.assertIsNotNone(self.qualtrics.last_error_message)
link5 = self.qualtrics.generate_unique_survey_link(
SurveyID=self.survey_id,
LibraryID="",
PanelID=panel_id,
DistributionID=distribution_id,
FirstName="Py",
LastName="Qualtrics",
Email="*****@*****.**",
)
self.assertIsNone(link5)
self.assertIsNotNone(self.qualtrics.last_error_message)
self.qualtrics.deletePanel(self.library_id, panel_id)
self.assertIsNone(self.qualtrics.last_error_message)
def test_import_responses_and_update_embedded_data(self):
survey_id = self.qualtrics.importSurvey(
ImportFormat="QSF",
Name="Test importResponses (DELETE ME - 4)",
FileContents=open(os.path.join(base_dir,
"pyqualtrics-ed.qsf")).read())
self.assertIsNotNone(survey_id)
self.assertIsNone(self.qualtrics.last_error_message)
result = self.qualtrics.importResponses(
survey_id,
FileContents=open(os.path.join(base_dir, "response.csv")).read())
self.assertIsNone(self.qualtrics.last_error_message)
self.assertTrue(result)
responses = self.qualtrics.getLegacyResponseData(survey_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertEqual(len(responses), 1)
for response_id in responses:
response = responses[response_id]
self.assertEqual(response["Finished"], "1")
self.assertEqual(response["Q1"], 1)
self.assertEqual(response["Q2"], 1)
# Note that Embedded Data must be declared in Survey
# before they can be updated with updateResponseEmbeddedData function
self.qualtrics.updateResponseEmbeddedData(survey_id,
response_id,
ED={"TEST": "Yay!"})
responses = self.qualtrics.getLegacyResponseData(survey_id)
for response_id in responses:
response = responses[response_id]
self.assertEqual(response["TEST"], "Yay!")
self.assertIn(response["Q_ID"], "")
# print responses
self.qualtrics.deleteSurvey(survey_id)
def test_import_responses_as_dict(self):
survey_id = self.qualtrics.importSurvey(
ImportFormat="QSF",
Name="Test responses_as_dict import (DELETE ME - 4)",
FileContents=open(os.path.join(base_dir,
"pyqualtrics.qsf")).read())
self.assertIsNotNone(survey_id)
self.assertIsNone(self.qualtrics.last_error_message)
result = self.qualtrics.importResponsesAsDict(
survey_id,
[{
"startDate": "",
"endDate": "",
"QID1": 1,
"QID2": 2
}],
# [{"Finished": "1", "Q1": 2, "Q2": 1}],
)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertTrue(result)
responses = self.qualtrics.getLegacyResponseData(survey_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertEqual(len(responses), 1)
for response_id in responses:
response = responses[response_id]
self.assertEqual(response["Finished"], "1")
self.assertEqual(response["Q1"], 1)
self.assertEqual(response["Q2"], 2)
self.qualtrics.deleteSurvey(survey_id)
# def test_subscriptions(self):
# print("Subscriptions")
# self.qualtrics.getAllSubscriptions()
# print(self.qualtrics.last_url)
# print(self.qualtrics.last_error_message)
#
# result = self.qualtrics.subscribe(
# Name="New responses",
# PublicationURL="https://wellbeing.crc.nd.edu",
# Topics="surveyengine.completedResponse." + self.survey_id
# )
# print(result)
# print(self.qualtrics.last_url)
# print(self.qualtrics.last_error_message)
#
# self.assertFalse(True)
def test_connection_error_invalid_url(self):
url = self.qualtrics.url
self.qualtrics.url = "http://blablabla.bla"
responses = self.qualtrics.getLegacyResponseData(
SurveyID=self.survey_id)
self.assertIsNone(responses)
self.assertIsNone(self.qualtrics.last_status_code)
self.assertIn("Max retries exceeded with url",
self.qualtrics.last_error_message)
# Restore API URL for tearDown() function
self.qualtrics.url = url
def test_connection_error_invalid_ip_address(self):
url = self.qualtrics.url
self.qualtrics.url = "http://0.0.0.0"
responses = self.qualtrics.getLegacyResponseData(
SurveyID=self.survey_id)
self.assertIsNone(responses)
self.assertIsNone(self.qualtrics.last_status_code)
self.assertIn("Max retries exceeded with url",
self.qualtrics.last_error_message)
# Restore API URL for tearDown() function
self.qualtrics.url = url
def test_not_a_json_document_google_com(self):
qualtrics = Qualtrics(self.user, "123")
qualtrics.url = "https://google.com"
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertEquals(
qualtrics.last_error_message,
"Unexpected response from Qualtrics: not a JSON document")
self.assertIsNone(qualtrics.json_response)
self.assertIsNone(result)
def test_ssl_error_1(self):
# This only works on Notre Dame VPN
qualtrics = Qualtrics(self.user, "123")
qualtrics.url = "https://vecnet-ingest.crc.nd.edu/"
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertIn("CERTIFICATE_VERIFY_FAILED",
qualtrics.last_error_message)
qualtrics.requests_kwargs = {"verify": False}
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertNotIn("CERTIFICATE_VERIFY_FAILED",
qualtrics.last_error_message)
def test_ssl_error_2(self):
# This may fail is 129.74.247.12 is down or certificate error is corrected
qualtrics = Qualtrics(self.user, "123")
qualtrics.url = "https://129.74.247.12/"
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
# Error: hostname '129.74.247.12' doesn't match either of '*.vecnet.org', 'vecnet.org'
self.assertIn("129.74.247.12", qualtrics.last_error_message)
qualtrics.requests_kwargs = {"verify": False}
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertNotIn("CERTIFICATE_VERIFY_FAILED",
qualtrics.last_error_message)
def tearDown(self):
# Note that tearDown is called after EACH test
# Remove all surveys with (DELETE ME in their name
for survey_id, survey in self.qualtrics.getSurveys().iteritems():
if "(DELETE ME" in survey["SurveyName"]:
print("Deleting survey %s" % survey["SurveyName"])
self.qualtrics.deleteSurvey(SurveyID=survey_id)
def setUpClass(cls):
cls.user = os.environ["QUALTRICS_USER"]
cls.token = os.environ["QUALTRICS_TOKEN"]
cls.qualtrics = Qualtrics(cls.user, cls.token)
# 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.
from pyqualtrics import Qualtrics
import os
user = None # os.environ["QUALTRICS_USER"]
token = None # os.environ["QUALTRICS_TOKEN"]
if __name__ == "__main__":
print "This is an example of panel import"
print "Make sure you have set QUALTRICS_USER, QUALTRICS_TOKEN and QUALTRICS_LIBRARY_ID enviroment variable"
# Note is user and token are None, QUALTRICS_USER and QUALTRICS_TOKEN environment variables will be used instead
qualtrics = Qualtrics(user, token)
library_id = os.environ["QUALTRICS_LIBRARY_ID"]
panel_id = qualtrics.importJsonPanel(
library_id,
Name="New Panel Created by PyQualtrics library (DELETE ME)",
panel=[{
"Email": "*****@*****.**",
"FirstName": "PyQualtrics",
"LastName": "Library",
"SubjectID": "123"
}, {
"Email": "*****@*****.**",
"FirstName": "PyQualtrics2",
"LastName": "Library2"
}],
headers=["Email", "FirstName", "LastName", "ExternalRef", "SubjectID"],
from pyqualtrics import Qualtrics
import os
user = None
token = None
if __name__ == "__main__":
print "This is an example of sending a survey"
print "Make sure you have set QUALTRICS_USER, QUALTRICS_TOKEN, QUALTRICS_LIBRARY_ID, QUALTRICS_SURVEY_ID " \
"and QUALTRICS_MESSAGE_ID enviroment variables"
# Note is user and token are None, QUALTRICS_USER and QUALTRICS_TOKEN environment variables will be used instead
qualtrics = Qualtrics(user, token)
survey_id = os.environ["QUALTRICS_SURVEY_ID"]
qualtrics = Qualtrics(user, token)
responses = qualtrics.getLegacyResponseData(SurveyID=survey_id)
for response_id, response in responses.items():
print response_id + " - " + response["Finished"]
def test_get_survey_unauthorized(self):
qualtrics = Qualtrics(self.user, "123")
result = qualtrics.getSurvey(self.survey_id)
self.assertEqual(result, None)
self.assertEqual(qualtrics.last_error_message,
"API Error: HTTP Code 401 (Unauthorized)")
import sys
import random
import string
from pyqualtrics import Qualtrics
import os
user = None # os.environ["QUALTRICS_USER"]
token = None # os.environ["QUALTRICS_TOKEN"]
if __name__ == "__main__":
print "This is an example of sending a survey"
print "Make sure you have set QUALTRICS_USER, QUALTRICS_TOKEN, QUALTRICS_LIBRARY_ID, QUALTRICS_SURVEY_ID " \
"and QUALTRICS_MESSAGE_ID enviroment variables"
# Note is user and token are None, QUALTRICS_USER and QUALTRICS_TOKEN environment variables will be used instead
qualtrics = Qualtrics(user, token)
library_id = os.environ["QUALTRICS_LIBRARY_ID"]
survey_id = os.environ["QUALTRICS_SURVEY_ID"]
message_id = os.environ["QUALTRICS_MESSAGE_ID"]
panel_id = qualtrics.createPanel(
LibraryID=library_id,
Name="Test Panel created by pyqualtrics example (DELETE ME)"
)
if panel_id is None:
print "Error creating panel: %s" % qualtrics.last_error_message
sys.exit(-1)
# random_prefix is required because you can't send same survey to the same email twice
import sys
import random
import string
from pyqualtrics import Qualtrics
import os
user = None # os.environ["QUALTRICS_USER"]
token = None # os.environ["QUALTRICS_TOKEN"]
if __name__ == "__main__":
print "This is an example of sending a survey"
print "Make sure you have set QUALTRICS_USER, QUALTRICS_TOKEN, QUALTRICS_LIBRARY_ID, QUALTRICS_SURVEY_ID " \
"and QUALTRICS_MESSAGE_ID enviroment variables"
# Note is user and token are None, QUALTRICS_USER and QUALTRICS_TOKEN environment variables will be used instead
qualtrics = Qualtrics(user, token)
library_id = os.environ["QUALTRICS_LIBRARY_ID"]
survey_id = os.environ["QUALTRICS_SURVEY_ID"]
message_id = os.environ["QUALTRICS_MESSAGE_ID"]
panel_id = qualtrics.createPanel(
LibraryID=library_id,
Name="Test Panel created by pyqualtrics example (DELETE ME)")
if panel_id is None:
print "Error creating panel: %s" % qualtrics.last_error_message
sys.exit(-1)
# random_prefix is required because you can't send same survey to the same email twice
random_prefix = ''.join(
# 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.
from pyqualtrics import Qualtrics
import os
user = None # os.environ["QUALTRICS_USER"]
token = None # os.environ["QUALTRICS_TOKEN"]
if __name__ == "__main__":
print "This is an example of panel import"
print "Make sure you have set QUALTRICS_USER, QUALTRICS_TOKEN and QUALTRICS_LIBRARY_ID enviroment variable"
# Note is user and token are None, QUALTRICS_USER and QUALTRICS_TOKEN environment variables will be used instead
qualtrics = Qualtrics(user, token)
library_id = os.environ["QUALTRICS_LIBRARY_ID"]
panel_id = qualtrics.importJsonPanel(
library_id,
Name="New Panel Created by PyQualtrics library (DELETE ME)",
panel=[
{"Email": "*****@*****.**", "FirstName": "PyQualtrics", "LastName": "Library", "SubjectID": "123"},
{"Email": "*****@*****.**", "FirstName": "PyQualtrics2", "LastName": "Library2"}
],
headers=["Email", "FirstName", "LastName", "ExternalRef", "SubjectID"],
AllED=1)
if qualtrics.last_error_message:
print "Error creating panel: " + qualtrics.last_error_message
else:
print "Panel created successfully, PanelID: " + panel_id
class TestQualtrics(unittest.TestCase):
def setUp(self):
self.user = os.environ["QUALTRICS_USER"]
self.token = os.environ["QUALTRICS_TOKEN"]
self.library_id = os.environ["QUALTRICS_LIBRARY_ID"]
self.survey_id = os.environ.get("QUALTRICS_SURVEY_ID", None)
self.message_id = os.environ.get("QUALTRICS_MESSAGE_ID", None)
self.response_id = os.environ.get("QUALTRICS_RESPONSE_ID", None)
self.qualtrics = Qualtrics(self.user, self.token)
def test_str(self):
self.assertEqual(str(self.qualtrics), self.user)
def test_creation_errors(self):
panel_id = self.qualtrics.createPanel(LibraryID="",
Name="Hello",
User="******")
self.assertIsNone(panel_id)
self.assertIsNotNone(self.qualtrics.last_error_message)
# message can be "Incorrect Username or Password" or "User Account Disabled"
# self.assertEqual(self.qualtrics.last_error_message, "Incorrect Username or Password")
# We can't really test for invalid token error, because Qualtrics disables account
# if there are too many failed login attempts.
# For example:
# "Too many failed login attempts. Your account has been disabled for 10 minutes."
# self.assertEqual(message, "Invalid token")
# Create panel with non-existing library id
panel_id = self.qualtrics.createPanel(
LibraryID="",
Name="Hello")
self.assertIsNone(panel_id)
self.assertEqual(self.qualtrics.last_error_message,
"Invalid request. Missing or invalid parameter LibraryID.")
def test_create_and_delete(self):
# Note you may need to login and logout to see new panel in Qualtrics interface
panel_id = self.qualtrics.createPanel(
LibraryID=self.library_id,
Name="Test Panel created by pyqualtrics library (DELETE ME)"
)
self.assertIsNotNone(panel_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
count = self.qualtrics.getPanelMemberCount(self.library_id, panel_id)
self.assertEqual(count, 0)
# random_prefix is required because you can't send same survey to the same email twice
random_prefix = ''.join(random.choice(string.ascii_uppercase + string.digits) for _ in range(6))
recipient_id = self.qualtrics.addRecipient(
self.library_id,
panel_id,
FirstName="Fake",
LastName="Subject",
Email="*****@*****.**" % random_prefix,
ExternalDataRef=None,
Language="EN",
ED={"SubjectID": "123"}
)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(recipient_id)
recipient = self.qualtrics.getRecipient(LibraryID=self.library_id, RecipientID=recipient_id)
self.assertEqual(recipient["FirstName"], "Fake")
self.assertEqual(recipient["LastName"], "Subject")
self.assertEqual(recipient["Language"], "EN")
self.assertIsNone(recipient["ExternalDataReference"])
self.assertEqual(recipient["EmbeddedData"]["SubjectID"], "123")
count = self.qualtrics.getPanelMemberCount(self.library_id, panel_id)
self.assertEqual(count, 1)
if self.survey_id is not None and self.message_id is not None:
# Test email delivery if SurveyID and MessageID have been provided
distribution_id = self.qualtrics.sendSurveyToIndividual(
SendDate="2015-12-12 19:48:28",
FromEmail="*****@*****.**",
FromName="PyQualtrics Library",
MessageID=self.message_id,
MessageLibraryID=self.library_id,
Subject="Why, hello there",
SurveyID=self.survey_id,
PanelID=panel_id,
PanelLibraryID=self.library_id,
RecipientID=recipient_id)
self.assertIsNotNone(distribution_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
result = self.qualtrics.getDistributions(LibraryID=self.library_id,
SurveyID=self.survey_id,
DistributionID=distribution_id)
self.assertIsNotNone(result)
xml = self.qualtrics.getSurvey(SurveyID=self.survey_id)
self.assertIsNotNone(xml)
self.assertIsNone(self.qualtrics.json_response)
self.assertIsNone(self.qualtrics.last_error_message)
data = self.qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertIsNotNone(data)
self.assertIsNotNone(self.qualtrics.json_response)
self.assertIsNone(self.qualtrics.last_error_message)
if self.response_id is not None and self.survey_id is not None:
response = self.qualtrics.getResponse(SurveyID=self.survey_id, ResponseID=self.response_id)
self.assertIsNotNone(response)
self.assertIsNone(self.qualtrics.last_error_message)
response = self.qualtrics.getResponse(SurveyID=self.survey_id, ResponseID="abc")
self.assertIsNone(response)
self.assertEqual(self.qualtrics.last_error_message, "Invalid request. Missing or invalid parameter ResponseID.") # noqa
result = self.qualtrics.removeRecipient(LibraryID=self.library_id,
PanelID=panel_id,
RecipientID=recipient_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertEqual(result, True)
count = self.qualtrics.getPanelMemberCount(self.library_id, panel_id)
self.assertEqual(count, 0)
result = self.qualtrics.deletePanel(
LibraryID=self.library_id,
PanelID=panel_id)
self.assertEqual(result, True)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
def test_send_survey_to_panel(self):
panel_id = self.qualtrics.createPanel(
LibraryID=self.library_id,
Name="Test Panel for send_survey_to_panel pyqualtrics (DELETE ME)"
)
# random_prefix is required because you can't send same survey to the same email twice
random_prefix = ''.join(random.choice(string.ascii_uppercase + string.digits) for _ in range(6))
recipient_id = self.qualtrics.addRecipient(
self.library_id,
panel_id,
FirstName="Panel",
LastName="Subject",
Email="*****@*****.**" % random_prefix,
ExternalDataRef=None,
Language="EN",
ED={"SubjectID": "123"}
)
email_distribution_id = self.qualtrics.sendSurveyToPanel(
SendDate="2015-12-12 19:48:28",
FromEmail="*****@*****.**",
FromName="PyQualtrics Library",
MessageID=self.message_id,
MessageLibraryID=self.library_id,
Subject="Why, hello there - sendSurveyToPanel",
SurveyID=self.survey_id,
PanelID=panel_id,
PanelLibraryID=self.library_id,
SentFromAddress=None,
LinkType="Multiple",
)
self.assertIsNotNone(email_distribution_id)
self.qualtrics.deletePanel(self.library_id, panel_id)
def test_get_panels(self):
result = self.qualtrics.getPanels(self.library_id)
self.assertIsNotNone(result)
def test_panel_errors(self):
result = self.qualtrics.removeRecipient(LibraryID=self.library_id,
PanelID="",
RecipientID="")
self.assertEqual(result, False)
self.assertEqual(
self.qualtrics.last_error_message,
"Invalid request. Missing or invalid parameter RecipientID."
)
def test_deletion_errors(self):
result = self.qualtrics.deletePanel(LibraryID="",
PanelID="",
User="******")
self.assertEqual(result, False)
self.assertIsNotNone(self.qualtrics.last_error_message)
# Different error messages can be returned
# "Incorrect Username or Password"
# "Account Locked"
# We can't really test for invalid token error, because Qualtrics disables account
# if there are too many failed login attempts
# For example:
# "Too many failed login attempts. Your account has been disabled for 10 minutes."
result = self.qualtrics.deletePanel(LibraryID="",
PanelID="Hello")
self.assertEqual(result, False)
self.assertEqual(self.qualtrics.last_error_message,
"Invalid request. Missing or invalid parameter LibraryID.")
def test_json_import(self):
panel_id = self.qualtrics.importJsonPanel(
self.library_id,
Name="Panel for testing JSON Import",
panel=[
{"Email": "*****@*****.**", "FirstName": "PyQualtrics", "LastName": "Library"},
{"Email": "*****@*****.**", "FirstName": "PyQualtrics2", "LastName": "Library2"}
])
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(panel_id)
self.assertIsNotNone(self.qualtrics.json_response)
count = self.qualtrics.getPanelMemberCount(self.library_id, panel_id)
self.assertEqual(count, 2)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
subjects = self.qualtrics.getPanel(self.library_id, panel_id)
self.assertEqual(len(subjects), 2)
self.assertEqual(subjects[0]["LastName"], "Library")
self.assertEqual(subjects[1]["FirstName"], "PyQualtrics2")
new_panel_id = self.qualtrics.importJsonPanel(
self.library_id,
Name="Panel for testing JSON Import",
PanelID=panel_id,
panel=[
{"Email": "*****@*****.**", "FirstName": "PyQualtrics", "LastName": "Library3"},
{"Email": "*****@*****.**", "FirstName": "PyQualtrics2", "LastName": "Library4"}
])
count = self.qualtrics.getPanelMemberCount(self.library_id, panel_id)
self.assertEqual(count, 4)
self.assertEqual(new_panel_id, panel_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
# This one should not be successful
result = self.qualtrics.importJsonPanel(
self.library_id,
Name="Panel for testing JSON Import",
PanelID=panel_id,
headers=["FirstName", "LastName"],
panel=[
{"FirstName": "PyQualtrics", "LastName": "Library3"},
{"FirstName": "PyQualtrics2", "LastName": "Library4"}
])
self.assertEqual(result, None)
self.assertEqual(self.qualtrics.last_error_message, "Invalid request. Missing or invalid parameter Email.")
count = self.qualtrics.getPanelMemberCount(self.library_id, panel_id)
self.assertEqual(count, 4)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
result = self.qualtrics.deletePanel(
LibraryID=self.library_id,
PanelID=panel_id)
self.assertEqual(result, True)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
def test_json_import_with_embedded_data(self):
panel_id = self.qualtrics.importJsonPanel(
self.library_id,
Name="Panel for testing JSON Import",
panel=[
{"Email": "*****@*****.**", "FirstName": "PyQualtrics", "LastName": "Library", "SubjectID": "SUBJ0001"}, # noqa
{"Email": "*****@*****.**", "FirstName": "PyQualtrics2", "LastName": "Library2"}
],
headers=["Email", "FirstName", "LastName", "ExternalRef", "SubjectID"],
AllED=1)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(panel_id)
self.assertIsNotNone(self.qualtrics.json_response)
count = self.qualtrics.getPanelMemberCount(self.library_id, panel_id)
self.assertEqual(count, 2)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
subjects = self.qualtrics.getPanel(self.library_id, panel_id)
self.assertEqual(len(subjects), 2)
self.assertEqual(subjects[0]["LastName"], "Library")
self.assertEqual(subjects[1]["FirstName"], "PyQualtrics2")
self.assertEqual(subjects[0]["EmbeddedData"]["SubjectID"], "SUBJ0001")
result = self.qualtrics.deletePanel(
LibraryID=self.library_id,
PanelID=panel_id)
self.assertEqual(result, True)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(self.qualtrics.json_response)
def test_import_survey_errors(self):
# Survey contents is invalid
result = self.qualtrics.importSurvey(
ImportFormat="QSF",
Name="Test survey import (DELETE ME - 1)",
FileContents="123"
)
self.assertFalse(result)
self.assertEqual(
self.qualtrics.last_error_message,
"Error parsing file: The file does not appear to be a valid survey")
# Unknown survey format
result = self.qualtrics.importSurvey(
ImportFormat="_",
Name="Test survey import (DELETE ME - 2)",
FileContents="123"
)
self.assertFalse(result)
self.assertEqual(
self.qualtrics.last_error_message,
"Invalid request. Missing or invalid parameter ImportFormat.")
def test_import_survey(self):
survey_id = self.qualtrics.importSurvey(
ImportFormat="QSF",
Name="Test survey import (DELETE ME - 3)",
FileContents=open(os.path.join(base_dir, "pyqualtrics.qsf")).read()
)
self.assertIsNotNone(survey_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIn(survey_id, self.qualtrics.getSurveys())
self.assertIsNone(self.qualtrics.last_error_message)
result = self.qualtrics.activateSurvey(SurveyID=survey_id)
self.assertTrue(result)
result = self.qualtrics.deactivateSurvey(SurveyID=survey_id)
self.assertTrue(result)
result = self.qualtrics.deleteSurvey(SurveyID=survey_id)
self.assertTrue(result)
def test_import_survey_from_url(self):
survey_id = self.qualtrics.importSurvey(
ImportFormat="QSF",
Name="Test survey import (DELETE ME - curatend)",
# URL="https://curate.nd.edu/downloads/xs55m903893",
URL="https://github.com/Baguage/pyqualtrics/raw/master/tests/pyqualtrics.qsf",
)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIsNotNone(survey_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertIn(survey_id, self.qualtrics.getSurveys())
self.assertIsNone(self.qualtrics.last_error_message)
result = self.qualtrics.deleteSurvey(SurveyID=survey_id)
self.assertTrue(result)
def test_delete_survey_fails(self):
self.assertFalse(self.qualtrics.deleteSurvey(SurveyID="123"))
def test_activate_survey_fails(self):
self.assertFalse(self.qualtrics.activateSurvey(SurveyID="123"))
self.assertFalse(self.qualtrics.deactivateSurvey(SurveyID="123"))
def test_single_response_html(self):
result = self.qualtrics.getSingleResponseHTML(SurveyID=self.survey_id, ResponseID=self.response_id)
self.assertIsNotNone(result)
self.assertTrue("DOCTYPE html PUBLIC" in result)
def test_get_legacy_response_data(self):
"""
WARNING!!!
This test requires a partially completed response in "getLegacyData test" survey (SV_8pqqcl4sy2316ZL),
and it will closed after 6 month (max timeout allowed by Qualtrics). Thus every 6 month new
partially completed response should be created.
Use link https://nd.qualtrics.com/jfe/form/SV_8pqqcl4sy2316ZL and answer "Male". Don't answer the second question
:return:
"""
# Get completed responses
responses = self.qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertIsNotNone(responses)
self.assertEqual(len(responses), 3)
key, response = responses.popitem(last=False)
self.assertEqual(response["SubjectID"], "PY0001")
# Note if response was imported to Qualtrics, Finished is a string, not a number
self.assertEqual(response["Finished"], '1')
self.assertEqual(response["Q1"], 1)
self.assertEqual(response["Q2"], 3)
key, response = responses.popitem(last=False)
self.assertEqual(response["SubjectID"], "")
self.assertEqual(response["Finished"], '1')
self.assertEqual(response["Q1"], 1)
self.assertEqual(response["Q2"], 3)
key, response = responses.popitem(last=False)
self.assertEqual(response["SubjectID"], "TEST0001")
self.assertEqual(response["Finished"], '1')
self.assertEqual(response["Q1"], 2)
self.assertEqual(response["Q2"], 1)
# Note that responses in progress do not have ResponseID, they have Survey Session ID instead
# When response is completed, Survey Session ID is gone and new ResponseID is assigned
responses = self.qualtrics.getLegacyResponseData(SurveyID=self.survey_id, ResponsesInProgress=1)
self.assertIsNotNone(responses)
self.assertEqual(len(responses), 1)
for survey_session_id, response in responses.iteritems():
self.assertEqual(response["SubjectID"], "")
self.assertEqual(response["Finished"], 0)
self.assertEqual(response["Q1"], 1)
self.assertEqual(response["Q2"], "")
def test_get_legacy_response_data_wrong_last_response_id(self):
responses = self.qualtrics.getLegacyResponseData(SurveyID=self.survey_id, LastResponseID="123")
self.assertEqual(responses, None)
self.assertEqual(self.qualtrics.last_error_message, "Invalid request. Missing or invalid parameter LastResponseID.")
def test_get_response(self):
response = self.qualtrics.getResponse(SurveyID=self.survey_id, ResponseID=self.response_id)
self.assertIsNotNone(response)
self.assertEqual(response["SubjectID"], "PY0001")
self.assertEqual(response["Finished"], '1')
self.assertEqual(response["Q1"], 1)
self.assertEqual(response["Q2"], 3)
def test_create_distribution(self):
panel_id = self.qualtrics.createPanel(self.library_id, "(DELETE ME) Panel for testing distributions")
distribution_id = self.qualtrics.createDistribution(
SurveyID=self.survey_id,
PanelID=panel_id,
Description="Test distribution",
PanelLibraryID=self.library_id)
self.qualtrics.deletePanel(self.library_id, panel_id)
self.assertIsNotNone(distribution_id)
self.assertIsNone(self.qualtrics.last_error_message)
def test_generate_unique_survey_link(self):
panel_id = self.qualtrics.createPanel(self.library_id, "(DELETE ME) Panel for testing unique links")
distribution_id = self.qualtrics.createDistribution(
SurveyID=self.survey_id,
PanelID=panel_id,
Description="Test distribution",
PanelLibraryID=self.library_id)
link1 = self.qualtrics.generate_unique_survey_link(
SurveyID=self.survey_id,
LibraryID=self.library_id,
PanelID=panel_id,
DistributionID=distribution_id,
FirstName="Py",
LastName="Qualtrics",
Email="*****@*****.**",
)
self.assertIsNotNone(link1)
self.assertIsNone(self.qualtrics.last_error_message)
link2 = self.qualtrics.generate_unique_survey_link(
SurveyID=self.survey_id,
LibraryID=self.library_id,
PanelID=panel_id,
DistributionID=distribution_id,
FirstName="Py",
LastName="Qualtrics",
Email="*****@*****.**",
)
self.assertIsNotNone(link2)
self.assertNotEquals(link1, link2)
self.assertIsNone(self.qualtrics.last_error_message)
link3 = self.qualtrics.generate_unique_survey_link(
SurveyID=self.survey_id,
LibraryID=self.library_id,
PanelID=panel_id,
DistributionID=distribution_id,
FirstName="Py",
LastName="Qualtrics",
Email="*****@*****.**",
EmbeddedData={"SubjectID": "TEST0001"}
)
self.assertIsNotNone(link3)
self.assertNotEquals(link1, link3)
self.assertNotEquals(link2, link3)
self.assertIsNone(self.qualtrics.last_error_message)
link4 = self.qualtrics.generate_unique_survey_link(
SurveyID="",
LibraryID=self.library_id,
PanelID=panel_id,
DistributionID=distribution_id,
FirstName="Py",
LastName="Qualtrics",
Email="*****@*****.**",
)
self.assertIsNone(link4)
self.assertIsNotNone(self.qualtrics.last_error_message)
link5 = self.qualtrics.generate_unique_survey_link(
SurveyID=self.survey_id,
LibraryID="",
PanelID=panel_id,
DistributionID=distribution_id,
FirstName="Py",
LastName="Qualtrics",
Email="*****@*****.**",
)
self.assertIsNone(link5)
self.assertIsNotNone(self.qualtrics.last_error_message)
self.qualtrics.deletePanel(self.library_id, panel_id)
self.assertIsNone(self.qualtrics.last_error_message)
def test_import_responses_and_update_embedded_data(self):
survey_id = self.qualtrics.importSurvey(
ImportFormat="QSF",
Name="Test importResponses (DELETE ME - 4)",
FileContents=open(os.path.join(base_dir, "pyqualtrics-ed.qsf")).read()
)
self.assertIsNotNone(survey_id)
self.assertIsNone(self.qualtrics.last_error_message)
result = self.qualtrics.importResponses(
survey_id,
FileContents=open(os.path.join(base_dir, "response.csv")).read()
)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertTrue(result)
responses = self.qualtrics.getLegacyResponseData(survey_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertEqual(len(responses), 1)
for response_id in responses:
response = responses[response_id]
self.assertEqual(response["Finished"], "1")
self.assertEqual(response["Q1"], 1)
self.assertEqual(response["Q2"], 1)
# Note that Embedded Data must be declared in Survey
# before they can be updated with updateResponseEmbeddedData function
self.qualtrics.updateResponseEmbeddedData(
survey_id,
response_id,
ED={"TEST": "Yay!"}
)
responses = self.qualtrics.getLegacyResponseData(survey_id)
for response_id in responses:
response = responses[response_id]
self.assertEqual(response["TEST"], "Yay!")
self.assertIn(response["Q_ID"], "")
# print responses
self.qualtrics.deleteSurvey(survey_id)
def test_import_responses_as_dict(self):
survey_id = self.qualtrics.importSurvey(
ImportFormat="QSF",
Name="Test responses_as_dict import (DELETE ME - 4)",
FileContents=open(os.path.join(base_dir, "pyqualtrics.qsf")).read()
)
self.assertIsNotNone(survey_id)
self.assertIsNone(self.qualtrics.last_error_message)
result = self.qualtrics.importResponsesAsDict(
survey_id,
[{"startDate": "", "endDate": "", "QID1": 1, "QID2": 2}],
# [{"Finished": "1", "Q1": 2, "Q2": 1}],
)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertTrue(result)
responses = self.qualtrics.getLegacyResponseData(survey_id)
self.assertIsNone(self.qualtrics.last_error_message)
self.assertEqual(len(responses), 1)
for response_id in responses:
response = responses[response_id]
self.assertEqual(response["Finished"], "1")
self.assertEqual(response["Q1"], 1)
self.assertEqual(response["Q2"], 2)
self.qualtrics.deleteSurvey(survey_id)
# def test_subscriptions(self):
# print("Subscriptions")
# self.qualtrics.getAllSubscriptions()
# print(self.qualtrics.last_url)
# print(self.qualtrics.last_error_message)
#
# result = self.qualtrics.subscribe(
# Name="New responses",
# PublicationURL="https://wellbeing.crc.nd.edu",
# Topics="surveyengine.completedResponse." + self.survey_id
# )
# print(result)
# print(self.qualtrics.last_url)
# print(self.qualtrics.last_error_message)
#
# self.assertFalse(True)
def test_connection_error_invalid_url(self):
url = self.qualtrics.url
self.qualtrics.url = "http://blablabla.bla"
responses = self.qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertIsNone(responses)
self.assertIsNone(self.qualtrics.last_status_code)
self.assertIn("Max retries exceeded with url", self.qualtrics.last_error_message)
# Restore API URL for tearDown() function
self.qualtrics.url = url
def test_connection_error_invalid_ip_address(self):
url = self.qualtrics.url
self.qualtrics.url = "http://0.0.0.0"
responses = self.qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertIsNone(responses)
self.assertIsNone(self.qualtrics.last_status_code)
self.assertIn("Max retries exceeded with url", self.qualtrics.last_error_message)
# Restore API URL for tearDown() function
self.qualtrics.url = url
def test_not_a_json_document_google_com(self):
qualtrics = Qualtrics(self.user, "123")
qualtrics.url = "https://google.com"
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertEquals(qualtrics.last_error_message, "Unexpected response from Qualtrics: not a JSON document")
self.assertIsNone(qualtrics.json_response)
self.assertIsNone(result)
def test_ssl_error_1(self):
# This only works on Notre Dame VPN
qualtrics = Qualtrics(self.user, "123")
qualtrics.url = "https://vecnet-ingest.crc.nd.edu/"
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertIn("CERTIFICATE_VERIFY_FAILED", qualtrics.last_error_message)
qualtrics.requests_kwargs = {"verify": False}
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertNotIn("CERTIFICATE_VERIFY_FAILED", qualtrics.last_error_message)
def test_ssl_error_2(self):
# This may fail is 129.74.247.12 is down or certificate error is corrected
qualtrics = Qualtrics(self.user, "123")
qualtrics.url = "https://129.74.247.12/"
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
# Error: hostname '129.74.247.12' doesn't match either of '*.vecnet.org', 'vecnet.org'
self.assertIn("129.74.247.12", qualtrics.last_error_message)
qualtrics.requests_kwargs = {"verify": False}
result = qualtrics.getLegacyResponseData(SurveyID=self.survey_id)
self.assertNotIn("CERTIFICATE_VERIFY_FAILED", qualtrics.last_error_message)
def tearDown(self):
# Note that tearDown is called after EACH test
# Remove all surveys with (DELETE ME in their name
for survey_id, survey in self.qualtrics.getSurveys().iteritems():
if "(DELETE ME" in survey["SurveyName"]:
print("Deleting survey %s" % survey["SurveyName"])
self.qualtrics.deleteSurvey(SurveyID=survey_id)