Implementación de un Health Check Endpoint en API con RSpec

Clase 6 de 33 • Curso de Creación de APIs con Ruby on Rails

Resumen

¿Cómo implementar un endpoint de Health Check en Rails?

Implementar un endpoint de "Health Check" es una práctica esencial en el desarrollo de servicios web. Este tipo de endpoints permite monitorear el estado de una aplicación de manera automática, verificando si todo está funcionando correctamente. A continuación, exploraremos cómo crear uno en Rails y la importancia de estas herramientas.

¿Qué es un Health Check y por qué es importante?

Un Health Check es un endpoint que verifica el estado de una aplicación, generalmente retornando un código HTTP 200 (OK) si todo funciona correctamente. Este es monitoreado por servicios como Pingdom o Runscope para alertar si hay fallos.

Algunos ejemplos de páginas de estado que utilizan Health Checks son:

Estos servicios son esenciales para garantizar que los desarrolladores sean notificados de cualquier problema en tiempo real.

¿Cómo configurar las pruebas utilizando RSpec?

El uso de RSpec para implementar pruebas es una buena práctica, asegurando que nuestra aplicación funcione como se espera.

Preparar el entorno de pruebas

Crear el directorio y archivo de pruebas:

Dentro de la carpeta spec, crear un directorio request y luego un archivo health_spec.rb.
```
mkdir spec/request
touch spec/request/health_spec.rb
```

Configurar el archivo de pruebas:

# spec/request/health_spec.rb

require 'rails_helper'

RSpec.describe 'Health endpoint', type: :request do
  before { get '/health' }

  it 'returns OK' do
    expect(JSON.parse(response.body)['API']).to eq('OK')
  end

  it 'returns status code 200' do
    expect(response).to have_http_status(200)
  end
end

Implementar el controlador y la lógica del Health Check

Crear el controlador:

En la carpeta controllers, crear un archivo health_controller.rb.

# app/controllers/health_controller.rb

class HealthController < ApplicationController
  def health
    render json: { API: 'OK' }, status: :ok
  end
end

Configurar las rutas:

Asegurarse de agregar la ruta al config/routes.rb para que el controlador pueda ser llamado.
```
# config/routes.rb

Rails.application.routes.draw do
  get '/health', to: 'health#health'
end
```
Verificar las pruebas:

Después de configurar el controlador y las rutas, ejecutar las pruebas para garantizar que todo funcione como se espera.
```
bundle exec rspec
```
Las pruebas deberían pasar exitosamente, indicando que el endpoint de Health Check está funcionando correctamente.

Implementar un endpoint de Health Check no solo es una práctica recomendada, sino un paso crucial para asegurar la robustez y el monitoreo continuo de una aplicación. Con esta implementación, tu equipo estará siempre al tanto del estado de tu servicio, reaccionando a tiempo ante cualquier incidente. Sigue explorando y mejorando tu aplicación paso a paso. ¡El aprendizaje nunca termina y cada línea de código cuenta!

Victor Manuel Franco Cañon

student•

**Buenas practicas en Ruby **

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```

Diego Ortiz

student•

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.

Enrique Andres Gonzalez Pelaez

student•

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.

Juan Diego Arriola

student•

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!

Jorge Levy Cen Avila

student•

Gracias, eso me faltaba

Fabio Leandro Fiestas Cobeñas

student•

amigo eres un genio, muchas gracias!

Ricardo de Jesús Veloz Cleto

student•

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

# Keep as many of these lines as are necessary:
with.library :active_record
with.library :active_model
with.library :rails
with.library :action_controller

end end

Diego Ortiz

student•

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

Oscar Eduardo Info Giraldo

student•

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'

Isabid De Jesus

student•

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

Angela Soler

student•

debe ser pq escribio 'emply' correcto es 'empty'

Enrique Andres Gonzalez Pelaez

student•

no me funcion el:

have_http_200

tuve que usar:

have_http_status(:ok)

Esto en rails 6

Isabid De Jesus

student•

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

Angela Soler

student•

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.

Angela Soler

student•

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.

Gerson Mayer

student•

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

Cristian Mendoza

student•

Tambien hay una gema muy util para esto health_check

Diego Camacho

student•

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?

Natalia Hashimoto

student•

Ojo con los dos puntos despues del "to" >

Rails.application.routes.draw do
  get '/health', to: 'health#index'
end

Alexei Teófilo Mamani Coaquira

student•

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

Bianca Florencia Piovano

student•

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

config.fixture_path = "#{::Rails.root}/spec/fixtures"
^^^^^^

Y no lo he podido solucionar

Brandon Argel Verdeja Domínguez

student•

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.

Bianca Florencia Piovano

student•

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)
            expect(payload['api']).to eq('OK')
        {
            api: OK, 
            db: DOWN
        }
    end
end

end

Diana Flores

student•

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.


Finished in 0.00006 seconds (files took 5.64 seconds to load)
0 examples, 0 failures, 1 error occurred outside of examples

Angela Soler

student•

parece un problema en las configuraciones dentro del archivo rails_helper

Bianca Florencia Piovano

student•

Tengo el mismo problema y me tiene bloqueada.

Piero Nolte

student•

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.configure do |config|
  config.include FactoryBot::Syntax::Methods

  config.before(:suite) do
    DatabaseCleaner.strategy = :transaction
  end

  config.before(:each) do
    DatabaseCleaner.strategy = :deletion
  end
  
  config.before(:each, :js => true) do
    DatabaseCleaner.strategy = :deletion
  end
  
  config.before(:each) do
    DatabaseCleaner.start
  end
  
  config.append_after(:each) do
    DatabaseCleaner.clean
  end

  config.around(:each) do |example|
    DatabaseCleaner.cleaning do
      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

Piero Nolte

student•

Actualización

Con la clase siguiente cambié la estructura de RSpec.configure de "rails\_helper.rb":

RSpec.configure do |config|
  config.include FactoryBot::Syntax::Methods
  
  
  config.before(:each) do
    DatabaseCleaner.strategy = :truncation
    DatabaseCleaner.strategy = :transaction
    DatabaseCleaner.start
  end
  
  config.append_after(:each) do
    DatabaseCleaner.clean
  end

  config.around(:each) do |example|
    DatabaseCleaner.cleaning do
      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!

Carlos Mauro Cárdenas Fernández

student•

Si no les sale con esto: require 'rails_helper' Sale con esto require 'spec_helper'

Pedro Perafán Carrasco

student•

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']).to eq('OK')
    end

    it 'does not return OK' do
      expect(response).to have_http_status(:ok)
    end
  end
end

Pedro Perafán Carrasco

student•

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'

Daniel Rodriguez

student•

create health request spec, me too use rails g rspec:request health

Emerson Xianai

student•

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.