test: improve cli calls

LedgerHQ · Dec 6, 2024 · fc04d9f · fc04d9f
1 parent df6ba89
commit fc04d9f
Show file tree

Hide file tree

Showing 9 changed files with 196 additions and 381 deletions.
diff --git a/apps/ledger-live-desktop/tests/fixtures/common.ts b/apps/ledger-live-desktop/tests/fixtures/common.ts
@@ -13,15 +13,7 @@ import { captureArtifacts } from "tests/utils/allureUtils";
 import { randomUUID } from "crypto";
 import { AppInfos } from "@ledgerhq/live-common/e2e/enum/AppInfos";
 import { lastValueFrom, Observable } from "rxjs";
-import { commandCLI } from "tests/utils/cliUtils";
 import { registerSpeculosTransport } from "@ledgerhq/live-cli/src/live-common-setup";
-import { activateLedgerSync } from "@ledgerhq/live-common/e2e/speculos";
-
-type Command<T extends (...args: any) => Observable<any> | Promise<any> | string> = {
-  command: T;
-  args: Parameters<T>[0]; // Infer the first argument type
-  output?: (output: any) => void;
-};
 
 type TestFixtures = {
   lang: string;
@@ -38,7 +30,7 @@ type TestFixtures = {
   featureFlags: OptionalFeatureMap;
   simulateCamera: string;
   app: Application;
-  cliCommands: Command<(typeof commandCLI)[keyof typeof commandCLI]>[];
+  cliCommands?: ((appjsonPath: string) => Observable<unknown> | Promise<unknown> | string)[];
 };
 
 const IS_NOT_MOCK = process.env.MOCK == "0";
@@ -121,31 +113,16 @@ export const test = base.extend<TestFixtures>({
         setEnv("SPECULOS_API_PORT", device?.ports.apiPort?.toString());
         setEnv("MOCK", "");
 
-        if (cliCommands) {
+        if (cliCommands?.length) {
           registerSpeculosTransport(device?.ports.apiPort);
-          for (const command of cliCommands) {
-            if (command.args && "appjson" in command.args) {
-              command.args.appjson = `${userdataDestinationPath}/app.json`;
-            }
-
-            const resultPromise = handleResult(command.command(command.args as any));
-
-            if (command.args && "getKeyRingTree" in command.args) {
-              await activateLedgerSync();
-            }
-
-            const result = await resultPromise;
-            command?.output?.(result);
+          for (const cmd of cliCommands) {
+            const promise = await cmd(`${userdataDestinationPath}/app.json`);
+            const result =
+              promise instanceof Observable ? await lastValueFrom(promise) : await promise;
             console.log("CLI result: ", result);
           }
         }
       }
-      async function handleResult(result: Promise<any> | Observable<any> | string): Promise<any> {
-        if (result instanceof Observable) {
-          return lastValueFrom(result); // Converts Observable to Promise
-        }
-        return result; // Return Promise directly
-      }
 
       // default environment variables
       env = Object.assign(

diff --git a/apps/ledger-live-desktop/tests/specs/speculos/delegate.spec.ts b/apps/ledger-live-desktop/tests/specs/speculos/delegate.spec.ts
@@ -3,7 +3,7 @@ import { Account } from "@ledgerhq/live-common/e2e/enum/Account";
 import { Delegate } from "../../models/Delegate";
 import { addTmsLink } from "tests/utils/allureUtils";
 import { getDescription } from "../../utils/customJsonReporter";
-import { commandCLI } from "tests/utils/cliUtils";
+import { CLI } from "tests/utils/cliUtils";
 import { isRunningInScheduledWorkflow } from "tests/utils/githubUtils";
 
 const e2eDelegationAccounts = [
@@ -59,14 +59,13 @@ test.describe("Delegate flows", () => {
         userdata: "skip-onboarding",
         speculosApp: account.delegate.account.currency.speculosApp,
         cliCommands: [
-          {
-            command: commandCLI.liveData,
-            args: {
+          (appjsonPath: string) => {
+            return CLI.liveData({
               currency: account.delegate.account.currency.ticker,
               index: account.delegate.account.index,
               add: true,
-              appjson: "",
-            },
+              appjson: appjsonPath,
+            });
           },
         ],
       });
@@ -114,14 +113,13 @@ test.describe("Delegate flows", () => {
         userdata: "skip-onboarding",
         speculosApp: validator.delegate.account.currency.speculosApp,
         cliCommands: [
-          {
-            command: commandCLI.liveData,
-            args: {
+          (appjsonPath: string) => {
+            return CLI.liveData({
               currency: validator.delegate.account.currency.ticker,
               index: validator.delegate.account.index,
               add: true,
-              appjson: "",
-            },
+              appjson: appjsonPath,
+            });
           },
         ],
       });
@@ -157,14 +155,13 @@ test.describe("Delegate flows", () => {
       userdata: "skip-onboarding",
       speculosApp: delegateAccount.account.currency.speculosApp,
       cliCommands: [
-        {
-          command: commandCLI.liveData,
-          args: {
+        (appjsonPath: string) => {
+          return CLI.liveData({
             currency: delegateAccount.account.currency.ticker,
             index: delegateAccount.account.index,
             add: true,
-            appjson: "",
-          },
+            appjson: appjsonPath,
+          });
         },
       ],
     });

diff --git a/apps/ledger-live-desktop/tests/specs/speculos/delete.account.spec.ts b/apps/ledger-live-desktop/tests/specs/speculos/delete.account.spec.ts
@@ -2,7 +2,7 @@ import { test } from "../../fixtures/common";
 import { Account } from "@ledgerhq/live-common/e2e/enum/Account";
 import { addTmsLink } from "tests/utils/allureUtils";
 import { getDescription } from "../../utils/customJsonReporter";
-import { commandCLI } from "tests/utils/cliUtils";
+import { CLI } from "tests/utils/cliUtils";
 
 const accounts = [
   { account: Account.BTC_NATIVE_SEGWIT_1, xrayTicket: "B2CQA-2548" },
@@ -24,14 +24,13 @@ for (const account of accounts) {
     test.use({
       userdata: "skip-onboarding",
       cliCommands: [
-        {
-          command: commandCLI.liveData,
-          args: {
+        (appjsonPath: string) => {
+          return CLI.liveData({
             currency: account.account.currency.currencyId,
             index: account.account.index,
-            appjson: "",
             add: true,
-          },
+            appjson: appjsonPath,
+          });
         },
       ],
       speculosApp: account.account.currency.speculosApp,

diff --git a/apps/ledger-live-desktop/tests/specs/speculos/ledgerSync.spec.ts b/apps/ledger-live-desktop/tests/specs/speculos/ledgerSync.spec.ts
@@ -2,55 +2,65 @@ import { test } from "../../fixtures/common";
 import { AppInfos } from "@ledgerhq/live-common/e2e/enum/AppInfos";
 import { addTmsLink } from "tests/utils/allureUtils";
 import { getDescription } from "../../utils/customJsonReporter";
-import { commandCLI } from "tests/utils/cliUtils";
+import { CLI } from "tests/utils/cliUtils";
+import { activateLedgerSync } from "@ledgerhq/live-common/e2e/speculos";
 
 const app: AppInfos = AppInfos.LS;
 
 test.describe(`[${app.name}] Sync Accounts`, () => {
   const ledgerKeyRingProtocolArgs = {
-    getKeyRingTree: true,
-    pubKey: undefined,
-    privateKey: undefined,
+    pubKey: "",
+    privateKey: "",
   };
   const ledgerSyncPushDataArgs = {
-    pubKey: undefined,
-    privateKey: undefined,
-    rootId: undefined,
-    walletSyncEncryptionKey: undefined,
-    applicationPath: undefined,
+    rootId: "",
+    walletSyncEncryptionKey: "",
+    applicationPath: "",
     push: true,
     data: '{"accounts":[{"id":"mock:1:dogecoin:0.790010769447963:","currencyId":"dogecoin","index":1,"seedIdentifier":"mock","derivationMode":"","freshAddress":"1uVnrWAzycYqKUXSuNXt3XSjJ8"},{"id":"mock:1:bitcoin_gold:0.8027791663782486:","currencyId":"bitcoin_gold","index":1,"seedIdentifier":"mock","derivationMode":"","freshAddress":"1Y5T8JQqBKUS7cXbxUYCR4wg3YSbV9R"}],"accountNames":{"mock:1:dogecoin:0.790010769447963:":"Renamed Dogecoin 2","mock:1:bitcoin_gold:0.8027791663782486:":"Bitcoin Gold 2"}}',
   };
 
+  async function initializeLedgerKeyRingProtocol() {
+    return CLI.ledgerKeyRingProtocol({ initMemberCredentials: true }).then(output => {
+      if (output && typeof output !== "string" && "pubkey" in output) {
+        ledgerKeyRingProtocolArgs.pubKey = output.pubkey;
+        ledgerKeyRingProtocolArgs.privateKey = output.privatekey;
+      }
+      return output;
+    });
+  }
+
+  async function initializeLedgerSync() {
+    const output = CLI.ledgerKeyRingProtocol({
+      getKeyRingTree: true,
+      ...ledgerKeyRingProtocolArgs,
+    }).then(out => {
+      if (out && typeof out !== "string" && "rootId" in out) {
+        ledgerSyncPushDataArgs.rootId = out.rootId;
+        ledgerSyncPushDataArgs.walletSyncEncryptionKey = out.walletSyncEncryptionKey;
+        ledgerSyncPushDataArgs.applicationPath = out.applicationPath;
+      }
+      return out;
+    });
+    await activateLedgerSync();
+    return output;
+  }
+
   test.use({
     userdata: "skip-onboarding",
     speculosApp: app,
     cliCommands: [
-      {
-        command: commandCLI.ledgerKeyRingProtocol,
-        args: {
-          initMemberCredentials: true,
-        },
-        output: output => {
-          ledgerKeyRingProtocolArgs.pubKey = output.pubkey;
-          ledgerKeyRingProtocolArgs.privateKey = output.privatekey;
-
-          ledgerSyncPushDataArgs.pubKey = output.pubkey;
-          ledgerSyncPushDataArgs.privateKey = output.privatekey;
-        },
+      async () => {
+        return initializeLedgerKeyRingProtocol();
       },
-      {
-        command: commandCLI.ledgerKeyRingProtocol,
-        args: ledgerKeyRingProtocolArgs,
-        output: output => {
-          ledgerSyncPushDataArgs.rootId = output.rootId;
-          ledgerSyncPushDataArgs.walletSyncEncryptionKey = output.walletSyncEncryptionKey;
-          ledgerSyncPushDataArgs.applicationPath = output.applicationPath;
-        },
+      async () => {
+        return initializeLedgerSync();
       },
-      {
-        command: commandCLI.ledgerSync,
-        args: ledgerSyncPushDataArgs,
+      async () => {
+        return CLI.ledgerSync({
+          ...ledgerKeyRingProtocolArgs,
+          ...ledgerSyncPushDataArgs,
+        });
       },
     ],
   });

diff --git a/apps/ledger-live-desktop/tests/specs/speculos/nft.spec.ts b/apps/ledger-live-desktop/tests/specs/speculos/nft.spec.ts
@@ -5,7 +5,7 @@ import { Nft } from "@ledgerhq/live-common/e2e/enum/Nft";
 import { Fee } from "@ledgerhq/live-common/e2e/enum/Fee";
 import { addTmsLink } from "tests/utils/allureUtils";
 import { getDescription } from "../../utils/customJsonReporter";
-import { commandCLI } from "tests/utils/cliUtils";
+import { CLI } from "tests/utils/cliUtils";
 import invariant from "invariant";
 
 test.describe("send NFT to ENS address", () => {
@@ -19,14 +19,13 @@ test.describe("send NFT to ENS address", () => {
   test.use({
     userdata: "skip-onboarding",
     cliCommands: [
-      {
-        command: commandCLI.liveData,
-        args: {
+      (appjsonPath: string) => {
+        return CLI.liveData({
           currency: transaction.accountToDebit.currency.currencyId,
           index: transaction.accountToDebit.index,
-          appjson: "",
           add: true,
-        },
+          appjson: appjsonPath,
+        });
       },
     ],
     speculosApp: transaction.accountToDebit.currency.speculosApp,
@@ -67,14 +66,13 @@ test.describe("The user can see his NFT floor price", () => {
   test.use({
     userdata: "skip-onboarding",
     cliCommands: [
-      {
-        command: commandCLI.liveData,
-        args: {
+      (appjsonPath: string) => {
+        return CLI.liveData({
           currency: account.currency.currencyId,
           index: account.index,
-          appjson: "",
           add: true,
-        },
+          appjson: appjsonPath,
+        });
       },
     ],
     speculosApp: account.currency.speculosApp,
@@ -117,14 +115,13 @@ for (const account of accounts) {
     test.use({
       userdata: "skip-onboarding",
       cliCommands: [
-        {
-          command: commandCLI.liveData,
-          args: {
+        (appjsonPath: string) => {
+          return CLI.liveData({
             currency: account.account.currency.currencyId,
             index: account.account.index,
-            appjson: "",
             add: true,
-          },
+            appjson: appjsonPath,
+          });
         },
       ],
       speculosApp: account.account.currency.speculosApp,
@@ -153,14 +150,13 @@ for (const account of accounts) {
     test.use({
       userdata: "skip-onboarding",
       cliCommands: [
-        {
-          command: commandCLI.liveData,
-          args: {
+        (appjsonPath: string) => {
+          return CLI.liveData({
             currency: account.account.currency.currencyId,
             index: account.account.index,
-            appjson: "",
             add: true,
-          },
+            appjson: appjsonPath,
+          });
         },
       ],
       speculosApp: account.account.currency.speculosApp,

diff --git a/apps/ledger-live-desktop/tests/specs/speculos/receive.address.spec.ts b/apps/ledger-live-desktop/tests/specs/speculos/receive.address.spec.ts
@@ -2,7 +2,7 @@ import { test } from "../../fixtures/common";
 import { Account } from "@ledgerhq/live-common/e2e/enum/Account";
 import { addTmsLink } from "tests/utils/allureUtils";
 import { getDescription } from "../../utils/customJsonReporter";
-import { commandCLI } from "tests/utils/cliUtils";
+import { CLI } from "tests/utils/cliUtils";
 
 const accounts = [
   { account: Account.BTC_NATIVE_SEGWIT_1, xrayTicket: "B2CQA-2559, B2CQA-2687" },
@@ -24,14 +24,13 @@ for (const account of accounts) {
       userdata: "skip-onboarding",
       speculosApp: account.account.currency.speculosApp,
       cliCommands: [
-        {
-          command: commandCLI.liveData,
-          args: {
+        (appjsonPath: string) => {
+          return CLI.liveData({
             currency: account.account.currency.currencyId,
             index: account.account.index,
-            appjson: "",
             add: true,
-          },
+            appjson: appjsonPath,
+          });
         },
       ],
     });
@@ -82,14 +81,13 @@ test.describe("Receive", () => {
     userdata: "skip-onboarding",
     speculosApp: account.currency.speculosApp,
     cliCommands: [
-      {
-        command: commandCLI.liveData,
-        args: {
+      (appjsonPath: string) => {
+        return CLI.liveData({
           currency: account.currency.currencyId,
           index: account.index,
           add: true,
-          appjson: "",
-        },
+          appjson: appjsonPath,
+        });
       },
     ],
   });