Add e2e test of chatqna for genai example (#334)

* add e2e test of chatqna for genai example. Signed-off-by: zhlsunshine <huailong.zhang@intel.com> Co-authored-by: mkbhanda <malini.bhandaru@intel.com> Co-authored-by: daisy-ycguo <yingchun.guo@intel.com>
opea-project · Jun 27, 2024 · afcb3a3 · afcb3a3
1 parent 3ffe19e
commit afcb3a3
Show file tree

Hide file tree

Showing 5 changed files with 606 additions and 0 deletions.
diff --git a/.github/workflows/gmc-e2e.yaml b/.github/workflows/gmc-e2e.yaml
@@ -0,0 +1,104 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+name: E2E test with GMC
+
+on:
+ pull_request:
+ branches: [main]
+ types: [opened, reopened, ready_for_review, synchronize] # added `ready_for_review` since draft is skipped
+ paths:
+ - "**/kubernetes/**"
+ - "**/tests/test_gmc**"
+ - "!**.md"
+ - "!**.txt"
+ workflow_dispatch:
+
+concurrency:
+ group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ job1:
+ uses: ./.github/workflows/reuse-get-test-matrix.yml
+ with:
+ diff_excluded_files: '.github|deprecated|docker|assets|*.md|*.txt'
+ xeon_server_label: 'xeon'
+ gaudi_server_label: 'gaudi'
+
+ gmc-test:
+ needs: [job1]
+ strategy:
+ matrix: ${{ fromJSON(needs.job1.outputs.run_matrix) }}
+ runs-on: "k8s-${{ matrix.hardware }}"
+ continue-on-error: true
+ steps:
+ - name: E2e test gmc
+ run: |
+ echo "Matrix - gmc: ${{ matrix.example }}"
+
+ - name: Clean Up Working Directory
+ run: sudo rm -rf ${{github.workspace}}/*
+
+ - name: Checkout out Repo
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+
+ - name: Set variables
+ run: |
+ if [ ${{ matrix.hardware }} == "gaudi" ]; then IMAGE_REPO=${{ vars.IMAGE_REPO_GAUDI }}; else IMAGE_REPO=${{ vars.IMAGE_REPO_XEON }}; fi
+ echo "IMAGE_REPO=$OPEA_IMAGE_REPO" >> $GITHUB_ENV
+ lower_example=$(echo "${{ matrix.example }}" | tr '[:upper:]' '[:lower:]')
+ echo "SYSTEM_NAMESPACE=opea-system-$(date +%Y%m%d%H%M%S)" >> $GITHUB_ENV
+ echo "APP_NAMESPACE=$lower_example-$(date +%Y%m%d%H%M%S)" >> $GITHUB_ENV
+ echo "ROLLOUT_TIMEOUT_SECONDS=1800s" >> $GITHUB_ENV
+ echo "KUBECTL_TIMEOUT_SECONDS=60s" >> $GITHUB_ENV
+ echo "continue_test=true" >> $GITHUB_ENV
+ echo "should_cleanup=false" >> $GITHUB_ENV
+ echo "skip_validate=true" >> $GITHUB_ENV
+ echo "APP_NAMESPACE=$APP_NAMESPACE"
+
+ - name: Kubectl install
+ id: install
+ run: |
+ if [[ ! -f ${{ github.workspace }}/${{ matrix.example }}/tests/test_gmc_on_${{ matrix.hardware }}.sh ]]; then
+ echo "No test script found, exist test!"
+ exit 0
+ else
+ ${{ github.workspace }}/${{ matrix.example }}/tests/test_gmc_on_${{ matrix.hardware }}.sh init_${{ matrix.example }}
+ echo "should_cleanup=true" >> $GITHUB_ENV
+ ${{ github.workspace }}/${{ matrix.example }}/tests/test_gmc_on_${{ matrix.hardware }}.sh install_${{ matrix.example }}
+ echo "Testing ${{ matrix.example }}, waiting for pod ready..."
+ if kubectl rollout status deployment --namespace "$APP_NAMESPACE" --timeout "$ROLLOUT_TIMEOUT_SECONDS"; then
+ echo "Testing gmc ${{ matrix.example }}, waiting for pod ready done!"
+ echo "skip_validate=false" >> $GITHUB_ENV
+ else
+ echo "Timeout waiting for pods in namespace $APP_NAMESPACE to be ready!"
+ exit 1
+ fi
+ sleep 60
+ fi
+
+ - name: Validate e2e test
+ if: always()
+ run: |
+ if $skip_validate; then
+ echo "Skip validate"
+ else
+ ${{ github.workspace }}/${{ matrix.example }}/tests/test_gmc_on_${{ matrix.hardware }}.sh validate_${{ matrix.example }}
+ fi
+
+ - name: Kubectl uninstall
+ if: always()
+ run: |
+ if $should_cleanup; then
+ if ! kubectl delete ns $APP_NAMESPACE --timeout=$KUBECTL_TIMEOUT_SECONDS; then
+ kubectl delete pods --namespace $APP_NAMESPACE --force --grace-period=0 --all
+ kubectl delete ns $APP_NAMESPACE --force --grace-period=0 --timeout=$KUBECTL_TIMEOUT_SECONDS
+ fi
+ if ! kubectl delete ns $SYSTEM_NAMESPACE --timeout=$KUBECTL_TIMEOUT_SECONDS; then
+ kubectl delete pods --namespace $SYSTEM_NAMESPACE --force --grace-period=0 --all
+ kubectl delete ns $SYSTEM_NAMESPACE --force --grace-period=0 --timeout=$KUBECTL_TIMEOUT_SECONDS
+ fi
+ fi
diff --git a/ChatQnA/kubernetes/chatQnA_gaudi.yaml b/ChatQnA/kubernetes/chatQnA_gaudi.yaml
@@ -0,0 +1,63 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+apiVersion: gmc.opea.io/v1alpha3
+kind: GMConnector
+metadata:
+ labels:
+ app.kubernetes.io/name: gmconnector
+ app.kubernetes.io/managed-by: kustomize
+ gmc/platform: gaudi
+ name: chatqa
+ namespace: chatqa
+spec:
+ routerConfig:
+ name: router
+ serviceName: router-service
+ nodes:
+ root:
+ routerType: Sequence
+ steps:
+ - name: Embedding
+ internalService:
+ serviceName: embedding-svc
+ config:
+ endpoint: /v1/embeddings
+ - name: TeiEmbeddingGaudi
+ internalService:
+ serviceName: tei-embedding-gaudi-svc
+ isDownstreamService: true
+ - name: Retriever
+ data: $response
+ internalService:
+ serviceName: retriever-svc
+ config:
+ endpoint: /v1/retrieval
+ - name: VectorDB
+ internalService:
+ serviceName: redis-vector-db
+ isDownstreamService: true
+ - name: Reranking
+ data: $response
+ internalService:
+ serviceName: reranking-svc
+ config:
+ endpoint: /v1/reranking
+ - name: TeiReranking
+ internalService:
+ serviceName: tei-reranking-svc
+ config:
+ endpoint: /rerank
+ isDownstreamService: true
+ - name: Llm
+ data: $response
+ internalService:
+ serviceName: llm-svc
+ config:
+ endpoint: /v1/chat/completions
+ - name: TgiGaudi
+ internalService:
+ serviceName: tgi-gaudi-svc
+ config:
+ endpoint: /generate
+ isDownstreamService: true
diff --git a/ChatQnA/kubernetes/chatQnA_xeon.yaml b/ChatQnA/kubernetes/chatQnA_xeon.yaml
@@ -0,0 +1,63 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+apiVersion: gmc.opea.io/v1alpha3
+kind: GMConnector
+metadata:
+ labels:
+ app.kubernetes.io/name: gmconnector
+ app.kubernetes.io/managed-by: kustomize
+ gmc/platform: xeon
+ name: chatqa
+ namespace: chatqa
+spec:
+ routerConfig:
+ name: router
+ serviceName: router-service
+ nodes:
+ root:
+ routerType: Sequence
+ steps:
+ - name: Embedding
+ internalService:
+ serviceName: embedding-svc
+ config:
+ endpoint: /v1/embeddings
+ - name: TeiEmbedding
+ internalService:
+ serviceName: tei-embedding-svc
+ isDownstreamService: true
+ - name: Retriever
+ data: $response
+ internalService:
+ serviceName: retriever-svc
+ config:
+ endpoint: /v1/retrieval
+ - name: VectorDB
+ internalService:
+ serviceName: redis-vector-db
+ isDownstreamService: true
+ - name: Reranking
+ data: $response
+ internalService:
+ serviceName: reranking-svc
+ config:
+ endpoint: /v1/reranking
+ - name: TeiReranking
+ internalService:
+ serviceName: tei-reranking-svc
+ config:
+ endpoint: /rerank
+ isDownstreamService: true
+ - name: Llm
+ data: $response
+ internalService:
+ serviceName: llm-svc
+ config:
+ endpoint: /v1/chat/completions
+ - name: Tgi
+ internalService:
+ serviceName: tgi-service-m
+ config:
+ endpoint: /generate
+ isDownstreamService: true