ENG-2268: integrate modbus-test into pipeline

[led0nk]

Description:

• using modbus_plugin tests for CI pipeline to test against wago-plc's
• checking on availability of wago-modbus-ports (main / fallback)
• update the checkout actions to v4

Summary by CodeRabbit

• New Features
  • Added new GitHub Actions workflow for Modbus PLC testing
• Chores
  • Updated GitHub Actions checkout action to v4 for multiple workflows (OPC UA, S7 PLC, Sensor Connect)

[coderabbitai]

Walkthrough

This pull request introduces a new GitHub Actions workflow for Modbus PLC testing and updates several existing workflows to use the latest actions/checkout action version. The new modbus-plc.yml workflow is specifically designed to test Modbus-related functionality, with a comprehensive setup that includes checking endpoint availability, installing necessary tools, and running tests conditionally based on the availability of Wago-Modbus devices.

Changes

File	Change Summary
.github/workflows/modbus-plc.yml	New workflow added for Modbus PLC testing with detailed environment setup and conditional testing
.github/workflows/opcua-plc.yml	Updated actions/checkout from v3 to v4
.github/workflows/s7-plc.yml	Updated actions/checkout from v3 to v4
.github/workflows/sensorconnect.yml	Updated actions/checkout from v3 to v4

Assessment against linked issues

Objective	Addressed	Explanation
Configure pipeline to use modbus-tests [ENG-2268]	✅
Add workflow running tests for modbus-plugin [ENG-2268]	✅
Add user-documentation on how to use modbus-tests with env-vars [ENG-2268]	❌	Documentation not included in this PR

Possibly related PRs

• ENG-2209: configure pipeline to use fallbacks #102: Involves Tcping installation and service availability checks similar to the new workflow
• ENG-2313: include testing modbus-plc-devices #111: Includes testing enhancements for WAGO PLCs

Suggested reviewers

• JeremyTheocharis
• kanapuli

Poem

🐰 Modbus workflows dance and spin,
Checking ports with a testing grin,
Actions updated, version four,
Pipelines singing from core to core!
Let the integration begin! 🚀

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

.github/workflows/modbus-plc.yml (1)

75-81: Consider adding Modbus-specific configuration.

The test step might need additional environment variables for Modbus configuration (e.g., port, unit ID, etc.) similar to how s7-plc.yml configures S7 rack and slot.

Consider adding Modbus configuration:

       - name: Test
+        env:
+          TEST_MODBUS_PORT: 502
+          TEST_MODBUS_UNIT_ID: 1
         run: |
           if [ -z "$TEST_WAGO_MODBUS_ENDPOINT" ]; then
             echo "no Wago device available for testing"
             exit 1
           fi
           make test

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between de8e5d4 and c37854a.

📒 Files selected for processing (4)

• .github/workflows/modbus-plc.yml (1 hunks)
• .github/workflows/opcua-plc.yml (1 hunks)
• .github/workflows/s7-plc.yml (1 hunks)
• .github/workflows/sensorconnect.yml (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• .github/workflows/opcua-plc.yml

🔇 Additional comments (4)

.github/workflows/sensorconnect.yml (1)

41-41: LGTM! Checkout action version update.

The update to actions/checkout@v4 is appropriate and consistent with the PR objectives.

.github/workflows/s7-plc.yml (1)

38-38: LGTM! Checkout action version update.

The update to actions/checkout@v4 is appropriate and consistent with the PR objectives.

.github/workflows/modbus-plc.yml (2)

15-35: LGTM! Well-structured workflow configuration.

The workflow is well-organized with proper concurrency settings, timeout, and runner group configuration.

---

52-52: Verify the availability of required secrets.

Ensure that the required secrets TEST_WAGO_MODBUS_ENDPOINT and TEST_WAGO_MODBUS_ENDPOINT_FALLBACK are configured in the repository settings.

Run the following script to verify the secret configuration:

Also applies to: 66-66