asecurityteam/sdcli

SDCLI - 安全开发仓库工具

!Build Status

状态：孵化中

镜像概述与主要用途

SDCLI 是一个 Docker 镜像，作为 Atlassian 安全开发团队的命令行工具（CLI），用于仓库管理。它集成了项目创建、测试执行、CI 自动化等工具，旨在保持仓库构建流程的一致性。通过容器化方式提供统一的开发环境，确保团队成员使用相同版本的工具链，简化开发流程并提高协作效率。

核心功能与特性

SDCLI 提供以下核心功能模块，涵盖多语言项目管理、代码质量保障及仓库标准化配置：

命令功能概览

bash
sdcli
  go                  # Go 项目管理工具
      dep             # 安装 Go 项目依赖
      lint            # 执行标准 Go 代码检查
      test            # 运行单元测试
      integration     # 运行集成测试
      coverage        # 生成测试覆盖率报告
  repo                # 仓库标准化工具
      all             # 通用仓库工具
          add-oss     # 添加开源许可证及贡献指南文件
          audit-contract # 验证仓库是否符合团队规范
      go              # Go 仓库专用工具
          add-docker  # 添加 Dockerfile
          add-layout  # 生成标准项目结构
          add-lint    # 添加代码检查配置
          add-travis  # 添加 Travis CI 配置
          create      # 生成完整 Go 项目（基于模板）
      build           # 启动交互式构建流程
  python              # Python 项目管理工具
      dep             # 安装 Python 项目依赖
      lint            # 使用 flake8 执行代码检查
      test            # 运行单元测试
      coverage        # 生成测试覆盖率报告
  yaml                # YAML 文件检查工具
      lint            # 对当前目录所有 YAML 文件执行 yamllint 检查
  version             # 列出 SDCLI 中安装的语言及工具版本

使用场景与适用范围

SDCLI 适用于 Atlassian 安全开发团队的日常开发与仓库管理，主要场景包括：

• 新项目初始化：通过模板快速生成 Go/Python 项目结构，自动配置 Dockerfile、CI 配置、代码检查规则等。
• 依赖管理：统一安装 Go（go dep）、Python（python dep）项目依赖，避免环境差异。
• 代码质量保障：执行标准化 lint（go lint、python lint、yaml lint）、测试（go test、python test）及覆盖率分析。
• 仓库规范审计：验证仓库是否符合团队契约（repo all audit-contract），确保开源合规性（repo all add-oss）。

使用方法与配置说明

拉取镜像

SDCLI 以 Docker 镜像形式分发，首先拉取最新版本：

bash
docker pull asecurityteam/sdcli:v1

基本运行命令

通过 docker run 执行 SDCLI 命令，需挂载本地项目目录及 SSH 认证代理（如需 Git 操作）。以下为通用命令模板：

Linux 系统（需挂载 SSH 认证代理）

bash
export cwd=$(pwd)
export project_path=${cwd#"${GOPATH}/src/"}  # 提取 GOPATH 相对路径
docker run -ti \
    # 挂载 SSH 认证代理（用于 Git 仓库访问）
    --mount src="${SSH_AUTH_SOCK}",target="/ssh-agent",type="bind" \
    --env SSH_AUTH_SOCK=/ssh-agent \
    # 挂载当前项目目录到容器内 GOPATH
    --mount src="$(pwd -L)",target="/go/src/${project_path}",type="bind" \
    # 设置容器工作目录为项目路径
    -w "/go/src/${project_path}" \
    # 执行具体命令（示例：运行 Go 单元测试）
    asecurityteam/sdcli:v1 go test

Mac 系统（无需 SSH 挂载）

省略 SSH 代理挂载参数：

bash
export cwd=$(pwd)
export project_path=${cwd#"${GOPATH}/src/"}
docker run -ti \
    --mount src="$(pwd -L)",target="/go/src/${project_path}",type="bind" \
    -w "/go/src/${project_path}" \
    asecurityteam/sdcli:v1 go test  # 示例命令

配置别名函数（bash）

为简化命令输入，可将以下函数添加到 .bashrc 或 .bash_profile，自动处理路径与挂载：

bash
sdcli() {
    local cwd
    local gopath
    cwd="$(pwd)"
    gopath="${GOPATH:-~/go}"  # 默认 GOPATH 为 ~/go（如未显式设置）
    # 提取项目在 GOPATH 中的相对路径
    local project_path=${cwd#"${gopath}/src/"}
    docker run -ti --rm \
        # Linux 需保留以下两行，Mac 需删除
        --mount src="${SSH_AUTH_SOCK}",target="/ssh-agent",type="bind" \
        --env "SSH_AUTH_SOCK=/ssh-agent" \
        # 挂载项目目录并设置工作目录
        --mount src="$(pwd -L)",target="/go/src/${project_path}",type="bind" \
        -w "/go/src/${project_path}" \
        asecurityteam/sdcli:v1 "$@"  # 传递用户输入的命令参数
}

配置后即可直接通过 sdcli <命令> 调用，例如：

bash
sdcli go lint          # 执行 Go 代码检查
sdcli python dep       # 安装 Python 依赖
sdcli yaml lint        # 检查 YAML 文件

非 bash Shell 配置（如 fish）

fish Shell 函数定义

创建 ~/.config/fish/functions/sdcli.fish（权限设为 755）：

bash
function sdcli
    set cwd (pwd)
    set gopath "$GOPATH"
    if test -z "$gopath"
        set gopath ~/go  # 默认 GOPATH
    end
    set project_path (string replace "$gopath/src/" "" $cwd)  # 提取相对路径
    docker run --rm \
        --mount src="$cwd",target="/go/src/$project_path",type="bind" \
        -w "/go/src/$project_path" \
        asecurityteam/sdcli:v1 $argv
end

解决交互式命令问题

非 bash Shell（如 fish）可能因 TTY 配置导致交互式命令失败（如提示“no TTY for interactive shell”）。可通过以下两种方式解决：

1. 非交互式模式：显式指定所有参数，禁用交互提示：

   bash
   sdcli repo go create -- project_name="myproject" project_description="描述" --no-input
   

2. 手动进入容器执行：以 bash 为入口点进入容器，再运行命令：

   bash
   docker run -it \
       --entrypoint "/bin/bash" \
       --mount src="$cwd",target="/go/src/$project_path",type="bind" \
       -w "/go/src/$project_path" \
       asecurityteam/sdcli:v1
   # 容器内执行命令
   /usr/bin/sdcli go test
   

从模板生成新项目

SDCLI 基于 cookiecutter 模板生成项目，支持交互式（默认）和非交互式两种模式。推荐非交互式模式以简化输入：

非交互式生成 Go 项目

bash
sdcli repo go create -- \
    project_name="我的项目" \
    project_description="这是一个基于 SDCLI 生成的 Go 项目" \
    --no-input  # 禁用交互提示，直接使用参数生成

交互式生成

省略 --no-input 及参数，通过终端提示输入项目信息：

bash
sdcli repo go create  # 按提示输入 project_name、project_description 等

扩展命令（添加自定义命令）

SDCLI 支持通过添加可执行文件扩展命令。命令命名规则为：子命令通过下划线连接，例如 sdcli my feature 会调用容器内 /commands/sdcli_my_feature 可执行文件。

添加步骤

1. 在 SDCLI 项目的 ./commands 目录中创建可执行文件，命名格式为 sdcli_<子命令1>_<子命令2>...（如 sdcli_demo_cmd）。
2. 文件需具备执行权限（chmod +x）。
3. 重新构建 Docker 镜像后，即可通过 sdcli demo cmd 调用。

环境变量与配置参数说明