Repository navigation
Initial unit testing framework and tests #7026
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,3 +39,4 @@ uninstaller/UAC.nsh | |
| *.pyc | ||
| *.pyo | ||
| *.dmp | ||
| tests/unit/nvda.ini | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| #tests/unit/__init__.py | ||
| #A part of NonVisual Desktop Access (NVDA) | ||
| #This file is covered by the GNU General Public License. | ||
| #See the file COPYING for more details. | ||
| #Copyright (C) 2017 NV Access Limited | ||
|
|
||
| """NVDA unit testing. | ||
| All unit tests should reside within this package and should be | ||
| divided into modules and packages similar to the code they are testing. | ||
| Test modules must have a C{test_} prefix | ||
| and should contain one or more classes with a C{Test} prefix which subclass L{TestCase}. | ||
| Methods in test classes should have a C{test_} prefix. | ||
| """ | ||
|
|
||
| ### Ugly bootstrapping code. | ||
|
|
||
| import os | ||
| import sys | ||
|
|
||
| # The path to the unit tests. | ||
| UNIT_DIR = os.path.dirname(os.path.abspath(__file__)) | ||
| # The path to the top of the repo. | ||
| TOP_DIR = os.path.dirname(os.path.dirname(UNIT_DIR)) | ||
| # The path to the NVDA "source" directory. | ||
| SOURCE_DIR = os.path.join(TOP_DIR, "source") | ||
| # Let us import modules from the NVDA source. | ||
| sys.path.insert(1, SOURCE_DIR) | ||
| import sourceEnv | ||
|
|
||
| # Set options normally taken from the command line. | ||
| import globalVars | ||
| class AppArgs: | ||
| # The path from which to load a configuration file. | ||
| # Ideally, this would be an in-memory, default configuration. | ||
| # However, config currently requires a path. | ||
| # We use the unit test directory, since we want a clean config. | ||
| configPath = UNIT_DIR.decode("mbcs") | ||
| secure = False | ||
| disableAddons = True | ||
| globalVars.appArgs = AppArgs() | ||
|
|
||
| # We depend on the current directory to load some files; | ||
| # e.g. braille imports louis which loads liblouis.dll using a relative path. | ||
| os.chdir(SOURCE_DIR) | ||
| # The path to this package might be relative, so make it absolute, | ||
| # since we just changed directory. | ||
| __path__[0] = UNIT_DIR | ||
| # We don't want logging. | ||
| import logging | ||
| from logHandler import log | ||
| log.addHandler(logging.NullHandler()) | ||
|
Contributor
There was a problem hiding this comment. As discussed, I think it could be helpful to be able to get the log information out of some tests. The log info could make debugging the unit tests easier. Could you open (and p4) an issue to keep track of the different ways we talked about to achieve this? I think for now there is low urgency on actually implementing this, however at the point when someone is trying to debug a unit test this could become more important. |
||
| # There's no point in logging anything at all, since it'll go nowhere. | ||
| log.setLevel(100) | ||
|
|
||
| # Much of this should eventually be replaced by stuff which gets reset before each test | ||
| # so the tests are isolated. | ||
| import config | ||
| config.initialize() | ||
| # Initialize languageHandler so that translatable strings work. | ||
| import languageHandler | ||
| languageHandler.setLanguage("en") | ||
| # NVDAObjects need appModuleHandler to be initialized. | ||
| import appModuleHandler | ||
| appModuleHandler.initialize() | ||
| # Anything which notifies of cursor updates requires braille to be initialized. | ||
| import braille | ||
| braille.initialize() | ||
| # The focus and navigator objects need to be initialized to something. | ||
| from NVDAObjects import NVDAObject | ||
| class PlaceholderNVDAObject(NVDAObject): | ||
| processID = None # Must be implemented to instantiate. | ||
| phObj = PlaceholderNVDAObject() | ||
| import api | ||
| api.setFocusObject(phObj) | ||
| api.setNavigatorObject(phObj) | ||
|
|
||
| # Stub speech functions to make them no-ops. | ||
| # Eventually, these should keep track of calls so we can make assertions. | ||
| import speech | ||
| speech.speak = lambda speechSequence, symbolLevel=None: None | ||
| speech.speakSpelling = lambda text, locale=None, useCharacterDescriptions=False: None | ||
|
|
||
| ### Base classes/utility functions. | ||
|
|
||
| import unittest | ||
|
|
||
| class TestCase(unittest.TestCase): | ||
|
Contributor
There was a problem hiding this comment. As discussed, I dont think we need this for now. We will need some way of managing setup/tear down of dependencies, but perhaps we should address this later. |
||
| """The base class which all test case classes should subclass. | ||
| """ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| ### | ||
| #This file is a part of the NVDA project. | ||
| #URL: http://www.nvaccess.org/ | ||
| #Copyright 2017 NV Access Limited. | ||
| #This program is free software: you can redistribute it and/or modify | ||
| #it under the terms of the GNU General Public License version 2.0, as published by | ||
| #the Free Software Foundation. | ||
| #This program is distributed in the hope that it will be useful, | ||
| #but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| #MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | ||
| #This license can be found at: | ||
| #http://www.gnu.org/licenses/old-licenses/gpl-2.0.html | ||
| ### | ||
|
|
||
| import sys | ||
|
|
||
| Import("env") | ||
|
|
||
| cmd = [sys.executable, "-m", "unittest"] | ||
| tests = env["unitTests"] | ||
| if tests: | ||
| # Run specific tests. | ||
| tests = tests.split(",") | ||
| cmd += ["tests.unit." + test for test in tests] | ||
| else: | ||
| # Run all tests. | ||
| cmd.extend(("discover", "tests.unit", "-t", ".")) | ||
| target = env.Command(".", None, [cmd]) | ||
| Return('target') |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| #tests/unit/test_cursorManager.py | ||
| #A part of NonVisual Desktop Access (NVDA) | ||
| #This file is covered by the GNU General Public License. | ||
| #See the file COPYING for more details. | ||
| #Copyright (C) 2017 NV Access Limited | ||
|
|
||
| """Unit tests for the cursorManager module. | ||
| """ | ||
|
|
||
| import unittest | ||
| import cursorManager | ||
| from . import TestCase | ||
| from .textProvider import BasicTextProvider | ||
|
|
||
| class CursorManager(cursorManager.CursorManager, BasicTextProvider): | ||
| """CursorManager which navigates within a provided string of text. | ||
| """ | ||
|
|
||
| class TestMove(TestCase): | ||
|
|
||
| def test_nextChar(self): | ||
| cm = CursorManager(text="abc") # Caret at "a" | ||
| cm.script_moveByCharacter_forward(None) | ||
| self.assertEqual(cm.selectionOffsets, (1, 1)) # Caret at "b" | ||
|
|
||
| def test_prevChar(self): | ||
| cm = CursorManager(text="abc", selection=(1, 1)) # Caret at "b" | ||
|
Contributor
There was a problem hiding this comment. Rather than the comment, the |
||
| cm.script_moveByCharacter_back(None) | ||
| self.assertEqual(cm.selectionOffsets, (0, 0)) # Caret at "a" | ||
|
|
||
| class TestSelection(TestCase): | ||
|
|
||
| def test_selectNextChar(self): | ||
| cm = CursorManager(text="abc") # Caret at "a" | ||
| cm.script_selectCharacter_forward(None) | ||
| self.assertEqual(cm.selectionOffsets, (0, 1)) # "a" selected | ||
|
|
||
| def test_selectPrevChar(self): | ||
| cm = CursorManager(text="abc", selection=(1, 1)) # Caret at "b" | ||
| cm.script_selectCharacter_back(None) | ||
| self.assertEqual(cm.selectionOffsets, (0, 1)) # "a" selected | ||
|
|
||
| def test_unselectPrevChar(self): | ||
| cm = CursorManager(text="abc") # Caret at "a" | ||
| cm.script_selectCharacter_forward(None) # "a" selected | ||
| cm.script_selectCharacter_back(None) # "a" unselected | ||
| self.assertEqual(cm.selectionOffsets, (0, 0)) # Caret at "a", no selection | ||
|
|
||
| def test_selForwardThenUnselThenSelBackward(self): | ||
| """Test selecting forward, then unselecting and selecting backward. | ||
|
Contributor
There was a problem hiding this comment. The docstring could be more explicit about the dependencies between tests / behaviour. |
||
| """ | ||
| cm = CursorManager(text="abc", selection=(1, 1)) # Caret at "b" | ||
| cm.script_selectCharacter_forward(None) # "b" selected | ||
| cm.script_selectCharacter_back(None) # "b" unselected, caret at "b" | ||
| cm.script_selectCharacter_back(None) | ||
| self.assertEqual(cm.selectionOffsets, (0, 1)) # "a" selected | ||
|
|
||
| def test_selectForwardThenSelBackward(self): | ||
| """Test selecting forward, then selecting backward without unselecting. | ||
| """ | ||
| cm = CursorManager(text="abc", selection=(1, 1)) # Caret at "b" | ||
| cm.script_selectCharacter_forward(None) # "b" selected | ||
| cm.script_selectWord_back(None) # "b" unselected, "a" selected | ||
| self.assertEqual(cm.selectionOffsets, (0, 1)) # "a" selected | ||
|
|
||
| class TestSelectAll(TestCase): | ||
| """Tests the select all command starting from different caret positions. | ||
| """ | ||
|
|
||
| def _selectAllTest(self, caret): | ||
| """Tests select all with the caret at the given offset. | ||
| """ | ||
| cm = CursorManager(text="abc", selection=(caret, caret)) | ||
| cm.script_selectAll(None) | ||
| self.assertEqual(cm.selectionOffsets, (0, 3)) # "abc" selected | ||
|
|
||
| def test_selectAllFromStart(self): | ||
| self._selectAllTest(0) # Caret at "a" | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is probably fine for now. But in the future this might need to pulled into the working directory for the test (even better if it was in memory rather than moving actual files around) during the setup for the test. If all tests use the same config file, there is a chance that some test will modify the settings and we could get some pretty nasty test interactions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Totally agree that ideally, we want to keep this in memory and isolate it per test. If it eases your concern any in the short-term, it's worth noting that nothing in NVDA ever really saves the configuration except the save configuration command or auto save on NVDA exit, neither of which should ever be reasonably called from a unit test.