fjudith/squash-tm

Squash-TM Docker镜像文档

镜像概述和主要用途

Squash TM是开源Squash工具包中的测试仓库管理器，支持在多项目环境中管理需求、测试用例和测试执行。本Docker镜像基于Tomcat:8-jre7官方镜像构建，提供便捷的容器化部署方式，并支持LDAP认证、反向代理配置等扩展功能。

核心功能和特性

• 基于Tomcat:8-jre7官方镜像构建，稳定可靠
• 支持多版本标签，包括1.18.4（latest）、1.18.0、1.17.4等
• 内置LDAP认证支持，可集成企业级身份验证
• 支持反向代理配置，适配HTTPS前端场景
• 支持多种数据库（H2、MySQL、PostgreSQL）
• 提供Kubernetes部署支持

已实现功能（Roadmap）

• 通过环境变量实现反向代理支持
• 修复反向代理配置时的容器重启问题
• LDAP认证支持

使用场景和适用范围

• 软件测试团队的测试用例和需求管理
• 多项目并行的测试流程管理
• 需要集成LDAP身份验证的企业环境
• 需通过反向代理实现HTTPS访问的场景
• 容器化部署环境（Docker、Kubernetes、Cloud Foundry）

使用方法和配置说明

快速启动

运行Squash-TM镜像：

bash
docker run --name='squash-tm' -it --rm -p 8080:8080 fjudith/squash-tm

注意：应用启动需要几分钟时间，首次运行时数据库初始化可能需要更长时间。可通过以下命令查看日志确认启动状态：

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

访问地址：http://localhost:8080/squash（Mac或Windows用户需将localhost替换为Docker主机IP，可通过docker-machine ip default获取）

默认登录信息：

• 用户名：admin
• 密码：admin

配置详情

持久卷

生产环境中建议持久化以下目录：

/usr/share/squash-tm/tmp                         # Jetty临时和工作目录
/usr/share/squash-tm/bundles                     # 捆绑包目录
/usr/share/squash-tm/conf                        # 配置目录
/usr/share/squash-tm/logs                        # 日志目录
/usr/share/squash-tm/jettyhome                   # Jetty主目录
/usr/share/squash-tm/luceneindexes               # Lucene索引目录
/usr/share/squash-tm/plugins                     # 插件目录

环境变量

数据库配置

默认数据库类型为H2，可通过以下变量切换为MySQL或PostgreSQL：

• DB_TYPE：数据库类型，可选值h2、mysql、postgresql，默认值=mysql
• DB_HOST：数据库主机名，默认值=mysql
• DB_PORT：数据库端口（MySQL默认3306，PostgreSQL默认5432），默认值=3306
• DB_NAME：数据库名称，默认值=squash-tm
• DB_USERNAME：数据库用户名，默认值=root
• DB_PASSWORD：数据库密码，默认值=root
• DB_URL：数据库连接URL，默认值=jdbc:${DB_TYPE}://${DB_HOST}:${DB_PORT}/$DB_NAME

反向代理配置

支持反向代理（如HTTPS前端的haproxy）：

• REVERSE_PROXY_HOST：完全限定域名（例如squashtm.example.com）
• REVERSE_PROXY_PORT：反向代理监听端口，默认值=443
• REVERSE_PROXY_PROTOCOL：协议（http或https），默认值=https

LDAP认证配置

• LDAP_ENABLED：启用LDAP认证，默认值=false

• LDAP_PROVIDER：选择"ldap"或"ad-ldap"

• LDAP_URL：LDAP服务器URL（含端口），默认值=ldap://example.com:389

• LDAP_SECURITY_MANAGERDN：管理LDAP认证的用户DN，默认值=***

• LDAP_SECURITY_MANAGERPASSWORD：LDAP管理员密码，默认值=password

• LDAP_FETCH_ATTRIBUTES：是否获取属性，默认值=true

  搜索选项1

  • LDAP_USER_DNPATTERNS：示例=uid={0},ou=people

  搜索选项2（推荐）

  • LDAP_USER_SEARCHFILTER：用户对象搜索过滤器，示例=(&(objectclass=user)(userAccountControl:1.2.840.***.1.4.803:=512))
  • LDAP_USER_SEARCHBASE：登录名属性（Active Directory使用"sAMAccountName"替代"uid"），默认值=(uid={0})

部署示例

使用PostgreSQL部署

数据库由数据库容器创建，应用容器首次运行时自动初始化：

bash
docker run -it -d --name squash-tm-pg \
--restart=always \
-e POSTGRES_USER=squashtm \
-e POSTGRES_PASSWORD=Ch4ng3M3 \
-e POSTGRES_DB=squashtm \
-v squash-tm-db:/var/lib/postgresql \
postgres

sleep 10

docker run -it -d --name=squash-tm \
--link squash-tm-pg:postgres \
--restart=always \
-p 32760:8080 \
fjudith/squash-tm

等待2-3分钟初始化完成后，访问http://localhost:32760/squash-tm

使用MySQL部署

bash
docker run -it -d --name squash-tm-md \
-e MYSQL_ROOT_PASSWORD=Ch4ng3M3 \
-e MYSQL_USER=squashtm \
-e MYSQL_PASSWORD=Ch4ng3M3 \
-e MYSQL_DATABASE=squashtm \
-v squash-tm-db:/var/lib/mysql \
mariadb --character-set-server=utf8_bin --collation-server=utf8_bin

sleep 10

docker run -it -d --name=squash-tm \
--link squash-tm-md:mysql \
-p 32760:8080 \
fjudith/squash-tm

等待2-3分钟初始化完成后，访问http://localhost:32760/squash-tm

Docker-Compose配置

以下示例启用Postgres数据库和反向代理SSL卸载：

yaml
squash-tm-pg:
  environment:
    POSTGRES_DB: squashtm
    POSTGRES_PASSWORD: Ch4ng3M3
    POSTGRES_USER: squashtm
  image: postgres
  volumes:
  - squash-tm-db:/var/lib/postgresql

squash-tm:
  environment:
    REVERSE_PROXY_HOST: squashtm.example.com
    REVERSE_PROXY_PORT: 443
    REVERSE_PROXY_PROTOCOL: https
  ports:
  - 32760:8080/tcp
  image: fjudith/squash-tm
  links:
  - squash-tm-pg:postgres
  volumes:
  - squash-tm-tmp:/usr/share/squash-tm/tmp
  - squash-tm-bundles:/usr/share/squash-tm/bundles
  - squash-tm-logs:/usr/share/squash-tm/logs
  - squash-tm-jettyhome:/usr/share/squash-tm/jettyhome
  - squash-tm-luceneindexes:/usr/share/squash-tm/luceneindexes
  - squash-tm-plugins:/usr/share/squash-tm/plugins

Cloud Foundry manifest.yml

yaml
---
applications:
- name: squashtm
  docker:
    image: fjudith/squash-tm
  instances: 1
  memory: 1G
  disk_quota: 1G
  env: 
    DB_HOST: <database-service-host>
    DB_PORT: <database-service-port>
    DB_TYPE: <database-type>
    DB_NAME: <database-name>
    DB_USERNAME: <username>
    DB_PASSWORD: <password>
    REVERSE_PROXY_HOST: squashtm.your-cf.domain
    REVERSE_PROXY_PORT: 443
    REVERSE_PROXY_PROTOCOL: https

更多信息：[***]

参考资料

• [***]
• https://github.com/Logicify/docker-squash-tm
• [***]
• [***]