[WIP] Add unit tests

[HubLot]

Hi,

I'm currently adding unit tests into the package to increase its 'robustness', specially on the different functions of the package (I think the scripts in test_regression.py are very well covered).
I also realized that I introduced some functions before without unit tests associated (booo).

[HubLot]

Hi,

Here a few commits to close this PR:

• I shrinked the test_data directory (~20Mb -> 2Mb) by shrinking the barstar test files. I removed the water from the gro and xtc and kept only 100 frames of the xtc. I also kept only 3 models of the 2LFU pdb (instead of 10).
• As discussed in Remove test dir from PyPi package? #121, I created a function called tests() within the root path of PBxplore so the users can run the tests easily. For example :

import pbxplore
pbxplore.tests()

One small issue: usually the test folder is named "tests" and the function is named "test". Here, it's the other way. I could rename those if you want before merging.
Another one is that nose automatically find tests by researching keywords. To prevent it to run this new function tests(), we need to specify the test folder now:

nosetests -v pbxplore/test

I updated those information into the install page of the documentation by creating a chapter called "Testing PBxplore".

• I create a function named system_info inside the test module which print the version and the install directory of PBxplore dependencies as well as the version of python.

[pierrepo]

Great work @HubLot !

One small issue: usually the test folder is named "tests" and the function is named "test". Here, it's the other way. I could rename those if you want before merging.

If you feel this is more mainstream to have the test function named test() and the test directory tests, you can rename them.

Regarding system_info and the module_info() function, be aware that not all Python modules have their version number in __version__.

@jbarnoud what do you think?

[HubLot]

Regarding system_info and the module_info() function, be aware that not all Python modules have their version number in version.

Indeed, I'll add a test to prevent the possible error.

[HubLot]

I updated the PR.

@jbarnoud can you review?

[jbarnoud]

I'll look at it on Saturday.

On 12-05-16 16:51, Hub wrote:

I updated the PR.

@jbarnoud https://github.com/jbarnoud can you review?

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#122 (comment)

[jbarnoud]

Does that mean that you must be in the PBxplore directory to tun this command? If not, the sentence is unclear. I would suggest something like:

Or from the `PBxplore` module

[jbarnoud]

I posted a few comments. Besides these, everything looks good to me.

[HubLot]

I updated the PR with @jbarnoud comments.
I also renamed the test folder "tests" and the function 'tests()' into 'test()' to be more 'mainstream' (and of course, updated the documentation and travis).
If you don't agree, I can roll back to the previous version.
If you agree, the PR can be merged :)