Merge pull request #904 from coreemu/develop

CORE 9.2.0

Author: bharnden

.github/workflows/daemon-checks.yml

@@ -7,10 +7,10 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v1
-      - name: Set up Python 3.9
+      - name: Set up Python
         uses: actions/setup-python@v1
         with:
-          python-version: 3.9
+          python-version: 3.10.16
       - name: install poetry
         run: |
           python -m pip install --upgrade pip
@@ -22,15 +22,15 @@ jobs:
       - name: isort
         run: |
           cd daemon
-          poetry run isort -c -df
+          poetry run isort -c --df .
       - name: black
         run: |
           cd daemon
           poetry run black --check .
       - name: flake8
         run: |
           cd daemon
-          poetry run flake8
+          poetry run flake8 .
       - name: grpc
         run: |
           cd daemon/proto

CHANGELOG.md

@@ -1,3 +1,24 @@
+## 2025-02-11 CORE 9.2.0
+
+* Installation
+    * python3.10+ now required
+    * updated various dependencies to help avoid the need to build them from source
+* Documentation
+    * docker run examples updated
+    * gRPC edit link examples corrected
+    * updated install examples
+    * updated tutorials to use absolute paths
+    * updated custom service example
+* core-daemon
+    * removed use of killall in provided services
+    * \#860 - fixed core-cli xml --start to run control network
+    * \#881 - EMANE TDMA fails to start
+    * \#888 - fixed service start validation
+    * \#902 - link deletion removing incorrect nodes
+* core-gui
+    * fixed bug when changing icons on a loaded scenario
+    * \#897 - fixed to properly exit when closing on a running session
+
 ## 2024-07-04 CORE 9.1.0
 
 * Installation

Makefile.am

@@ -100,7 +100,6 @@ fpm -s dir -t rpm -n core \
 	-d "tk" \
 	-d "procps-ng" \
 	-d "bash >= 3.0" \
-	-d "ebtables" \
 	-d "iproute" \
 	-d "libev" \
 	-d "net-tools" \
@@ -133,7 +132,6 @@ fpm -s dir -t deb -n core \
 	-d "procps" \
 	-d "libc6 >= 2.14" \
 	-d "bash >= 3.0" \
-	-d "ebtables" \
 	-d "iproute2" \
 	-d "libev4" \
 	-d "nftables" \

README.md

@@ -2,7 +2,7 @@
 
 CORE: Common Open Research Emulator
 
-Copyright (c)2005-2023 the Boeing Company.
+Copyright (c)2005-2025 the Boeing Company.
 
 See the LICENSE file included in this distribution.
 

configure.ac

@@ -2,7 +2,7 @@
 # Process this file with autoconf to produce a configure script.
 
 # this defines the CORE version number, must be static for AC_INIT
-AC_INIT(core, 9.1.0)
+AC_INIT(core, 9.2.0)
 
 # autoconf and automake initialization
 AC_CONFIG_SRCDIR([netns/version.h.in])
@@ -79,8 +79,8 @@ if test "x$enable_daemon" = "xyes"; then
   want_python=yes
   want_linux_netns=yes
 
-  AM_PATH_PYTHON(3.9)
-  AS_IF([$PYTHON -m grpc_tools.protoc -h &> /dev/null], [], [AC_MSG_ERROR([please install python grpcio-tools])])
+  AM_PATH_PYTHON(3.10)
+  AS_IF([./venv/bin/python -m grpc_tools.protoc -h &> /dev/null], [], [AC_MSG_ERROR([grpc tools must be setup in venv, try setup.sh])])
 
   AC_CHECK_PROG(sysctl_path, sysctl, $as_dir, no, $SEARCHPATH)
   if test "x$sysctl_path" = "xno" ; then

daemon/.pre-commit-config.yaml

@@ -3,21 +3,21 @@ repos:
   hooks:
   - id: isort
     name: isort
-    stages: [commit]
+    stages: [pre-commit]
     language: system
-    entry: bash -c 'cd daemon && poetry run isort --atomic -y'
+    entry: bash -c 'cd daemon && poetry run isort --atomic .'
     types: [python]
 
   - id: black
     name: black
-    stages: [commit]
+    stages: [pre-commit]
     language: system
     entry: bash -c 'cd daemon && poetry run black .'
     types: [python]
 
   - id: flake8
     name: flake8
-    stages: [commit]
+    stages: [pre-commit]
     language: system
-    entry: bash -c 'cd daemon && poetry run flake8'
+    entry: bash -c 'cd daemon && poetry run flake8 .'
     types: [python]

daemon/core/api/grpc/client.py

@@ -8,7 +8,7 @@
 from contextlib import contextmanager
 from pathlib import Path
 from queue import Queue
-from typing import Any, Optional
+from typing import Any
 
 import grpc
 
@@ -57,7 +57,7 @@
 class MoveNodesStreamer:
     def __init__(self, session_id: int, source: str = None) -> None:
         self.session_id: int = session_id
-        self.source: Optional[str] = source
+        self.source: str | None = source
         self.queue: SetQueue = SetQueue()
 
     def send_position(self, node_id: int, x: float, y: float) -> None:
@@ -83,8 +83,8 @@ def send(self, request: wrappers.MoveNodesRequest) -> None:
     def stop(self) -> None:
         self.queue.put(None)
 
-    def next(self) -> Optional[core_pb2.MoveNodesRequest]:
-        request: Optional[wrappers.MoveNodesRequest] = self.queue.get()
+    def next(self) -> core_pb2.MoveNodesRequest | None:
+        request: wrappers.MoveNodesRequest | None = self.queue.get()
         if request:
             return request.to_proto()
         else:
@@ -98,11 +98,11 @@ class EmanePathlossesStreamer:
     def __init__(self) -> None:
         self.queue: Queue = Queue()
 
-    def send(self, request: Optional[wrappers.EmanePathlossesRequest]) -> None:
+    def send(self, request: wrappers.EmanePathlossesRequest | None) -> None:
         self.queue.put(request)
 
-    def next(self) -> Optional[emane_pb2.EmanePathlossesRequest]:
-        request: Optional[wrappers.EmanePathlossesRequest] = self.queue.get()
+    def next(self) -> emane_pb2.EmanePathlossesRequest | None:
+        request: wrappers.EmanePathlossesRequest | None = self.queue.get()
         if request:
             return request.to_proto()
         else:
@@ -116,11 +116,11 @@ class EmaneEventsStreamer:
     def __init__(self) -> None:
         self.queue: Queue = Queue()
 
-    def send(self, request: Optional[wrappers.EmaneEventsRequest]) -> None:
+    def send(self, request: wrappers.EmaneEventsRequest | None) -> None:
         self.queue.put(request)
 
-    def next(self) -> Optional[emane_pb2.EmaneEventsRequest]:
-        request: Optional[wrappers.EmaneEventsRequest] = self.queue.get()
+    def next(self) -> emane_pb2.EmaneEventsRequest | None:
+        request: wrappers.EmaneEventsRequest | None = self.queue.get()
         if request:
             return request.to_proto()
         else:
@@ -133,6 +133,10 @@ def iter(self):
 class InterfaceHelper:
     """
     Convenience class to help generate IP4 and IP6 addresses for gRPC clients.
+
+    This is not a requirement to use, as interfaces can be created manually as
+    desired. Node IDs are used to index into a subnet, so if the subnet is tool small
+    of a pool of addresses and the node ID is too high, there will be a failure.
     """
 
     def __init__(self, ip4_prefix: str = None, ip6_prefix: str = None) -> None:
@@ -242,8 +246,8 @@ def __init__(self, address: str = "localhost:50051", proxy: bool = False) -> Non
         :param address: grpc server address to connect to
         """
         self.address: str = address
-        self.stub: Optional[core_pb2_grpc.CoreApiStub] = None
-        self.channel: Optional[grpc.Channel] = None
+        self.stub: core_pb2_grpc.CoreApiStub | None = None
+        self.channel: grpc.Channel | None = None
         self.proxy: bool = proxy
 
     def start_session(
@@ -830,7 +834,7 @@ def open_xml(self, file_path: Path, start: bool = False) -> tuple[bool, int]:
         Load a local scenario XML file to open as a new session.
 
         :param file_path: path of scenario XML file
-        :param start: tuple of result and session id when successful
+        :param start: instantiate session if true, false for a definition state
         :return: tuple of result and session id
         """
         with file_path.open("r") as f:
@@ -934,7 +938,7 @@ def get_emane_event_channel(
         response = self.stub.GetEmaneEventChannel(request)
         return wrappers.EmaneEventChannel.from_proto(response)
 
-    def execute_script(self, script: str, args: str) -> Optional[int]:
+    def execute_script(self, script: str, args: str) -> int | None:
         """
         Executes a python script given context of the current CoreEmu object.
 
@@ -1073,9 +1077,7 @@ def create_service(
         recreate: bool = False,
     ) -> bool:
         request = CreateServiceRequest(
-            service=service.to_proto(),
-            templates=templates,
-            recreate=recreate,
+            service=service.to_proto(), templates=templates, recreate=recreate
         )
         response = self.stub.CreateService(request)
         return response.result

daemon/core/api/grpc/events.py

@@ -1,7 +1,6 @@
 import logging
 from collections.abc import Iterable
 from queue import Empty, Queue
-from typing import Optional
 
 from core.api.grpc import core_pb2, grpcutils
 from core.api.grpc.grpcutils import convert_link_data
@@ -113,7 +112,7 @@ def add_handlers(self) -> None:
         if core_pb2.EventType.SESSION in self.event_types:
             self.session.broadcast_manager.add_handler(EventData, self.queue.put)
 
-    def process(self) -> Optional[core_pb2.Event]:
+    def process(self) -> core_pb2.Event | None:
         """
         Process the next event in the queue.
 

daemon/core/api/grpc/grpcutils.py

@@ -1,7 +1,7 @@
 import logging
 import time
 from pathlib import Path
-from typing import Any, Optional, Union
+from typing import Any
 
 import grpc
 from google.protobuf.internal.containers import RepeatedCompositeFieldContainer
@@ -248,7 +248,7 @@ def convert_session_options(session: Session) -> dict[str, common_pb2.ConfigOpti
 
 def get_config_options(
     config: dict[str, str],
-    configurable_options: Union[ConfigurableOptions, type[ConfigurableOptions]],
+    configurable_options: ConfigurableOptions | type[ConfigurableOptions],
 ) -> dict[str, common_pb2.ConfigOption]:
     """
     Retrieve configuration options in a form that is used by the grpc server.
@@ -348,8 +348,7 @@ def get_node_proto(
             if not service.custom_templates and not service.custom_config:
                 continue
             service_configs[service.name] = services_pb2.ServiceConfig(
-                templates=service.custom_templates,
-                config=service.custom_config,
+                templates=service.custom_templates, config=service.custom_config
             )
     return core_pb2.Node(
         id=node.id,
@@ -525,9 +524,9 @@ def convert_options_proto(options: core_pb2.LinkOptions) -> LinkOptions:
 
 def convert_link(
     node1: NodeBase,
-    iface1: Optional[CoreInterface],
+    iface1: CoreInterface | None,
     node2: NodeBase,
-    iface2: Optional[CoreInterface],
+    iface2: CoreInterface | None,
     options: LinkOptions,
     unidirectional: bool,
 ) -> core_pb2.Link:
@@ -710,7 +709,7 @@ def get_hooks(session: Session) -> list[core_pb2.Hook]:
 
 def get_mobility_node(
     session: Session, node_id: int, context: ServicerContext
-) -> Union[WlanNode, EmaneNet]:
+) -> WlanNode | EmaneNet:
     """
     Get mobility node.
 
@@ -820,5 +819,5 @@ def configure_node(
                 service.set_template(name, template)
 
 
-def get_optional(message: Message, name: str) -> Optional[Any]:
+def get_optional(message: Message, name: str) -> Any | None:
     return getattr(message, name) if message.HasField(name) else None

daemon/core/api/grpc/server.py

@@ -9,7 +9,6 @@
 from concurrent import futures
 from pathlib import Path
 from re import Pattern
-from typing import Optional
 
 import grpc
 from grpc import ServicerContext
@@ -107,7 +106,7 @@ def __init__(self, coreemu: CoreEmu) -> None:
         super().__init__()
         self.coreemu: CoreEmu = coreemu
         self.running: bool = True
-        self.server: Optional[grpc.Server] = None
+        self.server: grpc.Server | None = None
         # catch signals
         signal.signal(signal.SIGHUP, self._signal_handler)
         signal.signal(signal.SIGINT, self._signal_handler)
@@ -230,10 +229,7 @@ def GetConfig(
             )
             services.append(service_proto)
         emane_models = [x.name for x in EmaneModelManager.models.values()]
-        return core_pb2.GetConfigResponse(
-            services=services,
-            emane_models=emane_models,
-        )
+        return core_pb2.GetConfigResponse(services=services, emane_models=emane_models)
 
     def StartSession(
         self, request: core_pb2.StartSessionRequest, context: ServicerContext
@@ -1305,9 +1301,7 @@ def GetWirelessConfig(
         return GetWirelessConfigResponse(config=config_options)
 
     def EmaneEvents(
-        self,
-        request_iterator: Iterable[EmaneEventsRequest],
-        context: ServicerContext,
+        self, request_iterator: Iterable[EmaneEventsRequest], context: ServicerContext
     ) -> EmaneEventsResponse:
         for request in request_iterator:
             session = self.get_session(request.session_id, context)
@@ -1396,10 +1390,7 @@ def EmaneEvents(
                         session, node, antenna.iface_id, context
                     )
                 session.emane.event_manager.publish_antenna_profile(
-                    nem_id,
-                    antenna.profile,
-                    antenna.azimuth,
-                    antenna.elevation,
+                    nem_id, antenna.profile, antenna.azimuth, antenna.elevation
                 )
             elif request.HasField("fading"):
                 fading = request.fading
@@ -1416,9 +1407,7 @@ def EmaneEvents(
         return EmaneEventsResponse()
 
     def CreateService(
-        self,
-        request: CreateServiceRequest,
-        context: ServicerContext,
+        self, request: CreateServiceRequest, context: ServicerContext
     ) -> CreateServiceResponse:
         service = request.service
         class_name = f"{service.name.capitalize()}Class"