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
after · .github/workflows/forkless-update-nodata_v2.yml
1# Forkless update without data replication2# https://cryptousetech.atlassian.net/browse/CI-4134# Triger: only call from main workflow(re-usable workflows)5on:6  workflow_call:789#Define Workflow variables10env:11  REPO_URL: ${{ github.server_url }}/${{ github.repository }}1213# A workflow run is made up of one or more jobs that can run sequentially or in parallel14jobs:15  execution-marix:1617    name: Prepare execution matrix1819    runs-on: self-hosted-ci20    outputs:21      matrix: ${{ steps.create_matrix.outputs.matrix }}2223    steps:2425      - name: Clean Workspace26        uses: AutoModality/action-clean@v1.1.02728      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it29      - uses: actions/checkout@v330        with:31          ref: ${{ github.head_ref }}  #Checking out head commit3233      - name: Read .env file34        uses: xom9ikk/dotenv@v1.0.23536      - name: Create Execution matrix37        uses: CertainLach/create-matrix-action@v338        id: create_matrix39        with:40          matrix: |41            network {opal}, runtime {opal}, features {opal-runtime}, mainnet_branch {${{ env.OPAL_MAINNET_TAG }}}42            network {quartz}, runtime {quartz}, features {quartz-runtime}, mainnet_branch {${{ env.QUARTZ_MAINNET_TAG }}}43            network {unique}, runtime {unique}, features {unique-runtime}, mainnet_branch {${{ env.UNIQUE_MAINNET_TAG }}}444546  forkless-update-nodata:47    needs: execution-marix48    # The type of runner that the job will run on49    runs-on: [self-hosted-ci,large]5051    timeout-minutes: 13805253    name: ${{ matrix.network }}5455    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.5657    strategy:58      matrix:59        include: ${{fromJson(needs.execution-marix.outputs.matrix)}}    6061    steps:62      - name: Clean Workspace63        uses: AutoModality/action-clean@v1.1.06465      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it66      - uses: actions/checkout@v367        with:68          ref: ${{ github.head_ref }}  #Checking out head commit6970      - name: Read .env file71        uses: xom9ikk/dotenv@v1.0.27273      - name: Generate ENV related extend file for docker-compose74        uses: cuchi/jinja2-action@v1.2.075        with:76          template: .docker/docker-compose.tmp-forkless-nodata.j277          output_file: .docker/docker-compose.${{ matrix.network }}.yml78          variables: |79            REPO_URL=${{ github.server_url }}/${{ github.repository }}.git80            RUST_TOOLCHAIN=${{ env.RUST_TOOLCHAIN }}81            POLKADOT_BUILD_BRANCH=${{ env.POLKADOT_BUILD_BRANCH }}82            POLKADOT_MAINNET_BRANCH=${{ env.POLKADOT_MAINNET_BRANCH }}83            MAINNET_TAG=${{ matrix.mainnet_tag }}84            MAINNET_BRANCH=${{ matrix.mainnet_branch }}85            FEATURE=${{ matrix.features }}86            RUNTIME=${{ matrix.runtime }}87            BRANCH=${{ github.head_ref }}8889      - name: Show build configuration90        run: cat .docker/docker-compose.${{ matrix.network }}.yml9192      - name: Generate launch-config-forkless-nodata.json93        uses: cuchi/jinja2-action@v1.2.094        with:95          template: .docker/forkless-config/launch-config-forkless-nodata.j296          output_file: .docker/launch-config-forkless-nodata.json97          variables: |98            FEATURE=${{ matrix.features }}99            RUNTIME=${{ matrix.runtime }}100101      - name: Show launch-config-forkless configuration102        run: cat .docker/launch-config-forkless-nodata.json103104      - uses: actions/setup-node@v3105        with:106          node-version: 16107108      - name: Build the stack109        run: docker-compose -f ".docker/docker-compose-forkless.yml" -f ".docker/docker-compose.${{ matrix.network }}.yml" up -d --build  --force-recreate --timeout 300110111      - name: Check if docker logs consist logs related to Runtime Upgrade testing.112        if: success()113        run: |114          counter=160115          function check_container_status {116                docker inspect -f {{.State.Running}} node-parachain117          }118          function do_docker_logs {119                docker logs --details node-parachain  2>&1120          }121          function is_started {122                if [ "$(check_container_status)" == "true" ]; then123                        echo "Container: node-parachain RUNNING";124                        echo "Check Docker logs"125                        DOCKER_LOGS=$(do_docker_logs)126                        if [[ ${DOCKER_LOGS} = *"🛸 PARACHAINS' RUNTIME UPGRADE TESTING COMPLETE 🛸"* ]];then127                                echo "🛸 PARACHAINS' RUNTIME UPGRADE TESTING COMPLETE 🛸"128                                return 0129                        elif [[ ${DOCKER_LOGS} = *"🚧 PARACHAINS' RUNTIME UPGRADE TESTING FAILED 🚧"* ]];then130                                echo "🚧 PARACHAINS' RUNTIME UPGRADE TESTING FAILED 🚧"131                                return 1132                        else133                                echo "Message not found in logs output, repeating..."134                                return 1135                        fi136                else137                        echo "Container node-parachain not RUNNING"138                        echo "Halting all future checks"139                        exit 1140                fi141          exit 0142          }143          while ! is_started; do144                echo "Waiting for special message in log files "145                sleep 30s146                counter=$(( $counter - 1 ))147                echo "Counter: $counter"148                if [ "$counter" -gt "0" ]; then149                         continue150                else151                         break152                fi153          done154          echo "Halting script"155          exit 0156        shell: bash157158      - name: Collect Docker Logs159        if: success() || failure()160        uses: jwalton/gh-docker-logs@v2.2.0161        with:162          dest: './forkless-parachain-upgrade-nodata-logs.${{ matrix.features }}'163          images: 'node-parachain'164165      - name: Show docker logs166        if: success() || failure()167        run: cat './forkless-parachain-upgrade-nodata-logs.${{ matrix.features }}/node-parachain.log'168                169      - name: Run Parallel tests 170        working-directory: tests171        run: |172          yarn install173          yarn add mochawesome174          node scripts/readyness.js175          echo "Ready to start tests"176          yarn polkadot-types177          NOW=$(date +%s) && yarn testParallel --reporter mochawesome --reporter-options reportFilename=test-parallel-${NOW}178        env:179          RPC_URL: http://127.0.0.1:9933/180    181      - name: Test Report Parallel182        uses: phoenix-actions/test-reporting@v8183        id: test-report-parallel184        if: success() || failure()    # run this step even if previous step failed185        with:186          name: Report Parallel tests results - ${{ matrix.network }}            # Name of the check run which will be created187          path: tests/mochawesome-report/test-parallel-*.json    # Path to test results188          reporter: mochawesome-json189          fail-on-error: 'false'190          191      - name: Run Sequential tests 192        working-directory: tests193        if: success() || failure() 194        run: |195          yarn install196          yarn add mochawesome197          node scripts/readyness.js198          echo "Ready to start tests"199          yarn polkadot-types200          NOW=$(date +%s) && yarn testSequential --reporter mochawesome --reporter-options reportFilename=test-sequential-${NOW}201        env:202          RPC_URL: http://127.0.0.1:9933/203    204      - name: Test Report Sequential205        uses: phoenix-actions/test-reporting@v8206        id: test-report-sequential207        if: success() || failure()    # run this step even if previous step failed208        with:209          name: Report Sequential tests results - ${{ matrix.network }}            # Name of the check run which will be created210          path: tests/mochawesome-report/test-sequential-*.json    # Path to test results211          reporter: mochawesome-json212          fail-on-error: 'false'213214      - name: Stop running containers215        if: always()                   # run this step always216        run: docker-compose -f ".docker/docker-compose-forkless.yml" -f ".docker/docker-compose.${{ matrix.network }}.yml" down217        218      - name: Remove builder cache219        if: always()                   # run this step always220        run: |221          docker builder prune -f -a222          docker system prune -f223          docker image prune -f -a
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