antithesishq/go-instrumentor

Antithesis Go 插桩工具容器镜像

镜像概述

本镜像为 Antithesis Go 插桩工具的容器化版本，旨在提供便捷的方式对 Go 应用程序进行插桩处理。通过容器化部署，简化了工具的安装与配置流程，使其可轻松集成到各类开发和测试环境中，支持 Antithesis 平台对 Go 应用的测试分析需求。

核心功能与特性

• 容器化部署：无需本地安装工具依赖，通过容器即可直接运行，简化环境配置。
• Go 应用插桩：支持对 Go 语言编写的应用程序进行插桩处理，为 Antithesis 平台的测试提供必要的代码注入。
• 环境隔离：容器化运行确保工具与宿主环境隔离，避免依赖冲突。

使用场景与适用范围

• Antithesis 平台测试集成：适用于需要通过 Antithesis 平台对 Go 应用进行测试的场景。
• CI/CD 流程集成：可集成到持续集成/持续部署流程中，实现自动化插桩处理。
• 开发环境测试：供开发人员在本地开发环境中快速进行插桩测试验证。

使用方法与配置说明

基本使用方式

通过 docker run 命令运行容器，挂载需要插桩的 Go 项目目录，并指定插桩参数：

bash
docker run --rm -v /path/to/your/go/project:/app antithesis-go-instrumentor [插桩选项]

参数说明

由于原始文档未提供详细参数，以下为通用插桩工具常见参数说明（具体请参考 Antithesis 官方文档）：

• -input：指定需要插桩的 Go 源代码目录路径（默认通常为容器内挂载的 /app 目录）。
• -output：指定插桩后代码的输出目录。
• -mode：插桩模式（如覆盖率分析、性能追踪等，具体取值需参考工具文档）。

示例：对 Go 项目进行插桩

假设本地 Go 项目路径为 ./my-go-project，执行以下命令进行插桩：

bash
docker run --rm -v $(pwd)/my-go-project:/app antithesis-go-instrumentor -input /app -output /app/instrumented -mode coverage

执行完成后，插桩后的代码将输出到 ./my-go-project/instrumented 目录中，可用于后续 Antithesis 平台测试。

注意事项

• 确保挂载的项目目录具有适当的读写权限，以便容器内工具能够读取源代码并写入插桩结果。
• 具体插桩选项和功能请以 Antithesis 官方文档为准，本镜像仅提供容器化运行环境。