openim-e2eTest

This repository contains the end-to-end (e2e) automation tests for the OpenIM project. Below you'll find the steps to run the entire test suite or individual test cases, as well as the setup required for running tests in environments without a graphical user interface, such as a Git testing environment, by using a headless browser.

Setting Up a Headless Browser

In environments without a graphical user interface, like Git's testing environment, it's possible to run the entire test project using a headless browser. Here's how to set it up:

Configuring the Environment

1. Install Google Chrome

• Update your package list:

  sudo apt-get update
  

• Install Google Chrome Stable:

  sudo apt-get install -y google-chrome-stable
  

• If you encounter the error "Unable to locate package google-chrome-stable": a. Download and add the official Google Chrome public key:

  wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
  

  b. Add the Google Chrome repository to your software sources list:

  echo 'deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main' | sudo tee /etc/apt/sources.list.d/google-chrome.list
  

  c. Update the package list and install Google Chrome:

  sudo apt-get update
  sudo apt-get install -y google-chrome-stable
  

2. Run requirements.txt to install the environment

• pip install environment is required：

  pip install -r requirements.txt
  

Running Tests

Run the Entire Test Suite

To run all test cases in the suite:

1. Open your Git testing environment.
2. Execute the following command:

   pytest -v -s ./script  
   

Running Allure-report

To run all test cases in the suite:

1. Open your Git testing environment.
2. Execute the following command:

   pytest --alluredir=./reports/allure-results 
   

   allure serve ./reports/allure-results   
   

4. Install OpenIM Server Test

Clone openim-server, use docker install:

git clone https://github.com/openimsdk/openim-docker
cd openim-docker

edit env:

MINIO_EXTERNAL_ADDRESS="http://external_ip:10005"
GRAFANA_URL="http://external_ip:13000/"

start docker:

docker compose up -d

start test-e2e:

cd ..
cd test-e2e
pytest -v -s ./script  

Using the Headless Browser in Code

When initiating the driver() function in your code, include the following options to enable headless mode and avoid common issues:

from selenium.webdriver.chrome.options import Options
from selenium.webdriver.chrome.service import Service
from selenium import webdriver
import os

chrome_options = Options()
chrome_options.add_argument("--headless")  # Enable headless mode
chrome_options.add_argument("--no-sandbox")  # Bypass OS security model
chrome_options.add_argument("--enable-logging")
chrome_options.add_argument("--v=1")
chrome_options.add_argument("--disable-dev-shm-usage")  # Avoid shared memory issues

# Optional: Specify the path to chromedriver if not in PATH
driver_path = os.path.join(os.environ['HOME'], 'bin', 'chromedriver')  
service = Service(executable_path=driver_path)
# Instantiate WebDriver with Service object and options
driver = webdriver.Chrome(service=service, options=chrome_options)

This setup ensures your e2e tests can run in environments lacking a GUI, using Selenium WebDriver with Chrome in headless mode.