some minor refactor (#1310)

BillyWooo · zhizming-zhong · jingleizhang · web-flow · commit 20041acef480 · 2023-02-14T20:09:34.000+01:00
* minor cleanup

* small refactor of ts test

* typo

* add missing mount file

* it makes sense to install nodejs+yarn for both worker and cli docker images.

* forth bash execution

* fix hardcode names

* try again

* Wait for node in resume-worker

* revert redundant install

* add missing jq - must be missed out when merging

---------

Co-authored-by: zhizming-zhong &lt;zhiming.zhong@litentry.com&gt;
Co-authored-by: ericzhang &lt;jingleizhang@users.noreply.github.com&gt;
Co-authored-by: Kailai Wang &lt;Kailai.Wang@hotmail.com&gt;
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -398,11 +398,11 @@ jobs:
           - test_name: demo-sidechain
           - test_name: sidechain-benchmark
           # Litentry
-          - test_name: user-shielding-key
-          - test_name: resume-worker
-          - test_name: set-heartbeat-timeout
-          - test_name: vc-test
-          - test_name: identity-test
+          - test_name: lit-user-shielding-key
+          - test_name: lit-resume-worker
+          - test_name: lit-set-heartbeat-timeout
+          - test_name: lit-vc-test
+          - test_name: lit-identity-test
 
     steps:
       - uses: actions/checkout@v3
@@ -441,17 +441,17 @@ jobs:
 
       - name: Integration Test ${{ matrix.test_name }}
         timeout-minutes: 30
-        if: ${{ matrix.test_name != 'resume-worker' }}
+        if: ${{ matrix.test_name != 'lit-resume-worker' }}
         run: |
           cd tee-worker/docker
           docker-compose -f docker-compose.yml -f ${{ matrix.test_name }}.yml up --no-build --exit-code-from ${{ matrix.test_name }} -- ${{ matrix.test_name }}
 
       - name: Integration Test ${{ matrix.test_name }}
         timeout-minutes: 30
-        if: ${{ matrix.test_name == 'resume-worker' }}
+        if: ${{ matrix.test_name == 'lit-resume-worker' }}
         run: |
           cd tee-worker/docker
-          docker-compose -f docker-compose.yml -f resume-worker.yml up --no-build --exit-code-from resume-worker --attach resume-worker relaychain-alice relaychain-bob integritee-node resume-worker
+          docker-compose -f docker-compose.yml -f ${{ matrix.test_name }}.yml up --no-build --exit-code-from ${{ matrix.test_name }} --attach ${{ matrix.test_name }} relaychain-alice relaychain-bob integritee-node ${{ matrix.test_name }}
 
       - name: Stop docker containers
         run: |
diff --git a/tee-worker/build.Dockerfile b/tee-worker/build.Dockerfile
@@ -85,6 +85,11 @@ FROM ubuntu:20.04 AS runner
 
 RUN apt update && apt install -y libssl-dev iproute2 curl
 
+## ts-tests
+RUN curl -fsSL https://deb.nodesource.com/setup_18.x | bash
+RUN apt-get install -y nodejs jq
+RUN npm install -g yarn
+
 
 ### Deployed CLI client
 ##################################################
@@ -101,11 +106,6 @@ RUN mkdir ${LOG_DIR}
 RUN ldd /usr/local/bin/integritee-cli && \
 	/usr/local/bin/integritee-cli --version
 
-## ts-tests
-RUN curl -fsSL https://deb.nodesource.com/setup_18.x | bash
-RUN apt-get install -y nodejs jq
-RUN npm install -g yarn
-
 ENTRYPOINT ["/usr/local/bin/integritee-cli"]
 
 
@@ -121,7 +121,6 @@ WORKDIR /usr/local/bin
 
 COPY --from=builder /opt/sgxsdk/lib64 /opt/sgxsdk/lib64
 COPY --from=builder /root/work/tee-worker/bin/* ./
-COPY --from=builder /root/work/tee-worker/local-setup/worker-config-*.json ./
 COPY --from=builder /lib/x86_64-linux-gnu /lib/x86_64-linux-gnu
 
 RUN touch spid.txt key.txt
diff --git a/tee-worker/cli/identity_test.sh b/tee-worker/cli/identity_test.sh
diff --git a/tee-worker/cli/lit_set_heartbeat_timeout.sh b/tee-worker/cli/lit_set_heartbeat_timeout.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# Copyright 2020-2023 Litentry Technologies GmbH.
+
 while getopts ":p:A:B:u:W:V:C:" opt; do
     case $opt in
         p)
diff --git a/tee-worker/cli/lit_ts_test.sh b/tee-worker/cli/lit_ts_test.sh
@@ -0,0 +1,24 @@
+#!/bin/bash
+
+# Copyright 2020-2023 Litentry Technologies GmbH.
+
+set -euo pipefail
+
+function usage() {
+    echo "Usage: $0 <Options>"
+    echo ""
+    echo "This is a script for tee-worker ts-test. Current available Options:"
+    echo "  test-identity: "
+    echo "  test-vc: "
+    echo "  test-resuming-worker: "
+    echo ""
+    echo "Please try to extend the above list when adding new ts-test."
+}
+
+[ $# -ne 1 ] && (usage; exit 1)
+TEST=$1
+
+cd /ts-tests
+
+yarn install
+yarn run $TEST:staging
diff --git a/tee-worker/cli/lit_user_shielding_key.sh b/tee-worker/cli/lit_user_shielding_key.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# Copyright 2020-2023 Litentry Technologies GmbH.
+
 while getopts ":p:A:B:u:W:V:C:" opt; do
     case $opt in
         p)
diff --git a/tee-worker/cli/vc_test.sh b/tee-worker/cli/vc_test.sh
diff --git a/tee-worker/docker/lit-identity-test.yml b/tee-worker/docker/lit-identity-test.yml
@@ -1,7 +1,7 @@
 services:
-  vc-test:
+  lit-identity-test:
     image: integritee-cli:dev
-    container_name: integritee-vc-test
+    container_name: litentry-identity-test
     volumes:
       - ../ts-tests:/ts-tests
       - ../cli:/usr/local/worker-cli
@@ -19,7 +19,7 @@ services:
     networks:
       - integritee-test-network
     entrypoint:
-      "/usr/local/worker-cli/vc_test.sh 2>&1"
+      "bash -c '/usr/local/worker-cli/lit_ts_test.sh test-identity 2>&1' "
     restart: "no"
 networks:
   integritee-test-network:
diff --git a/tee-worker/docker/lit-resume-worker.yml b/tee-worker/docker/lit-resume-worker.yml
@@ -1,10 +1,10 @@
 services:
-  resume-worker:
+  lit-resume-worker:
     image: integritee-worker:dev
-    container_name: integritee-worker
+    container_name: litentry-worker
     volumes:
       - ../ts-tests:/ts-tests
-      - ../scripts/install_node.sh:/install_node.sh
+      - ../cli:/usr/local/worker-cli
     build:
       context: ..
       dockerfile: build.Dockerfile
@@ -14,7 +14,8 @@ services:
         condition: service_healthy
     networks:
       - integritee-test-network
-    entrypoint: "bash -c '/install_node.sh && cd /ts-tests && yarn install && yarn run test-resuming-worker:staging'"
+    entrypoint:
+      "bash -c '/usr/local/worker-cli/lit_ts_test.sh test-resuming-worker 2>&1' "
     restart: "no"
 networks:
   integritee-test-network:
diff --git a/tee-worker/docker/lit-set-heartbeat-timeout.yml b/tee-worker/docker/lit-set-heartbeat-timeout.yml
@@ -1,5 +1,5 @@
 services:
-  set-heartbeat-timeout:
+  lit-set-heartbeat-timeout:
     image: integritee-cli:dev
     container_name: litentry-set-heartbeat-timeout
     volumes:
@@ -18,7 +18,7 @@ services:
     networks:
       - integritee-test-network
     entrypoint:
-      "/usr/local/worker-cli/set_heartbeat_timeout.sh -p 9912 -u ws://integritee-node
+      "/usr/local/worker-cli/lit_set_heartbeat_timeout.sh -p 9912 -u ws://integritee-node
       -V wss://integritee-worker-1 -A 2011 -W wss://integritee-worker-2 -B 2012 -C /usr/local/bin/integritee-cli 2>&1"
     restart: "no"
 networks:
diff --git a/tee-worker/docker/lit-user-shielding-key.yml b/tee-worker/docker/lit-user-shielding-key.yml
@@ -1,5 +1,5 @@
 services:
-  user-shielding-key:
+  lit-user-shielding-key:
     image: integritee-cli:dev
     container_name: litentry-user-shielding-key
     volumes:
@@ -18,7 +18,7 @@ services:
     networks:
       - integritee-test-network
     entrypoint:
-      "/usr/local/worker-cli/user_shielding_key.sh -p 9912 -u ws://integritee-node
+      "/usr/local/worker-cli/lit_user_shielding_key.sh -p 9912 -u ws://integritee-node
       -V wss://integritee-worker-1 -A 2011 -W wss://integritee-worker-2 -B 2012 -C /usr/local/bin/integritee-cli 2>&1"
     restart: "no"
 networks:
diff --git a/tee-worker/docker/lit-vc-test.yml b/tee-worker/docker/lit-vc-test.yml
@@ -1,7 +1,7 @@
 services:
-  identity-test:
+  lit-vc-test:
     image: integritee-cli:dev
-    container_name: integritee-identity-test
+    container_name: litentry-vc-test
     volumes:
       - ../ts-tests:/ts-tests
       - ../cli:/usr/local/worker-cli
@@ -19,7 +19,7 @@ services:
     networks:
       - integritee-test-network
     entrypoint:
-      "/usr/local/worker-cli/identity_test.sh 2>&1"
+      "bash -c '/usr/local/worker-cli/lit_ts_test.sh test-vc 2>&1' "
     restart: "no"
 networks:
   integritee-test-network:
diff --git a/tee-worker/local-setup/launch.py b/tee-worker/local-setup/launch.py
@@ -25,10 +25,10 @@
 node_log = open(f'{log_dir}/node.log', 'w+')
 
 
-def setup_worker(work_dir: str, source_dir: str, config_dir: str, std_err: Union[None, int, IO]):
+def setup_worker(work_dir: str, source_dir: str, std_err: Union[None, int, IO]):
     print(f'Setting up worker in {work_dir}')
     print(f'Copying files from {source_dir}')
-    worker = Worker(cwd=work_dir, source_dir=source_dir, config_dir=config_dir, std_err=std_err)
+    worker = Worker(cwd=work_dir, source_dir=source_dir, std_err=std_err)
     worker.init_clean()
     print('Initialized worker.')
     return worker
@@ -37,7 +37,7 @@ def setup_worker(work_dir: str, source_dir: str, config_dir: str, std_err: Union
 def run_worker(config, i: int):
     log = open(f'{log_dir}/worker{i}.log', 'w+')
     # TODO: either hard-code 'local-setup' directory, or take from input config.json
-    w = setup_worker(f'tmp/w{i}', config["source"], f'local-setup', log)
+    w = setup_worker(f'tmp/w{i}', config["source"], log)
 
     print(f'Starting worker {i} in background')
     return w.run_in_background(log_file=log, flags=config["flags"], subcommand_flags=config["subcommand_flags"])
diff --git a/tee-worker/local-setup/py/helpers.py b/tee-worker/local-setup/py/helpers.py
@@ -45,11 +45,6 @@ def setup_working_dir(source_dir: str, target_dir: str):
         else:
             print(f'{source} does not exist. Did you run make?')
 
-def copy_config_files(source_dir: str, target_dir: str):
-    files_to_copy = ['worker-config-dev.json', 'worker-config-mock.json', 'worker-config-prod.json', 'worker-config-staging.json']
-    [shutil.copy(f'{source_dir}/{f}', f'{target_dir}/{f}') for f in files_to_copy]
-
-
 def mkdir_p(path):
     """ Surprisingly, there is no simple function in python to create a dir if it does not exist."""
     return subprocess.run(['mkdir', '-p', path])
diff --git a/tee-worker/local-setup/py/worker.py b/tee-worker/local-setup/py/worker.py
@@ -5,15 +5,14 @@
 from subprocess import Popen, STDOUT
 from typing import Union, TextIO, IO
 
-from .helpers import run_subprocess, setup_working_dir, copy_config_files, mkdir_p
+from .helpers import run_subprocess, setup_working_dir, mkdir_p
 
 
 class Worker:
     def __init__(self,
                  worker_bin: str = './integritee-service',
                  cwd: str = './',
                  source_dir: str = './',
-                 config_dir: str = './',
                  std_err: Union[None, int, IO] = STDOUT,
                  ):
         """
@@ -36,15 +35,13 @@ def __init__(self,
         self.cwd = cwd
         self.cli = [worker_bin]
         self.source_dir = source_dir
-        self.config_dir = config_dir
         self.std_err = std_err
         # cache fields
         self._mrenclave = None
 
     def setup_cwd(self):
         mkdir_p(self.cwd)
         setup_working_dir(self.source_dir, self.cwd)
-        copy_config_files(self.config_dir, self.cwd)
 
     def init_clean(self):
         """ Purges all db files first and initializes the environment afterwards. """
diff --git a/tee-worker/scripts/install_node.sh b/tee-worker/scripts/install_node.sh
diff --git a/tee-worker/scripts/launch.sh b/tee-worker/scripts/launch.sh
@@ -7,12 +7,13 @@ ROOTDIR=$(git rev-parse --show-toplevel)
 ROOTDIR="${ROOTDIR}/tee-worker"
 
 function usage() {
-    echo "Usage: $0 <dev|staging|prod/mock>"
+    echo "Usage: $0 <dev|staging|prod|mock>"
     echo ""
     echo "  All mode apply to ${PARACHAIN} context."
     echo "      dev: start worker(s) together with local ${PARACHAIN} for development"
     echo "  staging: start worker(s) sync with staging ${PARACHAIN} on tee-staging server"
     echo "     prod: start worker(s) sync with production ${PARACHAIN} on polkadot.js"
+    echo "     mock: start worker(s) together with local ${PARACHAIN} for development"
 }
 
 function start_local_parachain() {
@@ -24,7 +25,7 @@ function start_local_parachain() {
 }
 
 function start_worker_for_dev() {
-    # start_local_parachain
+    start_local_parachain
     cd ${ROOTDIR}
     worker_num=2
     echo "------------------------------------------------------------"
@@ -36,7 +37,7 @@ function start_worker_for_staging() {
     cd ${ROOTDIR}
     worker_num=2
     # staging_parachain_url
-    url="wss://parachain-eu-0.staging.litentry.io"
+    url="wss://tee-staging.litentry.io"
     # staging_parachain_port
     port=443
     echo "------------------------------------------------------------"
@@ -57,7 +58,7 @@ function start_worker_for_prod() {
 }
 
 function start_worker_for_mock() {
-    # start_local_parachain
+    start_local_parachain
     cd ${ROOTDIR}
     worker_num=2
     echo "------------------------------------------------------------"
diff --git a/tee-worker/service/src/cli.yml b/tee-worker/service/src/cli.yml
@@ -85,7 +85,7 @@ args:
         help: Cleans and purges any previous state and key files and generates them anew before starting.
     - running-mode:
         long: running-mode
-        help: Litentry TEE service running mode <dev/staging/prod/mock>
+        help: Litentry TEE service running mode <dev|staging|prod|mock>
         takes_value: true
         default_value: "dev"
     - enable-mock-server:
diff --git a/tee-worker/service/src/config.rs b/tee-worker/service/src/config.rs
@@ -27,7 +27,7 @@ static DEFAULT_UNTRUSTED_PORT: &str = "2001";
 static DEFAULT_MU_RA_PORT: &str = "3443";
 static DEFAULT_METRICS_PORT: &str = "8787";
 static DEFAULT_UNTRUSTED_HTTP_PORT: &str = "4545";
-// running mode for litentry: dev / staging / prod / local
+// running mode for litentry: dev | staging | prod | mock
 static DEFAULT_RUNNING_MODE: &str = "dev";
 static DEFAULT_MOCK_SERVER_PORT: &str = "9527";
 
diff --git a/tee-worker/service/src/main.rs b/tee-worker/service/src/main.rs
@@ -830,7 +830,7 @@ fn check_we_are_primary_validateer(
 }
 
 fn data_provider(config: &Config) -> DataProvidersStatic {
-	let built_in_modes = vec!["dev", "mock", "prod", "staging"];
+	let built_in_modes = vec!["dev", "staging", "prod", "mock"];
 	let built_in_config: Value =
 		serde_json::from_slice(include_bytes!("running-mode-config.json")).unwrap();
 
