Testing Gramps

From Gramps
Revision as of 16:00, 27 November 2013 by BACbKA (talk | contribs) (unit tests in the main tree)
Jump to: navigation, search

Currently used tests and frameworks

testing of reports


Runs all possible reports using the report cli interface, based on the example.gramps database. This test is not fully self-contained, in that it depends on various environment settings, such as your locale, your preferred name display formats, and your report options. Last, but not the least, the verification of the resulting reports is entirely manual.

Bugs tagged as found-by-runtest.sh

other report testing

See more specialized scripts in test/, status unknown.


Import/export test for GRAMPS.

From the file header:

  • Import example XML data and create internal Gramps DB
  • Open produced Gramps DB, then
    • check data for integrity
    • output in all formats
  • Check resulting XML for well-formedness and validate it against DTD and RelaxNG schema.
  • Import every exported file produced if the format is also supported for import, and run a text summary report.
  • Diff each report with the summary of the produced example DB.

Bugs tagged as found-by-impex.sh

Unit testing


Runs out-of-tree (not in gramps/) testing code, by looking for any test/*_Test.py files and executing the test suites therein. See the current code in test/*_Test.py for example and python standard unittest docs.

Starting with gramps40 branch, these tests include non-automated unit tests only. The automated unit tests are all under gramps/.

Bugs tagged as found-by-RunAllTests.py

GtkHandler testing code pops up the GRAMPS error dialog, but this is actually for testing the error reporting itself. Don't be scared by the dialog, it's expected. Your manual work is required to close the dialogs with the "Cancel" button. The relevant tests still pass (unless there's another bug there)...

unit tests in the main tree

python setup.py test

See Unit Test Quickstart for detailed running instructions.

File Status Comments
gramps/cli/test/cli_test.py OK 3 tests
gramps/cli/test/user_test.py OK 8 tests (6 require mocking to run)
gramps/gen/test/config_test.py OK 1 test
gramps/gen/test/constfunc_test.py OK 1 test (linux only, skipped elsewhere)
gramps/gen/test/user_test.py OK 1 test. See #7013 for context
gramps/gen/datehandler/test/datehandler_test.py OK 9 tests
gramps/gen/db/test/cursor_test.py OK 4 tests, 2 skipped
gramps/gen/db/test/db_test.py OK 6 tests
gramps/gen/db/test/reference_map_test.py OK 5 tests
gramps/gen/lib/test/date_test.py OK 8 tests (locale-based, OK for en, fails for some other locales)
gramps/gen/lib/test/grampstype_test.py OK 3 tests
gramps/gen/lib/test/merge_test.py FAIL 201 tests, 2 failed skipped 7027
gramps/gen/merge/test/merge_ref_test.py OK 53 tests
gramps/gen/utils/test/callback_test.py OK 10 tests
gramps/gen/utils/test/keyword_test.py OK 4 tests
gramps/gen/utils/test/place_test.py FAIL 28 tests, 4 failures (bug #7044)
gramps/gui/logger/test/rotate_handler_test.py OK 2 tests
gramps/gui/test/user_test.py OK 1 test (requires mocking to run)
gramps/plugins/export/test/exportvcard_test.py OK 28 tests
gramps/plugins/importer/test/importvcard_test.py OK 66 tests
gramps/plugins/importer/test/importxml_test.py OK 4 tests
gramps/plugins/importer/test/importgeneweb_test.py OK 2 tests
gramps/test/test/gedread_util_test.py No longer required?
gramps/test/test/test_util_test.py No longer required?

There is also semi-interactive testing via __main__ in some code:

File Status Comments
gramps/gen/relationship.py To Do Relationship calculator
gramps/gen/db/bsddbtxn.py To Do
gramps/gen/db/txn.py To Do
gramps/gen/db/undoredo.py To Do
gramps/gen/db/write.py To Do
gramps/gen/db/txn.py To Do
gramps/gen/lib/styledtext.py To Do
gramps/gen/utils/place.py OK Done
gramps/gen/utils/docgen/odstab.py To Do
gramps/gen/utils/docgen/csvtab.py To Do
gramps/gui/ddtargets.py To Do Not worth running?
gramps/gui/widgets/undoablebuffer.py To Do Not worth running?
gramps/gui/dialog.py To Do Interactive
gramps/gui/widgets/validatedmaskedentry.py To Do Interactive
gramps/gui/widgets/progressdialog.py To Do Interactive
gramps/gui/widgets/statusbar.py To Do Interactive
gramps/plugins/lib/libsubstkeyword.py To Do
gramps/plugins/rel/rel_*.py To Do Relationship calculator plugins
gramps/plugins/tool/phpgedviewconnector.py To Do

Manual test plan

See TestPlan.txt in gramps toplevel. I believe this is only done at a major release (like 4.0.0).

Test status

We currently don't have a record of tests executed, the platforms and environments they were run upon, and what code they covered. The only indirect evidence is available in open bugs, when people care to fill in these details. :-(

Possible improvements

  • unify running all the tests, in- or out- tree
    • Try switching the feature tests and non-automated unit tests in test/ from our runner scripts to python native unittest discovery mechanism.
    • we have a stale gramps/test/regrtest.py runner, notable for logging init. - should we revive that, or maybe integrate into setup.py test runner?
  • coverage analysis
  • (needs server capacity to be hosted online) continous test status report, coverage, automatic deployment into win/mac/linux VMs (I can dream, can't I?)

See also