girder/tox-and-node

girder/large_image 镜像文档

1. 镜像概述和主要用途

该镜像源自 GitHub 项目 https://github.com/girder/large_image%EF%BC%8C%E6%98%AF%E4%B8%80%E4%B8%AA%E9%9B%86%E6%88%90%E4%BA%86 tox 和 Node.js 的专用构建环境镜像。主要用途是为项目提供标准化的构建和测试环境，支持自动化构建流程、多环境测试及相关开发任务的高效执行。

2. 核心功能和特性

2.1 集成 tox

• 提供 Python 项目的多环境自动化测试与构建能力，支持配置多版本 Python 运行时及依赖管理。
• 简化测试环境一致性维护，可通过 tox.ini 定义测试矩阵，自动创建隔离环境并执行测试命令。

2.2 集成 Node.js

• 内置 JavaScript 运行时环境，支持前端代码构建、依赖管理（如 npm/yarn）及脚本执行。
• 满足前端项目打包、静态资源处理等需求，适配现代前端开发流程。

2.3 构建环境优化

• 整合必要的基础构建工具，减少环境配置复杂性，确保构建流程的可重复性和一致性。

3. 使用场景和适用范围

3.1 本地开发与测试

• 开发人员在本地快速搭建一致的构建环境，执行代码编译、单元测试和集成测试。

3.2 CI/CD 自动化流程

• 作为持续集成/持续部署（CI/CD）环节的运行环境，自动化执行构建、测试任务，确保代码质量。

3.3 多语言项目构建

• 适用于同时包含 Python（后端）和 JavaScript（前端）代码的项目，统一构建工具链。

4. 详细使用方法和配置说明

4.1 镜像拉取

通过 Docker Hub 拉取最新版本镜像：

bash
docker pull girder/large_image

4.2 基础使用示例（docker run）

4.2.1 交互式运行容器

挂载本地项目目录并进入容器终端，手动执行构建命令：

bash
docker run -it --rm \
  -v $(pwd):/app  # 挂载当前目录到容器内 /app 路径  
  -w /app         # 设置工作目录为 /app  
  girder/large_image \
  /bin/bash       # 启动 bash 终端

4.2.2 运行 tox 测试

直接在容器中执行 Python 项目的 tox 测试（需项目根目录存在 tox.ini）：

bash
docker run --rm \
  -v $(pwd):/app \
  -w /app \
  girder/large_image \
  tox -e py39  # 运行 tox 并指定环境（如 Python 3.9）

4.2.3 运行 Node.js 构建命令

执行前端项目的依赖安装或打包（需项目根目录存在 package.json）：

bash
# 安装依赖
docker run --rm \
  -v $(pwd):/app \
  -w /app \
  girder/large_image \
  npm install

# 执行打包脚本
docker run --rm \
  -v $(pwd):/app \
  -w /app \
  girder/large_image \
  npm run build

4.3 配置说明

4.3.1 环境变量

目前无特定预设环境变量，可通过 -e 参数传递自定义变量，例如：

bash
docker run --rm \
  -e NODE_ENV=production \  # 设置 Node.js 环境为生产环境
  -v $(pwd):/app \
  -w /app \
  girder/large_image \
  npm run build

4.3.2 数据持久化

通过 -v 参数挂载本地目录（如示例中的 $(pwd):/app），确保项目文件、依赖缓存（如 node_modules、.tox）在容器重启后不丢失。

5. Docker 部署方案示例

5.1 docker-compose 配置示例

创建 docker-compose.yml 文件，定义构建服务：

yaml
version: '3'
services:
  build-env:
    image: girder/large_image
    volumes:
      - ./:/app           # 挂载本地项目目录
      - node_modules:/app/node_modules  # 持久化 npm 依赖
      - .tox:/app/.tox                  # 持久化 tox 环境缓存
    working_dir: /app
    command: tox  # 默认执行 tox 测试（可自定义为 npm run build 等）

volumes:
  node_modules:  # 声明持久化卷（避免重复安装依赖）
  .tox:          # 声明持久化卷（避免重复创建 tox 环境）

使用方法：在 docker-compose.yml 所在目录执行：

bash
# 启动服务并执行默认命令（tox）
docker-compose up

# 覆盖默认命令，执行 npm 构建
docker-compose run build-env npm run build

6. 注意事项

• 确保本地项目目录存在必要的配置文件（如 tox.ini 或 package.json），否则容器内命令可能执行失败。
• 持久化卷（如 node_modules、.tox）仅在使用 docker-compose 时生效，纯 docker run 需通过本地目录挂载实现缓存。