async def test_authenticator_returns_username_in_auth_state_with_person_sourcedid(
jws,
get_jwt_id_token,
make_mock_request_handler,
mock_nbhelper,
):
'''
Do we get a valid username when only including lis person sourcedid resource link request?
'''
authenticator = LTI13Authenticator()
request_handler = make_mock_request_handler(RequestHandler,
authenticator=authenticator)
jws['name'] = ''
jws['given_name'] = ''
jws['family_name'] = ''
jws['email'] = ''
jws['https://purl.imsglobal.org/spec/lti/claim/lis'][
'person_sourcedid'] = 'abc123'
with patch.object(
RequestHandler,
'get_argument',
return_value=get_jwt_id_token(jws),
):
with patch.object(LTI13LaunchValidator,
'validate_launch_request',
return_value=True):
result = await authenticator.authenticate(request_handler)
assert result['name'] == 'abc123'
async def test_authenticator_returns_student_role_in_auth_state_with_student_role(
jws,
get_jwt_id_token,
make_mock_request_handler,
mock_nbhelper,
):
'''
Do we set the student role in the auth_state when receiving a valid resource link request with the Student role?
'''
authenticator = LTI13Authenticator()
request_handler = make_mock_request_handler(RequestHandler,
authenticator=authenticator)
# set our role to test
jws['https://purl.imsglobal.org/spec/lti/claim/roles'] = [
'http://purl.imsglobal.org/vocab/lis/v2/institution/person#Student'
]
with patch.object(
RequestHandler,
'get_argument',
return_value=get_jwt_id_token(jws),
):
with patch.object(LTI13LaunchValidator,
'validate_launch_request',
return_value=True):
result = await authenticator.authenticate(request_handler)
assert result['auth_state']['user_role'] == 'Learner'
async def test_authenticator_returns_username_in_auth_state_with_family_name(
jws,
get_jwt_id_token,
make_mock_request_handler,
mock_nbhelper,
):
'''
Do we get a valid username when only including the family name in the resource link request?
'''
authenticator = LTI13Authenticator()
request_handler = make_mock_request_handler(RequestHandler,
authenticator=authenticator)
jws['name'] = ''
jws['given_name'] = ''
jws['family_name'] = 'Family name'
jws['email'] = ''
with patch.object(
RequestHandler,
'get_argument',
return_value=get_jwt_id_token(jws),
):
with patch.object(LTI13LaunchValidator,
'validate_launch_request',
return_value=True):
result = await authenticator.authenticate(request_handler)
assert result['name'] == 'family_name'
async def test_authenticator_returns_auth_state_name_from_lti13_email_claim(
jws,
get_jwt_id_token,
make_mock_request_handler,
mock_nbhelper,
):
'''
Do we get a valid username when only including an email to the resource link request?
'''
authenticator = LTI13Authenticator()
request_handler = make_mock_request_handler(RequestHandler,
authenticator=authenticator)
lti13_json = jws
lti13_json['name'] = ''
lti13_json['given_name'] = ''
lti13_json['family_name'] = ''
lti13_json['email'] = '*****@*****.**'
with patch.object(
RequestHandler,
'get_argument',
return_value=get_jwt_id_token(lti13_json),
):
with patch.object(LTI13LaunchValidator,
'validate_launch_request',
return_value=True):
result = await authenticator.authenticate(request_handler)
assert result['name'] == 'usertest'
async def test_authenticator_returns_auth_state_with_course_id_normalized(
make_auth_state_dict,
jws,
get_jwt_id_token,
make_mock_request_handler,
mock_nbhelper,
):
'''
Do we get a valid course_id when receiving a valid resource link request?
'''
authenticator = LTI13Authenticator()
request_handler = make_mock_request_handler(RequestHandler,
authenticator=authenticator)
# change the context label to uppercase
link_request = jws
link_request['https://purl.imsglobal.org/spec/lti/claim/context'][
'label'] = 'CourseID-WITH_LARGE NAME'
with patch.object(
RequestHandler,
'get_argument',
return_value=get_jwt_id_token(link_request),
):
with patch.object(LTI13LaunchValidator,
'validate_launch_request',
return_value=True):
result = await authenticator.authenticate(request_handler)
assert result['auth_state'][
'course_id'] == 'courseid-with_large_name'
async def test_authenticator_invokes_lti13validator_jwt_verify_and_decode(
jws, make_mock_request_handler, mock_nbhelper):
'''
Does the authenticator invoke the LTI13Validator jwt_verify_and_decode method?
'''
authenticator = LTI13Authenticator()
request_handler = make_mock_request_handler(RequestHandler,
authenticator=authenticator)
with patch.object(RequestHandler, 'get_argument', return_value=None):
with patch.object(
LTI13LaunchValidator,
'jwt_verify_and_decode',
return_value=jws,
) as mock_verify_and_decode:
_ = await authenticator.authenticate(request_handler)
assert mock_verify_and_decode.called
async def test_authenticator_invokes_lti13validator_handler_get_argument(
get_jwt_id_token,
jws,
make_mock_request_handler,
mock_nbhelper,
):
'''
Does the authenticator invoke the RequestHandler get_argument method?
'''
authenticator = LTI13Authenticator()
request_handler = make_mock_request_handler(RequestHandler,
authenticator=authenticator)
with patch.object(
request_handler,
'get_argument',
return_value=get_jwt_id_token(jws),
) as mock_get_argument:
_ = await authenticator.authenticate(request_handler)
assert mock_get_argument.called
async def test_authenticator_invokes_lti13validator_validate_launch_request(
jws,
get_jwt_id_token,
make_mock_request_handler,
mock_nbhelper,
):
'''
Does the authenticator invoke the LTI13Validator validate_launch_request method?
'''
authenticator = LTI13Authenticator()
request_handler = make_mock_request_handler(RequestHandler,
authenticator=authenticator)
with patch.object(
RequestHandler,
'get_argument',
return_value=get_jwt_id_token(jws),
):
with patch.object(
LTI13LaunchValidator, 'validate_launch_request',
return_value=True) as mock_verify_authentication_request:
_ = await authenticator.authenticate(request_handler)
assert mock_verify_authentication_request.called
async def test_authenticator_returns_course_id_in_auth_state_with_valid_resource_link_request(
make_auth_state_dict,
jws,
get_jwt_id_token,
make_mock_request_handler,
mock_nbhelper,
):
'''
Do we get a valid course_id when receiving a valid resource link request?
'''
authenticator = LTI13Authenticator()
request_handler = make_mock_request_handler(RequestHandler,
authenticator=authenticator)
with patch.object(
RequestHandler,
'get_argument',
return_value=get_jwt_id_token(jws),
):
with patch.object(LTI13LaunchValidator,
'validate_launch_request',
return_value=True):
result = await authenticator.authenticate(request_handler)
assert result['auth_state']['course_id'] == 'intro101'
async def test_authenticator_invokes_lti_helper_format_string(
jws,
get_jwt_id_token,
make_mock_request_handler,
mock_nbhelper,
):
'''
Does the authenticator invoke the LTIHelper format_string method?
'''
authenticator = LTI13Authenticator()
request_handler = make_mock_request_handler(RequestHandler,
authenticator=authenticator)
with patch.object(
RequestHandler,
'get_argument',
return_value=get_jwt_id_token(jws),
):
with patch.object(LTI13LaunchValidator,
'validate_launch_request',
return_value=True):
with patch.object(LTIHelper, 'format_string',
return_value=True) as mock_format_string:
_ = await authenticator.authenticate(request_handler)
assert mock_format_string.called
async def test_authenticator_returns_learner_role_in_auth_state_with_empty_roles(
jws,
get_jwt_id_token,
make_mock_request_handler,
mock_nbhelper,
):
'''
Do we set the learner role in the auth_state when receiving resource link request
with empty roles?
'''
authenticator = LTI13Authenticator()
request_handler = make_mock_request_handler(RequestHandler,
authenticator=authenticator)
jws['https://purl.imsglobal.org/spec/lti/claim/roles'] = []
with patch.object(
RequestHandler,
'get_argument',
return_value=get_jwt_id_token(jws),
):
with patch.object(LTI13LaunchValidator,
'validate_launch_request',
return_value=True):
result = await authenticator.authenticate(request_handler)
assert result['auth_state']['user_role'] == 'Learner'
async def test_authenticator_returns_username_in_auth_state_with_privacy_enabled(
jws_with_privacy,
get_jwt_id_token,
make_mock_request_handler,
mock_nbhelper,
):
'''
Do we get a valid username when initiating the login flow with privacy enabled?
'''
authenticator = LTI13Authenticator()
request_handler = make_mock_request_handler(RequestHandler,
authenticator=authenticator)
with patch.object(
RequestHandler,
'get_argument',
return_value=get_jwt_id_token(jws_with_privacy),
):
with patch.object(LTI13LaunchValidator,
'validate_launch_request',
return_value=True):
result = await authenticator.authenticate(request_handler)
assert result['name'] == '4'
