ReportPortal 开源项目使用教程

ReportPortal 开源项目使用教程

reportportalMain Repository. ReportPortal starts here - see readme below.项目地址:https://gitcode.com/gh_mirrors/re/reportportal

1. 项目的目录结构及介绍

ReportPortal 是一个开源的、服务导向的、基于 Web 的平台，用于自动化测试过程的单一入口点。以下是 ReportPortal 项目的主要目录结构及其介绍：

reportportal/
├── api/
├── apiclients/
├── analytics/
├── commons/
├── core/
├── docker/
├── elasticsearch/
├── gateway/
├── index/
├── job/
├── logger/
├── mockserver/
├── notification/
├── plugins/
├── reporting/
├── resources/
├── rest/
├── service-api/
├── service-authorization/
├── service-index/
├── service-ui/
├── service-ui-2/
├── uat/
├── utils/
├── war/
├── .gitignore
├── .gitlab-ci.yml
├── .travis.yml
├── Dockerfile
├── LICENSE
├── README.md
├── docker-compose.yml
└── pom.xml

• api/: 包含 API 相关的代码和配置。
• apiclients/: 包含 API 客户端的实现。
• analytics/: 包含分析相关的代码和配置。
• commons/: 包含公共库和工具。
• core/: 包含核心服务和逻辑。
• docker/: 包含 Docker 相关的配置和脚本。
• elasticsearch/: 包含 Elasticsearch 相关的配置和脚本。
• gateway/: 包含网关服务的实现。
• index/: 包含索引服务的实现。
• job/: 包含定时任务服务的实现。
• logger/: 包含日志服务的实现。
• mockserver/: 包含模拟服务器的实现。
• notification/: 包含通知服务的实现。
• plugins/: 包含插件的实现。
• reporting/: 包含报告服务的实现。
• resources/: 包含资源文件。
• rest/: 包含 RESTful API 的实现。
• service-api/: 包含 API 服务的实现。
• service-authorization/: 包含授权服务的实现。
• service-index/: 包含索引服务的实现。
• service-ui/: 包含 UI 服务的实现。
• service-ui-2/: 包含新版 UI 服务的实现。
• uat/: 包含用户验收测试的实现。
• utils/: 包含工具类和辅助函数。
• war/: 包含 WAR 包的构建文件。
• .gitignore: Git 忽略文件配置。
• .gitlab-ci.yml: GitLab CI 配置文件。
• .travis.yml: Travis CI 配置文件。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• docker-compose.yml: Docker Compose 配置文件。
• pom.xml: Maven 项目配置文件。

2. 项目的启动文件介绍

ReportPortal 的启动文件主要位于各个服务的根目录下，例如 service-api/、service-ui/ 等。每个服务通常包含一个 Dockerfile 和一个 docker-compose.yml 文件，用于构建和启动服务。

例如，service-api/ 目录下的 Dockerfile 和 docker-compose.yml 文件：

# service-api/Dockerfile
FROM openjdk:8-jre-slim
COPY target/service-api.jar /app/service-api.jar
ENTRYPOINT ["java", "-jar", "/app/service-api.jar"]

# service-api/docker-compose.yml
version: '3'
services:
  service-api:
    image: reportportal/service-api:latest
    ports:
      - "8080:8080"
    depends_on:
      - database

3. 项目的配置文件介绍

ReportPortal 的配置文件主要位于各个服务的 src/main/resources/ 目录下，例如 service-api/src/main/resources/application.properties。以下是一些常见的配置文件及其介绍：

• application.properties: 包含服务的配置参数，如数据库连接、端口号等。

# service-api/src/main/resources/application.properties
server.port=

reportportalMain Repository. ReportPortal starts here - see readme below.项目地址:https://gitcode.com/gh_mirrors/re/reportportal