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

docs: ecocredit acceptance tests #550

Merged
merged 9 commits into from
Oct 21, 2021
Merged

docs: ecocredit acceptance tests #550

Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
86c819c
docs: ecocredit acceptance tests
ryanchristo Sep 21, 2021
94f4423
docs: ecocredit acceptance tests
ryanchristo Sep 21, 2021
b3780a5
docs: ecocredit acceptance tests
ryanchristo Sep 22, 2021
a3741bd
docs: ecocredit acceptance tests
ryanchristo Sep 23, 2021
9bdac32
docs: ecocredit acceptance tests
ryanchristo Sep 23, 2021
d8d9931
Merge branch 'master' into ryan/494-docs-ecocredit-at
ryanchristo Sep 23, 2021
6645ca2
Merge branch 'master' into ryan/494-docs-ecocredit-at
ryanchristo Oct 15, 2021
4a4e9a7
address review comments
ryanchristo Oct 19, 2021
6b691b9
Merge branch 'master' into ryan/494-docs-ecocredit-at
ryanchristo Oct 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
265 changes: 265 additions & 0 deletions x/ecocredit/spec/06_tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,265 @@
# Tests

This document includes acceptance tests for the ecocredit module.

### Create Credit Class

If a user tries to create a credit class and their address is on the list of approved credit class creators, then the transaction is successful and the credit class is created.

GIVEN - user is on list of approved credit class creators
ryanchristo marked this conversation as resolved.
Show resolved Hide resolved
WHEN - user tries to create a credit class
THEN - transaction is successful, credit class is created

If a user tries to create a credit class and their address is NOT on the list of approved credit class creators, then the transaction fails and the credit class is NOT created.

GIVEN - user is NOT on list of approved credit class creators
ryanchristo marked this conversation as resolved.
Show resolved Hide resolved
WHEN - user tries to create a credit class
THEN - transaction fails, credit class is NOT created

ryanchristo marked this conversation as resolved.
Show resolved Hide resolved
If a user tries to create a credit class and the user provides a valid credit type (credit type is included in the list of approved credit types), then the transaction is successful and the credit class is created.

GIVEN - user provides a valid credit type
WHEN - user tries to create a credit class
THEN - transaction is successful, credit class is created

If a user tries to create a credit class and the user provide an invalid credit type (credit type is NOT included in the list of approved credit types), then the transaction fails and the credit class is NOT created.

GIVEN - user provides an invalid credit type
WHEN - user tries to create a credit class
THEN - transaction fails, credit class is NOT created

If a user tries to create a credit class and the user provides metadata that is base64 encoded, then the transaction is successful and the credit class is created.

GIVEN - user provides metadata that is base64 encoded
WHEN - user tries to create a credit class
THEN - transaction is successful, credit class is created

If a user tries to create a credit class and the user provides metadata that is NOT base54 encoded, then the transaction fails and the credit class is NOT created.

GIVEN - user provides metadata that is NOT base54 encoded
WHEN - user tries to create a credit class
THEN - transaction fails, credit class is NOT created

If a user tries to create a credit class and the user provides metadata that is less than 256 bytes, then the transaction is successful and the credit class is created.
ryanchristo marked this conversation as resolved.
Show resolved Hide resolved

GIVEN - user provides metadata that is less than 256 bytes
WHEN - user tries to create a credit class
THEN - transaction is successful, credit class is created

If a user tries to create a credit class and the user provides metadata that is more than 256 bytes, then the transaction fails and the credit class is NOT created.

GIVEN - user provides metadata that is more than 256 bytes
WHEN - user tries to create a credit class
THEN - transaction fails, credit class is NOT created

If a user tries to create a credit class and the user provides a valid issuer address, then the transaction is successful and the credit class is created.

GIVEN - user provides a valid issuer address
WHEN - user tries to create a credit class
THEN - transaction successful, credit class is created

If a user tries to create a credit class and the user provides an invalid issuer address, then the transaction fails and the credit class is NOT created.

GIVEN - user provides an invalid issuer address
WHEN - user tries to create a credit class
THEN - transaction fails, credit class is NOT created

If a user tries to create a credit class and the user provides a valid credit type (credit type is included in the list of approved credit types), then the transaction is successful and the credit class is created.

GIVEN - user provides a valid credit type
WHEN - user tries to create a credit class
THEN - transaction is successful, credit class is created

If a user tries to create a credit class and the user provide an invalid credit type (credit type is NOT included in the list of approved credit types), then the transaction fails and the credit class is NOT created.

GIVEN - user provides an invalid credit type
WHEN - user tries to create a credit class
THEN - transaction fails, credit class is NOT created

If a user tries to create a credit class and the user account balance is equal to or more than the credit class fee, then the transaction is successful and the credit class is created.

GIVEN - user account balance is equal to or more than the credit class fee
WHEN - user tries to create a credit class
THEN - transaction is successful, credit class is created

If a user tries to create a credit class and the user account balance is less than the credit class fee, then the transaction fails and the credit class is NOT created.

GIVEN - user account balance is less than the credit class fee
WHEN - user tries to create a credit class
THEN - transaction fails, credit class is NOT created

### Create Credit Batch

If a user tries to create a credit batch and their account address is on the list of approved credit issuers, then the transaction is successful and the credit batch is created.

GIVEN - user is on list of approved credit issuers
ryanchristo marked this conversation as resolved.
Show resolved Hide resolved
WHEN - user tries to create a credit batch
THEN - transaction is successful, credit batch is created

If a user tries to create a credit batch and their account address is NOT on the list of approved credit issuers, then the transaction fails and the credit batch is NOT created.

GIVEN - user is NOT on list of approved credit issuers
ryanchristo marked this conversation as resolved.
Show resolved Hide resolved
WHEN - user tries to create a credit batch
THEN - transaction fails, credit batch is NOT created

If a user tries to create a credit batch and the user provides a valid recipient address, then the transaction is successful and the credit batch is created.

GIVEN - user provides a valid recipient address
WHEN - user tries to create a credit batch
THEN - transaction is successful, credit batch is created

If a user tries to create a credit batch and the user provides an invalid recipient address, then the transaction fails and the credit batch is NOT created.

GIVEN - user provides an invalid recipient address
WHEN - user tries to create a credit batch
THEN - transaction fails, credit batch is NOT created

If a user tries to create a credit batch and the user provides metadata that is less than 256 bytes, then the transaction is successful and the credit batch is created.
ryanchristo marked this conversation as resolved.
Show resolved Hide resolved

GIVEN - user provides metadata that is less than 256 bytes
WHEN - user tries to create a credit batch
THEN - transaction is successful, credit batch is created

If a user tries to create a credit batch and the user provides metadata that is more than 256 bytes, then the transaction fails and the credit batch is NOT created.

GIVEN - user provides metadata that is more than 256 bytes
WHEN - user tries to create a credit batch
THEN - transaction fails, credit batch is NOT created

If a user tries to create a credit batch and the user provides a valid project location, then the transaction is successful and the credit batch is created.

GIVEN - user provides a valid project location
WHEN - user tries to create a credit batch
THEN - transaction successful, credit batch is created

If a user tries to create a credit batch and the user provides an invalid project location, then the transaction fails and the credit batch is NOT created.

GIVEN - user provides an invalid project location
WHEN - user tries to create a credit batch
THEN - transaction fails, credit batch is NOT created

If a user tries to create a credit batch and the user provides a valid start and end date, then the transaction is successful and the credit batch is created.

GIVEN - user provides a valid start and end date
WHEN - user tries to create a credit batch
THEN - transaction is successful, credit batch is created

If a user tries to create a credit batch and the user provides an invalid start and end date, then the transaction fails and the credit batch is NOT created.

GIVEN - user provides an invalid start and end date
WHEN - user tries to create a credit batch
THEN - transaction fails, credit batch is NOT created

If a user tries to create a credit batch and the user includes retired credits with a retirement location, then the transaction is successful and the credit batch is created.

GIVEN - user includes retired credits with a retirement location
WHEN - user tries to create a credit batch
THEN - transaction is successful, credit batch is created

If a user tries to create a credit batch and the user includes retired credits without a retirement location, then the transaction fails and the credit batch is NOT created.

GIVEN - user includes retired credits without a retirement location
WHEN - user tries to create a credit batch
THEN - transaction fails, credit batch is NOT created

### Transfer Credits

If a user tries to transfer 20 credits and their tradable balance is more than or equal to 20 credits, then the transaction is successful and the credits are transferred.

GIVEN - tradable balance is more than or equal to 20 credits
WHEN - user tries to transfer 20 credits
THEN - transaction is successful, credits are transferred

If a user tries to transfer 20 credits and their tradable balance is less than 20 credits, then the transaction fails and the credits are NOT transferred.

GIVEN - tradable balance is less than 20 credits
WHEN - user tries to transfer 20 credits
THEN - transaction fails, credits are NOT transferred

If a user tries to transfer credits and the user provides a valid recipient address, then the transaction is successful and the credits are transferred.

GIVEN - user provides a valid recipient address
WHEN - user tries to transfer credits
THEN - transaction is successful, credits are transferred

If a user tries to transfer credits and the user provides an invalid recipient address, then the transaction fails and the credits are NOT transferred.

GIVEN - user provides an invalid recipient address
WHEN - user tries to transfer credits
THEN - transaction fails, credits are NOT transferred

If a user tries to transfer credits and the user provides a valid batch denomination, then the transaction is successful and the credits are transferred.

GIVEN - user provides a valid batch denomination
WHEN - user tries to transfer credits
THEN - transaction is successful, credits are transferred

If a user tries to transfer credits and the user provides an invalid batch denomination, then the transaction fails and the credits are NOT transferred.

GIVEN - user provides an invalid batch denomination
WHEN - user tries to transfer credits
THEN - transaction fails, credits are NOT transferred

If a user tries to retire 20 credits upon transfer and the user provides a retirement location, then the transaction is successful and the credits are transferred and retired.

GIVEN - user provides a retirement location
WHEN - user tries to retire 20 credits upon transfer
THEN - transaction is successful, credits are transferred and retired

If a user tries to retire 20 credits upon transfer and the user does NOT provide a retirement location, then the transaction fails and the credits are NOT transferred or retired.

GIVEN - user provides a retirement location
WHEN - user tries to retire 20 credits upon transfer
THEN - transaction fails, credits are NOT transferred or retired

### Retire Credits

If a user tries to retire 20 credits and their tradable balance is more than 20 credits, then the transaction is successful and the credits are retired.

GIVEN - tradable balance is more than 20 credits
WHEN - user tries to retire 20 credits
THEN - transaction is successful, credits are retired

If a user tries to retire 20 credits and their tradable balance is less than 20 credits, then the transaction fails and the credits are NOT retired.

GIVEN - tradable balance is less than 20 credits
WHEN - user tries to retire 20 credits
THEN - transaction fails, credits are NOT retired

If a user tries to retire credits and the user provides a valid batch denomination, then the transaction is successful and the credits are retired.

GIVEN - user provides a valid batch denomination
WHEN - user tries to retire credits
THEN - transaction is successful, credits are retired

If a user tries to retire credits and the user provides an invalid batch denomination, then the transaction fails and the credits are NOT retired.

GIVEN - user provides an invalid batch denomination
WHEN - user tries to retire credits
THEN - transaction fails, credits are NOT retired

### Cancel Credits

If a user tries to cancel 20 credits and their credit balance is more than or equal to 20 credits, then the transaction is successful and the credits are cancelled.

GIVEN - credit balance is more than 20 credits
WHEN - user tries to cancel 20 credits
THEN - transaction is successful, credits are cancelled

If a user tries to cancel 20 credits and their credit balance is less than 20 credits, then the transaction fails and the credits are NOT cancelled.

GIVEN - credit balance is less than 20 credits
WHEN - user tries to cancel 20 credits
THEN - transaction fails, credits are NOT cancelled

If a user tries to cancel credits and the user provides a valid batch denomination, then the transaction is successful and the credits are cancelled.

GIVEN - user provides a valid batch denomination
WHEN - user tries to cancel credits
THEN - transaction is successful, credits are cancelled

If a user tries to cancel credits and the user provides an invalid batch denomination, then the transaction fails and the credits are NOT cancelled.

GIVEN - user provides an invalid batch denomination
WHEN - user tries to cancel credits
THEN - transaction fails, credits are NOT cancelled