feat: Add ability to defer compilation

iliastsa commented 7 months ago

This PR adds the ability to defer compilation at a later stage, instead of doing it at the time of the CryticCompile object. This is useful when the client code wants to make use of some properties that are initialized before compilation is triggered.

Summary by CodeRabbit

New Features
- Introduced a deferred compilation feature, enhancing flexibility in compilation management.
Refactor
- Refactored metadata testing into two distinct functions for improved testing clarity.

coderabbitai[bot] commented 7 months ago

Walkthrough

The recent update introduces a significant enhancement to the CryticCompile class by adding a defer_compilation parameter, which offers the flexibility to defer the compilation process. A new method, compile, has been implemented to initiate compilation when required. Additionally, the testing suite has been refined by splitting a test function into two, focusing on standard and deferred compilation checks, streamlining the testing process for these new functionalities.

Changes

File	Change Summary
`crytic_compile/crytic_compile.py` `tests/test_metadata.py`	Added `defer_compilation` parameter and `compile` method to `CryticCompile` class for flexible compilation control. Refactored `test_metadata` into `metadata_checks` and `test_metadata_deferred` to accommodate and test new deferred compilation feature.

🐰✨
In the realm of code, under digital skies,
A change was made, wise and sly.
Compilation deferred, flexibility gained,
With tests refactored, no clarity drained.
A hop, a skip, in binary meadows,
Celebrating the code, with shadows in echos.
🌟📚

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: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.

CLAassistant commented 7 months ago

All committers have signed the CLA.

iliastsa commented 7 months ago

Hi @iliastsa, thanks for the PR! Could you elaborate a bit more on the use case you see for this feature? I'm not sure what kind of information may be useful on an "uncompiled" CryticCompile object.

The idea is to be able to use various inferred facts from Crytic (config file paths, inferred build system etc). In our use-case we'd like to modify configuration files right before compilation.

One way to emulate this without adding additional flags is to subclass the CryticCompile class and override the _compile method, something like:

class MyCryticCompile(CryticCompile):
     def _compile(self, **kwargs):
         # My logic here before compilation
         ...
        super()._compile(kwargs)
        # My logic here after compilation
        ...

but I think offering this capability with out having to create a new class is a bit cleaner.

0xalpharush commented 6 months ago

We just need to get the linters passing @iliastsa

crytic / crytic-compile