Test unitarios para paquetes de rOpenSpain

Desde rOpenSpain estamos comprometidos con la calidad del software que se produce. Es un síntoma de calidad el aplicar, no sólo buenas prácticas de programación, sino también aplicar un estilo de programación “defensivo” en el sentido de que tenemos que saber de antemano que nuestro código va a fallar, y a veces de formas inesperadas.

Recomendamos por tanto que tu código pase los correspondientes procesos de comprobación/validación con paquetes como testhat que permiten construir tests de prueba de manera paralela al código. Es una buena práctica construir los tests antes de empezar a programar, así podrás ver en todo momento si tu código da los resultados deseados. Como acompañante de testthat recomendamos el uso del paquete usethis

Os dejamos una breve guía muy simple de como usar estos paquetes:

  • Descargar e instalar testhat y usethis (seguramente también necesitarás instalar algunas dependencias)
   install.packages("testhat")
   install.packages("usethis")
  
  • Imaginemos que estás escribiendo una función que suma dos números (por mor de la sencillez en el ejemplo) y la guardamos en un archivo llamado sum.R
sum <- function(n, m){
    result <- n+m
    return(result)
}
  • Vemos que nuestro código funciona y seguimos programando, pero antes de continuar es muy buena idea construir un test unitario para nuestra función, porque estamos seguros de que alguno de los cambios o adiciones posteriores pueden provocar que nuestra función se comporte de manera inesperada. Para ello escribimos un archivo R de testeo denominado test_sum.R con el siguiente contenido (de nuevo, disculpad lo absurdo del ejemplo)
test_that("Test sum(4,16)",{
  expect_equal(sum(4,16), 20)
})
  • Este tipo de comprobaciones sencillas se pueden efectuar para muy diversos resultados esperados gracias al paquete testthat, que posee expectations para muchos tipos de comprobaciones, a saber:

    • expect_equal
    • expect_identical
    • expect_match
    • expect_output
    • expect_message
    • expect_warning
    • expect_error
    • expect_is
  • Una vez tengamos nuestros tests construidos, es muy sencillo ejecutarlos en nuestro código. La forma más simple es utilizando usethis. Asumiendo que estamos en el directorio donde tienes el código de tu paquete, simplemente ejecuta usethis::use_test("test_sum")

  • Otra forma de estructurar los tests es creando un archivo de testeo.

El archivo, que vamos a denominar my_testing_suite.R debe tener la siguiente estructura básica:

  library(testthat) 

  source("path/to/sum.R")

  test_results <- test_dir("path/to/tests", reporter="summary")

La ejecución de este archivo, dispara la comprobación de todos los tests que hayamos escrito y que estén contenidos en él, entregando un reporte completo de los resultados, tanto si dan resultados positivos como negativos.

Si estás usando RStudio, puedes presionar Cmd/Ctrl + Shift + T para ejecutar todos los tests que tengas en tu paquete.