Api test setup #106

rainrivas · 2018-01-29T05:55:31Z

EDIT Adding much needed details

New Dependencies

jest -- Our test controller. I think we are using this via some react package but since we're testing with it I'm including it directly. Full docs are here. Until we implement mocks, the most useful(read: 'relevant') part of jest docs is probably the expect api
superagent -- Low-level api that let's you get down and dirty with the http requests. Full docs here
supertest -- Makes using superagent easy. For simple things like .get('/') or expect(200) we can use this. For more complicated stuff, read the superagents docs

EDIT 2 No More Known Issues

Running Tests

Test can be run as part of the built in test command we've had, npm test, or you can specifically use jest to run the api tests:
$(npm bin)/jest api
If you want to set your tests up to watch use $(npm bin)/jest api --watch

~~## Known Issues~~
* Cannot run more than 1 test file at a time because of how we are exporting the connection, module.exports = app.listen...
* There has to be a better way to handle this; maybe not exporting the connection string and just starting the server? Can a test use a connection similar to how the routes do?

…orrectly. Setting up a single happy path test for /api

…tests more relevant to pairing route.

…riate number of donors are returned

…dding some basic wishlist test templates for the wishlist routes.

jwu910 · 2018-01-29T05:57:55Z

server/app.js

+// I don't like setting this to module exports just to make the tests work.. possible work around anyone?
+module.exports = app.listen(port, () =>
+  console.log(`Listening on port ${port}!`)
+);


So app.listen() doesn't work here?

if i don't export app.listen then I can't initiate the app (server) from the test files where I require it.
i.e. const app = require('../../../server/app');

jwu910 · 2018-01-29T05:59:00Z

server/routes/api.js

@@ -10,8 +10,6 @@ const Family = require('../models/family');
 // Wishlist = Family.readWishlist();
 mongoose.connect('mongodb://localhost/aaf');

-app.use(bodyParser.json());


jwu910

Lgtm. First iteration. will have plenty more integration with the family Ids later. :D

phuchle · 2018-01-29T14:26:10Z

Will take a look at this tonight when I get home.

AlChiu · 2018-01-29T19:53:48Z

server/routes/__tests__/PairingApi.test.js

    return request(app)
-      .get('/api/')
+      .get('/api/pairing')


Since you already created the constant PAIRING_ENDPOINT, shouldn't you change this line to use it to keep it consistent?

@AlChiu yep, I fixed it when i restructured the order of the file

…ually used in testing.

…tests can no run you can watch the api tests using $(npm bin)/jest api --watch This assumes you're naming api tests as <ROUTE>Api.test.js

phuchle · 2018-02-05T17:46:09Z

Are we able to run npm test or any variation and it passes?

jwu910 · 2018-02-05T18:01:33Z

npm test script's currently convoluted with linters.

If i recall, efrain said we can $(npm bin)/jest api to call the api tests

Edit: He mentions it in intial comment, ~~but npm test will not test with jest.~~ I am wrong

rainrivas · 2018-02-05T18:25:19Z

@jwu910 @phuchle npm test will run the api test, it runs all tests. currently the tests will not pass because of various reasons

npm test fails due to linters and snapshots
$(npm bin)/jest api fails due to the wishlist tests failing
$(npm bin)/jest Pairing fails due to the Pairing snapshot (which I forgot we had)
$(npm bin)/jest PairingApi PASSES since this only tests the /api/pairing route that I wrote. (and I skipped incomplete/WIP/open-ended tests

phuchle · 2018-02-05T18:34:15Z

For some reason, I can't get npm bin/jest PairingApi to run. I get

Usage: npm <command>

where <command> is one of:
...etc

Am I supposed to run it from a particular directory?

jwu910 · 2018-02-05T18:35:04Z

@phuchle $(npm bin)/jest include the bling and parens

rainrivas · 2018-02-05T18:38:31Z

@phuchle

$ echo $(npm bin)/jest
$ adopt-a-family/node_modules/.bin/jest

phuchle · 2018-02-05T18:46:50Z

Thanks. Got it running now.

phuchle · 2018-02-05T20:14:12Z

package.json

    "node-sass-chokidar": "0.0.3",
    "nodemon": "^1.12.1",
    "react-scripts": "^1.0.13",
    "react-test-renderer": "^16.0.0",
-    "sass-lint": "^1.12.1"
+    "sass-lint": "^1.12.1",
+    "superagent": "^3.8.2",


Do we need to explicitly require superagent in the package.json? I'm thinking that since supertest depends on superagent, supertest might install it as a dependency automatically.

It would, but I thought it was best practice to include exactly what you need and use as best practice. Also, I have first hand experience with NPM pruning things that you don't explicitly require (which is ridiculous) -- one of the many examples: npm/npm#17929

* Closing #30 by connecting to Heroku (#53) * Uncommenting logic to use build folder. Also using double quotes to check travis behavior * Adding `build` to source control * Adding Procfile to have heroku run a specific server command * Mofidying the path for express public folder * Modyfing homepage field on package.json and pushing up new build that use the homepage url * Adding build folder to eslint ignore file so we do not fail CI. Also removing our build folder from .gitignore so we can easily push up the build. * Install mongoose and bcrypt for writing models. * Add base user model and placeholder files for donor, family, and organizer models. * Add more fields and refine methods on userSchema. * Run user.js through prettier. * Add wishlist schema. * Refine existing models for consistency and clarity. Add initial version of other base models. * Add a few more methods before realizing I have no idea what I'm doing. * Update models. Add donor and family controllers. Add body-parser package for dealing with form data. * Setting up a very basic set of api routes * Adding basic logic for /pairing route. Modifying Donor and Family schema to make references to each otehr for matching and adding default values to it. /pairing should find all donors and filter them based on budget then sort budgets in descending order. * Adding organizer to the donor and family models * Adding pseudo logic for /paring/balance route * Adding notes to /pairing/balance to remind us to use the readWishlist() method * Correcting issues with api.js Switching the min/max budgets in the LTE/GTE query and removing the p from "res" * SeedDB script is working now (#93) * Fix capitalization error in server/models. * Update ecmaVersion to latest in order to use async/await. * Implement working seedDB script by making liberal use of async/await. * Add consistent error/sucess output on saving each model. * Aaf 97 budget pairing (#101) * Fixing #100 - Removing extra key, field, from Donor.sort * Pulling the data from the request correctly so we can find budgets accordingly * Fixing #97. The max budget cap is not implemented so we sort at a +/- 10% in ascending order for now. Also did some work for setting the database route to 'aaf' in our api file. Also setting matchedFamily to null in our models and correcting the name mapping in the db seed file. * Correcting the sort order to be as #97 is asking. * Add wishlist seeding to seedDB script (#102) Add wishlist seeding to seed DB and refine error handling for wishlists and families. * AAF-104 Change body parser declaration from app to routes * Api test setup (#106) * WIP :: Setting up API tests with base skeleton * Modifying app.js to export the app.listen so that the tests can run correctly. Setting up a single happy path test for /api * Enhancing api tests to make proper assertions. * Adding logic to /api/pairing to handle missing budget params. Making tests more relevant to pairing route. * Adding tests for making sure messages are only should when the appropriate number of donors are returned * Removing duplicated bodyparser line in api.js * Cleaning up the Pairing test to split the tests into sub-sets. Also adding some basic wishlist test templates for the wishlist routes. * Removing the babel dependencies that were added since they aren't actually used in testing. * Fixing the issue where only one test would run. Also, since multiple tests can no run you can watch the api tests using $(npm bin)/jest api --watch This assumes you're naming api tests as <ROUTE>Api.test.js * Removing useless comment on app.js * Fixing the linter issue for wishlist route so npm test will execute * Fixing the unused imports issue * AAF-111 Add usePushEach as deprecation workaround for mongo that affects array push methods (#112) * AAF-111 Add usePushEach as deprecation workaround for mongo that affects array push methods * AAF-111 Npm update and package lock * AAF-111 Add jest-cli as dev dependency * AAF-94 wishlist api read (#108) * add first route for families to read their wishlist * Add more error handling. Add a family with an empty wishlist. * AAF94 Add a description for the regex Fix the logic for the if statement Change the response status to 400 and made the output messages more discriptive * AAF 94 Change the HTTP code for no family found to 404. * AAF-94 Fix uppercase for const variable * AAF-94 Revert the change to the familyId variable and fix the route * AAF-94 Remove the delete route * AAF-113 npm test api -- Fix #113 (#114) * Trying to fix #113 by using concurrently to run all the tests but I doubt that this will work correctly. I might have to make the changes at the travis.yml file * (#113)Telling travis to cache node_modules so that it doesn't have to constantly install if things don't change * 113 - Skipping the wishlist tests since they aren't actually written. However, when travis runs concurrently, it might be failing to make a second connection to mongo.. will need to test this * AAF#113 - Adding mongodb service and seed script to travis.yml to solve the issue with scripts not running. * AAF-#113 - Skipping the POST routes tests in the wishlist API * Removing node 4 and 6 from Travis since we won't be supporting that in prod. Also modifying our README to show system requirements that are recommending a minium node version of 7 and a mongodb version of 3.6 (#113) * Modifying the test:api command to now run on a node nevironment since we're testing API (node services) and not some dom elements. Also setting API test to trigger OS Notification and to force quit once the execution is done ( no watch mode ) (#113) * moved the totalListCost outside of the list array (#117) * Aaf 109 families filter (#122) AAF-109 Add families filter route. This route is expected to be used like so: - GET /api/families with no queries returns list of all families - GET /api/families?filter=_id&value=123 Passing filter and value will look up families with the provided filter and value and return an object with a property families, an array of the families. If you pass less than 2 or more than 2 query fields, the route throws 400. If you pass exactly 2 query fields but they are not filter or value, it will throw 400. eg: filter: foo and valu: bar or foo: bar and bar: foo * Aaf 110 donors filter (#126) * AAF-109 Write show and filter route for donor. Experimenting with controller abstraction. * AAF-110 Rebuild bcrypt and node-sass due to errors that caused npm start to break. * Removing bcrypt from our package.json since we do not need this package... i dont think * readding bcrypt as version 2.0.1 since we are using it in seed file. * Setting up Bcrypt v3.0 * AAF-63 Update node-sass-chokidar. 1.3.0 released. node-sass dependencies should build with node-gyp * AAF-63 Autogenerate packagelock

rainrivas added 7 commits January 24, 2018 23:31

WIP :: Setting up tests with base skeleton

70f39fb

Modifying app.js to export the app.listen so that the tests can run c…

bc2f077

…orrectly. Setting up a single happy path test for /api

Enhancing api tests to make proper assertions.

f76056c

Adding logic to /api/pairing to handle missing budget params. Making …

ae95fa1

…tests more relevant to pairing route.

Adding tests for making sure messages are only should when the approp…

278bf1f

…riate number of donors are returned

Removing duplicated bodyparser line in api.js

020ed1a

Cleaning up the Pairing test to split the tests into sub-sets. Also a…

64fcf67

…dding some basic wishlist test templates for the wishlist routes.

rainrivas added the enhancement label Jan 29, 2018

rainrivas added this to the Sprint 1 milestone Jan 29, 2018

rainrivas requested review from phuchle, psyduc, jwu910 and AlChiu January 29, 2018 05:55

jwu910 reviewed Jan 29, 2018

View reviewed changes

jwu910 approved these changes Jan 29, 2018

View reviewed changes

AlChiu reviewed Jan 29, 2018

View reviewed changes

rainrivas added 3 commits January 29, 2018 12:13

Removing the babel dependencies that were added since they aren't act…

2709dc6

…ually used in testing.

Fixing the issue where only one test would run. Also, since multiple …

1b480ac

…tests can no run you can watch the api tests using $(npm bin)/jest api --watch This assumes you're naming api tests as <ROUTE>Api.test.js

Removing useless comment on app.js

db83828

AlChiu approved these changes Jan 29, 2018

View reviewed changes

jwu910 approved these changes Jan 30, 2018

View reviewed changes

rainrivas modified the milestones: Sprint 1, Sprint 2 Jan 31, 2018

Fixing the linter issue for wishlist route so npm test will execute

5f085b2

phuchle reviewed Feb 5, 2018

View reviewed changes

phuchle approved these changes Feb 6, 2018

View reviewed changes

phuchle merged commit f7261d7 into AAF-63-models Feb 6, 2018

phuchle deleted the api-test-setup branch February 6, 2018 17:56

rainrivas mentioned this pull request Feb 7, 2019

Add codeowners file for automatic reviews and clean up some configs #139

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Api test setup #106

Api test setup #106

rainrivas commented Jan 29, 2018 •

edited

Loading

jwu910 Jan 29, 2018

rainrivas Jan 29, 2018

jwu910 Jan 29, 2018

jwu910 left a comment

phuchle commented Jan 29, 2018

AlChiu Jan 29, 2018

rainrivas Jan 29, 2018

phuchle commented Feb 5, 2018

jwu910 commented Feb 5, 2018 •

edited

Loading

rainrivas commented Feb 5, 2018

phuchle commented Feb 5, 2018

jwu910 commented Feb 5, 2018

rainrivas commented Feb 5, 2018 •

edited

Loading

phuchle commented Feb 5, 2018

phuchle Feb 5, 2018

rainrivas Feb 5, 2018

Api test setup #106

Api test setup #106

Conversation

rainrivas commented Jan 29, 2018 • edited Loading

New Dependencies

Running Tests

jwu910 Jan 29, 2018

Choose a reason for hiding this comment

rainrivas Jan 29, 2018

Choose a reason for hiding this comment

jwu910 Jan 29, 2018

Choose a reason for hiding this comment

jwu910 left a comment

Choose a reason for hiding this comment

phuchle commented Jan 29, 2018

AlChiu Jan 29, 2018

Choose a reason for hiding this comment

rainrivas Jan 29, 2018

Choose a reason for hiding this comment

phuchle commented Feb 5, 2018

jwu910 commented Feb 5, 2018 • edited Loading

rainrivas commented Feb 5, 2018

phuchle commented Feb 5, 2018

jwu910 commented Feb 5, 2018

rainrivas commented Feb 5, 2018 • edited Loading

phuchle commented Feb 5, 2018

phuchle Feb 5, 2018

Choose a reason for hiding this comment

rainrivas Feb 5, 2018

Choose a reason for hiding this comment

rainrivas commented Jan 29, 2018 •

edited

Loading

jwu910 commented Feb 5, 2018 •

edited

Loading

rainrivas commented Feb 5, 2018 •

edited

Loading