did basic conversion to org mode for the docs folder

2025-01-18 17:30:10 +00:00
parent f38b6d2871
commit ca46b20be1
21 changed files with 1844 additions and 0 deletions
--- a/Docs/P2P-testing.md.org
+++ b/Docs/P2P-testing.md.org
@@ -0,0 +1,136 @@
+* Testing P2P network
+:PROPERTIES:
+:CUSTOM_ID: testing-p2p-network
+:END:
+The objective would be to test the p2p network, and the effectiveness of
+updating the ip tables. The objective of would be to give the impression
+to the client and server of a Zero configuration setting. For testing
+there will be a test network set. In the testing scenario all will be
+client and server because the IP table does not store clients IP
+addresses. At current number of hopes would be 3 as default.
+
+*** Test Network Scenario 1
+:PROPERTIES:
+:CUSTOM_ID: test-network-scenario-1
+:END:
+The test network consists of 5 nodes acting as a client and server. The
+objective would be to have the entire IP table Updated in each node with
+interacting with only 1 node once. Each node has knowledge of one node
+only.
+
+[[https://user-images.githubusercontent.com/31743758/115069627-e4aa8c80-9f04-11eb-8402-706a3407f0e8.png]]
+Fig 1.0 Visual Representation of testnet scenario 1
+
+**** Result
+:PROPERTIES:
+:CUSTOM_ID: result
+:END:
+All nodes except node 1 where able to have information of IP addresses
+in the test net. This was due to the reason of 3 hops set as default.
+Node 1 had in it's IP table IP addresses of Node 2, Node 3, Node 4. Once
+the number of hops was set to 4 objective of the test was acheived.
+
+*** Test Network Scenario 2
+:PROPERTIES:
+:CUSTOM_ID: test-network-scenario-2
+:END:
+The second test network has a scenario of a single peer which all the
+other nodes connect too. The scenario being when the other nodes connect
+to the single server they download information about nodes that have
+connected to the server node before.
+
+*** Testing Broadcast Module
+:PROPERTIES:
+:CUSTOM_ID: testing-broadcast-module
+:END:
+For testing the broadcast module 2 types of servers will be tested. One
+with a CPU only , another one with a CPU and GPU. The expected result
+being that the appropriate results are visible.
+
+**** Results (CPU and GPU):
+:PROPERTIES:
+:CUSTOM_ID: results-cpu-and-gpu
+:END:
+#+begin_example
+{
+    "Hostname": "akilan-Lenovo-IdeaPad-Y510P",
+    "Platform": "ubuntu",
+    "CPU": "Intel(R) Core(TM) i7-4700MQ CPU @ 2.40GHz",
+    "RAM": 7872,
+    "Disk": 937367,
+    "GPU": {
+        "DriveVersion": "390.141",
+        "Gpu": {
+            "GpuName": "GeForce GT 755M",
+            "BiosVersion": "80.07.A8.00.0F",
+            "FanSpeed": "N/A",
+            "Utilization": {
+                "GpuUsage": "N/A",
+                "MemoryUsage": "N/A"
+            },
+            "Temperature": {
+                "GpuTemp": "66 C"
+            },
+            "Clock": {
+                "GpuClock": "N/A",
+                "GpuMemClock": "N/A"
+            }
+        }
+    }
+} 
+#+end_example
+
+At the moment of the current implementation v1.0. Nvidia GPU are only
+compatible. As the Go code calls the command =nvidia-smi= to get
+information about the GPU available.
+
+**** Results (CPU only)
+:PROPERTIES:
+:CUSTOM_ID: results-cpu-only
+:END:
+#+begin_example
+{
+    "Hostname": "sv-t1.small.x86-01",
+    "Platform": "ubuntu",
+    "CPU": "Intel(R) Atom(TM) CPU  C2750  @ 2.40GHz",
+    "RAM": 7944,
+    "Disk": 138793,
+    "GPU": null
+} 
+#+end_example
+
+As the =nvidia-smi= interface was not detected it only broadcasts the
+CPU specs available.
+
+*** SpeedTests
+:PROPERTIES:
+:CUSTOM_ID: speedtests
+:END:
+The speed test has 3 parameters which are Ping , upload and download.
+The tests check if the results returned are approximately correct. The
+ping at the moment returns the correct result. The upload and download
+returned are inccorect at the moment, This is due incorrect
+implementation in for timer and will be patched in future versions.
+
+*** Unit tests
+:PROPERTIES:
+:CUSTOM_ID: unit-tests
+:END:
+All functions implemented on the P2P module returns type error. The
+units test call certain functions and check if the functions return an
+error or not. This proved sufficient as the point of the units tests was
+code coverage to check if certain functions return an error.
+
+**** Functions tested
+:PROPERTIES:
+:CUSTOM_ID: functions-tested
+:END:
+This sections talks about the function called and represents code
+coverage.
+
+1. =TestServer_SpeedTest=: Function called LocalSpeedTestIpTable()
+2. =TestReadIpTable=: Function called ReadIpTable()
+
+The P2P module has a 100% code coverage in unit tests as both the unit
+tests call directly or call within the function all the functions used
+in the P2P module.