Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add restricted module check #420

Merged
merged 3 commits into from
Nov 6, 2024
Merged

chore: add restricted module check #420

merged 3 commits into from
Nov 6, 2024

Conversation

boojamya
Copy link
Member

@boojamya boojamya commented Nov 1, 2024

This CI test ensures that certain Go modules are not included in Noble.

@boojamya boojamya requested a review from a team as a code owner November 1, 2024 19:49
Copy link

coderabbitai bot commented Nov 1, 2024

Walkthrough

The pull request introduces two main changes in the testing files. First, in e2e/conformance_test.go, the TestConformance function has been modified to remove a conditional check that previously allowed the test to be skipped in short mode, ensuring it runs regardless of the testing configuration. Second, a new test function, TestRestrictedModules, has been added to e2e/module_check_test.go, which checks that specific modules are restricted from access in the Noble blockchain context.

Changes

File Change Summary
e2e/conformance_test.go Removed conditional statement in TestConformance to prevent skipping the test in short mode.
e2e/module_check_test.go Added TestRestrictedModules to verify restricted module access in the Noble blockchain context.

Possibly related PRs

  • feat: ibc conformance test #416: The changes in this PR involve modifications to the TestConformance function in the same e2e/conformance_test.go file, which is directly related to the main PR's alterations to the same function.

Suggested reviewers

  • johnletey

Poem

In the land of tests, where bunnies hop,
The conformance runs, it won't stop!
Restricted modules, we check with glee,
Ensuring access is just for thee.
With every run, our hopes take flight,
Hooray for changes, all feels right! 🐇✨


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
🪧 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 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
e2e/module_check_test.go (1)

12-19: Consider adding test documentation

Please add a comment block explaining:

  • Why these specific modules are restricted
  • The security implications of these restrictions
  • The relationship to Noble's architecture
+// TestRestrictedModules verifies that specific modules are restricted from access
+// in the Noble blockchain context. These modules are restricted because:
+// - circuit: [explain why]
+// - gov: [explain why]
+// - group: [explain why]
 func TestRestrictedModules(t *testing.T) {
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9946d6b and 203aa4e.

📒 Files selected for processing (2)
  • e2e/conformance_test.go (0 hunks)
  • e2e/module_check_test.go (1 hunks)
💤 Files with no reviewable changes (1)
  • e2e/conformance_test.go
🔇 Additional comments (2)
e2e/module_check_test.go (2)

1-10: LGTM: Clean and minimal imports

The package declaration and imports are well-organized, containing only the necessary dependencies for the test implementation.


20-24: 🛠️ Refactor suggestion

Improve test robustness and error reporting

Consider these improvements:

  1. Use t.Run for each module to report failures independently
  2. Enhance error messages with more context
  3. Verify the complete list of restricted modules
-	restrictedModules := []string{"circuit", "gov", "group"}
-
-	for _, module := range restrictedModules {
-		require.False(t, noble.HasCommand(ctx, "query", module), fmt.Sprintf("%s is a restricted module", module))
-	}
+	restrictedModules := []string{"circuit", "gov", "group"}
+
+	for _, module := range restrictedModules {
+		t.Run(fmt.Sprintf("module_%s", module), func(t *testing.T) {
+			hasCommand := noble.HasCommand(ctx, "query", module)
+			require.False(t, hasCommand,
+				fmt.Sprintf("Module '%s' should be restricted but is accessible via 'query' command", module))
+		})
+	}

e2e/module_check_test.go Show resolved Hide resolved
Copy link
Member

@johnletey johnletey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very clean solution for checking this @boojamya, LGTM!

  • ✅ Green CI for TestRestrictedModules (link)

@johnletey johnletey merged commit a805343 into main Nov 6, 2024
36 checks passed
@johnletey johnletey deleted the dan/restricted-mods branch November 6, 2024 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants