brainstorming
brainstorming
You MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).
write-testthat-testsEscribir pruebas exhaustivas con testthat (edición 3) para funciones de paquetes R. Cubre organización de pruebas, aserciones, fixtures, mocking, pruebas de snapshot, pruebas parametrizadas y obtención de alta cobertura. Usar al añadir pruebas para nuevas funciones del paquete, aumentar la cobertura de pruebas del código existente, escribir pruebas de regre…
Independent GitHub snapshot · Automated classification · Original documentation governs
Crear pruebas exhaustivas para funciones de paquetes R usando testthat edición 3.
Si aún no está hecho:
usethis::use_testthat(edition = 3)
Esto crea tests/testthat.R y el directorio tests/testthat/.
Esperado: Se crean tests/testthat.R y el directorio tests/testthat/. DESCRIPTION tiene Config/testthat/edition: 3 configurado.
En caso de fallo: Si usethis no está disponible, crear manualmente tests/testthat.R con el contenido library(testthat); library(packagename); test_check("packagename") y el directorio tests/testthat/.
usethis::use_test("function_name")
Esto crea tests/testthat/test-function_name.R con una plantilla.
Esperado: Archivo de prueba creado en tests/testthat/test-function_name.R con un bloque test_that() de marcador listo para completar.
En caso de fallo: Si usethis::use_test() no está disponible, crear el archivo manualmente. Seguir la convención de nomenclatura test-<function_name>.R.
test_that("weighted_mean computes correct result", {
expect_equal(weighted_mean(1:3, c(1, 1, 1)), 2)
expect_equal(weighted_mean(c(10, 20), c(1, 3)), 17.5)
})
test_that("weighted_mean handles NA values", {
expect_equal(weighted_mean(c(1, NA, 3), c(1, 1, 1), na.rm = TRUE), 2)
expect_true(is.na(weighted_mean(c(1, NA, 3), c(1, 1, 1), na.rm = FALSE)))
})
test_that("weighted_mean validates input", {
expect_error(weighted_mean("a", 1), "numeric")
expect_error(weighted_mean(1:3, 1:2), "length")
})
Esperado: Las pruebas básicas cubren la salida correcta para entradas típicas, el comportamiento con valores NA y los mensajes de error de validación de entradas.
En caso de fallo: Si las pruebas fallan inmediatamente, verificar que la función está cargada (devtools::load_all()). Si los mensajes de error no coinciden, usar un patrón regex en expect_error() en lugar de una cadena exacta.
test_that("weighted_mean handles edge cases", {
# Empty input
expect_error(weighted_mean(numeric(0), numeric(0)))
# Single value
expect_equal(weighted_mean(5, 1), 5)
# Zero weights
expect_true(is.nan(weighted_mean(1:3, c(0, 0, 0))))
# Very large values
expect_equal(weighted_mean(c(1e15, 1e15), c(1, 1)), 1e15)
# Negative weights
expect_error(weighted_mean(1:3, c(-1, 1, 1)))
})
Esperado: Se cubren los casos límite: entrada vacía, valores únicos, pesos cero, valores extremos y entradas inválidas. Cada caso límite tiene un comportamiento esperado claro.
En caso de fallo: Si la función no gestiona un caso límite como se espera, decidir si corregir la función o ajustar la prueba. Documentar el comportamiento previsto para los casos ambiguos.
Crear tests/testthat/fixtures/ para datos de prueba:
# tests/testthat/helper.R (loaded automatically)
create_test_data <- function() {
data.frame(
x = c(1, 2, 3, NA, 5),
group = c("a", "a", "b", "b", "b")
)
}
# In test file
test_that("process_data works with grouped data", {
test_data <- create_test_data()
result <- process_data(test_data)
expect_s3_class(result, "data.frame")
expect_equal(nrow(result), 2)
})
Esperado: Las fixtures proporcionan datos de prueba consistentes en múltiples archivos de prueba. Las funciones auxiliares en tests/testthat/helper.R se cargan automáticamente por testthat.
En caso de fallo: Si las funciones auxiliares no se encuentran, asegurarse de que el archivo se llama helper.R (no helpers.R) y está en tests/testthat/. Reiniciar la sesión R si es necesario.
test_that("fetch_data handles API errors", {
local_mocked_bindings(
api_call = function(...) stop("Connection refused")
)
expect_error(fetch_data("endpoint"), "Connection refused")
})
test_that("fetch_data returns parsed data", {
local_mocked_bindings(
api_call = function(...) list(data = list(value = 42))
)
result <- fetch_data("endpoint")
expect_equal(result$value, 42)
})
Esperado: Las dependencias externas (APIs, bases de datos, llamadas de red) se simulan para que las pruebas se ejecuten sin conexiones reales. Los valores de retorno simulados ejercitan la lógica de procesamiento de datos de la función.
En caso de fallo: Si local_mocked_bindings() falla, asegurarse de que la función simulada es accesible en el ámbito de la prueba. Para funciones de otros paquetes, usar el argumento .package.
test_that("format_report produces expected output", {
expect_snapshot(format_report(test_data))
})
test_that("plot_results creates expected plot", {
expect_snapshot_file(
save_plot(plot_results(test_data), "test-plot.png"),
"expected-plot.png"
)
})
Esperado: Los archivos de snapshot se crean en tests/testthat/_snaps/. La primera ejecución crea la línea base; las ejecuciones siguientes comparan con ella.
En caso de fallo: Si los snapshots fallan tras un cambio intencionado, actualizarlos con testthat::snapshot_accept(). Para diferencias entre plataformas, usar el parámetro variant para mantener snapshots específicos de cada plataforma.
test_that("database query works", {
skip_on_cran()
skip_if_not(has_db_connection(), "No database available")
result <- query_db("SELECT 1")
expect_equal(result[[1]], 1)
})
test_that("parallel computation works", {
skip_on_os("windows")
skip_if(parallel::detectCores() < 2, "Need multiple cores")
result <- parallel_compute(1:100)
expect_length(result, 100)
})
Esperado: Las pruebas que requieren entornos especiales (red, base de datos, múltiples núcleos) están correctamente protegidas con condiciones de omisión. Estas pruebas se ejecutan localmente pero se omiten en CRAN o entornos de CI restringidos.
En caso de fallo: Si las pruebas fallan en CRAN o CI pero pasan localmente, añadir el guard skip_on_cran(), skip_on_os() o skip_if_not() apropiado al inicio del bloque test_that().
# Run all tests
devtools::test()
# Run specific test file
devtools::test_active_file() # in RStudio
testthat::test_file("tests/testthat/test-function_name.R")
# Check coverage
covr::package_coverage()
covr::report()
Esperado: Todas las pruebas pasan con devtools::test(). El informe de cobertura muestra que se alcanza el porcentaje objetivo (apuntar a >80%).
En caso de fallo: Si las pruebas fallan, leer la salida de las pruebas para los fallos de aserción específicos. Si la cobertura está por debajo del objetivo, usar covr::report() para identificar las rutas de código no probadas y añadir pruebas para ellas.
devtools::test()test_that() debe ser independientetestthat::test_path() para los fixtures de pruebaexpect_equal() (tiene tolerancia) no expect_identical()::: con moderación.variant para plataformas cruzadas.skip_on_cran(): Las pruebas que requieren red, bases de datos o ejecución larga deben omitirse en CRAN# Pattern: test file mirrors R/ file
# R/weighted_mean.R -> tests/testthat/test-weighted_mean.R
# Pattern: descriptive test names
test_that("weighted_mean returns NA when na.rm = FALSE and input contains NA", {
result <- weighted_mean(c(1, NA), c(1, 1), na.rm = FALSE)
expect_true(is.na(result))
})
# Pattern: testing warnings
test_that("deprecated_function emits deprecation warning", {
expect_warning(deprecated_function(), "deprecated")
})
create-r-package - configurar la infraestructura de pruebas como parte de la creación del paquetewrite-roxygen-docs - documentar las funciones que se pruebansetup-github-actions-ci - ejecutar pruebas automáticamente al hacer pushsubmit-to-cran - CRAN requiere que las pruebas pasen en todas las plataformas