From 9b7f49a57bbb8fa58ae110ddede8e49011c52740 Mon Sep 17 00:00:00 2001
From: "chen, suyue" <suyue.chen@intel.com>
Date: Mon, 12 Aug 2024 10:25:43 +0800
Subject: [PATCH] Add E2E example test (#453)

Signed-off-by: chensuyue <suyue.chen@intel.com>
---
 ...t-test-matrix.yml => _get-test-matrix.yml} |  0
 ...d-on-manual.yml => manual-image-build.yml} |  0
 .../{code-scan.yml => mix-code-scan.yml}      |  0
 ...vice-test.yml => mix-megaservice-test.yml} |  2 +-
 .../{trellix.yml => mix-trellix.yml}          |  0
 ...test.yaml => pr-dockerfile-path-scan.yaml} |  0
 .github/workflows/pr-examples-test.yml        | 72 +++++++++++++++++
 ...vice-test.yml => pr-microservice-test.yml} | 10 ++-
 ...build-on-push.yml => push-image-build.yml} |  2 +-
 .github/workflows/reuse-image-build.yml       | 32 --------
 ...-schedule.yml => schedule-image-build.yml} |  0
 .../scripts/docker_images_build_push.sh       | 77 ------------------
 tests/{test_asr_whisper.sh => test_asr.sh}    |  0
 tests/{test_tts_speecht5.sh => test_tts.sh}   |  0
 tests/test_workflow_chatqna.py                | 80 -------------------
 15 files changed, 80 insertions(+), 195 deletions(-)
 rename .github/workflows/{reuse-get-test-matrix.yml => _get-test-matrix.yml} (100%)
 rename .github/workflows/{image-build-on-manual.yml => manual-image-build.yml} (100%)
 rename .github/workflows/{code-scan.yml => mix-code-scan.yml} (100%)
 rename .github/workflows/{megaservice-test.yml => mix-megaservice-test.yml} (98%)
 rename .github/workflows/{trellix.yml => mix-trellix.yml} (100%)
 rename .github/workflows/{test.yaml => pr-dockerfile-path-scan.yaml} (100%)
 create mode 100644 .github/workflows/pr-examples-test.yml
 rename .github/workflows/{microservice-test.yml => pr-microservice-test.yml} (89%)
 rename .github/workflows/{image-build-on-push.yml => push-image-build.yml} (98%)
 delete mode 100644 .github/workflows/reuse-image-build.yml
 rename .github/workflows/{image-build-on-schedule.yml => schedule-image-build.yml} (100%)
 delete mode 100644 .github/workflows/scripts/docker_images_build_push.sh
 rename tests/{test_asr_whisper.sh => test_asr.sh} (100%)
 rename tests/{test_tts_speecht5.sh => test_tts.sh} (100%)
 delete mode 100644 tests/test_workflow_chatqna.py

diff --git a/.github/workflows/reuse-get-test-matrix.yml b/.github/workflows/_get-test-matrix.yml
similarity index 100%
rename from .github/workflows/reuse-get-test-matrix.yml
rename to .github/workflows/_get-test-matrix.yml
diff --git a/.github/workflows/image-build-on-manual.yml b/.github/workflows/manual-image-build.yml
similarity index 100%
rename from .github/workflows/image-build-on-manual.yml
rename to .github/workflows/manual-image-build.yml
diff --git a/.github/workflows/code-scan.yml b/.github/workflows/mix-code-scan.yml
similarity index 100%
rename from .github/workflows/code-scan.yml
rename to .github/workflows/mix-code-scan.yml
diff --git a/.github/workflows/megaservice-test.yml b/.github/workflows/mix-megaservice-test.yml
similarity index 98%
rename from .github/workflows/megaservice-test.yml
rename to .github/workflows/mix-megaservice-test.yml
index 7e55e2bf2a..83c826cd7e 100644
--- a/.github/workflows/megaservice-test.yml
+++ b/.github/workflows/mix-megaservice-test.yml
@@ -10,7 +10,7 @@ on:
     branches: [main]
     types: [opened, reopened, ready_for_review, synchronize] # added `ready_for_review` since draft is skipped
     paths:
-      - .github/workflows/megaservice-test.yml
+      - .github/workflows/mix-megaservice-test.yml
       - comps/cores/**
       - requirements.txt
       - setup.py
diff --git a/.github/workflows/trellix.yml b/.github/workflows/mix-trellix.yml
similarity index 100%
rename from .github/workflows/trellix.yml
rename to .github/workflows/mix-trellix.yml
diff --git a/.github/workflows/test.yaml b/.github/workflows/pr-dockerfile-path-scan.yaml
similarity index 100%
rename from .github/workflows/test.yaml
rename to .github/workflows/pr-dockerfile-path-scan.yaml
diff --git a/.github/workflows/pr-examples-test.yml b/.github/workflows/pr-examples-test.yml
new file mode 100644
index 0000000000..92354c5c24
--- /dev/null
+++ b/.github/workflows/pr-examples-test.yml
@@ -0,0 +1,72 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+name: Example-test
+
+on:
+  pull_request_target:
+    branches: [main]
+    types: [opened, reopened, ready_for_review, synchronize] # added `ready_for_review` since draft is skipped
+    paths:
+      - .github/workflows/pr-examples-test.yml
+      - comps/cores/**
+      - comps/embeddings/langchain/**
+      - comps/retrievers/langchain/redis/**
+      - comps/reranks/tei/**
+      - comps/llms/text-generation/tgi/**
+      - comps/dataprep/redis/langchain/**
+      - requirements.txt
+
+# If there is a new commit, the previous jobs will be canceled
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  example-test:
+    runs-on: gaudi-01-3
+    steps:
+      - name: Clean Up Working Directory
+        run: |
+          sudo rm -rf ${{github.workspace}}/* || true
+          echo y | docker system prune
+          docker rmi $(docker images --filter reference="*/*:comps" -q) || true
+
+      - name: Checkout out Repo
+        uses: actions/checkout@v4
+        with:
+          ref: "refs/pull/${{ github.event.number }}/merge"
+
+      - name: Run ChatQnA
+        env:
+          HUGGINGFACEHUB_API_TOKEN: ${{ secrets.HUGGINGFACEHUB_API_TOKEN }}
+        run: |
+          git clone https://github.com/opea-project/GenAIExamples.git
+          cd ${{ github.workspace }}/GenAIExamples/ChatQnA/docker/gaudi
+          sed -i "s#:latest#:comps#g" compose.yaml
+          cat compose.yaml
+
+          cd ${{ github.workspace }}/GenAIExamples/ChatQnA/tests
+          GenAIComps_dir=${{github.workspace}}
+          sed -i '/GenAIComps.git/d' test_chatqna_on_gaudi.sh
+          sed -i "s#cd GenAIComps#cd ${GenAIComps_dir}#g" test_chatqna_on_gaudi.sh
+          sed -i "s#docker build -t#docker build --no-cache -q -t#g" test_chatqna_on_gaudi.sh
+          sed -i "s#:latest#:comps#g" test_chatqna_on_gaudi.sh
+          cat test_chatqna_on_gaudi.sh
+
+          echo "Run test..."
+          timeout 50m bash test_chatqna_on_gaudi.sh
+
+      - name: Clean up container
+        if: cancelled() || failure()
+        run: |
+          cd ${{ github.workspace }}/GenAIExamples/ChatQnA/docker/gaudi
+          docker compose stop && docker compose rm -f
+          docker system prune -f
+
+      - name: Publish pipeline artifact
+        if: ${{ !cancelled() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: "Examples-Test-Logs"
+          path: ${{ github.workspace }}/GenAIExamples/ChatQnA/tests/*.log
diff --git a/.github/workflows/microservice-test.yml b/.github/workflows/pr-microservice-test.yml
similarity index 89%
rename from .github/workflows/microservice-test.yml
rename to .github/workflows/pr-microservice-test.yml
index e40745f0b3..9abdce833e 100644
--- a/.github/workflows/microservice-test.yml
+++ b/.github/workflows/pr-microservice-test.yml
@@ -12,7 +12,7 @@ on:
       - tests/**
       - "!**.md"
       - "!**.txt"
-      - .github/workflows/microservice-test.yml
+      - .github/workflows/pr-microservice-test.yml
 
 # If there is a new commit, the previous jobs will be canceled
 concurrency:
@@ -21,7 +21,7 @@ concurrency:
 
 jobs:
   job1:
-    uses: ./.github/workflows/reuse-get-test-matrix.yml
+    uses: ./.github/workflows/_get-test-matrix.yml
 
   Microservice-test:
     needs: job1
@@ -31,7 +31,9 @@ jobs:
     continue-on-error: true
     steps:
       - name: Clean Up Working Directory
-        run: sudo rm -rf ${{github.workspace}}/*
+        run: |
+          sudo rm -rf ${{github.workspace}}/*
+          docker system prune -f
 
       - name: Checkout out Repo
         uses: actions/checkout@v4
@@ -57,7 +59,7 @@ jobs:
         run: |
           cid=$(docker ps -aq --filter "name=test-comps-*")
           if [[ ! -z "$cid" ]]; then docker stop $cid && docker rm $cid && sleep 1s; fi
-          echo y | docker system prune --all
+          docker system prune -f
 
       - name: Publish pipeline artifact
         if: ${{ !cancelled() }}
diff --git a/.github/workflows/image-build-on-push.yml b/.github/workflows/push-image-build.yml
similarity index 98%
rename from .github/workflows/image-build-on-push.yml
rename to .github/workflows/push-image-build.yml
index a72d13a619..5472111dde 100644
--- a/.github/workflows/image-build-on-push.yml
+++ b/.github/workflows/push-image-build.yml
@@ -10,7 +10,7 @@ on:
       - comps/**
       - "!**.md"
       - "!**.txt"
-      - .github/workflows/image-build-on-push.yml
+      - .github/workflows/push-image-build.yml
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}-on-push
diff --git a/.github/workflows/reuse-image-build.yml b/.github/workflows/reuse-image-build.yml
deleted file mode 100644
index e2ed6883b1..0000000000
--- a/.github/workflows/reuse-image-build.yml
+++ /dev/null
@@ -1,32 +0,0 @@
-# Copyright (C) 2024 Intel Corporation
-# SPDX-License-Identifier: Apache-2.0
-
-name: Image Build
-permissions: read-all
-on:
-  workflow_call:
-    inputs:
-      micro_service:
-        required: true
-        type: string
-
-jobs:
-  micro-image-build:
-    continue-on-error: true
-    strategy:
-      matrix:
-        node: [docker-build-xeon, docker-build-gaudi]
-    runs-on: ${{ matrix.node }}
-    steps:
-      - name: Checkout out Repo
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Building MicroService Docker Image
-        id: build-microservice-image
-        env:
-          micro_service: ${{ inputs.micro_service }}
-          hardware: ${{ matrix.node }}
-        run: |
-          bash .github/workflows/scripts/docker_images_build_push.sh ${micro_service} ${hardware}
diff --git a/.github/workflows/image-build-on-schedule.yml b/.github/workflows/schedule-image-build.yml
similarity index 100%
rename from .github/workflows/image-build-on-schedule.yml
rename to .github/workflows/schedule-image-build.yml
diff --git a/.github/workflows/scripts/docker_images_build_push.sh b/.github/workflows/scripts/docker_images_build_push.sh
deleted file mode 100644
index eaf4d78f33..0000000000
--- a/.github/workflows/scripts/docker_images_build_push.sh
+++ /dev/null
@@ -1,77 +0,0 @@
-#!/bin/bash
-# Copyright (C) 2024 Intel Corporation
-# SPDX-License-Identifier: Apache-2.0
-
-set -xe
-
-WORKSPACE=$PWD
-IMAGE_REPO=${IMAGE_REPO:-$OPEA_IMAGE_REPO}
-IMAGE_TAG=${IMAGE_TAG:-latest}
-
-function docker_build() {
-    # docker_build <IMAGE_NAME>
-    IMAGE_NAME=$1
-    micro_service=$2
-    dockerfile_path=${WORKSPACE}/comps/${micro_service}
-    if [[ "$IMAGE_NAME" == *"gaudi" ]]; then
-        dockerfile_name="Dockerfile_hpu"
-    else
-        dockerfile_name="Dockerfile"
-    fi
-    if [ -f "$dockerfile_path/$dockerfile_name" ]; then
-        DOCKERFILE_PATH="$dockerfile_path/$dockerfile_name"
-    elif [ -f "$dockerfile_path/docker/$dockerfile_name" ]; then
-        DOCKERFILE_PATH="$dockerfile_path/docker/$dockerfile_name"
-    else
-        echo "Dockerfile not found"
-        exit 1
-    fi
-    echo "Building ${IMAGE_REPO}${IMAGE_NAME}:$IMAGE_TAG using Dockerfile $DOCKERFILE_PATH"
-
-    docker build --no-cache -t ${IMAGE_REPO}${IMAGE_NAME}:$IMAGE_TAG -f $DOCKERFILE_PATH .
-    docker push ${IMAGE_REPO}${IMAGE_NAME}:$IMAGE_TAG
-    docker rmi ${IMAGE_REPO}${IMAGE_NAME}:$IMAGE_TAG
-}
-
-micro_service=$1
-hardware=$(echo $2 | cut -d- -f3)
-case ${micro_service} in
-    "asr"|"tts")
-        IMAGE_NAME="opea/${micro_service}"
-        ;;
-    "embeddings/langchain")
-        IMAGE_NAME="opea/embedding-tei"
-        ;;
-    "retrievers/langchain/redis")
-        IMAGE_NAME="opea/retriever-redis"
-        ;;
-    "reranks/tei")
-        IMAGE_NAME="opea/reranking-tei"
-        ;;
-    "llms/text-generation/tgi")
-        IMAGE_NAME="opea/llm-tgi"
-        ;;
-    "dataprep/redis/langchain")
-        IMAGE_NAME="opea/dataprep-redis"
-        ;;
-    "llms/summarization/tgi")
-        IMAGE_NAME="opea/llm-docsum-tgi"
-        ;;
-    "llms/faq-generation/tgi")
-        IMAGE_NAME="opea/llm-faqgen-tgi"
-        ;;
-    "web_retrievers/langchain/chroma")
-        IMAGE_NAME="opea/web-retriever-chroma"
-        ;;
-    "tts/speecht5")
-        if [ "${hardware}" == "gaudi" ]; then IMAGE_NAME="opea/speecht5-gaudi"; else IMAGE_NAME="opea/speecht5"; fi
-        ;;
-    "asr/whisper")
-        if [ "${hardware}" == "gaudi" ]; then IMAGE_NAME="opea/whisper-gaudi"; else IMAGE_NAME="opea/whisper"; fi
-        ;;
-    *)
-        echo "Not supported yet"
-        exit 0
-        ;;
-esac
-docker_build "${IMAGE_NAME}" "${micro_service}"
diff --git a/tests/test_asr_whisper.sh b/tests/test_asr.sh
similarity index 100%
rename from tests/test_asr_whisper.sh
rename to tests/test_asr.sh
diff --git a/tests/test_tts_speecht5.sh b/tests/test_tts.sh
similarity index 100%
rename from tests/test_tts_speecht5.sh
rename to tests/test_tts.sh
diff --git a/tests/test_workflow_chatqna.py b/tests/test_workflow_chatqna.py
deleted file mode 100644
index a2ea0f2d0d..0000000000
--- a/tests/test_workflow_chatqna.py
+++ /dev/null
@@ -1,80 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-# Copyright (C) 2024 Intel Corporation
-# SPDX-License-Identifier: Apache-2.0
-
-#
-
-import asyncio
-import os
-
-from comps import ChatQnAGateway, MicroService, ServiceOrchestrator, ServiceType
-
-MEGA_SERVICE_HOST_IP = os.getenv("MEGA_SERVICE_HOST_IP", "0.0.0.0")
-MEGA_SERVICE_PORT = os.getenv("MEGA_SERVICE_PORT", 8888)
-EMBEDDING_SERVICE_HOST_IP = os.getenv("EMBEDDING_SERVICE_HOST_IP", "0.0.0.0")
-EMBEDDING_SERVICE_PORT = os.getenv("EMBEDDING_SERVICE_PORT", 6000)
-RETRIEVER_SERVICE_HOST_IP = os.getenv("RETRIEVER_SERVICE_HOST_IP", "0.0.0.0")
-RETRIEVER_SERVICE_PORT = os.getenv("RETRIEVER_SERVICE_PORT", 7000)
-RERANK_SERVICE_HOST_IP = os.getenv("RERANK_SERVICE_HOST_IP", "0.0.0.0")
-RERANK_SERVICE_PORT = os.getenv("RERANK_SERVICE_PORT", 8000)
-LLM_SERVICE_HOST_IP = os.getenv("LLM_SERVICE_HOST_IP", "0.0.0.0")
-LLM_SERVICE_PORT = os.getenv("LLM_SERVICE_PORT", 9000)
-
-
-class ChatQnAService:
-    def __init__(self, host="0.0.0.0", port=8000):
-        self.host = host
-        self.port = port
-        self.megaservice = ServiceOrchestrator()
-
-    def add_remote_service(self):
-        embedding = MicroService(
-            name="embedding",
-            host=EMBEDDING_SERVICE_HOST_IP,
-            port=EMBEDDING_SERVICE_PORT,
-            endpoint="/v1/embeddings",
-            use_remote_service=True,
-            service_type=ServiceType.EMBEDDING,
-        )
-        retriever = MicroService(
-            name="retriever",
-            host=RETRIEVER_SERVICE_HOST_IP,
-            port=RETRIEVER_SERVICE_PORT,
-            endpoint="/v1/retrieval",
-            use_remote_service=True,
-            service_type=ServiceType.RETRIEVER,
-        )
-        rerank = MicroService(
-            name="rerank",
-            host=RERANK_SERVICE_HOST_IP,
-            port=RERANK_SERVICE_PORT,
-            endpoint="/v1/reranking",
-            use_remote_service=True,
-            service_type=ServiceType.RERANK,
-        )
-        llm = MicroService(
-            name="llm",
-            host=LLM_SERVICE_HOST_IP,
-            port=LLM_SERVICE_PORT,
-            endpoint="/v1/chat/completions",
-            use_remote_service=True,
-            service_type=ServiceType.LLM,
-        )
-        self.megaservice.add(embedding).add(retriever).add(rerank).add(llm)
-        self.megaservice.flow_to(embedding, retriever)
-        self.megaservice.flow_to(retriever, rerank)
-        self.megaservice.flow_to(rerank, llm)
-        self.gateway = ChatQnAGateway(megaservice=self.megaservice, host="0.0.0.0", port=self.port)
-
-    async def schedule(self):
-        result_dict, runtime_graph = await self.megaservice.schedule(
-            initial_inputs={"text": "What is the revenue of Nike in 2023?"}
-        )
-        print(result_dict)
-
-
-if __name__ == "__main__":
-    chatqna = ChatQnAService(host=MEGA_SERVICE_HOST_IP, port=MEGA_SERVICE_PORT)
-    chatqna.add_remote_service()
-    asyncio.run(chatqna.schedule())