From 0887699d82f9c1d36713a90ff3bbfad6b50c8da3 Mon Sep 17 00:00:00 2001
From: marjev <marjevtic@gmail.com>
Date: Mon, 2 Feb 2015 12:30:41 +0100
Subject: [PATCH 1/4] Fixed unit tests to run on the newest version of
 workbench

---
 google_drive/tests/unit/test_docs.py | 393 ++++++++++++++-------------
 1 file changed, 207 insertions(+), 186 deletions(-)

diff --git a/google_drive/tests/unit/test_docs.py b/google_drive/tests/unit/test_docs.py
index 3244abf..3304358 100644
--- a/google_drive/tests/unit/test_docs.py
+++ b/google_drive/tests/unit/test_docs.py
@@ -1,17 +1,26 @@
 """ Tests for google drive components """
 import json
+import unittest
 
 from webob import Request
 from mock import Mock
 
 from workbench.runtime import WorkbenchRuntime
 from xblock.runtime import KvsFieldData, DictKeyValueStore
+from xblock.fields import ScopeIds
 
 from google_drive import GoogleDocumentBlock, GoogleCalendarBlock
 
 from nose.tools import assert_equals, assert_in
 
 
+def generate_scope_ids(runtime, block_type):
+    """ helper to generate scope IDs for an XBlock """
+    def_id = runtime.id_generator.create_definition(block_type)
+    usage_id = runtime.id_generator.create_usage(def_id)
+    return ScopeIds('user', block_type, def_id, usage_id)
+
+
 def make_request(body, method='POST'):
     """ helper to make a request """
     request = Request.blank('/')
@@ -21,193 +30,205 @@ def make_request(body, method='POST'):
     return request
 
 
-def make_document_block():
-    """ helper to construct a GoogleDocumentBlock """
-    runtime = WorkbenchRuntime()
-    key_store = DictKeyValueStore()
-    db_model = KvsFieldData(key_store)
-    return GoogleDocumentBlock(runtime, db_model, Mock())
-
-
-def make_calendar_block():
-    """ helper to construct a GoogleCalendarBlock """
-    runtime = WorkbenchRuntime()
-    key_store = DictKeyValueStore()
-    db_model = KvsFieldData(key_store)
-    return GoogleCalendarBlock(runtime, db_model, Mock())
-
-
-def test_document_templates_contents():
-    block = make_document_block()
-
-    student_fragment = block.render('student_view', Mock())
-    assert_in('<div class="google-docs-xblock-wrapper"', student_fragment.content)
-    assert_in('Google Document', student_fragment.content)
-    assert_in(
-        (
-            'https://docs.google.com/presentation/d/1x2ZuzqHsMoh1epK8VsGAlanSo7r9z55ualwQlj-ofBQ/embed?start=true&loop'
-            '=true&delayms=10000"\n    frameborder="0"\n    width="960"\n    height="569"\n    allowfullscreen="true"'
-        ),
-        student_fragment.content
-    )
-
-    studio_fragment = block.render('studio_view', Mock())
-    assert_in(
-        '<div class="wrapper-comp-settings is-active editor-with-buttons google-edit-wrapper" id="settings-tab">',
-        studio_fragment.content
-    )
-    assert_in('<div class="user-inputs-and-validation">', studio_fragment.content)
-    assert_in('<div class="xblock-inputs editor_content_wrapper">', studio_fragment.content)
-    assert_in('<div class="xblock-actions">', studio_fragment.content)
-
-
-def test_calendar_templates_contents():
-    block = make_calendar_block()
-
-    student_fragment = block.render('student_view', Mock())
-    assert_in('<div class="google-calendar-xblock-wrapper">', student_fragment.content)
-    assert_in(
-        (
-            'https://www.google.com/calendar/embed?mode=Month&amp;src=edx.org_lom804qe3ttspplj1bgeu1l3ak'
-            '@group.calendar.google.com&amp;showCalendars=0'
-        ),
-        student_fragment.content
-    )
-    assert_in('Google Calendar', student_fragment.content)
-
-    studio_fragment = block.render('studio_view', Mock())
-    assert_in(
-        '<div class="wrapper-comp-settings is-active editor-with-buttons google-edit-wrapper" id="settings-tab">',
-        studio_fragment.content
-    )
-    assert_in('<div class="user-inputs-and-validation">', studio_fragment.content)
-    assert_in('<div class="xblock-inputs editor_content_wrapper">', studio_fragment.content)
-    assert_in('<div class="xblock-actions">', studio_fragment.content)
-
-
-def test_studio_document_submit():
-    block = make_document_block()
-
-    body = json.dumps({
-        'display_name': "Google Document",
-        'embed_code': "<iframe>",
-        'alt_text': "This is alt text",
-    })
-    res = block.handle('studio_submit', make_request(body))
-
-    assert_equals(json.loads(res.body), {'result': 'success'})
-
-    assert_equals(block.display_name, "Google Document")
-    assert_equals(block.embed_code, "<iframe>")
-    assert_equals(block.alt_text, "This is alt text")
-
-
-def test_calendar_document_submit():
-    block = make_calendar_block()
-
-    body = json.dumps({
-        'display_name': "Google Calendar",
-        'calendar_id': "google1234",
-        'default_view': 1
-    })
-    res = block.handle('studio_submit', make_request(body))
-
-    assert_equals(json.loads(res.body), {'result': 'success'})
-
-    assert_equals(block.display_name, "Google Calendar")
-    assert_equals(block.calendar_id, "google1234")
-    assert_equals(block.default_view, 1)
-
-
-def test_check_document_url():
-    block = make_document_block()
-
-    data = json.dumps({
-        'url': (
-            "https://docs.google.com/presentation/d/1x2ZuzqHsMoh1epK8VsGAl"
-            "anSo7r9z55ualwQlj-ofBQ/embed?start=true&loop=true&delayms=10000"
+class TestGoogleDocumentBlock(unittest.TestCase):
+    """ Tests for GoogleDocumentBlock """
+
+    @classmethod
+    def make_document_block(cls):
+        """ helper to construct a GoogleDocumentBlock """
+        runtime = WorkbenchRuntime()
+        key_store = DictKeyValueStore()
+        db_model = KvsFieldData(key_store)
+        ids = generate_scope_ids(runtime, 'google_document')
+        return GoogleDocumentBlock(runtime, db_model, scope_ids=ids)
+
+    def test_document_templates_contents(self):
+        """ Test content of GoogleDocumentBlock's rendered views """
+        block = TestGoogleDocumentBlock.make_document_block()
+        block.usage_id = Mock()
+
+        student_fragment = block.render('student_view', Mock())
+        assert_in('<div class="google-docs-xblock-wrapper"', student_fragment.content)
+        assert_in('Google Document', student_fragment.content)
+        assert_in(
+            (
+                'https://docs.google.com/presentation/d/1x2ZuzqHsMoh1epK8VsGAlanSo7r9z55ualwQlj-ofBQ/embed?start=true&loop'
+                '=true&delayms=10000"\n    frameborder="0"\n    width="960"\n    height="569"\n    allowfullscreen="true"'
+            ),
+            student_fragment.content
         )
-    })
-    res = block.handle('check_url', make_request(data))
-
-    assert_equals(json.loads(res.body), {'status_code': 200})
 
-    data = json.dumps({
-        'url': 'undefined'
-    })
-    res = block.handle('check_url', make_request(data))
-
-    assert_equals(json.loads(res.body), {'status_code': 400})
+        studio_fragment = block.render('studio_view', Mock())
+        assert_in(
+            '<div class="wrapper-comp-settings is-active editor-with-buttons google-edit-wrapper" id="settings-tab">',
+            studio_fragment.content
+        )
+        assert_in('<div class="user-inputs-and-validation">', studio_fragment.content)
+        assert_in('<div class="xblock-inputs editor_content_wrapper">', studio_fragment.content)
+        assert_in('<div class="xblock-actions">', studio_fragment.content)
+
+    def test_studio_document_submit(self):
+        """ Test studio submission of GoogleDocumentBlock """
+        block = TestGoogleDocumentBlock.make_document_block()
+
+        body = json.dumps({
+            'display_name': "Google Document",
+            'embed_code': "<iframe>",
+            'alt_text': "This is alt text",
+        })
+        res = block.handle('studio_submit', make_request(body))
+
+        assert_equals(json.loads(res.body), {'result': 'success'})
+
+        assert_equals(block.display_name, "Google Document")
+        assert_equals(block.embed_code, "<iframe>")
+        assert_equals(block.alt_text, "This is alt text")
+
+    def test_check_document_url(self):
+        """ Test verification of the provided Google Document URL"""
+        block = TestGoogleDocumentBlock.make_document_block()
+
+        data = json.dumps({
+            'url': (
+                "https://docs.google.com/presentation/d/1x2ZuzqHsMoh1epK8VsGAl"
+                "anSo7r9z55ualwQlj-ofBQ/embed?start=true&loop=true&delayms=10000"
+            )
+        })
+        res = block.handle('check_url', make_request(data))
+
+        assert_equals(json.loads(res.body), {'status_code': 200})
+
+        data = json.dumps({
+            'url': 'undefined'
+        })
+        res = block.handle('check_url', make_request(data))
+
+        assert_equals(json.loads(res.body), {'status_code': 400})
+
+        data = json.dumps({
+            'url': (
+                "https://docs.google.com/presentation/d/1x2ZuzqHsMoh1epK8VsdsadfG"
+                "AlanSo7r9z55ualwQlj-ofBQ/embed?start=true&loop=true&delayms=10000"
+            )
+        })
+        res = block.handle('check_url', make_request(data))
+
+        assert_equals(json.loads(res.body), {'status_code': 404})
+
+    def test_document_publish_event(self):
+        """ Test event publishing in GoogleDocumentBlock"""
+        block = TestGoogleDocumentBlock.make_document_block()
+
+        body = json.dumps({
+            'url': (
+                'https://docs.google.com/presentation/d/1x2ZuzqHsMoh1epK8VsdsadfGAlanSo7r9z55ualwQlj-ofBQ/embed'
+                '?start=true&loop=true&delayms=10000'
+            ),
+            'displayed_in': 'iframe',
+            'event_type': 'edx.googlecomponent.document.displayed',
+        })
+        res = block.handle('publish_event', make_request(body))
+
+        assert_equals(json.loads(res.body), {'result': 'success'})
+
+        body = json.dumps({
+            'url': 'https://docs.google.com/drawings/d/1LHGzCTLRb--CDvFFjoYp62TiIN5KgsE7QOy9Sift_eg/pub?w=882&amp;h=657',
+            'displayed_in': 'img',
+            'event_type': 'edx.googlecomponent.document.displayed',
+        })
+        res = block.handle('publish_event', make_request(body))
+
+        assert_equals(json.loads(res.body), {'result': 'success'})
+
+        body = json.dumps({
+            'url': (
+                'https://docs.google.com/presentation/d/1x2ZuzqHsMoh1epK8VsdsadfGAlanSo7r9z55ualwQlj-ofBQ/embed'
+                '?start=true&loop=true&delayms=10000'
+            ),
+            'displayed_in': 'iframe',
+        })
+        res = block.handle('publish_event', make_request(body))
+
+        assert_equals(json.loads(res.body), {'result': 'error', 'message': 'Missing event_type in JSON data'})
+
+
+class TestGoogleCalendarBlock(unittest.TestCase):
+    """ Tests for GoogleCalendarBlock """
+
+    @classmethod
+    def make_calendar_block(cls):
+        """ helper to construct a GoogleCalendarBlock """
+        runtime = WorkbenchRuntime()
+        key_store = DictKeyValueStore()
+        db_model = KvsFieldData(key_store)
+        ids = generate_scope_ids(runtime, 'google_calendar')
+        return GoogleCalendarBlock(runtime, db_model, scope_ids=ids)
+
+    def test_calendar_templates_contents(self):
+        """ Test content of GoogleCalendarBlock's rendered views """
+        block = TestGoogleCalendarBlock.make_calendar_block()
+        block.usage_id = Mock()
+
+        student_fragment = block.render('student_view', Mock())
+        assert_in('<div class="google-calendar-xblock-wrapper">', student_fragment.content)
+        assert_in(
+            (
+                'https://www.google.com/calendar/embed?mode=Month&amp;src=edx.org_lom804qe3ttspplj1bgeu1l3ak'
+                '@group.calendar.google.com&amp;showCalendars=0'
+            ),
+            student_fragment.content
+        )
+        assert_in('Google Calendar', student_fragment.content)
 
-    data = json.dumps({
-        'url': (
-            "https://docs.google.com/presentation/d/1x2ZuzqHsMoh1epK8VsdsadfG"
-            "AlanSo7r9z55ualwQlj-ofBQ/embed?start=true&loop=true&delayms=10000"
+        studio_fragment = block.render('studio_view', Mock())
+        assert_in(
+            '<div class="wrapper-comp-settings is-active editor-with-buttons google-edit-wrapper" id="settings-tab">',
+            studio_fragment.content
         )
-    })
-    res = block.handle('check_url', make_request(data))
-
-    assert_equals(json.loads(res.body), {'status_code': 404})
-
-
-def test_document_publish_event():
-    block = make_document_block()
-
-    body = json.dumps({
-        'url': (
-            'https://docs.google.com/presentation/d/1x2ZuzqHsMoh1epK8VsdsadfGAlanSo7r9z55ualwQlj-ofBQ/embed'
-            '?start=true&loop=true&delayms=10000'
-        ),
-        'displayed_in': 'iframe',
-        'event_type': 'edx.googlecomponent.document.displayed',
-    })
-    res = block.handle('publish_event', make_request(body))
-
-    assert_equals(json.loads(res.body), {'result': 'success'})
-
-    body = json.dumps({
-        'url': 'https://docs.google.com/drawings/d/1LHGzCTLRb--CDvFFjoYp62TiIN5KgsE7QOy9Sift_eg/pub?w=882&amp;h=657',
-        'displayed_in': 'img',
-        'event_type': 'edx.googlecomponent.document.displayed',
-    })
-    res = block.handle('publish_event', make_request(body))
-
-    assert_equals(json.loads(res.body), {'result': 'success'})
-
-    body = json.dumps({
-        'url': (
-            'https://docs.google.com/presentation/d/1x2ZuzqHsMoh1epK8VsdsadfGAlanSo7r9z55ualwQlj-ofBQ/embed'
-            '?start=true&loop=true&delayms=10000'
-        ),
-        'displayed_in': 'iframe',
-    })
-    res = block.handle('publish_event', make_request(body))
-
-    assert_equals(json.loads(res.body), {'result': 'error', 'message': 'Missing event_type in JSON data'})
-
-
-def test_calendar_publish_event():
-    block = make_calendar_block()
-
-    body = json.dumps({
-        'url': (
-            'https://www.google.com/calendar/embed?mode=Month&src=edx.org_lom804qe3ttspplj1bgeu1l3ak'
-            '@group.calendar.google.com&showCalendars=0'
-        ),
-        'displayed_in': 'iframe',
-        'event_type': 'edx.googlecomponent.calendar.displayed'
-    })
-    res = block.handle('publish_event', make_request(body))
-
-    assert_equals(json.loads(res.body), {'result': 'success'})
-
-    body = json.dumps({
-        'url': (
-            'https://www.google.com/calendar/embed?mode=Month&src=edx.org_lom804qe3ttspplj1bgeu1l3ak'
-            '@group.calendar.google.com&showCalendars=0'
-        ),
-        'displayed_in': 'iframe',
-    })
-    res = block.handle('publish_event', make_request(body))
-
-    assert_equals(json.loads(res.body), {'result': 'error', 'message': 'Missing event_type in JSON data'})
+        assert_in('<div class="user-inputs-and-validation">', studio_fragment.content)
+        assert_in('<div class="xblock-inputs editor_content_wrapper">', studio_fragment.content)
+        assert_in('<div class="xblock-actions">', studio_fragment.content)
+
+    def test_calendar_document_submit(self):
+        """ Test studio submission of GoogleCalendarBlock """
+        block = TestGoogleCalendarBlock.make_calendar_block()
+
+        body = json.dumps({
+            'display_name': "Google Calendar",
+            'calendar_id': "google1234",
+            'default_view': 1
+        })
+        res = block.handle('studio_submit', make_request(body))
+
+        assert_equals(json.loads(res.body), {'result': 'success'})
+
+        assert_equals(block.display_name, "Google Calendar")
+        assert_equals(block.calendar_id, "google1234")
+        assert_equals(block.default_view, 1)
+
+    def test_calendar_publish_event(self):
+        """ Test event publishing in GoogleCalendarBlock"""
+        block = TestGoogleCalendarBlock.make_calendar_block()
+
+        body = json.dumps({
+            'url': (
+                'https://www.google.com/calendar/embed?mode=Month&src=edx.org_lom804qe3ttspplj1bgeu1l3ak'
+                '@group.calendar.google.com&showCalendars=0'
+            ),
+            'displayed_in': 'iframe',
+            'event_type': 'edx.googlecomponent.calendar.displayed'
+        })
+        res = block.handle('publish_event', make_request(body))
+
+        assert_equals(json.loads(res.body), {'result': 'success'})
+
+        body = json.dumps({
+            'url': (
+                'https://www.google.com/calendar/embed?mode=Month&src=edx.org_lom804qe3ttspplj1bgeu1l3ak'
+                '@group.calendar.google.com&showCalendars=0'
+            ),
+            'displayed_in': 'iframe',
+        })
+        res = block.handle('publish_event', make_request(body))
+
+        assert_equals(json.loads(res.body), {'result': 'error', 'message': 'Missing event_type in JSON data'})

From 1b6dbb61cb0651223e5cc9ae4612842e6a33d98a Mon Sep 17 00:00:00 2001
From: marjev <marjevtic@gmail.com>
Date: Tue, 3 Feb 2015 10:45:55 +0100
Subject: [PATCH 2/4] Updated requirements file

---
 requirements.txt | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/requirements.txt b/requirements.txt
index 906872c..5747ae0 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -2,10 +2,12 @@
 lxml
 mock
 selenium
+django==1.4.18
 -e git+https://github.com/nosedjango/nosedjango.git@ed7d7f9aa969252ff799ec159f828eaa8c1cbc5a#egg=nosedjango-dev
 -e git+https://github.com/edx-solutions/xblock-utils.git#egg=xblock-utils
 # Normally we'd use no specific hash here, but master appears to have a defect, a proposed solution appears in the git hash below
 -e git+https://github.com/edx/xblock-sdk.git@c251b8924ef5bf89fb59a0a5df2723114cdf4154#egg=xblock-sdk
 -e git+https://github.com/edx/XBlock.git#egg=XBlock
 -e git+https://github.com/edx/bok-choy.git#egg=bok-choy
+-e git+https://github.com/pmitros/django-pyfs.git@d175715e0fe3367ec0f1ee429c242d603f6e8b10#egg=djpyfs
 -e .

From 79203407cad36b7398fd962385a8b3fe4e299173 Mon Sep 17 00:00:00 2001
From: marjev <marjevtic@gmail.com>
Date: Tue, 3 Feb 2015 11:07:54 +0100
Subject: [PATCH 3/4] Split long lines into two

---
 google_drive/tests/unit/test_docs.py | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/google_drive/tests/unit/test_docs.py b/google_drive/tests/unit/test_docs.py
index 3304358..f8d3ae3 100644
--- a/google_drive/tests/unit/test_docs.py
+++ b/google_drive/tests/unit/test_docs.py
@@ -52,8 +52,10 @@ def test_document_templates_contents(self):
         assert_in('Google Document', student_fragment.content)
         assert_in(
             (
-                'https://docs.google.com/presentation/d/1x2ZuzqHsMoh1epK8VsGAlanSo7r9z55ualwQlj-ofBQ/embed?start=true&loop'
-                '=true&delayms=10000"\n    frameborder="0"\n    width="960"\n    height="569"\n    allowfullscreen="true"'
+                'https://docs.google.com/presentation/d/1x2ZuzqHsMoh1epK8VsGAlanSo7r9z55ualwQlj-ofBQ'
+                '/embed?start=true&loop'
+                '=true&delayms=10000"\n    frameborder="0"\n    width="960"\n    height="569"\n    '
+                'allowfullscreen="true"'
             ),
             student_fragment.content
         )
@@ -132,7 +134,9 @@ def test_document_publish_event(self):
         assert_equals(json.loads(res.body), {'result': 'success'})
 
         body = json.dumps({
-            'url': 'https://docs.google.com/drawings/d/1LHGzCTLRb--CDvFFjoYp62TiIN5KgsE7QOy9Sift_eg/pub?w=882&amp;h=657',
+            'url': (
+                'https://docs.google.com/drawings/d/1LHGzCTLRb--CDvFFjoYp62TiIN5KgsE7QOy9Sift_eg/'
+                'pub?w=882&amp;h=657'),
             'displayed_in': 'img',
             'event_type': 'edx.googlecomponent.document.displayed',
         })

From 39c446aa943defe5e5af8512136009c2a597435a Mon Sep 17 00:00:00 2001
From: marjev <marjevtic@gmail.com>
Date: Tue, 3 Feb 2015 13:25:30 +0100
Subject: [PATCH 4/4] Added the YAML file for Travis; Added coverage to
 requirements.txt; Described how someone can get test coverage in README file

---
 .travis.yml      | 5 +++++
 README.md        | 6 ++++++
 requirements.txt | 1 +
 3 files changed, 12 insertions(+)
 create mode 100644 .travis.yml

diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..16a288b
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,5 @@
+language: python
+python:
+  - "2.7"
+install: pip install -r requirements.txt
+script: DJANGO_SETTINGS_MODULE="settings" nosetests --with-coverage --with-django
diff --git a/README.md b/README.md
index c99abc7..48f2735 100644
--- a/README.md
+++ b/README.md
@@ -61,6 +61,12 @@ If you want to run only the integration or the unit tests, append the directory
 $ DJANGO_SETTINGS_MODULE="settings" nosetests --with-django tests/unit
 ```
 
+To see the coverage, run the tests using the following command:
+
+```bash
+$ DJANGO_SETTINGS_MODULE="settings" nosetests --with-coverage --with-django
+```
+
 If you have not installed the xblock-sdk in the active virtualenv,
 you might also have to prepend `PYTHONPATH=".:/path/to/xblock"` to the command above.
 (`/path/to/xblock` is the path to the xblock-sdk, where the workbench resides).
diff --git a/requirements.txt b/requirements.txt
index 5747ae0..0038a38 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -2,6 +2,7 @@
 lxml
 mock
 selenium
+coverage==3.7
 django==1.4.18
 -e git+https://github.com/nosedjango/nosedjango.git@ed7d7f9aa969252ff799ec159f828eaa8c1cbc5a#egg=nosedjango-dev
 -e git+https://github.com/edx-solutions/xblock-utils.git#egg=xblock-utils