Create Tests for `pokeys_py` Component

[zarfld]

Issue: Create Tests for pokeys_py Component

Summary

This issue aims to develop a comprehensive test suite for the pokeys_py component. The tests should cover all functionalities provided by pokeys_py to ensure reliability, correctness, and performance. Implementing these tests will help maintain code quality and facilitate future development and debugging.

Task Details

1. Define Test Scope

• Functionalities to Cover:
  • Digital I/O
  • Reading digital inputs
  • Writing digital outputs
  • Handling inversion parameters
  • Analog I/O
  • Reading analog inputs
  • Writing analog outputs
  • Pulse Engine v2 (PEv2)
  • Motion control commands
  • Position feedback (pos-fb)
  • Velocity commands (vel-cmd)
  • Homing procedures
  • Counters
  • Incrementing and resetting counters
  • Reading counter values
  • PWM Outputs
  • Configuring PWM channels
  • Setting duty cycles and frequencies
  • Peripheral Devices
  • Interaction with PoNETkbd48CNC
  • Control of PoExtBusOC16 and PoRelay8
  • CAN bus communication (if applicable)

2. Unit Tests

• Objective: Test individual functions and methods within pokeys_py.
• Actions:
  • Write tests for each class and method.
  • Use mocking to simulate PoKeys device responses where hardware interaction is required.
  • Ensure edge cases and error conditions are tested.

3. Integration Tests

• Objective: Verify that pokeys_py interacts correctly with the PoKeys hardware and LinuxCNC.
• Actions:
  • Test the initialization and connection process with a PoKeys device.
  • Verify data exchange between pokeys_py and the device.
  • Ensure correct registration and communication with LinuxCNC's HAL.

4. Functional Tests

• Objective: Simulate real-world usage scenarios.
• Actions:
  • Perform sequences of operations that a typical user might execute.
  • Test motion control sequences, including starting, stopping, and emergency stops.
  • Verify homing procedures using the custom homing component interface.

5. Performance Tests

• Objective: Ensure that pokeys_py meets performance requirements for real-time operations.
• Actions:
  • Measure latency in command execution and response times.
  • Stress test the system with high-frequency I/O operations.
  • Evaluate the component's behavior under heavy load conditions.

6. Automated Testing Framework

• Objective: Integrate tests into an automated testing pipeline.
• Actions:
  • Use a testing framework like pytest for Python.
  • Set up continuous integration (CI) to run tests on every commit or pull request.
  • Generate coverage reports to identify untested code.

7. Documentation

• Objective: Document the testing procedures and how to run the tests.
• Actions:
  • Provide clear instructions in a README.md file within the pokeys_py directory.
  • Include any necessary setup steps for hardware-dependent tests.
  • Document how to interpret test results and coverage reports.

Expected Outcome

• A robust test suite covering all aspects of pokeys_py.
• Automated tests integrated into the development workflow.
• Improved reliability and easier maintenance of the pokeys_py component.

Reference Files and Directories

• pokeys_py/ (Python component directory)
• tests/ (New directory to contain test scripts)
• Existing documentation and code within pokeys_py.

Notes

• Hardware Dependency:

  • Where possible, design tests that do not require physical hardware by using mocking.
  • For tests that require hardware, clearly document the setup and prerequisites.

• Error Reporting:

  • Any bugs or issues discovered during testing should be logged as separate issues.

• Collaboration:

  • Coordinate with team members familiar with pokeys_py for insights on complex functionalities.

• Timeline:

  • Aim to have the initial test suite completed within [insert timeframe], with ongoing additions as new features are implemented.

[zarfld]

Reading state information... E: Unable to locate package libxenomai-dev E: Unable to locate package python-gtk2 Error: Process completed with exit code 100.

[zarfld]

Fetched 13.6 MB in 2s (8353 kB/s) Reading package lists... Installing dependencies... Reading package lists... Building dependency tree... Reading state information... Package libreadline-gplv2-dev is not available, but is referred to by another package. This may mean that the package is missing, has been obsoleted, or is only available from another source

Package python-dev is not available, but is referred to by another package. This may mean that the package is missing, has been obsoleted, or is only available from another source However the following packages replace it: python2-dev python2 python-dev-is-python3

E: Unable to locate package python3-gtk2 E: Unable to locate package libxenomai-dev E: Package 'libreadline-gplv2-dev' has no installation candidate E: Unable to locate package python-lxml E: Package 'python-dev' has no installation candidate E: Unable to locate package python-gtk2 Error: Process completed with exit code 100.