FlowMeasurementRecorder: Clarify confusing parameter names (fixes #1089)

.gdbinit.py

@@ -7,6 +7,6 @@
 if 'register_inet_printers' in dir():
     print('inet pretty printers already initialized.')
 else:
-    from inet.printers import register_inet_printers
+    from inetgdb.printers import register_inet_printers
     register_inet_printers(None)
     print('Pretty printers initialized: inet')

INSTALL.md

@@ -24,15 +24,18 @@ General
 If you are building from command line:
 --------------------------------------
 3. Change to the INET directory and source the `setenv` script.
-   
+
        $ source setenv
 
-4. Type `make makefiles`. This should generate the makefiles for you automatically.
+4. Make sure that any required Python modules are properly installed by executing
+  `pip install -r python/requirements.txt`
+
+5. Type `make makefiles`. This should generate the makefiles for you automatically.
 
-5. Type `make` to build the inet executable (release version). Use `make MODE=debug`
+6. Type `make` to build the inet executable (release version). Use `make MODE=debug`
    to build debug version.
 
-6. You can run specific examples by changing into the example's directory and executing `inet`
+7. You can run specific examples by changing into the example's directory and executing `inet`
 
 If you are using the IDE:
 -------------------------

WHATSNEW

@@ -1,6 +1,38 @@
 Recent changes in the INET Framework
 ====================================
 
+INET-4.5.4 (October 2024) - Stable
+----------------------------------
+
+This is a minor patch release containing OMNeT++ 6.1 compatibility fixes (enum
+related issues). It contains also fixes for #880, #886, #913, #919, #956,
+#967, #974, #982. Several memory lake errors were fixed. Added logging and 
+testing framework enhancements. Added a `python/requirements.txt` so Python
+dependenies can be installed by `pip install -r python/requirements.txt`.
+Fixed escaping errors with Python 3.12 in pythons scripts.
+
+Test framework enhancements:
+- Added new commands `inet_run_*_tests` to allow running various tests.
+- Smoke tests are executed for run #0 only by default.
+- Tets marked as intentionally as SKIP are now left out from the test execution.
+- Added `inet_run_release_tests` for pre-release testing.
+- A lot of mischelanous fixes.
+
+
+INET-4.5.3 (September 2024) - Stable
+------------------------------------
+This version was yanked because of `@enum` related issues.
+
+
+INET-4.5.2 (August 2024) - Stable
+---------------------------------
+
+This is a minor bugfix release containing OMNeT++ 6.1 compatibility fixes
+and and a fix for an incorrect formula used in Rayleigh pathloss computation 
+(NOTE: This change may alter a simulation's results if it used the
+Rayleigh pathloss model).
+
+
 INET-4.5 (April 2023) - Stable
 ------------------------------
 

bin/inet_fingerprinttest

@@ -479,7 +479,7 @@ class FingerprintTestCase(SimulationTestCase):
         workingdir = _iif(self.wd.startswith('/'), rootDir + "/" + self.wd, self.wd)
         wdname = '' + self.wd + ' ' + self.cmdLine
         wdname = re.sub('/', '_', wdname)
-        wdname = re.sub('[\W]+', '_', wdname)
+        wdname = re.sub(r'[\W]+', '_', wdname)
         resultdir = os.path.abspath(".") + "/results/" + self.csvFile + "/" + wdname
         ensure_dir(resultdir)
 

bin/inet_run_packet_tests

@@ -0,0 +1,5 @@
+#!/usr/bin/env python3
+
+from inet.main import *
+
+run_packet_tests_main()

bin/inet_run_release_tests

@@ -0,0 +1,5 @@
+#!/usr/bin/env python3
+
+from inet.main import *
+
+run_release_tests_main()

examples/gptp/omnetpp.ini

@@ -64,3 +64,4 @@ description = gptp on, master is in a hurry, client is precise
 extends = sync1, _DriftMaster, _DriftSlave
 description = gptp on, master is in a hurry, client is late
 
+# expected-result = "ERROR"

examples/voipstream/osudp/receiver.ini

@@ -2,6 +2,7 @@
 network = VoipStreamReceiverApplication
 scheduler-class = "inet::RealTimeScheduler"
 sim-time-limit = 1h
+#emulation = true
 
 *.app.localPort = 1000
 *.app.resultFile = "results/sound.wav"

examples/voipstream/osudp/sender.ini

@@ -2,6 +2,7 @@
 network = VoipStreamSenderApplication
 scheduler-class = "inet::RealTimeScheduler"
 #abstract-config = true (requires omnet 7)
+#emulation = true
 
 *.app.packetTimeLength = 20ms
 *.app.voipHeaderSize = 28B

python/inet/common/summary.py

@@ -35,7 +35,7 @@ def collect_modules(simulation_project, path="src"):
             match = re.match(r"^package ([\w\.]+)", line)
             if match:
                 package = match.group(1)
-                package = re.sub("^\w+?\.", "", package)
+                package = re.sub(r"^\w+?\.", "", package)
             match = re.match(r"^(simple|module) (\w+)\b", line)
             if match:
                 module = match.group(2)
@@ -120,7 +120,7 @@ def collect_classes(simulation_project, path="src"):
             if match:
                 class_name = match.group(1)
                 relative_path = os.path.relpath(os.path.dirname(file_name), project_path)
-                relative_path = re.sub("^(\w+)/", "", relative_path)
+                relative_path = re.sub(r"^(\w+)/", "", relative_path)
                 classes.append(relative_path + "/" + class_name)
         file.close()
     return classes

python/inet/common/task.py

@@ -12,7 +12,7 @@
 logger = logging.getLogger(__name__)
 
 class TaskResult:
-    def __init__(self, task=None, result="DONE", expected_result="DONE", reason=None, error_message=None, exception=None, elapsed_wall_time=None, possible_results=["DONE", "CANCEL", "ERROR"], possible_result_colors=[COLOR_GREEN, COLOR_CYAN, COLOR_RED], **kwargs):
+    def __init__(self, task=None, result="DONE", expected_result="DONE", reason=None, stdout=None, stderr=None, error_message=None, exception=None, elapsed_wall_time=None, possible_results=["DONE", "CANCEL", "ERROR"], possible_result_colors=[COLOR_GREEN, COLOR_CYAN, COLOR_RED], **kwargs):
         self.locals = locals()
         self.locals.pop("self")
         self.kwargs = kwargs
@@ -21,6 +21,8 @@ def __init__(self, task=None, result="DONE", expected_result="DONE", reason=None
         self.expected_result = expected_result
         self.expected = expected_result == result
         self.reason = reason
+        self.stdout = stdout
+        self.stderr = stderr
         self.error_message = error_message
         self.exception = exception
         self.elapsed_wall_time = elapsed_wall_time
@@ -40,7 +42,7 @@ def get_description(self, complete_error_message=True, include_parameters=False,
                (" " + self.get_error_message(complete_error_message=complete_error_message) if self.result == "ERROR" else "")
 
     def get_error_message(self, **kwargs):
-        return self.error_message or "<Error message not found>"
+        return self.error_message or self.stderr or (self.exception and str(self.exception)) or "<No error message>"
 
     def print_result(self, complete_error_message=False, output_stream=sys.stdout, **kwargs):
         print(self.get_description(complete_error_message=complete_error_message), file=output_stream)
@@ -247,12 +249,14 @@ def run_protected(self, **kwargs):
         1/0
 
 class MultipleTasks:
-    def __init__(self, tasks=[], name="task", concurrent=True, randomize=False, chunksize=1, pool_class=multiprocessing.pool.ThreadPool, multiple_task_results_class=MultipleTaskResults, **kwargs):
+    def __init__(self, tasks=[], name="task", start=None, end=None, concurrent=True, randomize=False, chunksize=1, pool_class=multiprocessing.pool.ThreadPool, multiple_task_results_class=MultipleTaskResults, **kwargs):
         self.locals = locals()
         self.locals.pop("self")
         self.kwargs = kwargs
         self.tasks = tasks
         self.name = name
+        self.start = start
+        self.end = end
         self.concurrent = concurrent
         self.randomize = randomize
         self.chunksize = chunksize
@@ -287,7 +291,7 @@ def run(self, **kwargs):
         return multiple_task_results
 
     def run_protected(self, **kwargs):
-        tasks = self.tasks
+        tasks = self.tasks[self.start:self.end+1] if self.start is not None and self.end is not None else self.tasks
         task_count = len(tasks)
         for task in tasks:
             task.set_cancel(False)

python/inet/common/util.py

@@ -39,7 +39,7 @@ def coalesce(*values):
 
 def convert_to_seconds(s):
     seconds_per_unit = {"ns": 1E-9, "us": 1E-6, "ms": 1E-3, "s": 1, "second": 1, "m": 60, "min": 60, "h": 3600, "hour": 3600, "d": 86400, "day": 86400, "w": 604800, "week": 604800}
-    match = re.match("(-?[0-9]*\.?[0-9]*) *([a-zA-Z]+)", s)
+    match = re.match(r"(-?[0-9]*\.?[0-9]*) *([a-zA-Z]+)", s)
     return float(match.group(1)) * seconds_per_unit[match.group(2)]
 
 def write_object(file_name, object):

python/inet/main.py

@@ -21,6 +21,8 @@ def parse_arguments(task_name):
     parser.add_argument("-u", "--user-interface", choices=["Cmdenv", "Qtenv"], default="Cmdenv", help="User interface")
     parser.add_argument("-t", "--sim-time-limit", default=None, help="Simulation time limit")
     parser.add_argument("-T", "--cpu-time-limit", default=None, help="CPU time limit")
+    parser.add_argument('--start', default=None, help="First task index")
+    parser.add_argument('--end', default=None, help="Last task index")
     parser.add_argument("-f", "--filter", default=None, help="Filter")
     parser.add_argument("--exclude-filter", default=None, help="Exclude filter")
     parser.add_argument("-w", "--working-directory-filter", default=None, help="Working directory filter")
@@ -43,7 +45,7 @@ def process_arguments(task):
     logger.addHandler(handler)
     kwargs = {k: v for k, v in vars(args).items() if v is not None}
     kwargs["working_directory_filter"] = args.working_directory_filter or os.path.relpath(os.getcwd(), os.path.realpath(inet_project.get_full_path(".")))
-    kwargs["working_directory_filter"] = re.sub("(.*)/$", "\\1", kwargs["working_directory_filter"])
+    kwargs["working_directory_filter"] = re.sub(r"(.*)/$", "\\1", kwargs["working_directory_filter"])
     return kwargs
 
 def run_main(main_function, task_name):
@@ -94,4 +96,7 @@ def run_validation_tests_main():
     run_main(run_validation_tests, "validation tests")
 
 def run_all_tests_main():
-    run_main(run_all_tests, "tests")
+    run_main(run_all_tests, "all tests")
+
+def run_release_tests_main():
+    run_main(run_release_tests, "release tests")

python/inet/simulation/build.py

@@ -8,6 +8,10 @@
 
 def build_project(simulation_project, mode="debug", capture_output=True, **kwargs):
     logger.info(f"Building {simulation_project.get_name()} started")
+    args = ["make", "makefiles"]
+    subprocess_result = subprocess.run(args, cwd=simulation_project.get_full_path("."), capture_output=capture_output)
+    if subprocess_result.returncode != 0:
+        raise Exception(f"Build {simulation_project.get_name()} failed")
     args = ["make", "MODE=" + mode, "-j", str(multiprocessing.cpu_count())]
     subprocess_result = subprocess.run(args, cwd=simulation_project.get_full_path("."), capture_output=capture_output)
     if subprocess_result.returncode != 0:

python/inet/simulation/config.py

@@ -10,19 +10,20 @@
 
 from inet.common import *
 from inet.simulation.project import *
+from inet.simulation.build import *
 
 logger = logging.getLogger(__name__)
 
 class SimulationConfig:
-    def __init__(self, simulation_project, working_directory, ini_file="omnetpp.ini", config="General", num_runs=1, sim_time_limit=None, abstract=False, expected_result="DONE", user_interface="Cmdenv", description=None):
+    def __init__(self, simulation_project, working_directory, ini_file="omnetpp.ini", config="General", num_runs=1, sim_time_limit=None, abstract=False, emulation=False, expected_result="DONE", user_interface="Cmdenv", description=None):
         self.simulation_project = simulation_project
         self.working_directory = working_directory
         self.ini_file = ini_file
         self.config = config
         self.num_runs = num_runs
         self.sim_time_limit = sim_time_limit
         self.abstract = abstract
-        self.emulation = working_directory.find("emulation") != -1
+        self.emulation = working_directory.find("emulation") != -1 or emulation
         self.expected_result = expected_result
         self.user_interface = user_interface
         self.description = description
@@ -67,7 +68,7 @@ def get_sim_time_limit(config_dicts, config):
 # KLUDGE TODO replace this with a Python binding to the C++ configuration reader
 def collect_ini_file_simulation_configs(simulation_project, ini_path):
     def create_config_dict(config):
-        return {"config": config, "abstract_config": False, "expected_result": "DONE", "user_interface": None, "description": None, "network": None}
+        return {"config": config, "abstract_config": False, "emulation" : False, "expected_result": "DONE", "user_interface": None, "description": None, "network": None}
     simulation_configs = []
     working_directory = os.path.dirname(ini_path)
     num_runs_fast = get_num_runs_fast(ini_path)
@@ -76,30 +77,33 @@ def create_config_dict(config):
     config_dicts = {"General": create_config_dict("General")}
     config_dict = {}
     for line in file:
-        match = re.match("\\[(Config +)?(.*?)\\]|\\[(General)\\]", line)
+        match = re.match(r"\[(Config +)?(.*?)\]|\[(General)\]", line)
         if match:
             config = match.group(2) or match.group(3)
             config_dict = create_config_dict(config)
             config_dicts[config] = config_dict
-        match = re.match(" *extends *= *(\w+)", line)
+        match = re.match(r" *extends *= *(\w+)", line)
         if match:
             config_dict["extends"] = match.group(1)
-        match = re.match(" *user-interface *= \"*(\w+)\"", line)
+        match = re.match(r" *user-interface *= \"*(\w+)\"", line)
         if match:
             config_dict["user_interface"] = match.group(1)
-        match = re.match("#? *abstract-config *= *(\w+)", line)
+        match = re.match(r"#? *abstract-config *= *(\w+)", line)
         if match:
             config_dict["abstract_config"] = bool(match.group(1))
-        match = re.match("#? *expected-result *= *\"(\w+)\"", line)
+        match = re.match(r"#? *emulation *= *(\w+)", line)
+        if match:
+            config_dict["emulation"] = bool(match.group(1))
+        match = re.match(r"#? *expected-result *= *\"(\w+)\"", line)
         if match:
             config_dict["expected_result"] = match.group(1)
-        match = re.match("description *= *\"(.*)\"", line)
+        match = re.match(r"description *= *\"(.*)\"", line)
         if match:
             config_dict["description"] = match.group(1)
-        match = re.match("network *= *(.*)", line)
+        match = re.match(r"network *= *(.*)", line)
         if match:
             config_dict["network"] = match.group(1)
-        match = re.match("sim-time-limit *= *(.*)", line)
+        match = re.match(r"sim-time-limit *= *(.*)", line)
         if match:
             config_dict["sim_time_limit"] = match.group(1)
     general_config_dict = config_dicts["General"]
@@ -119,15 +123,17 @@ def create_config_dict(config):
                 raise Exception("Cannot determine number of runs")
         sim_time_limit = get_sim_time_limit(config_dicts, config)
         description = config_dict["description"]
-        description_abstract = (re.search("\((a|A)bstract\)", description) is not None) if description else False
+        description_abstract = (re.search(r"\((a|A)bstract\)", description) is not None) if description else False
         abstract = (config_dict["network"] is None and config_dict["config"] == "General") or config_dict["abstract_config"] or description_abstract
+        emulation = config_dict["emulation"] or general_config_dict["emulation"]
         expected_result = config_dict["expected_result"]
         user_interface = config_dict["user_interface"] or general_config_dict["user_interface"]
-        simulation_config = SimulationConfig(simulation_project, os.path.relpath(working_directory, simulation_project.get_full_path(".")), ini_file=ini_file, config=config, sim_time_limit=sim_time_limit, num_runs=num_runs, abstract=abstract, expected_result=expected_result, user_interface=user_interface, description=description)
+        simulation_config = SimulationConfig(simulation_project, os.path.relpath(working_directory, simulation_project.get_full_path(".")), ini_file=ini_file, config=config, sim_time_limit=sim_time_limit, num_runs=num_runs, abstract=abstract, emulation=emulation, expected_result=expected_result, user_interface=user_interface, description=description)
         simulation_configs.append(simulation_config)
     return simulation_configs
 
 def collect_all_simulation_configs(simulation_project, ini_path_globs, concurrent=True, **kwargs):
+    build_project(simulation_project=simulation_project, mode="release")
     logger.info("Collecting all simulation configs started")
     ini_paths = list(itertools.chain.from_iterable(map(lambda g: glob.glob(g, recursive=True), ini_path_globs)))
     if concurrent: