test_forms.py 83 KB

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