Files
@ b02e16dc7708
Branch filter:
Location: conntrackt/conntrackt/tests/test_models.py
b02e16dc7708
13.8 KiB
text/x-python
CONNT-17: Added tabelarised representation of communications to the project details page with colour-coding.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 | # -*- coding: utf-8 -*-
#
# Copyright (C) 2013 Branko Majic
#
# This file is part of Django Conntrackt.
#
# Django Conntrackt is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option) any
# later version.
#
# Django Conntrackt is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# Django Conntrackt. If not, see <http://www.gnu.org/licenses/>.
#
# Standard Python library import.
import collections
# Python third-party library imports.
import mock
# Django imports.
from django.core.exceptions import ValidationError
from django.db import IntegrityError
from django.db.models import Model
from django.test import TestCase
# Application imports.
from conntrackt.models import Project, Location, Entity, Interface, Communication
from conntrackt.models import SearchManager
from conntrackt.models import NestedObjects
from conntrackt.utils import list_formatter_callback
# Test imports.
from .factories import ProjectFactory, LocationFactory
from .factories import ServerEntityFactory, ServerInterfaceFactory
from .factories import SubnetEntityFactory, SubnetInterfaceFactory
from .factories import CommunicationFactory
from .factories import setup_test_data
class RelatedCollectorMixinTest(TestCase):
@mock.patch.object(NestedObjects, "collect")
@mock.patch.object(NestedObjects, "nested")
def test_get_dependant_objects_method_calls(self, nested_mock, collect_mock):
"""
Tests if correct methods are being called with correct arguments during
the invocation of get_dependant_objects method.
"""
# Set-up some test data.
project = ProjectFactory()
# Call the method.
project.get_dependant_objects()
# Check if correct collector methods were called.
collect_mock.assert_called_with([project])
nested_mock.assert_called_with()
def test_get_dependant_objects_return_value(self):
"""
Tests the return value of get_dependant_objects method.
"""
# Set-up some test data.
project = ProjectFactory()
location = LocationFactory()
entity1 = ServerEntityFactory(pk=1, project=project, location=location)
entity2 = ServerEntityFactory(pk=2, project=project, location=location)
communication1 = CommunicationFactory(pk=1, source_id=1, destination_id=2, protocol="TCP", port="22")
# Get the dependant objects.
dependant_objects = project.get_dependant_objects()
# Create a small local function for traversing the recursive list.
def traverse(data):
# If data is iterable, verify it is a list, and process its members
# as well. If data is not iterable, make sure it is descendant of
# Django Model class.
if isinstance(data, collections.Iterable):
self.assertIsInstance(data, list)
for element in data:
traverse(element)
else:
self.assertIsInstance(data, Model)
# Traverse the obtained dependant objects.
traverse(dependant_objects)
@mock.patch.object(NestedObjects, "collect")
@mock.patch.object(NestedObjects, "nested")
def test_get_dependant_objects_representation_method_calls(self, nested_mock, collect_mock):
"""
Tests if correct methods are being called with correct arguments during
the invocation of get_dependant_objects method.
"""
# Set-up some test data.
project = ProjectFactory()
# Call the method.
project.get_dependant_objects_representation()
# Check if correct collector methods were called.
collect_mock.assert_called_with([project])
nested_mock.assert_called_with(list_formatter_callback)
def test_get_dependant_objects_representation_return_value(self):
"""
Tests the return value of get_dependant_objects_representation method.
"""
# Set-up some test data.
project = ProjectFactory()
location = LocationFactory()
entity1 = ServerEntityFactory(pk=1, project=project, location=location)
entity2 = ServerEntityFactory(pk=2, project=project, location=location)
communication1 = CommunicationFactory(pk=1, source_id=1, destination_id=2, protocol="TCP", port="22")
# Get the dependant objects.
dependant_objects = project.get_dependant_objects_representation()
# Create a small local function for traversing the recursive list.
def traverse(data):
# If data is iterable, verify it is a list, and process its members
# as well. If data is not iterable, make sure it is descendant of
# Django Model class.
if isinstance(data, collections.Iterable) and not isinstance(data, str):
self.assertIsInstance(data, list)
for element in data:
traverse(element)
else:
self.assertIsInstance(data, str)
# Traverse the obtained dependant objects.
traverse(dependant_objects)
class ProjectTest(TestCase):
def test_unique_name(self):
"""
Test if unique project name is enforced.
"""
project = ProjectFactory()
self.assertRaises(IntegrityError, ProjectFactory, name=project.name)
def test_representation(self):
"""
Test the representation of project.
"""
project = ProjectFactory(name="Test Project")
self.assertEqual(str(project), "Test Project")
def test_absolute_url(self):
"""
Tests if the absolute URL is generated properly.
"""
project = ProjectFactory(pk=1)
self.assertEqual(project.get_absolute_url(), "/conntrackt/project/1/")
def test_custom_manager(self):
"""
Tests if the custom manager is being used.
"""
self.assertIsInstance(Project.objects, SearchManager)
class LocationTest(TestCase):
def test_unique_name(self):
"""
Test if unique location name is enforced.
"""
location = LocationFactory()
self.assertRaises(IntegrityError, LocationFactory, name=location.name)
def test_representation(self):
"""
Test the representation of location.
"""
project = LocationFactory(name="Test Location")
self.assertEqual(str(project), "Test Location")
class EntityTest(TestCase):
def setUp(cls):
"""
Set-up some test data.
"""
setup_test_data()
def test_incoming_communications(self):
"""
Test that we get correct list of incoming connections with the sample
data.
"""
entity = Entity.objects.get(pk=1)
incoming = Communication.objects.filter(pk__in=(1, 2, 3, 5))
self.assertItemsEqual(entity.incoming_communications(), incoming)
def test_outgoing_communications(self):
"""
Test that we get correct list of outgoing connections with the sample
data.
"""
entity = Entity.objects.get(pk=1)
outgoing = Communication.objects.filter(pk__in=(4, 6))
self.assertItemsEqual(entity.outgoing_communications(), outgoing)
def test_representation(self):
"""
Test the representation of entity.
"""
ent = Entity.objects.get(pk=1)
representation = "Test Entity 1 (Test Project 1 - Test Location 1)"
self.assertEqual(str(ent), representation)
def test_unique_name(self):
"""
Test if unique entity name is enforced across same project.
"""
entity1 = Entity.objects.get(pk=1)
entity_dup = Entity(name=entity1.name, description="Duplicate entity.", project=entity1.project, location=entity1.location)
self.assertRaises(IntegrityError, entity_dup.save)
def test_absolute_url(self):
"""
Tests if the absolute URL is generated properly.
"""
entity = Entity.objects.get(pk=1)
self.assertEqual(entity.get_absolute_url(), "/conntrackt/entity/1/")
def test_project_move_constraints(self):
"""
Tests if entity is prevented from being moved to different project in
case of existing communications.
"""
entity = Entity.objects.get(pk=1)
new_project = Project.objects.get(pk=2)
entity.project = new_project
self.assertRaisesRegexp(ValidationError, "The entity cannot be moved to different project as long as it has valid communications with entities in current project.", entity.clean)
def test_custom_manager(self):
"""
Tests if the custom manager is being used.
"""
self.assertIsInstance(Entity.objects, SearchManager)
class InterfaceTest(TestCase):
def setUp(self):
"""
Set-up some test data.
"""
setup_test_data()
def test_unique_name(self):
"""
Test if unique interface name is enforced across same entity.
"""
entity = Entity.objects.get(pk=1)
interface = entity.interface_set.get(pk=1)
duplicate = Interface(name=interface.name, description="Duplicate interface.", entity=entity, address="10.10.10.10", netmask="255.255.255.255")
self.assertRaises(IntegrityError, duplicate.save)
def test_unique_address(self):
"""
Test if unique address/netmask is enforced across same entity.
"""
entity = Entity.objects.get(pk=1)
interface = entity.interface_set.get(pk=1)
duplicate = Interface(name="eth1", description="Duplicate address", entity=entity, address=interface.address, netmask=interface.netmask)
self.assertRaises(IntegrityError, duplicate.save)
def test_representation_single(self):
"""
Test representation of single IP address.
"""
interface = Entity.objects.get(name="Test Entity 1").interface_set.get(name="eth0")
representation = "Test Entity 1 (192.168.1.1)"
self.assertEqual(str(interface), representation)
def test_representation_subnet(self):
"""
Test representation of subnet.
"""
interface = Entity.objects.get(pk=4).interface_set.get(name="switch0")
representation = "Test Subnet 4 (10.10.4.0/255.255.255.0)"
self.assertEqual(str(interface), representation)
class CommunicationTest(TestCase):
def setUp(self):
"""
Set-up some test data.
"""
setup_test_data()
def test_unique_communication(self):
"""
Test enforcement of unique communications.
"""
comm = Communication.objects.get(pk=1)
self.assertRaises(IntegrityError, Communication.objects.create, source=comm.source, destination=comm.destination, protocol=comm.protocol, port=comm.port, description="Duplicate communication.")
def test_project_same(self):
"""
Test enforcement of same project entities for communications.
"""
ent1 = Entity.objects.get(pk=1)
ent1_eth0 = ent1.interface_set.get(name="eth0")
ent5 = Entity.objects.get(pk=5)
ent5_eth0 = ent5.interface_set.get(name="eth0")
# Set-up a communication between different projects.
comm = Communication.objects.create(source=ent1_eth0, destination=ent5_eth0, protocol="ICMP", port="8", description="Ping.")
self.assertRaisesRegexp(ValidationError, 'Source and destination entities do not belong to the same project', comm.full_clean)
def test_same_entity(self):
"""
Test enforcement of differing entities for communication.
"""
ent = Entity.objects.get(pk=1)
ent_eth0 = ent.interface_set.get(name="eth0")
# Set-up a communication between same entity.
comm = Communication.objects.create(source=ent_eth0, destination=ent_eth0, protocol="ICMP", port="8", description="Ping.")
self.assertRaisesRegexp(ValidationError, "Source and destination entities are identical.", comm.full_clean)
def test_unsupported_protocol(self):
"""
Test enforcement of supported protocol.
"""
ent1 = Entity.objects.get(pk=1)
ent1_eth0 = ent1.interface_set.get(name="eth0")
ent2 = Entity.objects.get(pk=2)
ent2_eth0 = ent2.interface_set.get(name="eth0")
comm = Communication(source=ent1_eth0, destination=ent2_eth0, protocol="BOGUS", port="1234")
self.assertRaisesRegexp(ValidationError, "BOGUS is not a supported protocol.", comm.full_clean)
def test_edit_link(self):
"""
Tests the function for getting the edit link string.
"""
comm = Communication.objects.get(pk=1)
self.assertEqual("Edit", comm.edit_link())
def test_representation(self):
"""
Test the representation of communication.
"""
comm = Communication.objects.get(pk=1)
expected = "Test Entity 2 -> Test Entity 1 (TCP:22)"
self.assertEqual(expected, str(comm))
def test_source_representation(self):
"""
Test the representation of communication from source perspective.
"""
comm = Communication.objects.get(pk=1)
expected = "Test Entity 2 (192.168.1.2) - TCP: 22"
self.assertEqual(expected, comm.source_representation())
def test_destination_representation(self):
"""
Test the representation of communication from destination perspective.
"""
comm = Communication.objects.get(pk=1)
expected = "Test Entity 1 (192.168.1.1) - TCP: 22"
self.assertEqual(expected, comm.destination_representation())
|