Refactor code structure + fix pip package issue (#9)

KatharaFramework · Oct 17, 2024 · 0fa1f85 · 0fa1f85
1 parent bb6bc7c
commit 0fa1f85
Show file tree

Hide file tree

Showing 42 changed files with 58 additions and 58 deletions.
diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ The Kathará Lab Checker takes in input a configuration file specifying the test
 To run the tool you only need to run the `main.py` passing the desired configuration file.
 
 ```bash
-python3 -m kathara-lab-checker --config <path-to-the-configuration-file>
+python3 -m kathara_lab_checker --config <path-to-the-configuration-file> --labs <path-to-the-labs-directory>
 ```
 
 At this point, the tool parses the provided configuration file and executes the tests. For each network scenario the
@@ -47,7 +47,7 @@ The repository already provide a complete example with the results of the tests.
 You can re-run the example by typing the following command in the root directory of the project:
 
 ```bash
-python3 -m kathara-lab-checker --config examples/configuration_palabra.json --no-cache
+python3 -m kathara_lab_checker --config examples/palabra/configuration_palabra.json --no-cache --labs examples/palabra/labs
 ```
 
 The `--no-cache` flag force to repeat already executed tests.

diff --git a/examples/palabra/labs/lab1/lab1_result.xlsx b/examples/palabra/labs/lab1/lab1_result.xlsx
diff --git a/examples/palabra/labs/lab2/lab2_result.xlsx b/examples/palabra/labs/lab2/lab2_result.xlsx
diff --git a/examples/palabra/labs/lab3/lab3_result.xlsx b/examples/palabra/labs/lab3/lab3_result.xlsx
diff --git a/examples/palabra/labs/lab4/lab4_result.xlsx b/examples/palabra/labs/lab4/lab4_result.xlsx
diff --git a/examples/palabra/labs/results.xlsx b/examples/palabra/labs/results.xlsx
diff --git a/examples/palabra/results.xlsx b/examples/palabra/results.xlsx
diff --git a/pyproject.toml b/pyproject.toml
@@ -33,7 +33,7 @@ dependencies = [
 ]
 
 [project.scripts]
-kathara-lab-checker = "main:main"
+kathara-lab-checker = "kathara_lab_checker:main"
 
 [project.urls]
 "Bug Reports" = "https://github.com/KatharaFramework/kathara-lab-checker/issues"

diff --git a/src/main.py → src/kathara_lab_checker.py b/src/main.py → src/kathara_lab_checker.py
@@ -16,29 +16,29 @@
 from Kathara.setting.Setting import Setting
 from tqdm import tqdm
 
-from kathara_lab_checker.TestCollector import TestCollector
-from kathara_lab_checker.checks.BridgeCheck import BridgeCheck
-from kathara_lab_checker.checks.CollisionDomainCheck import CollisionDomainCheck
-from kathara_lab_checker.checks.CustomCommandCheck import CustomCommandCheck
-from kathara_lab_checker.checks.DaemonCheck import DaemonCheck
-from kathara_lab_checker.checks.DeviceExistenceCheck import DeviceExistenceCheck
-from kathara_lab_checker.checks.IPv6EnabledCheck import IPv6EnabledCheck
-from kathara_lab_checker.checks.InterfaceIPCheck import InterfaceIPCheck
-from kathara_lab_checker.checks.KernelRouteCheck import KernelRouteCheck
-from kathara_lab_checker.checks.ReachabilityCheck import ReachabilityCheck
-from kathara_lab_checker.checks.StartupExistenceCheck import StartupExistenceCheck
-from kathara_lab_checker.checks.SysctlCheck import SysctlCheck
-from kathara_lab_checker.checks.applications.dns.DNSAuthorityCheck import DNSAuthorityCheck
-from kathara_lab_checker.checks.applications.dns.DNSRecordCheck import DNSRecordCheck
-from kathara_lab_checker.checks.applications.dns.LocalNSCheck import LocalNSCheck
-from kathara_lab_checker.checks.protocols.AnnouncedNetworkCheck import AnnouncedNetworkCheck
-from kathara_lab_checker.checks.protocols.ProtocolRedistributionCheck import ProtocolRedistributionCheck
-from kathara_lab_checker.checks.protocols.bgp.BGPPeeringCheck import BGPPeeringCheck
-from kathara_lab_checker.checks.protocols.evpn.AnnouncedVNICheck import AnnouncedVNICheck
-from kathara_lab_checker.checks.protocols.evpn.EVPNSessionCheck import EVPNSessionCheck
-from kathara_lab_checker.checks.protocols.evpn.VTEPCheck import VTEPCheck
-from kathara_lab_checker.excel_utils import write_final_results_to_excel, write_result_to_excel
-from kathara_lab_checker.utils import reverse_dictionary
+from lab_checker.TestCollector import TestCollector
+from lab_checker.checks.BridgeCheck import BridgeCheck
+from lab_checker.checks.CollisionDomainCheck import CollisionDomainCheck
+from lab_checker.checks.CustomCommandCheck import CustomCommandCheck
+from lab_checker.checks.DaemonCheck import DaemonCheck
+from lab_checker.checks.DeviceExistenceCheck import DeviceExistenceCheck
+from lab_checker.checks.IPv6EnabledCheck import IPv6EnabledCheck
+from lab_checker.checks.InterfaceIPCheck import InterfaceIPCheck
+from lab_checker.checks.KernelRouteCheck import KernelRouteCheck
+from lab_checker.checks.ReachabilityCheck import ReachabilityCheck
+from lab_checker.checks.StartupExistenceCheck import StartupExistenceCheck
+from lab_checker.checks.SysctlCheck import SysctlCheck
+from lab_checker.checks.applications.dns.DNSAuthorityCheck import DNSAuthorityCheck
+from lab_checker.checks.applications.dns.DNSRecordCheck import DNSRecordCheck
+from lab_checker.checks.applications.dns.LocalNSCheck import LocalNSCheck
+from lab_checker.checks.protocols.AnnouncedNetworkCheck import AnnouncedNetworkCheck
+from lab_checker.checks.protocols.ProtocolRedistributionCheck import ProtocolRedistributionCheck
+from lab_checker.checks.protocols.bgp.BGPPeeringCheck import BGPPeeringCheck
+from lab_checker.checks.protocols.evpn.AnnouncedVNICheck import AnnouncedVNICheck
+from lab_checker.checks.protocols.evpn.EVPNSessionCheck import EVPNSessionCheck
+from lab_checker.checks.protocols.evpn.VTEPCheck import VTEPCheck
+from lab_checker.excel_utils import write_final_results_to_excel, write_result_to_excel
+from lab_checker.utils import reverse_dictionary
 
 VERSION = "0.1.3"
 CURRENT_LAB: Optional[Lab] = None

diff --git a/src/kathara_lab_checker/TestCollector.py → src/lab_checker/TestCollector.py b/src/kathara_lab_checker/TestCollector.py → src/lab_checker/TestCollector.py
diff --git a/...kathara_lab_checker/TqdmLoggingHandler.py → src/lab_checker/TqdmLoggingHandler.py b/...kathara_lab_checker/TqdmLoggingHandler.py → src/lab_checker/TqdmLoggingHandler.py
diff --git a/src/kathara_lab_checker/__init__.py → src/lab_checker/__init__.py b/src/kathara_lab_checker/__init__.py → src/lab_checker/__init__.py
diff --git a/...thara_lab_checker/checks/AbstractCheck.py → src/lab_checker/checks/AbstractCheck.py b/...thara_lab_checker/checks/AbstractCheck.py → src/lab_checker/checks/AbstractCheck.py
diff --git a/...kathara_lab_checker/checks/BridgeCheck.py → src/lab_checker/checks/BridgeCheck.py b/...kathara_lab_checker/checks/BridgeCheck.py → src/lab_checker/checks/BridgeCheck.py
@@ -4,7 +4,7 @@
 from Kathara.manager.Kathara import Kathara
 from Kathara.model.Lab import Lab
 
-from kathara_lab_checker.utils import get_output
+from lab_checker.utils import get_output
 from .AbstractCheck import AbstractCheck
 from .CheckResult import CheckResult
 

diff --git a/...kathara_lab_checker/checks/CheckResult.py → src/lab_checker/checks/CheckResult.py b/...kathara_lab_checker/checks/CheckResult.py → src/lab_checker/checks/CheckResult.py
@@ -1,6 +1,6 @@
 import logging
 
-from kathara_lab_checker.utils import green, red
+from lab_checker.utils import green, red
 
 
 class CheckResult:

diff --git a/...ab_checker/checks/CollisionDomainCheck.py → ...ab_checker/checks/CollisionDomainCheck.py b/...ab_checker/checks/CollisionDomainCheck.py → ...ab_checker/checks/CollisionDomainCheck.py
diff --git a/..._lab_checker/checks/CustomCommandCheck.py → src/lab_checker/checks/CustomCommandCheck.py b/..._lab_checker/checks/CustomCommandCheck.py → src/lab_checker/checks/CustomCommandCheck.py
diff --git a/...kathara_lab_checker/checks/DaemonCheck.py → src/lab_checker/checks/DaemonCheck.py b/...kathara_lab_checker/checks/DaemonCheck.py → src/lab_checker/checks/DaemonCheck.py
@@ -2,7 +2,7 @@
 from Kathara.manager.Kathara import Kathara
 from Kathara.model.Lab import Lab
 
-from kathara_lab_checker.utils import get_output
+from lab_checker.utils import get_output
 from .AbstractCheck import AbstractCheck
 from .CheckResult import CheckResult
 

diff --git a/...ab_checker/checks/DeviceExistenceCheck.py → ...ab_checker/checks/DeviceExistenceCheck.py b/...ab_checker/checks/DeviceExistenceCheck.py → ...ab_checker/checks/DeviceExistenceCheck.py
diff --git a/...ra_lab_checker/checks/IPv6EnabledCheck.py → src/lab_checker/checks/IPv6EnabledCheck.py b/...ra_lab_checker/checks/IPv6EnabledCheck.py → src/lab_checker/checks/IPv6EnabledCheck.py
diff --git a/...ra_lab_checker/checks/InterfaceIPCheck.py → src/lab_checker/checks/InterfaceIPCheck.py b/...ra_lab_checker/checks/InterfaceIPCheck.py → src/lab_checker/checks/InterfaceIPCheck.py
@@ -3,7 +3,7 @@
 from Kathara.exceptions import MachineNotRunningError
 from Kathara.model.Lab import Lab
 
-from kathara_lab_checker.utils import get_interfaces_addresses
+from lab_checker.utils import get_interfaces_addresses
 from .AbstractCheck import AbstractCheck
 from .CheckResult import CheckResult
 

diff --git a/...ra_lab_checker/checks/KernelRouteCheck.py → src/lab_checker/checks/KernelRouteCheck.py b/...ra_lab_checker/checks/KernelRouteCheck.py → src/lab_checker/checks/KernelRouteCheck.py
diff --git a/...a_lab_checker/checks/ReachabilityCheck.py → src/lab_checker/checks/ReachabilityCheck.py b/...a_lab_checker/checks/ReachabilityCheck.py → src/lab_checker/checks/ReachabilityCheck.py
@@ -2,7 +2,7 @@
 from Kathara.manager.Kathara import Kathara
 from Kathara.model.Lab import Lab
 
-from kathara_lab_checker.utils import get_output
+from lab_checker.utils import get_output
 from .AbstractCheck import AbstractCheck
 from .CheckResult import CheckResult
 

diff --git a/...b_checker/checks/StartupExistenceCheck.py → ...b_checker/checks/StartupExistenceCheck.py b/...b_checker/checks/StartupExistenceCheck.py → ...b_checker/checks/StartupExistenceCheck.py
diff --git a/...kathara_lab_checker/checks/SysctlCheck.py → src/lab_checker/checks/SysctlCheck.py b/...kathara_lab_checker/checks/SysctlCheck.py → src/lab_checker/checks/SysctlCheck.py
diff --git a/src/kathara_lab_checker/checks/__init__.py → src/lab_checker/checks/__init__.py b/src/kathara_lab_checker/checks/__init__.py → src/lab_checker/checks/__init__.py
diff --git a/...b_checker/checks/applications/__init__.py → ...b_checker/checks/applications/__init__.py b/...b_checker/checks/applications/__init__.py → ...b_checker/checks/applications/__init__.py
diff --git a/...cks/applications/dns/DNSAuthorityCheck.py → ...cks/applications/dns/DNSAuthorityCheck.py b/...cks/applications/dns/DNSAuthorityCheck.py → ...cks/applications/dns/DNSAuthorityCheck.py
@@ -5,9 +5,9 @@
 from Kathara.manager.Kathara import Kathara
 from Kathara.model.Lab import Lab
 
-from kathara_lab_checker.checks.AbstractCheck import AbstractCheck
-from kathara_lab_checker.checks.CheckResult import CheckResult
-from kathara_lab_checker.utils import get_output, find_lines_with_string, find_device_name_from_ip
+from lab_checker.checks.AbstractCheck import AbstractCheck
+from lab_checker.checks.CheckResult import CheckResult
+from lab_checker.utils import get_output, find_lines_with_string, find_device_name_from_ip
 
 
 class DNSAuthorityCheck(AbstractCheck):

diff --git a/...checks/applications/dns/DNSRecordCheck.py → ...checks/applications/dns/DNSRecordCheck.py b/...checks/applications/dns/DNSRecordCheck.py → ...checks/applications/dns/DNSRecordCheck.py
@@ -1,9 +1,9 @@
 from Kathara.manager.Kathara import Kathara
 from Kathara.model.Lab import Lab
 
-from kathara_lab_checker.checks.AbstractCheck import AbstractCheck
-from kathara_lab_checker.checks.CheckResult import CheckResult
-from kathara_lab_checker.utils import get_output
+from lab_checker.checks.AbstractCheck import AbstractCheck
+from lab_checker.checks.CheckResult import CheckResult
+from lab_checker.utils import get_output
 
 
 class DNSRecordCheck(AbstractCheck):

diff --git a/...r/checks/applications/dns/LocalNSCheck.py → ...r/checks/applications/dns/LocalNSCheck.py b/...r/checks/applications/dns/LocalNSCheck.py → ...r/checks/applications/dns/LocalNSCheck.py
@@ -3,9 +3,9 @@
 from Kathara.manager.Kathara import Kathara
 from Kathara.model.Lab import Lab
 
-from kathara_lab_checker.checks.AbstractCheck import AbstractCheck
-from kathara_lab_checker.checks.CheckResult import CheckResult
-from kathara_lab_checker.utils import get_output
+from lab_checker.checks.AbstractCheck import AbstractCheck
+from lab_checker.checks.CheckResult import CheckResult
+from lab_checker.utils import get_output
 
 
 class LocalNSCheck(AbstractCheck):

diff --git a/...ecker/checks/applications/dns/__init__.py → ...ecker/checks/applications/dns/__init__.py b/...ecker/checks/applications/dns/__init__.py → ...ecker/checks/applications/dns/__init__.py
diff --git a/...checks/protocols/AnnouncedNetworkCheck.py → ...checks/protocols/AnnouncedNetworkCheck.py b/...checks/protocols/AnnouncedNetworkCheck.py → ...checks/protocols/AnnouncedNetworkCheck.py
@@ -3,9 +3,9 @@
 from Kathara.manager.Kathara import Kathara
 from Kathara.model.Lab import Lab
 
-from kathara_lab_checker.checks.AbstractCheck import AbstractCheck
-from kathara_lab_checker.checks.CheckResult import CheckResult
-from kathara_lab_checker.utils import get_output
+from lab_checker.checks.AbstractCheck import AbstractCheck
+from lab_checker.checks.CheckResult import CheckResult
+from lab_checker.utils import get_output
 
 
 class AnnouncedNetworkCheck(AbstractCheck):

diff --git a/.../protocols/ProtocolRedistributionCheck.py → .../protocols/ProtocolRedistributionCheck.py b/.../protocols/ProtocolRedistributionCheck.py → .../protocols/ProtocolRedistributionCheck.py
@@ -3,9 +3,9 @@
 from Kathara.manager.Kathara import Kathara
 from Kathara.model.Lab import Lab
 
-from kathara_lab_checker.checks.AbstractCheck import AbstractCheck
-from kathara_lab_checker.checks.CheckResult import CheckResult
-from kathara_lab_checker.utils import get_output
+from lab_checker.checks.AbstractCheck import AbstractCheck
+from lab_checker.checks.CheckResult import CheckResult
+from lab_checker.utils import get_output
 
 
 class ProtocolRedistributionCheck(AbstractCheck):

diff --git a/..._lab_checker/checks/protocols/__init__.py → src/lab_checker/checks/protocols/__init__.py b/..._lab_checker/checks/protocols/__init__.py → src/lab_checker/checks/protocols/__init__.py
diff --git a/...r/checks/protocols/bgp/BGPPeeringCheck.py → ...r/checks/protocols/bgp/BGPPeeringCheck.py b/...r/checks/protocols/bgp/BGPPeeringCheck.py → ...r/checks/protocols/bgp/BGPPeeringCheck.py
@@ -4,9 +4,9 @@
 from Kathara.manager.Kathara import Kathara
 from Kathara.model.Lab import Lab
 
-from kathara_lab_checker.checks.AbstractCheck import AbstractCheck
-from kathara_lab_checker.checks.CheckResult import CheckResult
-from kathara_lab_checker.utils import get_output
+from lab_checker.checks.AbstractCheck import AbstractCheck
+from lab_checker.checks.CheckResult import CheckResult
+from lab_checker.utils import get_output
 
 
 class BGPPeeringCheck(AbstractCheck):

diff --git a/..._checker/checks/protocols/bgp/__init__.py → ..._checker/checks/protocols/bgp/__init__.py b/..._checker/checks/protocols/bgp/__init__.py → ..._checker/checks/protocols/bgp/__init__.py
diff --git a/...hecks/protocols/evpn/AnnouncedVNICheck.py → ...hecks/protocols/evpn/AnnouncedVNICheck.py b/...hecks/protocols/evpn/AnnouncedVNICheck.py → ...hecks/protocols/evpn/AnnouncedVNICheck.py
@@ -3,9 +3,9 @@
 from Kathara.manager.Kathara import Kathara
 from Kathara.model.Lab import Lab
 
-from kathara_lab_checker.checks.AbstractCheck import AbstractCheck
-from kathara_lab_checker.checks.CheckResult import CheckResult
-from kathara_lab_checker.utils import get_output
+from lab_checker.checks.AbstractCheck import AbstractCheck
+from lab_checker.checks.CheckResult import CheckResult
+from lab_checker.utils import get_output
 
 
 class AnnouncedVNICheck(AbstractCheck):

diff --git a/...checks/protocols/evpn/EVPNSessionCheck.py → ...checks/protocols/evpn/EVPNSessionCheck.py b/...checks/protocols/evpn/EVPNSessionCheck.py → ...checks/protocols/evpn/EVPNSessionCheck.py
@@ -4,9 +4,9 @@
 from Kathara.manager.Kathara import Kathara
 from Kathara.model.Lab import Lab
 
-from kathara_lab_checker.checks.AbstractCheck import AbstractCheck
-from kathara_lab_checker.checks.CheckResult import CheckResult
-from kathara_lab_checker.utils import get_output
+from lab_checker.checks.AbstractCheck import AbstractCheck
+from lab_checker.checks.CheckResult import CheckResult
+from lab_checker.utils import get_output
 
 
 class EVPNSessionCheck(AbstractCheck):

diff --git a/...hecker/checks/protocols/evpn/VTEPCheck.py → ...hecker/checks/protocols/evpn/VTEPCheck.py b/...hecker/checks/protocols/evpn/VTEPCheck.py → ...hecker/checks/protocols/evpn/VTEPCheck.py
@@ -4,9 +4,9 @@
 from Kathara.manager.Kathara import Kathara
 from Kathara.model.Lab import Lab
 
-from kathara_lab_checker.checks.AbstractCheck import AbstractCheck
-from kathara_lab_checker.checks.CheckResult import CheckResult
-from kathara_lab_checker.utils import get_output
+from lab_checker.checks.AbstractCheck import AbstractCheck
+from lab_checker.checks.CheckResult import CheckResult
+from lab_checker.utils import get_output
 
 
 class VTEPCheck(AbstractCheck):

diff --git a/...checker/checks/protocols/evpn/__init__.py → ...checker/checks/protocols/evpn/__init__.py b/...checker/checks/protocols/evpn/__init__.py → ...checker/checks/protocols/evpn/__init__.py
diff --git a/src/kathara_lab_checker/excel_utils.py → src/lab_checker/excel_utils.py b/src/kathara_lab_checker/excel_utils.py → src/lab_checker/excel_utils.py
diff --git a/src/kathara_lab_checker/utils.py → src/lab_checker/utils.py b/src/kathara_lab_checker/utils.py → src/lab_checker/utils.py