Merge pull request #1 from datacamp/colin-msft-check

added tsql function and tests

Author: machow

README.md

@@ -4,7 +4,7 @@ sqlwhat-ext
 [![Build Status](https://travis-ci.org/datacamp/sqlwhat-ext.svg?branch=master)](https://travis-ci.org/datacamp/sqlwhat-ext)
 [![PyPI version](https://badge.fury.io/py/sqlwhat-ext.svg)](https://badge.fury.io/py/sqlwhat-ext)
 
-Extensions (high-level SCTs) for sqlwhat. 
+Extensions (high-level SCTs) for sqlwhat.
 
 [Documentation here](http://sqlwhat-ext.readthedocs.io/).
 
@@ -43,5 +43,7 @@ Running tests
 pip install -r requirements.txt
 # may need to uncomment line below
 #pip install -e .
-py.test tests
+pytest tests
+
+# can also do: python -m pytest tests
 ```

sqlwhat_ext.py

@@ -1,6 +1,7 @@
 __version__ = '0.0.1'
 
 from sqlwhat.sct_syntax import *
+from sqlwhat.checks.check_result import TinyNone
 
 @state_dec
 def check_result2(state, col_names = None, sort = False, match = 'exact'):
@@ -31,3 +32,33 @@ def check_result2(state, col_names = None, sort = False, match = 'exact'):
 
     # return state in case another SCT is used after
     return state
+
+@state_dec
+def check_result_tsql(state, msg="Incorrect result."):
+    """High level function which wraps other SCTs for checking results."""
+
+    stu_res = state.student_result
+    sol_res = state.solution_result
+
+    # empty test
+    test_has_columns(state)
+    # row test
+    test_nrows(state)
+    # column tests
+    child = _sort_columns_indiv(state)
+    for k in sol_res:
+        msg = "Column `{}` in the solution does not have a column with matching values in your results."
+        test_column(child, k, msg, match = 'any')
+
+    return state
+
+def _sort_columns_indiv(state):
+    tiny_none = TinyNone()
+    sorted_columns = lambda res: {k: sorted(col, key = lambda el: el or tiny_none) for k, col in res.items()}
+
+    stu_res = sorted_columns(state.student_result)
+    sol_res = sorted_columns(state.solution_result)
+
+    return state.to_child(
+                student_result = stu_res,
+                solution_result = sol_res)

tests/test_check_result_tsql.py

@@ -0,0 +1,46 @@
+from sqlwhat.Reporter import Reporter
+from sqlwhat.State import State
+from sqlwhat.selectors import Dispatcher
+from sqlwhat.Test import TestFail as TF
+
+import pytest
+
+def prepare_state(sol_result, stu_result):
+    dispatcher = Dispatcher.from_dialect('postgresql')
+
+    return State(
+        student_code = "",
+        solution_code = "",
+        reporter = Reporter(),
+        # args below should be ignored
+        pre_exercise_code = "",
+        student_result = stu_result, solution_result = sol_result,
+        student_conn = None, solution_conn = None,
+        ast_dispatcher = dispatcher)
+
+
+from sqlwhat.sct_syntax import Ex
+from sqlwhat_ext import check_result_tsql
+
+def test_check_result_tsql_chain():
+    state = prepare_state({'a': [1,2,3]}, {'a': [1,2,3]})
+    Ex(state) >> check_result_tsql()
+
+@pytest.mark.parametrize('sol_res,stu_res', [        # pass cases where...
+    ( {'a': [1,2,3]}, {'a': [1,2,3]} ),              # identical
+    ( {'a': [1,2,3]}, {'b': [1,2,3]} ),              # diff colnames
+    ( {'a': [1,2,3]}, {'b': [3,2,1]} ),              # diff colnames + reordered
+    ( {'a': [1]}    , {'a': [1], 'b': [2]} )         # extra cols in student result
+    ])
+def test_check_result_tsql_pass(sol_res, stu_res):
+    state = prepare_state(sol_res, stu_res)
+    check_result_tsql(state)
+
+@pytest.mark.parametrize('sol_res,stu_res', [        # fail cases where...
+    ( {'a': [1,2,3]}, {'a': [1,2]} ),                # too few rows
+    ( {'a': [1,2,3]}, {'a': [1,2,2]} )               # values mismatch
+    ])
+def test_check_result_tsql_match_fail(sol_res, stu_res):
+    state = prepare_state(sol_res, stu_res)
+    with pytest.raises(TF):
+        check_result_tsql(state)