Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
E
edx-platform
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
edx-platform
Commits
9e8a24bf
Commit
9e8a24bf
authored
Dec 17, 2013
by
e0d
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #1979 from edx/alex/lti_fixes_to_release
Alex/lti fixes to release
parents
a78400a8
cc2e4bfe
Expand all
Show whitespace changes
Inline
Side-by-side
Showing
10 changed files
with
201 additions
and
140 deletions
+201
-140
CHANGELOG.rst
+5
-2
common/djangoapps/student/models.py
+2
-2
common/lib/xmodule/xmodule/lti_module.py
+36
-27
common/lib/xmodule/xmodule/tests/test_lti_unit.py
+0
-0
common/lib/xmodule/xmodule/x_module.py
+3
-0
lms/djangoapps/courseware/features/lti_setup.py
+4
-0
lms/djangoapps/courseware/mock_lti_server/mock_lti_server.py
+71
-81
lms/djangoapps/courseware/mock_lti_server/server_start.py
+6
-0
lms/djangoapps/courseware/mock_lti_server/test_mock_lti_server.py
+56
-9
lms/djangoapps/courseware/tests/test_lti_integration.py
+18
-19
No files found.
CHANGELOG.rst
View file @
9e8a24bf
...
@@ -5,13 +5,16 @@ These are notable changes in edx-platform. This is a rolling list of changes,
...
@@ -5,13 +5,16 @@ These are notable changes in edx-platform. This is a rolling list of changes,
in roughly chronological order, most recent first. Add your entries at or near
in roughly chronological order, most recent first. Add your entries at or near
the top. Include a label indicating the component affected.
the top. Include a label indicating the component affected.
Blades: Make LTI module not send grade_back_url if has_score=False. BLD-561.
Blades: LTI additional Python tests. LTI must use HTTPS for
lis_outcome_service_url. BLD-564.
Blades: Fix bug when Image mapping problems are not working for students in IE. BLD-413.
Blades: Fix bug when Image mapping problems are not working for students in IE. BLD-413.
Blades: Add template that displays the most up-to-date features of
Blades: Add template that displays the most up-to-date features of
drag-and-drop. BLD-479.
drag-and-drop. BLD-479.
Blades: LTI additional Python tests. LTI fix bug e-reader error when popping
Blades: LTI fix bug e-reader error when popping out window. BLD-465.
out window. BLD-465.
Common: Switch from mitx.db to edx.db for sqlite databases. This will effectively
Common: Switch from mitx.db to edx.db for sqlite databases. This will effectively
reset state for local instances of the code, unless you manually rename your
reset state for local instances of the code, unless you manually rename your
...
...
common/djangoapps/student/models.py
View file @
9e8a24bf
...
@@ -46,8 +46,8 @@ class AnonymousUserId(models.Model):
...
@@ -46,8 +46,8 @@ class AnonymousUserId(models.Model):
Purpose of this table is to provide user by anonymous_user_id.
Purpose of this table is to provide user by anonymous_user_id.
We
are generating anonymous_user_id using md5 algorithm, so resulting length will always be 16 bytes.
We
generate anonymous_user_id using md5 algorithm,
http://docs.python.org/2/library/md5.html#md5.digest_size
and use result in hex form, so its length is equal to 32 bytes.
"""
"""
user
=
models
.
ForeignKey
(
User
,
db_index
=
True
)
user
=
models
.
ForeignKey
(
User
,
db_index
=
True
)
anonymous_user_id
=
models
.
CharField
(
unique
=
True
,
max_length
=
32
)
anonymous_user_id
=
models
.
CharField
(
unique
=
True
,
max_length
=
32
)
...
...
common/lib/xmodule/xmodule/lti_module.py
View file @
9e8a24bf
...
@@ -259,37 +259,22 @@ class LTIModule(LTIFields, XModule):
...
@@ -259,37 +259,22 @@ class LTIModule(LTIFields, XModule):
'element_class'
:
self
.
category
,
'element_class'
:
self
.
category
,
'open_in_a_new_page'
:
self
.
open_in_a_new_page
,
'open_in_a_new_page'
:
self
.
open_in_a_new_page
,
'display_name'
:
self
.
display_name
,
'display_name'
:
self
.
display_name
,
'form_url'
:
self
.
get_form_path
(
),
'form_url'
:
self
.
runtime
.
handler_url
(
self
,
'preview_handler'
)
.
rstrip
(
'/?'
),
}
}
def
get_form_path
(
self
):
return
self
.
runtime
.
handler_url
(
self
,
'preview_handler'
)
.
rstrip
(
'/?'
)
def
get_html
(
self
):
def
get_html
(
self
):
"""
"""
Renders parameters to template.
Renders parameters to template.
"""
"""
return
self
.
system
.
render_template
(
'lti.html'
,
self
.
get_context
())
return
self
.
system
.
render_template
(
'lti.html'
,
self
.
get_context
())
def
get_form
(
self
):
"""
Renders parameters to form template.
"""
return
self
.
system
.
render_template
(
'lti_form.html'
,
self
.
get_context
())
@XBlock.handler
@XBlock.handler
def
preview_handler
(
self
,
request
,
dispatch
):
def
preview_handler
(
self
,
_
,
__
):
"""
"""
Ajax handler.
This is called to get context with new oauth params to iframe.
Args:
dispatch: string request slug
Returns:
json string
"""
"""
return
Response
(
self
.
get_form
(),
content_type
=
'text/html'
)
template
=
self
.
system
.
render_template
(
'lti_form.html'
,
self
.
get_context
())
return
Response
(
template
,
content_type
=
'text/html'
)
def
get_user_id
(
self
):
def
get_user_id
(
self
):
user_id
=
self
.
runtime
.
anonymous_student_id
user_id
=
self
.
runtime
.
anonymous_student_id
...
@@ -299,8 +284,15 @@ class LTIModule(LTIFields, XModule):
...
@@ -299,8 +284,15 @@ class LTIModule(LTIFields, XModule):
def
get_outcome_service_url
(
self
):
def
get_outcome_service_url
(
self
):
"""
"""
Return URL for storing grades.
Return URL for storing grades.
To test LTI on sandbox we must use http scheme.
While testing locally and on Jenkins, mock_lti_server use http.referer
to obtain scheme, so it is ok to have http(s) anyway.
"""
"""
uri
=
'http://{host}{path}'
.
format
(
scheme
=
'http'
if
'sandbox'
in
self
.
system
.
hostname
else
'https'
uri
=
'{scheme}://{host}{path}'
.
format
(
scheme
=
scheme
,
host
=
self
.
system
.
hostname
,
host
=
self
.
system
.
hostname
,
path
=
self
.
runtime
.
handler_url
(
self
,
'grade_handler'
,
thirdparty
=
True
)
.
rstrip
(
'/?'
)
path
=
self
.
runtime
.
handler_url
(
self
,
'grade_handler'
,
thirdparty
=
True
)
.
rstrip
(
'/?'
)
)
)
...
@@ -363,11 +355,15 @@ class LTIModule(LTIFields, XModule):
...
@@ -363,11 +355,15 @@ class LTIModule(LTIFields, XModule):
# Parameters required for grading:
# Parameters required for grading:
u'resource_link_id'
:
self
.
get_resource_link_id
(),
u'resource_link_id'
:
self
.
get_resource_link_id
(),
u'lis_outcome_service_url'
:
self
.
get_outcome_service_url
(),
u'lis_result_sourcedid'
:
self
.
get_lis_result_sourcedid
(),
u'lis_result_sourcedid'
:
self
.
get_lis_result_sourcedid
(),
}
}
if
self
.
has_score
:
body
.
update
({
u'lis_outcome_service_url'
:
self
.
get_outcome_service_url
()
})
# Appending custom parameter for signing.
# Appending custom parameter for signing.
body
.
update
(
custom_parameters
)
body
.
update
(
custom_parameters
)
...
@@ -449,7 +445,7 @@ oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"'}
...
@@ -449,7 +445,7 @@ oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"'}
Example of correct/incorrect answer XML body:: see response_xml_template.
Example of correct/incorrect answer XML body:: see response_xml_template.
"""
"""
response_xml_template
=
textwrap
.
dedent
(
"""
response_xml_template
=
textwrap
.
dedent
(
"""
\
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<imsx_POXEnvelopeResponse xmlns = "http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0">
<imsx_POXEnvelopeResponse xmlns = "http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0">
<imsx_POXHeader>
<imsx_POXHeader>
...
@@ -491,6 +487,8 @@ oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"'}
...
@@ -491,6 +487,8 @@ oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"'}
try
:
try
:
imsx_messageIdentifier
,
sourcedId
,
score
,
action
=
self
.
parse_grade_xml_body
(
request
.
body
)
imsx_messageIdentifier
,
sourcedId
,
score
,
action
=
self
.
parse_grade_xml_body
(
request
.
body
)
except
Exception
:
except
Exception
:
log
.
debug
(
"[LTI]: Request body XML parsing error."
)
failure_values
[
'imsx_description'
]
=
'Request body XML parsing error.'
return
Response
(
response_xml_template
.
format
(
**
failure_values
),
content_type
=
"application/xml"
)
return
Response
(
response_xml_template
.
format
(
**
failure_values
),
content_type
=
"application/xml"
)
# Verify OAuth signing.
# Verify OAuth signing.
...
@@ -498,10 +496,15 @@ oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"'}
...
@@ -498,10 +496,15 @@ oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"'}
self
.
verify_oauth_body_sign
(
request
)
self
.
verify_oauth_body_sign
(
request
)
except
(
ValueError
,
LTIError
):
except
(
ValueError
,
LTIError
):
failure_values
[
'imsx_messageIdentifier'
]
=
escape
(
imsx_messageIdentifier
)
failure_values
[
'imsx_messageIdentifier'
]
=
escape
(
imsx_messageIdentifier
)
failure_values
[
'imsx_description'
]
=
'OAuth verification error.'
return
Response
(
response_xml_template
.
format
(
**
failure_values
),
content_type
=
"application/xml"
)
return
Response
(
response_xml_template
.
format
(
**
failure_values
),
content_type
=
"application/xml"
)
real_user
=
self
.
system
.
get_real_user
(
urllib
.
unquote
(
sourcedId
.
split
(
':'
)[
-
1
]))
real_user
=
self
.
system
.
get_real_user
(
urllib
.
unquote
(
sourcedId
.
split
(
':'
)[
-
1
]))
if
not
real_user
:
# that means we can't save to database, as we do not have real user id.
failure_values
[
'imsx_messageIdentifier'
]
=
escape
(
imsx_messageIdentifier
)
failure_values
[
'imsx_description'
]
=
'User not found.'
return
Response
(
response_xml_template
.
format
(
**
failure_values
),
content_type
=
"application/xml"
)
if
action
==
'replaceResultRequest'
:
if
action
==
'replaceResultRequest'
:
self
.
system
.
publish
(
self
.
system
.
publish
(
event
=
{
event
=
{
...
@@ -518,9 +521,11 @@ oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"'}
...
@@ -518,9 +521,11 @@ oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"'}
'imsx_messageIdentifier'
:
escape
(
imsx_messageIdentifier
),
'imsx_messageIdentifier'
:
escape
(
imsx_messageIdentifier
),
'response'
:
'<replaceResultResponse/>'
'response'
:
'<replaceResultResponse/>'
}
}
log
.
debug
(
"[LTI]: Grade is saved."
)
return
Response
(
response_xml_template
.
format
(
**
values
),
content_type
=
"application/xml"
)
return
Response
(
response_xml_template
.
format
(
**
values
),
content_type
=
"application/xml"
)
unsupported_values
[
'imsx_messageIdentifier'
]
=
escape
(
imsx_messageIdentifier
)
unsupported_values
[
'imsx_messageIdentifier'
]
=
escape
(
imsx_messageIdentifier
)
log
.
debug
(
"[LTI]: Incorrect action."
)
return
Response
(
response_xml_template
.
format
(
**
unsupported_values
),
content_type
=
'application/xml'
)
return
Response
(
response_xml_template
.
format
(
**
unsupported_values
),
content_type
=
'application/xml'
)
...
@@ -549,6 +554,7 @@ oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"'}
...
@@ -549,6 +554,7 @@ oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"'}
# Raise exception if score is not float or not in range 0.0-1.0 regarding spec.
# Raise exception if score is not float or not in range 0.0-1.0 regarding spec.
score
=
float
(
score
)
score
=
float
(
score
)
if
not
0
<=
score
<=
1
:
if
not
0
<=
score
<=
1
:
log
.
debug
(
"[LTI]: Score not in range."
)
raise
LTIError
raise
LTIError
return
imsx_messageIdentifier
,
sourcedId
,
score
,
action
return
imsx_messageIdentifier
,
sourcedId
,
score
,
action
...
@@ -578,7 +584,7 @@ oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"'}
...
@@ -578,7 +584,7 @@ oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"'}
sha1
=
hashlib
.
sha1
()
sha1
=
hashlib
.
sha1
()
sha1
.
update
(
request
.
body
)
sha1
.
update
(
request
.
body
)
oauth_body_hash
=
base64
.
b64encode
(
sha1
.
hex
digest
())
oauth_body_hash
=
base64
.
b64encode
(
sha1
.
digest
())
oauth_params
=
signature
.
collect_parameters
(
headers
=
headers
,
exclude_oauth_signature
=
False
)
oauth_params
=
signature
.
collect_parameters
(
headers
=
headers
,
exclude_oauth_signature
=
False
)
oauth_headers
=
dict
(
oauth_params
)
oauth_headers
=
dict
(
oauth_params
)
...
@@ -590,8 +596,11 @@ oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"'}
...
@@ -590,8 +596,11 @@ oauth_consumer_key="", oauth_signature="frVp4JuvT1mVXlxktiAUjQ7%2F1cw%3D"'}
params
=
oauth_headers
.
items
(),
params
=
oauth_headers
.
items
(),
signature
=
oauth_signature
signature
=
oauth_signature
)
)
if
(
oauth_body_hash
!=
oauth_headers
.
get
(
'oauth_body_hash'
)
or
if
oauth_body_hash
!=
oauth_headers
.
get
(
'oauth_body_hash'
):
not
signature
.
verify_hmac_sha1
(
mock_request
,
client_secret
)):
log
.
debug
(
"[LTI]: OAuth body hash verification is failed."
)
raise
LTIError
if
not
signature
.
verify_hmac_sha1
(
mock_request
,
client_secret
):
log
.
debug
(
"[LTI]: OAuth signature verification is failed."
)
raise
LTIError
raise
LTIError
def
get_client_key_secret
(
self
):
def
get_client_key_secret
(
self
):
...
...
common/lib/xmodule/xmodule/tests/test_lti_unit.py
View file @
9e8a24bf
This diff is collapsed.
Click to expand it.
common/lib/xmodule/xmodule/x_module.py
View file @
9e8a24bf
...
@@ -1016,6 +1016,9 @@ class ModuleSystem(ConfigurableFragmentWrapper, Runtime): # pylint: disable=abs
...
@@ -1016,6 +1016,9 @@ class ModuleSystem(ConfigurableFragmentWrapper, Runtime): # pylint: disable=abs
error_descriptor_class - The class to use to render XModules with errors
error_descriptor_class - The class to use to render XModules with errors
get_real_user - function that takes `anonymous_student_id` and returns real user_id,
associated with `anonymous_student_id`.
"""
"""
# Right now, usage_store is unused, and field_data is always supplanted
# Right now, usage_store is unused, and field_data is always supplanted
...
...
lms/djangoapps/courseware/features/lti_setup.py
View file @
9e8a24bf
...
@@ -38,6 +38,10 @@ def setup_mock_lti_server():
...
@@ -38,6 +38,10 @@ def setup_mock_lti_server():
'lti_endpoint'
:
'correct_lti_endpoint'
'lti_endpoint'
:
'correct_lti_endpoint'
}
}
# Flag for acceptance tests used for creating right callback_url and sending
# graded result. Used in MockLTIRequestHandler.
server
.
test_mode
=
True
# Store the server instance in lettuce's world
# Store the server instance in lettuce's world
# so that other steps can access it
# so that other steps can access it
# (and we can shut it down later)
# (and we can shut it down later)
...
...
lms/djangoapps/courseware/mock_lti_server/mock_lti_server.py
View file @
9e8a24bf
"""
LTI Server
What is supported:
------------------
1.) This LTI Provider can service only one Tool Consumer at the same time. It is
not possible to have this LTI multiple times on a single page in LMS.
"""
from
BaseHTTPServer
import
HTTPServer
,
BaseHTTPRequestHandler
from
BaseHTTPServer
import
HTTPServer
,
BaseHTTPRequestHandler
from
uuid
import
uuid4
from
uuid
import
uuid4
import
textwrap
import
textwrap
...
@@ -35,88 +45,48 @@ class MockLTIRequestHandler(BaseHTTPRequestHandler):
...
@@ -35,88 +45,48 @@ class MockLTIRequestHandler(BaseHTTPRequestHandler):
def
do_GET
(
self
):
def
do_GET
(
self
):
'''
'''
Handle a GET request from the client and sends response back.
Handle a GET request from the client and sends response back.
'''
Used for checking LTI Provider started correctly.
'''
self
.
send_response
(
200
,
'OK'
)
self
.
send_response
(
200
,
'OK'
)
self
.
send_header
(
'Content-type'
,
'html'
)
self
.
send_header
(
'Content-type'
,
'html'
)
self
.
end_headers
()
self
.
end_headers
()
response_str
=
"""<html><head><title>TEST TITLE</title></head>
response_str
=
"""<html><head><title>TEST TITLE</title></head>
<body>I have stored grades.</body></html>"""
<body>This is LTI Provider.</body></html>"""
self
.
wfile
.
write
(
response_str
)
self
.
wfile
.
write
(
response_str
)
self
.
_send_graded_result
()
def
do_POST
(
self
):
def
do_POST
(
self
):
'''
'''
Handle a POST request from the client and sends response back.
Handle a POST request from the client and sends response back.
'''
'''
'''
logger.debug("LTI provider received POST request {} to path {}".format(
str(self.post_dict),
self.path)
) # Log the request
'''
# Respond to grade request
if
'grade'
in
self
.
path
and
self
.
_send_graded_result
()
.
status_code
==
200
:
if
'grade'
in
self
.
path
and
self
.
_send_graded_result
()
.
status_code
==
200
:
status_message
=
'LTI consumer (edX) responded with XML content:<br>'
+
self
.
server
.
grade_data
[
'TC answer'
]
status_message
=
'LTI consumer (edX) responded with XML content:<br>'
+
self
.
server
.
grade_data
[
'TC answer'
]
self
.
server
.
grade_data
[
'callback_url'
]
=
None
self
.
server
.
grade_data
[
'callback_url'
]
=
None
self
.
_send_response
(
status_message
,
200
)
# Respond to request with correct lti endpoint:
# Respond to request with correct lti endpoint:
elif
self
.
_is_correct_lti_request
():
elif
self
.
_is_correct_lti_request
():
self
.
post_dict
=
self
.
_post_dict
()
self
.
post_dict
=
self
.
_post_dict
()
correct_keys
=
[
'user_id'
,
'role'
,
'oauth_nonce'
,
'oauth_timestamp'
,
'oauth_consumer_key'
,
'lti_version'
,
'oauth_signature_method'
,
'oauth_version'
,
'oauth_signature'
,
'lti_message_type'
,
'oauth_callback'
,
'lis_outcome_service_url'
,
'lis_result_sourcedid'
,
'launch_presentation_return_url'
,
# 'lis_person_sourcedid', optional, not used now.
'resource_link_id'
,
]
if
sorted
(
correct_keys
)
!=
sorted
(
self
.
post_dict
.
keys
()):
status_message
=
"Incorrect LTI header"
else
:
params
=
{
k
:
v
for
k
,
v
in
self
.
post_dict
.
items
()
if
k
!=
'oauth_signature'
}
params
=
{
k
:
v
for
k
,
v
in
self
.
post_dict
.
items
()
if
k
!=
'oauth_signature'
}
if
self
.
server
.
check_oauth_signature
(
params
,
self
.
post_dict
[
'oauth_signature'
]
):
if
self
.
server
.
check_oauth_signature
(
params
,
self
.
post_dict
.
get
(
'oauth_signature'
,
""
)
):
status_message
=
"This is LTI tool. Success."
status_message
=
"This is LTI tool. Success."
else
:
# set data for grades what need to be stored as server data
status_message
=
"Wrong LTI signature"
if
'lis_outcome_service_url'
in
self
.
post_dict
:
# set data for grades
# what need to be stored as server data
self
.
server
.
grade_data
=
{
self
.
server
.
grade_data
=
{
'callback_url'
:
self
.
post_dict
[
"lis_outcome_service_url"
]
,
'callback_url'
:
self
.
post_dict
.
get
(
'lis_outcome_service_url'
)
,
'sourcedId'
:
self
.
post_dict
[
'lis_result_sourcedid'
]
'sourcedId'
:
self
.
post_dict
.
get
(
'lis_result_sourcedid'
)
}
}
else
:
else
:
status_message
=
"Wrong LTI signature"
self
.
_send_response
(
status_message
,
200
)
else
:
status_message
=
"Invalid request URL"
status_message
=
"Invalid request URL"
self
.
_send_response
(
status_message
,
500
)
self
.
_send_head
()
def
_send_head
(
self
,
status_code
):
self
.
_send_response
(
status_message
)
def
_send_head
(
self
):
'''
'''
Send the response code and MIME headers
Send the response code and MIME headers
'''
'''
self
.
send_response
(
200
)
self
.
send_response
(
status_code
)
'''
if self._is_correct_lti_request():
self.send_response(200)
else:
self.send_response(500)
'''
self
.
send_header
(
'Content-type'
,
'text/html'
)
self
.
send_header
(
'Content-type'
,
'text/html'
)
self
.
end_headers
()
self
.
end_headers
()
...
@@ -144,17 +114,17 @@ class MockLTIRequestHandler(BaseHTTPRequestHandler):
...
@@ -144,17 +114,17 @@ class MockLTIRequestHandler(BaseHTTPRequestHandler):
self
.
server
.
cookie
=
{}
self
.
server
.
cookie
=
{}
referer
=
urlparse
.
urlparse
(
self
.
headers
.
getheader
(
'referer'
))
referer
=
urlparse
.
urlparse
(
self
.
headers
.
getheader
(
'referer'
))
self
.
server
.
referer_host
=
"{}://{}"
.
format
(
referer
.
scheme
,
referer
.
netloc
)
self
.
server
.
referer_host
=
"{}://{}"
.
format
(
referer
.
scheme
,
referer
.
netloc
)
self
.
server
.
referer_netloc
=
referer
.
netloc
return
post_dict
return
post_dict
def
_send_graded_result
(
self
):
def
_send_graded_result
(
self
):
"""
Send grade request.
"""
values
=
{
values
=
{
'textString'
:
0.5
,
'textString'
:
0.5
,
'sourcedId'
:
self
.
server
.
grade_data
[
'sourcedId'
],
'sourcedId'
:
self
.
server
.
grade_data
[
'sourcedId'
],
'imsx_messageIdentifier'
:
uuid4
()
.
hex
,
'imsx_messageIdentifier'
:
uuid4
()
.
hex
,
}
}
payload
=
textwrap
.
dedent
(
"""
payload
=
textwrap
.
dedent
(
"""
<?xml version = "1.0" encoding = "UTF-8"?>
<?xml version = "1.0" encoding = "UTF-8"?>
<imsx_POXEnvelopeRequest xmlns="http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0">
<imsx_POXEnvelopeRequest xmlns="http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0">
...
@@ -182,15 +152,22 @@ class MockLTIRequestHandler(BaseHTTPRequestHandler):
...
@@ -182,15 +152,22 @@ class MockLTIRequestHandler(BaseHTTPRequestHandler):
</imsx_POXEnvelopeRequest>
</imsx_POXEnvelopeRequest>
"""
)
"""
)
data
=
payload
.
format
(
**
values
)
data
=
payload
.
format
(
**
values
)
# temporarily changed to get for easy view in browser
# get relative part, because host name is different in a) manual tests b) acceptance tests c) demos
# get relative part, because host name is different in a) manual tests b) acceptance tests c) demos
if
getattr
(
self
.
server
,
'test_mode'
,
None
):
relative_url
=
urlparse
.
urlparse
(
self
.
server
.
grade_data
[
'callback_url'
])
.
path
relative_url
=
urlparse
.
urlparse
(
self
.
server
.
grade_data
[
'callback_url'
])
.
path
url
=
self
.
server
.
referer_host
+
relative_url
url
=
self
.
server
.
referer_host
+
relative_url
else
:
url
=
self
.
server
.
grade_data
[
'callback_url'
]
headers
=
{
'Content-Type'
:
'application/xml'
,
'X-Requested-With'
:
'XMLHttpRequest'
}
headers
=
{
'Content-Type'
:
'application/xml'
,
'X-Requested-With'
:
'XMLHttpRequest'
}
headers
[
'Authorization'
]
=
self
.
oauth_sign
(
url
,
data
)
headers
[
'Authorization'
]
=
self
.
oauth_sign
(
url
,
data
)
# We can't mock requests in unit tests, because we use them, but we need
# them to be mocked only for this one case.
if
getattr
(
self
.
server
,
'run_inside_unittest_flag'
,
None
):
response
=
mock
.
Mock
(
status_code
=
200
,
url
=
url
,
data
=
data
,
headers
=
headers
)
return
response
response
=
requests
.
post
(
response
=
requests
.
post
(
url
,
url
,
data
=
data
,
data
=
data
,
...
@@ -199,45 +176,58 @@ class MockLTIRequestHandler(BaseHTTPRequestHandler):
...
@@ -199,45 +176,58 @@ class MockLTIRequestHandler(BaseHTTPRequestHandler):
self
.
server
.
grade_data
[
'TC answer'
]
=
response
.
content
self
.
server
.
grade_data
[
'TC answer'
]
=
response
.
content
return
response
return
response
def
_send_response
(
self
,
message
):
def
_send_response
(
self
,
message
,
status_code
):
'''
'''
Send message back to the client
Send message back to the client
'''
'''
self
.
_send_head
(
status_code
)
if
self
.
server
.
grade_data
[
'callback_url'
]:
if
getattr
(
self
.
server
,
'grade_data'
,
False
):
# lti can be graded
response_str
=
"""<html><head><title>TEST TITLE</title></head>
response_str
=
textwrap
.
dedent
(
"""
<html>
<head>
<title>TEST TITLE</title>
</head>
<body>
<body>
<div><h2>Graded IFrame loaded</h2>
\
<div>
<h3>Server response is:</h3>
\
<h2>Graded IFrame loaded</h2>
<h3 class="result">{}</h3></div>
<h3>Server response is:</h3>
<h3 class="result">{}</h3>
</div>
<form action="{url}/grade" method="post">
<form action="{url}/grade" method="post">
<input type="submit" name="submit-button" value="Submit">
<input type="submit" name="submit-button" value="Submit">
</form>
</form>
</body>
</body></html>"""
.
format
(
message
,
url
=
"http://
%
s:
%
s"
%
self
.
server
.
server_address
)
</html>
else
:
"""
)
.
format
(
message
,
url
=
"http://
%
s:
%
s"
%
self
.
server
.
server_address
)
response_str
=
"""<html><head><title>TEST TITLE</title></head>
else
:
# lti can't be graded
response_str
=
textwrap
.
dedent
(
"""
<html>
<head>
<title>TEST TITLE</title>
</head>
<body>
<body>
<div><h2>IFrame loaded</h2>
\
<div>
<h3>Server response is:</h3>
\
<h2>IFrame loaded</h2>
<h3 class="result">{}</h3></div>
<h3>Server response is:</h3>
</body></html>"""
.
format
(
message
)
<h3 class="result">{}</h3>
</div>
</body>
</html>
"""
)
.
format
(
message
)
# Log the response
logger
.
debug
(
"LTI: sent response {}"
.
format
(
response_str
))
logger
.
debug
(
"LTI: sent response {}"
.
format
(
response_str
))
self
.
wfile
.
write
(
response_str
)
self
.
wfile
.
write
(
response_str
)
def
_is_correct_lti_request
(
self
):
def
_is_correct_lti_request
(
self
):
'''If url to LTI tool is correct.'''
'''
If url to LTI tool is correct.
'''
return
self
.
server
.
oauth_settings
[
'lti_endpoint'
]
in
self
.
path
return
self
.
server
.
oauth_settings
[
'lti_endpoint'
]
in
self
.
path
def
oauth_sign
(
self
,
url
,
body
):
def
oauth_sign
(
self
,
url
,
body
):
"""
"""
Signs request and returns signed body and headers.
Signs request and returns signed body and headers.
"""
"""
client
=
oauthlib
.
oauth1
.
Client
(
client
=
oauthlib
.
oauth1
.
Client
(
client_key
=
unicode
(
self
.
server
.
oauth_settings
[
'client_key'
]),
client_key
=
unicode
(
self
.
server
.
oauth_settings
[
'client_key'
]),
client_secret
=
unicode
(
self
.
server
.
oauth_settings
[
'client_secret'
])
client_secret
=
unicode
(
self
.
server
.
oauth_settings
[
'client_secret'
])
...
@@ -250,7 +240,7 @@ class MockLTIRequestHandler(BaseHTTPRequestHandler):
...
@@ -250,7 +240,7 @@ class MockLTIRequestHandler(BaseHTTPRequestHandler):
#Calculate and encode body hash. See http://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/oauth-bodyhash.html
#Calculate and encode body hash. See http://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/oauth-bodyhash.html
sha1
=
hashlib
.
sha1
()
sha1
=
hashlib
.
sha1
()
sha1
.
update
(
body
)
sha1
.
update
(
body
)
oauth_body_hash
=
base64
.
b64encode
(
sha1
.
hex
digest
())
oauth_body_hash
=
base64
.
b64encode
(
sha1
.
digest
())
__
,
headers
,
__
=
client
.
sign
(
__
,
headers
,
__
=
client
.
sign
(
unicode
(
url
.
strip
()),
unicode
(
url
.
strip
()),
http_method
=
u'POST'
,
http_method
=
u'POST'
,
...
...
lms/djangoapps/courseware/mock_lti_server/server_start.py
View file @
9e8a24bf
"""
"""
Mock LTI server for manual testing.
Mock LTI server for manual testing.
Used for manual testing and testing on sandbox.
"""
"""
import
threading
import
threading
...
@@ -18,6 +20,10 @@ server.oauth_settings = {
...
@@ -18,6 +20,10 @@ server.oauth_settings = {
}
}
server
.
server_host
=
server_host
server
.
server_host
=
server_host
# If in test mode mock lti server will make callback url using referer host.
# Used in MockLTIRequestHandler when sending graded result.
server
.
test_mode
=
True
try
:
try
:
server
.
serve_forever
()
server
.
serve_forever
()
except
KeyboardInterrupt
:
except
KeyboardInterrupt
:
...
...
lms/djangoapps/courseware/mock_lti_server/test_mock_lti_server.py
View file @
9e8a24bf
...
@@ -11,7 +11,6 @@ import requests
...
@@ -11,7 +11,6 @@ import requests
from
mock_lti_server
import
MockLTIServer
from
mock_lti_server
import
MockLTIServer
class
MockLTIServerTest
(
unittest
.
TestCase
):
class
MockLTIServerTest
(
unittest
.
TestCase
):
'''
'''
A mock version of the LTI provider server that listens on a local
A mock version of the LTI provider server that listens on a local
...
@@ -33,6 +32,10 @@ class MockLTIServerTest(unittest.TestCase):
...
@@ -33,6 +32,10 @@ class MockLTIServerTest(unittest.TestCase):
'lti_base'
:
'http://{}:{}/'
.
format
(
server_host
,
server_port
),
'lti_base'
:
'http://{}:{}/'
.
format
(
server_host
,
server_port
),
'lti_endpoint'
:
'correct_lti_endpoint'
'lti_endpoint'
:
'correct_lti_endpoint'
}
}
self
.
server
.
run_inside_unittest_flag
=
True
#flag for creating right callback_url
self
.
server
.
test_mode
=
True
# Start the server in a separate daemon thread
# Start the server in a separate daemon thread
server_thread
=
threading
.
Thread
(
target
=
self
.
server
.
serve_forever
)
server_thread
=
threading
.
Thread
(
target
=
self
.
server
.
serve_forever
)
server_thread
.
daemon
=
True
server_thread
.
daemon
=
True
...
@@ -43,6 +46,23 @@ class MockLTIServerTest(unittest.TestCase):
...
@@ -43,6 +46,23 @@ class MockLTIServerTest(unittest.TestCase):
# Stop the server, freeing up the port
# Stop the server, freeing up the port
self
.
server
.
shutdown
()
self
.
server
.
shutdown
()
def
test_wrong_header
(
self
):
"""
Tests that LTI server processes request with right program path but with wrong header.
"""
#wrong number of params and no signature
payload
=
{
'user_id'
:
'default_user_id'
,
'role'
:
'student'
,
'oauth_nonce'
:
''
,
'oauth_timestamp'
:
''
,
}
uri
=
self
.
server
.
oauth_settings
[
'lti_base'
]
+
self
.
server
.
oauth_settings
[
'lti_endpoint'
]
headers
=
{
'referer'
:
'http://localhost:8000/'
}
response
=
requests
.
post
(
uri
,
data
=
payload
,
headers
=
headers
)
self
.
assertIn
(
'Wrong LTI signature'
,
response
.
content
)
def
test_wrong_signature
(
self
):
def
test_wrong_signature
(
self
):
"""
"""
Tests that LTI server processes request with right program
Tests that LTI server processes request with right program
...
@@ -53,7 +73,7 @@ class MockLTIServerTest(unittest.TestCase):
...
@@ -53,7 +73,7 @@ class MockLTIServerTest(unittest.TestCase):
'role'
:
'student'
,
'role'
:
'student'
,
'oauth_nonce'
:
''
,
'oauth_nonce'
:
''
,
'oauth_timestamp'
:
''
,
'oauth_timestamp'
:
''
,
'oauth_consumer_key'
:
'client_key'
,
'oauth_consumer_key'
:
'
test_
client_key'
,
'lti_version'
:
'LTI-1p0'
,
'lti_version'
:
'LTI-1p0'
,
'oauth_signature_method'
:
'HMAC-SHA1'
,
'oauth_signature_method'
:
'HMAC-SHA1'
,
'oauth_version'
:
'1.0'
,
'oauth_version'
:
'1.0'
,
...
@@ -65,25 +85,22 @@ class MockLTIServerTest(unittest.TestCase):
...
@@ -65,25 +85,22 @@ class MockLTIServerTest(unittest.TestCase):
'lis_result_sourcedid'
:
''
,
'lis_result_sourcedid'
:
''
,
'resource_link_id'
:
''
,
'resource_link_id'
:
''
,
}
}
uri
=
self
.
server
.
oauth_settings
[
'lti_base'
]
+
self
.
server
.
oauth_settings
[
'lti_endpoint'
]
uri
=
self
.
server
.
oauth_settings
[
'lti_base'
]
+
self
.
server
.
oauth_settings
[
'lti_endpoint'
]
headers
=
{
'referer'
:
'http://localhost:8000/'
}
headers
=
{
'referer'
:
'http://localhost:8000/'
}
response
=
requests
.
post
(
uri
,
data
=
payload
,
headers
=
headers
)
response
=
requests
.
post
(
uri
,
data
=
payload
,
headers
=
headers
)
self
.
assertIn
(
'Wrong LTI signature'
,
response
.
content
)
self
.
assertTrue
(
'Wrong LTI signature'
in
response
.
content
)
def
test_success_response_launch_lti
(
self
):
def
test_success_response_launch_lti
(
self
):
"""
"""
Success lti launch.
Success lti launch.
"""
"""
payload
=
{
payload
=
{
'user_id'
:
'default_user_id'
,
'user_id'
:
'default_user_id'
,
'role'
:
'student'
,
'role'
:
'student'
,
'oauth_nonce'
:
''
,
'oauth_nonce'
:
''
,
'oauth_timestamp'
:
''
,
'oauth_timestamp'
:
''
,
'oauth_consumer_key'
:
'client_key'
,
'oauth_consumer_key'
:
'
test_
client_key'
,
'lti_version'
:
'LTI-1p0'
,
'lti_version'
:
'LTI-1p0'
,
'oauth_signature_method'
:
'HMAC-SHA1'
,
'oauth_signature_method'
:
'HMAC-SHA1'
,
'oauth_version'
:
'1.0'
,
'oauth_version'
:
'1.0'
,
...
@@ -94,14 +111,44 @@ class MockLTIServerTest(unittest.TestCase):
...
@@ -94,14 +111,44 @@ class MockLTIServerTest(unittest.TestCase):
'lis_outcome_service_url'
:
''
,
'lis_outcome_service_url'
:
''
,
'lis_result_sourcedid'
:
''
,
'lis_result_sourcedid'
:
''
,
'resource_link_id'
:
''
,
'resource_link_id'
:
''
,
"lis_outcome_service_url"
:
''
,
}
}
self
.
server
.
check_oauth_signature
=
Mock
(
return_value
=
True
)
self
.
server
.
check_oauth_signature
=
Mock
(
return_value
=
True
)
uri
=
self
.
server
.
oauth_settings
[
'lti_base'
]
+
self
.
server
.
oauth_settings
[
'lti_endpoint'
]
uri
=
self
.
server
.
oauth_settings
[
'lti_base'
]
+
self
.
server
.
oauth_settings
[
'lti_endpoint'
]
headers
=
{
'referer'
:
'http://localhost:8000/'
}
headers
=
{
'referer'
:
'http://localhost:8000/'
}
response
=
requests
.
post
(
uri
,
data
=
payload
,
headers
=
headers
)
self
.
assertIn
(
'This is LTI tool. Success.'
,
response
.
content
)
def
test_send_graded_result
(
self
):
payload
=
{
'user_id'
:
'default_user_id'
,
'role'
:
'student'
,
'oauth_nonce'
:
''
,
'oauth_timestamp'
:
''
,
'oauth_consumer_key'
:
'test_client_key'
,
'lti_version'
:
'LTI-1p0'
,
'oauth_signature_method'
:
'HMAC-SHA1'
,
'oauth_version'
:
'1.0'
,
'oauth_signature'
:
''
,
'lti_message_type'
:
'basic-lti-launch-request'
,
'oauth_callback'
:
'about:blank'
,
'launch_presentation_return_url'
:
''
,
'lis_outcome_service_url'
:
''
,
'lis_result_sourcedid'
:
''
,
'resource_link_id'
:
''
,
}
self
.
server
.
check_oauth_signature
=
Mock
(
return_value
=
True
)
uri
=
self
.
server
.
oauth_settings
[
'lti_base'
]
+
self
.
server
.
oauth_settings
[
'lti_endpoint'
]
#this is the uri for sending grade from lti
headers
=
{
'referer'
:
'http://localhost:8000/'
}
response
=
requests
.
post
(
uri
,
data
=
payload
,
headers
=
headers
)
response
=
requests
.
post
(
uri
,
data
=
payload
,
headers
=
headers
)
self
.
assertIn
(
'This is LTI tool. Success.'
,
response
.
content
)
self
.
server
.
grade_data
[
'TC answer'
]
=
"Test response"
graded_response
=
requests
.
post
(
'http://127.0.0.1:8034/grade'
)
self
.
assertIn
(
'Test response'
,
graded_response
.
content
)
self
.
assertTrue
(
'This is LTI tool. Success.'
in
response
.
content
)
lms/djangoapps/courseware/tests/test_lti_integration.py
View file @
9e8a24bf
...
@@ -33,7 +33,7 @@ class TestLTI(BaseTestXmodule):
...
@@ -33,7 +33,7 @@ class TestLTI(BaseTestXmodule):
sourcedId
=
u':'
.
join
(
urllib
.
quote
(
i
)
for
i
in
(
lti_id
,
module_id
,
user_id
))
sourcedId
=
u':'
.
join
(
urllib
.
quote
(
i
)
for
i
in
(
lti_id
,
module_id
,
user_id
))
lis_outcome_service_url
=
'http://{host}{path}'
.
format
(
lis_outcome_service_url
=
'http
s
://{host}{path}'
.
format
(
host
=
self
.
item_descriptor
.
xmodule_runtime
.
hostname
,
host
=
self
.
item_descriptor
.
xmodule_runtime
.
hostname
,
path
=
self
.
item_descriptor
.
xmodule_runtime
.
handler_url
(
self
.
item_module
,
'grade_handler'
,
thirdparty
=
True
)
.
rstrip
(
'/?'
)
path
=
self
.
item_descriptor
.
xmodule_runtime
.
handler_url
(
self
.
item_module
,
'grade_handler'
,
thirdparty
=
True
)
.
rstrip
(
'/?'
)
)
)
...
@@ -46,7 +46,6 @@ class TestLTI(BaseTestXmodule):
...
@@ -46,7 +46,6 @@ class TestLTI(BaseTestXmodule):
u'role'
:
u'student'
,
u'role'
:
u'student'
,
u'resource_link_id'
:
module_id
,
u'resource_link_id'
:
module_id
,
u'lis_outcome_service_url'
:
lis_outcome_service_url
,
u'lis_result_sourcedid'
:
sourcedId
,
u'lis_result_sourcedid'
:
sourcedId
,
u'oauth_nonce'
:
mocked_nonce
,
u'oauth_nonce'
:
mocked_nonce
,
...
@@ -59,6 +58,16 @@ class TestLTI(BaseTestXmodule):
...
@@ -59,6 +58,16 @@ class TestLTI(BaseTestXmodule):
saved_sign
=
oauthlib
.
oauth1
.
Client
.
sign
saved_sign
=
oauthlib
.
oauth1
.
Client
.
sign
self
.
expected_context
=
{
'display_name'
:
self
.
item_module
.
display_name
,
'input_fields'
:
self
.
correct_headers
,
'element_class'
:
self
.
item_module
.
category
,
'element_id'
:
self
.
item_module
.
location
.
html_id
(),
'launch_url'
:
'http://www.example.com'
,
# default value
'open_in_a_new_page'
:
True
,
'form_url'
:
self
.
item_descriptor
.
xmodule_runtime
.
handler_url
(
self
.
item_module
,
'preview_handler'
)
.
rstrip
(
'/?'
),
}
def
mocked_sign
(
self
,
*
args
,
**
kwargs
):
def
mocked_sign
(
self
,
*
args
,
**
kwargs
):
"""
"""
Mocked oauth1 sign function.
Mocked oauth1 sign function.
...
@@ -79,21 +88,11 @@ class TestLTI(BaseTestXmodule):
...
@@ -79,21 +88,11 @@ class TestLTI(BaseTestXmodule):
self
.
addCleanup
(
patcher
.
stop
)
self
.
addCleanup
(
patcher
.
stop
)
def
test_lti_constructor
(
self
):
def
test_lti_constructor
(
self
):
"""
generated_content
=
self
.
item_module
.
render
(
'student_view'
)
.
content
Makes sure that all parameters extracted.
expected_content
=
self
.
runtime
.
render_template
(
'lti.html'
,
self
.
expected_context
)
"""
self
.
assertEqual
(
generated_content
,
expected_content
)
generated_context
=
self
.
item_module
.
render
(
'student_view'
)
.
content
expected_context
=
{
'display_name'
:
self
.
item_module
.
display_name
,
'input_fields'
:
self
.
correct_headers
,
'element_class'
:
self
.
item_module
.
category
,
'element_id'
:
self
.
item_module
.
location
.
html_id
(),
'launch_url'
:
'http://www.example.com'
,
# default value
'open_in_a_new_page'
:
True
,
'form_url'
:
self
.
item_descriptor
.
xmodule_runtime
.
handler_url
(
self
.
item_module
,
'preview_handler'
)
.
rstrip
(
'/?'
),
}
self
.
assertEqual
(
def
test_lti_preview_handler
(
self
):
generated_context
,
generated_content
=
self
.
item_module
.
preview_handler
(
None
,
None
)
.
body
self
.
runtime
.
render_template
(
'lti.html'
,
expected_context
),
expected_content
=
self
.
runtime
.
render_template
(
'lti_form.html'
,
self
.
expected_context
)
)
self
.
assertEqual
(
generated_content
,
expected_content
)
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment