test_event_rules.py 89 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048
  1. import json
  2. import logging
  3. import uuid
  4. from io import BytesIO
  5. from unittest import skipIf
  6. from unittest.mock import Mock, PropertyMock, patch
  7. import django_rq
  8. import requests
  9. from django.conf import settings
  10. from django.contrib.contenttypes.models import ContentType
  11. from django.core.exceptions import ImproperlyConfigured, ValidationError
  12. from django.http import HttpResponse
  13. from django.test import RequestFactory, TestCase, override_settings, tag
  14. from django.urls import reverse
  15. from PIL import Image
  16. from requests import Session
  17. from rest_framework import status
  18. from core.choices import JobNotificationChoices, ManagedFileRootPathChoices
  19. from core.events import *
  20. from core.models import Job, ObjectChange, ObjectType
  21. from dcim.choices import DeviceStatusChoices, InterfaceTypeChoices, SiteStatusChoices
  22. from dcim.models import Device, DeviceRole, DeviceType, Interface, Manufacturer, Site
  23. from extras.choices import EventRuleActionChoices
  24. from extras.events import enqueue_event, flush_events, process_event_rules, serialize_for_event
  25. from extras.models import EventRule, Notification, Script, ScriptModule, Tag, Webhook
  26. from extras.scripts import Script as ScriptBase
  27. from extras.signals import process_job_end_event_rules
  28. from extras.webhooks import generate_signature, send_webhook
  29. from ipam.choices import IPAddressStatusChoices
  30. from ipam.models import IPAddress, Prefix
  31. from netbox.context_managers import event_tracking
  32. from netbox.event_rules import (
  33. EventRuleAction,
  34. get_event_rule_action,
  35. get_event_rule_action_choices,
  36. register_event_rule_action,
  37. )
  38. from netbox.registry import registry
  39. from netbox.tests.dummy_plugin.event_rules import DummyRaisingAction
  40. from users.models import ObjectPermission
  41. from utilities.testing import APITestCase, create_test_device, disable_warnings
  42. from utilities.testing.mixins import RQQueueTestMixin
  43. class EventRuleTestCase(RQQueueTestMixin, APITestCase):
  44. def setUp(self):
  45. super().setUp()
  46. # Ensure the queue has been cleared for each test
  47. self.queue = django_rq.get_queue('default')
  48. self.queue.empty()
  49. def tearDown(self):
  50. super().tearDown()
  51. # Clear the queue so leftover jobs do not leak to the next test suite
  52. self.queue.empty()
  53. def test_enqueue_event_requires_saved_instance(self):
  54. """enqueue_event raises ValueError for an unsaved instance."""
  55. request = RequestFactory().get('/')
  56. request.id = uuid.uuid4()
  57. request.user = self.user
  58. site = Site(name='Site 1', slug='site-1')
  59. with patch('extras.events.has_feature', return_value=True):
  60. with self.assertRaises(ValueError):
  61. enqueue_event({}, site, request, OBJECT_CREATED)
  62. @classmethod
  63. def setUpTestData(cls):
  64. site_type = ObjectType.objects.get_for_model(Site)
  65. DUMMY_URL = 'http://localhost:9000/'
  66. DUMMY_SECRET = 'LOOKATMEIMASECRETSTRING'
  67. webhooks = Webhook.objects.bulk_create((
  68. Webhook(name='Webhook 1', payload_url=DUMMY_URL, secret=DUMMY_SECRET, additional_headers='X-Foo: Bar'),
  69. Webhook(name='Webhook 2', payload_url=DUMMY_URL, secret=DUMMY_SECRET),
  70. Webhook(name='Webhook 3', payload_url=DUMMY_URL, secret=DUMMY_SECRET),
  71. ))
  72. webhook_type = ObjectType.objects.get(app_label='extras', model='webhook')
  73. event_rules = EventRule.objects.bulk_create((
  74. EventRule(
  75. name='Event Rule 1',
  76. event_types=[OBJECT_CREATED],
  77. action_type=EventRuleActionChoices.WEBHOOK,
  78. action_object_type=webhook_type,
  79. action_object_id=webhooks[0].id,
  80. action_data={"foo": 1},
  81. ),
  82. EventRule(
  83. name='Event Rule 2',
  84. event_types=[OBJECT_UPDATED],
  85. action_type=EventRuleActionChoices.WEBHOOK,
  86. action_object_type=webhook_type,
  87. action_object_id=webhooks[0].id,
  88. action_data={"foo": 2},
  89. ),
  90. EventRule(
  91. name='Event Rule 3',
  92. event_types=[OBJECT_DELETED],
  93. action_type=EventRuleActionChoices.WEBHOOK,
  94. action_object_type=webhook_type,
  95. action_object_id=webhooks[0].id,
  96. action_data={"foo": 3},
  97. ),
  98. ))
  99. for event_rule in event_rules:
  100. event_rule.object_types.set([site_type])
  101. Tag.objects.bulk_create((
  102. Tag(name='Foo', slug='foo'),
  103. Tag(name='Bar', slug='bar'),
  104. Tag(name='Baz', slug='baz'),
  105. ))
  106. def test_eventrule_snapshot_changed_condition(self):
  107. """
  108. An event rule using the 'changed' operator fires only when the attribute
  109. transitions to the target value, not on subsequent updates that leave it
  110. unchanged. Exercises the full process_event_rules() path.
  111. """
  112. webhook = Webhook.objects.get(name='Webhook 1')
  113. webhook_type = ObjectType.objects.get_for_model(Webhook)
  114. site_type = ObjectType.objects.get_for_model(Site)
  115. event_rule = EventRule.objects.create(
  116. name='Status Change Rule',
  117. event_types=[OBJECT_UPDATED],
  118. action_type=EventRuleActionChoices.WEBHOOK,
  119. action_object_type=webhook_type,
  120. action_object_id=webhook.pk,
  121. conditions={
  122. 'and': [
  123. {'attr': 'status.value', 'value': SiteStatusChoices.STATUS_ACTIVE},
  124. {'attr': 'status', 'op': 'changed'},
  125. ]
  126. }
  127. )
  128. event_rule.object_types.set([site_type])
  129. site = Site.objects.create(name='Site Snapshot', slug='site-snapshot', status=SiteStatusChoices.STATUS_PLANNED)
  130. url = reverse('dcim-api:site-detail', kwargs={'pk': site.pk})
  131. self.add_permissions('dcim.change_site')
  132. # planned → active: the 'changed' condition is satisfied; rule must fire
  133. response = self.client.patch(url, {'status': SiteStatusChoices.STATUS_ACTIVE}, format='json', **self.header)
  134. self.assertHttpStatus(response, status.HTTP_200_OK)
  135. rule_jobs = [j for j in self.queue.jobs if j.kwargs['event_rule'] == event_rule]
  136. self.assertEqual(len(rule_jobs), 1, 'Expected rule to fire on status transition to active')
  137. self.queue.empty()
  138. # description update while status stays active: 'changed' condition fails; rule must not fire
  139. response = self.client.patch(url, {'description': 'Updated'}, format='json', **self.header)
  140. self.assertHttpStatus(response, status.HTTP_200_OK)
  141. rule_jobs = [j for j in self.queue.jobs if j.kwargs['event_rule'] == event_rule]
  142. self.assertEqual(len(rule_jobs), 0, 'Expected rule not to fire when status is unchanged')
  143. def test_eventrule_conditions(self):
  144. """
  145. Test evaluation of EventRule conditions.
  146. """
  147. event_rule = EventRule(
  148. name='Event Rule 1',
  149. event_types=[OBJECT_CREATED, OBJECT_UPDATED],
  150. conditions={
  151. 'and': [
  152. {
  153. 'attr': 'status.value',
  154. 'value': 'active',
  155. }
  156. ]
  157. }
  158. )
  159. # Create a Site to evaluate
  160. site = Site.objects.create(name='Site 1', slug='site-1', status=SiteStatusChoices.STATUS_STAGING)
  161. data = serialize_for_event(site)
  162. # Evaluate the conditions (status='staging')
  163. self.assertFalse(event_rule.eval_conditions(data))
  164. # Change the site's status
  165. site.status = SiteStatusChoices.STATUS_ACTIVE
  166. data = serialize_for_event(site)
  167. # Evaluate the conditions (status='active')
  168. self.assertTrue(event_rule.eval_conditions(data))
  169. def test_single_create_process_eventrule(self):
  170. """
  171. Check that creating an object with an applicable EventRule queues a background task for the rule's action.
  172. """
  173. # Create an object via the REST API
  174. data = {
  175. 'name': 'Site 1',
  176. 'slug': 'site-1',
  177. 'tags': [
  178. {'name': 'Foo'},
  179. {'name': 'Bar'},
  180. ]
  181. }
  182. url = reverse('dcim-api:site-list')
  183. self.add_permissions('dcim.add_site', 'extras.view_tag')
  184. response = self.client.post(url, data, format='json', **self.header)
  185. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  186. self.assertEqual(Site.objects.count(), 1)
  187. self.assertEqual(Site.objects.first().tags.count(), 2)
  188. # Verify that a background task was queued for the new object
  189. self.assertEqual(self.queue.count, 1)
  190. job = self.queue.jobs[0]
  191. self.assertEqual(job.kwargs['event_rule'], EventRule.objects.get(name='Event Rule 1'))
  192. self.assertEqual(job.kwargs['event_type'], OBJECT_CREATED)
  193. self.assertEqual(job.kwargs['object_type'], ObjectType.objects.get_for_model(Site))
  194. self.assertEqual(job.kwargs['data']['id'], response.data['id'])
  195. self.assertEqual(job.kwargs['data']['foo'], 1)
  196. self.assertEqual(len(job.kwargs['data']['tags']), len(response.data['tags']))
  197. self.assertEqual(job.kwargs['snapshots']['postchange']['name'], 'Site 1')
  198. self.assertEqual(job.kwargs['snapshots']['postchange']['tags'], ['Bar', 'Foo'])
  199. objectchange = ObjectChange.objects.get(
  200. changed_object_type=ContentType.objects.get_for_model(Site), changed_object_id=response.data['id']
  201. )
  202. self.assertEqual(job.kwargs['object_change_ids'], [objectchange.pk])
  203. def test_single_create_rollback_discards_events(self):
  204. """
  205. Check that creating an object which is then rolled back by the object-level permission check
  206. in perform_create() queues no background task.
  207. """
  208. # Permit the creation of active sites only. The new object is saved (queueing its event)
  209. # before _validate_objects() rejects it and the transaction is rolled back.
  210. obj_perm = ObjectPermission(
  211. name='Test permission',
  212. actions=['add'],
  213. constraints={'status': SiteStatusChoices.STATUS_ACTIVE},
  214. )
  215. obj_perm.save()
  216. obj_perm.users.add(self.user)
  217. obj_perm.object_types.add(ObjectType.objects.get_for_model(Site))
  218. data = {'name': 'Site 1', 'slug': 'site-1', 'status': SiteStatusChoices.STATUS_PLANNED}
  219. url = reverse('dcim-api:site-list')
  220. with disable_warnings('django.request'):
  221. response = self.client.post(url, data, format='json', **self.header)
  222. self.assertHttpStatus(response, status.HTTP_403_FORBIDDEN)
  223. self.assertEqual(Site.objects.count(), 0)
  224. # No task may be queued for a creation that was rolled back
  225. self.assertEqual(self.queue.count, 0)
  226. def test_bulk_create_process_eventrule(self):
  227. """
  228. Check that bulk creating multiple objects with an applicable EventRule queues a background task for each
  229. new object.
  230. """
  231. # Create multiple objects via the REST API
  232. data = [
  233. {
  234. 'name': 'Site 1',
  235. 'slug': 'site-1',
  236. 'tags': [
  237. {'name': 'Foo'},
  238. {'name': 'Bar'},
  239. ]
  240. },
  241. {
  242. 'name': 'Site 2',
  243. 'slug': 'site-2',
  244. 'tags': [
  245. {'name': 'Foo'},
  246. {'name': 'Bar'},
  247. ]
  248. },
  249. {
  250. 'name': 'Site 3',
  251. 'slug': 'site-3',
  252. 'tags': [
  253. {'name': 'Foo'},
  254. {'name': 'Bar'},
  255. ]
  256. },
  257. ]
  258. url = reverse('dcim-api:site-list')
  259. self.add_permissions('dcim.add_site', 'extras.view_tag')
  260. response = self.client.post(url, data, format='json', **self.header)
  261. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  262. self.assertEqual(Site.objects.count(), 3)
  263. self.assertEqual(Site.objects.first().tags.count(), 2)
  264. # Verify that a background task was queued for each new object
  265. self.assertEqual(self.queue.count, 3)
  266. for i, job in enumerate(self.queue.jobs):
  267. self.assertEqual(job.kwargs['event_rule'], EventRule.objects.get(name='Event Rule 1'))
  268. self.assertEqual(job.kwargs['event_type'], OBJECT_CREATED)
  269. self.assertEqual(job.kwargs['object_type'], ObjectType.objects.get_for_model(Site))
  270. self.assertEqual(job.kwargs['data']['id'], response.data[i]['id'])
  271. self.assertEqual(job.kwargs['data']['foo'], 1)
  272. self.assertEqual(len(job.kwargs['data']['tags']), len(response.data[i]['tags']))
  273. self.assertEqual(job.kwargs['snapshots']['postchange']['name'], response.data[i]['name'])
  274. self.assertEqual(job.kwargs['snapshots']['postchange']['tags'], ['Bar', 'Foo'])
  275. def test_bulk_create_rollback_discards_events(self):
  276. """
  277. Check that a sequential bulk create which is rolled back queues no background tasks for the
  278. objects that were provisionally created before the failure.
  279. """
  280. manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1')
  281. device_type = DeviceType.objects.create(manufacturer=manufacturer, model='Device Type 1', slug='device-type-1')
  282. role = DeviceRole.objects.create(name='Device Role 1', slug='device-role-1')
  283. site = Site.objects.create(name='Site 1', slug='site-1')
  284. # Bulk creates are performed one object at a time, so each valid object is provisionally
  285. # created (and its event queued) before a later object fails validation.
  286. event_rule = EventRule.objects.get(name='Event Rule 1')
  287. event_rule.object_types.set([ObjectType.objects.get_for_model(Device)])
  288. data = [
  289. {
  290. 'name': 'Device 1',
  291. 'device_type': device_type.pk,
  292. 'role': role.pk,
  293. 'site': site.pk,
  294. 'status': DeviceStatusChoices.STATUS_ACTIVE,
  295. },
  296. {}, # Missing all required fields
  297. ]
  298. url = reverse('dcim-api:device-list')
  299. self.add_permissions('dcim.add_device', 'dcim.view_site', 'dcim.view_devicetype', 'dcim.view_devicerole')
  300. response = self.client.post(url, data, format='json', **self.header)
  301. self.assertHttpStatus(response, status.HTTP_400_BAD_REQUEST)
  302. self.assertEqual(Device.objects.count(), 0)
  303. # No task may be queued for a creation that was rolled back
  304. self.assertEqual(self.queue.count, 0)
  305. def test_available_objects_create_rollback_discards_events(self):
  306. """
  307. Check that creating an object via an available-objects endpoint (e.g. available-ips) queues
  308. no background task when the object-level permission check rolls the transaction back.
  309. """
  310. prefix = Prefix.objects.create(prefix='192.0.2.0/24')
  311. event_rule = EventRule.objects.get(name='Event Rule 1')
  312. event_rule.object_types.set([ObjectType.objects.get_for_model(IPAddress)])
  313. # Permit the creation of active IP addresses only. The new object is saved (queueing its
  314. # event) before _validate_objects() rejects it and the transaction is rolled back.
  315. obj_perm = ObjectPermission(
  316. name='Test permission',
  317. actions=['add'],
  318. constraints={'status': IPAddressStatusChoices.STATUS_ACTIVE},
  319. )
  320. obj_perm.save()
  321. obj_perm.users.add(self.user)
  322. obj_perm.object_types.add(ObjectType.objects.get_for_model(IPAddress))
  323. self.add_permissions('ipam.view_prefix')
  324. url = reverse('ipam-api:prefix-available-ips', kwargs={'pk': prefix.pk})
  325. data = {'status': IPAddressStatusChoices.STATUS_RESERVED}
  326. with disable_warnings('django.request'):
  327. response = self.client.post(url, data, format='json', **self.header)
  328. self.assertHttpStatus(response, status.HTTP_403_FORBIDDEN)
  329. self.assertEqual(IPAddress.objects.count(), 0)
  330. # No task may be queued for a creation that was rolled back
  331. self.assertEqual(self.queue.count, 0)
  332. def test_single_update_process_eventrule(self):
  333. """
  334. Check that updating an object with an applicable EventRule queues a background task for the rule's action.
  335. """
  336. site = Site.objects.create(name='Site 1', slug='site-1')
  337. site.tags.set(Tag.objects.filter(name__in=['Foo', 'Bar']))
  338. # Update an object via the REST API
  339. data = {
  340. 'name': 'Site X',
  341. 'comments': 'Updated the site',
  342. 'tags': [
  343. {'name': 'Baz'}
  344. ]
  345. }
  346. url = reverse('dcim-api:site-detail', kwargs={'pk': site.pk})
  347. self.add_permissions('dcim.change_site', 'extras.view_tag')
  348. response = self.client.patch(url, data, format='json', **self.header)
  349. self.assertHttpStatus(response, status.HTTP_200_OK)
  350. # Verify that a background task was queued for the updated object
  351. self.assertEqual(self.queue.count, 1)
  352. job = self.queue.jobs[0]
  353. self.assertEqual(job.kwargs['event_rule'], EventRule.objects.get(name='Event Rule 2'))
  354. self.assertEqual(job.kwargs['event_type'], OBJECT_UPDATED)
  355. self.assertEqual(job.kwargs['object_type'], ObjectType.objects.get_for_model(Site))
  356. self.assertEqual(job.kwargs['data']['id'], site.pk)
  357. self.assertEqual(job.kwargs['data']['foo'], 2)
  358. self.assertEqual(len(job.kwargs['data']['tags']), len(response.data['tags']))
  359. self.assertEqual(job.kwargs['snapshots']['prechange']['name'], 'Site 1')
  360. self.assertEqual(job.kwargs['snapshots']['prechange']['tags'], ['Bar', 'Foo'])
  361. self.assertEqual(job.kwargs['snapshots']['postchange']['name'], 'Site X')
  362. self.assertEqual(job.kwargs['snapshots']['postchange']['tags'], ['Baz'])
  363. objectchange = ObjectChange.objects.get(
  364. changed_object_type=ContentType.objects.get_for_model(Site), changed_object_id=site.pk
  365. )
  366. self.assertEqual(job.kwargs['object_change_ids'], [objectchange.pk])
  367. def test_single_update_rollback_discards_events(self):
  368. """
  369. Check that updating an object which is then rolled back by the object-level permission check
  370. in perform_update() queues no background task.
  371. """
  372. site = Site.objects.create(name='Site 1', slug='site-1', status=SiteStatusChoices.STATUS_ACTIVE)
  373. # Permit the modification of active sites only. Setting the status to "planned" takes the
  374. # object outside the permission's scope, so it is saved (queueing its event) and then
  375. # rejected by _validate_objects(), rolling the transaction back.
  376. obj_perm = ObjectPermission(
  377. name='Test permission',
  378. actions=['change'],
  379. constraints={'status': SiteStatusChoices.STATUS_ACTIVE},
  380. )
  381. obj_perm.save()
  382. obj_perm.users.add(self.user)
  383. obj_perm.object_types.add(ObjectType.objects.get_for_model(Site))
  384. url = reverse('dcim-api:site-detail', kwargs={'pk': site.pk})
  385. with disable_warnings('django.request'):
  386. response = self.client.patch(
  387. url, {'status': SiteStatusChoices.STATUS_PLANNED}, format='json', **self.header
  388. )
  389. self.assertHttpStatus(response, status.HTTP_403_FORBIDDEN)
  390. site.refresh_from_db()
  391. self.assertEqual(site.status, SiteStatusChoices.STATUS_ACTIVE)
  392. # No task may be queued for an update that was rolled back
  393. self.assertEqual(self.queue.count, 0)
  394. def test_bulk_update_process_eventrule(self):
  395. """
  396. Check that bulk updating multiple objects with an applicable EventRule queues a background task for each
  397. updated object.
  398. """
  399. sites = (
  400. Site(name='Site 1', slug='site-1'),
  401. Site(name='Site 2', slug='site-2'),
  402. Site(name='Site 3', slug='site-3'),
  403. )
  404. Site.objects.bulk_create(sites)
  405. for site in sites:
  406. site.tags.set(Tag.objects.filter(name__in=['Foo', 'Bar']))
  407. # Update three objects via the REST API
  408. data = [
  409. {
  410. 'id': sites[0].pk,
  411. 'name': 'Site X',
  412. 'tags': [
  413. {'name': 'Baz'}
  414. ]
  415. },
  416. {
  417. 'id': sites[1].pk,
  418. 'name': 'Site Y',
  419. 'tags': [
  420. {'name': 'Baz'}
  421. ]
  422. },
  423. {
  424. 'id': sites[2].pk,
  425. 'name': 'Site Z',
  426. 'tags': [
  427. {'name': 'Baz'}
  428. ]
  429. },
  430. ]
  431. url = reverse('dcim-api:site-list')
  432. self.add_permissions('dcim.change_site', 'extras.view_tag')
  433. response = self.client.patch(url, data, format='json', **self.header)
  434. self.assertHttpStatus(response, status.HTTP_200_OK)
  435. # Verify that a background task was queued for each updated object
  436. self.assertEqual(self.queue.count, 3)
  437. for i, job in enumerate(self.queue.jobs):
  438. self.assertEqual(job.kwargs['event_rule'], EventRule.objects.get(name='Event Rule 2'))
  439. self.assertEqual(job.kwargs['event_type'], OBJECT_UPDATED)
  440. self.assertEqual(job.kwargs['object_type'], ObjectType.objects.get_for_model(Site))
  441. self.assertEqual(job.kwargs['data']['id'], data[i]['id'])
  442. self.assertEqual(job.kwargs['data']['foo'], 2)
  443. self.assertEqual(len(job.kwargs['data']['tags']), len(response.data[i]['tags']))
  444. self.assertEqual(job.kwargs['snapshots']['prechange']['name'], sites[i].name)
  445. self.assertEqual(job.kwargs['snapshots']['prechange']['tags'], ['Bar', 'Foo'])
  446. self.assertEqual(job.kwargs['snapshots']['postchange']['name'], response.data[i]['name'])
  447. self.assertEqual(job.kwargs['snapshots']['postchange']['tags'], ['Baz'])
  448. def test_bulk_update_rollback_discards_events(self):
  449. """
  450. Check that a bulk update which is rolled back because one object failed validation queues no
  451. background tasks for the objects that were provisionally updated.
  452. """
  453. sites = (
  454. Site(name='Site 1', slug='site-1'),
  455. Site(name='Site 2', slug='site-2'),
  456. Site(name='Site 3', slug='site-3'),
  457. )
  458. Site.objects.bulk_create(sites)
  459. # The first two objects are valid and will be provisionally updated; the third fails
  460. # validation, rolling the entire batch back.
  461. data = [
  462. {'id': sites[0].pk, 'name': 'Site X'},
  463. {'id': sites[1].pk, 'name': 'Site Y'},
  464. {'id': sites[2].pk, 'status': 'not-a-valid-status'},
  465. ]
  466. url = reverse('dcim-api:site-list')
  467. self.add_permissions('dcim.change_site')
  468. response = self.client.patch(url, data, format='json', **self.header)
  469. self.assertHttpStatus(response, status.HTTP_400_BAD_REQUEST)
  470. # No object may have been modified
  471. for site in sites:
  472. site.refresh_from_db()
  473. self.assertListEqual([site.name for site in sites], ['Site 1', 'Site 2', 'Site 3'])
  474. # No task may be queued for an update that was rolled back
  475. self.assertEqual(self.queue.count, 0)
  476. def test_single_delete_process_eventrule(self):
  477. """
  478. Check that deleting an object with an applicable EventRule queues a background task for the rule's action.
  479. """
  480. site = Site.objects.create(name='Site 1', slug='site-1')
  481. site.tags.set(Tag.objects.filter(name__in=['Foo', 'Bar']))
  482. # Delete an object via the REST API
  483. url = reverse('dcim-api:site-detail', kwargs={'pk': site.pk})
  484. self.add_permissions('dcim.delete_site')
  485. response = self.client.delete(url, **self.header)
  486. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  487. # Verify that a task was queued for the deleted object
  488. self.assertEqual(self.queue.count, 1)
  489. job = self.queue.jobs[0]
  490. self.assertEqual(job.kwargs['event_rule'], EventRule.objects.get(name='Event Rule 3'))
  491. self.assertEqual(job.kwargs['event_type'], OBJECT_DELETED)
  492. self.assertEqual(job.kwargs['object_type'], ObjectType.objects.get_for_model(Site))
  493. self.assertEqual(job.kwargs['data']['id'], site.pk)
  494. self.assertEqual(job.kwargs['data']['foo'], 3)
  495. self.assertEqual(job.kwargs['snapshots']['prechange']['name'], 'Site 1')
  496. self.assertEqual(job.kwargs['snapshots']['prechange']['tags'], ['Bar', 'Foo'])
  497. objectchange = ObjectChange.objects.get(
  498. changed_object_type=ContentType.objects.get_for_model(Site), changed_object_id=site.pk
  499. )
  500. self.assertEqual(job.kwargs['object_change_ids'], [objectchange.pk])
  501. def test_single_delete_rollback_discards_events(self):
  502. """
  503. Check that deleting an object whose cascading deletion is aborted queues no background task
  504. for the dependent objects that were already processed.
  505. """
  506. device = create_test_device('Device 1')
  507. Interface.objects.create(
  508. device=device, name='Interface 1', type=InterfaceTypeChoices.TYPE_1GE_FIXED, description='Has one'
  509. )
  510. Interface.objects.create(device=device, name='Interface 2', type=InterfaceTypeChoices.TYPE_1GE_FIXED)
  511. event_rule = EventRule.objects.get(name='Event Rule 3')
  512. event_rule.object_types.set([ObjectType.objects.get_for_model(Interface)])
  513. url = reverse('dcim-api:device-detail', kwargs={'pk': device.pk})
  514. self.add_permissions('dcim.delete_device')
  515. # Deleting the Device cascades to both Interfaces. The first satisfies the protection rule
  516. # and so is processed (queueing its event); the second does not, aborting the request.
  517. protection_rules = {'dcim.interface': [{'description': {'required': True}}]}
  518. with override_settings(PROTECTION_RULES=protection_rules):
  519. response = self.client.delete(url, **self.header)
  520. self.assertHttpStatus(response, status.HTTP_400_BAD_REQUEST)
  521. self.assertTrue(Device.objects.filter(pk=device.pk).exists())
  522. self.assertEqual(Interface.objects.filter(device=device).count(), 2)
  523. # No task may be queued for a deletion that was rolled back
  524. self.assertEqual(self.queue.count, 0)
  525. def test_bulk_delete_process_eventrule(self):
  526. """
  527. Check that bulk deleting multiple objects with an applicable EventRule queues a background task for each
  528. deleted object.
  529. """
  530. sites = (
  531. Site(name='Site 1', slug='site-1'),
  532. Site(name='Site 2', slug='site-2'),
  533. Site(name='Site 3', slug='site-3'),
  534. )
  535. Site.objects.bulk_create(sites)
  536. for site in sites:
  537. site.tags.set(Tag.objects.filter(name__in=['Foo', 'Bar']))
  538. # Delete three objects via the REST API
  539. data = [
  540. {'id': site.pk} for site in sites
  541. ]
  542. url = reverse('dcim-api:site-list')
  543. self.add_permissions('dcim.delete_site')
  544. response = self.client.delete(url, data, format='json', **self.header)
  545. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  546. # Verify that a background task was queued for each deleted object
  547. self.assertEqual(self.queue.count, 3)
  548. for i, job in enumerate(self.queue.jobs):
  549. self.assertEqual(job.kwargs['event_rule'], EventRule.objects.get(name='Event Rule 3'))
  550. self.assertEqual(job.kwargs['event_type'], OBJECT_DELETED)
  551. self.assertEqual(job.kwargs['object_type'], ObjectType.objects.get_for_model(Site))
  552. self.assertEqual(job.kwargs['data']['id'], sites[i].pk)
  553. self.assertEqual(job.kwargs['data']['foo'], 3)
  554. self.assertEqual(job.kwargs['snapshots']['prechange']['name'], sites[i].name)
  555. self.assertEqual(job.kwargs['snapshots']['prechange']['tags'], ['Bar', 'Foo'])
  556. def test_bulk_delete_rollback_discards_events(self):
  557. """
  558. Check that a bulk delete which is rolled back because one object is protected queues no
  559. background tasks for the objects that were provisionally deleted.
  560. """
  561. sites = (
  562. Site(name='Site 1', slug='site-1'),
  563. Site(name='Site 2', slug='site-2'),
  564. Site(name='Site 3', slug='site-3'),
  565. )
  566. Site.objects.bulk_create(sites)
  567. # A Device references the third Site, whose deletion will therefore raise a ProtectedError
  568. # and roll the entire batch back.
  569. create_test_device('Device 1', site=sites[2])
  570. data = [{'id': site.pk} for site in sites]
  571. url = reverse('dcim-api:site-list')
  572. self.add_permissions('dcim.delete_site')
  573. response = self.client.delete(url, data, format='json', **self.header)
  574. self.assertHttpStatus(response, status.HTTP_409_CONFLICT)
  575. self.assertEqual(Site.objects.count(), 3)
  576. # No task may be queued for a deletion that was rolled back
  577. self.assertEqual(self.queue.count, 0)
  578. def test_bulk_delete_abort_discards_events(self):
  579. """
  580. Check that a bulk delete blocked by a signal receiver raising AbortRequest (rather than by a
  581. database constraint) also queues no background tasks for the objects that were provisionally
  582. deleted before the failure.
  583. """
  584. sites = (
  585. Site(name='Site 1', slug='site-1', description='Has a description'),
  586. Site(name='Site 2', slug='site-2'),
  587. )
  588. Site.objects.bulk_create(sites)
  589. data = [{'id': site.pk} for site in sites]
  590. url = reverse('dcim-api:site-list')
  591. self.add_permissions('dcim.delete_site')
  592. # Site 2 has no description, so its deletion is blocked once Site 1 has already been deleted
  593. protection_rules = {'dcim.site': [{'description': {'required': True}}]}
  594. with override_settings(PROTECTION_RULES=protection_rules):
  595. response = self.client.delete(url, data, format='json', **self.header)
  596. # 400 rather than 409: a protection rule rejects the request, it is not a conflict with a
  597. # dependent object (see BulkDestroyModelMixin.bulk_destroy)
  598. self.assertHttpStatus(response, status.HTTP_400_BAD_REQUEST)
  599. self.assertEqual(Site.objects.count(), 2)
  600. # The failure is correlated to the blocked object only
  601. self.assertEqual([e['id'] for e in response.data['errors']], [sites[1].pk])
  602. # No task may be queued for a deletion that was rolled back
  603. self.assertEqual(self.queue.count, 0)
  604. @skipIf('netbox.tests.dummy_plugin' not in settings.PLUGINS, 'dummy_plugin not in settings.PLUGINS')
  605. def test_send_webhook(self):
  606. request_id = uuid.uuid4()
  607. url_path = reverse('dcim:site_add')
  608. def dummy_send(_, request, **kwargs):
  609. """
  610. A dummy implementation of Session.send() to be used for testing.
  611. Always returns a 200 HTTP response.
  612. """
  613. event = EventRule.objects.get(name='Event Rule 1')
  614. webhook = event.action_object
  615. signature = generate_signature(request.body, webhook.secret)
  616. # Validate the outgoing request headers
  617. self.assertEqual(request.headers['Content-Type'], webhook.http_content_type)
  618. self.assertEqual(request.headers['X-Hook-Signature'], signature)
  619. self.assertEqual(request.headers['X-Foo'], 'Bar')
  620. # The webhook does not define its own timeout, so the global default should be used
  621. self.assertEqual(kwargs['timeout'], settings.WEBHOOK_DEFAULT_TIMEOUT)
  622. # Validate the outgoing request body
  623. body = json.loads(request.body)
  624. self.assertEqual(body['event'], 'created')
  625. self.assertEqual(body['timestamp'], job.kwargs['timestamp'])
  626. self.assertEqual(body['object_type'], 'dcim.site')
  627. self.assertEqual(body['data']['name'], 'Site 1')
  628. self.assertEqual(body['data']['foo'], 1)
  629. self.assertEqual(body['context']['foo'], 123) # From netbox.tests.dummy_plugin
  630. self.assertEqual(body['request']['id'], str(request_id))
  631. self.assertEqual(body['request']['method'], 'GET')
  632. self.assertEqual(body['request']['path'], url_path)
  633. self.assertEqual(body['request']['user'], 'testuser')
  634. self.assertEqual(body['object_change_ids'], [123])
  635. return HttpResponse()
  636. # Create a dummy request
  637. request = RequestFactory().get(url_path)
  638. request.id = request_id
  639. request.user = self.user
  640. # Enqueue a webhook for processing
  641. webhooks_queue = {}
  642. site = Site.objects.create(name='Site 1', slug='site-1')
  643. enqueue_event(
  644. webhooks_queue,
  645. instance=site,
  646. request=request,
  647. event_type=OBJECT_CREATED,
  648. object_change_id=123,
  649. )
  650. flush_events(list(webhooks_queue.values()))
  651. # Retrieve the job from queue
  652. job = self.queue.jobs[0]
  653. # Patch the Session object with our dummy_send() method, then process the webhook for sending
  654. with patch.object(Session, 'send', dummy_send):
  655. send_webhook(**job.kwargs)
  656. def test_send_webhook_per_webhook_timeout(self):
  657. """
  658. A webhook which defines its own timeout should use that value in preference to the
  659. global WEBHOOK_DEFAULT_TIMEOUT.
  660. """
  661. webhook = Webhook.objects.get(name='Webhook 1')
  662. webhook.timeout = 5
  663. webhook.save()
  664. def dummy_send(_, request, **kwargs):
  665. self.assertEqual(kwargs['timeout'], 5)
  666. return HttpResponse()
  667. request = RequestFactory().get(reverse('dcim:site_add'))
  668. request.id = uuid.uuid4()
  669. request.user = self.user
  670. webhooks_queue = {}
  671. site = Site.objects.create(name='Site 1', slug='site-1')
  672. enqueue_event(
  673. webhooks_queue,
  674. instance=site,
  675. request=request,
  676. event_type=OBJECT_CREATED,
  677. )
  678. flush_events(list(webhooks_queue.values()))
  679. job = self.queue.jobs[0]
  680. with patch.object(Session, 'send', dummy_send):
  681. send_webhook(**job.kwargs)
  682. @override_settings(RQ_DEFAULT_TIMEOUT=10)
  683. def test_send_webhook_timeout_exceeding_job_timeout_is_logged(self):
  684. """
  685. A timeout which meets or exceeds the background job timeout should be logged as a warning. This can
  686. occur when RQ_DEFAULT_TIMEOUT has been lowered after the webhook was saved, which Webhook.clean()
  687. cannot catch.
  688. """
  689. webhook = Webhook.objects.get(name='Webhook 1')
  690. webhook.timeout = 30
  691. webhook.save()
  692. request = RequestFactory().get(reverse('dcim:site_add'))
  693. request.id = uuid.uuid4()
  694. request.user = self.user
  695. webhooks_queue = {}
  696. site = Site.objects.create(name='Site 1', slug='site-1')
  697. enqueue_event(
  698. webhooks_queue,
  699. instance=site,
  700. request=request,
  701. event_type=OBJECT_CREATED,
  702. )
  703. flush_events(list(webhooks_queue.values()))
  704. job = self.queue.jobs[0]
  705. with patch.object(Session, 'send', lambda _, request, **kwargs: HttpResponse()):
  706. with self.assertLogs('netbox.webhooks', level='WARNING') as cm:
  707. send_webhook(**job.kwargs)
  708. self.assertIn(
  709. 'Webhook timeout (30 seconds) is not less than the background job timeout (10 seconds)',
  710. '\n'.join(cm.output)
  711. )
  712. def test_send_webhook_timeout_is_logged(self):
  713. """
  714. A request which times out should be logged as an error before the exception is re-raised, so that the
  715. failure is discoverable without resorting to the RQ worker's traceback.
  716. """
  717. def timing_out_send(_, request, **kwargs):
  718. raise requests.exceptions.ConnectTimeout('Connection timed out')
  719. request = RequestFactory().get(reverse('dcim:site_add'))
  720. request.id = uuid.uuid4()
  721. request.user = self.user
  722. webhooks_queue = {}
  723. site = Site.objects.create(name='Site 1', slug='site-1')
  724. enqueue_event(
  725. webhooks_queue,
  726. instance=site,
  727. request=request,
  728. event_type=OBJECT_CREATED,
  729. )
  730. flush_events(list(webhooks_queue.values()))
  731. job = self.queue.jobs[0]
  732. with patch.object(Session, 'send', timing_out_send):
  733. with self.assertLogs('netbox.webhooks', level='ERROR') as cm:
  734. with self.assertRaises(requests.exceptions.Timeout):
  735. send_webhook(**job.kwargs)
  736. self.assertIn(f'timed out after {settings.WEBHOOK_DEFAULT_TIMEOUT} seconds', cm.output[0])
  737. def test_job_completed_webhook_without_request(self):
  738. """
  739. Ensure job_end event processing can enqueue a webhook even when the EventContext
  740. lacks a request context.
  741. The job_start/job_end signal receivers only populate `user` and `data`, so webhook
  742. processing must tolerate the absence of a request.
  743. """
  744. script_type = ObjectType.objects.get_for_model(Script)
  745. webhook_type = ObjectType.objects.get_for_model(Webhook)
  746. webhook = Webhook.objects.get(name='Webhook 1')
  747. event_rule = EventRule.objects.create(
  748. name='Event Rule Job Completed',
  749. event_types=[JOB_COMPLETED],
  750. action_type=EventRuleActionChoices.WEBHOOK,
  751. action_object_type=webhook_type,
  752. action_object_id=webhook.pk,
  753. )
  754. event_rule.object_types.set([script_type])
  755. # Mimic the `core.job_end` signal sender expected by extras.signals.process_job_end_event_rules
  756. # (notably: no request, and thus no legacy `username`)
  757. sender = Mock(object_type=script_type, data={}, user=self.user)
  758. process_job_end_event_rules(sender)
  759. self.assertEqual(self.queue.count, 1)
  760. job = self.queue.jobs[0]
  761. self.assertEqual(job.kwargs['event_rule'], event_rule)
  762. self.assertEqual(job.kwargs['event_type'], JOB_COMPLETED)
  763. self.assertEqual(job.kwargs['object_type'], script_type)
  764. self.assertNotIn('request', job.kwargs)
  765. self.assertNotIn('object_change_ids', job.kwargs)
  766. def _job_event_rule(self, conditions=None):
  767. webhook = Webhook.objects.get(name='Webhook 1')
  768. event_rule = EventRule.objects.create(
  769. name='Event Rule Job Completed',
  770. event_types=[JOB_COMPLETED],
  771. action_type=EventRuleActionChoices.WEBHOOK,
  772. action_object_type=ObjectType.objects.get_for_model(Webhook),
  773. action_object_id=webhook.pk,
  774. conditions=conditions,
  775. )
  776. event_rule.object_types.set([ObjectType.objects.get_for_model(Script)])
  777. return event_rule
  778. def test_job_event_with_null_data(self):
  779. """
  780. Job.data is nullable, and a job which recorded no data is entirely routine. Event
  781. processing must handle it rather than raising while merging the payload.
  782. """
  783. script_type = ObjectType.objects.get_for_model(Script)
  784. self._job_event_rule()
  785. process_job_end_event_rules(Mock(object_type=script_type, data=None, user=self.user))
  786. self.assertEqual(self.queue.count, 1)
  787. self.assertEqual(self.queue.jobs[0].kwargs['data'], {})
  788. def test_job_event_with_null_data_and_conditions(self):
  789. """
  790. A condition referencing an attribute of a null payload is a non-match rather than an
  791. error: the rule is skipped without logging, since a job which recorded no data is
  792. routine rather than a misconfigured rule.
  793. """
  794. script_type = ObjectType.objects.get_for_model(Script)
  795. self._job_event_rule(conditions={'attr': 'status', 'value': 'completed'})
  796. with self.assertNoLogs('netbox.event_rules', level='ERROR'):
  797. process_job_end_event_rules(Mock(object_type=script_type, data=None, user=self.user))
  798. self.assertEqual(self.queue.count, 0)
  799. def test_job_event_with_null_data_does_not_satisfy_conditions(self):
  800. """
  801. A null payload must not satisfy a conditioned rule, however the condition is phrased:
  802. there is no data to evaluate, so nothing may enqueue the rule's action. A test for null
  803. and a negated test are the two phrasings which would otherwise match.
  804. """
  805. script_type = ObjectType.objects.get_for_model(Script)
  806. for conditions in (
  807. {'attr': 'status', 'value': None},
  808. {'attr': 'status', 'value': 'completed', 'negate': True},
  809. ):
  810. with self.subTest(conditions=conditions):
  811. event_rule = self._job_event_rule(conditions=conditions)
  812. with self.assertNoLogs('netbox.event_rules', level='ERROR'):
  813. process_job_end_event_rules(Mock(object_type=script_type, data=None, user=self.user))
  814. self.assertEqual(self.queue.count, 0)
  815. event_rule.delete()
  816. def test_job_event_with_non_dict_data(self):
  817. """
  818. A payload which is neither null nor a dict is unexpected: log it, but continue
  819. processing rather than aborting the batch.
  820. """
  821. script_type = ObjectType.objects.get_for_model(Script)
  822. self._job_event_rule()
  823. for payload in ([1, 2], 'a string', 42):
  824. self.queue.empty()
  825. with self.assertLogs('netbox.events_processor', level='WARNING') as cm:
  826. process_job_end_event_rules(Mock(object_type=script_type, data=payload, user=self.user))
  827. self.assertIn(type(payload).__name__, cm.output[0])
  828. self.assertEqual(self.queue.count, 1)
  829. self.assertEqual(self.queue.jobs[0].kwargs['data'], {})
  830. def test_job_event_with_non_dict_data_and_conditions(self):
  831. """
  832. An invalid payload is no more evaluable than an absent one, so a conditioned rule must
  833. fail closed for it — including for the phrasings which a payload normalized to an empty
  834. dict would otherwise satisfy. The invalid payload is still reported once for the event,
  835. as the anomaly it is.
  836. """
  837. script_type = ObjectType.objects.get_for_model(Script)
  838. for conditions in (
  839. {'attr': 'status', 'value': None},
  840. {'attr': 'status', 'value': 'completed', 'negate': True},
  841. {'attr': 'status', 'value': 'completed'},
  842. ):
  843. event_rule = self._job_event_rule(conditions=conditions)
  844. for payload in ([1, 2], 'a string', 42):
  845. with self.subTest(conditions=conditions, payload=payload):
  846. self.queue.empty()
  847. with self.assertLogs('netbox.events_processor', level='WARNING') as cm:
  848. process_job_end_event_rules(
  849. Mock(object_type=script_type, data=payload, user=self.user)
  850. )
  851. self.assertIn(type(payload).__name__, cm.output[0])
  852. self.assertEqual(self.queue.count, 0)
  853. event_rule.delete()
  854. def test_no_matching_rules_leaves_payload_unserialized(self):
  855. """
  856. Normalizing the payload must not defeat EventContext's lazy serialization: an
  857. event with no applicable rules should never have its payload materialized.
  858. """
  859. request = RequestFactory().get('/')
  860. request.id = uuid.uuid4()
  861. request.user = self.user
  862. site = Site.objects.create(name='Site Lazy', slug='site-lazy')
  863. queue = {}
  864. enqueue_event(queue, site, request, OBJECT_UPDATED)
  865. event = queue[f'dcim.site:{site.pk}']
  866. self.assertNotIn('data', event.data)
  867. process_event_rules(
  868. event_rules=EventRule.objects.none(),
  869. object_type=ObjectType.objects.get_for_model(Site),
  870. event=event,
  871. )
  872. self.assertNotIn('data', event.data)
  873. def test_duplicate_enqueue_refreshes_lazy_payload(self):
  874. """
  875. When the same object is enqueued more than once in a single request,
  876. lazy serialization should use the most recently enqueued instance while
  877. preserving the original event['object'] reference.
  878. """
  879. request = RequestFactory().get(reverse('dcim:site_add'))
  880. request.id = uuid.uuid4()
  881. request.user = self.user
  882. site = Site.objects.create(name='Site 1', slug='site-1')
  883. stale_site = Site.objects.get(pk=site.pk)
  884. queue = {}
  885. enqueue_event(queue, stale_site, request, OBJECT_UPDATED)
  886. event = queue[f'dcim.site:{site.pk}']
  887. # Data should not be materialized yet (lazy serialization)
  888. self.assertNotIn('data', event.data)
  889. fresh_site = Site.objects.get(pk=site.pk)
  890. fresh_site.description = 'foo'
  891. fresh_site.save()
  892. enqueue_event(queue, fresh_site, request, OBJECT_UPDATED)
  893. # The original object reference should be preserved
  894. self.assertIs(event['object'], stale_site)
  895. # But serialized data should reflect the fresher instance
  896. self.assertEqual(event['data']['description'], 'foo')
  897. self.assertEqual(event['snapshots']['postchange']['description'], 'foo')
  898. def test_duplicate_enqueue_invalidates_materialized_data(self):
  899. """
  900. If event['data'] has already been materialized before a second enqueue
  901. for the same object, the stale payload should be discarded and rebuilt
  902. from the fresher instance on next access.
  903. """
  904. request = RequestFactory().get(reverse('dcim:site_add'))
  905. request.id = uuid.uuid4()
  906. request.user = self.user
  907. site = Site.objects.create(name='Site 1', slug='site-1')
  908. queue = {}
  909. enqueue_event(queue, site, request, OBJECT_UPDATED)
  910. event = queue[f'dcim.site:{site.pk}']
  911. # Force early materialization
  912. self.assertEqual(event['data']['description'], '')
  913. # Now update and re-enqueue
  914. fresh_site = Site.objects.get(pk=site.pk)
  915. fresh_site.description = 'updated'
  916. fresh_site.save()
  917. enqueue_event(queue, fresh_site, request, OBJECT_UPDATED)
  918. # Stale data should have been invalidated; new access should reflect update
  919. self.assertEqual(event['data']['description'], 'updated')
  920. def test_update_then_delete_enqueue_freezes_payload(self):
  921. """
  922. When an update event is coalesced with a subsequent delete, the event
  923. type should be promoted to OBJECT_DELETED and the payload should be
  924. eagerly frozen (since the object will be inaccessible after deletion).
  925. """
  926. request = RequestFactory().get(reverse('dcim:site_add'))
  927. request.id = uuid.uuid4()
  928. request.user = self.user
  929. site = Site.objects.create(name='Site 1', slug='site-1')
  930. queue = {}
  931. enqueue_event(queue, site, request, OBJECT_UPDATED)
  932. event = queue[f'dcim.site:{site.pk}']
  933. enqueue_event(queue, site, request, OBJECT_DELETED)
  934. # Event type should have been promoted
  935. self.assertEqual(event['event_type'], OBJECT_DELETED)
  936. # Data should already be materialized (frozen), not lazy
  937. self.assertIn('data', event.data)
  938. self.assertEqual(event['data']['name'], 'Site 1')
  939. self.assertIsNone(event['snapshots']['postchange'])
  940. def test_coalesced_event_includes_all_object_change_ids(self):
  941. """
  942. An event coalesced from multiple changes to an object within a single request should reference
  943. each ObjectChange recorded for it, in order and without duplicates.
  944. """
  945. request = RequestFactory().get(reverse('dcim:site_add'))
  946. request.id = uuid.uuid4()
  947. request.user = self.user
  948. with event_tracking(request):
  949. site = Site(name='Site 1', slug='site-1')
  950. site.save()
  951. site.snapshot()
  952. site.description = 'foo'
  953. site.save()
  954. # Updates the prior ObjectChange rather than recording a new one
  955. site.tags.set(Tag.objects.filter(name='Foo'))
  956. # Records no ObjectChange
  957. site.snapshot()
  958. site.save()
  959. object_change_ids = list(
  960. ObjectChange.objects.filter(
  961. changed_object_type=ContentType.objects.get_for_model(Site), changed_object_id=site.pk
  962. ).order_by('pk').values_list('pk', flat=True)
  963. )
  964. self.assertEqual(len(object_change_ids), 2)
  965. self.assertEqual(self.queue.count, 1)
  966. job = self.queue.jobs[0]
  967. self.assertEqual(job.kwargs['event_type'], OBJECT_CREATED)
  968. self.assertEqual(job.kwargs['object_change_ids'], object_change_ids)
  969. def test_send_webhook_omits_empty_object_change_ids(self):
  970. """
  971. The webhook context should omit object_change_ids if no ObjectChanges were recorded for the event.
  972. """
  973. def dummy_send(_, request, **kwargs):
  974. self.assertNotIn('object_change_ids', json.loads(request.body))
  975. return HttpResponse()
  976. request = RequestFactory().get(reverse('dcim:site_add'))
  977. request.id = uuid.uuid4()
  978. request.user = self.user
  979. queue = {}
  980. site = Site.objects.create(name='Site 1', slug='site-1')
  981. enqueue_event(queue, site, request, OBJECT_CREATED)
  982. flush_events(list(queue.values()))
  983. job = self.queue.jobs[0]
  984. self.assertNotIn('object_change_ids', job.kwargs)
  985. with patch.object(Session, 'send', dummy_send):
  986. send_webhook(**job.kwargs)
  987. @tag('regression') # #21338
  988. def test_cable_creation_event_payload_includes_connected_endpoints(self):
  989. """
  990. Interface update events queued during cable creation must include the
  991. peer interface in connected_endpoints and link_peers.
  992. """
  993. webhook = Webhook.objects.get(name='Webhook 1')
  994. event_rule = EventRule.objects.create(
  995. name='Interface Update Rule',
  996. event_types=[OBJECT_UPDATED],
  997. action_type=EventRuleActionChoices.WEBHOOK,
  998. action_object_type=ObjectType.objects.get_for_model(Webhook),
  999. action_object_id=webhook.id,
  1000. )
  1001. event_rule.object_types.set([ObjectType.objects.get_for_model(Interface)])
  1002. device = create_test_device('Device 1')
  1003. interface_a = Interface.objects.create(device=device, name='eth0')
  1004. interface_b = Interface.objects.create(device=device, name='eth1')
  1005. # Create a cable between the two interfaces via the REST API
  1006. data = {
  1007. 'a_terminations': [{'object_type': 'dcim.interface', 'object_id': interface_a.pk}],
  1008. 'b_terminations': [{'object_type': 'dcim.interface', 'object_id': interface_b.pk}],
  1009. }
  1010. url = reverse('dcim-api:cable-list')
  1011. self.add_permissions('dcim.add_cable')
  1012. response = self.client.post(url, data, format='json', **self.header)
  1013. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  1014. # One update event was queued for each interface
  1015. self.assertEqual(self.queue.count, 2)
  1016. payloads = {job.kwargs['data']['id']: job.kwargs['data'] for job in self.queue.jobs}
  1017. peers = {interface_a.pk: interface_b.pk, interface_b.pk: interface_a.pk}
  1018. self.assertEqual(set(payloads), set(peers))
  1019. for interface_id, payload in payloads.items():
  1020. peer_id = peers[interface_id]
  1021. self.assertIsNotNone(payload['connected_endpoints'])
  1022. self.assertEqual([endpoint['id'] for endpoint in payload['connected_endpoints']], [peer_id])
  1023. self.assertEqual([peer['id'] for peer in payload['link_peers']], [peer_id])
  1024. self.assertTrue(payload['connected_endpoints_reachable'])
  1025. def test_duplicate_triggers(self):
  1026. """
  1027. Test for erroneous duplicate event triggers resulting from saving an object multiple times
  1028. within the span of a single request.
  1029. """
  1030. url = reverse('dcim:site_add')
  1031. request = RequestFactory().get(url)
  1032. request.id = uuid.uuid4()
  1033. request.user = self.user
  1034. # Test create & update
  1035. with event_tracking(request):
  1036. site = Site(name='Site 1', slug='site-1')
  1037. site.save()
  1038. site.snapshot()
  1039. site.description = 'foo'
  1040. site.save()
  1041. self.assertEqual(self.queue.count, 1, msg="Duplicate jobs found in queue")
  1042. job = self.queue.get_jobs()[0]
  1043. self.assertEqual(job.kwargs['event_type'], OBJECT_CREATED)
  1044. self.queue.empty()
  1045. # Test multiple updates
  1046. site = Site.objects.create(name='Site 2', slug='site-2')
  1047. with event_tracking(request):
  1048. site.snapshot()
  1049. site.description = 'foo'
  1050. site.save()
  1051. site.snapshot()
  1052. site.description = 'bar'
  1053. site.save()
  1054. self.assertEqual(self.queue.count, 1, msg="Duplicate jobs found in queue")
  1055. job = self.queue.get_jobs()[0]
  1056. self.assertEqual(job.kwargs['event_type'], OBJECT_UPDATED)
  1057. self.queue.empty()
  1058. # Test update & delete
  1059. site = Site.objects.create(name='Site 3', slug='site-3')
  1060. with event_tracking(request):
  1061. site.snapshot()
  1062. site.description = 'foo'
  1063. site.save()
  1064. site.delete()
  1065. self.assertEqual(self.queue.count, 1, msg="Duplicate jobs found in queue")
  1066. job = self.queue.get_jobs()[0]
  1067. self.assertEqual(job.kwargs['event_type'], OBJECT_DELETED)
  1068. self.queue.empty()
  1069. def test_non_dict_action_data_does_not_crash_flush(self):
  1070. """
  1071. Pre-existing non-dict action_data must not cause flush_events() to
  1072. raise.
  1073. """
  1074. # flush_events() logs a warning about the invalid action_data; mute it so the expected
  1075. # message doesn't clutter the test runner's output.
  1076. events_logger = logging.getLogger('netbox.events_processor')
  1077. original_level = events_logger.level
  1078. events_logger.setLevel(logging.CRITICAL)
  1079. self.addCleanup(events_logger.setLevel, original_level)
  1080. site_type = ObjectType.objects.get_for_model(Site)
  1081. webhook = Webhook.objects.get(name='Webhook 1')
  1082. webhook_type = ObjectType.objects.get_for_model(Webhook)
  1083. bad_rule = EventRule.objects.create(
  1084. name='Bad action_data rule',
  1085. event_types=[OBJECT_CREATED],
  1086. action_type=EventRuleActionChoices.WEBHOOK,
  1087. action_object_type=webhook_type,
  1088. action_object_id=webhook.pk,
  1089. action_data={},
  1090. )
  1091. bad_rule.object_types.set([site_type])
  1092. # Simulate a legacy row that predates model validation.
  1093. EventRule.objects.filter(pk=bad_rule.pk).update(action_data='not a dict')
  1094. url = reverse('dcim-api:site-list')
  1095. self.add_permissions('dcim.add_site')
  1096. response = self.client.post(url, {'name': 'Site X', 'slug': 'site-x'}, format='json', **self.header)
  1097. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  1098. @tag('regression')
  1099. def test_eventrule_script_action_with_object_image_files(self):
  1100. """
  1101. Verify that a Script event-rule action can be enqueued and executed cleanly when the
  1102. triggering object carries uploaded files (e.g. DeviceType images).
  1103. This is a regression test for issue #22376.
  1104. """
  1105. # Create a dummy script class and an instance of it
  1106. class DummyScript(ScriptBase):
  1107. class Meta:
  1108. name = "Dummy Script"
  1109. def run(self, data, commit=True):
  1110. return "finished successfully"
  1111. dummy_script = DummyScript()
  1112. # Create ScriptModule and Script
  1113. with patch.object(ScriptModule, 'sync_classes'):
  1114. module = ScriptModule.objects.create(
  1115. file_root=ManagedFileRootPathChoices.SCRIPTS,
  1116. file_path='dummy_script.py',
  1117. )
  1118. script = Script.objects.create(
  1119. module=module,
  1120. name='Dummy Script',
  1121. is_executable=True,
  1122. )
  1123. script_type = ObjectType.objects.get_for_model(Script)
  1124. # Create an event rule that triggers on DeviceType update with Script action
  1125. devicetype_type = ObjectType.objects.get_for_model(DeviceType)
  1126. event_rule = EventRule.objects.create(
  1127. name='Test Script Event Rule with Files',
  1128. event_types=[OBJECT_UPDATED],
  1129. action_type=EventRuleActionChoices.SCRIPT,
  1130. action_object_type=script_type,
  1131. action_object_id=script.pk,
  1132. )
  1133. event_rule.object_types.set([devicetype_type])
  1134. # Create a manufacturer and DeviceType
  1135. manufacturer = Manufacturer.objects.create(
  1136. name='Test Manufacturer',
  1137. slug='test-manufacturer',
  1138. )
  1139. devicetype = DeviceType.objects.create(
  1140. model='Test DeviceType',
  1141. slug="test-devicetype",
  1142. manufacturer=manufacturer,
  1143. )
  1144. # Create an image file
  1145. image = BytesIO()
  1146. Image.new('RGB', (1, 1)).save(image, format='PNG')
  1147. image.name = 'test_image.png'
  1148. image.seek(0)
  1149. # PATCH the DeviceType via REST API to add the image
  1150. data = {
  1151. 'front_image': image,
  1152. }
  1153. url = reverse('dcim-api:devicetype-detail', kwargs={'pk': devicetype.pk})
  1154. self.add_permissions('dcim.change_devicetype')
  1155. # Mock the script's python_class to prevent the test from trying to load from disk
  1156. with patch.object(Script, 'python_class') as mock:
  1157. mock.return_value = dummy_script
  1158. # Since in core/models/jobs.py Jobs are enqueued with a transaction.on_commit-handler
  1159. # we simulate commit by using captureOnCommitCallbacks context manager
  1160. with self.captureOnCommitCallbacks(execute=True):
  1161. response = self.client.patch(url, data, format='multipart', **self.header)
  1162. self.assertHttpStatus(response, status.HTTP_200_OK)
  1163. # Assert that the script job was enqueued cleanly and is waiting for execution
  1164. self.assertEqual(self.queue.count, 1)
  1165. script_job = Job.objects.filter(name=dummy_script.name).last()
  1166. self.assertEqual(script_job.status, "pending")
  1167. # silence rqworker (cleaner output) and trigger job execution
  1168. logging.getLogger('rq.worker').setLevel(logging.ERROR)
  1169. self.run_rq_jobs('default')
  1170. # Assert that our script was executed without any errors
  1171. script_job.refresh_from_db()
  1172. self.assertEqual(script_job.status, "completed")
  1173. self.assertEqual(script_job.data.get('output', ''), "finished successfully")
  1174. @tag('regression') # Issue #22872
  1175. def test_eventrule_script_action_invalid_meta_does_not_abort_change(self):
  1176. """
  1177. A Script event-rule action whose Meta configuration is invalid must be logged and skipped without aborting
  1178. the triggering object change or raising an HTTP 500 (#22872). Because event rules are processed in-request,
  1179. an unhandled ValidationError here would fail the originating request.
  1180. """
  1181. class BadMetaScript(ScriptBase):
  1182. class Meta:
  1183. name = "Bad Meta Script"
  1184. job_timeout = 'not-a-timeout'
  1185. def run(self, data, commit=True):
  1186. return "never reached"
  1187. with patch.object(ScriptModule, 'sync_classes'):
  1188. module = ScriptModule.objects.create(
  1189. file_root=ManagedFileRootPathChoices.SCRIPTS,
  1190. file_path='bad_meta_script.py',
  1191. )
  1192. script = Script.objects.create(module=module, name='Bad Meta Script', is_executable=True)
  1193. script_type = ObjectType.objects.get_for_model(Script)
  1194. # Trigger on Manufacturer rather than Site: the class-level event rules all target Site, so a Site-based rule
  1195. # here would collide with them and perturb other tests' queue expectations.
  1196. manufacturer_type = ObjectType.objects.get_for_model(Manufacturer)
  1197. event_rule = EventRule.objects.create(
  1198. name='Bad Meta Script Rule',
  1199. event_types=[OBJECT_UPDATED],
  1200. action_type=EventRuleActionChoices.SCRIPT,
  1201. action_object_type=script_type,
  1202. action_object_id=script.pk,
  1203. )
  1204. event_rule.object_types.set([manufacturer_type])
  1205. manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1')
  1206. self.add_permissions('dcim.change_manufacturer')
  1207. url = reverse('dcim-api:manufacturer-detail', kwargs={'pk': manufacturer.pk})
  1208. # python_class is a property returning the script class; patch it to return our bad-Meta class so validate_meta
  1209. # (a classmethod on it) is exercised the way production reads it.
  1210. with patch.object(Script, 'python_class', new_callable=PropertyMock) as mock:
  1211. mock.return_value = BadMetaScript
  1212. with self.captureOnCommitCallbacks(execute=True):
  1213. with self.assertLogs('netbox.events_processor', 'ERROR') as captured:
  1214. response = self.client.patch(url, {'description': 'updated'}, format='json', **self.header)
  1215. # The triggering object change succeeds despite the misconfigured script
  1216. self.assertHttpStatus(response, status.HTTP_200_OK)
  1217. manufacturer.refresh_from_db()
  1218. self.assertEqual(manufacturer.description, 'updated')
  1219. # No script job was enqueued (nothing queued, no Job record), and the misconfiguration was logged
  1220. self.assertEqual(self.queue.count, 0)
  1221. self.assertEqual(Job.objects.filter(name=BadMetaScript.Meta.name).count(), 0)
  1222. self.assertTrue(any('Bad Meta Script Rule' in line for line in captured.output))
  1223. @tag('regression') # Issue #22852
  1224. def test_eventrule_script_action_honors_script_defaults(self):
  1225. """A script run from an event rule uses the notification policy and job timeout from its Meta class."""
  1226. class DummyScript(ScriptBase):
  1227. class Meta:
  1228. name = 'Dummy Defaults Script'
  1229. notifications_default = JobNotificationChoices.NOTIFICATION_ON_FAILURE
  1230. job_timeout = 600
  1231. def run(self, data, commit=True):
  1232. return 'finished successfully'
  1233. dummy_script = DummyScript()
  1234. with patch.object(ScriptModule, 'sync_classes'):
  1235. module = ScriptModule.objects.create(
  1236. file_root=ManagedFileRootPathChoices.SCRIPTS,
  1237. file_path='dummy_defaults_script.py',
  1238. )
  1239. script = Script.objects.create(
  1240. module=module,
  1241. name=dummy_script.name,
  1242. is_executable=True,
  1243. )
  1244. event_rule = EventRule.objects.create(
  1245. name='Test Script Defaults Event Rule',
  1246. event_types=[OBJECT_CREATED],
  1247. action_type=EventRuleActionChoices.SCRIPT,
  1248. action_object_type=ObjectType.objects.get_for_model(Script),
  1249. action_object_id=script.pk,
  1250. )
  1251. event_rule.object_types.set([ObjectType.objects.get_for_model(DeviceType)])
  1252. manufacturer = Manufacturer.objects.create(name='Test Manufacturer', slug='test-manufacturer')
  1253. self.add_permissions('dcim.add_devicetype')
  1254. with patch.object(Script, 'python_class') as mock:
  1255. mock.return_value = dummy_script
  1256. with self.captureOnCommitCallbacks(execute=True):
  1257. response = self.client.post(
  1258. reverse('dcim-api:devicetype-list'),
  1259. {
  1260. 'manufacturer': manufacturer.pk,
  1261. 'model': 'Test DeviceType',
  1262. 'slug': 'test-devicetype',
  1263. },
  1264. format='json',
  1265. **self.header,
  1266. )
  1267. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  1268. self.assertEqual(self.queue.count, 1)
  1269. self.assertEqual(self.queue.jobs[0].timeout, 600)
  1270. script_job = Job.objects.get(name=dummy_script.name)
  1271. self.assertEqual(script_job.notifications, JobNotificationChoices.NOTIFICATION_ON_FAILURE)
  1272. # silence rqworker (cleaner output) and trigger job execution
  1273. rq_logger = logging.getLogger('rq.worker')
  1274. self.addCleanup(rq_logger.setLevel, rq_logger.level)
  1275. rq_logger.setLevel(logging.ERROR)
  1276. self.run_rq_jobs('default')
  1277. script_job.refresh_from_db()
  1278. self.assertEqual(script_job.status, "completed")
  1279. self.assertFalse(
  1280. Notification.objects.filter(
  1281. user=self.user,
  1282. object_type=ObjectType.objects.get_for_model(Job),
  1283. object_id=script_job.pk,
  1284. ).exists()
  1285. )
  1286. @tag('regression')
  1287. def test_eventrule_webhook_action_with_object_image_files(self):
  1288. """
  1289. Verify that a Webhook event-rule action can be enqueued and executed cleanly when
  1290. the triggering object carries uploaded files (e.g. DeviceType images).
  1291. This is a regression test for issue #20873.
  1292. """
  1293. # Create an event rule that triggers on DeviceType update with Script action
  1294. webhook = Webhook.objects.get(name='Webhook 1')
  1295. webhook_type = ObjectType.objects.get_for_model(Webhook)
  1296. devicetype_type = ObjectType.objects.get_for_model(DeviceType)
  1297. event_rule = EventRule.objects.create(
  1298. name='Test Webhook Event Rule with Files',
  1299. event_types=[OBJECT_UPDATED],
  1300. action_type=EventRuleActionChoices.WEBHOOK,
  1301. action_object_type=webhook_type,
  1302. action_object_id=webhook.pk,
  1303. )
  1304. event_rule.object_types.set([devicetype_type])
  1305. # Create a manufacturer and DeviceType
  1306. manufacturer = Manufacturer.objects.create(
  1307. name='Test Manufacturer',
  1308. slug='test-manufacturer',
  1309. )
  1310. devicetype = DeviceType.objects.create(
  1311. model='Test DeviceType',
  1312. slug="test-devicetype",
  1313. manufacturer=manufacturer,
  1314. )
  1315. # Create an image file
  1316. image = BytesIO()
  1317. Image.new('RGB', (1, 1)).save(image, format='PNG')
  1318. image.name = 'test_image.png'
  1319. image.seek(0)
  1320. # PATCH the DeviceType via REST API to add the image
  1321. data = {
  1322. 'front_image': image,
  1323. }
  1324. url = reverse('dcim-api:devicetype-detail', kwargs={'pk': devicetype.pk})
  1325. self.add_permissions('dcim.change_devicetype')
  1326. response = self.client.patch(url, data, format='multipart', **self.header)
  1327. self.assertHttpStatus(response, status.HTTP_200_OK)
  1328. # Assert that the webhook job was enqueued cleanly
  1329. self.assertEqual(self.queue.count, 1)
  1330. job = self.queue.jobs[0]
  1331. self.assertEqual(job.kwargs['event_rule'], event_rule)
  1332. self.assertEqual(job.kwargs['event_type'], OBJECT_UPDATED)
  1333. def test_unregistered_action_type_does_not_block_other_rules(self):
  1334. """
  1335. An unregistered action_type must not block other EventRules for the same event. Kept on
  1336. this class, not a separate RQQueueTestMixin one, since two such classes in different
  1337. `--parallel` subsuites cross-flush each other's Redis queue.
  1338. """
  1339. site_type = ObjectType.objects.get_for_model(Site)
  1340. webhook = Webhook.objects.create(name='Dispatch Test Webhook', payload_url='http://localhost:9000/')
  1341. webhook_type = ObjectType.objects.get_for_model(Webhook)
  1342. good_rule = EventRule.objects.create(
  1343. name='Good Rule',
  1344. event_types=[OBJECT_CREATED],
  1345. action_type=EventRuleActionChoices.WEBHOOK,
  1346. action_object_type=webhook_type,
  1347. action_object_id=webhook.pk,
  1348. )
  1349. good_rule.object_types.set([site_type])
  1350. bad_rule = EventRule.objects.create(
  1351. name='Bad Rule',
  1352. event_types=[OBJECT_CREATED],
  1353. action_type='someplugin.not_installed',
  1354. )
  1355. bad_rule.object_types.set([site_type])
  1356. url = reverse('dcim-api:site-list')
  1357. self.add_permissions('dcim.add_site')
  1358. with self.assertLogs('netbox.events_processor', level='WARNING') as cm:
  1359. response = self.client.post(
  1360. url, {'name': 'Dispatch Site', 'slug': 'dispatch-site'}, format='json', **self.header
  1361. )
  1362. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  1363. self.assertTrue(any('someplugin.not_installed' in message for message in cm.output))
  1364. # The good rule's webhook must still have been enqueued despite the bad rule.
  1365. rule_jobs = [j for j in self.queue.jobs if j.kwargs['event_rule'] == good_rule]
  1366. self.assertEqual(len(rule_jobs), 1)
  1367. def test_raising_enqueue_does_not_block_other_rules(self):
  1368. """A raising action registered as plugin-provided (the default) must not block other rules."""
  1369. register_event_rule_action(DummyRaisingAction)
  1370. self.addCleanup(registry['event_rule_actions'].pop, DummyRaisingAction.slug, None)
  1371. site_type = ObjectType.objects.get_for_model(Site)
  1372. webhook = Webhook.objects.create(name='Dispatch Test Webhook 2', payload_url='http://localhost:9000/')
  1373. webhook_type = ObjectType.objects.get_for_model(Webhook)
  1374. good_rule = EventRule.objects.create(
  1375. name='Good Rule 2',
  1376. event_types=[OBJECT_CREATED],
  1377. action_type=EventRuleActionChoices.WEBHOOK,
  1378. action_object_type=webhook_type,
  1379. action_object_id=webhook.pk,
  1380. )
  1381. good_rule.object_types.set([site_type])
  1382. raising_rule = EventRule.objects.create(
  1383. name='Raising Rule',
  1384. event_types=[OBJECT_CREATED],
  1385. action_type=DummyRaisingAction.slug,
  1386. )
  1387. raising_rule.object_types.set([site_type])
  1388. url = reverse('dcim-api:site-list')
  1389. self.add_permissions('dcim.add_site')
  1390. with self.assertLogs('netbox.events_processor', level='ERROR') as cm:
  1391. response = self.client.post(
  1392. url, {'name': 'Dispatch Site 2', 'slug': 'dispatch-site-2'}, format='json', **self.header
  1393. )
  1394. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  1395. self.assertTrue(any('Raising Rule' in message for message in cm.output))
  1396. # The good rule's webhook must still have been enqueued despite the raising rule.
  1397. rule_jobs = [j for j in self.queue.jobs if j.kwargs['event_rule'] == good_rule]
  1398. self.assertEqual(len(rule_jobs), 1)
  1399. def test_raising_action_registered_as_non_plugin_propagates(self):
  1400. """A raising action registered with is_plugin_provided=False (as core actions are) must propagate."""
  1401. class RaisingCoreLikeAction(EventRuleAction):
  1402. slug = 'test.raising_core_like_action'
  1403. label = 'Raising Core-Like Action'
  1404. object_required = False
  1405. def enqueue(self, **kwargs):
  1406. raise RuntimeError("intentional failure for test")
  1407. register_event_rule_action(RaisingCoreLikeAction, is_plugin_provided=False)
  1408. self.addCleanup(registry['event_rule_actions'].pop, 'test.raising_core_like_action', None)
  1409. site_type = ObjectType.objects.get_for_model(Site)
  1410. rule = EventRule.objects.create(
  1411. name='Raising Core-Like Rule',
  1412. event_types=[OBJECT_CREATED],
  1413. action_type='test.raising_core_like_action',
  1414. )
  1415. rule.object_types.set([site_type])
  1416. with self.assertRaises(RuntimeError):
  1417. process_event_rules([rule], object_type=site_type, event={'data': {}, 'event_type': OBJECT_CREATED})
  1418. class EventRuleActionRegistrationTestCase(TestCase):
  1419. """
  1420. Unit tests for the EventRuleAction registry (netbox.event_rules).
  1421. """
  1422. def tearDown(self):
  1423. super().tearDown()
  1424. # The registry is a global dict; test-registered actions must not leak into other tests.
  1425. for slug in ('test.dummy_action', 'test.duplicate_action'):
  1426. registry['event_rule_actions'].pop(slug, None)
  1427. def test_register_event_rule_action(self):
  1428. class DummyAction(EventRuleAction):
  1429. slug = 'test.dummy_action'
  1430. label = 'Dummy Action'
  1431. description = 'A dummy action for testing'
  1432. register_event_rule_action(DummyAction)
  1433. action = get_event_rule_action('test.dummy_action')
  1434. self.assertIsInstance(action, DummyAction)
  1435. choices = {choice.value: choice.label for choice in get_event_rule_action_choices()}
  1436. self.assertEqual(choices.get('test.dummy_action'), 'Dummy Action')
  1437. def test_register_event_rule_action_as_decorator(self):
  1438. @register_event_rule_action
  1439. class DummyAction(EventRuleAction):
  1440. slug = 'test.dummy_action'
  1441. label = 'Dummy Action'
  1442. self.assertIsInstance(get_event_rule_action('test.dummy_action'), DummyAction)
  1443. def test_duplicate_slug_raises(self):
  1444. class FirstAction(EventRuleAction):
  1445. slug = 'test.duplicate_action'
  1446. label = 'First'
  1447. class SecondAction(EventRuleAction):
  1448. slug = 'test.duplicate_action'
  1449. label = 'Second'
  1450. register_event_rule_action(FirstAction)
  1451. with self.assertRaises(ImproperlyConfigured):
  1452. register_event_rule_action(SecondAction)
  1453. def test_slug_starting_with_digit_rejected(self):
  1454. """A slug starting with a digit would sanitize into a GraphQL-invalid enum member name."""
  1455. class DigitSlugAction(EventRuleAction):
  1456. slug = '2fa.notify'
  1457. label = 'Digit Slug Action'
  1458. with self.assertRaises(ImproperlyConfigured):
  1459. register_event_rule_action(DigitSlugAction)
  1460. self.assertIsNone(get_event_rule_action('2fa.notify'))
  1461. def test_slug_with_hyphen_rejected(self):
  1462. """Hyphens are not permitted, though plugin distribution names conventionally use them."""
  1463. class HyphenSlugAction(EventRuleAction):
  1464. slug = 'my-plugin.open_ticket'
  1465. label = 'Hyphen Slug Action'
  1466. with self.assertRaises(ImproperlyConfigured):
  1467. register_event_rule_action(HyphenSlugAction)
  1468. self.assertIsNone(get_event_rule_action('my-plugin.open_ticket'))
  1469. def test_slug_with_leading_underscore_rejected(self):
  1470. """A leading underscore sanitizes into a "__"-prefixed name, which GraphQL reserves for introspection."""
  1471. class LeadingUnderscoreAction(EventRuleAction):
  1472. slug = '_internal.foo'
  1473. label = 'Leading Underscore Action'
  1474. with self.assertRaises(ImproperlyConfigured):
  1475. register_event_rule_action(LeadingUnderscoreAction)
  1476. self.assertIsNone(get_event_rule_action('_internal.foo'))
  1477. def test_slug_with_uppercase_rejected(self):
  1478. """Slugs must be lowercase, though plugin/class names conventionally are not."""
  1479. class UppercaseSlugAction(EventRuleAction):
  1480. slug = 'MyPlugin.action'
  1481. label = 'Uppercase Slug Action'
  1482. with self.assertRaises(ImproperlyConfigured):
  1483. register_event_rule_action(UppercaseSlugAction)
  1484. self.assertIsNone(get_event_rule_action('MyPlugin.action'))
  1485. def test_slug_enum_key_collision_rejected(self):
  1486. """Two distinct slugs that sanitize to the same GraphQL enum member name must not both register."""
  1487. class DotAction(EventRuleAction):
  1488. slug = 'test.collision_action'
  1489. label = 'Dot Action'
  1490. class UnderscoreAction(EventRuleAction):
  1491. slug = 'test_collision_action'
  1492. label = 'Underscore Action'
  1493. register_event_rule_action(DotAction)
  1494. self.addCleanup(registry['event_rule_actions'].pop, 'test.collision_action', None)
  1495. with self.assertRaises(ImproperlyConfigured):
  1496. register_event_rule_action(UnderscoreAction)
  1497. self.assertIsNone(get_event_rule_action('test_collision_action'))
  1498. def test_missing_slug_raises_at_registration(self):
  1499. # Class definition itself must succeed; only registration checks slug/label.
  1500. class NoSlugAction(EventRuleAction):
  1501. label = 'No Slug'
  1502. with self.assertRaises(ImproperlyConfigured):
  1503. register_event_rule_action(NoSlugAction)
  1504. def test_missing_label_raises_at_registration(self):
  1505. class NoLabelAction(EventRuleAction):
  1506. slug = 'test.no_label'
  1507. with self.assertRaises(ImproperlyConfigured):
  1508. register_event_rule_action(NoLabelAction)
  1509. def test_intermediate_base_class_without_slug_or_label_is_definable(self):
  1510. """
  1511. slug/label are checked at registration, not class definition, so several concrete actions
  1512. can share an intermediate base class which sets neither.
  1513. """
  1514. class PluginActionBase(EventRuleAction):
  1515. object_required = False
  1516. def enqueue(self, **kwargs):
  1517. pass
  1518. class ConcreteAction(PluginActionBase):
  1519. slug = 'test.intermediate_base_concrete_action'
  1520. label = 'Concrete Action'
  1521. register_event_rule_action(ConcreteAction)
  1522. self.addCleanup(registry['event_rule_actions'].pop, 'test.intermediate_base_concrete_action', None)
  1523. self.assertIsInstance(get_event_rule_action('test.intermediate_base_concrete_action'), ConcreteAction)
  1524. def test_unregistered_slug_returns_none(self):
  1525. self.assertIsNone(get_event_rule_action('this.does.not.exist'))
  1526. def test_core_actions_are_registered(self):
  1527. """WebhookAction/ScriptAction/NotificationAction are registered at app startup."""
  1528. core_slugs = (
  1529. EventRuleActionChoices.WEBHOOK, EventRuleActionChoices.SCRIPT, EventRuleActionChoices.NOTIFICATION,
  1530. )
  1531. for slug in core_slugs:
  1532. self.assertIsNotNone(get_event_rule_action(slug))
  1533. def test_get_object_queryset_returns_none_without_object_model(self):
  1534. action = EventRuleAction()
  1535. self.assertIsNone(action.get_object_queryset())
  1536. def test_internal_validate_requires_object_when_object_required(self):
  1537. action = EventRuleAction()
  1538. action.object_required = True
  1539. with self.assertRaises(ValidationError):
  1540. action._validate(action_object=None, action_data={})
  1541. def test_internal_validate_passes_when_object_not_required(self):
  1542. action = EventRuleAction()
  1543. action.object_required = False
  1544. # Must not raise
  1545. action._validate(action_object=None, action_data={})
  1546. def test_internal_validate_rejects_wrong_object_type(self):
  1547. action = EventRuleAction()
  1548. action.object_model = Webhook
  1549. action.object_required = True
  1550. site = Site(name='Not A Webhook')
  1551. with self.assertRaises(ValidationError):
  1552. action._validate(action_object=site, action_data={})
  1553. def test_internal_validate_rejects_object_for_action_without_object_model(self):
  1554. """An action which declares no object_model must reject a target object outright."""
  1555. action = EventRuleAction()
  1556. with self.assertRaises(ValidationError):
  1557. action._validate(action_object=Webhook(), action_data={})
  1558. def test_object_required_without_object_model_rejected_at_registration(self):
  1559. """object_required with no object_model could never be satisfied, so it's caught early."""
  1560. class ImpossibleAction(EventRuleAction):
  1561. slug = 'test.impossible_action'
  1562. label = 'Impossible Action'
  1563. object_required = True
  1564. with self.assertRaises(ImproperlyConfigured):
  1565. register_event_rule_action(ImpossibleAction)
  1566. self.assertIsNone(get_event_rule_action('test.impossible_action'))
  1567. def test_get_object_label_defaults_to_object_model_verbose_name(self):
  1568. """The object picker's label defaults to the model's verbose name, capitalized."""
  1569. self.assertEqual(get_event_rule_action(EventRuleActionChoices.NOTIFICATION).get_object_label(),
  1570. 'Notification group')
  1571. self.assertEqual(get_event_rule_action(EventRuleActionChoices.WEBHOOK).get_object_label(), 'Webhook')
  1572. def test_get_object_label_honors_explicit_override(self):
  1573. class LabeledAction(EventRuleAction):
  1574. object_model = Webhook
  1575. object_label = 'Destination'
  1576. self.assertEqual(LabeledAction().get_object_label(), 'Destination')
  1577. def test_get_object_label_is_none_without_object_model(self):
  1578. self.assertIsNone(EventRuleAction().get_object_label())
  1579. def test_validate_is_noop_by_default(self):
  1580. action = EventRuleAction()
  1581. # Must not raise
  1582. action.validate(action_object=None, action_data={})
  1583. def test_validate_override_does_not_need_super(self):
  1584. """A subclass overriding validate() gets the base object_required check for free, no super() needed."""
  1585. class CustomValidatingAction(EventRuleAction):
  1586. slug = 'test.custom_validating_action'
  1587. label = 'Custom Validating Action'
  1588. object_model = Webhook
  1589. object_required = True
  1590. def validate(self, *, action_object, action_data):
  1591. if action_data.get('bad'):
  1592. raise ValidationError({'action_data': 'bad action_data for test'})
  1593. action = CustomValidatingAction()
  1594. # The subclass's own check fires
  1595. with self.assertRaises(ValidationError):
  1596. action._validate(action_object=Webhook(), action_data={'bad': True})
  1597. # ...as does the base object_required check
  1598. with self.assertRaises(ValidationError):
  1599. action._validate(action_object=None, action_data={})
  1600. action._validate(action_object=Webhook(), action_data={}) # must not raise
  1601. def test_enqueue_not_implemented_by_default(self):
  1602. action = EventRuleAction()
  1603. with self.assertRaises(NotImplementedError):
  1604. action.enqueue(event_rule=None, event_context={}, action_object=None, action_data={})
  1605. def test_is_plugin_provided_defaults_true_before_registration(self):
  1606. """is_plugin_provided is True on an instance that never goes through registration."""
  1607. self.assertTrue(EventRuleAction().is_plugin_provided)
  1608. class EventRuleActionAvailabilityTestCase(TestCase):
  1609. """
  1610. An EventRule with an unregistered action_type must remain loadable, skip gracefully during
  1611. processing, and display as "unavailable" -- but reject full_clean() until action_type changes.
  1612. """
  1613. @classmethod
  1614. def setUpTestData(cls):
  1615. site_type = ObjectType.objects.get_for_model(Site)
  1616. webhook = Webhook.objects.create(name='Availability Test Webhook', payload_url='http://localhost:9000/')
  1617. webhook_type = ObjectType.objects.get_for_model(Webhook)
  1618. cls.healthy_rule = EventRule.objects.create(
  1619. name='Healthy Rule',
  1620. event_types=[OBJECT_CREATED],
  1621. action_type=EventRuleActionChoices.WEBHOOK,
  1622. action_object_type=webhook_type,
  1623. action_object_id=webhook.pk,
  1624. )
  1625. cls.healthy_rule.object_types.set([site_type])
  1626. # .objects.create() calls save(), not full_clean(), so an unregistered action_type can be
  1627. # persisted directly, matching the state of a row whose providing plugin was uninstalled.
  1628. cls.unavailable_rule = EventRule.objects.create(
  1629. name='Unavailable Rule',
  1630. event_types=[OBJECT_CREATED],
  1631. action_type='someplugin.not_installed',
  1632. )
  1633. cls.unavailable_rule.object_types.set([site_type])
  1634. def test_action_is_available_true_for_registered_action(self):
  1635. self.assertTrue(self.healthy_rule.action_is_available)
  1636. self.assertIsNotNone(self.healthy_rule.action_provider)
  1637. def test_action_is_available_false_for_unregistered_action(self):
  1638. self.assertFalse(self.unavailable_rule.action_is_available)
  1639. self.assertIsNone(self.unavailable_rule.action_provider)
  1640. def test_get_action_type_display_for_registered_action(self):
  1641. self.assertEqual(self.healthy_rule.get_action_type_display(), 'Webhook')
  1642. def test_get_action_type_display_for_unregistered_action(self):
  1643. self.assertEqual(
  1644. self.unavailable_rule.get_action_type_display(),
  1645. 'someplugin.not_installed (unavailable)',
  1646. )
  1647. def test_get_action_type_color_for_registered_action(self):
  1648. self.assertIsNone(self.healthy_rule.get_action_type_color())
  1649. def test_get_action_type_color_for_unregistered_action(self):
  1650. self.assertEqual(self.unavailable_rule.get_action_type_color(), 'red')
  1651. def test_clean_rejects_unchanged_unavailable_action_type(self):
  1652. """A persisted-but-unavailable action_type is rejected by full_clean() even when left unchanged."""
  1653. rule = EventRule.objects.get(pk=self.unavailable_rule.pk)
  1654. rule.enabled = False
  1655. with self.assertRaises(ValidationError):
  1656. rule.full_clean()
  1657. def test_clean_rejects_new_row_with_unregistered_action_type(self):
  1658. rule = EventRule(
  1659. name='New Unregistered Rule',
  1660. event_types=[OBJECT_CREATED],
  1661. action_type='someplugin.also_not_installed',
  1662. )
  1663. with self.assertRaises(ValidationError):
  1664. rule.full_clean()
  1665. def test_clean_rejects_changing_to_unregistered_action_type(self):
  1666. rule = EventRule.objects.get(pk=self.healthy_rule.pk)
  1667. rule.action_type = 'someplugin.newly_unregistered'
  1668. with self.assertRaises(ValidationError):
  1669. rule.full_clean()
  1670. def test_clean_accepts_registered_action_with_valid_object(self):
  1671. rule = EventRule.objects.get(pk=self.healthy_rule.pk)
  1672. rule.full_clean() # must not raise
  1673. class EventRuleNoObjectActionTestCase(TestCase):
  1674. """
  1675. Model-layer tests for an EventRuleAction which declares object_model=None (no target object).
  1676. """
  1677. def tearDown(self):
  1678. super().tearDown()
  1679. registry['event_rule_actions'].pop('test.model_no_object_action', None)
  1680. def test_full_clean_and_save_with_no_object_action(self):
  1681. class NoObjectAction(EventRuleAction):
  1682. slug = 'test.model_no_object_action'
  1683. label = 'Model No-Object Action'
  1684. object_required = False
  1685. register_event_rule_action(NoObjectAction)
  1686. site_type = ObjectType.objects.get_for_model(Site)
  1687. rule = EventRule(
  1688. name='Model No-Object Rule',
  1689. event_types=[OBJECT_CREATED],
  1690. action_type='test.model_no_object_action',
  1691. )
  1692. rule.full_clean() # must not raise: no action_object required or supplied
  1693. rule.save()
  1694. rule.object_types.set([site_type])
  1695. rule.refresh_from_db()
  1696. self.assertIsNone(rule.action_object_type)
  1697. self.assertIsNone(rule.action_object_id)
  1698. self.assertIsNone(rule.action_object)
  1699. class WebhookRenderHeadersTest(TestCase):
  1700. def test_render_headers(self):
  1701. """Basic header rendering with Jinja2 interpolation."""
  1702. webhook = Webhook(
  1703. name='Webhook 1',
  1704. payload_url='http://localhost:9000/',
  1705. additional_headers='X-Foo: Bar\nX-Object: {{ data.name }}',
  1706. )
  1707. headers = webhook.render_headers({'data': {'name': 'Site 1'}})
  1708. self.assertEqual(headers, {'X-Foo': 'Bar', 'X-Object': 'Site 1'})
  1709. def test_render_headers_multiline_block(self):
  1710. """A multi-line Jinja2 block (e.g. a loop generating headers) must render against the full template."""
  1711. webhook = Webhook(
  1712. name='Webhook 1',
  1713. payload_url='http://localhost:9000/',
  1714. additional_headers=(
  1715. '{% for k, v in data.headers.items() %}X-{{ k }}: {{ v }}\n'
  1716. '{% endfor %}'
  1717. ),
  1718. )
  1719. headers = webhook.render_headers({'data': {'headers': {'Foo': '1', 'Bar': '2'}}})
  1720. self.assertEqual(headers, {'X-Foo': '1', 'X-Bar': '2'})
  1721. def test_render_headers_skips_blank_lines(self):
  1722. """Blank lines in the rendered output (e.g. from Jinja2 block tags) must be skipped, not raise."""
  1723. webhook = Webhook(
  1724. name='Webhook 1',
  1725. payload_url='http://localhost:9000/',
  1726. # Block tags on their own lines leave behind blank lines once rendered
  1727. additional_headers=(
  1728. '{% for k, v in data.headers.items() %}\n'
  1729. 'X-{{ k }}: {{ v }}\n'
  1730. '{% endfor %}'
  1731. ),
  1732. )
  1733. headers = webhook.render_headers({'data': {'headers': {'Foo': '1', 'Bar': '2'}}})
  1734. self.assertEqual(headers, {'X-Foo': '1', 'X-Bar': '2'})
  1735. def test_render_headers_skips_lines_without_separator(self):
  1736. """A non-blank line lacking a 'Name: Value' separator must be skipped, not raise."""
  1737. webhook = Webhook(
  1738. name='Webhook 1',
  1739. payload_url='http://localhost:9000/',
  1740. additional_headers='X-Foo: Bar\nthis line has no colon\nX-Baz: Qux',
  1741. )
  1742. headers = webhook.render_headers({})
  1743. self.assertEqual(headers, {'X-Foo': 'Bar', 'X-Baz': 'Qux'})
  1744. def test_render_headers_header_safe_filter_available(self):
  1745. """
  1746. The `header_safe` filter must be available when rendering headers, and must strip control characters
  1747. (including CR/LF) so that untrusted data cannot smuggle additional headers via CR/LF injection.
  1748. """
  1749. webhook = Webhook(
  1750. name='Webhook 1',
  1751. payload_url='http://localhost:9000/',
  1752. additional_headers='X-Object: {{ data.name | header_safe }}',
  1753. )
  1754. headers = webhook.render_headers({'data': {'name': 'legit\r\nX-Injected: evil\x00'}})
  1755. # The injected newline is stripped, so only a single (sanitized) header is produced
  1756. self.assertEqual(list(headers.keys()), ['X-Object'])
  1757. self.assertNotIn('X-Injected', headers)
  1758. self.assertEqual(headers['X-Object'], 'legitX-Injected: evil')