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.

Sign up for GitHub

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

Jump to bottom

Improve component tests with ComponentState #836

Merged
merged 7 commits into from
Dec 7, 2023
Merged

Improve component tests with ComponentState #836

merged 7 commits into from
Dec 7, 2023

Conversation

ericnordelo
Copy link
Member

Fixes #777

PR Checklist

  • Tests
  • Documentation
  • Added entry to CHANGELOG.md
  • Tried the feature on a public network

andrew-fleming
andrew-fleming reviewed Nov 30, 2023
View reviewed changes
Copy link
Collaborator

@andrew-fleming andrew-fleming left a comment

Choose a reason for hiding this comment

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

Nice work! I left a small comment and I'm also debating whether we should document the testing pattern in CONTRIBUTING. Maybe it's simple enough to follow without documenting it. What do you think?

src/tests/account/test_account.cairo Show resolved Hide resolved
src/tests/token/test_erc721.cairo Show resolved Hide resolved
martriay
martriay reviewed Dec 2, 2023
View reviewed changes
Copy link
Contributor

@martriay martriay left a comment

Choose a reason for hiding this comment

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

Looking good, much simpler! Thanks @ericnordelo and @enitrat

src/tests/access/test_accesscontrol.cairo Outdated Show resolved Hide resolved
src/tests/access/test_accesscontrol.cairo Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
src/tests/account/test_account.cairo Show resolved Hide resolved
@martriay martriay mentioned this pull request Dec 2, 2023
Merged
4 tasks
@enitrat
Copy link
Contributor

enitrat commented Dec 3, 2023

I'm also debating whether we should document the testing pattern in CONTRIBUTING. Maybe it's simple enough to follow without documenting it. What do you think?

If that can help I just wrote about it in the Cairo Book, you could simply link this. Let me know what you think

https://github.com/cairo-book/cairo-book/pull/458/files

@ericnordelo @martriay
Update CHANGELOG.md
08e57cd 
Co-authored-by: Martín Triay <martriay@gmail.com>
@ericnordelo
Copy link
Member Author

I'm also debating whether we should document the testing pattern in CONTRIBUTING. Maybe it's simple enough to follow without documenting it. What do you think?

IMO is simple enough

@martriay martriay merged commit 2ac2c3e into OpenZeppelin:main Dec 7, 2023
5 checks passed
@ericnordelo ericnordelo deleted the feat/testing-state-#777 branch December 7, 2023 11:29
martriay added a commit that referenced this pull request Dec 13, 2023
@martriay @andrew-fleming @ericnordelo
Update v0.8.0 docs (#854)
6f72a52 
* bump to 0.8.0 (#834)

* Update PULL_REQUEST_TEMPLATE.md (#827)

* Update PULL_REQUEST_TEMPLATE.md

* Update PULL_REQUEST_TEMPLATE.md

* Update PULL_REQUEST_TEMPLATE.md

* Update RELEASING and CONTRIBUTING (#828)

* update RELEASING

* fix linting

* update CONTRIBUTING

* fix emphasis

* add changelog to releasing.md

* improve live testing guidelines

* Update CONTRIBUTING.md

Co-authored-by: Andrew Fleming <fleming-andrew@protonmail.com>

---------

Co-authored-by: Andrew Fleming <fleming-andrew@protonmail.com>

* Add `ERC721ABI` and fix other abis (#761)

* fix account abi

* fix erc20 abi

* fix erc721 abi

* reorder internal fns

* reorder internal fns

* fix comment

* reorder fns

* fix casing

* fix casing

* reorder api fns

* add dual interfaces link

* add camel methods to api

* remove imports

* re-add src5_state

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <eric.nordelo39@gmail.com>

* add deployer trait/impl

* change non-standard to impls in fn list

* fix in-code doc style

* fix comments

* fix interface order

* remove unused impl

---------

Co-authored-by: Eric Nordelo <eric.nordelo39@gmail.com>

* Update utility docs  (#825)

* fix: link (#545)

* feat: add utility docs

* Update docs/modules/ROOT/pages/utilities.adoc

Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>

* Update docs/modules/ROOT/pages/utilities.adoc

Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>

* Update docs/modules/ROOT/pages/utilities.adoc

Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>

* feat: apply review updates

* Update docs/modules/ROOT/pages/utilities.adoc

Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>

* feat: apply review updates

* fix: remove drop events

* feat: update CHANGELOG

* feat: apply review udpates

---------

Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>

* Add in-code docs (#822)

* add in-code comment

* normalize in-code comments

* fix comment

* fix comments

* fix comments

* add double back ticks for comment possessives

* add missing reqs

* add missing reqs, fix _burn description

* fix __execute__ reqs

* remove double backticks

* remove unused imports

* fix: implementation name (#840)

* Improve component tests with ComponentState (#836)

* refactor: component state in tests

* feat: update CHANGELOG

* Update CHANGELOG.md

Co-authored-by: Martín Triay <martriay@gmail.com>

* feat: apply review updates

* fix: CHANGELOG

---------

Co-authored-by: Martín Triay <martriay@gmail.com>

* Document SRC5 migration (#821)

* start migration guide

* add links, add register_interfaces example

* add supports_interfaces

* add supports_interfaces to docs

* fix formatting

* revert change

* Apply suggestions from code review

Co-authored-by: Martín Triay <martriay@gmail.com>

* remove upgrade fn from code block

* remove supports_interfaces

* add deregister_erc165_interface

* change src5 migration title

* fix src5 migration doc

* fix how-to section

* fix formatting

* add deregister_erc165_interface

* update interface registration section

* add link to register_interface

* update CHANGELOG

* Apply suggestions from code review

Co-authored-by: Martín Triay <martriay@gmail.com>

* remove register_erc165_interface

* remove deregister_erc165_interface from utilities

* remove deregister from guide

* fix import

* remove register_interfaces fn from API

* remove unused var

* add initializable warning

---------

Co-authored-by: Martín Triay <martriay@gmail.com>

* Document Class Hashes (#832)

* fix: link (#545)

* feat: add page

* feat: finish UI

* Update docs/modules/ROOT/pages/api/erc721.adoc

Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>

* feat: apply review updates

* fix: remove trailing space

* feat: update CHANGELOG

* Update CHANGELOG.md

Co-authored-by: Martín Triay <martriay@gmail.com>

* feat: apply review updates

* feat: apply review updates

---------

Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>
Co-authored-by: Martín Triay <martriay@gmail.com>

* Update extensibility docs (#823)

* add extensibility docs

* start setup guide

* change file name

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <eric.nordelo39@gmail.com>

* fix name

* change title

* change title to component impl

* update changelog

* add comp storage section

* finish new structure

* finish edits, add customization section

* simplify titles

* finish custom impl section

* Apply suggestions from code review

Co-authored-by: Martín Triay <martriay@gmail.com>

* fix comp storage section

* change section title  to setup, minor edits

* add cmp storage link, clean up impl section

* add cairo book link

* add api design tip

* Apply suggestions from code review

---------

Co-authored-by: Eric Nordelo <eric.nordelo39@gmail.com>
Co-authored-by: Martín Triay <martriay@gmail.com>

* Update docs navbar (#838)

* update docs navbar

* complete navbar

* fix navbar

* fix navbar

* update changelog

* update changelog

* fix changelog

* update wizard and rename usage -> components

* fix broken links

* reordered changelog

* fix default collapsed sections

---------

Co-authored-by: Andrew Fleming <fleming-andrew@protonmail.com>
Co-authored-by: Eric Nordelo <eric.nordelo39@gmail.com>
Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@martriay martriay martriay approved these changes

@andrew-fleming andrew-fleming Awaiting requested review from andrew-fleming

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use TestingState from component in tests
4 participants
@ericnordelo @enitrat @martriay @andrew-fleming