exoplatform/squash-tm

Squash TM Docker镜像文档

镜像概述和主要用途

Squash TM 是一款优秀的开源测试管理工具，专为测试仓库管理设计，旨在促进利益相关者之间共享测试项目。作为全Web应用，无需在客户端工作站安装，支持多项目和跨项目协作，提供直观的用户界面和丰富的测试管理功能。

核心功能和特性

主要功能

• 需求、测试用例、测试计划管理
• 报告管理：支持需求相关的自定义报告（图表、仪表板）
• 与缺陷跟踪工具和敏捷项目管理工具（如Jira）集成
• 开发人员和测试人员的自动化工作区，包含Gherkin编辑器

协作功能

• 多项目和跨项目支持
• 全Web工具，无需客户端安装
• 直观且符合人体工程学的设计，采用RIA（富互联网应用）技术
• 轻量化的管理和用户管理

支持的标签和Dockerfile链接

该Dockerfile基于openjdk:8-jre-alpine构建，详见https://hub.docker.com/_/openjdk%E3%80%82

标签latest始终指向Squash TM的最新稳定版本，从1.19.1版本开始，每个Squash TM版本均对应一个Docker镜像：

• 1.19.2, latest（Dockerfile）
• 1.19.1（Dockerfile）

快速启动

使用嵌入式H2数据库运行Squash-TM镜像（仅用于演示！）：

bash
docker run --name='squash-tm' -it -p 8090:8080 squashtest/squash-tm

注意：如需以守护进程模式运行容器，使用-d选项：

bash
docker run --name='squash-tm' -d -it -p 8090:8080 squashtest/squash-tm

应用启动需要几分钟时间，首次运行数据库初始化时尤其如此。如需确认启动状态，可查看日志：

bash
docker exec -it squash-tm sh
tail -f squash-tm/logs/squash-tm.log

访问 http://localhost:8090/squash 或Docker主机的IP地址。默认用户名和密码：

• 用户名：admin
• 密码：admin

配置

以下部分介绍如何使用外部PostgreSQL数据库容器或MariaDB数据库容器部署Squash TM，同时提供使用docker-compose部署的示例配置文件。

使用持久卷备份数据

在Docker中，通常将数据存储在卷中。为正确使用Squash TM镜像，强烈建议配置外部数据库（MariaDB或PostgreSQL）。以下配置均包含数据持久卷的创建：

/var/lib/postgresql/data     # PostgreSQL数据存储位置
/var/lib/mysql               # MariaDB数据存储位置

若用于生产环境，建议将日志目录也持久化到卷中，以保留日志记录：

/opt/squash-tm/logs          # 日志目录

更多信息请参考Docker文档的容器数据管理部分。

使用PostgreSQL部署

数据库由数据库容器创建，应用容器在首次运行时自动初始化数据库。数据库数据将保存在本地卷squash-tm-db-pg中，因此数据库容器（名称squash-tm-pg）可停止和重启而不会丢失数据：

bash
docker run -it -d --name='squash-tm-pg' \
-e POSTGRES_USER=squashtm \
-e POSTGRES_PASSWORD=MustB3Ch4ng3d \
-e POSTGRES_DB=squashtm \
-v squash-tm-db-pg:/var/lib/postgresql/data \
postgres:9.6.12 \

sleep 10

docker run -it -d --name=squash-tm \
--link squash-tm-pg:postgres \
-v squash-tm-logs:/opt/squash-tm/logs -v squash-tm-plugins:/opt/squash-tm/plugins \
-p 8090:8080 \
squashtest/squash-tm

等待3-4分钟让Squash-TM完成初始化，然后访问 *http://localhost:8090/squash*（用户名/密码：admin/admin）。

使用MariaDB部署

数据库由数据库容器创建，应用容器在首次运行时自动初始化数据库。数据库数据将保存在本地卷squash-tm-db-mdb中，因此数据库容器（名称squash-tm-mdb）可停止和重启而不会丢失数据：

bash
docker run -it -d --name='squash-tm-mdb' \
-e MYSQL_ROOT_PASSWORD=MustB3Ch4ng3d \
-e MYSQL_USER=squashtm \
-e MYSQL_PASSWORD=MustB3Ch4ng3d \
-e MYSQL_DATABASE=squashtm \
-v squash-tm-db-mdb:/var/lib/mysql \
mariadb:10.2.22-bionic --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci \

sleep 10

docker run -it -d --name=squash-tm \
--link squash-tm-mdb:mysql \
-v squash-tm-logs:/opt/squash-tm/logs -v squash-tm-plugins:/opt/squash-tm/plugins \
-p 8090:8080 \
squashtest/squash-tm

等待约10分钟让Squash-TM完成初始化（MariaDB初始化比PostgreSQL稍慢），然后访问 *http://localhost:8090/squash*（用户名/密码：admin/admin）。

Docker-Compose配置

docker-compose.yml 文件

以下示例将Squash-TM与MariaDB数据库链接。环境变量应在.env文件中设置（与docker-compose.yml保存在同一目录）：

yaml
version: '3.7'
services:
  squash-tm-md:
    image: mariadb:10.2.22-bionic
    environment:
      MYSQL_ROOT_PASSWORD: ${DB_ROOT_PASSWORD}
      MYSQL_USER: ${DB_USER}
      MYSQL_PASSWORD: ${DB_PASSWORD}
      MYSQL_DATABASE: ${DB_DATABASE}
    volumes:
      - "/var/lib/mysql-db:/var/lib/mysql"

  squash-tm:
    image: squashtest/squash-tm
    depends_on:
      - squash-tm-md
    environment:
      MYSQL_ENV_MYSQL_ROOT_PASSWORD: ${DB_ROOT_PASSWORD}
      MYSQL_ENV_MYSQL_USER: ${DB_USER}
      MYSQL_ENV_MYSQL_PASSWORD: ${DB_PASSWORD}
      MYSQL_ENV_MYSQL_DATABASE: ${DB_DATABASE}
    ports:
      - 8090:8080/tcp
    links:
      - squash-tm-md:mysql
    volumes:
      - squash-tm-logs:/opt/squash-tm/logs
      - squash-tm-plugins:/opt/squash-tm/plugins

volumes:
  squash-tm-logs:
  squash-tm-plugins:

.env 文件

.env文件示例：

DB_ROOT_PASSWORD=MustB3Ch4ng3d
DB_USER=squashtm
DB_PASSWORD=MustB3Ch4ng3d
DB_DATABASE=squashtm

运行docker-compose

1. 复制所需的docker-compose.yml文件。可在Bitbucket仓库找到多个配置：

   • 使用MariaDB数据库部署
   • 使用PostgreSQL数据库部署
   • 使用PostgreSQL和反向代理部署
   • 使用MariaDB和反向代理部署

2. 创建.env文件（或直接在docker-compose.yml中设置环境变量值）。

3. 在docker-compose.yml目录中运行 docker-compose up 或 docker-compose up -d（守护进程模式）。

4. 访问 http://localhost:8090/squash 或 http://{host_ip}:8090/squash。

更多docker-compose信息请参考官方文档。

环境变量

Squash TM镜像使用现有数据库容器的环境变量来连接数据库，以下是关键环境变量说明及官方文档链接。

PostgreSQL镜像环境变量

POSTGRES_PASSWORD

推荐使用的环境变量，设置PostgreSQL超级用户密码。默认超级用户由POSTGRES_USER定义。

POSTGRES_USER

可选环境变量，与POSTGRES_PASSWORD配合使用，创建用户及其密码。该用户将拥有超级用户权限，并创建同名数据库。未指定时默认使用postgres用户。

POSTGRES_DB

可选环境变量，指定镜像首次启动时创建的默认数据库名称。未指定时使用POSTGRES_USER的值。

更多信息请参考https://hub.docker.com/_/postgres%E3%80%82

MariaDB镜像环境变量

MYSQL_ROOT_PASSWORD

必填变量，设置MariaDB root超级用户密码。

MYSQL_DATABASE

可选变量，指定镜像启动时创建的数据库名称。若提供了用户/密码，该用户将被授予该数据库的超级用户权限（对应GRANT ALL）。

MYSQL_USER、MYSQL_PASSWORD

可选变量，配合使用以创建新用户并设置密码。该用户将被授予MYSQL_DATABASE指定数据库的超级用户权限。创建用户需同时指定这两个变量。

注意：无需通过此机制创建root超级用户，root用户默认使用MYSQL_ROOT_PASSWORD设置的密码创建。

更多信息请参考https://hub.docker.com/_/mariadb%E3%80%82

使用反向代理部署Squash TM容器

Bitbucket仓库提供两个在反向代理后部署Squash TM的docker-compose.yml示例：

• 使用PostgreSQL和反向代理部署
• 使用MariaDB和反向代理部署

这些方案使用https://hub.docker.com/r/jwilder/nginx-proxy%E9%95%9C%E5%83%8F%E3%80%82%E4%BB%A5%E4%B8%8B%E6%98%AF%E4%BD%BF%E7%94%A8PostgreSQL%E6%95%B0%E6%8D%AE%E5%BA%93%E5%92%8C%E5%8F%8D%E5%90%91%E4%BB%A3%E7%90%86%E7%9A%84%E9%83%A8%E7%BD%B2%E7%A4%BA%E4%BE%8B%EF%BC%9A

yaml
version: '3.7'
services:
  squash-tm-pg:
    container_name: squash-tm-pg
    environment:
      POSTGRES_DB: ${DB_DATABASE}
      POSTGRES_PASSWORD: ${DB_PASSWORD}
      POSTGRES_USER: ${DB_USER}
    image: postgres:9.6.12
    volumes:
      - /var/lib/db-postgresql:/var/lib/postgresql/data
    networks:
      - db-network

  squash-tm:
    depends_on:
      - squash-tm-pg
    environment:
      POSTGRES_ENV_POSTGRES_USER: ${DB_USER}
      POSTGRES_ENV_POSTGRES_PASSWORD: ${DB_PASSWORD}
      POSTGRES_ENV_POSTGRES_DB: ${DB_DATABASE}
      VIRTUAL_HOST: mysquash.example.com
    ports:
      - 8090:8080/tcp
    image: squashtest/squash-tm
    links:
      - squash-tm-pg:postgres
    volumes:
      - squash-tm-logs:/opt/squash-tm/logs
      - squash-tm-plugins:/opt/squash-tm/plugins
    networks:
      - nginx-proxy
      - db-network

  nginx-proxy:
    container_name: nginx
    image: jwilder/nginx-proxy
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - /var/run/docker.sock:/tmp/docker.sock:ro
    networks:
      - nginx-proxy

volumes:
  squash-tm-logs:
  squash-tm-plugins:

networks:
  nginx-proxy:
  db-network:

参考资料

• Squash-TM官方文档
• Squash TM Docker源码Bitbucket仓库
• https://hub.docker.com/_/postgres
• https://hub.docker.com/_/mariadb
• https://hub.docker.com/r/jwilder/nginx-proxy