git.delta.rocks / unique-network / refs/commits / 3cddb472af6f

difftreelog

Merge pull request #666 from UniqueNetwork/rapid-parallel-start-v2-docs

Alex2022-10-19parents: #a63e642 #8d84680.patch.diff
in: master
Rapid parallel start v2 docs

13 files changed

modified.github/workflows/ci-develop.ymldiffbeforeafterboth
--- a/.github/workflows/ci-develop.yml
+++ b/.github/workflows/ci-develop.yml
@@ -1,51 +1,55 @@
+# Workflow which controls starts nested workflows.
 name: develop
 
+# Triger: PR at 'develop' branch with following types of events.
 on:
   pull_request:
     branches: [ 'develop' ]
     types: [ opened, reopened, synchronize, ready_for_review, converted_to_draft ]
 
+#Concurency group for control execution queue over github runners.
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref }}
   cancel-in-progress: true
 
+# List of a jobs included into Workflow.
 jobs:
 
   yarn-test-dev:
-    if: github.event.pull_request.draft == false
+    if: github.event.pull_request.draft == false                                                                             # Conditional check for draft per job.
     uses: ./.github/workflows/dev-build-tests_v2.yml
 
 
   unit-test:
-    if: github.event.pull_request.draft == false
+    if: github.event.pull_request.draft == false                                                                             # Conditional check for draft per job.
     uses: ./.github/workflows/unit-test_v2.yml
 
   canary:
-    if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'canary')) }}
+    if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'canary')) }}    # Conditional check for draft & labels per job.
     uses: ./.github/workflows/canary.yml
-    secrets: inherit # pass all secrets
+    secrets: inherit # pass all secrets from initial workflow to nested
 
   xcm:
-    if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'xcm')) }}
+    if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'xcm')) }}       # Conditional check for draft & labels per job.
     uses: ./.github/workflows/xcm.yml
-    secrets: inherit # pass all secrets
+    secrets: inherit # pass all secrets from initial workflow to nested
     
   forkless:
-    if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'forkless')) }}
+    if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'forkless')) }}  # Conditional check for draft & labels per job.
     uses: ./.github/workflows/forkless.yml
   
   node-only-update:
-    if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'forkless')) }}
+    if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'forkless')) }}  # Conditional check for draft & labels per job.
     uses: ./.github/workflows/node-only-update_v2.yml
     
   parallel_and_sequential_tests:
-    if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'para')) }}
+    if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'para')) }}      # Conditional check for draft & labels per job.
     uses: ./.github/workflows/node-only-update_v3.yml
 
   codestyle:
-    if: github.event.pull_request.draft == false
+    if: github.event.pull_request.draft == false                                                                             # Conditional check for draft per job.
     uses: ./.github/workflows/codestyle_v2.yml
   
   yarn_eslint:
-    if: github.event.pull_request.draft == false
+    if: github.event.pull_request.draft == false                                                                             # Conditional check for draft per job.
     uses: ./.github/workflows/test_codestyle_v2.yml
modified.github/workflows/ci-master.ymldiffbeforeafterboth
--- a/.github/workflows/ci-master.yml
+++ b/.github/workflows/ci-master.yml
@@ -1,14 +1,18 @@
+# Workflow which controls starts nested workflows.
 name: master
 
+# Triger: PR at 'master' branch with following types of events.
 on:
   pull_request:
     branches: [ 'master' ]
     types: [ opened, reopened, synchronize, ready_for_review ]
 
+#Concurency group for control execution queue over github runners.
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref }}
   cancel-in-progress: true
 
+# List of a jobs included into Workflow.
 jobs:
 
   unit-test:
@@ -22,11 +26,11 @@
 
   canary:
     uses: ./.github/workflows/canary.yml
-    secrets: inherit # pass all secrets
+    secrets: inherit # pass all secrets from initial workflow to nested
 
   xcm:
     uses: ./.github/workflows/xcm.yml
-    secrets: inherit # pass all secrets
+    secrets: inherit # pass all secrets from initial workflow to nested
 
   codestyle:
-    uses: ./.github/workflows/codestyle_v2.yml
\ No newline at end of file
+    uses: ./.github/workflows/codestyle_v2.yml
modified.github/workflows/codestyle_v2.ymldiffbeforeafterboth
--- a/.github/workflows/codestyle_v2.yml
+++ b/.github/workflows/codestyle_v2.yml
@@ -1,5 +1,8 @@
+# Nested workflow for checks related to formatting Rust code 
+
 name: cargo fmt
 
+# Triger: only call from main workflow(re-usable workflows)
 on:
   workflow_call:
 
modified.github/workflows/dev-build-tests_v2.ymldiffbeforeafterboth
--- a/.github/workflows/dev-build-tests_v2.yml
+++ b/.github/workflows/dev-build-tests_v2.yml
@@ -1,8 +1,9 @@
+# Integration test in --dev mode
+# https://cryptousetech.atlassian.net/browse/CI-12
 name: yarn test dev
 
-# Controls when the action will run.
+# Triger: only call from main workflow(re-usable workflows)
 on:
- # Triggers the workflow on push or pull request events but only for the master branch
   workflow_call:
 
 
@@ -101,4 +102,4 @@
         run: |
           docker builder prune -f -a
           docker system prune -f
-          docker image prune -f -a
\ No newline at end of file
+          docker image prune -f -a
modified.github/workflows/forkless-update-data_v2.ymldiffbeforeafterboth
--- a/.github/workflows/forkless-update-data_v2.yml
+++ b/.github/workflows/forkless-update-data_v2.yml
@@ -1,11 +1,10 @@
-# Controls when the action will run.
+# Forkless update with data replication
+# https://cryptousetech.atlassian.net/browse/CI-42
+
+# Triger: only call from main workflow(re-usable workflows)
 on:
   workflow_call:
-
 
-#Define Workflow variables
-env:
-  REPO_URL: ${{ github.server_url }}/${{ github.repository }}
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
@@ -163,3 +162,10 @@
       - name: Stop running containers
         if: always()                   # run this step always
         run: docker-compose -f ".docker/docker-compose-forkless.yml" -f ".docker/docker-compose.${{ matrix.network }}.yml" down --volumes
+        
+      - name: Remove builder cache
+        if: always()                   # run this step always
+        run: |
+          docker builder prune -f -a
+          docker system prune -f
+          docker image prune -f -a
modified.github/workflows/forkless-update-nodata_v2.ymldiffbeforeafterboth
before · .github/workflows/forkless-update-nodata_v2.yml
123# Controls when the action will run.4on:5  workflow_call:678#Define Workflow variables9env:10  REPO_URL: ${{ github.server_url }}/${{ github.repository }}1112# A workflow run is made up of one or more jobs that can run sequentially or in parallel13jobs:14  execution-marix:1516    name: Prepare execution matrix1718    runs-on: self-hosted-ci19    outputs:20      matrix: ${{ steps.create_matrix.outputs.matrix }}2122    steps:2324      - name: Clean Workspace25        uses: AutoModality/action-clean@v1.1.02627      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it28      - uses: actions/checkout@v329        with:30          ref: ${{ github.head_ref }}  #Checking out head commit3132      - name: Read .env file33        uses: xom9ikk/dotenv@v1.0.23435      - name: Create Execution matrix36        uses: CertainLach/create-matrix-action@v337        id: create_matrix38        with:39          matrix: |40            network {opal}, runtime {opal}, features {opal-runtime}, mainnet_branch {${{ env.OPAL_MAINNET_TAG }}}41            network {quartz}, runtime {quartz}, features {quartz-runtime}, mainnet_branch {${{ env.QUARTZ_MAINNET_TAG }}}42            network {unique}, runtime {unique}, features {unique-runtime}, mainnet_branch {${{ env.UNIQUE_MAINNET_TAG }}}434445  forkless-update-nodata:46    needs: execution-marix47    # The type of runner that the job will run on48    runs-on: [self-hosted-ci,large]4950    timeout-minutes: 13805152    name: ${{ matrix.network }}5354    continue-on-error: true         #Do not stop testing of matrix runs failed.  As it decided during PR review - it required 50/50& Let's check it with false.5556    strategy:57      matrix:58        include: ${{fromJson(needs.execution-marix.outputs.matrix)}}    5960    steps:61      - name: Clean Workspace62        uses: AutoModality/action-clean@v1.1.06364      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it65      - uses: actions/checkout@v366        with:67          ref: ${{ github.head_ref }}  #Checking out head commit6869      - name: Read .env file70        uses: xom9ikk/dotenv@v1.0.27172      - name: Generate ENV related extend file for docker-compose73        uses: cuchi/jinja2-action@v1.2.074        with:75          template: .docker/docker-compose.tmp-forkless-nodata.j276          output_file: .docker/docker-compose.${{ matrix.network }}.yml77          variables: |78            REPO_URL=${{ github.server_url }}/${{ github.repository }}.git79            RUST_TOOLCHAIN=${{ env.RUST_TOOLCHAIN }}80            POLKADOT_BUILD_BRANCH=${{ env.POLKADOT_BUILD_BRANCH }}81            POLKADOT_MAINNET_BRANCH=${{ env.POLKADOT_MAINNET_BRANCH }}82            MAINNET_TAG=${{ matrix.mainnet_tag }}83            MAINNET_BRANCH=${{ matrix.mainnet_branch }}84            FEATURE=${{ matrix.features }}85            RUNTIME=${{ matrix.runtime }}86            BRANCH=${{ github.head_ref }}8788      - name: Show build configuration89        run: cat .docker/docker-compose.${{ matrix.network }}.yml9091      - name: Generate launch-config-forkless-nodata.json92        uses: cuchi/jinja2-action@v1.2.093        with:94          template: .docker/forkless-config/launch-config-forkless-nodata.j295          output_file: .docker/launch-config-forkless-nodata.json96          variables: |97            FEATURE=${{ matrix.features }}98            RUNTIME=${{ matrix.runtime }}99100      - name: Show launch-config-forkless configuration101        run: cat .docker/launch-config-forkless-nodata.json102103      - uses: actions/setup-node@v3104        with:105          node-version: 16106107      - name: Build the stack108        run: docker-compose -f ".docker/docker-compose-forkless.yml" -f ".docker/docker-compose.${{ matrix.network }}.yml" up -d --build  --force-recreate --timeout 300109110      - name: Check if docker logs consist logs related to Runtime Upgrade testing.111        if: success()112        run: |113          counter=160114          function check_container_status {115                docker inspect -f {{.State.Running}} node-parachain116          }117          function do_docker_logs {118                docker logs --details node-parachain  2>&1119          }120          function is_started {121                if [ "$(check_container_status)" == "true" ]; then122                        echo "Container: node-parachain RUNNING";123                        echo "Check Docker logs"124                        DOCKER_LOGS=$(do_docker_logs)125                        if [[ ${DOCKER_LOGS} = *"🛸 PARACHAINS' RUNTIME UPGRADE TESTING COMPLETE 🛸"* ]];then126                                echo "🛸 PARACHAINS' RUNTIME UPGRADE TESTING COMPLETE 🛸"127                                return 0128                        elif [[ ${DOCKER_LOGS} = *"🚧 PARACHAINS' RUNTIME UPGRADE TESTING FAILED 🚧"* ]];then129                                echo "🚧 PARACHAINS' RUNTIME UPGRADE TESTING FAILED 🚧"130                                return 1131                        else132                                echo "Message not found in logs output, repeating..."133                                return 1134                        fi135                else136                        echo "Container node-parachain not RUNNING"137                        echo "Halting all future checks"138                        exit 1139                fi140          exit 0141          }142          while ! is_started; do143                echo "Waiting for special message in log files "144                sleep 30s145                counter=$(( $counter - 1 ))146                echo "Counter: $counter"147                if [ "$counter" -gt "0" ]; then148                         continue149                else150                         break151                fi152          done153          echo "Halting script"154          exit 0155        shell: bash156157      - name: Collect Docker Logs158        if: success() || failure()159        uses: jwalton/gh-docker-logs@v2.2.0160        with:161          dest: './forkless-parachain-upgrade-nodata-logs.${{ matrix.features }}'162          images: 'node-parachain'163164      - name: Show docker logs165        if: success() || failure()166        run: cat './forkless-parachain-upgrade-nodata-logs.${{ matrix.features }}/node-parachain.log'167                168      - name: Run Parallel tests 169        working-directory: tests170        run: |171          yarn install172          yarn add mochawesome173          node scripts/readyness.js174          echo "Ready to start tests"175          yarn polkadot-types176          NOW=$(date +%s) && yarn testParallel --reporter mochawesome --reporter-options reportFilename=test-parallel-${NOW}177        env:178          RPC_URL: http://127.0.0.1:9933/179    180      - name: Test Report Parallel181        uses: phoenix-actions/test-reporting@v8182        id: test-report-parallel183        if: success() || failure()    # run this step even if previous step failed184        with:185          name: Report Parallel tests results - ${{ matrix.network }}            # Name of the check run which will be created186          path: tests/mochawesome-report/test-parallel-*.json    # Path to test results187          reporter: mochawesome-json188          fail-on-error: 'false'189          190      - name: Run Sequential tests 191        working-directory: tests192        if: success() || failure() 193        run: |194          yarn install195          yarn add mochawesome196          node scripts/readyness.js197          echo "Ready to start tests"198          yarn polkadot-types199          NOW=$(date +%s) && yarn testSequential --reporter mochawesome --reporter-options reportFilename=test-sequential-${NOW}200        env:201          RPC_URL: http://127.0.0.1:9933/202    203      - name: Test Report Sequential204        uses: phoenix-actions/test-reporting@v8205        id: test-report-sequential206        if: success() || failure()    # run this step even if previous step failed207        with:208          name: Report Sequential tests results - ${{ matrix.network }}            # Name of the check run which will be created209          path: tests/mochawesome-report/test-sequential-*.json    # Path to test results210          reporter: mochawesome-json211          fail-on-error: 'false'212213      - name: Stop running containers214        if: always()                   # run this step always215        run: docker-compose -f ".docker/docker-compose-forkless.yml" -f ".docker/docker-compose.${{ matrix.network }}.yml" down
modified.github/workflows/forkless.ymldiffbeforeafterboth
--- a/.github/workflows/forkless.yml
+++ b/.github/workflows/forkless.yml
@@ -1,3 +1,5 @@
+# Intermediate Nested Workflow for calling subworkflows as a parallel tasks.
+
 name: Nesting Forkless
 
 on:
modified.github/workflows/market-test_v2.ymldiffbeforeafterboth
--- a/.github/workflows/market-test_v2.yml
+++ b/.github/workflows/market-test_v2.yml
@@ -1,3 +1,6 @@
+#https://cryptousetech.atlassian.net/browse/CI-37
+# Nested workflow for lunching Market e2e tests from external repository https://github.com/UniqueNetwork/market-e2e-tests
+
 name: market api tests
 
 # Controls when the action will run.
@@ -22,14 +25,8 @@
         include:
           - network: "opal"
             features: "opal-runtime"
-#          - network: "quartz"
-#            features: "quartz-runtime"
-#          - network: "unique"
-#            features: "unique-runtime"
 
     steps:
-
-
       - name: Clean Workspace
         uses: AutoModality/action-clean@v1.1.0
 
@@ -188,10 +185,3 @@
         run: |
           docker builder prune -f
           docker system prune -f
-
-      - name: Clean Workspace
-        if: always()
-        uses: AutoModality/action-clean@v1.1.0
-
-
-
modified.github/workflows/node-only-update_v2.ymldiffbeforeafterboth
--- a/.github/workflows/node-only-update_v2.yml
+++ b/.github/workflows/node-only-update_v2.yml
@@ -1,12 +1,13 @@
+# https://cryptousetech.atlassian.net/browse/CI-85
+# Node only update with restart polkadot-launch process.
+
 name: nodes-only update
 
-# Controls when the action will run.
+# Triger: only call from main workflow(re-usable workflows)
 on:
   workflow_call:
-#Define Workflow variables
-env:
-  REPO_URL: ${{ github.server_url }}/${{ github.repository }}
 
+
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
 
modified.github/workflows/node-only-update_v3.ymldiffbeforeafterboth
--- a/.github/workflows/node-only-update_v3.yml
+++ b/.github/workflows/node-only-update_v3.yml
@@ -1,6 +1,7 @@
+# Test workflow for debug parallel and sequental tests in scope of execution time reducing.
 name: Parallele tests
 
-# Controls when the action will run.
+# Triger: only call from main workflow(re-usable workflows)
 on:
   workflow_call:
 #Define Workflow variables
modified.github/workflows/test_codestyle_v2.ymldiffbeforeafterboth
--- a/.github/workflows/test_codestyle_v2.yml
+++ b/.github/workflows/test_codestyle_v2.yml
@@ -1,5 +1,8 @@
+# Yarn Eslint over tests
+#
 name: yarn eslint
 
+# Triger: only call from main workflow(re-usable workflows)
 on:
   workflow_call:
 
modified.github/workflows/try-runtime_v2.ymldiffbeforeafterboth
--- a/.github/workflows/try-runtime_v2.yml
+++ b/.github/workflows/try-runtime_v2.yml
@@ -1,3 +1,7 @@
+# Try-runtime checks
+# https://cryptousetech.atlassian.net/browse/CI-38
+
+# Triger: only call from main workflow(re-usable workflows)
 on:
   workflow_call:
 
@@ -66,3 +70,10 @@
       - name: Stop running containers
         if: always()                   # run this step always
         run: docker-compose -f ".docker/docker-compose-try-runtime.yml" -f ".docker/docker-compose.try-runtime.${{ matrix.network }}.yml" down
+        
+      - name: Remove builder cache
+        if: always()                   # run this step always
+        run: |
+          docker builder prune -f -a
+          docker system prune -f
+          docker image prune -f -a
modified.github/workflows/unit-test_v2.ymldiffbeforeafterboth
--- a/.github/workflows/unit-test_v2.yml
+++ b/.github/workflows/unit-test_v2.yml
@@ -1,8 +1,9 @@
+# Re-Usable Workflow for lanching Unit tests
 name: unit tests
 
 # Controls when the action will run.
+# Triger: only call from main workflow(re-usable workflows)
 on:
- # Triggers the workflow on push or pull request events but only for the master branch
   workflow_call:
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
@@ -49,3 +50,10 @@
       - name: Stop running containers
         if: always()                   # run this step always
         run: docker-compose -f ".docker/docker-compose-dev.yaml" -f ".docker/docker-compose.unit.yml" down
+        
+      - name: Remove builder cache
+        if: always()                   # run this step always
+        run: |
+          docker builder prune -f -a
+          docker system prune -f
+          docker image prune -f -a