Add TCK compatibility test results in README #28
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds Eclipse™ Sparkplug™ TCK (Test Compatibility Kit) compatibility test results to the README and implements supporting functionality to enable TCK testing. The changes include adding scan rate command support, introducing a profile-based configuration system, and enhancing the host application's subscription management.
Key Changes:
- Added TCK compatibility test results table to README showing 5 passed tests and 1 unsupported feature
- Implemented scan rate command functionality for both Edge Nodes and Devices
- Introduced profile-based configuration system (IProfile interface with TCK and MIMIC implementations) to support different deployment scenarios
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Added TCK compatibility test results section with test status table |
| SparkplugHostApplication.cs | Enhanced logging with MQTT client ID, improved subscription management to support wildcard topics |
| SparkplugHostApplicationExtensions.cs | Added PublishEdgeNodeScanRateCommandAsync and PublishDeviceScanRateCommandAsync methods with validation |
| SparkplugClientOptions.cs | Added AlwaysSubscribeToWildcardTopic property to support TCK test requirements |
| Program.cs | Refactored to use profile-based configuration with command-line argument support |
| SimpleHostApplication.cs | Extended SendCommandAsync to support both Rebirth and ScanRate command types |
| IProfile.cs | New interface defining contract for configuration profiles |
| TckApplicationProfile.cs | New profile for TCK testing with localhost broker configuration |
| MimicApplicationProfile.cs | New profile for MIMIC simulator with HiveMQ broker configuration |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+64
to
+89
| if (scanRate <= 0) | ||
| throw new ArgumentOutOfRangeException(nameof(scanRate), scanRate, "Scan rate must be greater than zero."); | ||
|
|
||
| var payload = CreateScanRatePayload(true, scanRate); | ||
| return hostApplication.PublishEdgeNodeCommandMessageAsync(groupId, edgeNodeId, payload); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Sends a Scan Rate command to a specific Device | ||
| /// </summary> | ||
| /// <param name="hostApplication">The Sparkplug Host Application instance</param> | ||
| /// <param name="groupId">The Sparkplug Group ID</param> | ||
| /// <param name="edgeNodeId">The Sparkplug Edge Node ID</param> | ||
| /// <param name="deviceId">The Sparkplug Device ID</param> | ||
| /// <param name="scanRate">The scan rate value in milliseconds</param> | ||
| /// <returns>The MQTT Client Publish Result</returns> | ||
| public static Task<MqttClientPublishResult> PublishDeviceScanRateCommandAsync( | ||
| this SparkplugHostApplication hostApplication, string groupId, string edgeNodeId, string deviceId, | ||
| long scanRate) | ||
| { | ||
| ArgumentNullException.ThrowIfNull(hostApplication); | ||
| SparkplugNamespace.ValidateNamespaceElement(groupId, nameof(groupId)); | ||
| SparkplugNamespace.ValidateNamespaceElement(edgeNodeId, nameof(edgeNodeId)); | ||
| SparkplugNamespace.ValidateNamespaceElement(deviceId, nameof(deviceId)); | ||
| if (scanRate <= 0) | ||
| throw new ArgumentOutOfRangeException(nameof(scanRate), scanRate, "Scan rate must be greater than zero."); |
There was a problem hiding this comment.
[nitpick] The scan rate validation logic if (scanRate <= 0) throw new ArgumentOutOfRangeException(...) is duplicated in both PublishEdgeNodeScanRateCommandAsync (lines 64-65) and PublishDeviceScanRateCommandAsync (lines 88-89). Consider extracting this validation into a private helper method to reduce code duplication and ensure consistency.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated README to add TCK compatibility test results in table format.