Implementa un health check endpoint en Rails con RSpec y TDD para asegurar servicios confiables y monitoreables. Aprenderás a validar el estado de tu API con pruebas de integración, a responder en JSON con status code 200 y a configurar rutas y controladores de forma clara y mantenible.
¿Qué es un health check endpoint y para qué sirve?
Un health check es un endpoint convencional como /health o /health_check que responde con 200 cuando el servicio está operativo. Es una buena práctica porque permite el monitoreo continuo por herramientas como Pingdom o Runscope mediante un request periódico. Además, se relaciona con páginas de estado públicas como las de Heroku, GitHub o Twitter, usadas para verificar si una aplicación está en buen estado.
Verificar disponibilidad del servicio con un request simple.
Integración con Pingdom y Runscope a través de /health.
Responder con 200 cuando todo está ok.
Alertar al equipo si hay error o no hay respuesta.
¿Cómo escribir pruebas de integración con RSpec para el health endpoint?
La estrategia es TDD: primero se escriben las pruebas, luego la funcionalidad. Crea el directorio spec/requests para pruebas de integración y un archivo health_spec.rb. Incluye rails_helper y declara el tipo request para disponer de helpers como response y have_http_status.
# spec/requests/health_spec.rbrequire'rails_helper'RSpec.describe 'Health Endpoint',type::requestdo describe 'GET /health'do before { get '/health'} it 'should return ok'do payload =JSON.parse(response.body) expect(payload).not_to be_empty
expect(payload['api']).to eq('ok')end it 'should return status code 200'do expect(response).to have_http_status(:ok)endendend
Pruebas de integración con type: :request para validar de extremo a extremo.
before ejecuta el requestget '/health' antes de cada ejemplo.
response.body y JSON.parse para obtener el payload.
have_http_status(:ok) valida el status code 200 de forma expresiva.
Pruebas autodescriptivas con it 'should return ok' para claridad.
¿Qué errores comunes se observaron al correr RSpec?
Al ejecutar las pruebas primero fallan, lo esperado en TDD. Se mencionan errores típicos y su solución directa:
"La constante RSpec no está inicializada": usar RSpec con la S en mayúscula.
"No existe una ruta para /health": agregar la ruta y el controlador.
¿Cómo implementar el controlador y la ruta en Rails?
Crea health_controller.rb heredando de ApplicationController. Define la acción que responde con un payload mínimo y status 200 usando la constante de Rails :ok.
Agrega la ruta para el endpoint/health apuntando a la acción health.
# config/routes.rbRails.application.routes.draw do get 'health',to:'health#health'end
render json: define el payload en JSON.
status: :ok traduce a 200 automáticamente.
Ruta GET /health conectada a health#health.
¿Qué incluye el payload del health check?
La idea es reflejar el estado de componentes clave. Se parte por el API: api: 'ok'. Este payload puede ampliarse para reportar otros servicios, por ejemplo, base de datos, manteniendo el formato legible y validable por pruebas de integración.
¿Tienes una variación de health check que uses en producción o más checks que te funcionen bien? Compártelo en los comentarios.
Implementación de un Health Check Endpoint en API con RSpec
Implementa un health check endpoint en Rails con RSpec y TDD para asegurar servicios confiables y monitoreables. Aprenderás a validar el estado de tu API con pruebas de integración, a responder en JSON con status code 200 y a configurar rutas y controladores de forma clara y mantenible.
¿Qué es un health check endpoint y para qué sirve?
Un health check es un endpoint convencional como /health o /health_check que responde con 200 cuando el servicio está operativo. Es una buena práctica porque permite el monitoreo continuo por herramientas como Pingdom o Runscope mediante un request periódico. Además, se relaciona con páginas de estado públicas como las de Heroku, GitHub o Twitter, usadas para verificar si una aplicación está en buen estado.
Verificar disponibilidad del servicio con un request simple.
Integración con Pingdom y Runscope a través de /health.
Responder con 200 cuando todo está ok.
Alertar al equipo si hay error o no hay respuesta.
¿Cómo escribir pruebas de integración con RSpec para el health endpoint?
La estrategia es TDD: primero se escriben las pruebas, luego la funcionalidad. Crea el directorio spec/requests para pruebas de integración y un archivo health_spec.rb. Incluye rails_helper y declara el tipo request para disponer de helpers como response y have_http_status.
# spec/requests/health_spec.rb
require 'rails_helper'
RSpec.describe 'Health Endpoint', type: :request do
describe 'GET /health' do
before { get '/health' }
it 'should return ok' do
payload = JSON.parse(response.body)
expect(payload).not_to be_empty
expect(payload['api']).to eq('ok')
end
it 'should return status code 200' do
expect(response).to have_http_status(:ok)
end
end
end
Pruebas de integración con type: :request para validar de extremo a extremo.
before ejecuta el requestget '/health' antes de cada ejemplo.
response.body y JSON.parse para obtener el payload.
have_http_status(:ok) valida el status code 200 de forma expresiva.
Pruebas autodescriptivas con it 'should return ok' para claridad.
¿Qué errores comunes se observaron al correr RSpec?
Al ejecutar las pruebas primero fallan, lo esperado en TDD. Se mencionan errores típicos y su solución directa:
"La constante RSpec no está inicializada": usar RSpec con la S en mayúscula.
"No existe una ruta para /health": agregar la ruta y el controlador.
¿Cómo implementar el controlador y la ruta en Rails?
Crea health_controller.rb heredando de ApplicationController. Define la acción que responde con un payload mínimo y status 200 usando la constante de Rails :ok.
# app/controllers/health_controller.rb
class HealthController < ApplicationController
def health
render json: { api: 'ok' }, status: :ok
end
end
Agrega la ruta para el endpoint/health apuntando a la acción health.
# config/routes.rb
Rails.application.routes.draw do
get 'health', to: 'health#health'
end
render json: define el payload en JSON.
status: :ok traduce a 200 automáticamente.
Ruta GET /health conectada a health#health.
¿Qué incluye el payload del health check?
La idea es reflejar el estado de componentes clave. Se parte por el API: api: 'ok'. Este payload puede ampliarse para reportar otros servicios, por ejemplo, base de datos, manteniendo el formato legible y validable por pruebas de integración.
¿Tienes una variación de health check que uses en producción o más checks que te funcionen bien? Compártelo en los comentarios.
Me preguntaba, si en algunos videos nos instan a implementar buenas practicas o las convenciones utilizadas por la comunidad de Ruby y Ruby on Rails, ademas de algunas gemas como rubocop, en las cuales nos indican que se debería utilizar ‘single quotes’ para situaciones donde no debamos interpolar o Ruby no deba hacer una inspeccion del codigo.
Mi pregunta es: porque en el código que estamos escribiendo utilizamos comillas dobles para información que no debemos interpolar o Ruby no debería inspeccionar. Hay alguna convención específica para cuando escribimos tests?
require "rails_helper"
RSpec.describe "Health endpoint", type: :request do
describe "GET /health" do
before { get '/health' }
it "should return OK" do
payload = JSON.parse(response.body)
expect(payload).not_to be_empty
expect(payload['api']).to eq('OK')
end
it "should return status code 200" do
expect(response).to have_http_status(200)
end
end
end```
Si a alguien tiene Ruby 3.0.0 con Rails 6, y se le presenta el error:
Error: example.run name is not available from within an example (e.g. an it block) or from constructs that run in the scope of an example (e.g. before, let, etc).
La solución que funcionó para mi fue ir al Gemfile y cambiar la versión de la gema "rspec-rails" de 3.5 a 4.0. Saludos!
group :test do
gem 'factory_bot_rails'
gem 'shoulda-matchers' , '~> 5.0'
gem 'faker'
gem 'database_cleaner-active_record'
end
rails_helper.rb:
Shoulda::Matchers.configure do |config|
config.integrate do |with|
with.test_framework :rspec
# Keep as many of these lines as are necessary:
with.library :active_record
with.library :active_model
with.library :rails
with.library :action_controller
Puede que para algunos no sea claro por qué usa el comando:
RAILS_ENV=test rails c
En vez de usar simplemente
rails c
Y la razón está en el gemfile, en esa consola va a usar la gema FactoryBot, que si recordamos, solo fue definida para el ambiente de test, al correr el rails c solito, abriría una consola del ambente development
group :test do
gem 'factory_bot_rails', '~> 4.0'
...
end
si depronto les sale este error: Health endpoint GET /health should return status code 200 Failure/Error: example.run nameis not available from within an example (e.g. anitblock) or from constructs that run in the scope of an example (e.g.before, let, etc). It is only available on an example group (e.g. a describeorcontext block).
Les recomiendo actualizar su gema de rspec a la versión 4.0
gem 'rspec-rails', '~> 4.0'
No he podido pasar el siguiente error...Gracias si me puede ayudar:
C:\Isabid\Paginasweb\blogapi>bundle exec rspec
FF
Failures:
Health endpoint GET /health should return OK
Failure/Error: example.run
name is not available from within an example (e.g. an it block) or from constructs that run in the scope of an example (e.g. before, let, etc). It is only available on an example group (e.g. a describe or context block).
./spec/rails_helper.rb:59:in `block (3 levels) in <top (required)>'
./spec/rails_helper.rb:58:in `block (2 levels) in <top (required)>'
Health endpoint GET /health should return status code 200
Failure/Error: example.run
name is not available from within an example (e.g. an it block) or from constructs that run in the scope of an example (e.g. before, let, etc). It is only available on an example group (e.g. a describe or context block).
./spec/rails_helper.rb:59:in `block (3 levels) in <top (required)>'
./spec/rails_helper.rb:58:in `block (2 levels) in <top (required)>'
Finished in 0.1422 seconds (files took 5.52 seconds to load)
2 examples, 2 failures
Failed examples:
rspec ./spec/request/health_spec.rb:8 # Health endpoint GET /health should return OK
rspec ./spec/request/health_spec.rb:13 # Health endpoint GET /health should return status code 200
Como este curso es introductorio pues se foca mas en mostrar las bases, entonces es diferente de la vida real. API es bastante complexo, inclusive, tanto que en esta clase lo que se hizo fue demostrar que es una buena practica tener el health end point, pero para que esto sirva en la vida real, se tendria que mockar en los test y hacer el codigo de procesamiento del json en el model, (siendo que API no acostumbra usar controller practicamente). Mockar es como fingir esta interaccion entre nuestra api e una app externa que se comunica, esto retorno un archivo json, entonces tambien tendria que haber un json en la carpeta support de spec para fingir el retorno.
Lo que hizo fue que el controller retorno una resposta JSON, entonces no se cumple el din de una API que es la comunicacion con softwares externos.
Y aun restaria testear los caso de no sucesso, que es muy importante tambine.
Aqui les dejo una expicación de API en la Guia Rails, directo de la documentación oficial.
Me preguntaba, si en algunos videos nos instan a implementar buenas practicas o las convenciones utilizadas por la comunidad de Ruby y Ruby on Rails, ademas de algunas gemas como rubocop, en las cuales nos indican que se debería utilizar ‘single quotes’ para situaciones donde no debamos interpolar o Ruby no deba hacer una inspeccion del codigo.
Mi pregunta es: porque en el código que estamos escribiendo utilizamos comillas dobles para información que no debemos interpolar o Ruby no debería inspeccionar. Hay alguna convención específica para cuando escribimos tests?
require "rails_helper"RSpec.describe"Health endpoint",type::request do describe "GET /health"do before {get'/health'} it "should return OK"do payload =JSON.parse(response.body)expect(payload).not_to be_empty
expect(payload['api']).toeq('OK') end
it "should return status code 200"doexpect(response).tohave_http_status(200) end
end
end```
Tú tienes razón, si no vamos a interpolar o usar comillas sencillas en el texto, no se deben usar las comillas dobles por buenas practicas. Tal vez se sale del scope del curso, pero que bueno que lo apuntes y que la gente sepa que es mejor escribir comillas sencillas.
Las buenas practicas son "opinionadas", puede ser que una empresa le guste todo en dobles comillas (como parece ser el default en rails) y otras que prefieran comillas simples.
Si a alguien tiene Ruby 3.0.0 con Rails 6, y se le presenta el error:
Error: example.run name is not available from within an example (e.g. an it block) or from constructs that run in the scope of an example (e.g. before, let, etc).
La solución que funcionó para mi fue ir al Gemfile y cambiar la versión de la gema "rspec-rails" de 3.5 a 4.0. Saludos!
Gracias, eso me faltaba
amigo eres un genio, muchas gracias!
para rails 7:
GEMFILE:
group :test do
gem 'factory_bot_rails'
gem 'shoulda-matchers' , '~> 5.0'
gem 'faker'
gem 'database_cleaner-active_record'
end
rails_helper.rb:
Shoulda::Matchers.configure do |config|
config.integrate do |with|
with.test_framework :rspec
# Keepas many of these lines as are necessary:with.library:active_record
with.library:active_model
with.library:rails
with.library:action_controller
end
end
Puede que para algunos no sea claro por qué usa el comando:
RAILS_ENV=test rails c
En vez de usar simplemente
rails c
Y la razón está en el gemfile, en esa consola va a usar la gema FactoryBot, que si recordamos, solo fue definida para el ambiente de test, al correr el rails c solito, abriría una consola del ambente development
group:test do gem 'factory_bot_rails','~> 4.0'...end
si depronto les sale este error: Health endpoint GET /health should return status code 200 Failure/Error: example.run nameis not available from within an example (e.g. anitblock) or from constructs that run in the scope of an example (e.g.before, let, etc). It is only available on an example group (e.g. a describeorcontext block).
Les recomiendo actualizar su gema de rspec a la versión 4.0
gem 'rspec-rails', '~> 4.0'
Hola tengo este error, alguien me puede ayudar.
C:\Isabid\Paginasweb\blogapi>bundle exec rspec
F.
Failures:
Health endpoint GET /health should return OK
Failure/Error: expect(payload).not_to be_emply
expected {"api"=>"OK"} to respond to emply?
./spec/request/health_spec.rb:10:in `block (3 levels) in <top (required)>'
./spec/rails_helper.rb:59:in `block (3 levels) in <top (required)>'
./spec/rails_helper.rb:58:in `block (2 levels) in <top (required)>'
Finished in 0.21116 seconds (files took 2.82 seconds to load)
2 examples, 1 failure
Failed examples:
rspec ./spec/request/health_spec.rb:8 # Health endpoint GET /health should return OK
debe ser pq escribio 'emply' correcto es 'empty'
no me funcion el:
have_http_200
tuve que usar:
have_http_status(:ok)
Esto en rails 6
No he podido pasar el siguiente error...Gracias si me puede ayudar:
C:\Isabid\Paginasweb\blogapi>bundle exec rspec
FF
Failures:
Health endpoint GET /health should return OK
Failure/Error: example.run
name is not available from within an example (e.g. an it block) or from constructs that run in the scope of an example (e.g. before, let, etc). It is only available on an example group (e.g. a describe or context block).
./spec/rails_helper.rb:59:in `block (3 levels) in <top (required)>'
./spec/rails_helper.rb:58:in `block (2 levels) in <top (required)>'
Health endpoint GET /health should return status code 200
Failure/Error: example.run
name is not available from within an example (e.g. an it block) or from constructs that run in the scope of an example (e.g. before, let, etc). It is only available on an example group (e.g. a describe or context block).
./spec/rails_helper.rb:59:in `block (3 levels) in <top (required)>'
./spec/rails_helper.rb:58:in `block (2 levels) in <top (required)>'
Finished in 0.1422 seconds (files took 5.52 seconds to load)
2 examples, 2 failures
Failed examples:
rspec ./spec/request/health_spec.rb:8 # Health endpoint GET /health should return OK
rspec ./spec/request/health_spec.rb:13 # Health endpoint GET /health should return status code 200
Como este curso es introductorio pues se foca mas en mostrar las bases, entonces es diferente de la vida real. API es bastante complexo, inclusive, tanto que en esta clase lo que se hizo fue demostrar que es una buena practica tener el health end point, pero para que esto sirva en la vida real, se tendria que mockar en los test y hacer el codigo de procesamiento del json en el model, (siendo que API no acostumbra usar controller practicamente). Mockar es como fingir esta interaccion entre nuestra api e una app externa que se comunica, esto retorno un archivo json, entonces tambien tendria que haber un json en la carpeta support de spec para fingir el retorno.
Lo que hizo fue que el controller retorno una resposta JSON, entonces no se cumple el din de una API que es la comunicacion con softwares externos.
Y aun restaria testear los caso de no sucesso, que es muy importante tambine.
Aqui les dejo una expicación de API en la Guia Rails, directo de la documentación oficial.
Olá amigos vine del futuro... jaja... ahora en serio: queria comentar por aqui que lo me di cuenta, que lo que estamos haciendo en el proyecto es exponer una api para otros aplicativos, lo del comentario anterior se aplicaria en el caso de consumir una API.
Realmente exponer una API resulta en estos TDD simples, la complejidad de los TDD se da mas cuando devemos consumirlos.
si obtienen un error de tipo
Failure/Error: example.run
name is not available from within an example (e.g. an it block)
actualicen sus gemas de test a la ultima version en mi caso fallaba por que Rspec con versiones <4 en rails 6 tiene problemas
Tambien hay una gema muy util para esto health_check
leyendo sobre buenas practicas que sugieren al momento de desarrollar APIs que cumplan el concepto de REST.
Mi duda seria si ya tengo un HealthController y sugiriendo la convención de REST el metodo que de respuesta no quedaria mejor en un metodo index?
health_controller.rb
class HealthController < ApplicationController
def index
render json: { api: 'OK' }, status: :ok
end
end
routes.rb
Rails.application.routes.draw do
get '/health', to 'health#index'
end
¿Qué opiniones o sugerencias han tenido siguiendo estas convenciones de REST?
Si quiere trabajar con recurso y siguiendo la recomendaciones de REST, es mejor colocarlo en el metodo show, en tu ruta tendrías algo como
resource :health, only: [:show]
tu controller tendria que fcambiar de nombre a HealthsController
Me sale un error que dice
"
An error occurred while loading ./spec/requests/health_spec.rb.
Failure/Error: config.fixture_path = "#{::Rails.root}/spec/fixtures"
NameError:
undefined local variable or method `config' for main:Object
Hola, Bianca, buen día, ¿pudieras compartirme el código que está en tu archivo “health_spec.rb”? Para poder checar con mayor exactitud el problema.
require 'rails_helper'
RSpec.describe 'Health endpoint', type: :request do
describe 'GET /health'do before {get'/health'} it 'should return OK'do payload =JSON.parse(response.body)expect(payload).not_to be_empty
expect(payload['api']).toeq('OK') end
it 'should return status code 200'doexpect(response).tohave_http_status(200)expect(payload['api']).toeq('OK'){api:OK,db:DOWN} end
end
end
Como puedo resolver el siguiente error que surge cuando ejecuto en consola bundle exec rspec:
An error occurred while loading ./spec/requests/health_spec.rb.Failure/Error: config.fixture_path="#{::Rails.root}/spec/fixtures"NameError:undefined local variable or method `config' for main:Object
# ./spec/rails_helper.rb:60:in `<top(required)>'
# ./spec/requests/health_spec.rb:1:in`require'
# ./spec/requests/health_spec.rb:1:in `<top(required)>'
No examples found.Finishedin0.00006seconds(files took 5.64 seconds to load)0 examples,0 failures,1 error occurred outside of examples
parece un problema en las configuraciones dentro del archivo rails_helper
Tengo el mismo problema y me tiene bloqueada.
Si te aparece este error:
Failure/Error:DatabaseCleaner.clean_with(:truncation)NoMethodError:undefined method `table_name' for ActiveRecord::SchemaMigration:Class
```Te recomiendo configurar RSpec.configure de "rails\_helper.rb" de la siguiente manera:```js
RSpec.configuredo|config| config.includeFactoryBot::Syntax::Methods config.before(:suite)doDatabaseCleaner.strategy=:transaction
end
config.before(:each)doDatabaseCleaner.strategy=:deletion
end
config.before(:each,:js=>true)doDatabaseCleaner.strategy=:deletion
end
config.before(:each)doDatabaseCleaner.start end
config.append_after(:each)doDatabaseCleaner.clean end
config.around(:each)do|example|DatabaseCleaner.cleaningdo example.run end
end
config.fixture_path="#{::Rails.root}/spec/fixtures" config.use_transactional_fixtures=true config.infer_spec_type_from_file_location! config.filter_rails_from_backtrace!
end
Actualización
Con la clase siguiente cambié la estructura de RSpec.configure de "rails\_helper.rb":
RSpec.configuredo|config| config.includeFactoryBot::Syntax::Methods config.before(:each)doDatabaseCleaner.strategy=:truncation
DatabaseCleaner.strategy=:transaction
DatabaseCleaner.start end
config.append_after(:each)doDatabaseCleaner.clean end
config.around(:each)do|example|DatabaseCleaner.cleaningdo example.run end
end
config.fixture_path="#{::Rails.root}/spec/fixtures" config.use_transactional_fixtures=true config.infer_spec_type_from_file_location! config.filter_rails_from_backtrace!end
Espero que una de las dos versiones te pueda servir!
Si no les sale con esto:
require 'rails_helper'
Sale con esto
require 'spec_helper'
Test
require 'rails_helper'RSpec.describe'Health endpoint',type::request do describe 'GET /health'do before {get'/health'} it 'returns OK'do payload =JSON.parse(response.body)expect(payload).not_to be_empty
expect(payload['api']).toeq('OK') end
it 'does not return OK'doexpect(response).tohave_http_status(:ok) end
end
end
Si tienen algún error similar a
Failure/Error: example.run`name` is not available from within an example(e.g.an`it` block) or from constructs that run in the scope of an example(e.g.`before`,`let`, etc).It is only available on an example group(e.g.a`describe` or `context` block).
Actualicen la gema de rspec-rails a 4.0
gem 'rspec-rails','~> 4.0'
create health request spec, me too use rails g rspec:request health
Si están siguiendo tal cual el video y están usando rails 6, y sienten que les sale error, es porque tienen que actualizar el rspec a 4.0. en el gemfile.