forked from w3f/polkadot-wiki
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add jest testing with a couple samples for react components * run jest tests on CI * run test on pull request * rename action * fix naming * rename once more * step name * step name take 2 * add testing coverage for all used RPC paths in docs * debugging * fix bug when retrieving constants * all tests passing, still a couple warnings * handle one more default case * clean up * bump timeout Co-authored-by: Radha <[email protected]>
- Loading branch information
Showing
6 changed files
with
2,742 additions
and
1,453 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "presets": ["@babel/preset-env", "@babel/preset-react"] | ||
| } |
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,14 @@ | ||
| name: Jest Testing Coverage | ||
| on: | ||
| pull_request: | ||
| branches: | ||
| - master | ||
| jobs: | ||
| run-tests: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: Install modules | ||
| run: yarn | ||
| - name: Run jest tests | ||
| run: yarn polkadot:test |
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 |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| import React from "react"; | ||
| import { render, act, screen, waitFor } from "@testing-library/react"; | ||
| import "@testing-library/jest-dom"; | ||
| import RPC from "../components/RPC-Connection"; | ||
| import { ApiPromise, WsProvider } from "@polkadot/api"; | ||
|
|
||
| // Set max test duration before failing (2 min) | ||
| jest.setTimeout(120000); | ||
|
|
||
| test("Retrieves and applies a 'const' RPC value", async () => { | ||
| render(<RPC network="polkadot" path="consts.balances.existentialDeposit" defaultValue={0} />); | ||
| await waitFor(() => expect(screen.getByText("10000000000")).toBeInTheDocument(), { timeout: 2000 }); | ||
| }); | ||
|
|
||
| test("Retrieves and applies a 'query' RPC value", async () => { | ||
| render(<RPC network="polkadot" path="query.staking.minNominatorBond" defaultValue={0} filter="humanReadable"/>); | ||
| await waitFor(() => expect(screen.getByText("10 DOT")).toBeInTheDocument(), { timeout: 2000 }); | ||
| }); | ||
|
|
||
| test("RPC falls back to default", async () => { | ||
| render(<RPC network="polkadot" path="BAD.PATH" defaultValue={150} />); | ||
| await waitFor(() => expect(screen.getByText("150")).toBeInTheDocument(), { timeout: 2000 }); | ||
| }); | ||
|
|
||
| test("Human readable filter with integer value", async () => { | ||
| render(<RPC network="polkadot" path="BAD.PATH" defaultValue={50000000000} filter="humanReadable" />); | ||
| await waitFor(() => expect(screen.getByText("5 DOT")).toBeInTheDocument(), { timeout: 2000 }); | ||
| }); | ||
|
|
||
| test("Human readable filter with float value", async () => { | ||
| render(<RPC network="polkadot" path="BAD.PATH" defaultValue={202580000000} filter="humanReadable" />); | ||
| await waitFor(() => expect(screen.getByText("20.258 DOT")).toBeInTheDocument(), { timeout: 2000 }); | ||
| }); | ||
|
|
||
| // This test takes about a minute to execute synchronously | ||
| test("All leveraged RPC paths are valid", async () => { | ||
| const paths = [ | ||
| // Polkadot & Kusama | ||
| { networks: ["polkadot", "kusama"], path: "query.staking.validatorCount" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.staking.maxNominatorRewardedPerValidator" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.identity.basicDeposit" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.identity.subAccountDeposit" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.balances.existentialDeposit" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.identity.basicDeposit" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.crowdloan.minContribution" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.staking.maxNominations" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.democracy.voteLockingPeriod" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.identity.fieldDeposit" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.electionProviderMultiPhase.maxElectingVoters" }, | ||
| { networks: ["polkadot", "kusama"], path: "query.staking.maxNominatorsCount" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.proxy.proxyDepositBase" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.proxy.proxyDepositFactor" }, | ||
| { networks: ["polkadot", "kusama"], path: "query.staking.minNominatorBond" }, | ||
| { networks: ["polkadot", "kusama"], path: "query.staking.maxNominatorsCount" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.treasury.spendPeriod" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.treasury.proposalBondMinimum" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.treasury.proposalBondMaximum" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.tips.tipReportDepositBase" }, | ||
| { networks: ["polkadot", "kusama"], path: "consts.tips.tipFindersFee" }, | ||
| // Statemine & Statemint | ||
| { networks: ["statemine", "statemint"], path: "consts.assets.assetDeposit" }, | ||
| { networks: ["statemine", "statemint"], path: "consts.assets.metadataDepositBase" }, | ||
| ] | ||
|
|
||
| let attemptedConnections = 0; | ||
| let successfulResponses = 0; | ||
|
|
||
| for (let i = 0; i < paths.length; i++) { | ||
| const testObject = paths[i]; | ||
| for (let j = 0; j < testObject.networks.length; j++) { | ||
| attemptedConnections += 1; | ||
| let chainValue = undefined; | ||
| try { | ||
| const network = testObject.networks[j]; | ||
| const path = testObject.path; | ||
| let wsUrl = undefined; | ||
|
|
||
| switch (network) { | ||
| case "polkadot": | ||
| wsUrl = "wss://rpc.polkadot.io"; | ||
| break; | ||
| case "kusama": | ||
| wsUrl = "wss://kusama-rpc.polkadot.io/"; | ||
| break; | ||
| case "statemine": | ||
| wsUrl = "wss://statemine-rpc.polkadot.io/"; | ||
| break; | ||
| case "statemint": | ||
| wsUrl = "wss://statemint-rpc.polkadot.io/"; | ||
| break; | ||
| default: | ||
| fail("Unknown socket url provided, no connection made."); | ||
|
|
||
| } | ||
|
|
||
| const wsProvider = new WsProvider(wsUrl); | ||
| let api = await ApiPromise.create({ provider: wsProvider }); | ||
|
|
||
| // Build API call | ||
| const pathParameters = path.split("."); | ||
| pathParameters.forEach(param => { | ||
| api = api[param]; | ||
| }); | ||
|
|
||
| // Process constants and queries based on parameters prefix | ||
| switch (pathParameters[0]) { | ||
| case "consts": | ||
| chainValue = api.toString(); | ||
| break; | ||
| case "query": | ||
| chainValue = await api(); | ||
| chainValue = chainValue.toString(); | ||
| break; | ||
| default: | ||
| fail(`Unknown path prefix (${pathParameters[0]}) in ${path}`); | ||
| } | ||
| } catch (error) { | ||
| console.log(error); | ||
| } | ||
|
|
||
| // TODO - check chain value before marking successful response | ||
| if(chainValue !== undefined) { successfulResponses += 1; } | ||
| } | ||
| } | ||
|
|
||
| // All RPC paths should return valid responses | ||
| expect(attemptedConnections === successfulResponses).toEqual(true); | ||
| }); |
Oops, something went wrong.