fix(shield): add unit tests for ASP preprocess

[Overseven]

closes #140

Summary by CodeRabbit

• Tests
  • Added unit tests for the AST preprocessor in the shield module.

[coderabbitai[bot]]

Walkthrough

## Walkthrough The recent changes introduce unit tests for the AST preprocessor in the `shield` module, specifically targeting the `Preprocess` function and its helper functions. These tests ensure the correctness of preprocessing logic for various expression types, including arrays, infix expressions, and call expressions. ## Changes | File(s) | Change Summary | |-----------------------------------------------------|--------------------------------------------------------------------------------------------------------| | `CHANGELOG.md` | Documented the addition of unit tests for the AST preprocessor in the shield module. | | `shield/internal/preprocess/preprocess_test.go` | Added multiple test functions to validate the `Preprocess` function and its helper functions. | | | Introduced `NoopExpander` type and its `Expand` method to assist in testing the preprocessing logic. | | | Added helper functions like `parseExpression` to facilitate expression parsing in tests. | ## Sequence Diagram(s) (Beta) ```mermaid sequenceDiagram participant Tester as Test Function participant Preprocessor as Preprocess Function participant Expander as NoopExpander Tester->>Preprocessor: Call with expression Preprocessor->>Expander: Expand identifiers Expander-->>Preprocessor: Return expanded expression Preprocessor-->>Tester: Return preprocessed expression ``` ## Assessment against linked issues | Objective (Issue #) | Addressed | Explanation | |---------------------------------------------------------------|-----------|-------------------------------------------------------------------------------------------------------------| | Add unit tests for `Preprocess` function (140) | ✅ | | | Ensure tests cover various scenarios for `Preprocess` (140) | ✅ | |

---

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@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. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[Pitasi]

thanks, one last nit: could you squash the two commits into a single one to keep git history clean?

[Overseven]

thanks, one last nit: could you squash the two commits into a single one to keep git history clean?

How exactly should I do this? "Squash and merge" PR option is disabled for this repo. Should I create a new PR?

[Pitasi]

thanks, one last nit: could you squash the two commits into a single one to keep git history clean?

How exactly should I do this? "Squash and merge" PR option is disabled for this repo. Should I create a new PR?

No problem! In this case, what I would do (locally) is this:

• move to your branch

  git switch feature/ast-preprocess-unit-tests

• rebase interactively to main:

  git rebase -i main

• it will open a text editor with the following content:

  pick 3d85ea3a fix(shield): add unit tests for ASP preprocess
  pick 02f26da9 fix(shield): add NoopExpander

• edit the second line like this:

  pick 3d85ea3a fix(shield): add unit tests for ASP preprocess
  f 02f26da9 fix(shield): add NoopExpander

(f stands for fixup = merge that commit into the commit above)

• save and close the file
• you can check the result with git log if you want, you should see a single commit in your branch
• push the result (requires -f but I usually do --force-with-lease instead, which is a bit safer since it aborts if you're overriding someone else's commits!)

  git push --force-with-lease

we have some more guides here https://docs.wardenprotocol.org/developers/contributing/#clean-up-mistakes-by-rewriting-history that explains possible alternatives on how to achieve this :)

hope it helps

[Overseven]

@Pitasi Done!