Create tests for webhooks #3183

New Issue

adam · 2025-12-29T18:26:24+01:00

adam commented

2025-12-29 18:26:24 +01:00

Originally created by @jeremystretch on GitHub (Jan 17, 2020).

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

Create new unit tests for:

Create/updating/deleting webhooks
Placing webhook events in the queue
Transmitting webhooks

Justification

We have a huge gap in our test coverage around webhooks currently, leading to bugs such as #3951.

Originally created by @jeremystretch on GitHub (Jan 17, 2020). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes Create new unit tests for: 1. Create/updating/deleting webhooks 2. Placing webhook events in the queue 3. Transmitting webhooks ### Justification We have a huge gap in our test coverage around webhooks currently, leading to bugs such as #3951.

adam added the status: accepted type: housekeeping labels 2025-12-29 18:26:24 +01:00

adam closed this issue

2025-12-29 18:26:24 +01:00

adam commented

2025-12-29 18:26:25 +01:00

@jeremystretch commented on GitHub (Jan 17, 2020):

I've added tests for the enqueuing process in c6eb40daa8, but I'm not sure how to go about testing the RQ worker process. @lampwins any ideas?

@jeremystretch commented on GitHub (Jan 17, 2020): I've added tests for the enqueuing process in c6eb40daa8dbc3ed7c70c4835089e24ccb8301eb, but I'm not sure how to go about testing the RQ worker process. @lampwins any ideas?

adam commented

2025-12-29 18:26:25 +01:00

@hSaria commented on GitHub (Jan 17, 2020):

unittest.mock.patch the requests.send and checking it is called with the expected arguments is an option (I was testing with requests.post, but you get the idea).

>>> from unittest.mock import patch
>>> import requests
>>>
>>> def send():
...     requests.post('http://localhost')
... 
>>> @patch('requests.post')
... def test_send(mock_post):
...     send()
...     mock_post.assert_called_with('http://localhost')
... 
>>> test_send()
>>> 
>>> def send():
...     requests.post('http://not_localhost')
... 
>>> test_send()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/usr/local/Cellar/python/3.7.6_1/Frameworks/Python.framework/Versions/3.7/lib/python3.7/unittest/mock.py", line 1255, in patched
    return func(*args, **keywargs)
  File "<stdin>", line 4, in test_send
  File "/usr/local/Cellar/python/3.7.6_1/Frameworks/Python.framework/Versions/3.7/lib/python3.7/unittest/mock.py", line 873, in assert_called_with
    raise AssertionError(_error_message()) from cause
AssertionError: Expected call: post('http://localhost')
Actual call: post('http://not_localhost')
>>>

@hSaria commented on GitHub (Jan 17, 2020): `unittest.mock.patch` the `requests.send` and checking it is called with the expected arguments is an option (I was testing with `requests.post`, but you get the idea). ```python >>> from unittest.mock import patch >>> import requests >>> >>> def send(): ... requests.post('http://localhost') ... >>> @patch('requests.post') ... def test_send(mock_post): ... send() ... mock_post.assert_called_with('http://localhost') ... >>> test_send() >>> >>> def send(): ... requests.post('http://not_localhost') ... >>> test_send() Traceback (most recent call last): File "<stdin>", line 1, in <module> File "/usr/local/Cellar/python/3.7.6_1/Frameworks/Python.framework/Versions/3.7/lib/python3.7/unittest/mock.py", line 1255, in patched return func(*args, **keywargs) File "<stdin>", line 4, in test_send File "/usr/local/Cellar/python/3.7.6_1/Frameworks/Python.framework/Versions/3.7/lib/python3.7/unittest/mock.py", line 873, in assert_called_with raise AssertionError(_error_message()) from cause AssertionError: Expected call: post('http://localhost') Actual call: post('http://not_localhost') >>> ```

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#3183