Add tests for Cloud Functions

[eeeeeric]

See the documentation. It will be better to test using a special test project, rather than using offline mode.

[eeeeeric]

We have 6 functions which can be tested:

// Deck Functions
export const importDeckFunction = Decklist.importDeckFunction;
export const parseDeckFunction = Decklist.parseDeckFunction;
export const populateDeckFunction = Decklist.populateDeckFunction;

// Game Functions
export const hostGameFunction = Game.hostGameFunction;
export const joinGameFunction = Game.joinGameFunction;
export const startGameFunction = Game.startGameFunction;

I am mostly interested in white-box testing here, so I believe our ideal approach would be to use a dedicated test project in Firebase. This will allow us to test things as they would be in production and perform the inspections we desire (e.g. this document was created with the following fields).

The scope of this project does not include any CI/CD support, but I will make reference to what we will need to do to achieve that since that is an eventual goal (#19).

To run the tests, we will need to

• Build and deploy functions to Firebase
  • Firebase CLI needs to be available and authenticated (there's nothing to do here for my local environment, although I am not currently using the dedicated Firebase account)
  • For a CI environment like Travis, see the documentation
  • /firebase/.firebaserc will need to include a test project, see the documentation
• Ensure that the WrapAPI config value is available by some means
  • This is a one time setup thing that can be done manually
• Ensure that two test users exists for the project, using email and password auth
  • User 1
  • Use an email value of function-tests-user-1@example.com
  • Use a password value of password
  • User 2
  • Use an email value of function-tests-user-2@example.com
  • Use a password value of password
  • This is a one time setup thing that can be done manually

Test Cases

These cases are not as thorough as they can be, but provide what I feel is the most value for us at this time.

Many of these functions depend on another function in one way or another, so cleanup after each test does not strike me as worthwhile (e.g. I need the imported deck to test starting a game). Cleanup should be run before the tests begin. This allow manual inspection of Firestore contents after a failed test run.

These tests should be run sequentially and in order due to their dependency on each other.

importDeckFunction

This function imports a deck from MTGGoldfish.

Test importing a standard commander deck (1 commander, 99 other)

• Import this deck for user1
• Assert that Users/<uid>/Decks/<deckId> exists
• Assert that the deck name is DRAGONS
• Assert that the sum of all card quantities is equal to 100
• Assert that The Ur-Dragon is listed as the commander (Scryfall ID is 7e78b70b-0c67-4f14-8ad7-c9f8e3f59743)

Test importing a partner commander deck (2 commanders, 98 other)

• Import this deck for user2
• Assert that Users/<uid>/Decks/<deckId> exists
• Assert that the deck name is Example deck with partner commanders
• Assert that the sum of all card quantities is equal to 100
• Assert that Akiri, Line-Slinger and Bruse Tarl, Boorish Herder are listed as the commanders (Scryfall IDs are 3b951e0c-a4dd-4a20-87c6-eaa947e33aa4 and 125b552b-45ea-4e0b-94a9-8131c97a04c0)

Test importing a deck with an invalid or non-existent URI

• Import https://www.mtggoldfish.com/deck/1630110FAKE#paper
• Assert that the function returns an error

parseDeckFunction

This function parses a deck from MTGGoldfish. The output produced is an intermediary format that is intended for use by a future deck editor feature, which we may or may not ever implement. The backing logic is the same as that for the importDeckFunction, so I don't think it is necessary to add tests for this function.

populateDeckFunction

This function provides data from Scryfall for each card in the requested deck.

Test populating for a deck

• Populate the partner commander deck, including only the fields name and id.
• Assert that we get back data for all four unique cards
  • We should see the names Akiri, Line-Slinger, Bruse Tarl, Boorish Herder, Mountain, and Plains

Test populating a deck that does not exist

• Populate a deck with id FAKEID
• Assert that the function returns an error

hostGameFunction

This creates a new Game that is initialized with the host player and a target deck.

Test starting a game

• Host a game with the DRAGONS deck as user 1
• Assert that Games/<gameId>/Players/<userId> exists, and has
  • life set to 40
  • uid set to
  • meta.deck_id set to the correct value for the DRAGONS deck
• Assert that Games/<gameId>/Cards contains 100 documents
• Assert that the collection contains exactly 1 document where scryfall_id equals 7e78b70b-0c67-4f14-8ad7-c9f8e3f59743, state.zone equals Command, and state.owner equals <userId for user 1>

No negative tests for now.

joinGameFunction

This joins an existing game.

Test joining a game

• Join a game with the partner commander deck as user 2
• Assert that Games/<gameId>/Players/<userId> exists, and has
  • life set to 40
  • uid set to
  • meta.deckId set to the correct value for the partner commander deck
• Assert that Games/<gameId>/Cards contains 200 documents
• Assert that the collection contains exactly 1 document where scryfall_id equals 3b951e0c-a4dd-4a20-87c6-eaa947e33aa4, state.zone equals Command, and state.owner equals <userId for user 2>
• Assert that the collection contains exactly 1 document where scryfall_id equals 125b552b-45ea-4e0b-94a9-8131c97a04c0, state.zone equals Command, and state.owner equals <userId for user 2>

startGameFunction

This starts a game by determining the turn order.

Start the game

• As user1, start the game
• Assert that Games/<gameId> has a turn_order field, containing properties 0 and 1, one of which points to user1 and the other to user2

[eeeeeric]

Some things I've realized as I'm working on this

• I didn't implement #24 yet
• When a new user is created, something (I hope a function is the answer) needs to create their User document in Firestore
• For whatever reason, I decided to return the data in the form of headers, with a useless plain text body. I need to open an issue to update the functions to return a JSON body containing the data. (For example, when you import a deck, the deck ID is returned in the X-DeckID header, rather than as a property of the body.)
• I had a bug in the initialization logic for decks (cards where qty > 1 weren't being expanded into qty distinct cards). I'm glad I'm writing tests.
• There are some inconsistencies in how things are named, e.g. Command vs command depending on if you are looking at a deck stored for a player vs a card stored for a game.
• The turn_order field on the game document probably could be a simple array, since we write once and read once

Other notes

• I created a service account via the instructions I found here, but I'm not sure if there is any difference between that and this. As far as I can tell, the accounts have the same privileges and permissions though.
• The service account credentials are highly sensitive, so they cannot be committed to git. For Travis CI, we will need to encrypt the file
• I see this when running tests, I need to figure out why and how best to fix it
  • Warning, FIREBASE_CONFIG environment variable is missing. Initializing firebase-admin will fail
• Deleting an entire collection via code is crappy because the SDK does not provide a native method for this, so instead, I added a script (npm run fb-clean) to do it via the CLI.

There are a number of TODO items in here which I will take care of after the meeting tomorrow.

[eeeeeric]

I see this when running tests, I need to figure out why and how best to fix it

• Warning, FIREBASE_CONFIG environment variable is missing. Initializing firebase-admin will fail

Regarding this warning - it seems that this env var is auto populated in cloud environments and provides some configuration that we currently don't need, so this is benign, for now. I doubt it will be difficult to fix should the time come so I'm going to do nothing for it. (You can make it go away for now by just running export FIREBASE_CONFIG={} before running the tests).

This, along with the above issues I opened, should track all the TODOs from my last comment.