Fix/doc tests

[neomonkeus]

@niftools/pyffi-reviewers

Overview

Incremental increases in test suite execution working towards all tests being executed. Consolidation of test structure to support above.

Fixes Known Issues

N/A

Documentation

Holding off on docs until we take a decision if we can co-execute automation tests that run pytest via Travis/Appvoyer and local tests executing via doc tests.

Testing

Expanded number of tests suite being executed. Performed maintenance updates on doctests. Structural improvements, i.e moved files around the place to mirror prod structure better.

Manual

All manual tests mainly relate to tests run via doctests.

• Majority of doctest tests fixed, not really the goal of the PR but nice to get some progress.
• These are not included in automated tests suite, so coverage won't reflect accurately doctest/currently manual related changes.

So...bonus coverage awaits if we can get these included in automation. The reason not included as part of this PR is :

• improved pass rate of about 30+ test cases working again, mainly low hanging fruit, not all tests are passing. Further effort required to identify if test or code issue. Main goal of PR is get framework up and running. Separate issues will be written when we get down individual tests failure point.
• Need to decide effort required unify running of all tests via pytests or provide an alternative method of execution for travis/appvoyer or convert to another system.

They aren't currently run via the pytest automation as they would break due to relative path issues. At a later stage, attempt to figure if it is worth unifying how they run together through local execution, relative.

Automated

• Increased test coverage by 10% -> 36%

Additional Information

The process of introducing more tests will be incremental, but I think there is enough content. These maybe replaced at a later stage as paths are not very well supported. This does not contribute to current coverage for automation.

[coveralls]

Coverage increased (+5.8%) to 34.364% when pulling 977d1d89f58e7f163dd1d27e8ae02791913fcd6a on neomonkeus:fix/doc_tests into de11acdbb6a3aa1045673fdeeefbb72ed09693a8 on niftools:develop.

[neomonkeus]

@psi29a are you happy with the review?

[psi29a]

I am, we can build on this. :)