test_api.py 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146
  1. import json
  2. from django.urls import reverse
  3. from netaddr import IPNetwork
  4. from rest_framework import status
  5. from dcim.models import Device, DeviceRole, DeviceType, Manufacturer, Site
  6. from ipam.choices import *
  7. from ipam.models import Aggregate, IPAddress, Prefix, RIR, Role, Service, VLAN, VLANGroup, VRF
  8. from utilities.testing import APITestCase, choices_to_dict, disable_warnings
  9. class AppTest(APITestCase):
  10. def test_root(self):
  11. url = reverse('ipam-api:api-root')
  12. response = self.client.get('{}?format=api'.format(url), **self.header)
  13. self.assertEqual(response.status_code, 200)
  14. def test_choices(self):
  15. url = reverse('ipam-api:field-choice-list')
  16. response = self.client.get(url, **self.header)
  17. self.assertEqual(response.status_code, 200)
  18. # Aggregate
  19. # self.assertEqual(choices_to_dict(response.data.get('aggregate:family')), )
  20. # Prefix
  21. # self.assertEqual(choices_to_dict(response.data.get('prefix:family')), )
  22. self.assertEqual(choices_to_dict(response.data.get('prefix:status')), PrefixStatusChoices.as_dict())
  23. # IPAddress
  24. # self.assertEqual(choices_to_dict(response.data.get('ip-address:family')), )
  25. self.assertEqual(choices_to_dict(response.data.get('ip-address:role')), IPAddressRoleChoices.as_dict())
  26. self.assertEqual(choices_to_dict(response.data.get('ip-address:status')), IPAddressStatusChoices.as_dict())
  27. # VLAN
  28. self.assertEqual(choices_to_dict(response.data.get('vlan:status')), VLANStatusChoices.as_dict())
  29. # Service
  30. self.assertEqual(choices_to_dict(response.data.get('service:protocol')), ServiceProtocolChoices.as_dict())
  31. class VRFTest(APITestCase):
  32. def setUp(self):
  33. super().setUp()
  34. self.vrf1 = VRF.objects.create(name='Test VRF 1', rd='65000:1')
  35. self.vrf2 = VRF.objects.create(name='Test VRF 2', rd='65000:2')
  36. self.vrf3 = VRF.objects.create(name='Test VRF 3') # No RD
  37. def test_get_vrf(self):
  38. url = reverse('ipam-api:vrf-detail', kwargs={'pk': self.vrf1.pk})
  39. response = self.client.get(url, **self.header)
  40. self.assertEqual(response.data['name'], self.vrf1.name)
  41. def test_list_vrfs(self):
  42. url = reverse('ipam-api:vrf-list')
  43. response = self.client.get(url, **self.header)
  44. self.assertEqual(response.data['count'], 3)
  45. def test_list_vrfs_brief(self):
  46. url = reverse('ipam-api:vrf-list')
  47. response = self.client.get('{}?brief=1'.format(url), **self.header)
  48. self.assertEqual(
  49. sorted(response.data['results'][0]),
  50. ['id', 'name', 'prefix_count', 'rd', 'url']
  51. )
  52. def test_create_vrf(self):
  53. data_list = [
  54. # VRF with RD
  55. {
  56. 'name': 'Test VRF 4',
  57. 'rd': '65000:4',
  58. },
  59. # VRF without RD
  60. {
  61. 'name': 'Test VRF 5',
  62. }
  63. ]
  64. url = reverse('ipam-api:vrf-list')
  65. for data in data_list:
  66. response = self.client.post(url, data, format='json', **self.header)
  67. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  68. vrf = VRF.objects.get(pk=response.data['id'])
  69. self.assertEqual(vrf.name, data['name'])
  70. self.assertEqual(vrf.rd, data['rd'] if 'rd' in data else None)
  71. def test_create_vrf_bulk(self):
  72. data = [
  73. {
  74. 'name': 'Test VRF 4',
  75. 'rd': '65000:4',
  76. },
  77. {
  78. 'name': 'Test VRF 5',
  79. 'rd': '65000:5',
  80. },
  81. {
  82. 'name': 'Test VRF 6',
  83. 'rd': '65000:6',
  84. },
  85. ]
  86. url = reverse('ipam-api:vrf-list')
  87. response = self.client.post(url, data, format='json', **self.header)
  88. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  89. self.assertEqual(VRF.objects.count(), 6)
  90. self.assertEqual(response.data[0]['name'], data[0]['name'])
  91. self.assertEqual(response.data[1]['name'], data[1]['name'])
  92. self.assertEqual(response.data[2]['name'], data[2]['name'])
  93. def test_update_vrf(self):
  94. data = {
  95. 'name': 'Test VRF X',
  96. 'rd': '65000:99',
  97. }
  98. url = reverse('ipam-api:vrf-detail', kwargs={'pk': self.vrf1.pk})
  99. response = self.client.put(url, data, format='json', **self.header)
  100. self.assertHttpStatus(response, status.HTTP_200_OK)
  101. self.assertEqual(VRF.objects.count(), 3)
  102. vrf1 = VRF.objects.get(pk=response.data['id'])
  103. self.assertEqual(vrf1.name, data['name'])
  104. self.assertEqual(vrf1.rd, data['rd'])
  105. def test_delete_vrf(self):
  106. url = reverse('ipam-api:vrf-detail', kwargs={'pk': self.vrf1.pk})
  107. response = self.client.delete(url, **self.header)
  108. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  109. self.assertEqual(VRF.objects.count(), 2)
  110. class RIRTest(APITestCase):
  111. def setUp(self):
  112. super().setUp()
  113. self.rir1 = RIR.objects.create(name='Test RIR 1', slug='test-rir-1')
  114. self.rir2 = RIR.objects.create(name='Test RIR 2', slug='test-rir-2')
  115. self.rir3 = RIR.objects.create(name='Test RIR 3', slug='test-rir-3')
  116. def test_get_rir(self):
  117. url = reverse('ipam-api:rir-detail', kwargs={'pk': self.rir1.pk})
  118. response = self.client.get(url, **self.header)
  119. self.assertEqual(response.data['name'], self.rir1.name)
  120. def test_list_rirs(self):
  121. url = reverse('ipam-api:rir-list')
  122. response = self.client.get(url, **self.header)
  123. self.assertEqual(response.data['count'], 3)
  124. def test_list_rirs_brief(self):
  125. url = reverse('ipam-api:rir-list')
  126. response = self.client.get('{}?brief=1'.format(url), **self.header)
  127. self.assertEqual(
  128. sorted(response.data['results'][0]),
  129. ['aggregate_count', 'id', 'name', 'slug', 'url']
  130. )
  131. def test_create_rir(self):
  132. data = {
  133. 'name': 'Test RIR 4',
  134. 'slug': 'test-rir-4',
  135. }
  136. url = reverse('ipam-api:rir-list')
  137. response = self.client.post(url, data, format='json', **self.header)
  138. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  139. self.assertEqual(RIR.objects.count(), 4)
  140. rir4 = RIR.objects.get(pk=response.data['id'])
  141. self.assertEqual(rir4.name, data['name'])
  142. self.assertEqual(rir4.slug, data['slug'])
  143. def test_create_rir_bulk(self):
  144. data = [
  145. {
  146. 'name': 'Test RIR 4',
  147. 'slug': 'test-rir-4',
  148. },
  149. {
  150. 'name': 'Test RIR 5',
  151. 'slug': 'test-rir-5',
  152. },
  153. {
  154. 'name': 'Test RIR 6',
  155. 'slug': 'test-rir-6',
  156. },
  157. ]
  158. url = reverse('ipam-api:rir-list')
  159. response = self.client.post(url, data, format='json', **self.header)
  160. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  161. self.assertEqual(RIR.objects.count(), 6)
  162. self.assertEqual(response.data[0]['name'], data[0]['name'])
  163. self.assertEqual(response.data[1]['name'], data[1]['name'])
  164. self.assertEqual(response.data[2]['name'], data[2]['name'])
  165. def test_update_rir(self):
  166. data = {
  167. 'name': 'Test RIR X',
  168. 'slug': 'test-rir-x',
  169. }
  170. url = reverse('ipam-api:rir-detail', kwargs={'pk': self.rir1.pk})
  171. response = self.client.put(url, data, format='json', **self.header)
  172. self.assertHttpStatus(response, status.HTTP_200_OK)
  173. self.assertEqual(RIR.objects.count(), 3)
  174. rir1 = RIR.objects.get(pk=response.data['id'])
  175. self.assertEqual(rir1.name, data['name'])
  176. self.assertEqual(rir1.slug, data['slug'])
  177. def test_delete_rir(self):
  178. url = reverse('ipam-api:rir-detail', kwargs={'pk': self.rir1.pk})
  179. response = self.client.delete(url, **self.header)
  180. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  181. self.assertEqual(RIR.objects.count(), 2)
  182. class AggregateTest(APITestCase):
  183. def setUp(self):
  184. super().setUp()
  185. self.rir1 = RIR.objects.create(name='Test RIR 1', slug='test-rir-1')
  186. self.rir2 = RIR.objects.create(name='Test RIR 2', slug='test-rir-2')
  187. self.aggregate1 = Aggregate.objects.create(prefix=IPNetwork('10.0.0.0/8'), rir=self.rir1)
  188. self.aggregate2 = Aggregate.objects.create(prefix=IPNetwork('172.16.0.0/12'), rir=self.rir1)
  189. self.aggregate3 = Aggregate.objects.create(prefix=IPNetwork('192.168.0.0/16'), rir=self.rir1)
  190. def test_get_aggregate(self):
  191. url = reverse('ipam-api:aggregate-detail', kwargs={'pk': self.aggregate1.pk})
  192. response = self.client.get(url, **self.header)
  193. self.assertEqual(response.data['family']['value'], 4)
  194. self.assertEqual(response.data['prefix'], str(self.aggregate1.prefix))
  195. def test_list_aggregates(self):
  196. url = reverse('ipam-api:aggregate-list')
  197. response = self.client.get(url, **self.header)
  198. self.assertEqual(response.data['count'], 3)
  199. def test_list_aggregates_brief(self):
  200. url = reverse('ipam-api:aggregate-list')
  201. response = self.client.get('{}?brief=1'.format(url), **self.header)
  202. self.assertEqual(
  203. sorted(response.data['results'][0]),
  204. ['family', 'id', 'prefix', 'url']
  205. )
  206. def test_create_aggregate(self):
  207. data = {
  208. 'prefix': '192.0.2.0/24',
  209. 'rir': self.rir1.pk,
  210. }
  211. url = reverse('ipam-api:aggregate-list')
  212. response = self.client.post(url, data, format='json', **self.header)
  213. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  214. self.assertEqual(Aggregate.objects.count(), 4)
  215. aggregate4 = Aggregate.objects.get(pk=response.data['id'])
  216. self.assertEqual(str(aggregate4.prefix), data['prefix'])
  217. self.assertEqual(aggregate4.rir_id, data['rir'])
  218. def test_create_aggregate_bulk(self):
  219. data = [
  220. {
  221. 'prefix': '100.0.0.0/8',
  222. 'rir': self.rir1.pk,
  223. },
  224. {
  225. 'prefix': '101.0.0.0/8',
  226. 'rir': self.rir1.pk,
  227. },
  228. {
  229. 'prefix': '102.0.0.0/8',
  230. 'rir': self.rir1.pk,
  231. },
  232. ]
  233. url = reverse('ipam-api:aggregate-list')
  234. response = self.client.post(url, data, format='json', **self.header)
  235. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  236. self.assertEqual(Aggregate.objects.count(), 6)
  237. self.assertEqual(response.data[0]['prefix'], data[0]['prefix'])
  238. self.assertEqual(response.data[1]['prefix'], data[1]['prefix'])
  239. self.assertEqual(response.data[2]['prefix'], data[2]['prefix'])
  240. def test_update_aggregate(self):
  241. data = {
  242. 'prefix': '11.0.0.0/8',
  243. 'rir': self.rir2.pk,
  244. }
  245. url = reverse('ipam-api:aggregate-detail', kwargs={'pk': self.aggregate1.pk})
  246. response = self.client.put(url, data, format='json', **self.header)
  247. self.assertHttpStatus(response, status.HTTP_200_OK)
  248. self.assertEqual(Aggregate.objects.count(), 3)
  249. aggregate1 = Aggregate.objects.get(pk=response.data['id'])
  250. self.assertEqual(str(aggregate1.prefix), data['prefix'])
  251. self.assertEqual(aggregate1.rir_id, data['rir'])
  252. def test_delete_aggregate(self):
  253. url = reverse('ipam-api:aggregate-detail', kwargs={'pk': self.aggregate1.pk})
  254. response = self.client.delete(url, **self.header)
  255. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  256. self.assertEqual(Aggregate.objects.count(), 2)
  257. class RoleTest(APITestCase):
  258. def setUp(self):
  259. super().setUp()
  260. self.role1 = Role.objects.create(name='Test Role 1', slug='test-role-1')
  261. self.role2 = Role.objects.create(name='Test Role 2', slug='test-role-2')
  262. self.role3 = Role.objects.create(name='Test Role 3', slug='test-role-3')
  263. def test_get_role(self):
  264. url = reverse('ipam-api:role-detail', kwargs={'pk': self.role1.pk})
  265. response = self.client.get(url, **self.header)
  266. self.assertEqual(response.data['name'], self.role1.name)
  267. def test_list_roles(self):
  268. url = reverse('ipam-api:role-list')
  269. response = self.client.get(url, **self.header)
  270. self.assertEqual(response.data['count'], 3)
  271. def test_list_roles_brief(self):
  272. url = reverse('ipam-api:role-list')
  273. response = self.client.get('{}?brief=1'.format(url), **self.header)
  274. self.assertEqual(
  275. sorted(response.data['results'][0]),
  276. ['id', 'name', 'prefix_count', 'slug', 'url', 'vlan_count']
  277. )
  278. def test_create_role(self):
  279. data = {
  280. 'name': 'Test Role 4',
  281. 'slug': 'test-role-4',
  282. }
  283. url = reverse('ipam-api:role-list')
  284. response = self.client.post(url, data, format='json', **self.header)
  285. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  286. self.assertEqual(Role.objects.count(), 4)
  287. role4 = Role.objects.get(pk=response.data['id'])
  288. self.assertEqual(role4.name, data['name'])
  289. self.assertEqual(role4.slug, data['slug'])
  290. def test_create_role_bulk(self):
  291. data = [
  292. {
  293. 'name': 'Test Role 4',
  294. 'slug': 'test-role-4',
  295. },
  296. {
  297. 'name': 'Test Role 5',
  298. 'slug': 'test-role-5',
  299. },
  300. {
  301. 'name': 'Test Role 6',
  302. 'slug': 'test-role-6',
  303. },
  304. ]
  305. url = reverse('ipam-api:role-list')
  306. response = self.client.post(url, data, format='json', **self.header)
  307. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  308. self.assertEqual(Role.objects.count(), 6)
  309. self.assertEqual(response.data[0]['name'], data[0]['name'])
  310. self.assertEqual(response.data[1]['name'], data[1]['name'])
  311. self.assertEqual(response.data[2]['name'], data[2]['name'])
  312. def test_update_role(self):
  313. data = {
  314. 'name': 'Test Role X',
  315. 'slug': 'test-role-x',
  316. }
  317. url = reverse('ipam-api:role-detail', kwargs={'pk': self.role1.pk})
  318. response = self.client.put(url, data, format='json', **self.header)
  319. self.assertHttpStatus(response, status.HTTP_200_OK)
  320. self.assertEqual(Role.objects.count(), 3)
  321. role1 = Role.objects.get(pk=response.data['id'])
  322. self.assertEqual(role1.name, data['name'])
  323. self.assertEqual(role1.slug, data['slug'])
  324. def test_delete_role(self):
  325. url = reverse('ipam-api:role-detail', kwargs={'pk': self.role1.pk})
  326. response = self.client.delete(url, **self.header)
  327. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  328. self.assertEqual(Role.objects.count(), 2)
  329. class PrefixTest(APITestCase):
  330. def setUp(self):
  331. super().setUp()
  332. self.site1 = Site.objects.create(name='Test Site 1', slug='test-site-1')
  333. self.vrf1 = VRF.objects.create(name='Test VRF 1', rd='65000:1')
  334. self.vlan1 = VLAN.objects.create(vid=1, name='Test VLAN 1')
  335. self.role1 = Role.objects.create(name='Test Role 1', slug='test-role-1')
  336. self.prefix1 = Prefix.objects.create(prefix=IPNetwork('192.168.1.0/24'))
  337. self.prefix2 = Prefix.objects.create(prefix=IPNetwork('192.168.2.0/24'))
  338. self.prefix3 = Prefix.objects.create(prefix=IPNetwork('192.168.3.0/24'))
  339. def test_get_prefix(self):
  340. url = reverse('ipam-api:prefix-detail', kwargs={'pk': self.prefix1.pk})
  341. response = self.client.get(url, **self.header)
  342. self.assertEqual(response.data['family']['value'], 4)
  343. self.assertEqual(response.data['prefix'], str(self.prefix1.prefix))
  344. def test_list_prefixes(self):
  345. url = reverse('ipam-api:prefix-list')
  346. response = self.client.get(url, **self.header)
  347. self.assertEqual(response.data['count'], 3)
  348. def test_list_prefixes_brief(self):
  349. url = reverse('ipam-api:prefix-list')
  350. response = self.client.get('{}?brief=1'.format(url), **self.header)
  351. self.assertEqual(
  352. sorted(response.data['results'][0]),
  353. ['family', 'id', 'prefix', 'url']
  354. )
  355. def test_create_prefix(self):
  356. data = {
  357. 'prefix': '192.168.4.0/24',
  358. 'site': self.site1.pk,
  359. 'vrf': self.vrf1.pk,
  360. 'vlan': self.vlan1.pk,
  361. 'role': self.role1.pk,
  362. }
  363. url = reverse('ipam-api:prefix-list')
  364. response = self.client.post(url, data, format='json', **self.header)
  365. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  366. self.assertEqual(Prefix.objects.count(), 4)
  367. prefix4 = Prefix.objects.get(pk=response.data['id'])
  368. self.assertEqual(str(prefix4.prefix), data['prefix'])
  369. self.assertEqual(prefix4.site_id, data['site'])
  370. self.assertEqual(prefix4.vrf_id, data['vrf'])
  371. self.assertEqual(prefix4.vlan_id, data['vlan'])
  372. self.assertEqual(prefix4.role_id, data['role'])
  373. def test_create_prefix_bulk(self):
  374. data = [
  375. {
  376. 'prefix': '10.0.1.0/24',
  377. },
  378. {
  379. 'prefix': '10.0.2.0/24',
  380. },
  381. {
  382. 'prefix': '10.0.3.0/24',
  383. },
  384. ]
  385. url = reverse('ipam-api:prefix-list')
  386. response = self.client.post(url, data, format='json', **self.header)
  387. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  388. self.assertEqual(Prefix.objects.count(), 6)
  389. self.assertEqual(response.data[0]['prefix'], data[0]['prefix'])
  390. self.assertEqual(response.data[1]['prefix'], data[1]['prefix'])
  391. self.assertEqual(response.data[2]['prefix'], data[2]['prefix'])
  392. def test_update_prefix(self):
  393. data = {
  394. 'prefix': '192.168.99.0/24',
  395. 'site': self.site1.pk,
  396. 'vrf': self.vrf1.pk,
  397. 'vlan': self.vlan1.pk,
  398. 'role': self.role1.pk,
  399. }
  400. url = reverse('ipam-api:prefix-detail', kwargs={'pk': self.prefix1.pk})
  401. response = self.client.put(url, data, format='json', **self.header)
  402. self.assertHttpStatus(response, status.HTTP_200_OK)
  403. self.assertEqual(Prefix.objects.count(), 3)
  404. prefix1 = Prefix.objects.get(pk=response.data['id'])
  405. self.assertEqual(str(prefix1.prefix), data['prefix'])
  406. self.assertEqual(prefix1.site_id, data['site'])
  407. self.assertEqual(prefix1.vrf_id, data['vrf'])
  408. self.assertEqual(prefix1.vlan_id, data['vlan'])
  409. self.assertEqual(prefix1.role_id, data['role'])
  410. def test_delete_prefix(self):
  411. url = reverse('ipam-api:prefix-detail', kwargs={'pk': self.prefix1.pk})
  412. response = self.client.delete(url, **self.header)
  413. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  414. self.assertEqual(Prefix.objects.count(), 2)
  415. def test_list_available_prefixes(self):
  416. prefix = Prefix.objects.create(prefix=IPNetwork('192.0.2.0/24'))
  417. Prefix.objects.create(prefix=IPNetwork('192.0.2.64/26'))
  418. Prefix.objects.create(prefix=IPNetwork('192.0.2.192/27'))
  419. url = reverse('ipam-api:prefix-available-prefixes', kwargs={'pk': prefix.pk})
  420. # Retrieve all available IPs
  421. response = self.client.get(url, **self.header)
  422. available_prefixes = ['192.0.2.0/26', '192.0.2.128/26', '192.0.2.224/27']
  423. for i, p in enumerate(response.data):
  424. self.assertEqual(p['prefix'], available_prefixes[i])
  425. def test_create_single_available_prefix(self):
  426. vrf = VRF.objects.create(name='Test VRF 1', rd='1234')
  427. prefix = Prefix.objects.create(prefix=IPNetwork('192.0.2.0/28'), vrf=vrf, is_pool=True)
  428. url = reverse('ipam-api:prefix-available-prefixes', kwargs={'pk': prefix.pk})
  429. # Create four available prefixes with individual requests
  430. prefixes_to_be_created = [
  431. '192.0.2.0/30',
  432. '192.0.2.4/30',
  433. '192.0.2.8/30',
  434. '192.0.2.12/30',
  435. ]
  436. for i in range(4):
  437. data = {
  438. 'prefix_length': 30,
  439. 'description': 'Test Prefix {}'.format(i + 1)
  440. }
  441. response = self.client.post(url, data, format='json', **self.header)
  442. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  443. self.assertEqual(response.data['prefix'], prefixes_to_be_created[i])
  444. self.assertEqual(response.data['vrf']['id'], vrf.pk)
  445. self.assertEqual(response.data['description'], data['description'])
  446. # Try to create one more prefix
  447. response = self.client.post(url, {'prefix_length': 30}, format='json', **self.header)
  448. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  449. self.assertIn('detail', response.data)
  450. # Try to create invalid prefix type
  451. response = self.client.post(url, {'prefix_length': '30'}, format='json', **self.header)
  452. self.assertHttpStatus(response, status.HTTP_400_BAD_REQUEST)
  453. self.assertIn('prefix_length', response.data[0])
  454. def test_create_multiple_available_prefixes(self):
  455. prefix = Prefix.objects.create(prefix=IPNetwork('192.0.2.0/28'), is_pool=True)
  456. url = reverse('ipam-api:prefix-available-prefixes', kwargs={'pk': prefix.pk})
  457. # Try to create five /30s (only four are available)
  458. data = [
  459. {'prefix_length': 30, 'description': 'Test Prefix 1'},
  460. {'prefix_length': 30, 'description': 'Test Prefix 2'},
  461. {'prefix_length': 30, 'description': 'Test Prefix 3'},
  462. {'prefix_length': 30, 'description': 'Test Prefix 4'},
  463. {'prefix_length': 30, 'description': 'Test Prefix 5'},
  464. ]
  465. response = self.client.post(url, data, format='json', **self.header)
  466. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  467. self.assertIn('detail', response.data)
  468. # Verify that no prefixes were created (the entire /28 is still available)
  469. response = self.client.get(url, **self.header)
  470. self.assertEqual(response.data[0]['prefix'], '192.0.2.0/28')
  471. # Create four /30s in a single request
  472. response = self.client.post(url, data[:4], format='json', **self.header)
  473. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  474. self.assertEqual(len(response.data), 4)
  475. def test_list_available_ips(self):
  476. prefix = Prefix.objects.create(prefix=IPNetwork('192.0.2.0/29'), is_pool=True)
  477. url = reverse('ipam-api:prefix-available-ips', kwargs={'pk': prefix.pk})
  478. # Retrieve all available IPs
  479. response = self.client.get(url, **self.header)
  480. self.assertEqual(len(response.data), 8) # 8 because prefix.is_pool = True
  481. # Change the prefix to not be a pool and try again
  482. prefix.is_pool = False
  483. prefix.save()
  484. response = self.client.get(url, **self.header)
  485. self.assertEqual(len(response.data), 6) # 8 - 2 because prefix.is_pool = False
  486. def test_create_single_available_ip(self):
  487. vrf = VRF.objects.create(name='Test VRF 1', rd='1234')
  488. prefix = Prefix.objects.create(prefix=IPNetwork('192.0.2.0/30'), vrf=vrf, is_pool=True)
  489. url = reverse('ipam-api:prefix-available-ips', kwargs={'pk': prefix.pk})
  490. # Create all four available IPs with individual requests
  491. for i in range(1, 5):
  492. data = {
  493. 'description': 'Test IP {}'.format(i)
  494. }
  495. response = self.client.post(url, data, format='json', **self.header)
  496. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  497. self.assertEqual(response.data['vrf']['id'], vrf.pk)
  498. self.assertEqual(response.data['description'], data['description'])
  499. # Try to create one more IP
  500. response = self.client.post(url, {}, **self.header)
  501. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  502. self.assertIn('detail', response.data)
  503. def test_create_multiple_available_ips(self):
  504. prefix = Prefix.objects.create(prefix=IPNetwork('192.0.2.0/29'), is_pool=True)
  505. url = reverse('ipam-api:prefix-available-ips', kwargs={'pk': prefix.pk})
  506. # Try to create nine IPs (only eight are available)
  507. data = [{'description': 'Test IP {}'.format(i)} for i in range(1, 10)] # 9 IPs
  508. response = self.client.post(url, data, format='json', **self.header)
  509. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  510. self.assertIn('detail', response.data)
  511. # Verify that no IPs were created (eight are still available)
  512. response = self.client.get(url, **self.header)
  513. self.assertEqual(len(response.data), 8)
  514. # Create all eight available IPs in a single request
  515. data = [{'description': 'Test IP {}'.format(i)} for i in range(1, 9)] # 8 IPs
  516. response = self.client.post(url, data, format='json', **self.header)
  517. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  518. self.assertEqual(len(response.data), 8)
  519. class IPAddressTest(APITestCase):
  520. def setUp(self):
  521. super().setUp()
  522. self.vrf1 = VRF.objects.create(name='Test VRF 1', rd='65000:1')
  523. self.ipaddress1 = IPAddress.objects.create(address=IPNetwork('192.168.0.1/24'))
  524. self.ipaddress2 = IPAddress.objects.create(address=IPNetwork('192.168.0.2/24'))
  525. self.ipaddress3 = IPAddress.objects.create(address=IPNetwork('192.168.0.3/24'))
  526. def test_get_ipaddress(self):
  527. url = reverse('ipam-api:ipaddress-detail', kwargs={'pk': self.ipaddress1.pk})
  528. response = self.client.get(url, **self.header)
  529. self.assertEqual(response.data['family']['value'], 4)
  530. self.assertEqual(response.data['address'], str(self.ipaddress1.address))
  531. def test_list_ipaddresss(self):
  532. url = reverse('ipam-api:ipaddress-list')
  533. response = self.client.get(url, **self.header)
  534. self.assertEqual(response.data['count'], 3)
  535. def test_list_ipaddresses_brief(self):
  536. url = reverse('ipam-api:ipaddress-list')
  537. response = self.client.get('{}?brief=1'.format(url), **self.header)
  538. self.assertEqual(
  539. sorted(response.data['results'][0]),
  540. ['address', 'family', 'id', 'url']
  541. )
  542. def test_create_ipaddress(self):
  543. data = {
  544. 'address': '192.168.0.4/24',
  545. 'vrf': self.vrf1.pk,
  546. }
  547. url = reverse('ipam-api:ipaddress-list')
  548. response = self.client.post(url, data, format='json', **self.header)
  549. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  550. self.assertEqual(IPAddress.objects.count(), 4)
  551. ipaddress4 = IPAddress.objects.get(pk=response.data['id'])
  552. self.assertEqual(str(ipaddress4.address), data['address'])
  553. self.assertEqual(ipaddress4.vrf_id, data['vrf'])
  554. def test_create_ipaddress_bulk(self):
  555. data = [
  556. {
  557. 'address': '192.168.0.4/24',
  558. },
  559. {
  560. 'address': '192.168.0.5/24',
  561. },
  562. {
  563. 'address': '192.168.0.6/24',
  564. },
  565. ]
  566. url = reverse('ipam-api:ipaddress-list')
  567. response = self.client.post(url, data, format='json', **self.header)
  568. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  569. self.assertEqual(IPAddress.objects.count(), 6)
  570. self.assertEqual(response.data[0]['address'], data[0]['address'])
  571. self.assertEqual(response.data[1]['address'], data[1]['address'])
  572. self.assertEqual(response.data[2]['address'], data[2]['address'])
  573. def test_update_ipaddress(self):
  574. data = {
  575. 'address': '192.168.0.99/24',
  576. 'vrf': self.vrf1.pk,
  577. }
  578. url = reverse('ipam-api:ipaddress-detail', kwargs={'pk': self.ipaddress1.pk})
  579. response = self.client.put(url, data, format='json', **self.header)
  580. self.assertHttpStatus(response, status.HTTP_200_OK)
  581. self.assertEqual(IPAddress.objects.count(), 3)
  582. ipaddress1 = IPAddress.objects.get(pk=response.data['id'])
  583. self.assertEqual(str(ipaddress1.address), data['address'])
  584. self.assertEqual(ipaddress1.vrf_id, data['vrf'])
  585. def test_delete_ipaddress(self):
  586. url = reverse('ipam-api:ipaddress-detail', kwargs={'pk': self.ipaddress1.pk})
  587. response = self.client.delete(url, **self.header)
  588. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  589. self.assertEqual(IPAddress.objects.count(), 2)
  590. class VLANGroupTest(APITestCase):
  591. def setUp(self):
  592. super().setUp()
  593. self.vlangroup1 = VLANGroup.objects.create(name='Test VLAN Group 1', slug='test-vlan-group-1')
  594. self.vlangroup2 = VLANGroup.objects.create(name='Test VLAN Group 2', slug='test-vlan-group-2')
  595. self.vlangroup3 = VLANGroup.objects.create(name='Test VLAN Group 3', slug='test-vlan-group-3')
  596. def test_get_vlangroup(self):
  597. url = reverse('ipam-api:vlangroup-detail', kwargs={'pk': self.vlangroup1.pk})
  598. response = self.client.get(url, **self.header)
  599. self.assertEqual(response.data['name'], self.vlangroup1.name)
  600. def test_list_vlangroups(self):
  601. url = reverse('ipam-api:vlangroup-list')
  602. response = self.client.get(url, **self.header)
  603. self.assertEqual(response.data['count'], 3)
  604. def test_list_vlangroups_brief(self):
  605. url = reverse('ipam-api:vlangroup-list')
  606. response = self.client.get('{}?brief=1'.format(url), **self.header)
  607. self.assertEqual(
  608. sorted(response.data['results'][0]),
  609. ['id', 'name', 'slug', 'url', 'vlan_count']
  610. )
  611. def test_create_vlangroup(self):
  612. data = {
  613. 'name': 'Test VLAN Group 4',
  614. 'slug': 'test-vlan-group-4',
  615. }
  616. url = reverse('ipam-api:vlangroup-list')
  617. response = self.client.post(url, data, format='json', **self.header)
  618. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  619. self.assertEqual(VLANGroup.objects.count(), 4)
  620. vlangroup4 = VLANGroup.objects.get(pk=response.data['id'])
  621. self.assertEqual(vlangroup4.name, data['name'])
  622. self.assertEqual(vlangroup4.slug, data['slug'])
  623. def test_create_vlangroup_bulk(self):
  624. data = [
  625. {
  626. 'name': 'Test VLAN Group 4',
  627. 'slug': 'test-vlan-group-4',
  628. },
  629. {
  630. 'name': 'Test VLAN Group 5',
  631. 'slug': 'test-vlan-group-5',
  632. },
  633. {
  634. 'name': 'Test VLAN Group 6',
  635. 'slug': 'test-vlan-group-6',
  636. },
  637. ]
  638. url = reverse('ipam-api:vlangroup-list')
  639. response = self.client.post(url, data, format='json', **self.header)
  640. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  641. self.assertEqual(VLANGroup.objects.count(), 6)
  642. self.assertEqual(response.data[0]['name'], data[0]['name'])
  643. self.assertEqual(response.data[1]['name'], data[1]['name'])
  644. self.assertEqual(response.data[2]['name'], data[2]['name'])
  645. def test_update_vlangroup(self):
  646. data = {
  647. 'name': 'Test VLAN Group X',
  648. 'slug': 'test-vlan-group-x',
  649. }
  650. url = reverse('ipam-api:vlangroup-detail', kwargs={'pk': self.vlangroup1.pk})
  651. response = self.client.put(url, data, format='json', **self.header)
  652. self.assertHttpStatus(response, status.HTTP_200_OK)
  653. self.assertEqual(VLANGroup.objects.count(), 3)
  654. vlangroup1 = VLANGroup.objects.get(pk=response.data['id'])
  655. self.assertEqual(vlangroup1.name, data['name'])
  656. self.assertEqual(vlangroup1.slug, data['slug'])
  657. def test_delete_vlangroup(self):
  658. url = reverse('ipam-api:vlangroup-detail', kwargs={'pk': self.vlangroup1.pk})
  659. response = self.client.delete(url, **self.header)
  660. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  661. self.assertEqual(VLANGroup.objects.count(), 2)
  662. class VLANTest(APITestCase):
  663. def setUp(self):
  664. super().setUp()
  665. self.vlan1 = VLAN.objects.create(vid=1, name='Test VLAN 1')
  666. self.vlan2 = VLAN.objects.create(vid=2, name='Test VLAN 2')
  667. self.vlan3 = VLAN.objects.create(vid=3, name='Test VLAN 3')
  668. self.prefix1 = Prefix.objects.create(prefix=IPNetwork('192.168.1.0/24'))
  669. def test_get_vlan(self):
  670. url = reverse('ipam-api:vlan-detail', kwargs={'pk': self.vlan1.pk})
  671. response = self.client.get(url, **self.header)
  672. self.assertEqual(response.data['name'], self.vlan1.name)
  673. def test_list_vlans(self):
  674. url = reverse('ipam-api:vlan-list')
  675. response = self.client.get(url, **self.header)
  676. self.assertEqual(response.data['count'], 3)
  677. def test_list_vlans_brief(self):
  678. url = reverse('ipam-api:vlan-list')
  679. response = self.client.get('{}?brief=1'.format(url), **self.header)
  680. self.assertEqual(
  681. sorted(response.data['results'][0]),
  682. ['display_name', 'id', 'name', 'url', 'vid']
  683. )
  684. def test_create_vlan(self):
  685. data = {
  686. 'vid': 4,
  687. 'name': 'Test VLAN 4',
  688. }
  689. url = reverse('ipam-api:vlan-list')
  690. response = self.client.post(url, data, format='json', **self.header)
  691. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  692. self.assertEqual(VLAN.objects.count(), 4)
  693. vlan4 = VLAN.objects.get(pk=response.data['id'])
  694. self.assertEqual(vlan4.vid, data['vid'])
  695. self.assertEqual(vlan4.name, data['name'])
  696. def test_create_vlan_bulk(self):
  697. data = [
  698. {
  699. 'vid': 4,
  700. 'name': 'Test VLAN 4',
  701. },
  702. {
  703. 'vid': 5,
  704. 'name': 'Test VLAN 5',
  705. },
  706. {
  707. 'vid': 6,
  708. 'name': 'Test VLAN 6',
  709. },
  710. ]
  711. url = reverse('ipam-api:vlan-list')
  712. response = self.client.post(url, data, format='json', **self.header)
  713. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  714. self.assertEqual(VLAN.objects.count(), 6)
  715. self.assertEqual(response.data[0]['name'], data[0]['name'])
  716. self.assertEqual(response.data[1]['name'], data[1]['name'])
  717. self.assertEqual(response.data[2]['name'], data[2]['name'])
  718. def test_update_vlan(self):
  719. data = {
  720. 'vid': 99,
  721. 'name': 'Test VLAN X',
  722. }
  723. url = reverse('ipam-api:vlan-detail', kwargs={'pk': self.vlan1.pk})
  724. response = self.client.put(url, data, format='json', **self.header)
  725. self.assertHttpStatus(response, status.HTTP_200_OK)
  726. self.assertEqual(VLAN.objects.count(), 3)
  727. vlan1 = VLAN.objects.get(pk=response.data['id'])
  728. self.assertEqual(vlan1.vid, data['vid'])
  729. self.assertEqual(vlan1.name, data['name'])
  730. def test_delete_vlan(self):
  731. url = reverse('ipam-api:vlan-detail', kwargs={'pk': self.vlan1.pk})
  732. response = self.client.delete(url, **self.header)
  733. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  734. self.assertEqual(VLAN.objects.count(), 2)
  735. def test_delete_vlan_with_prefix(self):
  736. self.prefix1.vlan = self.vlan1
  737. self.prefix1.save()
  738. url = reverse('ipam-api:vlan-detail', kwargs={'pk': self.vlan1.pk})
  739. with disable_warnings('django.request'):
  740. response = self.client.delete(url, **self.header)
  741. self.assertHttpStatus(response, status.HTTP_409_CONFLICT)
  742. content = json.loads(response.content.decode('utf-8'))
  743. self.assertIn('detail', content)
  744. self.assertTrue(content['detail'].startswith('Unable to delete object.'))
  745. class ServiceTest(APITestCase):
  746. def setUp(self):
  747. super().setUp()
  748. site = Site.objects.create(name='Test Site 1', slug='test-site-1')
  749. manufacturer = Manufacturer.objects.create(name='Test Manufacturer 1', slug='test-manufacturer-1')
  750. devicetype = DeviceType.objects.create(manufacturer=manufacturer, model='Test Device Type 1')
  751. devicerole = DeviceRole.objects.create(name='Test Device Role 1', slug='test-device-role-1')
  752. self.device1 = Device.objects.create(
  753. name='Test Device 1', site=site, device_type=devicetype, device_role=devicerole
  754. )
  755. self.device2 = Device.objects.create(
  756. name='Test Device 2', site=site, device_type=devicetype, device_role=devicerole
  757. )
  758. self.service1 = Service.objects.create(
  759. device=self.device1, name='Test Service 1', protocol=ServiceProtocolChoices.PROTOCOL_TCP, port=1
  760. )
  761. self.service1 = Service.objects.create(
  762. device=self.device1, name='Test Service 2', protocol=ServiceProtocolChoices.PROTOCOL_TCP, port=2
  763. )
  764. self.service1 = Service.objects.create(
  765. device=self.device1, name='Test Service 3', protocol=ServiceProtocolChoices.PROTOCOL_TCP, port=3
  766. )
  767. def test_get_service(self):
  768. url = reverse('ipam-api:service-detail', kwargs={'pk': self.service1.pk})
  769. response = self.client.get(url, **self.header)
  770. self.assertEqual(response.data['name'], self.service1.name)
  771. def test_list_services(self):
  772. url = reverse('ipam-api:service-list')
  773. response = self.client.get(url, **self.header)
  774. self.assertEqual(response.data['count'], 3)
  775. def test_create_service(self):
  776. data = {
  777. 'device': self.device1.pk,
  778. 'name': 'Test Service 4',
  779. 'protocol': ServiceProtocolChoices.PROTOCOL_TCP,
  780. 'port': 4,
  781. 'tags': ['Foo', 'Bar'],
  782. }
  783. url = reverse('ipam-api:service-list')
  784. response = self.client.post(url, data, format='json', **self.header)
  785. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  786. self.assertEqual(Service.objects.count(), 4)
  787. service4 = Service.objects.get(pk=response.data['id'])
  788. self.assertEqual(service4.device_id, data['device'])
  789. self.assertEqual(service4.name, data['name'])
  790. self.assertEqual(service4.protocol, data['protocol'])
  791. self.assertEqual(service4.port, data['port'])
  792. tags = [tag.name for tag in service4.tags.all()]
  793. self.assertEqual(sorted(tags), sorted(data['tags']))
  794. def test_create_service_bulk(self):
  795. data = [
  796. {
  797. 'device': self.device1.pk,
  798. 'name': 'Test Service 4',
  799. 'protocol': ServiceProtocolChoices.PROTOCOL_TCP,
  800. 'port': 4,
  801. },
  802. {
  803. 'device': self.device1.pk,
  804. 'name': 'Test Service 5',
  805. 'protocol': ServiceProtocolChoices.PROTOCOL_TCP,
  806. 'port': 5,
  807. },
  808. {
  809. 'device': self.device1.pk,
  810. 'name': 'Test Service 6',
  811. 'protocol': ServiceProtocolChoices.PROTOCOL_TCP,
  812. 'port': 6,
  813. },
  814. ]
  815. url = reverse('ipam-api:service-list')
  816. response = self.client.post(url, data, format='json', **self.header)
  817. self.assertHttpStatus(response, status.HTTP_201_CREATED)
  818. self.assertEqual(Service.objects.count(), 6)
  819. self.assertEqual(response.data[0]['name'], data[0]['name'])
  820. self.assertEqual(response.data[1]['name'], data[1]['name'])
  821. self.assertEqual(response.data[2]['name'], data[2]['name'])
  822. def test_update_service(self):
  823. data = {
  824. 'device': self.device2.pk,
  825. 'name': 'Test Service X',
  826. 'protocol': ServiceProtocolChoices.PROTOCOL_UDP,
  827. 'port': 99,
  828. }
  829. url = reverse('ipam-api:service-detail', kwargs={'pk': self.service1.pk})
  830. response = self.client.put(url, data, format='json', **self.header)
  831. self.assertHttpStatus(response, status.HTTP_200_OK)
  832. self.assertEqual(Service.objects.count(), 3)
  833. service1 = Service.objects.get(pk=response.data['id'])
  834. self.assertEqual(service1.device_id, data['device'])
  835. self.assertEqual(service1.name, data['name'])
  836. self.assertEqual(service1.protocol, data['protocol'])
  837. self.assertEqual(service1.port, data['port'])
  838. def test_delete_service(self):
  839. url = reverse('ipam-api:service-detail', kwargs={'pk': self.service1.pk})
  840. response = self.client.delete(url, **self.header)
  841. self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
  842. self.assertEqual(Service.objects.count(), 2)