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

Migrate tests for example contracts #347

Merged
merged 44 commits into from
Oct 18, 2023
Merged

Migrate tests for example contracts #347

merged 44 commits into from
Oct 18, 2023

Conversation

Bargsteen
Copy link
Contributor

@Bargsteen Bargsteen commented Oct 6, 2023 •
edited

Purpose

Migrate the tests of most of our example contracts from the old testing infrastructure to the new integration testing library.
Closes #337 and #338.

Changes

  • Migrate tests and remove use of abstractions on example contracts
    • account-signature-checks (none)
    • auction
    • cis2-multi
    • cis2-multi-royalties
    • cis2-nft
    • cis2-wccd
    • cis3-nft-sponsored-txs
    • counter-notify
    • credential-registry
      • Migrate the tests that use entrypoints (will keep the quickcheck tests that use the state methods directly)
    • eSealing
    • fib
    • icecream
    • memo (none)
    • nametoken
    • offchain-transfers (won't do, needs larger contract changes)
      • In particular, we need to add some more view entrypoints to be able to test it completely. In the interest of time, we'll skip that for now.
    • piggybank
    • proxy
    • recorder
    • signature-verifier
    • smart-contract-upgrade
    • transfer-policy-check
    • two-step-transfer (won't do, uses quickcheck)
    • voting
  • Derive some PartialEq / Eq for some cis2 types
  • Add type aliases the Extern* types, e.g. type StateApi = ExternStateApi
  • Include events from interrupts in ContractInvokeSuccess::events
  • Update rust-sdk dependency with a fix to policy serialization (bug found when migrating transfer-policy-check
  • Use cargo concordium test --out ./concordium-out/module.wasm.v1in the CI instead ofcargo test`
  • Update templates
    • default
    • cis2-nft
    • credential-registry
  • Update documentation and deprecate old testing infrastructure: Deprecate test_infrastructure and supporting traits #349

Checklist

  • My code follows the style of this project.
  • The code compiles without warnings.
  • I have performed a self-review of the changes.
  • I have documented my code, in particular the intent of the
    hard-to-understand areas.
  • (If necessary) I have updated the CHANGELOG.

@Bargsteen
Add type aliases that removes the Extern prefix
7a081ea 
Also sets a default type for the StateBuilder to be (Extern)`StateApi`
so that users don't have to specify a parameter unless they also use the testing-infrastructure.
@Bargsteen
Migrate tests and remove generics in init/receive methods
d26aaba 
- Migrates the tests from the deprecated testing infrastructure to
  `concordium-smart-contract-testing`.
- Remove the abstractions/generics in the init and receive methods that
  were only needed to support the old testing infrastructure
- Make a few minor changes to the examples to enable testing, for
  example adding a contract to be called in the counter-notify example.
@Bargsteen
Also include events produced in interrupts
d0f7cb8
@Bargsteen
Derive PartialEq/Eq
e87b1d5
@Bargsteen
Update dependency with policy serialization fix
505f6bf
@Bargsteen
Merge branch 'main' into kb/migrate-tests
fac9486
@Bargsteen Bargsteen marked this pull request as draft October 6, 2023 14:27
@Bargsteen Bargsteen changed the title Kb/migrate tests Migrate tests for example contracts Oct 10, 2023
@Bargsteen
Remove some of the crypto-primitive checks in the CI
03fba11 
The contracts no longer have the crypto-primitives feature as it is not needed.
@Bargsteen Bargsteen marked this pull request as ready for review October 10, 2023 08:10
DOBEN
DOBEN approved these changes Oct 10, 2023
View reviewed changes
Copy link
Member

@DOBEN DOBEN left a comment

Choose a reason for hiding this comment

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

Very good to see how much this improves the contract's readability once we remove these generics (not needed anymore because the old unit testing will be deprecated soon). Nice work.

concordium-std/src/types.rs Outdated Show resolved Hide resolved
.github/workflows/linter.yml Show resolved Hide resolved
examples/auction/tests/tests.rs Outdated Show resolved Hide resolved
examples/cis2-multi-royalties/tests/tests.rs Outdated Show resolved Hide resolved
examples/cis2-multi-royalties/tests/tests.rs Outdated Show resolved Hide resolved
examples/cis3-nft-sponsored-txs/tests/tests.rs Outdated Show resolved Hide resolved
examples/nametoken/tests/tests.rs Outdated Show resolved Hide resolved
examples/nametoken/tests/tests.rs Show resolved Hide resolved
examples/smart-contract-upgrade/contract-version1/tests/tests.rs Show resolved Hide resolved
examples/transfer-policy-check/tests/tests.rs Outdated Show resolved Hide resolved
@Bargsteen @DOBEN
Apply suggestions from code review
a03ecd0 
Co-authored-by: Doris Benda <DOBEN@users.noreply.github.com>
limemloh
limemloh approved these changes Oct 12, 2023
View reviewed changes
concordium-cis2/src/lib.rs Show resolved Hide resolved
@Bargsteen Bargsteen mentioned this pull request Oct 13, 2023
Merged
5 tasks
Bargsteen and others added 16 commits October 17, 2023 14:43
@Bargsteen
Migrate applicable tests
d902b66
@Bargsteen
Update template
218fb31
@Bargsteen
Merge branch 'main' into kb/migrate-tests
62b38d6
@Bargsteen
Fix formatting
2121c33
@Bargsteen
Include integration tests
2d8cc97
@Bargsteen
Run diff on tests
993d3ee
@Bargsteen
Fix discrepancies and clippy warnings
21037e4
@Bargsteen
Address review comments
949a782
@Bargsteen
Fix more diffs
285bdd2
@Bargsteen
Move with sudo
71ba719
@Bargsteen
Readme diffs..
f7fd8ce
@Bargsteen
Merge branch 'kb/migrate-tests' into kb/migrate-docs
cfdda63
@Bargsteen
Deprecate test_infrastructure and supporting traits (#349)
226c8ab 
* Deprecate several traits in favour of the concrete alternatives

Also documents how to migrate your smart contract to use the concrete types.

* Deprecate `test_infrastructure` module and update changelog

* Add backlinks

* Clarify documentation

* Explain allow deprecated

* Address review comments
@Bargsteen
Fix references in docs
e916b1a
@Bargsteen
Merge branch 'kb/migrate-docs' into kb/migrate-tests
3d74d03
@abizjak
Bump versions and changelog for release.
f9e835b
@abizjak abizjak mentioned this pull request Oct 18, 2023
Open
@abizjak abizjak merged commit 91daebe into main Oct 18, 2023
131 checks passed
@abizjak abizjak deleted the kb/migrate-tests branch October 18, 2023 18:36
This was referenced Oct 19, 2023
Closed
Closed
Closed
Closed
abizjak added a commit that referenced this pull request Oct 27, 2023
@abizjak
Merge pull request #347 from Concordium/kb/migrate-tests
461d390 
Migrate tests for example contracts
@Bargsteen Bargsteen mentioned this pull request Apr 29, 2024
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abizjak abizjak abizjak approved these changes

@limemloh limemloh limemloh approved these changes

@DOBEN DOBEN DOBEN approved these changes

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

Successfully merging this pull request may close these issues.

Rewrite tests of all example contracts to use the testing library
4 participants
@Bargsteen @abizjak @limemloh @DOBEN