Add tests for RandomBeaconHistory contract
#389
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,106 @@ | ||
| { | ||
| "contracts": { | ||
| "FlowClusterQC": { | ||
| "source": "./contracts/epochs/FlowClusterQC.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| }, | ||
| "FlowContractAudits": { | ||
| "source": "./contracts/FlowContractAudits.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| }, | ||
| "FlowDKG": { | ||
| "source": "./contracts/epochs/FlowEpoch.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| }, | ||
| "FlowEpoch": { | ||
| "source": "./contracts/epochs/FlowEpoch.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| }, | ||
| "FlowFees": { | ||
| "source": "./contracts/FlowFees.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| }, | ||
| "FlowIDTableStaking": { | ||
| "source": "./contracts/FlowIDTableStaking.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| }, | ||
| "FlowIDTableStaking_old": { | ||
| "source": "./contracts/FlowIDTableStaking_old.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| }, | ||
| "FlowServiceAccount": { | ||
| "source": "./contracts/FlowServiceAccount.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| }, | ||
| "FlowStakingCollection": { | ||
| "source": "./contracts/FlowStakingCollection.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| }, | ||
| "FlowStorageFees": { | ||
| "source": "./contracts/FlowStorageFees.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| }, | ||
| "FlowToken": { | ||
| "source": "./contracts/FlowToken.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| }, | ||
| "LockedTokens": { | ||
| "source": "./contracts/LockedTokens.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| }, | ||
| "NodeVersionBeacon": { | ||
| "source": "./contracts/NodeVersionBeacon.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| }, | ||
| "RandomBeaconHistory": { | ||
| "source": "./contracts/RandomBeaconHistory.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| }, | ||
| "StakingProxy": { | ||
| "source": "./contracts/StakingProxy.cdc", | ||
| "aliases": { | ||
| "testing": "0x0000000000000007" | ||
| } | ||
| } | ||
| }, | ||
| "networks": { | ||
| "emulator": "127.0.0.1:3569", | ||
| "testing": "127.0.0.1:3569", | ||
| "mainnet": "access.mainnet.nodes.onflow.org:9000", | ||
| "testnet": "access.devnet.nodes.onflow.org:9000" | ||
| }, | ||
| "accounts": { | ||
| "emulator-account": { | ||
| "address": "f8d6e0586b0a20c7", | ||
| "key": "7677f7c9410f8773b482737c778b5d7c6acfdbbae718d61e4727a07667f66004" | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| import "RandomBeaconHistory" | ||
|
|
||
| access(all) fun main(): UInt64 { | ||
| return RandomBeaconHistory.getLowestHeight() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| import Test | ||
| import BlockchainHelpers | ||
| import "RandomBeaconHistory" | ||
|
|
||
| access(all) let admin = Test.getAccount(0x0000000000000007) | ||
|
|
||
| access(all) | ||
| fun setup() { | ||
| let err = Test.deployContract( | ||
| name: "RandomBeaconHistory", | ||
| path: "../contracts/RandomBeaconHistory.cdc", | ||
| arguments: [] | ||
| ) | ||
| Test.expect(err, Test.beNil()) | ||
| } | ||
|
|
||
| access(all) | ||
| fun testGetLowestHeightWhenNotInitialized() { | ||
| let scriptResult = executeScript( | ||
| "scripts/get_lowest_height.cdc", | ||
| [] | ||
| ) | ||
| Test.expect(scriptResult, Test.beFailed()) | ||
| Test.assertError( | ||
| scriptResult, | ||
| errorMessage: "History has not yet been initialized" | ||
| ) | ||
| } | ||
|
|
||
| access(all) | ||
| fun testGetRandomSourceHistoryPageWithoutLowestHeightSet() { | ||
| let page: UInt64 = 1 | ||
| let perPage: UInt64 = 10 | ||
| let scriptResult = executeScript( | ||
| "../transactions/randomBeaconHistory/scripts/get_source_of_randomness_page.cdc", | ||
| [page, perPage] | ||
| ) | ||
| Test.expect(scriptResult, Test.beFailed()) | ||
| Test.assertError( | ||
| scriptResult, | ||
| errorMessage: "History has not yet been initialized", | ||
| ) | ||
| } | ||
|
|
||
| access(all) | ||
| fun testGetSourceOfRandomnessWithoutLowestHeightSet() { | ||
| let atBlockHeight: UInt64 = 101 | ||
| let scriptResult = executeScript( | ||
| "../transactions/randomBeaconHistory/scripts/get_source_of_randomness.cdc", | ||
| [atBlockHeight] | ||
| ) | ||
| Test.expect(scriptResult, Test.beFailed()) | ||
| Test.assertError( | ||
| scriptResult, | ||
| errorMessage: "History has not yet been initialized" | ||
| ) | ||
| } | ||
|
|
||
| access(all) | ||
| fun testRecordRandomSource() { | ||
| let randomSource: [UInt8] = [0, 1, 1, 2, 3, 5, 8] | ||
| let txResult = executeTransaction( | ||
| "transactions/record_random_source.cdc", | ||
| [randomSource], | ||
| admin | ||
| ) | ||
| Test.expect(txResult, Test.beSucceeded()) | ||
|
|
||
| let page: UInt64 = 0 | ||
| let perPage: UInt64 = 10 | ||
| let scriptResult = executeScript( | ||
| "../transactions/randomBeaconHistory/scripts/get_source_of_randomness_page.cdc", | ||
| [page, perPage] | ||
| ) | ||
| Test.expect(scriptResult, Test.beSucceeded()) | ||
|
|
||
| let history = (scriptResult.returnValue as! RandomBeaconHistory.RandomSourceHistoryPage?)! | ||
| Test.assertEqual(randomSource, history.values[0]!.value) | ||
| } | ||
|
|
||
| access(all) | ||
| fun testGetSourceOfRandomnessForMissingBlockHeight() { | ||
| let atBlockHeight: UInt64 = 101 | ||
| let scriptResult = executeScript( | ||
| "../transactions/randomBeaconHistory/scripts/get_source_of_randomness.cdc", | ||
| [atBlockHeight] | ||
| ) | ||
| Test.expect(scriptResult, Test.beFailed()) | ||
| Test.assertError( | ||
| scriptResult, | ||
| errorMessage: "Source of randomness not yet recorded" | ||
| ) | ||
| } | ||
|
|
||
| access(all) | ||
| fun testGetSourceOfRandomnessPrecedingRecordedHistory() { | ||
| let lowestHeight = (executeScript( | ||
| "scripts/get_lowest_height.cdc", | ||
| [] | ||
| ).returnValue as! UInt64?)! | ||
| let atBlockHeight: UInt64 = lowestHeight - 2 | ||
|
|
||
| let scriptResult = executeScript( | ||
| "../transactions/randomBeaconHistory/scripts/get_source_of_randomness.cdc", | ||
| [atBlockHeight] | ||
| ) | ||
| Test.expect(scriptResult, Test.beFailed()) | ||
| Test.assertError( | ||
| scriptResult, | ||
| errorMessage: "Requested block height precedes recorded history" | ||
| ) | ||
| } | ||
|
|
||
| access(all) | ||
| fun testGetSourceOfRandomnessFromPreviousBlockHeight() { | ||
| // Commit current block and advance to the next one | ||
| Test.commitBlock() | ||
|
|
||
| let atBlockHeight: UInt64 = getCurrentBlockHeight() - 1 | ||
| let scriptResult = executeScript( | ||
| "../transactions/randomBeaconHistory/scripts/get_source_of_randomness.cdc", | ||
| [atBlockHeight] | ||
| ) | ||
| Test.expect(scriptResult, Test.beSucceeded()) | ||
|
|
||
| let randomSource = scriptResult.returnValue! as! RandomBeaconHistory.RandomSource | ||
| let value: [UInt8] = [0, 1, 1, 2, 3, 5, 8] | ||
| Test.assertEqual(atBlockHeight, randomSource.blockHeight) | ||
| Test.assertEqual(value, randomSource.value) | ||
| } | ||
|
|
||
| access(all) | ||
| fun testGetLatestSourceOfRandomness() { | ||
| let scriptResult = executeScript( | ||
| "../transactions/randomBeaconHistory/scripts/get_latest_source_of_randomness.cdc", | ||
| [] | ||
| ) | ||
| Test.expect(scriptResult, Test.beSucceeded()) | ||
|
|
||
| let randomSource = scriptResult.returnValue! as! RandomBeaconHistory.RandomSource | ||
| let atBlockHeight: UInt64 = getCurrentBlockHeight() - 1 | ||
| let value: [UInt8] = [0, 1, 1, 2, 3, 5, 8] | ||
| Test.assertEqual(atBlockHeight, randomSource.blockHeight) | ||
| Test.assertEqual(value, randomSource.value) | ||
| } | ||
|
|
||
| access(all) | ||
| fun testGetRandomSourceHistoryPageExceedingLastPage() { | ||
| // There is only 1 page currently | ||
| let page: UInt64 = 11 | ||
| let perPage: UInt64 = 10 | ||
| let scriptResult = executeScript( | ||
| "../transactions/randomBeaconHistory/scripts/get_source_of_randomness_page.cdc", | ||
| [page, perPage] | ||
| ) | ||
| Test.expect(scriptResult, Test.beSucceeded()) | ||
|
|
||
| let history = (scriptResult.returnValue as! RandomBeaconHistory.RandomSourceHistoryPage?)! | ||
| Test.expect(history.values, Test.beEmpty()) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import "RandomBeaconHistory" | ||
|
|
||
| transaction(randomSource: [UInt8]) { | ||
| prepare(acct: AuthAccount) { | ||
| let heartbeat = acct.borrow<&RandomBeaconHistory.Heartbeat>( | ||
| from: RandomBeaconHistory.HeartbeatStoragePath | ||
| ) ?? panic("Could not borrow heartbeat resource") | ||
|
|
||
| heartbeat.heartbeat(randomSourceHistory: randomSource) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,5 +3,5 @@ import "RandomBeaconHistory" | |
| /// Retrieves the source of randomness for the requested block height from the RandomBeaconHistory contract. | ||
| /// | ||
| access(all) fun main(page: UInt64, perPage: UInt64): RandomBeaconHistory.RandomSourceHistoryPage { | ||
| return RandomBeaconHistory.getRandomSourceHistoryPage(page, perPage: perPage) | ||
|
There was a problem hiding this comment. cc @janezpodhostnik There was an error while testing this script, not how much important it is though. There was a problem hiding this comment. Its not that important, as it is mostly as an example, but we should fix this. I'll open up a PR. Thank you for finding this. There was a problem hiding this comment. It is fixed in this PR, so not sure there's a need to open up another PR. |
||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do they all have the same testing alias?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
testingalias is basically the account where the current contract will be deployed for usage in the Cadence testing framework. For the sake of completion & consistency, I had added it to all contracts in theflow.jsonconfig file. It does not need to be the same though. There are 10 predefined accounts that can be used as the testing alias.