Cucumber-Nagios 项目技术文档

1. 安装指南

1.1 安装 Ruby 和 RubyGems

在安装 cucumber-nagios 之前，确保你已经安装了 Ruby 和 RubyGems。如果你使用的是 Windows 系统，需要下载并安装 Ruby Installer 和 development kit。

1.2 安装 Cucumber-Nagios

使用以下命令安装 cucumber-nagios：

gem install cucumber-nagios

安装完成后，cucumber-nagios-gen 和 cucumber-nagios 命令将会添加到你的系统路径中。

2. 项目的使用说明

2.1 快速启动

按照以下步骤快速启动项目：

1. 安装 cucumber-nagios 的 gem：

   gem install cucumber-nagios
   

2. 生成一个新的项目：

   cucumber-nagios-gen project bunch-o-tests
   

3. 进入项目目录：

   cd bunch-o-tests
   

4. 安装依赖：

   bundle install
   

5. 生成一个新的功能测试：

   cucumber-nagios-gen feature ebay.com.au bidding
   

6. 运行测试：

   cucumber-nagios features/ebay.com.au/bidding.feature
   

2.2 设置项目

安装 cucumber-nagios 后，可以使用以下命令设置一个独立的项目：

cucumber-nagios-gen project <project-name>

该命令会在指定的目录中生成一系列文件。请查看生成的 README 文件以获取项目管理的具体说明。

2.3 设置无密码 SSH

为了使用 Aruba 的步骤定义与 SSH 会话，需要设置无密码认证。安装 cucumber-nagios 后，SSH 应该可以“自动工作”。当然，你的服务器需要接受这些连接。

3. 项目API使用文档

3.1 生成功能测试

使用 cucumber-nagios-gen 命令生成新的功能测试。该命令接受两个参数：要测试的站点和功能：

cucumber-nagios-gen feature gnome.org navigation

这将生成两个文件：

• features/gnome.org/navigation.feature
• features/gnome.org/steps/navigation_steps.rb

3.2 运行测试

使用 cucumber-nagios 脚本运行 Cucumber 功能测试：

cucumber-nagios features/smh.com.au/smh.feature

cucumber-nagios 可以从任何路径运行：

/path/to/bin/cucumber-nagios /path/to/features/smh/smh.feature

运行结果将以标准的 Nagios 格式返回：

Critical: 0, Warning: 0, 2 okay | passed=2, failed=0, total=2

3.3 自定义步骤

你可以编写自定义步骤来测试特定的输出和行为。例如，在 features/smh.com.au/smh.feature 中：

Feature: smh.com.au
  It should be up
  And provide links to content

  Scenario: Visiting home page
    When I go to http://smh.com.au/
    Then I should see site navigation
    And there should be a section named "Opinion"

在 features/smh.com.au/steps/smh_steps.rb 中编写自定义步骤：

Then /^I should see site navigation$/ do
  doc = Nokogiri::HTML(response.body.to_s)
  doc.css("ul#nav li a").size.should > 5
end

4. 项目安装方式

4.1 安装依赖

确保以下依赖已安装：

• RubyGems
• bundler gem（由 cucumber-nagios gem 自动拉取）

4.2 打包依赖

在项目目录中运行以下命令以打包依赖：

bundle install

4.3 部署到生产环境

将项目复制到监控服务器后，再次运行 bundle install：

bundle install

4.4 版本控制

强烈建议将 cucumber-nagios 项目存储在版本控制系统中。可以使用以下命令初始化 Git 仓库：

git init
git add .
git commit -m 'created cucumber-nagios project'

生成的项目中会自动创建 .gitignore 文件。