Skip to content

A
acid-block
Commit 459aff7b by Andy Armstrong
Options

Merge pull request #5 from edx/andya/acid-parent-xblock 

Split AcidBlock into leaf and parent variants
parents b734c955 5de8bcd6
Showing with 171 additions and 89 deletions
AUTHORS
Calen Pennington <calen.pennington@gmail.com> Calen Pennington <calen.pennington@gmail.com>
Ned Batchelder <ned@nedbatchelder.com> Ned Batchelder <ned@nedbatchelder.com>
Andy Armstrong <andy.armstrong@pobox.com>
acid/__init__.py
from .acid import AcidBlock from .acid import AcidBlock, AcidParentBlock
acid/acid.py
...@@ -56,7 +56,7 @@ class AcidBlock(XBlock): ...@@ -56,7 +56,7 @@ class AcidBlock(XBlock):
""" """
A testing block that checks the behavior of the container. A testing block that checks the behavior of the container.
""" """
has_children = True has_children = False
SUCCESS_CLASS = 'fa fa-check-square-o fa-lg pass' SUCCESS_CLASS = 'fa fa-check-square-o fa-lg pass'
FAILURE_CLASS = 'fa fa-times fa-lg fail' FAILURE_CLASS = 'fa fa-times fa-lg fail'
...@@ -151,40 +151,18 @@ class AcidBlock(XBlock): ...@@ -151,40 +151,18 @@ class AcidBlock(XBlock):
except Exception: except Exception:
logging.warning('Unable to use scope in acid test', exc_info=True) logging.warning('Unable to use scope in acid test', exc_info=True)
# Save the changes to our fields so that they are visible to our children
self.save()
children = [
self.runtime.get_block(child_id)
for child_id in self.children
]
rendered_children = [
self.runtime.render_child(child, view_name, context=context)
for child in children
]
child_values = {
child.name: child.parent_value
for child in children
if child.scope_ids.block_type == 'acid' and child.name is not None
}
frag = Fragment(self.render_template( frag = Fragment(self.render_template(
'html/acid.html.mako', 'html/acid.html.mako',
error_class=self.ERROR_CLASS, error_class=self.ERROR_CLASS,
success_class=self.SUCCESS_CLASS, success_class=self.SUCCESS_CLASS,
failure_class=self.FAILURE_CLASS, failure_class=self.FAILURE_CLASS,
unknown_class=self.UNKNOWN_CLASS, unknown_class=self.UNKNOWN_CLASS,
acid_child_values=child_values,
acid_child_count=len([child for child in children if child.scope_ids.block_type == 'acid']),
rendered_children=(fragment.content for fragment in rendered_children),
storage_tests=scope_test_contexts, storage_tests=scope_test_contexts,
local_resource_url=self.runtime.local_resource_url(self, 'public/test_data.json'), local_resource_url=self.runtime.local_resource_url(self, 'public/test_data.json'),
)) ))
frag.add_frags_resources(rendered_children)
frag.add_javascript(self.resource_string("static/js/jquery.ajaxq-0.0.1.js")) frag.add_javascript(self.resource_string("static/js/jquery.ajaxq-0.0.1.js"))
frag.add_javascript(self.resource_string('static/js/acid_update_status.js'))
frag.add_javascript(self.resource_string('static/js/acid.js')) frag.add_javascript(self.resource_string('static/js/acid.js'))
frag.add_css(self.resource_string("static/css/acid.css")) frag.add_css(self.resource_string("static/css/acid.css"))
frag.add_css_url('//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css') frag.add_css_url('//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css')
...@@ -253,13 +231,78 @@ class AcidBlock(XBlock): ...@@ -253,13 +231,78 @@ class AcidBlock(XBlock):
def workbench_scenarios(): def workbench_scenarios():
"""A canned scenario for display in the workbench.""" """A canned scenario for display in the workbench."""
return [ return [
("XBlock Acid test", ("XBlock Acid single block test",
"""\
<vertical_demo>
<acid name='test'>
</acid>
</vertical_demo>
""")
]
@generate_fields
class AcidParentBlock(AcidBlock):
"""
A testing block that checks the behavior of the container for a parent XBlock.
"""
has_children = True
def fallback_view(self, view_name, context=None): # pylint: disable=W0613
"""
This view is used by the Acid XBlock to test various features of
the runtime it is contained in
"""
acid_fragment = super(AcidParentBlock, self).fallback_view(view_name, context=context)
# Save the changes to our fields so that they are visible to our children
self.save()
children = [
self.runtime.get_block(child_id)
for child_id in self.children
]
rendered_children = [
self.runtime.render_child(child, view_name, context=context)
for child in children
]
child_values = {
child.name: child.parent_value
for child in children
if child.scope_ids.block_type == 'acid' and child.name is not None
}
frag = Fragment(self.render_template(
'html/acid_parent.html.mako',
error_class=self.ERROR_CLASS,
success_class=self.SUCCESS_CLASS,
failure_class=self.FAILURE_CLASS,
unknown_class=self.UNKNOWN_CLASS,
acid_html=acid_fragment.content,
acid_child_values=child_values,
acid_child_count=len([child for child in children if child.scope_ids.block_type == 'acid']),
rendered_children=(fragment.content for fragment in rendered_children),
local_resource_url=self.runtime.local_resource_url(self, 'public/test_data.json'),
))
frag.add_frag_resources(acid_fragment)
frag.add_frags_resources(rendered_children)
frag.add_javascript(self.resource_string('static/js/acid_parent.js'))
frag.initialize_js('AcidParentBlock')
return frag
@staticmethod
def workbench_scenarios():
"""A canned scenario for display in the workbench."""
return [
("XBlock Acid Parent test",
"""\ """\
<vertical_demo> <vertical_demo>
<acid name='parent'> <acid_parent name='parent'>
<acid name='left-child'/> <acid name='left-child'/>
<acid name='right-child'/> <acid name='right-child'/>
</acid> </acid_parent>
</vertical_demo> </vertical_demo>
""") """)
] ]
acid/static/html/acid.html.mako
...@@ -5,29 +5,14 @@ ...@@ -5,29 +5,14 @@
data-failure-class="${failure_class}" data-failure-class="${failure_class}"
data-error-class="${error_class}" data-error-class="${error_class}"
data-unknown-class="${unknown_class}" data-unknown-class="${unknown_class}"
data-acid-child-count="${acid_child_count}"
data-local-resource-url="${local_resource_url}" data-local-resource-url="${local_resource_url}"
> >
<script class="acid-child-values" type="application/json"> <h3>Acid XBlock</h3>
${json.dumps(acid_child_values)}
</script>
<p>Acid XBlock</p>
<p>JS init function run: <p>JS init function run:
<span class="js-init-run"> <span class="js-init-run">
<i class="${unknown_class}"></i> <i class="${unknown_class}"></i>
</span> </span>
</p> </p>
<p>Acid Child counts match:
<span class="child-counts-match">
<i class="${unknown_class}"></i>
</span>
</p>
<p>Acid Child values match:
<span class="child-values-match">
<i class="${unknown_class}"></i>
</span>
</p>
<p>Resource Url Test: <p>Resource Url Test:
<span class="local-resource-test"> <span class="local-resource-test">
<i class="${unknown_class}"></i> <i class="${unknown_class}"></i>
...@@ -71,9 +56,4 @@ ...@@ -71,9 +56,4 @@
</tr> </tr>
% endfor % endfor
</table> </table>
<div class='acid-children'>
% for child in rendered_children:
${child}
% endfor
</div>
</div> </div>
acid/static/html/acid_parent.html.mako 0 → 100644
<%! import json %>
<div class="acid-parent-block"
data-success-class="${success_class}"
data-failure-class="${failure_class}"
data-error-class="${error_class}"
data-unknown-class="${unknown_class}"
data-acid-child-count="${acid_child_count}"
data-local-resource-url="${local_resource_url}"
>
<script class="acid-child-values" type="application/json">
${json.dumps(acid_child_values)}
</script>
${acid_html}
<hr/>
<h3>Acid Children</h3>
<p>Acid Child counts match:
<span class="child-counts-match">
<i class="${unknown_class}"></i>
</span>
</p>
<p>Acid Child values match:
<span class="child-values-match">
<i class="${unknown_class}"></i>
</span>
</p>
<div class='acid-children'>
% for child in rendered_children:
${child}
% endfor
</div>
</div>
acid/static/js/acid.js
...@@ -6,23 +6,8 @@ function AcidBlock(runtime, element) { ...@@ -6,23 +6,8 @@ function AcidBlock(runtime, element) {
} }
function mark(result, selector, subelem, msg) { function mark(result, selector, subelem, msg) {
subelem = subelem || element; acid_update_status(selector, subelem, element, msg,
msg = msg || ""; acidData(result + '-class'), acidData('error-class'));
var elems = $(selector, subelem || element).not($('.acid-children *', element))
if (elems.length == 1) {
symbol = $("<i/>", {
'class': acidData(result + '-class')
});
if (msg) {
symbol = symbol.after(": " + msg)
}
symbol.appendTo(elems.empty());
} else {
$("<i/>", {
'class': acidData('error-class')
}).after("ASSERTION FAILURE: Can only mark single elements").appendTo(elems.empty())
console.log(elems);
}
} }
function resourceTests() { function resourceTests() {
...@@ -31,7 +16,7 @@ function AcidBlock(runtime, element) { ...@@ -31,7 +16,7 @@ function AcidBlock(runtime, element) {
mark('failure', '.local-resource-test', element, 'Unable to load local resource'); mark('failure', '.local-resource-test', element, 'Unable to load local resource');
}) })
.done(function(data) { .done(function(data) {
if (data.test_data == 'success') { if (data.test_data === 'success') {
mark('success', '.local-resource-test'); mark('success', '.local-resource-test');
} else { } else {
mark('failure', '.local-resource-test', element, 'Data mismatch'); mark('failure', '.local-resource-test', element, 'Data mismatch');
...@@ -39,25 +24,6 @@ function AcidBlock(runtime, element) { ...@@ -39,25 +24,6 @@ function AcidBlock(runtime, element) {
}); });
} }
function childTests() {
if (acidData('acid-child-count') == runtime.children(element).length) {
mark('success', '.child-counts-match');
}
var childValues = JSON.parse($('.acid-child-values', element).html());
$.each(childValues, function(name, value) {
var child_value = runtime.childMap(element, name).parentValue;
if (child_value != value) {
mark(
'failure', '.child-values-match', element,
'Child ' + name + ' had value ' + child_value + ' but expected ' + value
);
return;
}
});
mark('success', '.child-values-match');
}
function scopeTests() { function scopeTests() {
$('.scope-storage-test', element).each(function() { $('.scope-storage-test', element).each(function() {
var $this = $(this); var $this = $(this);
...@@ -67,7 +33,7 @@ function AcidBlock(runtime, element) { ...@@ -67,7 +33,7 @@ function AcidBlock(runtime, element) {
url: $this.data('handler-url'), url: $this.data('handler-url'),
success: function (ret) { success: function (ret) {
mark('success', '.server-storage-test-returned', $this); mark('success', '.server-storage-test-returned', $this);
if (ret.status == "ok") { if (ret.status === "ok") {
mark('success', '.server-storage-test-succeeded', $this); mark('success', '.server-storage-test-succeeded', $this);
$.ajaxq("acid-queue", { $.ajaxq("acid-queue", {
...@@ -77,7 +43,7 @@ function AcidBlock(runtime, element) { ...@@ -77,7 +43,7 @@ function AcidBlock(runtime, element) {
success: function (ret) { success: function (ret) {
mark('success', '.client-storage-test-returned', $this); mark('success', '.client-storage-test-returned', $this);
if (ret.status == "ok") { if (ret.status === "ok") {
mark('success', '.client-storage-test-succeeded', $this); mark('success', '.client-storage-test-succeeded', $this);
} else { } else {
mark('failure', '.client-storage-test-succeeded', $this, ret.message); mark('failure', '.client-storage-test-succeeded', $this, ret.message);
...@@ -94,7 +60,6 @@ function AcidBlock(runtime, element) { ...@@ -94,7 +60,6 @@ function AcidBlock(runtime, element) {
mark('success', '.js-init-run'); mark('success', '.js-init-run');
childTests();
resourceTests(); resourceTests();
scopeTests(); scopeTests();
......
acid/static/js/acid_parent.js 0 → 100644
/* Javascript for the Acid XBlock. */
function AcidParentBlock(runtime, element) {
function acidData(key) {
return $('.acid-parent-block', element).data(key);
}
function mark(result, selector, subelem, msg) {
acid_update_status(selector, subelem, element, msg,
acidData(result + '-class'), acidData('error-class'));
}
function childTests() {
if (acidData('acid-child-count') === runtime.children(element).length) {
mark('success', '.child-counts-match');
}
var childValues = JSON.parse($('.acid-child-values', element).html());
$.each(childValues, function(name, value) {
var child_value = runtime.childMap(element, name).parentValue;
if (child_value !== value) {
mark(
'failure', '.child-values-match', element,
'Child ' + name + ' had value ' + child_value + ' but expected ' + value
);
return;
}
});
mark('success', '.child-values-match');
}
AcidBlock(runtime, element);
childTests();
return {parentValue: acidData('parent-value')};
}
acid/static/js/acid_update_status.js 0 → 100644
function acid_update_status(selector, element, block, msg, successClass, errorClass) {
var elems, symbol;
msg = msg || "";
elems = $(selector, element || block).not($('.acid-children *', block));
if (elems.length === 1) {
symbol = $("<i/>", {
'class': successClass
});
if (msg) {
symbol = symbol.after(": " + msg);
}
symbol.appendTo(elems.empty());
} else {
$("<i/>", {
'class': errorClass
}).after("ASSERTION FAILURE: Can only mark single elements").appendTo(elems.empty());
console.log(elems);
}
}
setup.py
...@@ -29,6 +29,7 @@ setup( ...@@ -29,6 +29,7 @@ setup(
entry_points={ entry_points={
'xblock.v1': [ 'xblock.v1': [
'acid = acid:AcidBlock', 'acid = acid:AcidBlock',
'acid_parent = acid:AcidParentBlock',
], ],
}, },
package_data=package_data("acid", ["static", "public"]), package_data=package_data("acid", ["static", "public"]),
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment