22、使用RSpec和Sinatra进行高效测试与服务原型开发

time3

于 2025-12-03 10:19:13 发布

阅读量21

点赞数

CC 4.0 BY-SA版权

分类专栏： Ruby企业开发实战精要文章标签： RSpec Sinatra 模拟对象

本文链接：https://blog.youkuaiyun.com/time3/article/details/155546127

Ruby企业开发实战精要专栏收录该内容

23 篇文章 ¥499.90

订阅专栏¥69.90

会员秒杀 ¥9.9 重磅福利

超级会员免费看

使用RSpec和Sinatra进行高效测试与服务原型开发

1. 使用RSpec创建模拟对象

1.1 问题背景

在使用RSpec测试应用程序时，会遇到一些问题。一方面，很多测试频繁访问数据库，导致测试耗时过长；另一方面，部分测试依赖外部服务，这使得测试变得困难，具体表现如下：
- 无法保证外部服务始终可用，若服务不可用，部分测试用例将无法正常运行。
- 不能要求服务提供商关闭服务来测试应用在网络故障时的行为，也无法要求提供商返回特定错误条件以测试应用的处理能力。
- 即使是测试请求，也可能需要为每个服务请求付费，这会使测试套件成本高昂。
- 有些服务没有测试接口，且不想使用真实数据进行测试。

1.2 解决方案

使用模拟对象来解决这些问题。模拟对象常用于单元测试，可将其视为真实对象的“碰撞测试假人”。例如，不使用真实数据库测试应用，而是使用模拟对象，这些模拟对象表现得如同访问真实数据库一样，提供相同的API，但其行为可由程序员完全控制。

1.3 示例场景

假设构建了一个运送产品的网上商店，为满足客户需求，添加了跟踪功能，让客户查看货物的当前状态。物流服务提供了一个用于跟踪包裹的RESTful Web服务，其URL格式为 /package-history/:tracking_number ，会返回如下XML文档：

<?xml version="1.0" encoding="UTF-8"?>
<package-history id="42-xyz-4711">
  <steps>
    <step ts="2008-10-09 00:45">Received package</step>
    <step ts="2008-10-10 08:23">First delivery attempt</step>
    <step ts="2008-10-10 08:24">Receiver not at home</step>
    <step ts="2008-10-11 09:51">Second delivery attempt</step>
    <step ts="2008-10-11 09:53">Delivered</step>
  </steps>
  <state>delivered</state>
</package-history>

以下是使用Ruby编写的该服务的客户端代码：

require 'open-uri'
require 'rexml/document'

class TrackingService
  def initialize(url = 'http://localhost:4567')
    @url = url
  end

  def track(tracking_number)
    request_uri = "#{@url}/package-history/#{tracking_number}"
    doc = REXML::Document.new(open(request_uri).read)
    doc.elements['/package-history/state'].text
  end
end

1.4 创建控制器和模型

创建 ShipmentController 和 Order 模型：

./script/generate rspec_controller Shipment
./script/generate rspec_model Order

数据库中订单的定义如下：

create_table :orders do |t|
  t.string :product, :tracking_number
  t.integer :quantity
  t.timestamps
end

ShipmentController 中用于跟踪订单的代码如下：

class ShipmentController < ApplicationController
  def track
    @order = Order.find(params[:id])
    @state = begin
      TrackingService.new.track(@order.tracking_number)
    rescue
      :unavailable
    end
  end
end

1.5 编写测试用例

在编写第一个测试用例前，创建一个数据夹具，确保数据库中至少有一个订单：

beer:
  id: 1
  product: Beer
  quantity: 6
  tracking_number: 42-xyz-4711

第一个 ShipmentController 的测试用例如下：

describe ShipmentController, 'track' do
  fixtures :orders

  it 'should track package correctly' do
    get :track, :id => orders(:beer)
    assigns[:state].should eql('delivered')
  end
end

运行测试时失败了，因为没有真正的跟踪服务，客户端尝试打开连接时出错。

1.6 使用模拟对象

为测试控制器的行为，需要模拟一个真实的跟踪服务，创建模拟对象返回常量结果：

describe ShipmentController, 'track with mock service' do
  fixtures :orders

  before :each do
    tracking_service = mock('tracking service')
    tracking_service.stub!(:track).and_return('delivered')
    TrackingService.stub!(:new).and_return(tracking_service)
  end

  it 'should track package correctly' do
    get :track, :id => orders(:beer)
    assigns[:state].should eql('delivered')
  end
end

再次运行测试，测试通过。

1.7 模拟服务不可用

模拟跟踪服务不可用的情况：

describe ShipmentController, 'tracking service unavailable' do
  fixtures :orders

  before :each do
    tracking_service = mock('unavailable tracking service')
    tracking_service.stub!(:track).and_raise(IOError)
    TrackingService.stub!(:new).and_return(tracking_service)
  end

  it 'should not be able to track package' do
    get :track, :id => orders(:beer)
    assigns[:state].should eql(:unavailable)
  end
end

1.8 模拟模型

为了进一步解耦，还可以模拟模型：

describe ShipmentController, 'track with mock model' do
  before :each do
    order = mock_model(Order, :tracking_number => '42')
    Order.stub!(:find).and_return(order)
    tracking_service = mock('tracking service')
    tracking_service.stub!(:track).and_return('delivered')
    TrackingService.stub!(:new).and_return(tracking_service)
  end

  it 'should track package correctly without database access' do
    get :track, :id => 42
    assigns[:state].should eql('delivered')
  end
end

1.9 检查模拟对象的使用情况

RSpec 提供了一些方法来检查模拟对象的使用情况，例如：

describe ShipmentController, 'track with expectation' do
  fixtures :orders

  before :each do
    @tracking_service = mock('tracking service')
    @tracking_service.stub!(:track).and_return('delivered')
    TrackingService.stub!(:new).and_return(@tracking_service)
  end

  it 'should track package correctly' do
    @tracking_service.should_receive(:track).with('42-xyz-4711').once.and_return('delivered')
    get :track, :id => orders(:beer)
    assigns[:state].should eql('delivered')
  end
end

RSpec 还有很多用于检查模拟对象的方法，如下所示：

mock.should_receive(:method).with(no_args())
mock.should_receive(:method).with(any_args())
mock.should_receive(:method).with(/foo/)
mock.should_receive(:method).with('foo', anything(), true)
mock.should_receive(:method).with(duck_type(:walk, :talk))
mock.should_receive(:method).twice
mock.should_receive(:method).exactly(3).times
mock.should_receive(:method).at_least(:once)
mock.should_receive(:method).at_most(:twice)
mock.should_receive(:method).any_number_of_times

1.10 小结

模拟对象不仅能加快测试速度，更重要的是能帮助测试软件在极端条件下的行为。当需要与外部组件（如 Web 服务、数据库、文件系统等）集成时，为它们创建模拟对象，并尽可能多地测试边界情况。

2. 使用 Sinatra 进行服务原型开发

2.1 问题背景

公司采用面向服务的架构，每个新应用由分布式 REST 组件组成。组件独立开发，通常在后期进行集成测试。为了提前开始集成测试，构建服务原型很有帮助。

2.2 解决方案

使用 Sinatra 来创建 REST 服务的原型。Sinatra 是一种用于创建 Web 应用程序的领域特定语言，相比 Rails，它更适合构建小型应用或原型，因为代码不会分散在多个文件中。

2.3 示例场景

2.4 数据库设置

使用 SQLite 作为数据库，创建一个用于存储产品的表：

require 'sinatra'
require 'activerecord'

configure do
  ActiveRecord::Base.establish_connection(
    :adapter => 'sqlite3',
    :database => './catalog.db',
    :timeout => 5000
  )

  class CreateProducts < ActiveRecord::Migration
    def self.up
      create_table :products, :force => true do |t|
        t.string :name
        t.decimal :price, :precision => 10, :scale => 2
      end
    end
  end

  CreateProducts.up

  class Product < ActiveRecord::Base
    validates_uniqueness_of :name
  end

  Product.create(:name => 'Beer', :price => 6.99)
end

configure 块中的代码仅会执行一次，避免在开发模式下每次请求都重新创建数据库。

2.5 实现 REST 端点

2.5.1 获取所有产品

get '/products' do
  header 'Content-Type' => 'text/xml; charset=utf-8'
  products = Product.find(:all)
  builder do |xml|
    xml.instruct!
    xml.products do
      products.each do |product|
        xml.product :name => product.name, :price => product.price
      end
    end
  end
end

启动服务：

ruby catalog.rb -e development

发起第一个请求：

curl -i http://localhost:4567/products

2.5.2 获取单个产品

helpers do
  def product_to_xml(xml, product)
    xml.product :name => product.name, :price => product.price
  end
end

get '/products/:id' do
  header 'Content-Type' => 'text/xml; charset=utf-8'
  unless product = Product.find_by_id(params[:id])
    response.status = 404
  else
    builder do |xml|
      xml.instruct!
      product_to_xml(xml, product)
    end
  end
end

发起请求：

curl http://localhost:4567/products/1

2.5.3 添加产品

require 'rexml/document'

post '/products' do
  xml = request.env['rack.input'].read
  doc = REXML::Document.new(xml)
  product = Product.create(
    :name => doc.elements['/product/@name'].value,
    :price => doc.elements['/product/@price'].value.to_f
  )
  header 'Location' => "/products/#{product.id}"
  response.status = 201
end

添加产品：

curl -i -H 'content-type:text/xml' -d @product.xml http://localhost:4567/products

2.5.4 删除产品

delete '/products/:id' do
  if Product.exists?(params[:id])
    Product.delete(params[:id])
  else
    response.status = 404
  end
end

尝试删除不存在的产品：

curl -i -X DELETE http://localhost:4567/products/42

2.6 其他特性

2.6.1 静态文件服务

Sinatra 会自动提供 public 目录下的静态文件，例如：

curl http://localhost:4567/README

2.6.2 模板支持

Sinatra 支持 ERb、HAML 和 SASS 模板，以下是创建 HTML 视图的代码：

get '/screen.css' do
  header 'Content-Type' => 'text/css; charset=utf-8'
  sass :screen
end

get '/catalog' do
  @products = Product.find(:all)
  haml :catalog
end

catalog.haml 文件内容如下：

%html
  %head
    %title Our Fancy Catalog
    %link{:rel => 'stylesheet', :href => '/screen.css', :type => 'text/css', :media => 'screen'}
  %body
    %h2 Our Catalog:
    #content
      %ol
        = list_of(@products) do |p|
          = "#{p.name} ($#{p.price})"

sass 文件内容如下：

body
  font-family: sans-serif
content
  padding: 1em

2.7 小结

使用 Sinatra 可以在短时间内创建 REST 服务的原型，它不仅实现了所需的端点，还提供了一些实用的功能，如静态文件服务和模板支持。Sinatra 非常适合用于快速验证想法和提前开始集成测试。

2.8 流程总结

下面通过 mermaid 流程图来总结使用 Sinatra 构建目录服务原型的整体流程：

graph LR
    A[安装 Sinatra 和 haml 宝石] --> B[配置数据库]
    B --> C[定义产品表结构]
    C --> D[实现 REST 端点]
    D --> E[获取所有产品]
    D --> F[获取单个产品]
    D --> G[添加产品]
    D --> H[删除产品]
    E --> I[启动服务]
    F --> I
    G --> I
    H --> I
    I --> J[发起请求测试服务]

2.9 深入理解 Sinatra 特性

2.9.1 路由机制

Sinatra 的路由机制是其核心特性之一。它通过 HTTP 动词和 URI 模式来匹配请求，并执行相应的代码块。例如：

get '/products' do
  # 处理获取所有产品的逻辑
end

get '/products/:id' do
  # 处理获取指定 ID 产品的逻辑
end

post '/products' do
  # 处理创建新产品的逻辑
end

delete '/products/:id' do
  # 处理删除指定 ID 产品的逻辑
end

这种路由方式简洁明了，使得开发者可以轻松定义不同的服务端点。

2.9.2 中间件和过滤器

虽然在上述示例中未详细提及，但 Sinatra 也支持中间件和过滤器。中间件可以在请求到达路由之前或响应返回客户端之前进行一些预处理或后处理操作。过滤器则可以在特定的路由执行前后执行代码。例如：

before do
  # 在每个请求之前执行的代码
end

after do
  # 在每个请求之后执行的代码
end

2.9.3 错误处理

Sinatra 提供了简单的错误处理机制。可以通过 error 块来捕获并处理特定类型的错误。例如：

error Sinatra::NotFound do
  status 404
  'Page not found'
end

当请求的路由不存在时，会返回 404 状态码和相应的错误信息。

2.10 对比 RSpec 和 Sinatra 的应用场景

工具	应用场景	优点	缺点
RSpec	单元测试、模拟外部服务和组件	加快测试速度，可模拟极端条件，便于测试软件行为	需要一定的学习成本来掌握模拟对象的使用
Sinatra	快速构建服务原型、小型 Web 应用	代码简洁，开发速度快，适合快速验证想法	对于大型复杂应用，可能缺乏一些高级功能和扩展性

2.11 总结与展望

在软件开发过程中，RSpec 和 Sinatra 是两个非常实用的工具。RSpec 可以帮助我们高效地进行单元测试，通过模拟对象解决测试中依赖外部服务和耗时过长的问题，确保软件在各种条件下的稳定性和正确性。而 Sinatra 则为我们提供了一种快速创建 REST 服务原型的方法，使得我们可以在项目早期就开始进行集成测试，验证服务的可行性和功能。

未来，随着软件开发技术的不断发展，我们可以进一步探索如何将 RSpec 和 Sinatra 与其他工具和框架相结合，以满足更复杂的开发需求。例如，可以将 RSpec 与持续集成工具集成，实现自动化测试；将 Sinatra 与前端框架结合，构建完整的 Web 应用。同时，也可以不断优化和改进使用这两个工具的方法和技巧，提高开发效率和软件质量。

总之，掌握 RSpec 和 Sinatra 的使用方法，对于提升软件开发能力和效率具有重要意义。希望本文能为开发者在实际项目中应用这两个工具提供一些参考和帮助。