exfo/fms-ci-docker-whitesource

镜像概述

本镜像为预配置Whitesource依赖的构建环境，集成Whitesource客户端及相关工具，旨在帮助开发团队在软件开发构建过程中快速集成Whitesource的开源组件安全扫描与管理功能，减少环境配置时间，提升开发效率。

核心功能与特性

• 预安装Whitesource客户端：内置最新版Whitesource Unified Agent，支持开源组件扫描、漏洞检测及许可合规分析。
• 多构建工具兼容：适配Maven、Gradle、npm、Yarn、pip等主流构建工具，满足Java、JavaScript、Python等多技术栈项目需求。
• 简化依赖管理：自动解析项目依赖树，与Whitesource平台实时同步组件信息，无需手动维护依赖清单。
• 轻量级设计：基于Alpine或Ubuntu Slim基础镜像构建，减小体积并提升容器启动速度，优化资源占用。
• 灵活配置机制：支持通过环境变量或配置文件自定义扫描参数（如API密钥、项目名称、扫描范围、服务器地址等）。

使用场景与适用范围

• CI/CD流程集成：在持续集成/部署 pipeline 中自动执行Whitesource扫描，确保代码合并前开源组件安全性。
• 本地开发环境：开发者本地快速启动含Whitesource功能的构建环境，避免手动配置依赖及工具版本冲突。
• 多项目统一管理：适用于管理多技术栈项目，提供标准化Whitesource扫描环境，确保团队协作一致性。
• 开源合规检查：帮助团队遵循开源许可协议要求，自动识别潜在许可风险及漏洞组件。

使用方法与配置说明

基本使用步骤

1. 拉取镜像

   bash
   docker pull whitesource-build-env:latest  # 替换为实际镜像名称及标签
   

2. 启动容器并挂载项目

   bash
   docker run -it --rm \
     -v /本地项目路径:/app  # 挂载本地项目目录至容器内/app
     -e WHITESOURCE_API_KEY="your-api-key"  # Whitesource平台API密钥
     -e WHITESOURCE_PROJECT_NAME="your-project"  # 目标项目名称
     whitesource-build-env:latest
   

3. 执行Whitesource扫描
   根据项目类型在容器内运行对应命令：

   • Maven项目：mvn whitesource:scan
   • Gradle项目：gradle whitesourceScan
   • npm项目：whitesource run -d /app（需确保项目根目录含package.json）
   • Python项目：whitesource run -d /app --python（需提前安装项目依赖）

环境变量配置

持久化配置文件

在项目根目录创建whitesource.config文件自定义扫描规则，示例：

ini
apiKey=your-api-key
projectName=your-project
serverUrl=https://saas.whitesourcesoftware.com/agent  # 默认云服务地址
includes=**/*.jar,**/*.js,**/*.py  # 需扫描的文件类型
excludes=**/node_modules/**,**/target/**  # 排除路径

启动容器时挂载配置文件：

bash
docker run -it --rm \
  -v /本地项目路径:/app \
  -v /本地配置路径/whitesource.config:/opt/whitesource/ws-unified-agent.config \
  whitesource-build-env:latest

CI/CD集成示例（GitLab CI）

在.gitlab-ci.yml中添加扫描任务：

yaml
whitesource-scan:
  image: whitesource-build-env:latest
  stage: test
  variables:
    WHITESOURCE_API_KEY: $WHITESOURCE_API_KEY  # 从GitLab CI变量中获取密钥
    WHITESOURCE_PROJECT_NAME: "my-project"
  script:
    - cd /app
    - mvn whitesource:scan  # 根据项目类型调整命令
  only:
    - main
    - develop