macOS环境下搭建本地W3C VNU验证服务器并用于Rails测试

1. 安装VNU HTML验证器 #

通过Homebrew安装官方VNU验证工具：

brew install vnu

2. 启动本地VNU验证服务器 #

安装完成后，执行以下命令启动本地验证服务器（端口设为8888，可自行修改）：

java -jar $(brew --prefix vnu)/libexec/vnu.jar --port 8888

启动成功后会输出类似信息：Server started on port 8888

3. 配置w3c_validators gem连接本地服务 #

在Rails项目中，创建测试环境专属的初始化文件（如config/initializers/w3c_validators.rb），添加以下配置：

if Rails.env.test?
  # 替换默认W3C官方验证地址为本地服务器
  W3CValidators::Validator.set_validator_url(:html, 'http://localhost:8888/')
end

若不想新增文件，也可直接将上述代码添加到test/test_helper.rb的开头。

4. 编写HTML验证测试用例 #

在系统测试或功能测试中，使用w3c_validators验证页面HTML合法性，示例代码：

require 'test_helper'

class HomePageValidationTest < ActionDispatch::SystemTestCase
  test "home page contains valid HTML" do
    visit root_path
    validator = W3CValidators::MarkupValidator.new
    validation_results = validator.validate_text(page.html)

    # 断言页面无HTML验证错误
    assert_empty validation_results.errors, 
      "HTML validation failed:\n#{validation_results.errors.map { |err| "#{err.line}: #{err.message}" }.join('\n')}"
  end
end

5. 运行测试 #

确保本地VNU服务器处于运行状态，执行测试命令：

# 系统测试
rails test:system
# 功能测试
rails test

可选：自动管理服务器（进阶） #

若不想每次手动启停服务器，可借助foreman实现自动化：

1. 安装foreman：brew install foreman
2. 创建Procfile.test文件：

   vnu: java -jar $(brew --prefix vnu)/libexec/vnu.jar --port 8888
   

3. 启动测试时执行：

   foreman start -f Procfile.test -d . & rails test:system; pkill -f vnu
   

该命令会自动启动VNU服务器，测试完成后自动终止进程。

内容的提问来源于stack exchange，提问作者Masa Sakano