2
0

test_forms.py 82 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912
  1. import tempfile
  2. from unittest.mock import patch
  3. from django import forms
  4. from django.template.loader import render_to_string
  5. from django.test import TestCase, override_settings
  6. from circuits.models import CircuitTermination
  7. from dcim.choices import (
  8. CableEndChoices,
  9. CableProfileChoices,
  10. DeviceFaceChoices,
  11. DeviceStatusChoices,
  12. InterfaceModeChoices,
  13. InterfaceTypeChoices,
  14. LinkStatusChoices,
  15. PortTypeChoices,
  16. PowerOutletStatusChoices,
  17. VirtualDeviceContextStatusChoices,
  18. )
  19. from dcim.forms import *
  20. from dcim.models import *
  21. from dcim.tests.test_module_moves import fail_after
  22. from ipam.models import ASN, RIR, VLAN
  23. from utilities.exceptions import AbortRequest
  24. from utilities.forms.rendering import M2MAddRemoveFields
  25. from utilities.testing import create_test_device, create_test_image
  26. from virtualization.models import Cluster, ClusterGroup, ClusterType
  27. def get_id(model, slug):
  28. return model.objects.get(slug=slug).id
  29. class PowerOutletFormTestCase(TestCase):
  30. @classmethod
  31. def setUpTestData(cls):
  32. cls.site = site = Site.objects.create(name='Site 1', slug='site-1')
  33. cls.manufacturer = manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1')
  34. cls.role = role = DeviceRole.objects.create(
  35. name='Device Role 1', slug='device-role-1', color='ff0000'
  36. )
  37. cls.device_type = device_type = DeviceType.objects.create(
  38. manufacturer=manufacturer, model='Device Type 1', slug='device-type-1', u_height=1
  39. )
  40. cls.rack = rack = Rack.objects.create(name='Rack 1', site=site)
  41. cls.device = Device.objects.create(
  42. name='Device 1', device_type=device_type, role=role, site=site, rack=rack, position=1
  43. )
  44. def test_status_is_required(self):
  45. form = PowerOutletForm(data={
  46. 'device': self.device,
  47. 'module': None,
  48. 'name': 'New Enabled Outlet',
  49. })
  50. self.assertFalse(form.is_valid())
  51. self.assertIn('status', form.errors)
  52. def test_status_must_be_defined_choice(self):
  53. form = PowerOutletForm(data={
  54. 'device': self.device,
  55. 'module': None,
  56. 'name': 'New Enabled Outlet',
  57. 'status': 'this isn\'t a defined choice',
  58. })
  59. self.assertFalse(form.is_valid())
  60. self.assertIn('status', form.errors)
  61. self.assertTrue(form.errors['status'][-1].startswith('Select a valid choice.'))
  62. def test_status_recognizes_choices(self):
  63. for index, choice in enumerate(PowerOutletStatusChoices.CHOICES):
  64. form = PowerOutletForm(data={
  65. 'device': self.device,
  66. 'module': None,
  67. 'name': f'New Enabled Outlet {index + 1}',
  68. 'status': choice[0],
  69. })
  70. self.assertEqual({}, form.errors)
  71. self.assertTrue(form.is_valid())
  72. instance = form.save()
  73. self.assertEqual(instance.status, choice[0])
  74. class DeviceTestCase(TestCase):
  75. @classmethod
  76. def setUpTestData(cls):
  77. site = Site.objects.create(name='Site 1', slug='site-1')
  78. rack = Rack.objects.create(name='Rack 1', site=site)
  79. manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1')
  80. device_type = DeviceType.objects.create(
  81. manufacturer=manufacturer, model='Device Type 1', slug='device-type-1', u_height=1
  82. )
  83. role = DeviceRole.objects.create(
  84. name='Device Role 1', slug='device-role-1', color='ff0000'
  85. )
  86. Platform.objects.create(name='Platform 1', slug='platform-1')
  87. Device.objects.create(
  88. name='Device 1', device_type=device_type, role=role, site=site, rack=rack, position=1
  89. )
  90. cluster_type = ClusterType.objects.create(name='Cluster Type 1', slug='cluster-type-1')
  91. cluster_group = ClusterGroup.objects.create(name='Cluster Group 1', slug='cluster-group-1')
  92. Cluster.objects.create(name='Cluster 1', type=cluster_type, group=cluster_group)
  93. def test_racked_device(self):
  94. form = DeviceForm(data={
  95. 'name': 'New Device',
  96. 'role': DeviceRole.objects.first().pk,
  97. 'tenant': None,
  98. 'manufacturer': Manufacturer.objects.first().pk,
  99. 'device_type': DeviceType.objects.first().pk,
  100. 'site': Site.objects.first().pk,
  101. 'rack': Rack.objects.first().pk,
  102. 'face': DeviceFaceChoices.FACE_FRONT,
  103. 'position': 2,
  104. 'platform': Platform.objects.first().pk,
  105. 'status': DeviceStatusChoices.STATUS_ACTIVE,
  106. })
  107. self.assertTrue(form.is_valid())
  108. self.assertTrue(form.save())
  109. def test_replicate_components(self):
  110. device_type = DeviceType.objects.first()
  111. InterfaceTemplate.objects.create(device_type=device_type, name='eth0', type='1000base-t')
  112. data = {
  113. 'role': DeviceRole.objects.first().pk,
  114. 'device_type': device_type.pk,
  115. 'site': Site.objects.first().pk,
  116. 'status': DeviceStatusChoices.STATUS_ACTIVE,
  117. }
  118. form = DeviceForm(data={**data, 'name': 'Device 2', 'replicate_components': True})
  119. self.assertTrue(form.is_valid(), form.errors)
  120. self.assertTrue(form.save().interfaces.filter(name='eth0').exists())
  121. form = DeviceForm(data={**data, 'name': 'Device 3', 'replicate_components': False})
  122. self.assertTrue(form.is_valid(), form.errors)
  123. self.assertFalse(form.save().interfaces.exists())
  124. # The replicate_components field is not available when editing an existing device
  125. form = DeviceForm(instance=Device.objects.get(name='Device 1'))
  126. self.assertNotIn('replicate_components', form.fields)
  127. def test_import_replicate_components(self):
  128. device_type = DeviceType.objects.first()
  129. InterfaceTemplate.objects.create(device_type=device_type, name='eth0', type='1000base-t')
  130. data = {
  131. 'role': DeviceRole.objects.first().name,
  132. 'manufacturer': device_type.manufacturer.name,
  133. 'device_type': device_type.model,
  134. 'site': Site.objects.first().name,
  135. 'status': DeviceStatusChoices.STATUS_ACTIVE,
  136. }
  137. # Components are replicated by default
  138. form = DeviceImportForm(data={**data, 'name': 'Device 2'})
  139. self.assertTrue(form.is_valid(), form.errors)
  140. self.assertTrue(form.save().interfaces.filter(name='eth0').exists())
  141. # A blank value (e.g. an empty CSV cell) is treated as omitted
  142. for i, value in enumerate(('', None), start=4):
  143. form = DeviceImportForm(data={**data, 'name': f'Device {i}', 'replicate_components': value})
  144. self.assertTrue(form.is_valid(), form.errors)
  145. self.assertTrue(form.save().interfaces.filter(name='eth0').exists())
  146. form = DeviceImportForm(data={**data, 'name': 'Device 3', 'replicate_components': 'false'})
  147. self.assertTrue(form.is_valid(), form.errors)
  148. self.assertFalse(form.save().interfaces.exists())
  149. def test_racked_device_occupied(self):
  150. form = DeviceForm(data={
  151. 'name': 'test',
  152. 'role': DeviceRole.objects.first().pk,
  153. 'tenant': None,
  154. 'manufacturer': Manufacturer.objects.first().pk,
  155. 'device_type': DeviceType.objects.first().pk,
  156. 'site': Site.objects.first().pk,
  157. 'rack': Rack.objects.first().pk,
  158. 'face': DeviceFaceChoices.FACE_FRONT,
  159. 'position': 1,
  160. 'platform': Platform.objects.first().pk,
  161. 'status': DeviceStatusChoices.STATUS_ACTIVE,
  162. })
  163. self.assertFalse(form.is_valid())
  164. self.assertIn('position', form.errors)
  165. def test_non_racked_device(self):
  166. form = DeviceForm(data={
  167. 'name': 'New Device',
  168. 'role': DeviceRole.objects.first().pk,
  169. 'tenant': None,
  170. 'manufacturer': Manufacturer.objects.first().pk,
  171. 'device_type': DeviceType.objects.first().pk,
  172. 'site': Site.objects.first().pk,
  173. 'rack': None,
  174. 'face': None,
  175. 'position': None,
  176. 'platform': Platform.objects.first().pk,
  177. 'status': DeviceStatusChoices.STATUS_ACTIVE,
  178. })
  179. self.assertTrue(form.is_valid())
  180. self.assertTrue(form.save())
  181. def test_vc_member_removal_blocked_by_cross_chassis_lag(self):
  182. device1 = Device.objects.get(name='Device 1')
  183. device2 = Device.objects.create(
  184. name='Device 2', device_type=device1.device_type, role=device1.role, site=device1.site
  185. )
  186. vc = VirtualChassis.objects.create(name='VC 1', master=device1)
  187. Device.objects.filter(pk=device1.pk).update(virtual_chassis=vc, vc_position=1)
  188. Device.objects.filter(pk=device2.pk).update(virtual_chassis=vc, vc_position=2)
  189. lag = Interface.objects.create(device=device1, name='lag0', type=InterfaceTypeChoices.TYPE_LAG)
  190. Interface.objects.create(device=device2, name='eth0', type=InterfaceTypeChoices.TYPE_1GE_FIXED, lag=lag)
  191. device2.refresh_from_db()
  192. form = DeviceForm(instance=device2, data={
  193. 'name': device2.name,
  194. 'role': device2.role.pk,
  195. 'device_type': device2.device_type.pk,
  196. 'site': device2.site.pk,
  197. 'status': DeviceStatusChoices.STATUS_ACTIVE,
  198. 'virtual_chassis': None,
  199. 'vc_position': None,
  200. })
  201. self.assertFalse(form.is_valid())
  202. self.assertIn('virtual_chassis', form.errors)
  203. def test_non_racked_device_with_face(self):
  204. form = DeviceForm(data={
  205. 'name': 'New Device',
  206. 'role': DeviceRole.objects.first().pk,
  207. 'tenant': None,
  208. 'manufacturer': Manufacturer.objects.first().pk,
  209. 'device_type': DeviceType.objects.first().pk,
  210. 'site': Site.objects.first().pk,
  211. 'rack': None,
  212. 'face': DeviceFaceChoices.FACE_REAR,
  213. 'platform': None,
  214. 'status': DeviceStatusChoices.STATUS_ACTIVE,
  215. })
  216. self.assertFalse(form.is_valid())
  217. self.assertIn('face', form.errors)
  218. def test_non_racked_device_with_position(self):
  219. form = DeviceForm(data={
  220. 'name': 'New Device',
  221. 'role': DeviceRole.objects.first().pk,
  222. 'tenant': None,
  223. 'manufacturer': Manufacturer.objects.first().pk,
  224. 'device_type': DeviceType.objects.first().pk,
  225. 'site': Site.objects.first().pk,
  226. 'rack': None,
  227. 'position': 10,
  228. 'platform': None,
  229. 'status': DeviceStatusChoices.STATUS_ACTIVE,
  230. })
  231. self.assertFalse(form.is_valid())
  232. self.assertIn('position', form.errors)
  233. class ModuleTypeFormTestCase(TestCase):
  234. @classmethod
  235. def setUpTestData(cls):
  236. cls.manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1')
  237. cls.profile = ModuleTypeProfile.objects.create(
  238. name='Module Type Profile 1',
  239. schema={
  240. 'properties': {
  241. 'media': {
  242. 'title': 'Media',
  243. 'type': 'array',
  244. 'items': {
  245. 'type': 'string',
  246. 'enum': ['copper', 'sfp', 'qsfp28'],
  247. },
  248. },
  249. },
  250. },
  251. )
  252. def test_upload_and_clear_images(self):
  253. """
  254. Upload images through the form, then clear the front image, which should delete only its file.
  255. """
  256. data = {
  257. 'manufacturer': self.manufacturer.pk,
  258. 'model': 'Module Type 1',
  259. 'profile': self.profile.pk,
  260. 'attr_media': ['copper', 'qsfp28'],
  261. }
  262. form = ModuleTypeForm(data=data, files={
  263. 'front_image': create_test_image('front.png'),
  264. 'rear_image': create_test_image('rear.png'),
  265. })
  266. # A profile change re-renders only the profile-attributes fieldset, which must not hold a picked file
  267. profile_fieldset = next(fieldset for fieldset in form.fieldsets if fieldset.html_id == 'profile-attributes')
  268. self.assertNotIn('front_image', profile_fieldset.items)
  269. self.assertNotIn('rear_image', profile_fieldset.items)
  270. self.assertTrue(form.is_multipart())
  271. with (
  272. tempfile.TemporaryDirectory() as media_root,
  273. override_settings(MEDIA_ROOT=media_root),
  274. patch('utilities.forms.fields.dynamic.get_action_url', return_value='/'),
  275. ):
  276. self.assertTrue(form.is_valid(), form.errors)
  277. module_type = form.save()
  278. front_image_name = module_type.front_image.name
  279. rear_image_name = module_type.rear_image.name
  280. storage = module_type.front_image.storage
  281. self.assertTrue(storage.exists(front_image_name))
  282. self.assertTrue(storage.exists(rear_image_name))
  283. self.assertEqual(module_type.attribute_data, {'media': ['copper', 'qsfp28']})
  284. form = ModuleTypeForm(data={**data, 'front_image-clear': True}, instance=module_type)
  285. self.assertTrue(form.is_valid(), form.errors)
  286. with self.captureOnCommitCallbacks(execute=True):
  287. form.save()
  288. module_type.refresh_from_db()
  289. self.assertFalse(module_type.front_image)
  290. self.assertEqual(module_type.rear_image.name, rear_image_name)
  291. self.assertFalse(storage.exists(front_image_name))
  292. self.assertTrue(storage.exists(rear_image_name))
  293. self.assertEqual(module_type.attribute_data, {'media': ['copper', 'qsfp28']})
  294. def test_enum_array_attribute_uses_multiselect_field(self):
  295. form = ModuleTypeForm(data={
  296. 'manufacturer': self.manufacturer.pk,
  297. 'model': 'Module Type 1',
  298. 'profile': self.profile.pk,
  299. 'attr_media': ['copper', 'qsfp28'],
  300. })
  301. self.assertIsInstance(form.fields['attr_media'], forms.MultipleChoiceField)
  302. self.assertEqual(
  303. list(form.fields['attr_media'].choices),
  304. [
  305. ('copper', 'copper'),
  306. ('sfp', 'sfp'),
  307. ('qsfp28', 'qsfp28'),
  308. ],
  309. )
  310. with patch('utilities.forms.fields.dynamic.get_action_url', return_value='/'):
  311. self.assertTrue(form.is_valid(), form.errors)
  312. module_type = form.save()
  313. self.assertEqual(module_type.attribute_data, {'media': ['copper', 'qsfp28']})
  314. def test_zero_bound_attribute_is_enforced_by_the_form(self):
  315. profile = ModuleTypeProfile.objects.create(
  316. name='Module Type Profile 2',
  317. schema={
  318. 'properties': {
  319. 'offset': {
  320. 'title': 'Offset',
  321. 'type': 'number',
  322. 'minimum': 0,
  323. 'maximum': 0,
  324. },
  325. },
  326. },
  327. )
  328. form = ModuleTypeForm(data={
  329. 'manufacturer': self.manufacturer.pk,
  330. 'model': 'Module Type 2',
  331. 'profile': profile.pk,
  332. 'attr_offset': -5,
  333. })
  334. self.assertEqual(form.fields['attr_offset'].min_value, 0)
  335. self.assertEqual(form.fields['attr_offset'].max_value, 0)
  336. with patch('utilities.forms.fields.dynamic.get_action_url', return_value='/'):
  337. self.assertFalse(form.is_valid())
  338. self.assertIn('attr_offset', form.errors)
  339. def test_numeric_enum_attribute_is_saved_as_a_number(self):
  340. profile = ModuleTypeProfile.objects.create(
  341. name='Module Type Profile 3',
  342. schema={
  343. 'properties': {
  344. 'slots': {
  345. 'title': 'Slots',
  346. 'type': 'integer',
  347. 'enum': [0, 1, 2],
  348. },
  349. },
  350. },
  351. )
  352. for value in (0, 1):
  353. with self.subTest(value=value):
  354. form = ModuleTypeForm(data={
  355. 'manufacturer': self.manufacturer.pk,
  356. 'model': f'Module Type {value}',
  357. 'profile': profile.pk,
  358. 'attr_slots': str(value),
  359. })
  360. with patch('utilities.forms.fields.dynamic.get_action_url', return_value='/'):
  361. self.assertTrue(form.is_valid(), form.errors)
  362. module_type = form.save()
  363. self.assertEqual(module_type.attribute_data, {'slots': value})
  364. class ModuleTypeProfileDescriptionRenderingTestCase(TestCase):
  365. """
  366. A profile schema property's description is rendered as the attribute field's help text via the
  367. `safe` filter, so markup outside HTML_ALLOWED_TAGS must not reach the DOM as a live element.
  368. Verified end to end because the sanitization and the `safe` filter that makes it necessary sit
  369. in different layers.
  370. """
  371. @classmethod
  372. def setUpTestData(cls):
  373. cls.manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1')
  374. cls.profile = ModuleTypeProfile.objects.create(
  375. name='Disk',
  376. schema={
  377. 'properties': {
  378. 'capacity': {
  379. 'type': 'integer',
  380. 'title': 'Capacity (GB)',
  381. 'description': 'Gross disk size <iframe src="https://example.com"></iframe>',
  382. },
  383. },
  384. },
  385. )
  386. def test_help_text_is_rendered_without_disallowed_markup(self):
  387. form = ModuleTypeForm(data={
  388. 'manufacturer': self.manufacturer.pk,
  389. 'model': 'Module Type 1',
  390. 'profile': self.profile.pk,
  391. 'attr_capacity': 500,
  392. })
  393. rendered = render_to_string('form_helpers/render_field.html', {'field': form['attr_capacity']})
  394. self.assertInHTML(
  395. '<span class="form-text" id="id_attr_capacity_helptext">'
  396. '<div class="rendered-markdown"><p>Gross disk size</p></div></span>',
  397. rendered,
  398. )
  399. class ModuleBayTemplateImportFormTestCase(TestCase):
  400. def test_module_bay_types_prefers_manufacturer_specific_match_over_global(self):
  401. """A name shared by a global and a manufacturer-scoped type resolves to the scoped one."""
  402. manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1')
  403. global_type = ModuleBayType.objects.create(name='SFP28', slug='sfp28-global')
  404. scoped_type = ModuleBayType.objects.create(
  405. name='SFP28', slug='sfp28-scoped', manufacturer=manufacturer,
  406. )
  407. device_type = DeviceType.objects.create(
  408. manufacturer=manufacturer, model='Device Type 1', slug='device-type-1',
  409. )
  410. form = ModuleBayTemplateImportForm({
  411. 'device_type': device_type.pk,
  412. 'name': 'Module Bay 1',
  413. 'module_bay_types': ['SFP28'],
  414. })
  415. self.assertTrue(form.is_valid(), form.errors)
  416. module_bay_template = form.save()
  417. self.assertEqual(
  418. list(module_bay_template.module_bay_types.all()), [scoped_type],
  419. )
  420. self.assertNotIn(global_type, module_bay_template.module_bay_types.all())
  421. def test_module_bay_types_unknown_name_raises_error(self):
  422. device_type = DeviceType.objects.create(
  423. manufacturer=Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1'),
  424. model='Device Type 1',
  425. slug='device-type-1',
  426. )
  427. form = ModuleBayTemplateImportForm({
  428. 'device_type': device_type.pk,
  429. 'name': 'Module Bay 1',
  430. 'module_bay_types': ['Nonexistent'],
  431. })
  432. self.assertFalse(form.is_valid())
  433. self.assertEqual(
  434. form.errors.as_data()['module_bay_types'][0].code, 'invalid_choice',
  435. )
  436. def test_module_bay_types_prefers_manufacturer_specific_match_over_global_for_module_type(self):
  437. """Same disambiguation, but for a module bay template nested under a ModuleType."""
  438. manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1')
  439. global_type = ModuleBayType.objects.create(name='SFP28', slug='sfp28-global')
  440. scoped_type = ModuleBayType.objects.create(
  441. name='SFP28', slug='sfp28-scoped', manufacturer=manufacturer,
  442. )
  443. module_type = ModuleType.objects.create(manufacturer=manufacturer, model='Module Type 1')
  444. form = ModuleBayTemplateImportForm({
  445. 'module_type': module_type.pk,
  446. 'name': 'Module Bay 1',
  447. 'module_bay_types': ['SFP28'],
  448. })
  449. self.assertTrue(form.is_valid(), form.errors)
  450. module_bay_template = form.save()
  451. self.assertEqual(
  452. list(module_bay_template.module_bay_types.all()), [scoped_type],
  453. )
  454. self.assertNotIn(global_type, module_bay_template.module_bay_types.all())
  455. def test_enabled_honors_explicit_false(self):
  456. device_type = DeviceType.objects.create(
  457. manufacturer=Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1'),
  458. model='Device Type 1',
  459. slug='device-type-1',
  460. )
  461. form = ModuleBayTemplateImportForm({
  462. 'device_type': device_type.pk,
  463. 'name': 'Module Bay 1',
  464. 'enabled': False,
  465. })
  466. self.assertTrue(form.is_valid(), form.errors)
  467. self.assertFalse(form.save().enabled)
  468. def test_import_export_round_trip_preserves_module_bay_types(self):
  469. """to_yaml() then re-import through this form preserves module bay types."""
  470. manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1')
  471. bay_type_a = ModuleBayType.objects.create(name='SFP28', slug='sfp28')
  472. bay_type_b = ModuleBayType.objects.create(name='QSFP28', slug='qsfp28')
  473. device_type = DeviceType.objects.create(
  474. manufacturer=manufacturer, model='Device Type 1', slug='device-type-1',
  475. )
  476. original = ModuleBayTemplate.objects.create(device_type=device_type, name='Module Bay 1')
  477. original.module_bay_types.set([bay_type_a, bay_type_b])
  478. exported = original.to_yaml()
  479. form = ModuleBayTemplateImportForm({
  480. 'device_type': device_type.pk,
  481. 'name': 'Module Bay 2',
  482. 'module_bay_types': exported['module_bay_types'],
  483. })
  484. self.assertTrue(form.is_valid(), form.errors)
  485. reimported = form.save()
  486. self.assertEqual(
  487. set(reimported.module_bay_types.values_list('name', flat=True)),
  488. set(original.module_bay_types.values_list('name', flat=True)),
  489. )
  490. def test_module_bay_types_name_belonging_only_to_other_manufacturers_is_unresolvable(self):
  491. """
  492. A name that exists only for manufacturers other than the device type's own (and isn't
  493. global) must not resolve at all -- module_bay_types is scoped to the device type's own
  494. manufacturer plus global types, with no cross-manufacturer fallback.
  495. """
  496. juniper = Manufacturer.objects.create(name='Juniper', slug='juniper')
  497. cisco = Manufacturer.objects.create(name='Cisco', slug='cisco')
  498. ModuleBayType.objects.create(name='SFP28', slug='sfp28-cisco', manufacturer=cisco)
  499. device_type = DeviceType.objects.create(
  500. manufacturer=juniper, model='Juniper Device Type', slug='juniper-device-type',
  501. )
  502. form = ModuleBayTemplateImportForm({
  503. 'device_type': device_type.pk,
  504. 'name': 'Module Bay 1',
  505. 'module_bay_types': ['SFP28'],
  506. })
  507. self.assertFalse(form.is_valid())
  508. self.assertEqual(
  509. form.errors.as_data()['module_bay_types'][0].code, 'invalid_choice',
  510. )
  511. def test_module_bay_types_resolution_is_independent_of_field_order(self):
  512. """
  513. Resolution must not depend on the parent type having been cleaned first, so declaring
  514. module_bay_types ahead of device_type/module_type must not change the outcome.
  515. """
  516. class ReorderedImportForm(ModuleBayTemplateImportForm):
  517. class Meta(ModuleBayTemplateImportForm.Meta):
  518. fields = [
  519. 'module_bay_types', 'device_type', 'module_type', 'name', 'label', 'position',
  520. 'enabled', 'description',
  521. ]
  522. self.assertEqual(list(ReorderedImportForm().fields)[0], 'module_bay_types')
  523. juniper = Manufacturer.objects.create(name='Juniper', slug='juniper')
  524. cisco = Manufacturer.objects.create(name='Cisco', slug='cisco')
  525. global_type = ModuleBayType.objects.create(name='SFP28', slug='sfp28-global')
  526. juniper_type = ModuleBayType.objects.create(name='SFP28', slug='sfp28-juniper', manufacturer=juniper)
  527. cisco_type = ModuleBayType.objects.create(name='QSFP28', slug='qsfp28-cisco', manufacturer=cisco)
  528. device_type = DeviceType.objects.create(
  529. manufacturer=juniper, model='Juniper Device Type', slug='juniper-device-type',
  530. )
  531. # The device type's own manufacturer still wins over the global type of the same name
  532. form = ReorderedImportForm({
  533. 'device_type': device_type.pk,
  534. 'name': 'Module Bay 1',
  535. 'module_bay_types': ['SFP28'],
  536. })
  537. self.assertTrue(form.is_valid(), form.errors)
  538. module_bay_template = form.save()
  539. self.assertEqual(list(module_bay_template.module_bay_types.all()), [juniper_type])
  540. self.assertNotIn(global_type, module_bay_template.module_bay_types.all())
  541. # ...and another manufacturer's bay type is still rejected rather than resolved to
  542. form = ReorderedImportForm({
  543. 'device_type': device_type.pk,
  544. 'name': 'Module Bay 2',
  545. 'module_bay_types': [cisco_type.name],
  546. })
  547. self.assertFalse(form.is_valid())
  548. self.assertEqual(
  549. form.errors.as_data()['module_bay_types'][0].code, 'invalid_choice',
  550. )
  551. class ModuleFormTestCase(TestCase):
  552. @classmethod
  553. def setUpTestData(cls):
  554. cls.device = create_test_device('Module Form Device A')
  555. cls.device_b = create_test_device('Module Form Device B')
  556. cls.bay_a = ModuleBay.objects.create(device=cls.device, name='Bay A')
  557. cls.bay_b = ModuleBay.objects.create(device=cls.device, name='Bay B')
  558. cls.bay_c = ModuleBay.objects.create(device=cls.device_b, name='Bay C')
  559. manufacturer = Manufacturer.objects.create(
  560. name='Module Form Manufacturer', slug='module-form-manufacturer'
  561. )
  562. cls.module_type = ModuleType.objects.create(manufacturer=manufacturer, model='Module Form Type')
  563. cls.module = Module.objects.create(
  564. device=cls.device, module_bay=cls.bay_a, module_type=cls.module_type
  565. )
  566. def test_module_device_is_editable_on_edit(self):
  567. form = ModuleForm(instance=self.module)
  568. self.assertFalse(form.fields['device'].disabled)
  569. self.assertTrue(form.fields['replicate_components'].disabled)
  570. self.assertTrue(form.fields['adopt_components'].disabled)
  571. def test_module_form_moves_module_to_empty_bay(self):
  572. form = ModuleForm(
  573. data={
  574. 'device': self.device.pk,
  575. 'module_bay': self.bay_b.pk,
  576. 'module_type': self.module_type.pk,
  577. 'status': 'active',
  578. },
  579. instance=self.module,
  580. )
  581. self.assertTrue(form.is_valid(), form.errors)
  582. form.save()
  583. self.module.refresh_from_db()
  584. self.assertEqual(self.module.module_bay, self.bay_b)
  585. def test_module_form_rejects_occupied_bay(self):
  586. Module.objects.create(device=self.device, module_bay=self.bay_b, module_type=self.module_type)
  587. form = ModuleForm(
  588. data={
  589. 'device': self.device.pk,
  590. 'module_bay': self.bay_b.pk,
  591. 'module_type': self.module_type.pk,
  592. 'status': 'active',
  593. },
  594. instance=self.module,
  595. )
  596. self.assertFalse(form.is_valid())
  597. self.assertIn('module_bay', form.errors)
  598. def test_module_form_moves_module_to_different_device(self):
  599. interface = Interface.objects.create(
  600. device=self.device, module=self.module, name='eth0', type=InterfaceTypeChoices.TYPE_1GE_FIXED
  601. )
  602. form = ModuleForm(
  603. data={
  604. 'device': self.device_b.pk,
  605. 'module_bay': self.bay_c.pk,
  606. 'module_type': self.module_type.pk,
  607. 'status': 'active',
  608. },
  609. instance=self.module,
  610. )
  611. self.assertTrue(form.is_valid(), form.errors)
  612. form.save()
  613. self.module.refresh_from_db()
  614. self.assertEqual(self.module.device, self.device_b)
  615. self.assertEqual(self.module.module_bay, self.bay_c)
  616. interface.refresh_from_db()
  617. self.assertEqual(interface.device, self.device_b)
  618. def test_module_create_into_cyclic_hierarchy_is_rejected(self):
  619. # CREATE into a cyclic hierarchy (bypassing clean() via .update()) must be a form error.
  620. other_module = Module.objects.create(
  621. device=self.device, module_bay=self.bay_b, module_type=self.module_type
  622. )
  623. child_bay_1 = ModuleBay.objects.create(device=self.device, module=self.module, name='Child Bay 1')
  624. child_bay_2 = ModuleBay.objects.create(device=self.device, module=other_module, name='Child Bay 2')
  625. Module.objects.filter(pk=self.module.pk).update(module_bay=child_bay_2)
  626. Module.objects.filter(pk=other_module.pk).update(module_bay=child_bay_1)
  627. form = ModuleForm(
  628. data={
  629. 'device': self.device.pk,
  630. 'module_bay': child_bay_1.pk,
  631. 'module_type': self.module_type.pk,
  632. 'status': 'active',
  633. 'replicate_components': True,
  634. },
  635. )
  636. with fail_after(15):
  637. self.assertFalse(form.is_valid())
  638. self.assertIn('contains a cycle', str(form.errors))
  639. def test_module_form_reports_conflicting_cooling_component(self):
  640. """
  641. A cooling component name collision must surface as a form error rather than an
  642. IntegrityError raised from the replication insert. See netbox#15289.
  643. """
  644. cooled_type = ModuleType.objects.create(
  645. manufacturer=self.module_type.manufacturer, model='Cooled Form Type'
  646. )
  647. CoolingIntakeTemplate.objects.create(module_type=cooled_type, name='Intake 1')
  648. CoolingOutflowTemplate.objects.create(module_type=cooled_type, name='Outflow 1')
  649. CoolingIntake.objects.create(device=self.device, name='Intake 1')
  650. form = ModuleForm(
  651. data={
  652. 'device': self.device.pk,
  653. 'module_bay': self.bay_b.pk,
  654. 'module_type': cooled_type.pk,
  655. 'status': 'active',
  656. 'replicate_components': True,
  657. },
  658. )
  659. self.assertFalse(form.is_valid())
  660. self.assertIn('Intake 1', str(form.errors))
  661. def test_module_form_adopts_existing_cooling_component(self):
  662. cooled_type = ModuleType.objects.create(
  663. manufacturer=self.module_type.manufacturer, model='Adoptable Cooled Type'
  664. )
  665. CoolingIntakeTemplate.objects.create(module_type=cooled_type, name='Intake 1')
  666. intake = CoolingIntake.objects.create(device=self.device, name='Intake 1')
  667. form = ModuleForm(
  668. data={
  669. 'device': self.device.pk,
  670. 'module_bay': self.bay_b.pk,
  671. 'module_type': cooled_type.pk,
  672. 'status': 'active',
  673. 'replicate_components': True,
  674. 'adopt_components': True,
  675. },
  676. )
  677. self.assertTrue(form.is_valid(), form.errors)
  678. module = form.save()
  679. intake.refresh_from_db()
  680. self.assertEqual(intake.module, module)
  681. def test_module_form_rejects_module_token_without_bay_position(self):
  682. """Replication and adoption reject a {module} token in any resolved field when the bay has no position."""
  683. interface_type = InterfaceTypeChoices.TYPE_1GE_FIXED
  684. templates = (
  685. (InterfaceTemplate, {'name': 'eth{module}', 'type': interface_type}),
  686. (InterfaceTemplate, {'name': 'eth0', 'label': 'Port {module}', 'type': interface_type}),
  687. (ModuleBayTemplate, {'name': 'Bay {module}'}),
  688. (ModuleBayTemplate, {'name': 'Bay', 'label': 'Bay {module}'}),
  689. (ModuleBayTemplate, {'name': 'Bay', 'position': '{module}'}),
  690. )
  691. for i, (template_model, attrs) in enumerate(templates, start=1):
  692. module_type = ModuleType.objects.create(
  693. manufacturer=self.module_type.manufacturer, model=f'Token No-Position Form Type {i}'
  694. )
  695. template_model.objects.create(module_type=module_type, **attrs)
  696. for flags in ({'replicate_components': True}, {'adopt_components': True}):
  697. with self.subTest(template=template_model.__name__, attrs=attrs, flags=flags):
  698. form = ModuleForm(data={
  699. 'device': self.device.pk,
  700. 'module_bay': self.bay_b.pk,
  701. 'module_type': module_type.pk,
  702. 'status': 'active',
  703. **flags,
  704. })
  705. self.assertFalse(form.is_valid())
  706. self.assertIn('no position defined', str(form.errors))
  707. def test_module_form_rejects_module_token_depth_mismatch(self):
  708. """Replication and adoption reject more {module} tokens in a resolved field than the bay depth."""
  709. module_bay = ModuleBay.objects.create(device=self.device, name='Bay D', position='1')
  710. interface_type = InterfaceTypeChoices.TYPE_1GE_FIXED
  711. tokens = '{module}/{module}'
  712. templates = (
  713. (InterfaceTemplate, {'name': f'eth{tokens}', 'type': interface_type}),
  714. (InterfaceTemplate, {'name': 'eth0', 'label': tokens, 'type': interface_type}),
  715. (ModuleBayTemplate, {'name': tokens}),
  716. (ModuleBayTemplate, {'name': 'Bay', 'label': tokens}),
  717. (ModuleBayTemplate, {'name': 'Bay', 'position': tokens}),
  718. )
  719. for i, (template_model, attrs) in enumerate(templates, start=1):
  720. module_type = ModuleType.objects.create(
  721. manufacturer=self.module_type.manufacturer, model=f'Token Depth Form Type {i}'
  722. )
  723. template_model.objects.create(module_type=module_type, **attrs)
  724. for flags in ({'replicate_components': True}, {'adopt_components': True}):
  725. with self.subTest(template=template_model.__name__, attrs=attrs, flags=flags):
  726. form = ModuleForm(data={
  727. 'device': self.device.pk,
  728. 'module_bay': module_bay.pk,
  729. 'module_type': module_type.pk,
  730. 'status': 'active',
  731. **flags,
  732. })
  733. self.assertFalse(form.is_valid())
  734. self.assertIn('2 placeholders given', str(form.errors))
  735. def test_module_form_adopt_only_creates_no_components(self):
  736. """Adoption without replication adopts matching components and creates no others."""
  737. adopt_type = ModuleType.objects.create(
  738. manufacturer=self.module_type.manufacturer, model='Adopt Only Form Type'
  739. )
  740. InterfaceTemplate.objects.create(module_type=adopt_type, name='eth0', type=InterfaceTypeChoices.TYPE_1GE_FIXED)
  741. InterfaceTemplate.objects.create(module_type=adopt_type, name='eth1', type=InterfaceTypeChoices.TYPE_1GE_FIXED)
  742. interface = Interface.objects.create(
  743. device=self.device, name='eth0', type=InterfaceTypeChoices.TYPE_1GE_FIXED
  744. )
  745. form = ModuleForm(data={
  746. 'device': self.device.pk,
  747. 'module_bay': self.bay_b.pk,
  748. 'module_type': adopt_type.pk,
  749. 'status': 'active',
  750. 'adopt_components': True,
  751. })
  752. self.assertTrue(form.is_valid(), form.errors)
  753. module = form.save()
  754. interface.refresh_from_db()
  755. self.assertEqual(interface.module, module)
  756. self.assertFalse(self.device.interfaces.filter(name='eth1').exists())
  757. def test_module_form_adopt_only_rejects_component_of_another_module(self):
  758. """Adoption without replication refuses a component that already belongs to another module."""
  759. adopt_type = ModuleType.objects.create(
  760. manufacturer=self.module_type.manufacturer, model='Owned Adopt Form Type'
  761. )
  762. InterfaceTemplate.objects.create(module_type=adopt_type, name='eth0', type=InterfaceTypeChoices.TYPE_1GE_FIXED)
  763. Interface.objects.create(
  764. device=self.device, module=self.module, name='eth0', type=InterfaceTypeChoices.TYPE_1GE_FIXED
  765. )
  766. form = ModuleForm(data={
  767. 'device': self.device.pk,
  768. 'module_bay': self.bay_b.pk,
  769. 'module_type': adopt_type.pk,
  770. 'status': 'active',
  771. 'adopt_components': True,
  772. })
  773. self.assertFalse(form.is_valid())
  774. self.assertIn('already belongs to a module', str(form.errors))
  775. def test_module_form_skips_template_checks_without_component_operations(self):
  776. """Without replication or adoption, templates are neither checked nor instantiated."""
  777. token_type = ModuleType.objects.create(
  778. manufacturer=self.module_type.manufacturer, model='No Operations Form Type'
  779. )
  780. InterfaceTemplate.objects.create(
  781. module_type=token_type, name='eth0', label='Port {module}', type=InterfaceTypeChoices.TYPE_1GE_FIXED
  782. )
  783. form = ModuleForm(data={
  784. 'device': self.device.pk,
  785. 'module_bay': self.bay_b.pk,
  786. 'module_type': token_type.pk,
  787. 'status': 'active',
  788. })
  789. self.assertTrue(form.is_valid(), form.errors)
  790. module = form.save()
  791. self.assertFalse(module.interfaces.exists())
  792. def test_module_import_form_rejects_module_token_without_bay_position(self):
  793. """Bulk import applies the module form's placeholder checks."""
  794. token_type = ModuleType.objects.create(
  795. manufacturer=self.module_type.manufacturer, model='Token Import Type'
  796. )
  797. InterfaceTemplate.objects.create(
  798. module_type=token_type, name='eth0', label='Port {module}', type=InterfaceTypeChoices.TYPE_1GE_FIXED
  799. )
  800. form = ModuleImportForm(data={
  801. 'device': self.device.name,
  802. 'module_bay': self.bay_b.name,
  803. 'module_type': token_type.model,
  804. 'status': 'active',
  805. })
  806. self.assertFalse(form.is_valid())
  807. self.assertIn('no position defined', str(form.errors))
  808. class VCPositionTokenFormTestCase(TestCase):
  809. @classmethod
  810. def setUpTestData(cls):
  811. Site.objects.create(name='Site VC 1', slug='site-vc-1')
  812. manufacturer = Manufacturer.objects.create(name='Manufacturer VC 1', slug='manufacturer-vc-1')
  813. device_type = DeviceType.objects.create(
  814. manufacturer=manufacturer, model='Device Type VC 1', slug='device-type-vc-1'
  815. )
  816. DeviceRole.objects.create(name='Device Role VC 1', slug='device-role-vc-1', color='ff0000')
  817. InterfaceTemplate.objects.create(
  818. device_type=device_type,
  819. name='ge-{vc_position:0}/0/0',
  820. type='1000base-t',
  821. )
  822. VirtualChassis.objects.create(name='VC 1')
  823. def test_device_creation_in_vc_resolves_vc_position(self):
  824. form = DeviceForm(data={
  825. 'name': 'Device VC Form 1',
  826. 'role': DeviceRole.objects.first().pk,
  827. 'tenant': None,
  828. 'manufacturer': Manufacturer.objects.first().pk,
  829. 'device_type': DeviceType.objects.first().pk,
  830. 'site': Site.objects.first().pk,
  831. 'rack': None,
  832. 'face': None,
  833. 'position': None,
  834. 'platform': None,
  835. 'status': DeviceStatusChoices.STATUS_ACTIVE,
  836. 'replicate_components': True,
  837. 'virtual_chassis': VirtualChassis.objects.first().pk,
  838. 'vc_position': 2,
  839. })
  840. self.assertTrue(form.is_valid())
  841. device = form.save()
  842. self.assertTrue(device.interfaces.filter(name='ge-2/0/0').exists())
  843. def test_device_creation_not_in_vc_uses_fallback(self):
  844. form = DeviceForm(data={
  845. 'name': 'Device VC Form 2',
  846. 'role': DeviceRole.objects.first().pk,
  847. 'tenant': None,
  848. 'manufacturer': Manufacturer.objects.first().pk,
  849. 'device_type': DeviceType.objects.first().pk,
  850. 'site': Site.objects.first().pk,
  851. 'rack': None,
  852. 'face': None,
  853. 'position': None,
  854. 'platform': None,
  855. 'status': DeviceStatusChoices.STATUS_ACTIVE,
  856. 'replicate_components': True,
  857. })
  858. self.assertTrue(form.is_valid())
  859. device = form.save()
  860. self.assertTrue(device.interfaces.filter(name='ge-0/0/0').exists())
  861. def test_device_creation_duplicate_name_conflict(self):
  862. # With conflict
  863. device_type = DeviceType.objects.first()
  864. # to generate conflicts create an interface that will exist
  865. InterfaceTemplate.objects.create(
  866. device_type=device_type,
  867. name='ge-0/0/0',
  868. type='1000base-t',
  869. )
  870. form = DeviceForm(data={
  871. 'name': 'Device VC Form 3',
  872. 'role': DeviceRole.objects.first().pk,
  873. 'tenant': None,
  874. 'manufacturer': Manufacturer.objects.first().pk,
  875. 'device_type': device_type.pk,
  876. 'site': Site.objects.first().pk,
  877. 'rack': None,
  878. 'face': None,
  879. 'position': None,
  880. 'platform': None,
  881. 'status': DeviceStatusChoices.STATUS_ACTIVE,
  882. 'replicate_components': True,
  883. })
  884. self.assertTrue(form.is_valid())
  885. with self.assertRaises(AbortRequest):
  886. form.save()
  887. class FrontPortTestCase(TestCase):
  888. @classmethod
  889. def setUpTestData(cls):
  890. cls.device = create_test_device('Panel Device 1')
  891. cls.rear_ports = (
  892. RearPort(name='RearPort1', device=cls.device, type=PortTypeChoices.TYPE_8P8C),
  893. RearPort(name='RearPort2', device=cls.device, type=PortTypeChoices.TYPE_8P8C),
  894. RearPort(name='RearPort3', device=cls.device, type=PortTypeChoices.TYPE_8P8C),
  895. RearPort(name='RearPort4', device=cls.device, type=PortTypeChoices.TYPE_8P8C),
  896. )
  897. RearPort.objects.bulk_create(cls.rear_ports)
  898. cls.rear_port_templates = (
  899. RearPortTemplate(name='RearPort1', device_type=cls.device.device_type, type=PortTypeChoices.TYPE_8P8C),
  900. RearPortTemplate(name='RearPort2', device_type=cls.device.device_type, type=PortTypeChoices.TYPE_8P8C),
  901. RearPortTemplate(name='RearPort3', device_type=cls.device.device_type, type=PortTypeChoices.TYPE_8P8C),
  902. RearPortTemplate(name='RearPort4', device_type=cls.device.device_type, type=PortTypeChoices.TYPE_8P8C),
  903. )
  904. RearPortTemplate.objects.bulk_create(cls.rear_port_templates)
  905. def test_front_port_label_count_valid(self):
  906. """
  907. Test that generating an equal number of names and labels passes form validation.
  908. """
  909. front_port_data = {
  910. 'device': self.device.pk,
  911. 'name': 'FrontPort[1-4]',
  912. 'label': 'Port[1-4]',
  913. 'type': PortTypeChoices.TYPE_8P8C,
  914. 'positions': 1,
  915. 'rear_ports': [f'{rear_port.pk}:1' for rear_port in self.rear_ports],
  916. }
  917. form = FrontPortCreateForm(front_port_data)
  918. self.assertTrue(form.is_valid())
  919. def test_front_port_label_count_mismatch(self):
  920. """
  921. Check that attempting to generate a differing number of names and labels results in a validation error.
  922. """
  923. bad_front_port_data = {
  924. 'device': self.device.pk,
  925. 'name': 'FrontPort[1-4]',
  926. 'label': 'Port[1-2]',
  927. 'type': PortTypeChoices.TYPE_8P8C,
  928. 'positions': 1,
  929. 'rear_ports': [f'{rear_port.pk}:1' for rear_port in self.rear_ports],
  930. }
  931. form = FrontPortCreateForm(bad_front_port_data)
  932. self.assertFalse(form.is_valid())
  933. self.assertIn('label', form.errors)
  934. def test_front_port_position_count_valid(self):
  935. """
  936. Test that generating front ports with multiple positions each passes form validation.
  937. """
  938. front_port_data = {
  939. 'device': self.device.pk,
  940. 'name': 'FrontPort[1-2]',
  941. 'type': PortTypeChoices.TYPE_8P8C,
  942. 'positions': 2,
  943. 'rear_ports': [f'{rear_port.pk}:1' for rear_port in self.rear_ports],
  944. }
  945. form = FrontPortCreateForm(front_port_data)
  946. self.assertTrue(form.is_valid(), form.errors)
  947. def test_front_port_position_count_mismatch(self):
  948. """
  949. Check that the mismatch error reports the total number of front port positions, not the port count.
  950. """
  951. bad_front_port_data = {
  952. 'device': self.device.pk,
  953. 'name': 'FrontPort[1-2]',
  954. 'type': PortTypeChoices.TYPE_8P8C,
  955. 'positions': 2,
  956. 'rear_ports': [f'{rear_port.pk}:1' for rear_port in self.rear_ports[:2]],
  957. }
  958. form = FrontPortCreateForm(bad_front_port_data)
  959. self.assertFalse(form.is_valid())
  960. self.assertIn(
  961. 'The total number of front port positions (4) must match the selected number of rear port '
  962. 'positions (2).',
  963. form.errors['rear_ports']
  964. )
  965. def test_front_port_template_position_count_mismatch(self):
  966. """
  967. Check that the front port template form reports the same corrected position total.
  968. """
  969. bad_front_port_template_data = {
  970. 'device_type': self.device.device_type.pk,
  971. 'name': 'FrontPort[1-2]',
  972. 'type': PortTypeChoices.TYPE_8P8C,
  973. 'positions': 2,
  974. 'rear_ports': [f'{rear_port_template.pk}:1' for rear_port_template in self.rear_port_templates[:2]],
  975. }
  976. form = FrontPortTemplateCreateForm(bad_front_port_template_data)
  977. self.assertFalse(form.is_valid())
  978. self.assertIn(
  979. 'The total number of front port positions (4) must match the selected number of rear port '
  980. 'positions (2).',
  981. form.errors['rear_ports']
  982. )
  983. def test_front_port_missing_rear_ports(self):
  984. """
  985. Check that omitting the rear port selection reports a field error rather than raising an exception.
  986. """
  987. bad_front_port_data = {
  988. 'device': self.device.pk,
  989. 'name': 'FrontPort[1-2]',
  990. 'type': PortTypeChoices.TYPE_8P8C,
  991. 'positions': 1,
  992. }
  993. form = FrontPortCreateForm(bad_front_port_data)
  994. self.assertFalse(form.is_valid())
  995. self.assertIn('rear_ports', form.errors)
  996. def test_front_port_invalid_positions(self):
  997. """
  998. Check that a non-numeric position count reports a field error rather than raising an exception.
  999. """
  1000. bad_front_port_data = {
  1001. 'device': self.device.pk,
  1002. 'name': 'FrontPort[1-2]',
  1003. 'type': PortTypeChoices.TYPE_8P8C,
  1004. 'positions': 'two',
  1005. 'rear_ports': [f'{rear_port.pk}:1' for rear_port in self.rear_ports[:2]],
  1006. }
  1007. form = FrontPortCreateForm(bad_front_port_data)
  1008. self.assertFalse(form.is_valid())
  1009. self.assertIn('positions', form.errors)
  1010. def test_front_port_template_missing_rear_ports(self):
  1011. """
  1012. Check that the front port template form also reports a field error rather than raising an exception.
  1013. """
  1014. bad_front_port_template_data = {
  1015. 'device_type': self.device.device_type.pk,
  1016. 'name': 'FrontPort[1-2]',
  1017. 'type': PortTypeChoices.TYPE_8P8C,
  1018. 'positions': 1,
  1019. }
  1020. form = FrontPortTemplateCreateForm(bad_front_port_template_data)
  1021. self.assertFalse(form.is_valid())
  1022. self.assertIn('rear_ports', form.errors)
  1023. def test_front_port_invalid_label_range(self):
  1024. """
  1025. Check that an inverted label range reports a field error rather than raising an exception.
  1026. """
  1027. bad_front_port_data = {
  1028. 'device': self.device.pk,
  1029. 'name': 'FrontPort[1-2]',
  1030. 'label': 'Port[2-1]',
  1031. 'type': PortTypeChoices.TYPE_8P8C,
  1032. 'positions': 1,
  1033. 'rear_ports': [f'{rear_port.pk}:1' for rear_port in self.rear_ports[:2]],
  1034. }
  1035. form = FrontPortCreateForm(bad_front_port_data)
  1036. self.assertFalse(form.is_valid())
  1037. self.assertIn('label', form.errors)
  1038. class InterfaceTestCase(TestCase):
  1039. @classmethod
  1040. def setUpTestData(cls):
  1041. cls.device = create_test_device('Device 1')
  1042. cls.vlans = (
  1043. VLAN(name='VLAN 1', vid=1),
  1044. VLAN(name='VLAN 2', vid=2),
  1045. VLAN(name='VLAN 3', vid=3),
  1046. )
  1047. VLAN.objects.bulk_create(cls.vlans)
  1048. cls.interface = Interface.objects.create(
  1049. device=cls.device,
  1050. name='Interface 1',
  1051. type=InterfaceTypeChoices.TYPE_1GE_GBIC,
  1052. mode=InterfaceModeChoices.MODE_TAGGED,
  1053. )
  1054. def test_interface_label_count_valid(self):
  1055. """
  1056. Test that generating an equal number of names and labels passes form validation.
  1057. """
  1058. interface_data = {
  1059. 'device': self.device.pk,
  1060. 'name': 'eth[0-9]',
  1061. 'label': 'Interface[0-9]',
  1062. 'type': InterfaceTypeChoices.TYPE_1GE_GBIC,
  1063. }
  1064. form = InterfaceCreateForm(interface_data)
  1065. self.assertTrue(form.is_valid())
  1066. def test_interface_label_count_mismatch(self):
  1067. """
  1068. Check that attempting to generate a differing number of names and labels results in a validation error.
  1069. """
  1070. bad_interface_data = {
  1071. 'device': self.device.pk,
  1072. 'name': 'eth[0-9]',
  1073. 'label': 'Interface[0-1]',
  1074. 'type': InterfaceTypeChoices.TYPE_1GE_GBIC,
  1075. }
  1076. form = InterfaceCreateForm(bad_interface_data)
  1077. self.assertFalse(form.is_valid())
  1078. self.assertIn('label', form.errors)
  1079. def test_create_interface_mode_valid_data(self):
  1080. """
  1081. Test that saving valid interface mode and tagged/untagged vlans works properly
  1082. """
  1083. # Validate access mode
  1084. data = {
  1085. 'device': self.device.pk,
  1086. 'name': 'ethernet1/1',
  1087. 'type': InterfaceTypeChoices.TYPE_1GE_GBIC,
  1088. 'mode': InterfaceModeChoices.MODE_ACCESS,
  1089. 'untagged_vlan': self.vlans[0].pk
  1090. }
  1091. form = InterfaceCreateForm(data)
  1092. self.assertTrue(form.is_valid())
  1093. # Validate tagged vlans
  1094. data = {
  1095. 'device': self.device.pk,
  1096. 'name': 'ethernet1/2',
  1097. 'type': InterfaceTypeChoices.TYPE_1GE_GBIC,
  1098. 'mode': InterfaceModeChoices.MODE_TAGGED,
  1099. 'untagged_vlan': self.vlans[0].pk,
  1100. 'tagged_vlans': [self.vlans[1].pk, self.vlans[2].pk]
  1101. }
  1102. form = InterfaceCreateForm(data)
  1103. self.assertTrue(form.is_valid())
  1104. # Validate tagged vlans
  1105. data = {
  1106. 'device': self.device.pk,
  1107. 'name': 'ethernet1/3',
  1108. 'type': InterfaceTypeChoices.TYPE_1GE_GBIC,
  1109. 'mode': InterfaceModeChoices.MODE_TAGGED_ALL,
  1110. 'untagged_vlan': self.vlans[0].pk,
  1111. }
  1112. form = InterfaceCreateForm(data)
  1113. self.assertTrue(form.is_valid())
  1114. def test_create_interface_mode_access_invalid_data(self):
  1115. """
  1116. Test that saving invalid interface mode and tagged/untagged vlans works properly
  1117. """
  1118. data = {
  1119. 'device': self.device.pk,
  1120. 'name': 'ethernet1/4',
  1121. 'type': InterfaceTypeChoices.TYPE_1GE_GBIC,
  1122. 'mode': InterfaceModeChoices.MODE_ACCESS,
  1123. 'untagged_vlan': self.vlans[0].pk,
  1124. 'tagged_vlans': [self.vlans[1].pk, self.vlans[2].pk]
  1125. }
  1126. form = InterfaceCreateForm(data)
  1127. self.assertTrue(form.is_valid())
  1128. self.assertIn('untagged_vlan', form.cleaned_data.keys())
  1129. self.assertNotIn('tagged_vlans', form.cleaned_data.keys())
  1130. self.assertNotIn('qinq_svlan', form.cleaned_data.keys())
  1131. def test_edit_interface_mode_access_invalid_data(self):
  1132. """
  1133. Test that saving invalid interface mode and tagged/untagged vlans works properly
  1134. """
  1135. data = {
  1136. 'device': self.device.pk,
  1137. 'name': 'Ethernet 1/5',
  1138. 'type': InterfaceTypeChoices.TYPE_1GE_GBIC,
  1139. 'mode': InterfaceModeChoices.MODE_ACCESS,
  1140. 'tagged_vlans': [self.vlans[0].pk, self.vlans[1].pk, self.vlans[2].pk]
  1141. }
  1142. form = InterfaceForm(data, instance=self.interface)
  1143. self.assertTrue(form.is_valid())
  1144. self.assertIn('untagged_vlan', form.cleaned_data.keys())
  1145. self.assertNotIn('tagged_vlans', form.cleaned_data.keys())
  1146. self.assertNotIn('qinq_svlan', form.cleaned_data.keys())
  1147. def test_create_interface_mode_tagged_all_invalid_data(self):
  1148. """
  1149. Test that saving invalid interface mode and tagged/untagged vlans works properly
  1150. """
  1151. data = {
  1152. 'device': self.device.pk,
  1153. 'name': 'ethernet1/6',
  1154. 'type': InterfaceTypeChoices.TYPE_1GE_GBIC,
  1155. 'mode': InterfaceModeChoices.MODE_TAGGED_ALL,
  1156. 'tagged_vlans': [self.vlans[0].pk, self.vlans[1].pk, self.vlans[2].pk]
  1157. }
  1158. form = InterfaceCreateForm(data)
  1159. self.assertTrue(form.is_valid())
  1160. self.assertIn('untagged_vlan', form.cleaned_data.keys())
  1161. self.assertNotIn('tagged_vlans', form.cleaned_data.keys())
  1162. self.assertNotIn('qinq_svlan', form.cleaned_data.keys())
  1163. def test_edit_interface_mode_tagged_all_invalid_data(self):
  1164. """
  1165. Test that saving invalid interface mode and tagged/untagged vlans works properly
  1166. """
  1167. data = {
  1168. 'device': self.device.pk,
  1169. 'name': 'Ethernet 1/7',
  1170. 'type': InterfaceTypeChoices.TYPE_1GE_GBIC,
  1171. 'mode': InterfaceModeChoices.MODE_TAGGED_ALL,
  1172. 'tagged_vlans': [self.vlans[0].pk, self.vlans[1].pk, self.vlans[2].pk]
  1173. }
  1174. form = InterfaceForm(data)
  1175. self.assertTrue(form.is_valid())
  1176. self.assertIn('untagged_vlan', form.cleaned_data.keys())
  1177. self.assertNotIn('tagged_vlans', form.cleaned_data.keys())
  1178. self.assertNotIn('qinq_svlan', form.cleaned_data.keys())
  1179. def test_create_interface_mode_routed_invalid_data(self):
  1180. """
  1181. Test that saving invalid interface mode (routed) and tagged/untagged vlans works properly
  1182. """
  1183. data = {
  1184. 'device': self.device.pk,
  1185. 'name': 'ethernet1/6',
  1186. 'type': InterfaceTypeChoices.TYPE_1GE_GBIC,
  1187. 'mode': None,
  1188. 'untagged_vlan': self.vlans[0].pk,
  1189. 'tagged_vlans': [self.vlans[0].pk, self.vlans[1].pk, self.vlans[2].pk]
  1190. }
  1191. form = InterfaceCreateForm(data)
  1192. self.assertTrue(form.is_valid())
  1193. self.assertNotIn('untagged_vlan', form.cleaned_data.keys())
  1194. self.assertNotIn('tagged_vlans', form.cleaned_data.keys())
  1195. self.assertNotIn('qinq_svlan', form.cleaned_data.keys())
  1196. def test_edit_interface_mode_routed_invalid_data(self):
  1197. """
  1198. Test that saving invalid interface mode (routed) and tagged/untagged vlans works properly
  1199. """
  1200. data = {
  1201. 'device': self.device.pk,
  1202. 'name': 'Ethernet 1/7',
  1203. 'type': InterfaceTypeChoices.TYPE_1GE_GBIC,
  1204. 'mode': None,
  1205. 'untagged_vlan': self.vlans[0].pk,
  1206. 'tagged_vlans': [self.vlans[0].pk, self.vlans[1].pk, self.vlans[2].pk]
  1207. }
  1208. form = InterfaceForm(data)
  1209. self.assertTrue(form.is_valid())
  1210. self.assertNotIn('untagged_vlan', form.cleaned_data.keys())
  1211. self.assertNotIn('tagged_vlans', form.cleaned_data.keys())
  1212. self.assertNotIn('qinq_svlan', form.cleaned_data.keys())
  1213. def test_child_interface_preselects_every_parent_vdc(self):
  1214. """A child interface's form pre-selects every virtual device context of its parent."""
  1215. vdcs = (
  1216. VirtualDeviceContext(
  1217. device=self.device,
  1218. name='VDC 1',
  1219. identifier=1,
  1220. status=VirtualDeviceContextStatusChoices.STATUS_ACTIVE
  1221. ),
  1222. VirtualDeviceContext(
  1223. device=self.device,
  1224. name='VDC 2',
  1225. identifier=2,
  1226. status=VirtualDeviceContextStatusChoices.STATUS_ACTIVE
  1227. ),
  1228. )
  1229. VirtualDeviceContext.objects.bulk_create(vdcs)
  1230. self.interface.vdcs.set(vdcs)
  1231. form = InterfaceForm(initial={'device': self.device.pk, 'parent': self.interface.pk})
  1232. self.assertCountEqual([vdc.pk for vdc in form['vdcs'].field.queryset], [vdc.pk for vdc in vdcs])
  1233. class CableTestCase(TestCase):
  1234. @classmethod
  1235. def setUpTestData(cls):
  1236. cls.site = Site.objects.create(name='Site 1', slug='site-1')
  1237. cls.device_a = create_test_device('Device A', site=cls.site)
  1238. cls.device_b = create_test_device('Device B', site=cls.site)
  1239. cls.device_c = create_test_device('Device C', site=cls.site)
  1240. cls.interfaces_a = (
  1241. Interface(device=cls.device_a, name='et-0/0/0', type=InterfaceTypeChoices.TYPE_1GE_FIXED),
  1242. Interface(device=cls.device_a, name='et-0/0/1', type=InterfaceTypeChoices.TYPE_1GE_FIXED),
  1243. )
  1244. cls.interfaces_b = (
  1245. Interface(device=cls.device_b, name='et-0/0/0', type=InterfaceTypeChoices.TYPE_1GE_FIXED),
  1246. Interface(device=cls.device_b, name='et-0/0/1', type=InterfaceTypeChoices.TYPE_1GE_FIXED),
  1247. Interface(device=cls.device_b, name='et-0/0/2', type=InterfaceTypeChoices.TYPE_1GE_FIXED),
  1248. )
  1249. cls.interface_c = Interface(device=cls.device_c, name='et-0/0/1', type=InterfaceTypeChoices.TYPE_1GE_FIXED)
  1250. Interface.objects.bulk_create([*cls.interfaces_a, *cls.interfaces_b, cls.interface_c])
  1251. cls.power_panel = PowerPanel.objects.create(site=cls.site, name='Power Panel 1')
  1252. cls.power_feeds = (
  1253. PowerFeed(power_panel=cls.power_panel, name='Power Feed 1'),
  1254. PowerFeed(power_panel=cls.power_panel, name='Power Feed 2'),
  1255. )
  1256. PowerFeed.objects.bulk_create(cls.power_feeds)
  1257. cls.power_ports = (
  1258. PowerPort(device=cls.device_b, name='Power Port 1'),
  1259. PowerPort(device=cls.device_b, name='Power Port 2'),
  1260. )
  1261. PowerPort.objects.bulk_create(cls.power_ports)
  1262. def _make_edit_form(self):
  1263. cable = Cable(
  1264. a_terminations=[self.interfaces_a[0]],
  1265. b_terminations=[self.interfaces_b[1], self.interface_c],
  1266. )
  1267. cable.save()
  1268. return get_cable_form(Interface, Interface)(instance=Cable.objects.get(pk=cable.pk))
  1269. def test_invalid_side_designation_raises_value_error(self):
  1270. """_clean_side rejects a side other than 'a' or 'b' with ValueError."""
  1271. form = CableImportForm.__new__(CableImportForm)
  1272. with self.assertRaisesMessage(ValueError, "Invalid side designation: c"):
  1273. form._clean_side('c')
  1274. def test_import_single_termination_cable(self):
  1275. """A single-value cell per side resolves one termination per side."""
  1276. form = CableImportForm(data={
  1277. 'side_a_site': 'Site 1',
  1278. 'side_a_device': 'Device A',
  1279. 'side_a_type': 'dcim.interface',
  1280. 'side_a_name': 'et-0/0/0',
  1281. 'side_b_site': 'Site 1',
  1282. 'side_b_device': 'Device B',
  1283. 'side_b_type': 'dcim.interface',
  1284. 'side_b_name': 'et-0/0/0',
  1285. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1286. })
  1287. self.assertTrue(form.is_valid(), form.errors)
  1288. cable = form.save()
  1289. self.assertEqual(cable.a_terminations, [self.interfaces_a[0]])
  1290. self.assertEqual(cable.b_terminations, [self.interfaces_b[0]])
  1291. def test_import_multiple_terminations_single_parent(self):
  1292. """A single parent value is reused for all comma-separated termination names."""
  1293. form = CableImportForm(data={
  1294. 'side_a_device': 'Device A',
  1295. 'side_a_type': 'dcim.interface',
  1296. 'side_a_name': 'et-0/0/0',
  1297. 'side_b_device': 'Device B',
  1298. 'side_b_type': 'dcim.interface',
  1299. 'side_b_name': 'et-0/0/1, et-0/0/2',
  1300. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1301. 'profile': CableProfileChoices.BREAKOUT_1C2P_2C1P,
  1302. })
  1303. self.assertTrue(form.is_valid(), form.errors)
  1304. cable = form.save()
  1305. self.assertEqual(cable.a_terminations, [self.interfaces_a[0]])
  1306. self.assertEqual(cable.b_terminations, [self.interfaces_b[1], self.interfaces_b[2]])
  1307. def test_import_multiple_terminations_multiple_parents_preserves_order(self):
  1308. """Pairwise parent/name lists resolve in submitted order, driving connector assignment."""
  1309. form = CableImportForm(data={
  1310. 'side_a_device': 'Device A',
  1311. 'side_a_type': 'dcim.interface',
  1312. 'side_a_name': 'et-0/0/0',
  1313. 'side_b_device': 'Device C,Device B',
  1314. 'side_b_type': 'dcim.interface',
  1315. 'side_b_name': 'et-0/0/1,et-0/0/1',
  1316. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1317. 'profile': CableProfileChoices.BREAKOUT_1C2P_2C1P,
  1318. })
  1319. self.assertTrue(form.is_valid(), form.errors)
  1320. cable = form.save()
  1321. self.assertEqual(cable.b_terminations, [self.interface_c, self.interfaces_b[1]])
  1322. cable_terminations = CableTermination.objects.filter(
  1323. cable=cable, cable_end=CableEndChoices.SIDE_B
  1324. ).order_by('connector')
  1325. self.assertEqual([ct.termination for ct in cable_terminations], [self.interface_c, self.interfaces_b[1]])
  1326. self.assertEqual([ct.connector for ct in cable_terminations], [1, 2])
  1327. def test_import_multiple_terminations_parent_count_mismatch(self):
  1328. """A parent list that is neither one value nor one per termination name is rejected."""
  1329. form = CableImportForm(data={
  1330. 'side_a_device': 'Device A',
  1331. 'side_a_type': 'dcim.interface',
  1332. 'side_a_name': 'et-0/0/0',
  1333. 'side_b_device': 'Device B,Device C',
  1334. 'side_b_type': 'dcim.interface',
  1335. 'side_b_name': 'et-0/0/1,et-0/0/1,et-0/0/2',
  1336. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1337. })
  1338. self.assertFalse(form.is_valid())
  1339. self.assertIn('Must specify either one device', str(form.errors.get('side_b_name')))
  1340. def test_import_multiple_terminations_duplicate_termination(self):
  1341. """The same termination cannot be listed twice on one cable end."""
  1342. form = CableImportForm(data={
  1343. 'side_a_device': 'Device A',
  1344. 'side_a_type': 'dcim.interface',
  1345. 'side_a_name': 'et-0/0/0',
  1346. 'side_b_device': 'Device B',
  1347. 'side_b_type': 'dcim.interface',
  1348. 'side_b_name': 'et-0/0/1,et-0/0/1',
  1349. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1350. })
  1351. self.assertFalse(form.is_valid())
  1352. self.assertIn('Duplicate termination', str(form.errors.get('side_b_name')))
  1353. def test_import_terminations_exceeding_profile_capacity(self):
  1354. """A side carrying more terminations than its profile permits reports against that side's column."""
  1355. form = CableImportForm(data={
  1356. 'side_a_device': 'Device A',
  1357. 'side_a_type': 'dcim.interface',
  1358. 'side_a_name': 'et-0/0/0',
  1359. 'side_b_device': 'Device B',
  1360. 'side_b_type': 'dcim.interface',
  1361. 'side_b_name': 'et-0/0/0,et-0/0/1,et-0/0/2',
  1362. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1363. 'profile': CableProfileChoices.BREAKOUT_1C2P_2C1P,
  1364. })
  1365. self.assertFalse(form.is_valid())
  1366. self.assertIn('only 2 are permitted', str(form.errors.get('side_b_name')))
  1367. def test_import_terminations_exceeding_profile_capacity_side_a(self):
  1368. """The same applies to side A, whose profile capacity is often lower than side B's."""
  1369. form = CableImportForm(data={
  1370. 'side_a_device': 'Device A',
  1371. 'side_a_type': 'dcim.interface',
  1372. 'side_a_name': 'et-0/0/0,et-0/0/1',
  1373. 'side_b_device': 'Device B',
  1374. 'side_b_type': 'dcim.interface',
  1375. 'side_b_name': 'et-0/0/0',
  1376. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1377. 'profile': CableProfileChoices.BREAKOUT_1C2P_2C1P,
  1378. })
  1379. self.assertFalse(form.is_valid())
  1380. self.assertIn('only 1 are permitted', str(form.errors.get('side_a_name')))
  1381. def test_import_multiple_terminations_empty_name(self):
  1382. """A trailing comma produces an empty termination name and is rejected."""
  1383. form = CableImportForm(data={
  1384. 'side_a_device': 'Device A',
  1385. 'side_a_type': 'dcim.interface',
  1386. 'side_a_name': 'et-0/0/0',
  1387. 'side_b_device': 'Device B',
  1388. 'side_b_type': 'dcim.interface',
  1389. 'side_b_name': 'et-0/0/1,',
  1390. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1391. })
  1392. self.assertFalse(form.is_valid())
  1393. self.assertIn('Empty termination names', str(form.errors.get('side_b_name')))
  1394. def test_import_multiple_terminations_connected_termination(self):
  1395. """An already-cabled termination in a multi-value list is rejected."""
  1396. cable = Cable(a_terminations=[self.interfaces_a[1]], b_terminations=[self.interfaces_b[1]])
  1397. cable.save()
  1398. form = CableImportForm(data={
  1399. 'side_a_device': 'Device A',
  1400. 'side_a_type': 'dcim.interface',
  1401. 'side_a_name': 'et-0/0/0',
  1402. 'side_b_device': 'Device B',
  1403. 'side_b_type': 'dcim.interface',
  1404. 'side_b_name': 'et-0/0/1,et-0/0/2',
  1405. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1406. })
  1407. self.assertFalse(form.is_valid())
  1408. self.assertIn('already connected', str(form.errors.get('side_b_name')))
  1409. def test_import_multiple_terminations_power_feeds(self):
  1410. """Multiple power feeds import from a single broadcast power panel."""
  1411. form = CableImportForm(data={
  1412. 'side_a_power_panel': 'Power Panel 1',
  1413. 'side_a_type': 'dcim.powerfeed',
  1414. 'side_a_name': 'Power Feed 1,Power Feed 2',
  1415. 'side_b_device': 'Device B',
  1416. 'side_b_type': 'dcim.powerport',
  1417. 'side_b_name': 'Power Port 1,Power Port 2',
  1418. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1419. })
  1420. self.assertTrue(form.is_valid(), form.errors)
  1421. cable = form.save()
  1422. self.assertEqual(cable.a_terminations, list(self.power_feeds))
  1423. self.assertEqual(cable.b_terminations, list(self.power_ports))
  1424. def test_import_multiple_terminations_repeated_parent_values(self):
  1425. """A repeated parent in a pairwise list resolves per position, not deduplicated."""
  1426. form = CableImportForm(data={
  1427. 'side_a_device': 'Device A',
  1428. 'side_a_type': 'dcim.interface',
  1429. 'side_a_name': 'et-0/0/0',
  1430. 'side_b_device': 'Device B,Device C,Device B',
  1431. 'side_b_type': 'dcim.interface',
  1432. 'side_b_name': 'et-0/0/1,et-0/0/1,et-0/0/2',
  1433. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1434. })
  1435. self.assertTrue(form.is_valid(), form.errors)
  1436. cable = form.save()
  1437. self.assertEqual(
  1438. cable.b_terminations,
  1439. [self.interfaces_b[1], self.interface_c, self.interfaces_b[2]]
  1440. )
  1441. def test_import_multiple_terminations_native_lists(self):
  1442. """Native list values (JSON/YAML import) resolve like comma-separated cells."""
  1443. form = CableImportForm(data={
  1444. 'side_a_device': 'Device A',
  1445. 'side_a_type': 'dcim.interface',
  1446. 'side_a_name': 'et-0/0/0',
  1447. 'side_b_device': ['Device C', 'Device B'],
  1448. 'side_b_type': 'dcim.interface',
  1449. 'side_b_name': ['et-0/0/1', 'et-0/0/1'],
  1450. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1451. 'profile': CableProfileChoices.BREAKOUT_1C2P_2C1P,
  1452. })
  1453. self.assertTrue(form.is_valid(), form.errors)
  1454. cable = form.save()
  1455. self.assertEqual(cable.b_terminations, [self.interface_c, self.interfaces_b[1]])
  1456. def test_import_multiple_terminations_unknown_parent(self):
  1457. """An unknown parent in a multi-value cell errors on the parent field only."""
  1458. form = CableImportForm(data={
  1459. 'side_a_device': 'Device A',
  1460. 'side_a_type': 'dcim.interface',
  1461. 'side_a_name': 'et-0/0/0',
  1462. 'side_b_device': 'Device B,Device X',
  1463. 'side_b_type': 'dcim.interface',
  1464. 'side_b_name': 'et-0/0/1,et-0/0/2',
  1465. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1466. })
  1467. self.assertFalse(form.is_valid())
  1468. self.assertIn('Object not found: Device X', str(form.errors.get('side_b_device')))
  1469. self.assertNotIn('side_b_name', form.errors)
  1470. def test_import_multiple_terminations_missing_parent(self):
  1471. """A device component termination type without a device value is rejected."""
  1472. form = CableImportForm(data={
  1473. 'side_a_device': 'Device A',
  1474. 'side_a_type': 'dcim.interface',
  1475. 'side_a_name': 'et-0/0/0',
  1476. 'side_b_type': 'dcim.interface',
  1477. 'side_b_name': 'et-0/0/1,et-0/0/2',
  1478. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1479. })
  1480. self.assertFalse(form.is_valid())
  1481. self.assertIn('Must specify a device', str(form.errors.get('side_b_name')))
  1482. def test_import_unsupported_termination_type(self):
  1483. """Termination types without a supported parent field are rejected."""
  1484. form = CableImportForm(data={
  1485. 'side_a_device': 'Device A',
  1486. 'side_a_type': 'dcim.interface',
  1487. 'side_a_name': 'et-0/0/0',
  1488. 'side_b_device': 'Device B',
  1489. 'side_b_type': 'circuits.circuittermination',
  1490. 'side_b_name': 'Termination X',
  1491. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1492. })
  1493. self.assertFalse(form.is_valid())
  1494. self.assertIn('Bulk import does not support', str(form.errors.get('side_b_name')))
  1495. def test_import_unknown_termination_type(self):
  1496. """An unresolvable termination type errors on the type field only."""
  1497. form = CableImportForm(data={
  1498. 'side_a_device': 'Device A',
  1499. 'side_a_type': 'dcim.interface',
  1500. 'side_a_name': 'et-0/0/0',
  1501. 'side_b_device': 'Device B',
  1502. 'side_b_type': 'dcim.nosuchmodel',
  1503. 'side_b_name': 'et-0/0/1',
  1504. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1505. })
  1506. self.assertFalse(form.is_valid())
  1507. self.assertIn('side_b_type', form.errors)
  1508. self.assertNotIn('side_b_name', form.errors)
  1509. def test_import_multiple_terminations_unknown_name(self):
  1510. """An unknown termination name in a multi-value list is rejected."""
  1511. form = CableImportForm(data={
  1512. 'side_a_device': 'Device A',
  1513. 'side_a_type': 'dcim.interface',
  1514. 'side_a_name': 'et-0/0/0',
  1515. 'side_b_device': 'Device B',
  1516. 'side_b_type': 'dcim.interface',
  1517. 'side_b_name': 'et-0/0/1,et-0/0/9',
  1518. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1519. })
  1520. self.assertFalse(form.is_valid())
  1521. self.assertIn('side termination not found', str(form.errors.get('side_b_name')))
  1522. def test_import_multiple_terminations_ambiguous_parent(self):
  1523. """A parent name matching multiple objects errors on the parent field."""
  1524. site_2 = Site.objects.create(name='Site 2', slug='site-2')
  1525. create_test_device('Device D', site=self.site)
  1526. create_test_device('Device D', site=site_2)
  1527. form = CableImportForm(data={
  1528. 'side_a_device': 'Device A',
  1529. 'side_a_type': 'dcim.interface',
  1530. 'side_a_name': 'et-0/0/0',
  1531. 'side_b_device': 'Device D',
  1532. 'side_b_type': 'dcim.interface',
  1533. 'side_b_name': 'et-0/0/1',
  1534. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1535. })
  1536. self.assertFalse(form.is_valid())
  1537. self.assertIn('is not a unique value', str(form.errors.get('side_b_device')))
  1538. self.assertNotIn('side_b_name', form.errors)
  1539. def test_import_multiple_terminations_site_filtered_parent_queryset(self):
  1540. """Parent resolution honors side_x_site queryset filtering for multi-value parents."""
  1541. site_2 = Site.objects.create(name='Site 2', slug='site-2')
  1542. device_x = create_test_device('Device X', site=site_2)
  1543. Interface.objects.create(device=device_x, name='et-0/0/1', type=InterfaceTypeChoices.TYPE_1GE_FIXED)
  1544. form = CableImportForm(data={
  1545. 'side_a_site': 'Site 1',
  1546. 'side_a_device': 'Device A',
  1547. 'side_a_type': 'dcim.interface',
  1548. 'side_a_name': 'et-0/0/0',
  1549. 'side_b_site': 'Site 1',
  1550. 'side_b_device': 'Device B,Device X',
  1551. 'side_b_type': 'dcim.interface',
  1552. 'side_b_name': 'et-0/0/1,et-0/0/1',
  1553. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1554. })
  1555. self.assertFalse(form.is_valid())
  1556. self.assertIn('Object not found: Device X', str(form.errors.get('side_b_device')))
  1557. self.assertNotIn('side_b_name', form.errors)
  1558. def test_import_ambiguous_vc_component(self):
  1559. """A component name found on multiple VC members produces a form error."""
  1560. vc = VirtualChassis.objects.create(name='Virtual Chassis 1')
  1561. master = create_test_device('VC Master', site=self.site, virtual_chassis=vc, vc_position=1)
  1562. member_2 = create_test_device('VC Member 2', site=self.site, virtual_chassis=vc, vc_position=2)
  1563. member_3 = create_test_device('VC Member 3', site=self.site, virtual_chassis=vc, vc_position=3)
  1564. vc.master = master
  1565. vc.save()
  1566. Interface.objects.create(device=member_2, name='vc-eth0', type=InterfaceTypeChoices.TYPE_1GE_FIXED)
  1567. Interface.objects.create(device=member_3, name='vc-eth0', type=InterfaceTypeChoices.TYPE_1GE_FIXED)
  1568. form = CableImportForm(data={
  1569. 'side_a_device': 'Device A',
  1570. 'side_a_type': 'dcim.interface',
  1571. 'side_a_name': 'et-0/0/0',
  1572. 'side_b_device': 'VC Master',
  1573. 'side_b_type': 'dcim.interface',
  1574. 'side_b_name': 'vc-eth0',
  1575. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1576. })
  1577. self.assertFalse(form.is_valid())
  1578. self.assertIn('side termination not unique', str(form.errors.get('side_b_name')))
  1579. def test_edit_form_selects_every_device_terminating_an_end(self):
  1580. """The edit form selects every device terminating an end of the cable."""
  1581. form = self._make_edit_form()
  1582. self.assertCountEqual(
  1583. [device.pk for device in form['termination_b_device'].field.queryset],
  1584. [self.device_b.pk, self.device_c.pk]
  1585. )
  1586. def test_edit_form_names_the_device_of_each_termination(self):
  1587. """Each termination option names its device, so identically named interfaces stay distinct."""
  1588. html = str(self._make_edit_form()['b_terminations'])
  1589. for interface in (self.interfaces_b[1], self.interface_c):
  1590. self.assertInHTML(
  1591. f'<option value="{interface.pk}" data-parent="{interface.device}" selected>et-0/0/1</option>', html
  1592. )
  1593. def test_termination_fields_preserve_their_selection(self):
  1594. """Only the termination fields keep their selection when a parent selector changes."""
  1595. for termination_type, parent in (
  1596. (Interface, 'device'),
  1597. (PowerFeed, 'powerpanel'),
  1598. (CircuitTermination, 'circuit'),
  1599. ):
  1600. fields = get_cable_form(termination_type, termination_type)().fields
  1601. with self.subTest(termination_type=termination_type.__name__):
  1602. self.assertIn('data-preserve-selection', fields['b_terminations'].widget.attrs)
  1603. self.assertNotIn('data-preserve-selection', fields[f'termination_b_{parent}'].widget.attrs)
  1604. def test_edit_form_saves_terminations_outside_the_device_filter(self):
  1605. """Saving keeps every selected termination and its row, even when its device is not in the Device filter."""
  1606. cable = self._make_edit_form().instance
  1607. rows = CableTermination.objects.filter(cable=cable, cable_end=CableEndChoices.SIDE_B)
  1608. existing_rows = set(rows.values_list('pk', flat=True))
  1609. device_d = create_test_device('Device D', site=self.site)
  1610. interface_d = Interface.objects.create(
  1611. device=device_d, name='et-0/0/1', type=InterfaceTypeChoices.TYPE_1GE_FIXED
  1612. )
  1613. b_terminations = [self.interfaces_b[1], self.interface_c, interface_d]
  1614. form = get_cable_form(Interface, Interface)(instance=Cable.objects.get(pk=cable.pk), data={
  1615. 'a_terminations_type': 'dcim.interface',
  1616. 'b_terminations_type': 'dcim.interface',
  1617. 'termination_a_device': [self.device_a.pk],
  1618. 'termination_b_device': [device_d.pk],
  1619. 'a_terminations': [self.interfaces_a[0].pk],
  1620. 'b_terminations': [interface.pk for interface in b_terminations],
  1621. 'status': LinkStatusChoices.STATUS_CONNECTED,
  1622. })
  1623. self.assertTrue(form.is_valid(), form.errors)
  1624. form.save()
  1625. self.assertCountEqual(Cable.objects.get(pk=cable.pk).b_terminations, b_terminations)
  1626. self.assertTrue(existing_rows.issubset(rows.values_list('pk', flat=True)))
  1627. class SiteFormTestCase(TestCase):
  1628. """
  1629. Tests for M2MAddRemoveFields using Site ASN assignments as the test case.
  1630. Covers both simple mode (single multi-select field) and add/remove mode (dual fields).
  1631. """
  1632. @classmethod
  1633. def setUpTestData(cls):
  1634. cls.rir = RIR.objects.create(name='RIR 1', slug='rir-1')
  1635. # Create 110 ASNs: 100 to pre-assign (triggering add/remove mode) plus 10 extras
  1636. ASN.objects.bulk_create([ASN(asn=i, rir=cls.rir) for i in range(1, 111)])
  1637. cls.asns = list(ASN.objects.order_by('asn'))
  1638. def _site_data(self, **kwargs):
  1639. data = {'name': 'Test Site', 'slug': 'test-site', 'status': 'active'}
  1640. data.update(kwargs)
  1641. return data
  1642. def test_new_site_uses_simple_mode(self):
  1643. """A form for a new site uses the single 'asns' field (simple mode)."""
  1644. form = SiteForm(data=self._site_data())
  1645. self.assertIn('asns', form.fields)
  1646. self.assertNotIn('add_asns', form.fields)
  1647. self.assertNotIn('remove_asns', form.fields)
  1648. def test_existing_site_below_threshold_uses_simple_mode(self):
  1649. """A form for an existing site with fewer than THRESHOLD ASNs uses simple mode."""
  1650. site = Site.objects.create(name='Site 1', slug='site-1')
  1651. site.asns.set(self.asns[:5])
  1652. form = SiteForm(instance=site)
  1653. self.assertIn('asns', form.fields)
  1654. self.assertNotIn('add_asns', form.fields)
  1655. self.assertNotIn('remove_asns', form.fields)
  1656. def test_existing_site_at_threshold_uses_add_remove_mode(self):
  1657. """A form for an existing site with THRESHOLD or more ASNs uses add/remove mode."""
  1658. site = Site.objects.create(name='Site 2', slug='site-2')
  1659. site.asns.set(self.asns[:M2MAddRemoveFields.THRESHOLD])
  1660. form = SiteForm(instance=site)
  1661. self.assertNotIn('asns', form.fields)
  1662. self.assertIn('add_asns', form.fields)
  1663. self.assertIn('remove_asns', form.fields)
  1664. def test_simple_mode_assigns_asns_on_create(self):
  1665. """Saving a new site via simple mode assigns the selected ASNs."""
  1666. asn_pks = [asn.pk for asn in self.asns[:3]]
  1667. form = SiteForm(data=self._site_data(asns=asn_pks))
  1668. self.assertTrue(form.is_valid(), form.errors)
  1669. site = form.save()
  1670. self.assertEqual(set(site.asns.values_list('pk', flat=True)), set(asn_pks))
  1671. def test_simple_mode_replaces_asns_on_edit(self):
  1672. """Saving an existing site via simple mode replaces the current ASN assignments."""
  1673. site = Site.objects.create(name='Site 3', slug='site-3')
  1674. site.asns.set(self.asns[:3])
  1675. new_asn_pks = [asn.pk for asn in self.asns[3:6]]
  1676. form = SiteForm(
  1677. data=self._site_data(name='Site 3', slug='site-3', asns=new_asn_pks),
  1678. instance=site
  1679. )
  1680. self.assertTrue(form.is_valid(), form.errors)
  1681. site = form.save()
  1682. self.assertEqual(set(site.asns.values_list('pk', flat=True)), set(new_asn_pks))
  1683. def test_add_remove_mode_adds_asns(self):
  1684. """In add/remove mode, specifying 'add_asns' appends to current assignments."""
  1685. site = Site.objects.create(name='Site 4', slug='site-4')
  1686. site.asns.set(self.asns[:M2MAddRemoveFields.THRESHOLD])
  1687. new_asn_pks = [asn.pk for asn in self.asns[M2MAddRemoveFields.THRESHOLD:]]
  1688. form = SiteForm(
  1689. data=self._site_data(name='Site 4', slug='site-4', add_asns=new_asn_pks),
  1690. instance=site
  1691. )
  1692. self.assertTrue(form.is_valid(), form.errors)
  1693. site = form.save()
  1694. self.assertEqual(site.asns.count(), len(self.asns))
  1695. def test_add_remove_mode_removes_asns(self):
  1696. """In add/remove mode, specifying 'remove_asns' drops those assignments."""
  1697. site = Site.objects.create(name='Site 5', slug='site-5')
  1698. site.asns.set(self.asns[:M2MAddRemoveFields.THRESHOLD])
  1699. remove_pks = [asn.pk for asn in self.asns[:5]]
  1700. form = SiteForm(
  1701. data=self._site_data(name='Site 5', slug='site-5', remove_asns=remove_pks),
  1702. instance=site
  1703. )
  1704. self.assertTrue(form.is_valid(), form.errors)
  1705. site = form.save()
  1706. self.assertEqual(site.asns.count(), M2MAddRemoveFields.THRESHOLD - 5)
  1707. self.assertFalse(site.asns.filter(pk__in=remove_pks).exists())
  1708. def test_add_remove_mode_simultaneous_add_and_remove(self):
  1709. """In add/remove mode, add and remove operations are applied together."""
  1710. site = Site.objects.create(name='Site 6', slug='site-6')
  1711. site.asns.set(self.asns[:M2MAddRemoveFields.THRESHOLD])
  1712. add_pks = [asn.pk for asn in self.asns[M2MAddRemoveFields.THRESHOLD:M2MAddRemoveFields.THRESHOLD + 3]]
  1713. remove_pks = [asn.pk for asn in self.asns[:3]]
  1714. form = SiteForm(
  1715. data=self._site_data(name='Site 6', slug='site-6', add_asns=add_pks, remove_asns=remove_pks),
  1716. instance=site
  1717. )
  1718. self.assertTrue(form.is_valid(), form.errors)
  1719. site = form.save()
  1720. self.assertEqual(site.asns.count(), M2MAddRemoveFields.THRESHOLD)
  1721. self.assertTrue(site.asns.filter(pk__in=add_pks).count() == 3)
  1722. self.assertFalse(site.asns.filter(pk__in=remove_pks).exists())