Habitat项目开发环境搭建与构建指南

前言

Habitat是一个现代化的应用自动化管理工具，它通过将应用与其运行时环境打包在一起，实现了应用在任何环境中的一致性运行。本文将详细介绍如何在各种操作系统环境下搭建Habitat开发环境并进行项目构建。

官方支持环境：Ubuntu最新版（18.04/Bionic）

环境准备

Habitat官方推荐使用Ubuntu 18.04（Bionic）作为开发环境，无论是原生安装还是虚拟机环境均可。以下是详细步骤：

1. 安装Git（如未安装）：

   sudo -E apt-get install -y --no-install-recommends git
   

2. 克隆代码库：

   git clone https://github.com/habitat-sh/habitat.git
   cd habitat
   

3. 运行系统准备脚本：

   sh support/linux/install_dev_0_ubuntu_latest.sh
   sh support/linux/install_dev_9_linux.sh
   

4. 安装Docker（如需运行BATS集成测试）：

   sh support/linux/install_dev_8_docker.sh
   

Rust环境配置

Habitat使用Rust语言开发，需要正确配置Rust工具链：

1. 确保cargo可用：

   • 将$HOME/.cargo/bin添加到$PATH环境变量
   • 对于使用.profile的shell：

     source ~/.profile
     

   • 验证安装：

     cargo --version
     

2. 安装rustfmt：

   ./support/rustfmt_nightly.sh
   

   可以通过以下命令查看使用的rustfmt版本：

   echo $(< RUSTFMT_VERSION)
   

构建Habitat二进制文件

在项目根目录执行：

make

构建完成后，二进制文件位于habitat/target/debug目录下。可以通过以下方式运行：

1. 直接运行二进制文件
2. 使用cargo命令：

   cd components/sup
   cargo run -- --help
   cargo run -- status
   

   或从项目根目录：

   cargo run -p hab plan --help
   cargo run -p hab sup --help
   

针对非官方支持目标的构建

Habitat核心组件定义了多种目标平台特性。默认情况下，构建系统会启用所有官方支持的目标平台（x86_64-darwin、x86_64-linux等）。如需为实验性平台构建，需要手动启用相应特性。

添加新目标平台

1. 在components/core/src/package/target.rs中添加目标平台信息
2. 在habitat_core的Cargo.toml中添加对应特性
3. 在所有需要该特性的crate中添加包装特性
4. 添加条件逻辑

测试变更

环境变量覆盖

Habitat命令会调用其他二进制文件（如hab-sup）。默认情况下会使用已安装的版本，但可以通过以下环境变量覆盖：

• HAB_BUTTERFLY_BINARY
• HAB_LAUNCH_BINARY
• HAB_STUDIO_BINARY
• HAB_SUP_BINARY

例如：

export HAB_SUP_BINARY=/path/to/habitat/target/debug/hab-sup

或：

env HAB_SUP_BINARY=/path/to/habitat/target/debug/hab-sup hab sup status

单元测试

可以使用平台特定的CI脚本或直接使用cargo命令运行测试：

Linux：

.expeditor/scripts/verify/run_cargo_test.sh

Windows：

.expeditor/scripts/verify/run_cargo_test.ps1

直接使用cargo：

cargo +$(<RUST_NIGHTLY_VERSION) test

其他操作系统环境

Mac OS X开发环境

Linux开发环境（推荐）

1. 安装Docker for Mac
2. 克隆代码库
3. 运行make编译所有Rust组件
4. （可选）运行make test执行测试

进入开发环境shell：

make shell

原生开发环境（不推荐）

1. 克隆代码库
2. 运行准备脚本：

   cp components/hab/install.sh /tmp/
   sh support/mac/install_dev_0_mac_latest.sh
   sh support/mac/install_dev_9_mac.sh
   . ~/.profile
   export PKG_CONFIG_PATH="/usr/local/opt/openssl/lib/pkgconfig:/usr/local/lib/pkgconfig:$PKG_CONFIG_PATH"
   export IN_DOCKER=false
   make
   

其他Linux发行版

包括Ubuntu 14.04+、CentOS 7和Arch Linux等，具体步骤与Ubuntu类似，但需要使用对应的准备脚本。

Windows环境

基于Windows 10 1607（周年更新）或更高版本：

1. 克隆代码库
2. 运行构建脚本：

   cd habitat
   ./build.ps1 components/hab -configure
   

开发环境选择建议

虽然Docker镜像提供了便捷的入门体验，但对于长期开发，建议：

1. 使用原生Linux环境或专用Linux虚拟机
2. 避免将项目放在共享文件夹中构建
3. 可以使用项目根目录提供的Vagrantfile快速搭建Ubuntu开发环境

通过合理选择开发环境，可以显著提高构建效率，获得更好的开发体验。