Chore/client integration tests #759

Ghislain89 · 2023-08-08T09:18:37Z

This PR adds

the test:integration command. Invoke through pnpm run test:integration
GitHub Actions to run Integration tests when a change is made to @kadena/Client
Updates the default Jest unit test profile to ignore integration tests.
Integration tests to validate integration between kadena client and chainweb.

To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1205201634350538

vercel · 2023-08-08T09:18:44Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

5 Ignored Deployments

Name	Status	Preview	Updated (UTC)
alpha-docs	⬜️ Ignored (Inspect)	Visit Preview	Oct 5, 2023 11:17am
docs-storybook	⬜️ Ignored (Inspect)	Visit Preview	Oct 5, 2023 11:17am
immutable-records	⬜️ Ignored (Inspect)	Visit Preview	Oct 5, 2023 11:17am
react-ui	⬜️ Ignored (Inspect)	Visit Preview	Oct 5, 2023 11:17am
tools	⬜️ Ignored (Inspect)	Visit Preview	Oct 5, 2023 11:17am

javadkh2 · 2023-08-16T08:15:35Z

packages/libs/client/src/integration-tests/test-data/accounts.ts

+  chainId: '0',
+  guard: '5a2afbc4564b76b2c27ce5a644cab643c43663835ea0be22433b209d3351f937',
+};
+export const targetAccount: IAccount = {


Why is this one the same as sourceAccount?

I opted for the usecase that an individual wants to transfer funds to his own account on another chain. I can easily update if it's more realistic to be a different account?

javadkh2 · 2023-08-16T08:22:50Z

Nice job Ghislain!
I will try to fix the typing issue, then we won't need to cast Pact.modules to any

changeset-bot · 2023-09-05T09:39:05Z

🦋 Changeset detected

Latest commit: 97849f8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

javadkh2

We need to update the github workflow file based on the new monorepo setup.

alber70g

Minor comments. Only static review

alber70g · 2023-09-11T09:52:14Z

packages/libs/client/package.json

Formatting needs to be executed. Dependencies aren't ordered alphabetically

Should be done now.

alber70g · 2023-09-11T09:52:26Z

packages/libs/client/src/integration-tests/crosschain-transaction.int.test.ts

+let initialTargetBalance: number;
+
+describe('Cross Chain Transfer', () => {
+  it('should fund the source account on chain 0', async () => {


Suggested change

it('should fund the source account on chain 0', async () => {

it('funds the source account on chain 0', async () => {

alber70g · 2023-09-11T09:52:36Z

packages/libs/client/src/integration-tests/crosschain-transaction.int.test.ts

+
+  // this is required as the source account is used to pay for gas;
+  // in mainnet this is not required as the gas station pays for gas
+  it('should fund the source account on chain 1', async () => {


Suggested change

it('should fund the source account on chain 1', async () => {

it('funds the source account on chain 1', async () => {

alber70g · 2023-09-11T09:52:55Z

packages/libs/client/src/integration-tests/crosschain-transaction.int.test.ts

+    expect(initialTargetBalance).toBeGreaterThanOrEqual(100);
+  });
+
+  it('should be able to perform a cross chain transfer', async () => {


Etc....

Suggested change

it('should be able to perform a cross chain transfer', async () => {

it('performs a cross chain transfer', async () => {

alber70g · 2023-09-11T09:54:20Z

packages/libs/client/src/integration-tests/helpers/account/describe-account.ts

+): Promise<number> {
+  const tr = Pact.builder
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    .execution((Pact.modules as any).coin['get-balance'](account))


Instead of using Pact.modules as any you can write the Pact expression

Suggested change

.execution((Pact.modules as any).coin['get-balance'](account))

.execution(`(coin.get-balance "${account}")`)

alber70g · 2023-09-11T09:57:22Z

packages/libs/client/src/integration-tests/helpers/account/fund-account.ts

+      (Pact.modules as any).coin['transfer-create'](
+        sender00Account.account,
+        receiver,
+        readKeyset('ks'),
+        amount,
+      ),


If you like this structure, generating the typings would be even better.

I think typings are available, considering the scripts in the packages/libs/client/package.json

"pactjs:generate:contract": "pactjs contract-generate --file contracts/coin.contract.pact", "pactjs:retrieve:contract": "pactjs retrieve-contract --out contracts/coin.contract.pact --module coin",

I tried making the typings available by running the first mentioned script (I had to slightly update it) this seems to generate typings but then using pact.modules.coin doesn't appear to work. I might need a tiny little bit of help getting that to work.

We can't generate types for the contract here. The problem is that this file is in the client package, and we use interface merging for Pact types. This will break types in the pact.ts file itself. If we can somehow isolate this section, maybe with a separate tsconfig file, we might be able to fix it.

alber70g · 2023-09-11T10:00:34Z

packages/libs/client/src/integration-tests/helpers/account/keyFromAccount.ts

+export function keyFromAccount(account: Account): string {
+  return account.split(':')[1];
+}


Taking the key from the account can only be done with k:... accounts. Would be good to do a runtime check whether the account is compatible. Even when it is, the key could've been rotated.

Suggested change

export function keyFromAccount(account: Account): string {

return account.split(':')[1];

}

export function keyFromAccount(account: Account): string {

if (!account.includes('k:')) {

throw new Error(`Not able to retrieve key from '${account}'`);

}

return account.split(':')[1];

}

@alber70g given that we provide a type for Account: export type Account = ${'k' | 'w'}:${string} | string;
Perhaps we could just return the account if there is no k: prefix.

webpro

Nitpicks only, good stuff ✨

webpro · 2023-10-04T09:01:10Z

packages/libs/client/TESTING.md

+[1]: https://www.docker.com/
+[2]: /packages/tools/heft-rig/jest.config.json
+[3]: http://localhost:8080
+


Bonus points if you add *.md or TESTING.md to the format:md script in package.json (and run that).

It is done!

webpro · 2023-10-04T09:14:18Z

packages/libs/client/jest.integration.config.js

@@ -0,0 +1,10 @@
+module.exports = {


Does it make sense to extend from packages/tools/heft-rig/jest.config.json (and overwrite as needed like below), or not (yet)?

I thought of that, but there are quite a few settings in the central config should not be used for the integration config. It might make sense to eventually add a shared integration config if more packages perform similar tests.

webpro · 2023-10-04T09:15:04Z

packages/libs/client/package.json

@@ -33,7 +33,8 @@
    "pactjs:generate:contract": "pactjs contract-generate --file contracts/coin.contract.pact",
    "pactjs:retrieve:contract": "pactjs retrieve-contract --out contracts/coin.contract.pact --module coin",
    "start": "ts-node --transpile-only src/index.ts",
-    "test": "jest"
+    "test": "jest",
+    "test:integration": "jest --silent -c ./jest.integration.config.js"


Why go silent?

Primarily to not output all the console logging done by Kadena Client. It makes the logs generated by Jest very hard to read.

webpro · 2023-10-04T09:42:08Z

packages/libs/client/src/integration-tests/helpers/fp-helpers.ts

+  <T extends any>(data: T): T => {
+    console.log(tag, data);
+    return data;
+  };


Idea: move to reusable helpers? Not necessarily in this PR.

javadkh2

I think this is good enough and very valuable to merge it and have the test in the pipeline. Fixing the typing issues might require some revision of how we export contract types. For example, if we don't use interface merging, then we can easily generate types here.

…nning tests and determining coverage.

Ghislain89 requested review from alber70g, webpro and javadkh2 as code owners August 8, 2023 09:18

javadkh2 reviewed Aug 16, 2023

View reviewed changes

javadkh2 force-pushed the chore/client-integration-tests branch from 28aa26c to 6b1957c Compare September 5, 2023 09:38

javadkh2 self-requested a review September 5, 2023 13:08

javadkh2 requested changes Sep 5, 2023

View reviewed changes

alber70g approved these changes Sep 11, 2023

View reviewed changes

Ghislain89 force-pushed the chore/client-integration-tests branch 2 times, most recently from fb8e241 to bd737cb Compare October 3, 2023 10:17

webpro approved these changes Oct 4, 2023

View reviewed changes

Ghislain89 requested a review from javadkh2 October 4, 2023 09:51

javadkh2 approved these changes Oct 5, 2023

View reviewed changes

Ghislain89 added 14 commits October 5, 2023 13:14

Add Initial Iteration of Client Integration Tests

27405a2

update changelog

33291ec

update simple transfer after client changes

6246d34

Don't run everything in a container

7760865

update timeout for test

679f1dc

re-add rush build

73630ad

only build Kadena client for the sake of speed

5374038

Add documentation for running tests

eb8b20d

Update integration tests for kadena client

7aa787d

Update integration tests for kadena client

d50fe22

Update integration tests for kadena client

f01b523

First iteration of cross chain transfer

d0b87ac

First iteration of cross chain transfer

45b70fc

add debug logging

f4470ae

Ghislain89 and others added 27 commits October 5, 2023 13:14

add disable eslint for specific lines

52762ce

Add a little bit of leniency in the test case

a691885

chore: removed old change log files

ba1f53d

refactor(client): integration test

316f0bd

Tidy up Jest configuration and use latest version of devnet for tests.

e887541

Tidy up Jest configuration and use latest version of devnet for tests.

ed5390e

Update workflow to work with pnpm and turbo.

af5ba45

update host for health check.

19b7bc5

remove -t flag

09e1a66

update host for health check.

ddb07c9

Try increasing verbosity of health check to debug container startup.

02ce8c8

add additional settings to health checkk

82294e0

tweak healthcheck settings

9273e83

update curl to explicit path

24eff34

remove explicit path to curl, it has been added to PATH env.

6cb3d8e

update GitHub actions for pnpm and turbo.

4aef1c6

update GitHub actions for pnpm and turbo.

1c896e0

update workflow to use turbo explicitly

c95a3b2

Update shared JestConfig to exclude integration tests folders when ru…

4b03721

…nning tests and determining coverage.

Update turbo.json to include integration stage.

4e5def9

Update Turbo scripts and workflow

84ac27b

Linting & Prettier

b604db8

update readme.

b8ed9bb

update TESTING.md

0146fcc

Add error handling for KeyFromAccount

3126f6b

Add empty changeset

80f5375

Format all Markdown files for the client

97849f8

Ghislain89 force-pushed the chore/client-integration-tests branch from ca62c95 to 97849f8 Compare October 5, 2023 11:14

Ghislain89 merged commit ce1d4c6 into main Oct 5, 2023

Ghislain89 deleted the chore/client-integration-tests branch October 5, 2023 11:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Chore/client integration tests #759

Chore/client integration tests #759

Ghislain89 commented Aug 8, 2023 •

edited

Loading

vercel bot commented Aug 8, 2023 •

edited

Loading

javadkh2 Aug 16, 2023

Ghislain89 Aug 17, 2023

javadkh2 commented Aug 16, 2023 •

edited

Loading

changeset-bot bot commented Sep 5, 2023 •

edited

Loading

javadkh2 left a comment

alber70g left a comment

alber70g Sep 11, 2023

Ghislain89 Oct 3, 2023

alber70g Sep 11, 2023

alber70g Sep 11, 2023

alber70g Sep 11, 2023

alber70g Sep 11, 2023

alber70g Sep 11, 2023

Ghislain89 Oct 3, 2023

javadkh2 Oct 5, 2023

alber70g Sep 11, 2023

Ghislain89 Oct 3, 2023

webpro left a comment

webpro Oct 4, 2023

Ghislain89 Oct 5, 2023

webpro Oct 4, 2023

Ghislain89 Oct 5, 2023

webpro Oct 4, 2023

Ghislain89 Oct 5, 2023

webpro Oct 4, 2023

Ghislain89 Oct 5, 2023

javadkh2 left a comment

	it('should fund the source account on chain 0', async () => {
	it('funds the source account on chain 0', async () => {

	it('should fund the source account on chain 1', async () => {
	it('funds the source account on chain 1', async () => {

	it('should be able to perform a cross chain transfer', async () => {
	it('performs a cross chain transfer', async () => {

	.execution((Pact.modules as any).coin['get-balance'](account))
	.execution(`(coin.get-balance "${account}")`)

Chore/client integration tests #759

Chore/client integration tests #759

Conversation

Ghislain89 commented Aug 8, 2023 • edited Loading

vercel bot commented Aug 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

javadkh2 commented Aug 16, 2023 • edited Loading

changeset-bot bot commented Sep 5, 2023 • edited Loading

🦋 Changeset detected

javadkh2 left a comment

Choose a reason for hiding this comment

alber70g left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

webpro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

javadkh2 left a comment

Choose a reason for hiding this comment

Ghislain89 commented Aug 8, 2023 •

edited

Loading

vercel bot commented Aug 8, 2023 •

edited

Loading

javadkh2 commented Aug 16, 2023 •

edited

Loading

changeset-bot bot commented Sep 5, 2023 •

edited

Loading