wirepas/jenkins-builder

Jenkins Wirepas依赖环境镜像文档

一、镜像概述和主要用途

本镜像是专为Jenkins CI/CD流水线设计的环境镜像，预集成了Wirepas物联网通信协议开发所需的全部依赖组件。主要用途是为Jenkins提供开箱即用的Wirepas开发环境，支持在自动化流水线中执行Wirepas应用构建、测试脚本运行、固件生成等任务，避免因依赖缺失导致的流水线中断，提升开发与部署效率。

二、核心功能和特性

2.1 核心功能

• 预配置依赖：集成Wirepas SDK、编译工具链及相关运行时库，无需手动安装依赖。
• Jenkins适配：兼容Jenkins agent运行环境，支持通过docker run或Kubernetes插件集成至流水线。
• 多场景支持：覆盖Wirepas应用构建、单元测试、集成测试、固件打包等全流程需求。

2.2 关键特性

• 依赖完整性：包含Wirepas协议栈核心库、SDK工具、Python/Java运行时及专用测试框架。
• 版本可控：内置指定版本的Wirepas组件（具体版本需参考镜像标签），确保构建环境一致性。
• 轻量级设计：基于Alpine或Debian Slim基础镜像，平衡环境完整性与资源占用。
• 可扩展性：支持通过环境变量或挂载配置文件自定义依赖版本及运行参数。

三、使用场景和适用范围

3.1 典型使用场景

• Wirepas应用CI构建：在Jenkins流水线中编译Wirepas节点应用代码，生成可部署固件。
• 自动化测试执行：运行基于Wirepas协议的单元测试、通信模拟测试脚本。
• 固件版本管理：集成版本控制工具，自动生成带版本信息的Wirepas固件包。
• 文档自动生成：基于Wirepas代码注释生成API文档或开发手册。

3.2 适用范围

• 开发团队：用于本地开发环境与CI环境的依赖统一。
• 自动化测试团队：构建稳定的Wirepas测试基准环境。
• IoT设备制造商：在生产流水线中集成Wirepas固件生成流程。

四、使用方法和配置说明

4.1 前提条件

• 已安装Docker Engine（20.10+）或Docker Desktop。
• Jenkins服务器可访问镜像仓库（如Docker Hub、私有Registry）。

4.2 获取镜像

假设镜像托管于私有Registry，拉取命令示例：

bash
docker pull [registry-url]/jenkins-wirepas-deps:[tag]  # 替换为实际镜像地址和标签（如v1.2.0）

4.3 快速启动（独立运行）

通过docker run直接启动镜像，验证环境完整性：

bash
docker run -it --rm \
  -v $(pwd):/workspace \  # 挂载本地工作目录至容器
  -e WIREPAS_SDK_VERSION=2.4.0 \  # 指定Wirepas SDK版本（镜像支持范围内）
  [registry-url]/jenkins-wirepas-deps:[tag] \
  /bin/bash  # 进入交互终端验证依赖

4.4 Docker Compose配置示例

在Jenkins从节点或本地开发环境中，通过docker-compose.yml定义服务：

yaml
version: '3.8'
services:
  jenkins-wirepas-agent:
    image: [registry-url]/jenkins-wirepas-deps:[tag]
    volumes:
      - jenkins-workspace:/var/jenkins_home/workspace  # 持久化Jenkins工作目录
      - ./wirepas-config:/etc/wirepas  # 挂载自定义配置文件
    environment:
      - LOG_LEVEL=info  # 日志级别：debug/info/warn/error
      - TZ=Asia/Shanghai  # 时区配置
    restart: unless-stopped

volumes:
  jenkins-workspace:  # 声明持久化卷

4.5 环境变量说明

4.6 集成Jenkins流水线

在Jenkinsfile中使用本镜像作为构建环境：

groovy
pipeline {
  agent {
    docker {
      image '[registry-url]/jenkins-wirepas-deps:[tag]'
      args '-v /var/jenkins_home/workspace:/workspace'  # 挂载工作目录
    }
  }
  stages {
    stage('Build Wirepas App') {
      steps {
        sh '''
          # 示例：使用Wirepas SDK编译应用
          cd /workspace/wirepas-app
          wirepas-build --sdk-version $WIREPAS_SDK_VERSION --output firmware.bin
        '''
      }
    }
    stage('Run Tests') {
      steps {
        sh '''
          # 示例：运行Wirepas测试脚本
          cd /workspace/wirepas-tests
          pytest --wirepas-sdk-path /opt/wirepas/sdk
        '''
      }
    }
  }
}

4.7 持久化与数据挂载

• 工作目录：建议挂载/var/jenkins_home/workspace至宿主机或持久卷，避免流水线数据丢失。
• 配置文件：通过/etc/wirepas挂载自定义Wirepas配置（如网络参数、密钥文件）。
• 缓存目录：可挂载/root/.cache/wirepas缓存依赖包，加速重复构建。

五、注意事项

1. 版本兼容性：镜像标签与Wirepas SDK版本强关联，需根据项目需求选择匹配标签（如v1.2.0对应SDK 2.4.0）。
2. 资源需求：编译大型Wirepas项目时建议分配≥2核CPU及4GB内存，避免构建超时。
3. 依赖更新：如需升级Wirepas依赖，需重新拉取新版本镜像或通过WIREPAS_SDK_VERSION指定（需镜像支持动态版本切换）。
4. 安全配置：生产环境中建议限制容器权限，通过--user指定非root用户运行。