Repository files navigation

👋 hi there! My name isKent C. Dodds! This is aworkshop repo to teach you how to test your Node.js Apps!

TestingJavaScript.com

• Have fundamental understanding and experience with automated testing andtools. (Additional learning material:But really, what is a JavaScript test?andBut really, what is a JavaScript mock?)
• Have experience with modern JavaScript APIs and features.

• git v2 or greater
• NodeJS v12 or greater
• yarn v1 or greater (ornpm v6 or greater)

All of these must be available in yourPATH. To verify things are set upproperly, you can run this:

git --versionnode --versionyarn --version# or npm --version

If you have trouble with any of these, learn more about the PATH environmentvariable and how to fix it here forwindows ormac/linux.

If you want to commit and push your work as you go, you'll want toforkfirst and then clone your fork rather than this repo directly.

After you've made sure to have the correct things (and versions) installed, youshould be able to just run a few commands to get set up:

git clone https://github.com/kentcdodds/testing-node-apps.gitcd testing-node-appsnode setup

This may take a few minutes.It will ask you for your email. This isoptional and just automatically adds your email to the links in the project tomake filling out some forms easier.

If you get any errors, please read through them and see if you can find out whatthe problem is. If you can't work it out on your own then pleasefile anissue and provideall the output from the commands you ran (even ifit's a lot).

If you can't get the setup script to work, then just make sure you have theright versions of the requirements listed above, and run the following commands:

npm installnpm run validate

It's recommended you run everything locally in the same environment you work inevery day, but if you're having issues getting things set up, you can also setthis up usingGitHub Codespaces(video demo) orCodesandbox.

This is the backend forBookshelf. I recommend you playaround with it a little bit to get an idea of the kind of data we're dealingwith here.

• User

  • id: string
  • username: string

• List Item

  • id: string
  • bookId: string
  • ownerId: string
  • rating: number (-1 is no rating, otherwise it's 1-5)
  • notes: string
  • startDate: number (Date.now())
  • finishDate: number (Date.now())

For convenience, our we return abook object on each list item which is thebook it's associated to. You're welcome frontend folks!

/me wishes we could use GraphQL

• Book

  • id: string
  • title: string
  • author: string
  • coverImageUrl: string
  • pageCount: number
  • publisher: string
  • synopsis: string

npmtest

This will startJest in watch mode. Read the output andplay around with it. You'll be working in the.exercise files.

• src/**/__tests__/[title].md: Background, Exercise Instructions, Extra Credit
• src/**/__tests__/[title].exercise.js: Exercise with Emoji helpers
• src/**/__tests__/[title].final.js: Final version
• src/**/__tests__/[title].final.extra-#.js: Final version of extra credit
• src/**/[title].js: The source file that you'll be testing

The purpose of the exercise isnot for you to work through all the material.It's intended to get your brain thinking about the right questions to ask me asI walk through the material.

Here's the order of exercises we'll be doing as well as where you can find themarkdown file associated with each.

1. 🏋 Testing Pure Functions:src/utils/__tests__/auth.md
2. 🏋 Testing Middleware:src/utils/__tests__/error-middleware.md
3. 🏋 Testing Controllers:src/routes/__tests__/list-items-controller.md
4. 🏋 Testing Authentication API Routes:src/__tests__/auth.md
5. 🏋 Testing CRUD API Routes:src/__tests__/list-items.md

Each exercise has comments in it to help you get through the exercise. These funemoji characters are here to help you.

• Kody the Koala 🐨 will tell you when there's something specific you shoulddo
• Matthew the Muscle 💪 will indicate what you're working with an exercise
• Chuck the Checkered Flag 🏁 will indicate that you're working with a finalversion
• Marty the Money Bag 💰 will give you specific tips (and sometimes code)along the way
• Hannah the Hundred 💯 will give you extra challenges you can do if youfinish the exercises early.
• Olivia the Owl 🦉 will give you useful tidbits/best practice notes and alink for elaboration and feedback.
• Dominic the Document 📜 will give you links to useful documentation
• Berry the Bomb 💣 will be hanging around anywhere you need to blow stuffup (delete code)
• Peter the Product Manager 👨‍💼 helps us know what our users want
• Alfred the Alert 🚨 will occasionally show up in the test failures withpotential explanations for why the tests are failing.

npm installnpm run validate

Thanks goes to these wonderful people(emoji key):

Kent C. Dodds 💻📖🚇⚠️

Justin Dorfman 🔍

Andrew Mason 📖

This project follows theall-contributorsspecification. Contributions of any kind welcome!

This material is available for private, non-commercial use under theGPL version 3. If youwould like to use this material to conduct your own workshop, please contact meatme@kentcdodds.com

Each exercise has an Elaboration and Feedback link. Please fill that out afterthe exercise and instruction.

At the end of the workshop, please go to this URL to give overall feedback.Thank you!https://kcd.im/tna-ws-feedback