ci(e2e): E2E tests with CI integration

.circleci/config.yml

@@ -128,21 +128,48 @@ jobs:
       - run:
           name: Check for known security issues in dependencies
           command: cargo audit
-  docker-build:
+  docker-build-release:
     executor: test-executor
     description: Build Docker Image
     steps:
       - checkout
       - run:
           name: Build docker image
-          command: BUILDKIT_PROGRESS=plain DOCKER_BUILDKIT=1 docker build -t $IMAGE_NAME:latest .
+          command: BUILDKIT_PROGRESS=plain DOCKER_BUILDKIT=1 docker build -f docker/release.Dockerfile -t $IMAGE_NAME:latest .
       - run:
           name: Archive Docker image
           command: docker save -o image.tar $IMAGE_NAME
       - persist_to_workspace:
           root: .
           paths:
             - ./image.tar
+  docker-run-e2e:
+    executor: test-executor
+    description: Build and run e2e tests
+    steps:
+      - attach_workspace:
+          at: /tmp/workspace
+      - run:
+          name: Load Archived Docker Image
+          command: docker load -i /tmp/workspace/image.tar
+      - checkout
+      - run:
+          name: Build PINT launch Image
+          command: |
+            git submodule update --init
+            docker build -f docker/launch.Dockerfile -t launch .
+      - run:
+          name: Run e2e tests
+          command: |
+            sudo curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | sudo bash \
+              && source ~/.bashrc \
+              && nvm install v15.9.0 \
+              && nvm use v15.9.0 \
+              && npm install yarn -g \
+              && cd js/e2e \
+              && yarn \
+              && yarn start
+
   docker-publish-latest:
     executor: test-executor
     description: Publish latest Docker Image
@@ -185,10 +212,13 @@ workflows:
       - security
   docker:
     jobs:
-      - docker-build
+      - docker-build-release
+      - docker-run-e2e:
+          requires:
+            - docker-build-release
       - docker-publish-latest:
           requires:
-            - docker-build
+            - docker-build-release
           filters:
             branches:
               only: main

.dockerignore

@@ -1,3 +1,4 @@
 /.cargo/config.toml
 /target
 /Dockerfile
+/launch/bin

.gitignore

@@ -4,9 +4,26 @@
 # These are backup files generated by rustfmt
 **/*.rs.bk
 
+# node deps for e2e
+node_modules
+
+# The directory caches for osx
 .DS_Store
 
+# typescript language server logs
+.log
+
+# The cache for docker container dependency
+.cargo
+
 # The cache for chain data in container
 .local
 
-local-test
+# Binaries for launching PINT with polkadot
+bin
+
+# Libraries of js output
+js/**/*/lib
+
+# Unknown
+local-test

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "js/polkadot-launch"]
+	path = js/polkadot-launch
+	url = https://github.com/paritytech/polkadot-launch.git

config.json

@@ -22,34 +22,38 @@
   },
   "parachains": [
     {
-      "bin": "./target/target/pint",
+      "bin": "./bin/pint",
       "chain": "pint-dev",
       "id": "1",
-      "wsPort": 9988,
-      "port": 31200,
       "balance": "1000000000000000000000",
-      "flags": [
-        "-lruntime=debug",
-        "--",
-        "--execution=wasm"
+      "nodes": [
+        {
+          "wsPort": 9988,
+          "port": 31200,
+          "flags": [
+            "-lruntime=debug",
+            "--unsafe-ws-external",
+            "--",
+            "--execution=wasm"
+          ]
+        }
       ]
     },
     {
       "bin": "./bin/statemint",
       "chain": "statemint-dev",
       "id": "300",
-      "wsPort": 9999,
-      "port": 31300,
       "balance": "1000000000000000000000",
-      "flags": [
-        "-lruntime=debug",
-        "--",
-        "--execution=wasm"
+      "nodes": [
+        {
+          "wsPort": 9999,
+          "port": 31300,
+          "flags": ["-lruntime=debug", "--", "--execution=wasm"]
+        }
       ]
     }
   ],
-  "simpleParachains": [
-  ],
+  "simpleParachains": [],
   "hrmpChannels": [
     {
       "sender": 1,
@@ -60,4 +64,4 @@
   ],
   "types": {},
   "finalization": false
-}
+}

docker/launch.Dockerfile

@@ -0,0 +1,24 @@
+# syntax=docker/dockerfile:experimental
+#
+# Copyright 2021 ChainSafe Systems
+# SPDX-License-Identifier: LGPL-3.0-only
+#
+# This Dockerfile builds the environment of e2e tests
+FROM debian:buster-slim
+COPY config.json config.json
+COPY js/polkadot-launch polkadot-launch
+COPY --from=chainsafe/pint /usr/local/bin/pint bin/
+COPY --from=clearloop/rococo-v1 /polkadot bin/
+COPY --from=clearloop/statemint /statemint bin/
+ENV CARGO_TERM_COLOR=always
+RUN apt-get update -y \
+    && apt-get install openssl curl git -y \
+    && curl -sL https://deb.nodesource.com/setup_15.x | bash - \
+    && apt-get -qqy --no-install-recommends install nodejs -y \
+    && rm -f /var/cache/apt/archives/*.deb /var/cache/apt/archives/partial/*.deb \
+    && rm -f /var/cache/apt/*.bin \
+    && cd polkadot-launch \
+    && npm install \
+    && npm run build
+EXPOSE 9988
+ENTRYPOINT [ "node", "polkadot-launch/dist/index.js", "config.json" ]

docker/rococo.Dockerfile

@@ -0,0 +1,20 @@
+# syntax=docker/dockerfile:experimental
+#
+# Copyright 2021 ChainSafe Systems
+# SPDX-License-Identifier: LGPL-3.0-only
+#
+# rococo-v1
+FROM paritytech/ci-linux:production as builder
+COPY . .
+ENV CARGO_TERM_COLOR=always
+RUN --mount=type=cache,target=/usr/local/cargo/git \
+    --mount=type=cache,target=/usr/local/cargo/registry \
+    --mount=type=cache,sharing=private,target=target \
+    git clone https://github.com/paritytech/polkadot.git -b rococo-v1 --depth=1 \
+    && cd polkadot \
+    && cargo build --release \
+    && mv target/release/polkadot /polkadot
+
+# Only a binary for debian
+FROM scratch
+COPY --from=builder /polkadot /

docker/statemint.Dockerfile

@@ -0,0 +1,20 @@
+# syntax=docker/dockerfile:experimental
+#
+# Copyright 2021 ChainSafe Systems
+# SPDX-License-Identifier: LGPL-3.0-only
+#
+# statemint
+FROM paritytech/ci-linux:production as builder
+COPY . .
+ENV CARGO_TERM_COLOR=always
+RUN --mount=type=cache,target=/usr/local/cargo/git \
+    --mount=type=cache,target=/usr/local/cargo/registry \
+    --mount=type=cache,sharing=private,target=target \
+    git clone https://github.com/paritytech/statemint.git --depth=1 \
+    && cd statemint \
+    && cargo build --release \
+    && mv target/release/statemilnt /statemint
+
+# Only a binary for debian
+FROM scratch
+COPY --from=builder /statemint /

js/.prettierrc

@@ -0,0 +1,17 @@
+{
+  "tabWidth": 4,
+  "overrides": [
+    {
+      "files": "*.json",
+      "options": {
+        "tabWidth": 2
+      }
+    },
+    {
+      "files": ".prettierrc",
+      "options": {
+        "tabWidth": 2
+      }
+    }
+  ]
+}

js/e2e/README.md

@@ -0,0 +1,10 @@
+# E2E
+
+E2E tests for PINT
+
+This package will traverse all APIs provided written in the config
+
+
+## LICENSE
+
+GNU-v3

js/e2e/index.ts

@@ -0,0 +1,24 @@
+/**
+ * E2E tests for PINT
+ */
+import { Runner, Extrinsic } from "./src";
+import { ApiPromise } from "@polkadot/api";
+
+// Tests
+const TESTS = (api: ApiPromise): Extrinsic[] => [
+    {
+        pallet: "assetIndex",
+        call: "addAsset",
+        args: [
+            42,
+            1000000,
+            api.createType("AssetAvailability" as any),
+            1000000,
+        ],
+    },
+];
+
+// main
+(async () => {
+    await Runner.run(TESTS);
+})();

js/e2e/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@pint/e2e",
+  "version": "1.0.0",
+  "description": "E2E tests for PINT",
+  "main": "index.js",
+  "repository": "https://github.com/ChainSafe/PINT",
+  "author": "ChainSafe",
+  "license": "GNU-v3",
+  "private": true,
+  "devDependencies": {
+    "@polkadot/types": "^4.11.2",
+    "@types/node": "^15.3.1",
+    "ts-node": "^10.0.0",
+    "tslint": "^6.1.3",
+    "typescript": "^4.2.4"
+  },
+  "dependencies": {
+    "@pint/types": "^1.0.0",
+    "@polkadot/api": "^4.11.2",
+    "@polkadot/keyring": "^6.5.1",
+    "find-up": "^5.0.0"
+  },
+  "scripts": {
+    "start": "ts-node index.ts",
+    "build": "tsc --strict",
+    "lint": "tsc --noEmit --strict && tslint --project ./tsconfig.json"
+  }
+}

js/e2e/src/config.ts

@@ -0,0 +1,25 @@
+/**
+ * Config of E2E tests
+ */
+import { ApiPromise } from "@polkadot/api";
+import { KeyringPair } from "@polkadot/keyring/types";
+
+/**
+ * Extrinsic definition
+ */
+export interface Extrinsic {
+    pallet: string;
+    call: string;
+    args: any[];
+    block?: number;
+    timeout?: number;
+}
+
+/**
+ * The config of e2e tests
+ */
+export interface Config {
+    api: ApiPromise;
+    pair: KeyringPair;
+    exs: Extrinsic[];
+}

js/e2e/src/index.ts

@@ -0,0 +1,8 @@
+/**
+ * E2E tests for PINT
+ */
+import Runner from "./runner";
+import { Config, Extrinsic } from "./config";
+import * as Launch from "./launch";
+
+export { Config, Runner, Launch, Extrinsic };