Collect simulators into a single test import file

[hyanwong]

Summary by CodeRabbit

• Refactor
  • Improved the organization and efficiency of genetic algorithm simulations by centralizing simulator functions.
  • Updated test cases to align with the new simulation module structure.

[coderabbitai]

Walkthrough

The recent update introduces a new sim.py module to centralize simulator functionalities for genetic algorithms, streamlining the structure and improving modularity. It also includes a refactoring of the test_gigutil.py file to utilize this new module, enhancing maintainability and readability of the test code by referencing simulators through the sim module instead of direct imports from gigutil.

Changes

Files	Change Summary
tests/sim.py	Added new module for collecting genetic algorithm simulators.
tests/test_gigutil.py	Refactored to use sim module; updated references to simulator entities.

🐇✨
In the land of code and byte,
A rabbit hopped with great delight.
It found a module, shiny and new,
Where algorithms dance and simulators stew.
"To organize, to test, to streamline!" it cheered,
"With every commit, our goal's neared."
🌟📚🚀

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

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>.
  • Generate unit-tests for this file.
• 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 tests 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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between ee4c92b and 61d18be.

Files selected for processing (2)

• tests/sim.py (1 hunks)
• tests/test_gigutil.py (7 hunks)

Files skipped from review due to trivial changes (1)

• tests/sim.py

Additional comments: 3

tests/test_gigutil.py (3)

• 6-6: The import statement for the sim module is correctly added. This change aligns with the PR's objective to centralize simulator functionalities, enhancing maintainability and clarity.
• 98-98: The class DTWF_one_break_no_rec_inversions_test now inherits from sim.DTWF_one_break_no_rec_inversions_slow instead of directly from a class within gigutil. This modification is consistent with the PR's goal of using the sim module as a central point for importing simulator functionalities. Ensure that all functionalities and behaviors inherited from sim.DTWF_one_break_no_rec_inversions_slow are compatible and fully supported in the context of DTWF_one_break_no_rec_inversions_test.
• 128-128: The test functions within TestSimpleSims and TestDTWF_one_break_no_rec_inversions_slow classes have been updated to instantiate simulator objects using the sim module. This change is crucial for maintaining consistency with the PR's objective of centralizing simulator functionalities. It's important to verify that these updates do not introduce any regressions or unexpected behaviors in the test cases. Additionally, ensure that the sim module provides all necessary functionalities and configurations required by these tests.

Also applies to: 135-135, 145-145, 157-157, 168-168, 199-199