SnowSignal 0.1.1__tar.gz → 0.1.4.1__tar.gz

{snowsignal-0.1.1 → snowsignal-0.1.4.1}/.github/workflows/publish-to-test-pypi.yml

@@ -28,7 +28,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest] #, mac-latest]
-        python-version: ["3.11", "3.12"]
+        python-version: ["3.11", "3.12", "3.13"]
     runs-on: ${{ matrix.os }}
     continue-on-error: true
     steps:
@@ -45,7 +45,7 @@ jobs:
     - name: Run tests
       run: |
         PYTHON_PATH=$(which python)
-        sudo $PYTHON_PATH -m coverage run --source=. -m unittest discover tests/
+        sudo -E $PYTHON_PATH -m coverage run --source=. -m unittest discover tests/
     - name: Gather coverage statistics
       if: ${{ always() }}
       run: |

{snowsignal-0.1.1 → snowsignal-0.1.4.1}/.gitlab/.gitlab-ci.yml

@@ -1,7 +1,7 @@
 stages:
   - format-lint
   - test
-  - pypi
+  - publish
   - build
   - deploy
 
@@ -26,7 +26,7 @@ format:
   image: "python:$VERSION"
   parallel:
     matrix:
-      - VERSION: ['3.11', '3.12']
+      - VERSION: ['3.11', '3.12', '3.13']
 
 Run unittests:
   <<: *test_job_template
@@ -35,6 +35,8 @@ Run unittests:
     - coverage report -m
     - coverage xml
   coverage: '/TOTAL.*\s+(\d+\%)/'
+  variables:
+    FF_NETWORK_PER_BUILD: 1 # Integration tests need to send real UDP broadcasts so could potentially interfere with one another
   artifacts:
     when: always
     reports:
@@ -44,27 +46,39 @@ Run unittests:
 
 Publish:
   <<: *before_script_template
-  stage: pypi
+  stage: publish
   when: on_success
   image: python:latest
+  variables:
+    GIT_DEPTH: 0
   script:
+    - export
     - pip install .[dist]
     - python -m build
-    - TWINE_PASSWORD=${CI_JOB_TOKEN} TWINE_USERNAME=gitlab-ci-token python -m twine upload --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi dist/*
+    - HATCH_INDEX_AUTH=${CI_JOB_TOKEN} HATCH_INDEX_USER=gitlab-ci-token 
+      python -m hatch publish -r ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi dist/*
 
 Rebuild Image: 
   stage: build
   image: docker
   variables:
     DOCKER_TAG: $CI_COMMIT_REF_NAME
+    PIPARGS: 
+  rules:
+    - if: $CI_COMMIT_BRANCH == "dev"
+      variables:
+        PIPARGS: "--pre"
+      when: on_success
+    - if: $CI_COMMIT_BRANCH == "main"
+      when: on_success
+    - when: never
   services:
     - docker:dind
   script:
     - echo $NAME
-    - docker build -t snowsignal snowsignal
     - docker login https://harbor.stfc.ac.uk -u $DOCKER_REG_NAME --password $DOCKER_REG_TOKEN
-    - echo Build Identifiers - ${NAME}:$DOCKER_TAG
-    - docker build -t harbor.stfc.ac.uk/isis-accelerator-controls/snowsignal:$DOCKER_TAG snowsignal
+    - echo "Build Identifiers - name=${NAME} tag=${DOCKER_TAG} pipargs=${PIPARGS}" 
+    - docker build --no-cache --build-arg PIPARGS=${PIPARGS} -t harbor.stfc.ac.uk/isis-accelerator-controls/snowsignal:$DOCKER_TAG snowsignal
     - docker push harbor.stfc.ac.uk/isis-accelerator-controls/snowsignal:$DOCKER_TAG
 
 Deploy Development Image:

{snowsignal-0.1.1 → snowsignal-0.1.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: SnowSignal
-Version: 0.1.1
+Version: 0.1.4.1
 Summary: UDP Broadcast Relay
 Project-URL: Repository, https://github.com/ISISNeutronMuon/SnowSignal
 Author-email: Ivan Finch <ivan.finch@stfc.ac.uk>
@@ -16,14 +16,15 @@ Classifier: Programming Language :: Python
 Classifier: Topic :: System :: Networking
 Classifier: Typing :: Typed
 Requires-Python: >=3.11
+Requires-Dist: cachetools>=5.5
 Requires-Dist: configargparse>=1.7
 Requires-Dist: psutil>=5.9
 Provides-Extra: dist
 Requires-Dist: build>=1.2; extra == 'dist'
-Requires-Dist: twine>=5.1; extra == 'dist'
+Requires-Dist: hatch>=1.14; extra == 'dist'
 Provides-Extra: test
 Requires-Dist: coverage>=7.6; extra == 'test'
-Requires-Dist: ruff>0.6; extra == 'test'
+Requires-Dist: ruff>0.9; extra == 'test'
 Requires-Dist: scapy~=2.0; extra == 'test'
 Description-Content-Type: text/markdown
 

snowsignal-0.1.4.1/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.1.4.1'
+__version_tuple__ = version_tuple = (0, 1, 4, 1)
+
+__commit_id__ = commit_id = None

{snowsignal-0.1.1 → snowsignal-0.1.4.1}/docker-compose.dev.yml

@@ -1,22 +1,21 @@
-version: '3.9'
-
 services:
   snowsignal:
     image: harbor.stfc.ac.uk/isis-accelerator-controls/snowsignal:dev
     environment:
       SERVICENAME: '{{.Service.Name}}'
-      LOGLEVEL: 'debug'
+      LOGLEVEL:
     networks:
-      - snowsignal-test
+      - controls
     deploy: 
       mode: global
       placement:
          max_replicas_per_node: 1
+    restart: unless-stopped
 
   probe:
     image: harbor.stfc.ac.uk/isis-accelerator-controls/internal-pvagw-tests
     networks:
-      - snowsignal-test
+      - controls
     deploy: 
       mode: global
       placement:

{snowsignal-0.1.1 → snowsignal-0.1.4.1}/docker-compose.local-dev.yml

@@ -10,8 +10,8 @@ services:
         hostname: server1
         container_name: server1
         build:
-            context: ./snowsignal
-        command: "sleep infinity"
+            context: ./tests
+        command: "sh /snowsignal/tests/testenv.sh"
         volumes:
             - .:/snowsignal/
         networks:
@@ -22,8 +22,8 @@ services:
         hostname: server2
         container_name: server2
         build:
-            context: ./snowsignal
-        command: "sleep infinity"
+            context: ./tests
+        command: "sh /snowsignal/tests/testenv.sh"
         volumes:
             - .:/snowsignal/
         networks:

{snowsignal-0.1.1 → snowsignal-0.1.4.1}/docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.9'
-
 services:
   snowsignal:
     image: harbor.stfc.ac.uk/isis-accelerator-controls/snowsignal:main
@@ -11,6 +9,8 @@ services:
       mode: global
       placement:
          max_replicas_per_node: 1
+    restart: unless-stopped
+    
 
 networks:
   controls:

{snowsignal-0.1.1 → snowsignal-0.1.4.1}/docs/local_dev.md

@@ -25,6 +25,9 @@ socat - udp-datagram:255.255.255.255:5076,broadcast
 ```
 will allow a user to type text and press enter to send it as the payload of a UDP broadcast message.
 
+> [!caution]
+> 'socat' (and `nc`) do not produce valid UDP checksums in their broadcasts. If SnowSignal rebroadcasts a packet from one of these sources it may appear to have an invalid UDP checksum.
+
 `tcpdump` is used to show a raw dump of received network packets. This command line 
 ```
 tcpdump -e -i eth0 udp and broadcast -vv -X

{snowsignal-0.1.1 → snowsignal-0.1.4.1}/pyproject.toml

@@ -2,6 +2,7 @@
 name = "SnowSignal"
 dynamic = ["version"]
 dependencies = [
+    "cachetools>=5.5",
     "configargparse>=1.7",
     "psutil>=5.9",
 ]
@@ -33,12 +34,12 @@ Repository = "https://github.com/ISISNeutronMuon/SnowSignal"
 [project.optional-dependencies]
 test = [
   "scapy~=2.0",
-  "ruff>0.6",
+  "ruff>0.9",
   "coverage>=7.6"
 ]
 dist = [
   "build>=1.2",
-  "twine>=5.1",
+  "hatch>=1.14",
 ]
 
 [build-system]

{snowsignal-0.1.1 → snowsignal-0.1.4.1}/snowsignal/configure.py

@@ -20,12 +20,13 @@ class ConfigArgs(NamedTuple):
     mesh_port: int
     other_relays: list[str]
     log_level: str
+    decode_pvaccess: bool
 
 
 def configure(argv: Sequence[str] | None = None) -> ConfigArgs:
     """Setup configuration for the SnowSignal service"""
 
-    p = configargparse.ArgParser()
+    p = configargparse.ArgParser(prog="snowsignal")
     # Remember to add new arguments to the Args class above!
     p.add_argument(
         "-t",
@@ -66,6 +67,7 @@ def configure(argv: Sequence[str] | None = None) -> ConfigArgs:
         default="info",
         help="Logging level",
     )
+    p.add_argument("--decode-pvaccess", action="store_true", help="Attempt to decode and log to INFO pvaccess messages")
     # Remember to add new arguments to the Args class above!
 
     # config = p.parse_args(argv)
@@ -82,10 +84,12 @@ def configure(argv: Sequence[str] | None = None) -> ConfigArgs:
             loglevel = logging.INFO
         case "debug":
             loglevel = logging.DEBUG
+        case _:
+            loglevel = logging.WARNING
 
     if loglevel < logging.INFO:
         logging.basicConfig(
-            format="%(asctime)s - %(levelname)s - " "%(name)s.%(funcName)s: %(message)s",
+            format="%(asctime)s - %(levelname)s - %(name)s.%(funcName)s: %(message)s",
             encoding="utf-8",
             level=loglevel,
         )
@@ -100,7 +104,7 @@ def configure(argv: Sequence[str] | None = None) -> ConfigArgs:
             "Broadcast port (%i) and mesh port (%i) may not be the same", config.broadcast_port, config.mesh_port
         )
         raise ValueError(
-            f"Broadcast port ({config.broadcast_port}) and " f"mesh port ({config.mesh_port}) may not be the same"
+            f"Broadcast port ({config.broadcast_port}) and mesh port ({config.mesh_port}) may not be the same"
         )
 
     return config

{snowsignal-0.1.1 → snowsignal-0.1.4.1}/snowsignal/dockerfile

@@ -2,8 +2,10 @@
 # psutils requirement in requirements.txt
 FROM python:3.12-slim
 
+ARG PIPARGS=
+
 # Token has read_api and read_repository permissions and so does not need to be kept secret
 # However it will expire
-RUN pip install SnowSignal --index-url https://gitlab.stfc.ac.uk/api/v4/projects/5671/packages/pypi/simple 
+RUN pip install SnowSignal ${PIPARGS} --no-cache-dir --index-url https://gitlab.stfc.ac.uk/api/v4/projects/5671/packages/pypi/simple 
 
 CMD ["python", "-m", "snowsignal"]

{snowsignal-0.1.1 → snowsignal-0.1.4.1}/snowsignal/netutils.py

@@ -65,9 +65,7 @@ def get_from_iface(
         if snicaddr.family == family:
             return getattr(snicaddr, attribute)
 
-    raise ResourceNotFoundException(
-        f"Could not identify the {family}, " "{attribute} associated with interface {iface}"
-    )
+    raise ResourceNotFoundException(f"Could not identify the {family}, {attribute} associated with interface {iface}")
 
 
 def get_localipv4_from_iface(iface: str) -> str:

{snowsignal-0.1.1 → snowsignal-0.1.4.1}/snowsignal/packet.py

@@ -48,6 +48,10 @@ class Packet:
     ip_chksum: int | None = None
     ip_src_addr: str | None = None
     ip_dst_addr: str | None = None
+    ip_length: int | None = None
+    ipv4_identification: int | None = None
+    ipv4_more_fragments: bool = False
+    ipv4_fragmented_offset: int | None = None
 
     udp_src_port: int | None = None
     udp_dst_port: int | None = None
@@ -93,6 +97,14 @@ class Packet:
         if self.ip_version != 4:
             return
 
+        self.ip_length = iph[2]
+        self.ipv4_identification = iph[3]
+
+        # Decode fragment data
+        fragment_flag_and_offset = iph[4]
+        self.ipv4_more_fragments = bool(fragment_flag_and_offset & 0x2000)
+        self.ipv4_fragmented_offset = fragment_flag_and_offset & 0x1FFF
+
         # Calculate the length (of the header?)
         ihl = version_ihl & 0xF
         self._iph_length = ihl * 4
@@ -172,3 +184,21 @@ class Packet:
     def change_ethernet_source(self, newmac) -> None:
         """Change packet Ethernet source to a new MAC address"""
         self.raw = self.raw[0:6] + newmac + self.raw[12:]
+
+    def is_ipv4_fragmented(self) -> bool:
+        """Check if the IPv4 packet is fragmented"""
+        # Check for IP packet fragmentation, only IPv4 packets can be fragmented
+        # https://en.wikipedia.org/wiki/IPv4#Fragmentation_and_reassembly
+        # If a fragment then the More Fragments flag is set True for the first fragment and subsequent flags until the
+        # last segment in which the More Fragments flag is False. However, the Fragment Offset is only zero
+        # in the first fragment.
+        # We can identify a last fragment by the More Fragments flag being False and the Fragment Offset being non-zero.
+        # A non-fragmented IP packet will have the More Fragments flag set False and the Fragment Offset equal to zero.
+        logger.debug(
+            "ip_version = %i, ipv4_more_fragments = %s, ipv4_fragmented_offset = %i",
+            self.ip_version,
+            self.ipv4_more_fragments,
+            self.ipv4_fragmented_offset,
+        )
+
+        return self.ip_version == 4 and (self.ipv4_more_fragments or self.ipv4_fragmented_offset != 0)