Add automated tests using Tox

This commit creates a test suite for the xblock and uses the
Tox framework to make tests automatically run when the
repository is ubdated. The suite of tests can be run as follows:

 python ./manage.py lms test --verbosity=1
 xblock-submit-and-compare/submit_and_compare/tests.py --traceback
 --settings=test

Author: azimpradhan

.gitignore

@@ -0,0 +1,2 @@
+.coverage
+.tox/

.travis.yml

@@ -0,0 +1,27 @@
+sudo: false
+language: python
+cache: pip
+python:
+    - '2.7'
+before_install:
+    - 'uname -a'
+    - 'python --version'
+install:
+    - 'pip install tox'
+    - 'virtualenv --version'
+    - 'easy_install --version'
+    - 'pip --version'
+    - 'tox --version'
+script:
+    - 'tox -v'
+branches:
+    only:
+      - 'master'
+env:
+    - TOXENV=py27-dj14
+    - TOXENV=py27-dj18
+    - TOXENV=coveralls
+    - TOXENV=pep8
+    # TODO: Add pylint and pyflakes compliance
+    # - TOXENV=pyflakes
+    # - TOXENV=pylint

manage.py

@@ -0,0 +1,12 @@
+#!/usr/bin/env python
+"""
+Manage the djangoapp
+"""
+import os
+import sys
+
+from django.core.management import execute_from_command_line
+
+if __name__ == '__main__':
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'submit_and_compare.settings')
+    execute_from_command_line(sys.argv)

pylintrc

@@ -0,0 +1,8 @@
+[VARIABLES]
+dummy-variables-rgx=_|dummy
+
+[REPORTS]
+reports=no
+
+[MESSAGES CONTROL]
+disable=locally-disabled

setup.cfg

@@ -0,0 +1,6 @@
+[metadata]
+description-file = README.markdown
+
+[nosetests]
+cover-package=submit_and_compare
+cover-tests=1

setup.py

@@ -2,7 +2,7 @@
 
 import os
 from setuptools import setup
-
+from setuptools.command.test import test as TestCommand
 
 def package_data(pkg, root):
     """Generic function to find package_data for `pkg` under `root`."""
@@ -14,6 +14,25 @@ def package_data(pkg, root):
     return {pkg: data}
 
 
+class Tox(TestCommand):
+    user_options = [('tox-args=', 'a', "Arguments to pass to tox")]
+    def initialize_options(self):
+        TestCommand.initialize_options(self)
+        self.tox_args = None
+    def finalize_options(self):
+        TestCommand.finalize_options(self)
+        self.test_args = []
+        self.test_suite = True
+    def run_tests(self):
+        # import here, cause outside the eggs aren't loaded
+        import tox
+        import shlex
+        args = self.tox_args
+        if args:
+            args = shlex.split(self.tox_args)
+        errno = tox.cmdline(args=args)
+        sys.exit(errno)
+
 setup(
     name='xblock-submit-and-compare',
     version='0.5',
@@ -23,11 +42,21 @@ def package_data(pkg, root):
     ],
     install_requires=[
         'XBlock',
+        'django',
+        'edx-opaque-keys',
+        'mock',
+        'django_nose',
+        'coverage',
     ],
     entry_points={
         'xblock.v1': [
             'submit-and-compare = submit_and_compare:SubmitAndCompareXBlock',
         ]
     },
     package_data=package_data("submit_and_compare", "static"),
-)
+    tests_require=[
+    ],
+    cmdclass={
+        'test': Tox,
+    },
+)

submit_and_compare/settings.py

@@ -0,0 +1,14 @@
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        # 'NAME': 'intentionally-omitted',
+    },
+}
+
+TEST_RUNNER = 'django_nose.NoseTestSuiteRunner'
+
+INSTALLED_APPS = (
+    'django_nose',
+)
+
+SECRET_KEY = 'TOX_SECRET_KEY'

submit_and_compare/tests.py

@@ -0,0 +1,140 @@
+"""
+Module Placeholder Docstring
+"""
+import unittest
+
+import cgi
+import mock
+from django.test.client import Client
+from django.utils.translation import ugettext as _
+from opaque_keys.edx.locations import SlashSeparatedCourseKey
+from xblock.field_data import DictFieldData
+
+from .submit_and_compare import SubmitAndCompareXBlock
+
+
+class SubmitAndCompareXblockTestCase(unittest.TestCase):
+    # pylint: disable=too-many-instance-attributes, too-many-public-methods
+    """
+    A complete suite of unit tests for the Free-text Response XBlock
+    """
+    @classmethod
+    def make_an_xblock(cls, **kw):
+        """
+        Helper method that creates a Free-text Response XBlock
+        """
+        course_id = SlashSeparatedCourseKey('foo', 'bar', 'baz')
+        runtime = mock.Mock(course_id=course_id)
+        scope_ids = mock.Mock()
+        field_data = DictFieldData(kw)
+        xblock = SubmitAndCompareXBlock(runtime, field_data, scope_ids)
+        xblock.xmodule_runtime = runtime
+        return xblock
+
+    def setUp(self):
+        # pylint: disable=super-method-not-called
+        self.xblock = SubmitAndCompareXblockTestCase.make_an_xblock()
+        self.client = Client()
+
+    def test_student_view(self):
+        # pylint: disable=protected-access
+        """
+        Checks the student view for student specific instance variables.
+        """
+        student_view_html = self.student_view_html()
+        self.assertIn(self.xblock.display_name, student_view_html)
+        self.assertIn(
+            self.xblock._get_body(self.xblock.question_string),
+            student_view_html,
+        )
+        self.assertIn(self.xblock._get_problem_progress(), student_view_html)
+
+    def test_studio_view(self):
+        """
+        Checks studio view for instance variables specified by the instructor.
+        """
+        studio_view_html = self.studio_view_html()
+        self.assertIn(self.xblock.display_name, studio_view_html)
+        self.assertIn(
+            cgi.escape(self.xblock._get_body(self.xblock.question_string)),
+            studio_view_html,
+        )
+        self.assertIn(str(self.xblock.max_attempts), studio_view_html)
+
+    def test_initialization_variables(self):
+        """
+        Checks that all instance variables are initialized correctly
+        """
+        self.assertEquals('Submit and Compare', self.xblock.display_name)
+        self.assertIn(
+            'Before you begin the simulation',
+            self.xblock.question_string,
+        )
+        self.assertEquals(0.0, self.xblock.score)
+        self.assertEquals(0, self.xblock.max_attempts)
+        self.assertEquals('', self.xblock.student_answer)
+        self.assertEquals(0, self.xblock.count_attempts)
+
+    def student_view_html(self):
+        """
+        Helper method that returns the html of student_view
+        """
+        return self.xblock.student_view().content
+
+    def studio_view_html(self):
+        """
+        Helper method that returns the html of studio_view
+        """
+        return self.xblock.studio_view(context=None).content
+
+    def test_problem_progress_score_zero_weight_singular(self):
+        # pylint: disable=invalid-name, protected-access
+        """
+        Tests that the the string returned by get_problem_progress
+        when the weight of the problem is singular, and the score is zero
+        """
+        self.xblock.score = 0
+        self.xblock.weight = 1
+        self.assertEquals(
+            _('1 point possible'),
+            self.xblock._get_problem_progress(),
+        )
+
+    def test_problem_progress_score_zero_weight_plural(self):
+        # pylint: disable=invalid-name, protected-access
+        """
+        Tests that the the string returned by get_problem_progress
+        when the weight of the problem is plural, and the score is zero
+        """
+        self.xblock.score = 0
+        self.xblock.weight = 3
+        self.assertEquals(
+            _('3 points possible'),
+            self.xblock._get_problem_progress(),
+        )
+
+    def test_problem_progress_score_positive_weight_singular(self):
+        # pylint: disable=invalid-name, protected-access
+        """
+        Tests that the the string returned by get_problem_progress
+        when the weight of the problem is singular, and the score is positive
+        """
+        self.xblock.score = 1
+        self.xblock.weight = 1
+        self.assertEquals(
+            _('1/1 point'),
+            self.xblock._get_problem_progress(),
+        )
+
+    def test_problem_progress_score_positive_weight_plural(self):
+        # pylint: disable=invalid-name, protected-access
+        """
+        Tests that the the string returned by get_problem_progress
+        when the weight of the problem is plural, and the score is positive
+        """
+        self.xblock.score = 1.5
+        self.xblock.weight = 3
+        self.assertEquals(
+            _('1.5/3 points'),
+            self.xblock._get_problem_progress(),
+        )

tox.ini

@@ -0,0 +1,50 @@
+[tox]
+downloadcache = {toxworkdir}/_download/
+envlist = py27-dj{14,18},coverage,pep8,pylint,pyflakes
+
+[testenv]
+commands = {envpython} manage.py test
+
+[testenv:py27-dj14]
+deps =
+    django == 1.4.22
+
+[testenv:py27-dj18]
+deps =
+    django >= 1.8, < 1.9
+
+[testenv:pep8]
+deps = pep8
+commands = {envbindir}/pep8 submit_and_compare/
+
+[testenv:pylint]
+deps = pylint
+commands = {envbindir}/pylint submit_and_compare/
+
+[testenv:pyflakes]
+deps = pyflakes
+commands = {envbindir}/pyflakes submit_and_compare/
+
+# Note: Coverage appears lower than it actually is.
+# For a detailed explanation of why this is the case, see:
+# https://docs.python.org/devguide/coverage.html#common-gotchas
+[testenv:coverage]
+deps =
+    coverage
+setenv =
+    NOSE_COVER_TESTS=1
+    NOSE_WITH_COVERAGE=1
+commands =
+    {envpython} manage.py test
+
+[testenv:coveralls]
+deps =
+    coverage
+    coveralls
+setenv =
+    NOSE_COVER_TESTS=1
+    NOSE_WITH_COVERAGE=1
+passenv = TRAVIS TRAVIS_JOB_ID TRAVIS_BRANCH
+commands =
+    {envpython} manage.py test
+    {envbindir}/coveralls