jamespjh / eResearch-meeting-list

Apache License 2.0
5 stars 6 forks source link

Adding tests for all meetings, documentation in readme #40

Closed vsoch closed 4 years ago

vsoch commented 4 years ago

This PR will add a testing file to check the contents of each data file under _data. I'm not sure if this repo has github actions so I waited on adding a workflow, but (whatever service we add) we would basically need to install pyaml, pytest, and then run:

$ pytest tests/test_meetings.py 
============================= test session starts ==============================
platform linux -- Python 3.7.3, pytest-4.3.1, py-1.8.0, pluggy-0.9.0
rootdir: /home/vanessa/Documents/Dropbox/Code/usrse/eResearch-meeting-list, inifile:
plugins: remotedata-0.3.1, openfiles-0.3.2, doctestplus-0.3.0, arraydiff-0.3
collected 1 item                                                               

I've also added notes in the README about expected fields and formatting so there aren't surprises. I noticed that some files have "extra" fields that are custom/specific to them, and I didn't error/fail these tests, but likely this should be addressed in some way (likely we should decide on a specific set of officially supported fields and error if extras are found).

This will close #39, and of course we will also need to have this run automated with CI (per preference of @jamespjh )

Signed-off-by: Vanessa Sochat vsochat@stanford.edu

jamespjh commented 4 years ago

Thanks @vsoch