feat: e2e tests #245
Open
feat: e2e tests #245
Conversation
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
cavacado
reviewed
Jan 31, 2023
src/e2e/utils/shell.ts
Outdated
Comment on lines
33
to
77
| export const printLines = (lines: LineInfo[]): void => { | ||
| lines.sort((a: LineInfo, b: LineInfo): number => { | ||
| return a.lineNumber - b.lineNumber; | ||
| }); | ||
| for (const line of lines) { | ||
| log(`${line.lineNumber}: ${line.lineContent}`); | ||
| } | ||
| }; | ||
|
|
||
| export const extractLine = (result: string, query: string): LineInfo[] | void => { | ||
| const splitResults = result.trim().split("\n"); | ||
| const matchedLines = []; | ||
| for (let count = 0; count < splitResults.length; count++) { | ||
| const line = splitResults[count].trim(); | ||
| const containsQueryString = line.includes(query); | ||
| if (containsQueryString) { | ||
| matchedLines.push({ | ||
| lineNumber: count, | ||
| lineContent: line, | ||
| }); | ||
| } | ||
| } | ||
| if (matchedLines.length > 0) return matchedLines; | ||
| else return; | ||
| }; | ||
|
|
||
| // https://github.com/chalk/strip-ansi/blob/main/index.js | ||
| export function stripAnsi(ansiString: string): string { | ||
| if (typeof ansiString !== "string") { | ||
| throw new TypeError(`Expected a \`string\`, got \`${typeof ansiString}\``); | ||
| } | ||
| return ansiString.replace(ansiRegex(), ""); | ||
| } | ||
|
|
||
| // https://github.com/chalk/ansi-regex/blob/main/index.js | ||
| export function ansiRegex({ onlyFirst = false } = {}): RegExp { | ||
| const pattern = [ | ||
| "[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)", | ||
| "(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-nq-uy=><~]))", | ||
| ].join("|"); | ||
|
|
||
| return new RegExp(pattern, onlyFirst ? undefined : "g"); | ||
| } | ||
|
|
||
| export { shell, ShellString }; |
There was a problem hiding this comment.
do u need to export these??
cavacado
reviewed
Jan 31, 2023
src/e2e/all.ts
Outdated
| awaitForDuration(nominate); | ||
| awaitForDuration(changeHolder); | ||
| awaitForDuration(endorseChangeOwner); | ||
| awaitForDuration(endorseTransfer); |
There was a problem hiding this comment.
name this file index better
cavacado
reviewed
Feb 1, 2023
Comment on lines
+22
to
+28
| const tokenInfo = await retrieveTokenInfo(signer, tokenRegistryAddress); | ||
| if (!(tokenInfo.name === tokenRegistryParameter.registryName)) { | ||
| throw new Error("tokenInfo.name === tokenRegistryParameter.registryName"); | ||
| } | ||
| if (!(tokenInfo.symbol === tokenRegistryParameter.registrySymbol)) { | ||
| throw new Error("tokenInfo.symbol === tokenRegistryParameter.registrySymbol"); | ||
| } |
There was a problem hiding this comment.
y do we need to check for the name and symbol, when those are the parameters you specified?
There was a problem hiding this comment.
it's checking the values on the deployed token-registry rather than within oa-cli, not necessary but is of some use in case something is seriously broken on the smart contract level
cavacado
reviewed
Feb 1, 2023
|
|
||
| const command = generateDeployDocumentStoreCommand(documentStoreParameters, owner.privateKey); | ||
| const results = run(command); | ||
| const tokenRegistrySuccessFormat = `${EndStatus.success} Document store Test Document Store deployed at `; |
There was a problem hiding this comment.
the document store is called Test Document Store
So it's Document store ${Test Document Store} deployed at 0x0
The results of this has no fixed length so it had to match the results directly
cavacado
reviewed
Feb 1, 2023
src/e2e/deploy.e2e.ts
Outdated
| import { getSigner, retrieveTokenInfo, rolesCheck } from "./utils/contract-checks"; | ||
| import { checkTokenRegistrySuccess, defaultTokenRegistry } from "./utils/helpers"; | ||
|
|
||
| export const deployTokenRegistry = async (): Promise<void> => { |
There was a problem hiding this comment.
can add a suffixes to indicate its a e2e test?
hard to discern whether its a method or e2e (this goes for all the e2e entry point functions)
* feat(token-registry)!: token registry v4
BREAKING CHANGE: Token Registry V4
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Validation, End-to-End tests with ganache to test if token-registry is working as intended
Changes
src/e2e containing the tests
package.json & config.yml to update ci workflow
src/implementations to detect if token registry is valid
Issues