Move user journey tests to a package (#562)

* moved sdk e2e tests to separate package

* import sdk from path, added API clients to sdk exports

* remove user-journey from package CI

* specify type export in armory-sdk

* removed type from resourceId function

* renamed user-journey package

* renamed manually in makefile, fixed import from sdk

.github/workflows/packages.yml

@@ -54,25 +54,25 @@ jobs:
       - name: Code format
         run: |
           npx nx affected --target format:check lint:check \
-            --exclude tag:type:application \
+            --exclude tag:type:application,armory-e2e-testing \
             --base=origin/main
 
       - name: Test types
         run: |
           npx nx affected --target test:type \
-            --exclude tag:type:application \
+            --exclude tag:type:application,armory-e2e-testing \
             --base=origin/main
 
       - name: Test unit
         run: |
           npx nx affected --target test:unit \
-            --exclude tag:type:application \
+            --exclude tag:type:application,armory-e2e-testing \
             --base=origin/main
 
       - name: Test integration
         run: |
           npx nx affected --target test:integration \
-            --exclude tag:type:application \
+            --exclude tag:type:application,armory-e2e-testing \
             --base=origin/main
 
       - name: Test end-to-end
@@ -83,7 +83,7 @@ jobs:
           # in-memory. It'd be a good time to revisit this TODO and think about
           # using testcontainers.
           npx nx affected --target test:e2e \
-            --exclude tag:type:application \
+            --exclude tag:type:application,armory-e2e-testing \
             --base=origin/main \
             --testPathIgnorePatterns=packages/armory-sdk/src/lib/__test__/e2e/*
 

Makefile

@@ -8,6 +8,7 @@ include ./packages/policy-engine-shared/Makefile
 include ./packages/transaction-request-intent/Makefile
 include ./packages/signature/Makefile
 include ./packages/armory-sdk/Makefile
+include ./packages/armory-e2e-testing/Makefile
 
 # For more terminal color codes, head over to
 # https://opensource.com/article/19/9/linux-terminal-colors

packages/armory-e2e-testing/.eslintrc.json

@@ -0,0 +1,25 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": "error"
+      }
+    }
+  ]
+}

packages/armory-e2e-testing/Makefile

@@ -0,0 +1,37 @@
+ARMORY_E2E_TESTING_PROJECT_NAME := armory-e2e-testing
+ARMORY_E2E_TESTING_PROJECT_DIR := ./packages/armory-e2e-testing
+
+# === Build ===
+
+armory-e2e-testing/build:
+	npx nx build ${ARMORY_E2E_TESTING_PROJECT_NAME}
+
+# === Code format ===
+
+armory-e2e-testing/format:
+	 npx nx format:write --projects ${ARMORY_E2E_TESTING_PROJECT_NAME}
+
+armory-e2e-testing/lint:
+	npx nx lint ${ARMORY_E2E_TESTING_PROJECT_NAME} -- --fix
+
+armory-e2e-testing/format/check:
+	 npx nx format:check --projects ${ARMORY_E2E_TESTING_PROJECT_NAME}
+
+armory-e2e-testing/lint/check:
+	npx nx lint ${ARMORY_E2E_TESTING_PROJECT_NAME}
+
+# === Testing ===
+
+armory-e2e-testing/test/type:
+	npx tsc \
+		--project ${ARMORY_E2E_TESTING_PROJECT_DIR}/tsconfig.lib.json \
+		--noEmit
+
+armory-e2e-testing/test/unit/watch:
+	make armory-e2e-testing/test/unit ARGS=--watch
+
+armory-e2e-testing/test/e2e:
+	npx nx test:e2e ${ARMORY_E2E_TESTING_PROJECT_NAME} -- ${ARGS}
+
+armory-e2e-testing/test/e2e/watch:
+	make armory-e2e-testing/test/e2e ARGS=--watch

packages/armory-e2e-testing/README.md

@@ -0,0 +1,3 @@
+# User-journey
+
+This package is an e2e test package. It encapsulate some core usage scenarios for armory stack. In order to run, all

packages/armory-e2e-testing/jest.config.ts

@@ -0,0 +1,18 @@
+import type { Config } from 'jest'
+
+const config: Config = {
+  displayName: 'armory-sdk',
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
+  preset: '../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]sx?$': [
+      'ts-jest',
+      {
+        tsconfig: '<rootDir>/tsconfig.spec.json'
+      }
+    ]
+  }
+}
+
+export default config

packages/armory-e2e-testing/jest.e2e.ts

@@ -0,0 +1,9 @@
+import type { Config } from 'jest'
+import sharedConfig from './jest.config'
+
+const config: Config = {
+  ...sharedConfig,
+  testMatch: ['<rootDir>/**/__test__/e2e/**/*.spec.ts']
+}
+
+export default config

packages/armory-e2e-testing/project.json

@@ -0,0 +1,25 @@
+{
+  "name": "armory-e2e-testing",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/armory-e2e-testing/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "lint": {
+      "executor": "@nx/eslint:lint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["packages/armory-e2e-testing/**/*.ts"]
+      }
+    },
+    "test:e2e": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "packages/armory-e2e-testing/jest.e2e.ts",
+        "verbose": true,
+        "runInBand": true
+      }
+    }
+  }
+}

packages/armory-sdk/src/lib/__test__/e2e/criterion/check-approvals.spec.ts → packages/armory-e2e-testing/src/__test__/e2e/criterion/check-approvals.spec.ts

@@ -1,9 +1,9 @@
 import { Action, Decision, entitiesSchema, FIXTURE, Request } from '@narval/policy-engine-shared'
 import { v4 } from 'uuid'
-import defaultEntities from '../../resource/entity/test.default.json'
-import twoAdminApproval from '../../resource/policy/checkApprovals/2-admin-approval-required.json'
-import adminApproval from '../../resource/policy/checkApprovals/admin-approval-required.json'
-import adminPermitAll from '../../resource/policy/checkPrincipalRole/admin-permit-all.json'
+import defaultEntities from '../../../resource/entity/test.default.json'
+import twoAdminApproval from '../../../resource/policy/checkApprovals/2-admin-approval-required.json'
+import adminApproval from '../../../resource/policy/checkApprovals/admin-approval-required.json'
+import adminPermitAll from '../../../resource/policy/checkPrincipalRole/admin-permit-all.json'
 import {
   buildAuthClient,
   buildPolicy,
@@ -12,7 +12,7 @@ import {
   getAuthAdminApiKey,
   getAuthHost,
   saveDataStore
-} from '../../util/setup'
+} from '../../../util/setup'
 
 const systemManagerHexPk = FIXTURE.UNSAFE_PRIVATE_KEY.Root
 const ericPrivateKey = FIXTURE.UNSAFE_PRIVATE_KEY.Eric

packages/armory-sdk/src/lib/__test__/e2e/criterion/check-rate-limit.spec.ts → packages/armory-e2e-testing/src/__test__/e2e/criterion/check-rate-limit.spec.ts

@@ -1,8 +1,8 @@
 import { Action, entitiesSchema, FIXTURE, Request } from '@narval/policy-engine-shared'
 import { v4 } from 'uuid'
-import defaultEntities from '../../resource/entity/test.default.json'
-import adminPermitAll from '../../resource/policy/checkPrincipalRole/admin-permit-all.json'
-import memberTwoTransferPerDay from '../../resource/policy/checkRateLimit/members-2-transfer-per-day.json'
+import defaultEntities from '../../../resource/entity/test.default.json'
+import adminPermitAll from '../../../resource/policy/checkPrincipalRole/admin-permit-all.json'
+import memberTwoTransferPerDay from '../../../resource/policy/checkRateLimit/members-2-transfer-per-day.json'
 import {
   buildAuthClient,
   buildPolicy,
@@ -11,7 +11,7 @@ import {
   getAuthAdminApiKey,
   getAuthHost,
   saveDataStore
-} from '../../util/setup'
+} from '../../../util/setup'
 
 const systemManagerHexPk = FIXTURE.UNSAFE_PRIVATE_KEY.Root
 const ericPrivateKey = FIXTURE.UNSAFE_PRIVATE_KEY.Eric

packages/armory-sdk/src/lib/__test__/e2e/criterion/check-spending-limit.spec.ts → packages/armory-e2e-testing/src/__test__/e2e/criterion/check-spending-limit.spec.ts

@@ -1,9 +1,9 @@
 import { Action, entitiesSchema, FIXTURE, Request } from '@narval/policy-engine-shared'
 import { v4 } from 'uuid'
-import defaultEntities from '../../resource/entity/test.default.json'
-import adminPermitAll from '../../resource/policy/checkPrincipalRole/admin-permit-all.json'
-import treasuryMemberCanTransferOneEthFixed from '../../resource/policy/checkSpendingLimit/treasury-groupMember-can-transfer-1-eth-fixed.json'
-import treasuryMemberCanTransferOneEthRolling from '../../resource/policy/checkSpendingLimit/treasury-groupMember-can-transfer-1-eth-rolling.json'
+import defaultEntities from '../../../resource/entity/test.default.json'
+import adminPermitAll from '../../../resource/policy/checkPrincipalRole/admin-permit-all.json'
+import treasuryMemberCanTransferOneEthFixed from '../../../resource/policy/checkSpendingLimit/treasury-groupMember-can-transfer-1-eth-fixed.json'
+import treasuryMemberCanTransferOneEthRolling from '../../../resource/policy/checkSpendingLimit/treasury-groupMember-can-transfer-1-eth-rolling.json'
 import {
   buildAuthClient,
   buildPolicy,
@@ -12,7 +12,7 @@ import {
   getAuthAdminApiKey,
   getAuthHost,
   saveDataStore
-} from '../../util/setup'
+} from '../../../util/setup'
 
 const systemManagerHexPk = FIXTURE.UNSAFE_PRIVATE_KEY.Root
 const ericPrivateKey = FIXTURE.UNSAFE_PRIVATE_KEY.Eric

packages/armory-sdk/src/lib/__test__/e2e/scenarii/address-book-management.spec.ts → packages/armory-e2e-testing/src/__test__/e2e/scenarii/address-book-management.spec.ts

@@ -11,9 +11,9 @@ import { AddressBookAddresses } from 'packages/policy-engine-shared/src/lib/dev.
 import { v4 } from 'uuid'
 import { Hex } from 'viem'
 import { generatePrivateKey, privateKeyToAccount } from 'viem/accounts'
-import defaultEntities from '../../resource/entity/test.default.json'
-import addressBookAndRoles from '../../resource/policy/set/address-book-and-roles.json'
-import { buildAuthClient, createClient, saveDataStore } from '../../util/setup'
+import defaultEntities from '../../../resource/entity/test.default.json'
+import addressBookAndRoles from '../../../resource/policy/set/address-book-and-roles.json'
+import { buildAuthClient, createClient, saveDataStore } from '../../../util/setup'
 
 const TEST_TIMEOUT_MS = 30_000
 

packages/armory-sdk/src/lib/__test__/e2e/scenarii/approvals-and-spending-limit.spec.ts → packages/armory-e2e-testing/src/__test__/e2e/scenarii/approvals-and-spending-limit.spec.ts

@@ -1,15 +1,15 @@
 /* eslint-disable jest/consistent-test-it */
 import { Action, Decision, entitiesSchema, FIXTURE, policySchema, Request } from '@narval/policy-engine-shared'
 import { v4 } from 'uuid'
-import defaultEntities from '../../resource/entity/test.default.json'
-import approvalsAndSpendingLimit from '../../resource/policy/set/approvals-and-spending-limit.json'
-import { buildAuthClient, createClient, saveDataStore } from '../../util/setup'
+import defaultEntities from '../../../resource/entity/test.default.json'
+import approvalsAndSpendingLimit from '../../../resource/policy/set/approvals-and-spending-limit.json'
+import { buildAuthClient, createClient, saveDataStore } from '../../../util/setup'
 
 const TEST_TIMEOUT_MS = 30_000
 
 jest.setTimeout(TEST_TIMEOUT_MS)
 
-export const advanceTime = (hours: number): void => {
+export const peradvanceTime = (hours: number): void => {
   jest.useFakeTimers()
   jest.setSystemTime(Date.now() + hours * 60 * 60 * 1000)
 }
@@ -25,7 +25,7 @@ const ericPrivateKey = FIXTURE.UNSAFE_PRIVATE_KEY.Eric
 const genNonce = (request: Request) => ({ ...request, nonce: `${request.nonce}-${v4()}` })
 
 describe('approvals and spending limits', () => {
-  describe('members can spend up to 1 eth per day, above an approval is required', () => {
+  describe('members can spend up to 1 eth  day, above an approval is required', () => {
     const request: Request = {
       action: Action.SIGN_TRANSACTION,
       nonce: 'test-nonce-4',

packages/armory-sdk/src/lib/__test__/e2e/scenarii/defi-interactions.spec.ts → packages/armory-e2e-testing/src/__test__/e2e/scenarii/defi-interactions.spec.ts

@@ -8,9 +8,9 @@ import {
   Request
 } from '@narval/policy-engine-shared'
 import { v4 } from 'uuid'
-import defiEntities from '../../resource/entity/defi-interaction.json'
-import defiInteractionPolicy from '../../resource/policy/set/defi-interaction.json'
-import { buildAuthClient, createClient, saveDataStore } from '../../util/setup'
+import defiEntities from '../../../resource/entity/defi-interaction.json'
+import defiInteractionPolicy from '../../../resource/policy/set/defi-interaction.json'
+import { buildAuthClient, createClient, saveDataStore } from '../../../util/setup'
 
 const TEST_TIMEOUT_MS = 30_000
 

packages/armory-sdk/src/lib/__test__/e2e/scenarii/tiered-eth-transfer-policy.spec.ts → packages/armory-e2e-testing/src/__test__/e2e/scenarii/tiered-eth-transfer-policy.spec.ts

@@ -1,9 +1,9 @@
 /* eslint-disable jest/consistent-test-it */
 import { Action, Decision, entitiesSchema, FIXTURE, policySchema, Request, toHex } from '@narval/policy-engine-shared'
 import { v4 } from 'uuid'
-import defaultEntities from '../../resource/entity/test.default.json'
-import tieredEthTransfer from '../../resource/policy/set/tiered-eth-transfer.json'
-import { buildAuthClient, createClient, saveDataStore } from '../../util/setup'
+import defaultEntities from '../../../resource/entity/test.default.json'
+import tieredEthTransfer from '../../../resource/policy/set/tiered-eth-transfer.json'
+import { buildAuthClient, createClient, saveDataStore } from '../../../util/setup'
 
 const TEST_TIMEOUT_MS = 30_000
 

packages/armory-sdk/src/lib/__test__/e2e/scenarii/user-journeys.spec.ts → packages/armory-e2e-testing/src/__test__/e2e/scenarii/user-journeys.spec.ts

@@ -1,4 +1,23 @@
 /* eslint-disable jest/consistent-test-it */
+import {
+  AuthAdminClient,
+  AuthClient,
+  AuthorizationResponseDtoStatusEnum,
+  ClientDto,
+  CreateClientResponseDto,
+  DataStoreConfig,
+  EntityStoreClient,
+  Permission,
+  PolicyStoreClient,
+  SignOptions,
+  Signer,
+  VaultAdminClient,
+  VaultClient,
+  WalletDto,
+  createHttpDataStore,
+  credential,
+  resourceId
+} from '@narval/armory-sdk'
 import {
   AccessToken,
   AccountEntity,
@@ -26,16 +45,6 @@ import {
 import { format } from 'date-fns'
 import { v4 as uuid } from 'uuid'
 import { english, generateMnemonic, generatePrivateKey, privateKeyToAccount } from 'viem/accounts'
-import { AuthAdminClient, AuthClient } from '../../../auth/client'
-import { EntityStoreClient, PolicyStoreClient } from '../../../data-store/client'
-import { DataStoreConfig } from '../../../data-store/type'
-import { createHttpDataStore, credential } from '../../../data-store/util'
-import { Permission } from '../../../domain'
-import { AuthorizationResponseDtoStatusEnum, CreateClientResponseDto } from '../../../http/client/auth'
-import { ClientDto, WalletDto } from '../../../http/client/vault'
-import { SignOptions, Signer } from '../../../shared/type'
-import { resourceId } from '../../../utils'
-import { VaultAdminClient, VaultClient } from '../../../vault/client'
 
 const TEST_TIMEOUT_MS = 30_000
 

packages/armory-sdk/src/lib/__test__/util/setup.ts → packages/armory-e2e-testing/src/util/setup.ts

@@ -1,10 +1,18 @@
+import {
+  AuthAdminClient,
+  AuthClient,
+  AuthConfig,
+  createHttpDataStore,
+  DataStoreConfig,
+  EntityStoreClient,
+  PolicyStoreClient,
+  VaultAdminClient,
+  VaultConfig
+} from '@narval/armory-sdk'
 import { Entities, Hex, Policy, policySchema, Request } from '@narval/policy-engine-shared'
 import { buildSignerForAlg, getPublicKey, privateKeyToJwk } from '@narval/signature'
 import { format } from 'date-fns'
 import { v4 } from 'uuid'
-import { AuthAdminClient, AuthClient, AuthConfig } from '../../auth'
-import { createHttpDataStore, DataStoreConfig, EntityStoreClient, PolicyStoreClient } from '../../data-store'
-import { VaultAdminClient, VaultConfig } from '../../vault'
 
 export const getAuthHost = () => 'http://localhost:3005'
 export const getAuthAdminApiKey = () => 'armory-admin-api-key'

packages/armory-e2e-testing/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "compilerOptions": {
+    "module": "commonjs",
+    "strict": true,
+    "resolveJsonModule": true
+  }
+}

packages/armory-e2e-testing/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts"]
+}