Skip to content

feat(examples): yet another unit and file testing package p/jeronimoabi/expect #4299

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

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

Conversation

jeronimoalbi
Copy link
Member

@jeronimoalbi jeronimoalbi commented May 20, 2025

The package expect provides testing support for packages and realms.

The opinionated approach taken on this package for testing is to use function chaining and semantics.

Focus is not on speed as there are other packages that would run tests faster like the official uassert or urequire packages.

Values can be asserted using the Value() function, for example:

func TestFoo(t *testing.T) {
  got := 42
  expect.Value(t, got).ToEqual(42)
  expect.Value(t, got).Not().ToEqual(0)

  expect.Value(t, "foo").ToEqual("foo")
  expect.Value(t, 42).AsInt().Not().ToBeGreaterThan(50)
  expect.Value(t, "TRUE").AsBoolean().ToBeTruthy()
}

Functions can also be used to assert returned values, errors or panics.

Package supports four type of functions:

  • func()
  • func() any
  • func() error
  • func() (any, error)

Functions can be asserted using the Func() function, for example:

func TestFoo(t *testing.T) {
  expect.Func(t, func() {
    panic("Boom!")
  }).ToPanic().WithMessage("Boom!")

  wantErr := errors.New("Boom!")
  expect.Func(t, func() error {
    return wantErr
  }).ToFail().WithMessage("Boom!")

  expect.Func(t, func() error {
    return wantErr
  }).ToFail().WithError(wantErr)
}

@jeronimoalbi jeronimoalbi self-assigned this May 20, 2025
@github-actions github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label May 20, 2025
@Gno2D2 Gno2D2 requested a review from a team May 20, 2025 10:49
@Gno2D2
Copy link
Collaborator

Gno2D2 commented May 20, 2025

🛠 PR Checks Summary

🔴 Pending initial approval by a review team member, or review from tech-staff

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):

🔴 Pending initial approval by a review team member, or review from tech-staff

☑️ 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
Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🔴 Requirement not satisfied
└── 🔴 If
    ├── 🔴 Condition
    │   └── 🔴 Or
    │       ├── 🔴 At least 1 user(s) of the organization reviewed the pull request (with state "APPROVED")
    │       ├── 🔴 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🔴 Else
        └── 🔴 And
            ├── 🟢 This label is applied to pull request: review/triage-pending
            ├── 🔴 At least 1 user(s) of the team tech-staff reviewed pull request
            └── 🔴 On no pull request

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 May 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@jeronimoalbi jeronimoalbi marked this pull request as ready for review May 25, 2025 19:08
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label May 25, 2025
@jeronimoalbi jeronimoalbi marked this pull request as draft May 26, 2025 12:31
@Gno2D2 Gno2D2 removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label May 26, 2025
@jeronimoalbi jeronimoalbi marked this pull request as ready for review May 29, 2025 09:03
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label May 29, 2025
@Kouteki Kouteki moved this from Triage to In Review in 🧙‍♂️gno.land core team Jun 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧾 package/realm Tag used for new Realms or Packages. review/triage-pending PRs opened by external contributors that are waiting for the 1st review
Projects
Status: No status
Status: In Review
Development

Successfully merging this pull request may close these issues.

2 participants