Adds widget based tests

Author: craigsdennis

binder/environment.yml

@@ -5,5 +5,6 @@ dependencies:
   - numpy=1.15.0
   - pandas=0.23.4
   - python=3.7.0
+  - ipywidgets
   - faker
 

s2n03-challenge1-top-referrers.ipynb

@@ -10,12 +10,12 @@
     "\n",
     "Currently, anyone with **5 or more** referrals is considered a top referrer.\n",
     "\n",
-    "In the cell labelled CHALLENGE, follow the instructions to return what is required. Use `Kernel > Restart and run all cells` to check your work.  If all the tests pass, you got it!"
+    "When you have completed the challenge, press the `Run Tests` button"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 37,
    "metadata": {},
    "outputs": [
     {
@@ -24,7 +24,7 @@
        "475"
       ]
      },
-     "execution_count": 1,
+     "execution_count": 37,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -44,7 +44,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 38,
    "metadata": {},
    "outputs": [
     {
@@ -223,7 +223,7 @@
        "[475 rows x 7 columns]"
       ]
      },
-     "execution_count": 2,
+     "execution_count": 38,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -238,9 +238,68 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 39,
    "metadata": {},
    "outputs": [
+    {
+     "data": {
+      "application/javascript": [
+       "IPython.notebook.execute_all_cells();"
+      ],
+      "text/plain": [
+       "<IPython.core.display.Javascript object>"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "6dda60d04f0040859bd5f5db7db3eeea",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "Button(description='Run Tests', style=ButtonStyle())"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "text/markdown": [
+       "```\n",
+       "...\n",
+       "----------------------------------------------------------------------\n",
+       "Ran 3 tests in 0.004s\n",
+       "\n",
+       "OK\n",
+       "\n",
+       "```"
+      ],
+      "text/plain": [
+       "<IPython.core.display.Markdown object>"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "5fdab85d808240b5ba79999461a20256",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "Button(description='Run Tests', style=ButtonStyle())"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
     {
      "data": {
       "text/markdown": [
@@ -271,7 +330,7 @@
        "AssertionError: 475 != 142 : Whoops I received a different count than I expected, make sure the last line is the entire resulting DataFrame (not just the head)\n",
        "\n",
        "----------------------------------------------------------------------\n",
-       "Ran 3 tests in 0.005s\n",
+       "Ran 3 tests in 0.004s\n",
        "\n",
        "FAILED (failures=3)\n",
        "\n",
@@ -288,6 +347,13 @@
    "source": [
     "check(__name__, 'Find the top referrers')"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
@@ -306,7 +372,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.0"
+   "version": "3.7.1"
   }
  },
  "nbformat": 4,

tests/helpers.py

@@ -4,7 +4,8 @@
 import sys
 import unittest
 
-from IPython.display import display, Markdown
+from IPython.display import display, Markdown, Javascript
+import ipywidgets as widgets
 
 
 registered_tests = {}
@@ -23,9 +24,13 @@ def wrapped(cls):
 def cell_matching(module, test_text):
     # In is a list of notebook cell inputs
     # Out is a dictionary of cell outputs
+    matching_indices = []
     for index, value in enumerate(module.In):
         if test_text in value:
-            return Cell(value, module.Out.get(index))
+            matching_indices.append(index)
+    if matching_indices:
+        # The last entry is the call to `check`
+        return Cell(value, module.Out.get(matching_indices[-2]))
     return None, None
 
 
@@ -43,6 +48,9 @@ class BoundTestClass(test_cls):
     BoundTestClass.__doc__ = "Cell Tests for " + test_text
     return BoundTestClass
 
+def execute_all_cells(b):
+      display(Javascript('''IPython.notebook.execute_all_cells();'''))
+
 
 def check(module_name, test_text):
     module = sys.modules[module_name]
@@ -51,4 +59,7 @@ def check(module_name, test_text):
     runner = unittest.TextTestRunner(stream=output_stream)
     runner.run(unittest.defaultTestLoader.loadTestsFromTestCase(test_class))
     md = '```\n' + output_stream.getvalue() + '\n```'
+    button = widgets.Button(description='Run Tests')
+    button.on_click(execute_all_cells)
+    display(button)
     display(Markdown(md))