eloomi/unittest

unittest:v3 Docker镜像文档

镜像概述

unittest:v3是一个用于CI/CD管道中处理部署流程的基础Docker镜像。该镜像集成了PHP 7.1运行环境及多种部署所需工具，旨在为PHP项目的部署流程提供统一、便捷的执行环境，简化管道中的代码同步、依赖管理和单元测试等环节。

核心功能与特性

• PHP 7.1环境：提供PHP 7.1运行环境，支持基于该版本的PHP应用部署。
• 文件同步工具：集成rSync，支持高效的文件同步与传输。
• 远程操作支持：包含ssh客户端，可实现远程服务器的连接与操作。
• 压缩文件处理：内置unzip工具，支持解压各类压缩文件。
• PHP依赖管理：全局安装composer，便于PHP项目依赖的安装与管理。
• 单元测试支持：集成phpunit 5.7，可直接执行PHP项目的单元测试。

使用场景

• CI/CD管道中的部署阶段，用于执行代码同步、依赖安装、单元测试等部署前置操作。
• PHP 7.1项目的自动化部署流程，尤其是需要通过ssh远程操作、rSync文件同步的场景。
• 本地开发环境中快速搭建包含PHP 7.1及相关工具的临时执行环境。

使用方法与配置说明

基本使用

通过docker run命令启动容器：

bash
docker run --rm -it unittest:v3 /bin/bash

常用工具使用示例

1. 执行composer命令

bash
# 安装项目依赖
docker run --rm -v $(pwd):/app unittest:v3 composer install -d /app

2. 运行phpunit测试

bash
# 执行项目单元测试
docker run --rm -v $(pwd):/app unittest:v3 phpunit /app/tests

3. 使用rSync同步文件

bash
# 将本地文件同步至远程服务器
docker run --rm -v $(pwd):/source unittest:v3 rsync -avz /source user@remote-server:/target

4. 通过ssh连接远程服务器

bash
# 连接远程服务器（需提前挂载ssh密钥）
docker run --rm -v ~/.ssh:/root/.ssh unittest:v3 ssh user@remote-server

配置说明

• 挂载目录：建议将项目代码目录挂载至容器内（如-v $(pwd):/app），以便工具直接操作项目文件。
• SSH密钥：若需使用ssh或rsync的ssh模式，需将本地SSH密钥挂载至容器的/root/.ssh目录（如-v ~/.ssh:/root/.ssh）。
• 环境变量：可根据需要通过-e参数传递环境变量，如-e COMPOSER_CACHE_DIR=/tmp/composer-cache设置composer缓存目录。

docker-compose配置示例

yaml
version: '3'
services:
  deploy:
    image: unittest:v3
    volumes:
      - ./project:/app
      - ~/.ssh:/root/.ssh
    command: >
      sh -c "cd /app && 
             composer install && 
             phpunit tests && 
             rsync -avz /app user@remote-server:/var/www/project"