doip-server 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. doip_server-0.1.0/LICENSE +21 -0
  2. doip_server-0.1.0/PKG-INFO +109 -0
  3. doip_server-0.1.0/README.md +82 -0
  4. doip_server-0.1.0/pyproject.toml +71 -0
  5. doip_server-0.1.0/src/doip_server/__init__.py +0 -0
  6. doip_server-0.1.0/src/doip_server/doip_server.py +828 -0
  7. doip_server-0.1.0/src/doip_server/hierarchical_config_manager.py +508 -0
  8. doip_server-0.1.0/src/doip_server/main.py +39 -0
doip_server-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Alonso Ramirez
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
doip_server-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,109 @@
1
+ Metadata-Version: 2.4
2
+ Name: doip-server
3
+ Version: 0.1.0
4
+ Summary: DoIP Server and Client implementation with YAML configuration
5
+ License: MIT
6
+ License-File: LICENSE
7
+ Keywords: doip,diagnostics,automotive,uds,iso13400,server,client
8
+ Author: Alonso Ramirez
9
+ Author-email: alonsoram07@gmail.com
10
+ Requires-Python: >=3.10,<4.0
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: License :: OSI Approved :: MIT License
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
21
+ Classifier: Topic :: System :: Networking
22
+ Classifier: Topic :: Communications
23
+ Requires-Dist: PyYAML (>=6.0,<7.0)
24
+ Requires-Dist: doipclient (>=1.1.7,<2.0.0)
25
+ Description-Content-Type: text/markdown
26
+
27
+ # DoIP Server
28
+
29
+ A Python implementation of DoIP (Diagnostics over Internet Protocol) server and client with comprehensive YAML configuration management.
30
+
31
+ ## ๐Ÿš€ Quick Start
32
+
33
+ ```bash
34
+ # Install dependencies
35
+ poetry install
36
+
37
+ # Run with hierarchical configuration
38
+ poetry run python src/doip_server/main.py --gateway-config config/gateway1.yaml
39
+
40
+ # Test UDP Vehicle Identification
41
+ python run_udp_client.py --verbose
42
+
43
+ # Test Functional Diagnostics (NEW!)
44
+ python test_functional_diagnostics.py
45
+ ```
46
+
47
+ ## ๐Ÿ“š Documentation
48
+
49
+ All documentation has been moved to the `docs/` directory for better organization:
50
+
51
+ - **[๐Ÿ“– Documentation Index](docs/INDEX.md)** - Complete documentation index
52
+ - **[๐Ÿš€ Getting Started](docs/README.md)** - Detailed project overview and setup
53
+ - **[โš™๏ธ Configuration Guide](docs/HIERARCHICAL_CONFIGURATION_GUIDE.md)** - Hierarchical configuration system
54
+ - **[๐Ÿ”ง Functional Diagnostics](docs/FUNCTIONAL_DIAGNOSTICS_GUIDE.md)** - Functional addressing and broadcast diagnostics
55
+ - **[๐Ÿงช Test Results](docs/COMPREHENSIVE_TEST_RESULTS.md)** - Complete test results and analysis
56
+
57
+ ## โœจ Key Features
58
+
59
+ - **Hierarchical Configuration**: Multi-file configuration system with dynamic ECU loading
60
+ - **Response Cycling**: Automatic cycling through multiple responses per UDS service
61
+ - **Per-ECU Services**: ECU-specific UDS service definitions
62
+ - **Functional Diagnostics**: Broadcast requests to multiple ECUs using functional addressing (NEW!)
63
+ - **UDP Vehicle Identification**: Network discovery via UDP broadcasts
64
+ - **Comprehensive Testing**: 99.5% test pass rate with full core functionality
65
+
66
+ ## ๐Ÿ—๏ธ Architecture
67
+
68
+ ```
69
+ config/
70
+ โ”œโ”€โ”€ gateway1.yaml # Gateway network configuration
71
+ โ”œโ”€โ”€ ecu_engine.yaml # Engine ECU configuration
72
+ โ”œโ”€โ”€ ecu_transmission.yaml # Transmission ECU configuration
73
+ โ”œโ”€โ”€ ecu_abs.yaml # ABS ECU configuration
74
+ โ””โ”€โ”€ uds_services.yaml # Common UDS services
75
+ ```
76
+
77
+ ## ๐Ÿ“Š Test Status
78
+
79
+ - **Unit Tests**: 17/17 โœ… (100%)
80
+ - **Hierarchical Config Tests**: 21/21 โœ… (100%)
81
+ - **Response Cycling Tests**: 9/9 โœ… (100%)
82
+ - **Legacy Integration Tests**: 13/13 โœ… (100%)
83
+ - **Client Extended Tests**: 25/25 โœ… (100%)
84
+ - **Main Module Tests**: 12/12 โœ… (100%)
85
+ - **Validate Config Tests**: 15/15 โœ… (100%)
86
+ - **Debug Client Tests**: 30/30 โœ… (100%)
87
+ - **Demo Tests**: 5/6 โœ… (83% - 1 skipped)
88
+ - **Overall**: 185/186 tests passing (99.5% success rate)
89
+
90
+ ## ๐Ÿ”ง Development
91
+
92
+ ```bash
93
+ # Run tests
94
+ poetry run pytest tests/ -v
95
+
96
+ # Run specific test categories
97
+ poetry run pytest tests/test_doip_unit.py -v
98
+ poetry run pytest tests/test_hierarchical_configuration.py -v
99
+ poetry run pytest tests/test_response_cycling.py -v
100
+ ```
101
+
102
+ ## ๐Ÿ“– Documentation
103
+
104
+ For detailed documentation, see the [docs/](docs/) directory or start with the [Documentation Index](docs/INDEX.md).
105
+
106
+ ---
107
+
108
+ *For complete documentation and implementation details, see the [docs/](docs/) directory.*
109
+
doip_server-0.1.0/README.md ADDED
@@ -0,0 +1,82 @@
1
+ # DoIP Server
2
+
3
+ A Python implementation of DoIP (Diagnostics over Internet Protocol) server and client with comprehensive YAML configuration management.
4
+
5
+ ## ๐Ÿš€ Quick Start
6
+
7
+ ```bash
8
+ # Install dependencies
9
+ poetry install
10
+
11
+ # Run with hierarchical configuration
12
+ poetry run python src/doip_server/main.py --gateway-config config/gateway1.yaml
13
+
14
+ # Test UDP Vehicle Identification
15
+ python run_udp_client.py --verbose
16
+
17
+ # Test Functional Diagnostics (NEW!)
18
+ python test_functional_diagnostics.py
19
+ ```
20
+
21
+ ## ๐Ÿ“š Documentation
22
+
23
+ All documentation has been moved to the `docs/` directory for better organization:
24
+
25
+ - **[๐Ÿ“– Documentation Index](docs/INDEX.md)** - Complete documentation index
26
+ - **[๐Ÿš€ Getting Started](docs/README.md)** - Detailed project overview and setup
27
+ - **[โš™๏ธ Configuration Guide](docs/HIERARCHICAL_CONFIGURATION_GUIDE.md)** - Hierarchical configuration system
28
+ - **[๐Ÿ”ง Functional Diagnostics](docs/FUNCTIONAL_DIAGNOSTICS_GUIDE.md)** - Functional addressing and broadcast diagnostics
29
+ - **[๐Ÿงช Test Results](docs/COMPREHENSIVE_TEST_RESULTS.md)** - Complete test results and analysis
30
+
31
+ ## โœจ Key Features
32
+
33
+ - **Hierarchical Configuration**: Multi-file configuration system with dynamic ECU loading
34
+ - **Response Cycling**: Automatic cycling through multiple responses per UDS service
35
+ - **Per-ECU Services**: ECU-specific UDS service definitions
36
+ - **Functional Diagnostics**: Broadcast requests to multiple ECUs using functional addressing (NEW!)
37
+ - **UDP Vehicle Identification**: Network discovery via UDP broadcasts
38
+ - **Comprehensive Testing**: 99.5% test pass rate with full core functionality
39
+
40
+ ## ๐Ÿ—๏ธ Architecture
41
+
42
+ ```
43
+ config/
44
+ โ”œโ”€โ”€ gateway1.yaml # Gateway network configuration
45
+ โ”œโ”€โ”€ ecu_engine.yaml # Engine ECU configuration
46
+ โ”œโ”€โ”€ ecu_transmission.yaml # Transmission ECU configuration
47
+ โ”œโ”€โ”€ ecu_abs.yaml # ABS ECU configuration
48
+ โ””โ”€โ”€ uds_services.yaml # Common UDS services
49
+ ```
50
+
51
+ ## ๐Ÿ“Š Test Status
52
+
53
+ - **Unit Tests**: 17/17 โœ… (100%)
54
+ - **Hierarchical Config Tests**: 21/21 โœ… (100%)
55
+ - **Response Cycling Tests**: 9/9 โœ… (100%)
56
+ - **Legacy Integration Tests**: 13/13 โœ… (100%)
57
+ - **Client Extended Tests**: 25/25 โœ… (100%)
58
+ - **Main Module Tests**: 12/12 โœ… (100%)
59
+ - **Validate Config Tests**: 15/15 โœ… (100%)
60
+ - **Debug Client Tests**: 30/30 โœ… (100%)
61
+ - **Demo Tests**: 5/6 โœ… (83% - 1 skipped)
62
+ - **Overall**: 185/186 tests passing (99.5% success rate)
63
+
64
+ ## ๐Ÿ”ง Development
65
+
66
+ ```bash
67
+ # Run tests
68
+ poetry run pytest tests/ -v
69
+
70
+ # Run specific test categories
71
+ poetry run pytest tests/test_doip_unit.py -v
72
+ poetry run pytest tests/test_hierarchical_configuration.py -v
73
+ poetry run pytest tests/test_response_cycling.py -v
74
+ ```
75
+
76
+ ## ๐Ÿ“– Documentation
77
+
78
+ For detailed documentation, see the [docs/](docs/) directory or start with the [Documentation Index](docs/INDEX.md).
79
+
80
+ ---
81
+
82
+ *For complete documentation and implementation details, see the [docs/](docs/) directory.*
doip_server-0.1.0/pyproject.toml ADDED
@@ -0,0 +1,71 @@
1
+ [project]
2
+ name = "doip-server"
3
+ version = "0.1.0"
4
+ description = "DoIP Server and Client implementation with YAML configuration"
5
+ authors = [
6
+ {name = "Alonso Ramirez", email = "alonsoram07@gmail.com"}
7
+ ]
8
+ license = {text = "MIT"}
9
+ readme = "README.md"
10
+ requires-python = ">=3.10,<4.0"
11
+ keywords = ["doip", "diagnostics", "automotive", "uds", "iso13400", "server", "client"]
12
+ classifiers = [
13
+ "Development Status :: 4 - Beta",
14
+ "Intended Audience :: Developers",
15
+ "License :: OSI Approved :: MIT License",
16
+ "Operating System :: OS Independent",
17
+ "Programming Language :: Python :: 3",
18
+ "Programming Language :: Python :: 3.10",
19
+ "Programming Language :: Python :: 3.11",
20
+ "Programming Language :: Python :: 3.12",
21
+ "Programming Language :: Python :: 3.13",
22
+ "Topic :: Software Development :: Libraries :: Python Modules",
23
+ "Topic :: System :: Networking",
24
+ "Topic :: Communications",
25
+ ]
26
+ dependencies = [
27
+ "PyYAML>=6.0,<7.0",
28
+ "doipclient>=1.1.7,<2.0.0"
29
+ ]
30
+
31
+ [tool.poetry]
32
+ packages = [{include = "doip_server", from = "src"}]
33
+
34
+ [tool.poetry.group.dev.dependencies]
35
+ pytest = "^8.3.5"
36
+ pytest-cov = "^6.0.0"
37
+ flake8 = "^7.0.0"
38
+ black = "^24.0.0"
39
+ bandit = "^1.7.0"
40
+ safety = "^2.3.0"
41
+ build = "^1.3.0"
42
+ twine = "^6.2.0"
43
+
44
+ [tool.pytest.ini_options]
45
+ testpaths = ["tests"]
46
+ python_files = ["test_*.py"]
47
+ python_classes = ["Test*"]
48
+ python_functions = ["test_*"]
49
+ addopts = [
50
+ "-v",
51
+ "--tb=short",
52
+ "--strict-markers",
53
+ "--disable-warnings"
54
+ ]
55
+ markers = [
56
+ "integration: marks tests as integration tests",
57
+ "unit: marks tests as unit tests",
58
+ "slow: marks tests as slow"
59
+ ]
60
+
61
+ [build-system]
62
+ requires = ["poetry-core>=2.0.0,<3.0.0"]
63
+ build-backend = "poetry.core.masonry.api"
64
+
65
+
66
+ [tool.poetry.scripts]
67
+ main = 'doip_server.main:main'
68
+ doip_server = 'doip_server.doip_server:start_doip_server'
69
+ doip_client = 'doip_client.doip_client:start_doip_client'
70
+ validate_config = 'doip_server.validate_config:main'
71
+ debug_client = 'doip_client.debug_client:main'
doip_server-0.1.0/src/doip_server/__init__.py ADDED
File without changes