Test webhooks events

Open
#26 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
elixir, github
Domain
backend, testing

Research direction

Start by reading the referenced dwylbot test/controllers/event_controller_test.exs and tracing the webhook endpoints to their controllers in this repository. Investigate whether GitHub provides a sandbox or another source of real webhook data, and compare that with the current fixture-based approach. Done means an agreed, maintainable testing strategy that checks webhook controller logic against suitably current data.

Written by the indexing model from the issue text.

Description

help wanted technical

One way to test the logic of the app when a webhook request is received is to mock the request. The tests will send a "fake" payload on the endpoints of the app and from this can check that the logic of the controllers linked to the endpoint is correct. It is the way that we are currently using on dwylbot:

https://github.com/dwyl/dwylbot/blob/master/test/controllers/event_controller_test.exs

I'm wondering if we could find another way to test the application without using mock? I would prefer to use "real" data from Github and not based our test on fixtures which might not be updated for a long time (the Github API might change but not the fixtures)

see:

Dominant language
Elixir
Stars
33
Forks
3
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dwyl/github-backup

All issues in dwyl/github-backup

Similar issues

More Elixir issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.