Version 1.5.2 - See changelog for updates.

Author: jscott3201

.gitignore

@@ -267,6 +267,8 @@ debug.log
 # Project-specific
 # Add any project-specific files or directories you want to ignore
 sc_test_certs/
+.sc-bench-certs/
+.sc-mixed-certs/
 config/local_config.json
 logs/
 temp/

CHANGELOG.md

@@ -5,6 +5,67 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.5.2] - 2026-02-16
+
+### Fixed
+
+- **Docker entrypoint `sys.path`** — Added project root to `sys.path` so
+  `docker.lib` imports work when the entrypoint is run as a script.
+- **SC PKI `generate_test_pki()`** — Clear directory contents instead of
+  `shutil.rmtree()` on Docker volume mount points (which cannot be removed).
+- **SC certificate SANs** — Use specific `IPv4Address` entries instead of
+  `IPv4Network` for Docker bridge IPs in certificate Subject Alternative Names.
+  `IPv4Network` does not work for SSL hostname verification.
+
+### Added
+
+- **Mixed-environment SC profiling** — `bench_sc.py` supports `--mode hub` and
+  `--mode client` for split Docker/local benchmarks, enabling isolated
+  pyinstrument profiling of hub-side or client-side TLS overhead.
+  `--generate-certs DIR` creates shared TLS certificates with broad SANs
+  (localhost, host.docker.internal, Docker bridge IPs).  New Docker Compose
+  profiles `sc-bench-hub` and `sc-bench-client` and Makefile targets
+  `bench-sc-profile-client` and `bench-sc-profile-hub` orchestrate the
+  mixed-environment runs.
+- **Docker scenario 14: Mixed BIP↔IPv6 routing** — A BACnet/IP client on
+  network 1 communicates with a BACnet/IPv6 server on network 2 through a
+  dual-stack `NetworkRouter`.  Tests read, write, RPM, WPM, and object-list
+  operations through the cross-transport router (6 tests).
+  `make docker-test-mixed-bip-ipv6`.
+- **Docker scenario 15: Mixed BIP↔SC routing** — A BACnet/IP client sends
+  NPDUs through a BIP↔SC `NetworkRouter` to SC echo nodes connected via an
+  SC hub with mutual TLS 1.3 on network 2.  SC echo nodes parse incoming
+  NPDUs and swap SNET/SADR→DNET/DADR headers for proper routed responses.
+  TLS certificates are generated locally and bind-mounted into containers
+  (4 tests).  `make docker-test-mixed-bip-sc`.
+- **Entrypoint roles: `router-bip-sc`, `sc-npdu-echo`** — New Docker
+  entrypoint roles for BIP↔SC gateway routing and NPDU-level SC echo with
+  proper routing header manipulation.
+
+### Changed
+
+- **Docker images tagged with version** — All services share a version-tagged
+  image (`bac-py:<version>`) for reproducible builds.
+- **`docker-build` uses `docker build` directly** — Replaced `docker compose
+  build` (which built nothing since all services have profiles) with a direct
+  `docker build` command.  `docker-clean` now removes all `bac-py:*` images.
+
+- **Performance: APDU dispatch optimization** — Replaced `match`/`case` on
+  `PduType` enum with direct `isinstance` checks in `_on_apdu_received()`,
+  eliminating a redundant `PduType` extraction from the raw byte after
+  `decode_apdu()` already determines the type. BIP throughput improved ~4%,
+  Router throughput improved ~36% (cumulative with loop caching).
+- **Performance: Event loop caching** — Cache the running `asyncio` event loop
+  in `BACnetApplication.start()` and use `loop.create_task()` instead of
+  `asyncio.create_task()` in `_spawn_task()`, skipping the `get_running_loop()`
+  lookup on every request dispatch.
+- **Performance: SC WebSocket pending events deque** — Changed
+  `SCWebSocket._pending_events` from `list` with O(n) `pop(0)` to
+  `collections.deque` with O(1) `popleft()` and built-in `maxlen=64` cap.
+- **Performance: SC hub payload skip** — Hub connections now decode BVLC-SC
+  messages with `skip_payload=True`, avoiding a `bytes()` copy of the NPDU
+  payload that the hub never inspects (it forwards raw bytes directly).
+
 ## [1.5.1] - 2026-02-15
 
 ### Added

Makefile

@@ -3,12 +3,14 @@
        bench-router bench-router-json bench-router-profile \
        bench-bbmd bench-bbmd-json bench-bbmd-profile \
        bench-sc bench-sc-json bench-sc-profile \
+       bench-sc-profile-client bench-sc-profile-hub \
        docker-build docker-test docker-stress docker-test-client docker-test-bbmd \
        docker-test-router docker-test-device-mgmt docker-test-cov-advanced \
        docker-test-events docker-test-sc docker-test-sc-stress docker-sc-stress \
        docker-test-router-stress docker-router-stress \
        docker-test-bbmd-stress docker-bbmd-stress \
        docker-test-ipv6 \
+       docker-test-mixed-bip-ipv6 docker-test-mixed-bip-sc \
        docker-demo docker-demo-auto docker-clean
 
 lint:
@@ -79,14 +81,42 @@ bench-bbmd-profile:
 bench-sc-profile:
 	uv run python scripts/bench_sc.py --profile --sustain 10
 
+# ---------------------------------------------------------------------------
+# Mixed-environment SC profiling (Docker ↔ local split)
+# ---------------------------------------------------------------------------
+
+# Generate shared TLS certs for mixed SC benchmarks
+.sc-bench-certs:
+	uv run python scripts/bench_sc.py --generate-certs .sc-bench-certs
+
+# Profile client side: hub runs in Docker, echo nodes + stress client run locally
+bench-sc-profile-client: .sc-bench-certs docker-build
+	SC_BENCH_CERTS=.sc-bench-certs $(COMPOSE) --profile sc-bench-hub up -d
+	@echo "Waiting for Docker hub..." && sleep 5
+	-uv run python scripts/bench_sc.py --mode client \
+		--hub-uri wss://localhost:4443 --cert-dir .sc-bench-certs \
+		--profile --sustain 15
+	SC_BENCH_CERTS=.sc-bench-certs $(COMPOSE) --profile sc-bench-hub down
+
+# Profile hub side: hub runs locally, echo nodes + stress client run in Docker
+bench-sc-profile-hub: .sc-bench-certs docker-build
+	SC_BENCH_CERTS=.sc-bench-certs $(COMPOSE) --profile sc-bench-client up -d &
+	@echo "Waiting for Docker clients..." && sleep 10
+	uv run python scripts/bench_sc.py --mode hub --port 4443 \
+		--cert-dir .sc-bench-certs --profile --duration 100
+	SC_BENCH_CERTS=.sc-bench-certs $(COMPOSE) --profile sc-bench-client down
+
 # ---------------------------------------------------------------------------
 # Docker integration tests
 # ---------------------------------------------------------------------------
 
+BAC_PY_VERSION := $(shell uv run python -c "import bac_py; print(bac_py.__version__)")
+export BAC_PY_VERSION
+
 COMPOSE := docker compose -f docker/docker-compose.yml
 
 docker-build:
-	$(COMPOSE) build --no-cache
+	docker build --no-cache -t bac-py:$(BAC_PY_VERSION) -f docker/Dockerfile .
 
 docker-test-client: docker-build
 	$(COMPOSE) --profile client-server up --abort-on-container-exit --exit-code-from test-client-server
@@ -128,6 +158,18 @@ docker-test-ipv6: docker-build
 	$(COMPOSE) --profile ipv6 up --abort-on-container-exit --exit-code-from test-ipv6
 	$(COMPOSE) --profile ipv6 down -v
 
+docker-test-mixed-bip-ipv6: docker-build
+	$(COMPOSE) --profile mixed-bip-ipv6 up --abort-on-container-exit --exit-code-from test-mixed-bip-ipv6
+	$(COMPOSE) --profile mixed-bip-ipv6 down -v
+
+.sc-mixed-certs:
+	uv run python -c "from docker.lib.sc_pki import generate_test_pki; from pathlib import Path; generate_test_pki(Path('.sc-mixed-certs'), names=['hub','node1','node2','router'])"
+
+docker-test-mixed-bip-sc: docker-build .sc-mixed-certs
+	SC_MIXED_CERTS=$(CURDIR)/.sc-mixed-certs $(COMPOSE) --profile mixed-bip-sc up --abort-on-container-exit --exit-code-from test-mixed-bip-sc
+	SC_MIXED_CERTS=$(CURDIR)/.sc-mixed-certs $(COMPOSE) --profile mixed-bip-sc down -v
+	rm -rf .sc-mixed-certs
+
 docker-test: docker-build
 	$(MAKE) docker-test-client
 	$(MAKE) docker-test-bbmd
@@ -138,6 +180,8 @@ docker-test: docker-build
 	$(MAKE) docker-test-events
 	$(MAKE) docker-test-sc
 	$(MAKE) docker-test-ipv6
+	$(MAKE) docker-test-mixed-bip-ipv6
+	$(MAKE) docker-test-mixed-bip-sc
 
 docker-stress: docker-build
 	$(COMPOSE) --profile stress-runner up --abort-on-container-exit --exit-code-from stress-runner
@@ -181,3 +225,8 @@ docker-clean:
 	$(COMPOSE) --profile router-stress-runner down -v --rmi local
 	$(COMPOSE) --profile bbmd-stress down -v --rmi local
 	$(COMPOSE) --profile bbmd-stress-runner down -v --rmi local
+	$(COMPOSE) --profile mixed-bip-ipv6 down -v --rmi local
+	$(COMPOSE) --profile mixed-bip-sc down -v --rmi local
+	rm -rf .sc-mixed-certs
+	@echo "Removing all bac-py images..."
+	docker images --format '{{.Repository}}:{{.Tag}}' | grep '^bac-py:' | xargs -r docker rmi 2>/dev/null || true

README.md

@@ -43,7 +43,7 @@ async with Client(instance_number=999) as client:
 | **Convenience API** | String-based addressing (`"ai,1"`, `"pv"`), smart type coercion, auto-discovery |
 | **Serialization** | `to_dict()`/`from_dict()` on all data types; optional `orjson` backend |
 | **Conformance** | BIBB declarations and PICS generation per Clause 24 |
-| **Quality** | 6,420+ unit tests, Docker integration tests, local benchmarks, type-safe enums and frozen dataclasses throughout |
+| **Quality** | 6,425+ unit tests, Docker integration tests, local benchmarks, type-safe enums and frozen dataclasses throughout |
 
 ## Installation
 
@@ -356,7 +356,7 @@ detailed walkthroughs.
 ## Testing
 
 ```bash
-make test          # 6,420+ unit tests
+make test          # 6,425+ unit tests
 make lint          # ruff check + format verification
 make typecheck     # mypy
 make docs          # sphinx-build
@@ -396,6 +396,8 @@ make docker-test-device-mgmt     # Device management: DCC, time sync, text messa
 make docker-test-cov-advanced    # COV: concurrent subscriptions, property-level COV
 make docker-test-events          # Events: alarm reporting, acknowledgment, queries
 make docker-test-ipv6            # IPv6: BACnet/IPv6 client/server (Annex U)
+make docker-test-mixed-bip-ipv6  # Mixed BIP↔IPv6: cross-transport routing
+make docker-test-mixed-bip-sc    # Mixed BIP↔SC: cross-transport routing (TLS)
 make docker-stress               # BIP stress runner (JSON report to stdout)
 make docker-sc-stress            # SC stress runner (JSON report to stdout)
 make docker-router-stress        # Router stress runner (JSON report to stdout)