Testing Kvasir¶

Running the Tests¶

There are a couple of configuration options that you have to set in order for the test cases to work the first time:

• KVASIR_MIDDLEWARE_TEST_URI=http://localhost:5000

  • the Python middleware server will run on port 5000 and we want to tell Kvasir to use this URL for running tests

You can either set this in your .env file or via environment variables.

When you run Kvasir you want to run it as:

>>> npm start -- --test

This will launch Kvasir in test mode and overwrite the value of KVASIR_MIDDLEWARE_URI with the value on KVASIR_MIDDLEWARE_TEST_URI. It will also override the value of KVASIR_MIDDLEWARE_SECRET with the value provided in the test JSON “database.”

After this is set up, open another terminal window and navigate to the test directory and run:

>>> pip install -r requirements.txt
>>> python middleware.py

The first line will install all required libraries for our middleware to run. The second will actually launch it.

The middleware loads the JSON file into memory in order to simulate what it would look like if this was actually live. Originally, we wrote only failure test cases, because we couldn’t be certain what values would be in every database that tries to integrate with us. It’s hard to write a test to successfully query a user based on their email if you don’t know what emails you have avaialable.

Now launch a third terminal and navigate to Kvasir’s main source directory and run:

>>> npm test

This will launch a series of test cases, all of which should succeed.

These tests are designed to make sure that the server and the middleware:

1. can communicate with one another
2. are returning data in the expected format
3. are returing errors when they are supposed to

The tests are broken up into two sections - server tests and middleware tests. The server tests rely on communication with the middleware to succeed, so if your middleware is not working properly the server tests will fail, but just because the server tests fail does not mean its a result of a middleware. So we provide tests that will specifically query your middleware to provide more clarity as to why tests may be failing.

Testing your Middleware¶

While a middleware is readily provided, the KVASIR_MIDDLEWARE_TEST_URI is meant to provide you with the ability to change what URI you are testing against, and thereby what middleware you test against.

All Kvasir cares about is that the middleware is present and returns data as expected. As you develop your own middleware, you can use the testing cases provided to make sure that your middleware provides the necessary data in the expected format. Build your middleware, and then change the KVASIR_MIDDLEWARE_TEST_URI and you will test against whatever URI you provide.

None of these tests check that the React components are working properly. That is on the to-do list; however, the React components should behave as expected as long as the data they receive is in the right format. So having test cases that simply check the format of the data that Kvasir sends to the front end allows us to be reasonably confident that your middleware works in all cases with Kvasir.

"1964530060":{
                "username": "gbriggs2012+test08091601@gmail.com",
                "user_id": 118034129,
                "account_id": 1964530060,
                "creation_time": 1470758670,
                "account_info": {
                    "name": "My Fundraiser",
                    "firstname": "Giovanni",
                    "lastname": "Briggs",
                    "email": "gbriggs2012+test08091601@gmail.com",
                    "description": "Fundraising!"}
        }

"555763278": {
       "account_id": 1964530060,
       "payment_method": "credit_card",
       "creation_time": 1470759670,
       "checkout_id": 555763278,
       "payer_email": "gbriggs2012+payer@gmail.com",
       "data": {"refund": {"amount_refunded": 0, "refund_reason": null}, "payment_method": {"type": "credit_card", "credit_card": {"auto_capture": true, "data": {"emv_receipt": null, "signature_url": null}, "id": 3722644581}}, "currency": "USD", "create_time": 1470758296, "auto_release": true, "long_description": null, "account_id": 1964530060, "gross": 26.02, "fee": {"processing_fee": 1.02, "app_fee": 0, "fee_payer": "payer"}, "payment_error": null, "npo_information": null, "state": "authorized", "chargeback": {"dispute_uri": null, "amount_charged_back": 0}, "short_description": "Fundraising!", "type": "goods", "hosted_checkout": null, "delivery_type": null, "in_review": false, "checkout_id": 555763278, "reference_id": null, "soft_descriptor": "WPY*My Fundraiser", "payer": {"home_address": null, "email": "gbriggs2012+payer@gmail.com", "name": "John Shepard"}, "amount": 25, "callback_uri": null}, "payment_method_id": 3722644581
   }

"gbriggs2012+payer@gmail.com": {}