Merged PR 354: Network focussed dev config documentation

## Summary Built three networks, one is the minimal network, one is a basic LAN, and another is a nice beefy multi-LAN setup with ISP and DNS along with applications, services. Documented the process when building the config files. Included the config files as example configs for use. ## Test process Tested the shit out of the big multi-lan network. ## Checklist - [ ] PR is linked to a **work item** - [ ] **acceptance criteria** of linked ticket are met - [ ] performed **self-review** of the code - [ ] written **tests** for any new functionality added with this PR - [ ] updated the **documentation** if this PR changes or adds functionality - [ ] written/updated **design docs** if this PR implements new functionality - [ ] updated the **change log** - [ ] ran **pre-commit** checks for code style - [ ] attended to any **TO-DOs** left in the code Related work items: #2266
2024-04-30 13:53:28 +00:00
parent 137f2a9648 a141c8d212
commit a82ee2b8e1
17 changed files with 2142 additions and 19 deletions
--- a/tests/integration_tests/network/test_multi_lan_internet_example_network.py
+++ b/tests/integration_tests/network/test_multi_lan_internet_example_network.py
@@ -0,0 +1,199 @@
+from primaite.simulator.network.hardware.nodes.host.computer import Computer
+from primaite.simulator.network.hardware.nodes.host.server import Server
+from primaite.simulator.network.networks import multi_lan_internet_network_example
+from primaite.simulator.system.applications.database_client import DatabaseClient
+from primaite.simulator.system.services.dns.dns_client import DNSClient
+from primaite.simulator.system.services.ftp.ftp_client import FTPClient
+from src.primaite.simulator.system.applications.web_browser import WebBrowser
+
+
+def test_all_with_configured_dns_server_ip_can_resolve_url():
+    network = multi_lan_internet_network_example()
+
+    for node in network.nodes.values():
+        dns_client: DNSClient = node.software_manager.software.get("DNSClient")
+
+        if not dns_client:
+            continue
+
+        if dns_client.dns_server:
+            assert dns_client.check_domain_exists("sometech.ai")
+
+
+def test_external_pcs_can_access_sometech_website():
+    network = multi_lan_internet_network_example()
+
+    pc_1_browser: WebBrowser = network.get_node_by_hostname("pc_1").software_manager.software["WebBrowser"]
+    pc_2_browser: WebBrowser = network.get_node_by_hostname("pc_2").software_manager.software["WebBrowser"]
+
+    assert pc_1_browser.get_webpage()
+    assert pc_2_browser.get_webpage()
+
+
+def test_external_pcs_cannot_access_sometech_db():
+    network = multi_lan_internet_network_example()
+
+    pc_1_db_client: DatabaseClient = network.get_node_by_hostname("pc_1").software_manager.software["DatabaseClient"]
+    pc_2_db_client: DatabaseClient = network.get_node_by_hostname("pc_2").software_manager.software["DatabaseClient"]
+
+    assert not pc_1_db_client.get_new_connection()
+    assert not pc_2_db_client.get_new_connection()
+
+
+def test_external_pcs_cannot_access_ftp_on_sometech_storage_server():
+    network = multi_lan_internet_network_example()
+
+    some_tech_storage_srv = network.get_node_by_hostname("some_tech_storage_srv")
+    some_tech_storage_srv.file_system.create_file(file_name="test.png")
+
+    pc_1_ftp_client: FTPClient = network.get_node_by_hostname("pc_1").software_manager.software["FTPClient"]
+    pc_2_ftp_client: FTPClient = network.get_node_by_hostname("pc_2").software_manager.software["FTPClient"]
+
+    assert not pc_1_ftp_client.request_file(
+        dest_ip_address=some_tech_storage_srv.network_interface[1].ip_address,
+        src_folder_name="root",
+        src_file_name="test.png",
+        dest_folder_name="root",
+        dest_file_name="test.png",
+    )
+
+    assert not pc_2_ftp_client.request_file(
+        dest_ip_address=some_tech_storage_srv.network_interface[1].ip_address,
+        src_folder_name="root",
+        src_file_name="test.png",
+        dest_folder_name="root",
+        dest_file_name="test.png",
+    )
+
+
+def test_sometech_webserver_can_access_sometech_db_server():
+    network = multi_lan_internet_network_example()
+
+    web_db_client: DatabaseClient = network.get_node_by_hostname("some_tech_web_srv").software_manager.software[
+        "DatabaseClient"
+    ]
+
+    assert web_db_client.get_new_connection()
+
+
+def test_sometech_webserver_cannot_access_ftp_on_sometech_storage_server():
+    network = multi_lan_internet_network_example()
+
+    some_tech_storage_srv = network.get_node_by_hostname("some_tech_storage_srv")
+    some_tech_storage_srv.file_system.create_file(file_name="test.png")
+
+    web_server: Server = network.get_node_by_hostname("some_tech_web_srv")
+
+    web_ftp_client: FTPClient = web_server.software_manager.software["FTPClient"]
+
+    assert not web_ftp_client.request_file(
+        dest_ip_address=some_tech_storage_srv.network_interface[1].ip_address,
+        src_folder_name="root",
+        src_file_name="test.png",
+        dest_folder_name="root",
+        dest_file_name="test.png",
+    )
+
+
+def test_sometech_dev_pcs_can_access_sometech_website():
+    network = multi_lan_internet_network_example()
+
+    some_tech_snr_dev_pc: Computer = network.get_node_by_hostname("some_tech_snr_dev_pc")
+
+    snr_dev_browser: WebBrowser = some_tech_snr_dev_pc.software_manager.software["WebBrowser"]
+
+    assert snr_dev_browser.get_webpage()
+
+    some_tech_jnr_dev_pc: Computer = network.get_node_by_hostname("some_tech_jnr_dev_pc")
+
+    jnr_dev_browser: WebBrowser = some_tech_jnr_dev_pc.software_manager.software["WebBrowser"]
+
+    assert jnr_dev_browser.get_webpage()
+
+
+def test_sometech_dev_pcs_can_connect_to_sometech_db_server():
+    network = multi_lan_internet_network_example()
+
+    some_tech_snr_dev_pc: Computer = network.get_node_by_hostname("some_tech_snr_dev_pc")
+    snr_dev_db_client: DatabaseClient = some_tech_snr_dev_pc.software_manager.software["DatabaseClient"]
+
+    assert snr_dev_db_client.get_new_connection()
+
+    some_tech_jnr_dev_pc: Computer = network.get_node_by_hostname("some_tech_jnr_dev_pc")
+    jnr_dev_db_client: DatabaseClient = some_tech_jnr_dev_pc.software_manager.software["DatabaseClient"]
+
+    assert jnr_dev_db_client.get_new_connection()
+
+
+def test_sometech_snr_dev_can_access_ftp_on_sometech_storage_server():
+    network = multi_lan_internet_network_example()
+
+    some_tech_storage_srv = network.get_node_by_hostname("some_tech_storage_srv")
+    some_tech_storage_srv.file_system.create_file(file_name="test.png")
+
+    some_tech_snr_dev_pc: Computer = network.get_node_by_hostname("some_tech_snr_dev_pc")
+    snr_dev_ftp_client: FTPClient = some_tech_snr_dev_pc.software_manager.software["FTPClient"]
+
+    assert snr_dev_ftp_client.request_file(
+        dest_ip_address=some_tech_storage_srv.network_interface[1].ip_address,
+        src_folder_name="root",
+        src_file_name="test.png",
+        dest_folder_name="root",
+        dest_file_name="test.png",
+    )
+
+
+def test_sometech_jnr_dev_cannot_access_ftp_on_sometech_storage_server():
+    network = multi_lan_internet_network_example()
+
+    some_tech_storage_srv = network.get_node_by_hostname("some_tech_storage_srv")
+    some_tech_storage_srv.file_system.create_file(file_name="test.png")
+
+    some_tech_jnr_dev_pc: Computer = network.get_node_by_hostname("some_tech_jnr_dev_pc")
+    jnr_dev_ftp_client: FTPClient = some_tech_jnr_dev_pc.software_manager.software["FTPClient"]
+
+    assert not jnr_dev_ftp_client.request_file(
+        dest_ip_address=some_tech_storage_srv.network_interface[1].ip_address,
+        src_folder_name="root",
+        src_file_name="test.png",
+        dest_folder_name="root",
+        dest_file_name="test.png",
+    )
+
+
+def test_sometech_hr_pc_can_access_sometech_website():
+    network = multi_lan_internet_network_example()
+
+    some_tech_hr_pc: Computer = network.get_node_by_hostname("some_tech_hr_1")
+
+    hr_browser: WebBrowser = some_tech_hr_pc.software_manager.software["WebBrowser"]
+
+    assert hr_browser.get_webpage()
+
+
+def test_sometech_hr_pc_cannot_access_sometech_db():
+    network = multi_lan_internet_network_example()
+
+    some_tech_hr_pc: Computer = network.get_node_by_hostname("some_tech_hr_1")
+
+    hr_db_client: DatabaseClient = some_tech_hr_pc.software_manager.software["DatabaseClient"]
+
+    assert not hr_db_client.get_new_connection()
+
+
+def test_sometech_hr_pc_cannot_access_ftp_on_sometech_storage_server():
+    network = multi_lan_internet_network_example()
+
+    some_tech_storage_srv = network.get_node_by_hostname("some_tech_storage_srv")
+    some_tech_storage_srv.file_system.create_file(file_name="test.png")
+
+    some_tech_hr_pc: Computer = network.get_node_by_hostname("some_tech_hr_1")
+    hr_ftp_client: FTPClient = some_tech_hr_pc.software_manager.software["FTPClient"]
+
+    assert not hr_ftp_client.request_file(
+        dest_ip_address=some_tech_storage_srv.network_interface[1].ip_address,
+        src_folder_name="root",
+        src_file_name="test.png",
+        dest_folder_name="root",
+        dest_file_name="test.png",
+    )