Unit Testing - Githubissues

hwoodward / Remote-Card-Games

Program for playing card games online/remotely. Goal is to play a game of hand and foot with multiple groups in different locations.

MIT License

2 stars 1 forks source link

Unit Testing #14

Closed hwoodward closed 5 years ago

hwoodward commented 5 years ago

need to define how much we force ourselves to do and where it lives, then do it for what code we have already written. Steps

[x] write unit tests for common code (Cards)
[x] write unit tests for the state trackers
[x] look into what we can unit test of the listeners/playerChannel/server to test they do the correct thing on receiving a network call (might not be possible)
[x] decide if we should test that send functions generate the json as expected/specified in the API (network calls read them with an expectation of format, but if we change the format then we change 3 places, the send func, the network func that recieves it, AND the unit test)
[x] Document this stuff!

hwoodward commented 5 years ago

Notes from before I made the checklist for reference:

sending communication cannot be unit tested, but we can probably test that the Network_actionName methods cause the correct state changes without establishing a functional connection
can definitely test the methods inside the serverState and client stateTracker classes to ensure that the transitions work (although most of those essentially just call a state transition and a send action)
could maybe make a mockito type thing to make sure that send actions have expected content
the common classes DEFINITELY need unit testing and that can be done
testing the UI might be tricky since the goal is to check that a render results in a proper image

hwoodward commented 5 years ago

If anyone has thoughts/comments/knowledge about unit testing, especially in python and/or with network calls/APIs speak up. I probably need to google best practices about the network api stuff (and maybe python too)

hwoodward commented 5 years ago

oops.

hwoodward commented 5 years ago

We now have documentation on what should be unit tested in the contributing guide - its common code and state trackers. The network calls I decided it would be just one more place for the api to be coded in correctly and the data transmission is tested in podsixnet. The UI is hard to test at all and it gets its data via the state tracker - so while testing its render is expected to be done on edit I don't think a unit test is needed.