add tests

.github/code_spell_ignore.txt

@@ -0,0 +1 @@
+

.github/license_template.txt

@@ -0,0 +1,2 @@
+Copyright (C) 2024 Intel Corporation
+SPDX-License-Identifier: Apache-2.0

.github/pull_request_template.md

@@ -0,0 +1,24 @@
+## Description
+
+The summary of the proposed changes as long as the relevant motivation and context.
+
+## Issues
+
+List the issue or RFC link this PR is working on. If there is no such link, please mark it as `n/a`.
+
+## Type of change
+
+List the type of change like below. Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds new functionality)
+- [ ] Breaking change (fix or feature that would break existing design and interface)
+- [ ] Others (enhancement, documentation, validation, etc.)
+
+## Dependencies
+
+List the newly introduced 3rd party dependency if exists.
+
+## Tests
+
+Describe the tests that you ran to verify your changes.

.github/workflows/docker/code-scan.dockerfile

@@ -0,0 +1,23 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+ARG UBUNTU_VER=22.04
+FROM ubuntu:${UBUNTU_VER} as devel
+
+ENV LANG=C.UTF-8
+
+RUN apt-get update && apt-get install -y --no-install-recommends --fix-missing \
+    aspell \
+    aspell-en \
+    build-essential \
+    python3 \
+    python3-pip \
+    python3-dev \
+    python3-distutils \
+    wget
+
+RUN ln -sf $(which python3) /usr/bin/python
+
+RUN python -m pip install --no-cache-dir bandit
+
+WORKDIR /

.github/workflows/docker/ut.dockerfile

@@ -0,0 +1,23 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+ARG UBUNTU_VER=22.04
+FROM ubuntu:${UBUNTU_VER} as devel
+
+ENV LANG=C.UTF-8
+
+RUN apt-get update && apt-get install -y --no-install-recommends --fix-missing \
+    aspell \
+    aspell-en \
+    build-essential \
+    git \
+    python3 \
+    python3-dev \
+    python3-distutils \
+    python3-pip \
+    wget
+
+RUN ln -sf $(which python3) /usr/bin/python
+RUN python -m pip install --no-cache-dir pytest pytest-cov
+
+WORKDIR /

.github/workflows/mix-code-scan.yml

@@ -0,0 +1,66 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+name: Code Scan
+
+on:
+  pull_request:
+    branches: [main]
+    types: [opened, reopened, ready_for_review, synchronize] # added `ready_for_review` since draft is skipped
+    paths-ignore:
+      - "**.md"
+  workflow_dispatch:
+
+# 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
+
+env:
+  DOCKER_CONFIG_NAME: "commonDockerConfig"
+  REPO_NAME: "code-scan"
+  REPO_TAG: "1.0"
+  DOCKER_FILE_NAME: "code-scan"
+  CONTAINER_NAME: "code-scan"
+
+jobs:
+  code-scan:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        job_name: ["bandit", "hadolint"]
+      fail-fast: false
+    steps:
+      - name: Checkout out Repo
+        uses: actions/checkout@v4
+
+      - name: Check Dangerous Command Injection
+        uses: opea-project/validation/actions/check-cmd@main
+        with:
+          work_dir: ${{ github.workspace }}
+
+      - name: Docker Build
+        run: |
+          docker build -f ${{ github.workspace }}/.github/workflows/docker/${{ env.DOCKER_FILE_NAME }}.dockerfile -t ${{ env.REPO_NAME }}:${{ env.REPO_TAG }} .
+
+      - name: Docker Run
+        run: |
+          if [[ $(docker ps -a | grep -i '${{ env.CONTAINER_NAME }}'$) ]]; then
+            docker stop ${{ env.CONTAINER_NAME }}
+            docker rm -vf ${{ env.CONTAINER_NAME }} || true
+          fi
+          docker run -dit --memory="4g" --memory-reservation="1g" --disable-content-trust --privileged --name=${{ env.CONTAINER_NAME }} --shm-size="1g" \
+          -v ${{ github.workspace }}:/LangChinaOPEA \
+          ${{ env.REPO_NAME }}:${{ env.REPO_TAG }}
+
+      - name: Code scan check
+        run: |
+          docker exec ${{ env.CONTAINER_NAME }} \
+          bash -c "bash /LangChinaOPEA/.github/workflows/scripts/codeScan/${{ matrix.job_name }}.sh"
+
+      - name: Publish pipeline artifact
+        if: ${{ !cancelled() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.job_name }}
+          path: ${{ github.workspace }}/.github/workflows/scripts/codeScan/${{ matrix.job_name }}.*

.github/workflows/mix-trellix.yml

@@ -0,0 +1,34 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+name: Trellix Command Line Scanner
+
+on:
+  workflow_dispatch:
+    inputs:
+      node:
+        default: trellix
+        required: false
+        type: string
+        description: "Action runner node label"
+
+jobs:
+  Trellix:
+    runs-on: ${{ inputs.node }}
+    steps:
+      - name: Clean Up Working Directory
+        run: sudo rm -rf ${{github.workspace}}/*
+
+      - name: Checkout out Repo
+        uses: actions/checkout@v4
+
+      - name: Run Trellix Scanner
+        env:
+          workspace: ${{ github.workspace }}
+        run: bash .github/workflows/scripts/codeScan/trellix.sh
+
+      - name: Publish pipeline artifact
+        if: ${{ !cancelled() }}
+        uses: actions/upload-artifact@v4
+        with:
+          path: ${{ github.workspace }}/.github/workflows/scripts/codeScan/report.html

.github/workflows/pr-link-path-scan.yaml

@@ -0,0 +1,153 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+name: Check hyperlinks and relative path validity
+
+on:
+  pull_request:
+    branches: [main]
+    types: [opened, reopened, ready_for_review, synchronize]
+
+# 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:
+  check-the-validity-of-hyperlinks-in-README:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clean Up Working Directory
+        run: sudo rm -rf ${{github.workspace}}/*
+
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Check the Validity of Hyperlinks
+        # ignore_links=("https://platform.openai.com/docs/api-reference/fine-tuning"
+        #               "https://platform.openai.com/docs/api-reference/"
+        #               "https://openai.com/index/whisper/"
+        #               "https://platform.openai.com/docs/api-reference/chat/create")
+        run: |
+          cd ${{github.workspace}}
+          fail="FALSE"
+          merged_commit=$(git log -1 --format='%H')
+          changed_files="$(git diff --name-status --diff-filter=ARM ${{ github.event.pull_request.base.sha }} ${merged_commit} | awk '/\.md$/ {print $NF}')"
+          if  [ -n "$changed_files" ]; then
+            for changed_file in $changed_files; do
+              echo $changed_file
+              url_lines=$(grep -H -Eo '\]\(http[s]?://[^)]+\)' "$changed_file" | grep -Ev 'LangChain-OPEA/blob/main') || true
+              if [ -n "$url_lines" ]; then
+                for url_line in $url_lines; do
+                  url=$(echo "$url_line"|cut -d '(' -f2 | cut -d ')' -f1|sed 's/\.git$//')
+                  path=$(echo "$url_line"|cut -d':' -f1 | cut -d'/' -f2-)
+                  if [[ "$url" == "https://platform.openai.com/docs/api-reference/"* || "https://www.docker.com/get-started" == "$url" || "https://openai.com/index/whisper/" == "$url" ]]; then
+                    echo "Link "$url" from ${{github.workspace}}/$path need to be verified by a real person."
+                  else
+                    response=$(curl -L -s -o /dev/null -w "%{http_code}" "$url")
+                    if [ "$response" -ne 200 ]; then
+                      echo "**********Validation failed, try again**********"
+                      response_retry=$(curl -s -o /dev/null -w "%{http_code}" "$url")
+                      if [ "$response_retry" -eq 200 ]; then
+                        echo "*****Retry successfully*****"
+                      else
+                        echo "Invalid link from ${{github.workspace}}/$path: $url"
+                        fail="TRUE"
+                      fi
+                    fi
+                  fi
+                done
+              fi
+            done
+          else
+            echo "No changed .md file."
+          fi
+
+          if [[ "$fail" == "TRUE" ]]; then
+            exit 1
+          else
+            echo "All hyperlinks are valid."
+          fi
+        shell: bash
+
+  check-the-validity-of-relative-path:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clean up Working Directory
+        run: sudo rm -rf ${{github.workspace}}/*
+
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Checking Relative Path Validity
+        run: |
+          cd ${{github.workspace}}
+          fail="FALSE"
+          repo_name=${{ github.event.pull_request.head.repo.full_name }}
+          if [ "$(echo "$repo_name"|cut -d'/' -f1)" != "opea-project" ]; then
+            owner=$(echo "${{ github.event.pull_request.head.repo.full_name }}" |cut -d'/' -f1)
+            branch="https://github.com/$owner/LangChain-OPEA/tree/${{ github.event.pull_request.head.ref }}"
+          else
+            branch="https://github.com/opea-project/LangChain-OPEA/blob/${{ github.event.pull_request.head.ref }}"
+          fi
+          link_head="https://github.com/opea-project/LangChain-OPEA/blob/main"
+
+          merged_commit=$(git log -1 --format='%H')
+          changed_files="$(git diff --name-status --diff-filter=ARM ${{ github.event.pull_request.base.sha }} ${merged_commit} | awk '/\.md$/ {print $NF}')"
+          png_lines=$(grep -Eo '\]\([^)]+\)' --include='*.md' -r .|grep -Ev 'http')
+          if [ -n "$png_lines" ]; then
+            for png_line in $png_lines; do
+              refer_path=$(echo "$png_line"|cut -d':' -f1 | cut -d'/' -f2-)
+              png_path=$(echo "$png_line"|cut -d '(' -f2 | cut -d ')' -f1)
+
+              if [[ "${png_path:0:1}" == "/" ]]; then
+                check_path=$png_path
+              elif [[ "$png_path" == *#* ]]; then
+                relative_path=$(echo "$png_path" | cut -d '#' -f1)
+                if [ -n "$relative_path" ]; then
+                  check_path=$(dirname "$refer_path")/$relative_path
+                  png_path=$(echo "$png_path" | awk -F'#' '{print "#" $2}')
+                else
+                  check_path=$refer_path
+                fi
+              else
+                check_path=$(dirname "$refer_path")/$png_path
+              fi
+
+              if [ -e "$check_path" ]; then
+                real_path=$(realpath $check_path)
+                if [[ "$png_line" == *#* ]]; then
+                  if [ -n "changed_files" ] && echo "$changed_files" | grep -q "^${refer_path}$"; then
+                    url_dev=$branch$(echo "$real_path" | sed 's|.*/LangChain-OPEA||')$png_path
+                    response=$(curl -I -L -s -o /dev/null -w "%{http_code}" "$url_dev")
+                    if [ "$response" -ne 200 ]; then
+                      echo "**********Validation failed, try again**********"
+                      response_retry=$(curl -s -o /dev/null -w "%{http_code}" "$url_dev")
+                      if [ "$response_retry" -eq 200 ]; then
+                        echo "*****Retry successfully*****"
+                      else
+                        echo "Invalid path from ${{github.workspace}}/$refer_path: $png_path, link: $url_dev"
+                        fail="TRUE"
+                      fi
+                    else
+                      echo "Validation succeed $png_line"
+                    fi
+                  fi
+                fi
+              else
+                echo "$check_path does not exist"
+                fail="TRUE"
+              fi
+            done
+          fi
+
+          if [[ "$fail" == "TRUE" ]]; then
+            exit 1
+          else
+            echo "All hyperlinks are valid."
+          fi
+        shell: bash