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

feat(cmd): gno mod module name validations #3526

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

notJoon
Copy link
Member

@notJoon notJoon commented Jan 16, 2025

Description

Added module path validation to prevent invalid characters from being written to gno mod initialization.

The validation:

  1. Checks for non-ASCII characters
  2. Validates against specific invalid characters (``, ", , ?, *, :, <, >, |, [, ]`)
  3. Prevents spaces and control characters
  4. Ensures the module path is not empty

Implementation Details

  1. Added validateModulePath function with comprehensive validation rules
  2. Integrated validation into execModInit

Added Tests

  • TestValidateModulePath: Tests various validation scenarios including

    • Valid module paths (including gno.land paths)
    • Invalid UTF-8 characters
    • Spaces in paths
    • Special characters
    • Empty paths
    • Various invalid characters
  • TestExecModInit: Integration tests covering

    • Successful module initialization
    • Various invalid path scenarios
    • Error cases (existing gno.mod, too many arguments)

Relative Issue

closes #3493

@github-actions github-actions bot added the 📦 🤖 gnovm Issues or PRs gnovm related label Jan 16, 2025
@notJoon notJoon added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Jan 16, 2025
@Gno2D2
Copy link
Collaborator

Gno2D2 commented Jan 16, 2025

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🟢 Pending initial approval by a review team member (and label matches review triage state)

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 The pull request was created from a fork (head branch repo: notJoon/gno-core)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Pending initial approval by a review team member (and label matches review triage state)

If

🟢 Condition met
└── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🟢 Requirement satisfied
└── 🟢 If
    ├── 🟢 Condition
    │   └── 🟢 Or
    │       ├── 🟢 At least 1 user(s) of the organization approved the pull request
    │       └── 🔴 This pull request is a draft
    └── 🟢 Then
        └── 🟢 Not (🔴 This label is applied to pull request: review/triage-pending)

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission

Copy link

codecov bot commented Jan 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@Kouteki Kouteki requested a review from zivkovicmilos January 17, 2025 12:12
@jefft0
Copy link
Contributor

jefft0 commented Jan 22, 2025

@notJoon , can you resolve the CI check for "gno.land / Run gno.land suite / Go Test" ?

@notJoon
Copy link
Member Author

notJoon commented Jan 23, 2025

@jefft0 Thanks for notifying me. Now all issues have been resolved except for the review-triage stage.

Copy link
Contributor

@jefft0 jefft0 left a comment

Choose a reason for hiding this comment

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

This PR appears to correctly address and resolve issue #3493 . A test is included. All CI checks pass (except "Merge Requirements" which will be resolved later).

@jefft0 jefft0 removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Jan 23, 2025
@jefft0
Copy link
Contributor

jefft0 commented Jan 23, 2025

Removed the review/triage-pending label. Ready to be reviewed by core devs, possibly including @kristovatlas who created issue #3493 which this PR resolves.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📦 🤖 gnovm Issues or PRs gnovm related
Projects
Status: In Review
Development

Successfully merging this pull request may close these issues.

gno mod accepts invalid module names
3 participants