El testing es una parte fundamental en el ciclo de desarrollo de software. Aunque es un tema vasto que podría requerir cursos enteros dedicados, en este contexto nos centraremos en crear pruebas unitarias para el código que desarrollamos. Las pruebas unitarias son pequeñas evaluaciones que verifican el comportamiento de funciones individuales. Este proceso no solo valida que el código funciona como se espera, sino que también nos ayuda a garantizar la calidad y a detectar errores con anticipación. Además, vamos a medir el code coverage, que nos indica qué porcentaje de nuestro código está cubierto por estas pruebas.
¿Cómo creamos pruebas unitarias en Go?
Para ilustrar el proceso de creación de pruebas unitarias en Go, comenzamos creando un archivo principal, main.go, que contiene una función simple de suma. Después, crearemos un archivo de pruebas, main_test.go, donde escribiremos las pruebas para la función de suma. Este archivo de pruebas debe seguir un formato específico para que Go lo reconozca, usando el sufijo _test.go.
Configuración inicial
Primero, definimos el paquete principal y la función que vamos a probar:
package main
funcsum(x, y int)int{return x + y
}
Creación de la prueba unitaria
En el archivo main_test.go, definimos el paquete y la función de prueba. Es esencial importar el paquete testing, ya que proporciona las herramientas necesarias para verificar los resultados de las pruebas.
package main
import"testing"funcTestSum(t *testing.T){ total :=sum(5,5)if total !=10{ t.Errorf("Suma incorrecta, obtuvimos %d, pero esperábamos %d", total,10)}}
Ejecutando las pruebas
Para ejecutar las pruebas, utilizamos el comando go test desde la terminal. Si configuramos correctamente nuestro módulo con go mod init, las pruebas deberían ejecutarse sin problemas. En caso de haber errores, Go reportará los fallos y sus ubicaciones específicas en el código.
¿Cómo utilizamos tablas de prueba para múltiples casos?
Un patrón común para aplicar pruebas en Go es el uso de tablas de prueba. Esta técnica nos permite definir múltiples escenarios de prueba en un slice de structs, facilitando la iteración y ejecución de cada caso.
Creación de una tabla de pruebas
Definimos una estructura para nuestros casos de prueba, que incluya los valores de entrada y el resultado esperado.
funcTestSum(t *testing.T){ testCases :=[]struct{a, b, expected int}{{1,2,3},{2,2,4},{25,26,51},}for_, tc :=range testCases { result :=sum(tc.a, tc.b)if result != tc.expected { t.Errorf("Suma incorrecta, obtuvimos %d, pero esperábamos %d", result, tc.expected)}}}
Ventajas de las tablas de pruebas
Este enfoque no solo organiza el proceso de pruebas, sino que también permite agregar y modificar casos fácilmente sin cambiar la lógica de prueba. Además, proporciona un marco claro para identificar fallos específicos cuando ocurren.
¿Qué impacto tiene el code coverage?
El code coverage es una métrica que indica qué parte de nuestro código ha sido ejecutada durante las pruebas. Aunque Go no obliga a cubrir el 100% del código, un bajo porcentaje de cobertura podría ocultar errores en partes no probadas. Go ofrece comandos para generar informes de cobertura, permitiéndonos identificar y mejorar áreas deficientes en nuestras pruebas.
Integración del code coverage
Para calcular el code coverage, podemos usar el comando go test -cover, que mostrará un resumen del porcentaje de código cubierto por las pruebas. Esta práctica nos ayuda a mantener un estándar de calidad alto y a asegurar que todas las partes críticas del código estén debidamente verificadas.
El uso consciente de pruebas unitarias y el seguimiento del code coverage no solo mejoran la calidad del software, sino que también aumentan la confianza en nuestras aplicaciones. Invito a continuar explorando y aplicando estos conceptos en sus proyectos para asegurar un desarrollo más sólido y eficiente.
El testing es una parte fundamental en el ciclo de desarrollo de software. Aunque es un tema vasto que podría requerir cursos enteros dedicados, en este contexto nos centraremos en crear pruebas unitarias para el código que desarrollamos. Las pruebas unitarias son pequeñas evaluaciones que verifican el comportamiento de funciones individuales. Este proceso no solo valida que el código funciona como se espera, sino que también nos ayuda a garantizar la calidad y a detectar errores con anticipación. Además, vamos a medir el code coverage, que nos indica qué porcentaje de nuestro código está cubierto por estas pruebas.
¿Cómo creamos pruebas unitarias en Go?
Para ilustrar el proceso de creación de pruebas unitarias en Go, comenzamos creando un archivo principal, main.go, que contiene una función simple de suma. Después, crearemos un archivo de pruebas, main_test.go, donde escribiremos las pruebas para la función de suma. Este archivo de pruebas debe seguir un formato específico para que Go lo reconozca, usando el sufijo _test.go.
Configuración inicial
Primero, definimos el paquete principal y la función que vamos a probar:
package main
func sum(x, y int) int {
return x + y
}
Creación de la prueba unitaria
En el archivo main_test.go, definimos el paquete y la función de prueba. Es esencial importar el paquete testing, ya que proporciona las herramientas necesarias para verificar los resultados de las pruebas.
package main
import "testing"
func TestSum(t *testing.T) {
total := sum(5, 5)
if total != 10 {
t.Errorf("Suma incorrecta, obtuvimos %d, pero esperábamos %d", total, 10)
}
}
Ejecutando las pruebas
Para ejecutar las pruebas, utilizamos el comando go test desde la terminal. Si configuramos correctamente nuestro módulo con go mod init, las pruebas deberían ejecutarse sin problemas. En caso de haber errores, Go reportará los fallos y sus ubicaciones específicas en el código.
¿Cómo utilizamos tablas de prueba para múltiples casos?
Un patrón común para aplicar pruebas en Go es el uso de tablas de prueba. Esta técnica nos permite definir múltiples escenarios de prueba en un slice de structs, facilitando la iteración y ejecución de cada caso.
Creación de una tabla de pruebas
Definimos una estructura para nuestros casos de prueba, que incluya los valores de entrada y el resultado esperado.
func TestSum(t *testing.T) {
testCases := []struct{a, b, expected int}{
{1, 2, 3},
{2, 2, 4},
{25, 26, 51},
}
for _, tc := range testCases {
result := sum(tc.a, tc.b)
if result != tc.expected {
t.Errorf("Suma incorrecta, obtuvimos %d, pero esperábamos %d", result, tc.expected)
}
}
}
Ventajas de las tablas de pruebas
Este enfoque no solo organiza el proceso de pruebas, sino que también permite agregar y modificar casos fácilmente sin cambiar la lógica de prueba. Además, proporciona un marco claro para identificar fallos específicos cuando ocurren.
¿Qué impacto tiene el code coverage?
El code coverage es una métrica que indica qué parte de nuestro código ha sido ejecutada durante las pruebas. Aunque Go no obliga a cubrir el 100% del código, un bajo porcentaje de cobertura podría ocultar errores en partes no probadas. Go ofrece comandos para generar informes de cobertura, permitiéndonos identificar y mejorar áreas deficientes en nuestras pruebas.
Integración del code coverage
Para calcular el code coverage, podemos usar el comando go test -cover, que mostrará un resumen del porcentaje de código cubierto por las pruebas. Esta práctica nos ayuda a mantener un estándar de calidad alto y a asegurar que todas las partes críticas del código estén debidamente verificadas.
El uso consciente de pruebas unitarias y el seguimiento del code coverage no solo mejoran la calidad del software, sino que también aumentan la confianza en nuestras aplicaciones. Invito a continuar explorando y aplicando estos conceptos en sus proyectos para asegurar un desarrollo más sólido y eficiente.
Para programar los tests os recomiendo utilizar el módulo , ya que te ofrece diversas funcionalidades que facilitan la vida a la hora de programar los tests de Go.
Yo encuentro especialmente útil el paquete assert, el qual te permite hacer los asserts igual que en cualquier lenguaje de programación. Por ejempo:
Una forma de darle descripcion a todos los casos de uso de los tests:
func Test_Sum(t *testing.T) {
tables := []struct {
description string
a int
b int
total int
}{
{
description: "adding 2 digit numbers",
a: 12,
b: 20,
total: 32,
},
{
description: "adding 1 digit numbers",
a: 2,
b: 2,
total: 4,
},
}
for _, item := range tables {
t.Run(item.description, func(t *testing.T) {
if totalSum := Sum(item.a, item.b); totalSum != item.total {
t.Errorf("error: incorrect sum. got %d, expected %d", totalSum, item.total)
}
})
}
}
En este caso solo hay un caso de uso, pero hay veces que vamos a tener muchisimos casos de uso, como por ejemplo, una funcion puede retornar distintos tipos de errores, y lo ideal es cubrir cada uno de ellos. Por esto, tener una descripcion por caso de uso no ayuda mucho a mantener los tests limpios y entendibles
Como buena practica el paquete de los test deberia llamrse "main_test" y no directamente como el paquete, esto para temas de seguridad y que go no compile nuestros test dentro de build
Go has a builtin testing library, which is awesome!
How To:
To define a test must:
Create a the test file named <file>_test.go, where <file> is the name of the file you are testing
Write the tests
Run the tests with go test
Example:
main.go:
package main
func Sum(x, y int) int {
return x + y
}
main_test.go:
package main
import (
"fmt"
"testing"
)
func TestSum(t *testing.T) {
fmt.Println()
total := Sum(5, 5)
if total != 10 {
t.Errorf("Wrong output, expected 10, go %d", total)
}
}
Often times it's useful to test various cases in single test. To do that you'd wanna use a slice and iterate over them like so:
tableCases := []struct {
a int
b int
n int
}{
{1, 2, 3},
{2, 2, 4},
{25, 26, 51},
}
for _, item := range tableCases {
total := Sum(item.a, item.b)
if total != item.n {
t.Errorf("Failed: Incorrect sum, got %d expected %d", total, item.n)
}
}
package main
import (
"fmt"
"strings"
)
func Sum(x, y int) int {
return x + y
}
func SayHello(name string) string {
return fmt.Sprintf("Hello %v", strings.Title(strings.ToLower(name)))
}
func GreaterThan(x, y int) int {
if x > y {
return x
}
return y
}
func SumTotal(numbers ...int) int {
total := 0
for _, val := range numbers {
total += val
}
return total
}
main_test.go
package main
import (
"testing"
)
func TestSum(t *testing.T) {
type args struct {
x int
y int
}
tests := []struct {
name string
args args
want int
}{
// TODO: Add test cases.
{name: "Test Sum Correct", args: args{x: 6, y: 6}, want: 12},
{name: "Test Sum Correct", args: args{x: 5, y: 5}, want: 10},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := Sum(tt.args.x, tt.args.y); got != tt.want {
t.Errorf("Sum() = %v, want %v", got, tt.want)
}
})
}
}
func TestSayHello(t *testing.T) {
type args struct {
name string
}
tests := []struct {
name string
args args
want string
}{
// TODO: Add test cases.
{name: "Correctly", args: args{name: "pedro"}, want: "Hello Pedro"},
{name: "Correctly", args: args{name: "Ramon"}, want: "Hello Ramon"},
{name: "Correctly", args: args{name: "mARIa"}, want: "Hello Maria"},
{name: "Correctly", args: args{name: "DIANA"}, want: "Hello Diana"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := SayHello(tt.args.name); got != tt.want {
t.Errorf("SayHello() = %v, want %v", got, tt.want)
}
})
}
}
func TestGreaterThan(t *testing.T) {
type args struct {
x int
y int
}
tests := []struct {
name string
args args
want int
}{
// TODO: Add test cases.
{name: "Equal", args: args{x: 6, y: 6}, want: 6},
{name: "X greater", args: args{x: 9, y: 8}, want: 9},
{name: "Y greater", args: args{x: 1, y: 99}, want: 99},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := GreaterThan(tt.args.x, tt.args.y); got != tt.want {
t.Errorf("GreaterThan() = %v, want %v", got, tt.want)
}
})
}
}
func TestSumTotal(t *testing.T) {
type args struct {
numbers []int
}
tests := []struct {
name string
args args
want int
}{
// TODO: Add test cases.
{name: "Correctly", args: args{[]int{1, 3, 2}}, want: 6},
{name: "Correctly", args: args{[]int{106, 105, 6}}, want: 217},
{name: "Correctly", args: args{[]int{96, 3, 0}}, want: 99},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := SumTotal(tt.args.numbers...); got != tt.want {
t.Errorf("SumTotal() = %v, want %v", got, tt.want)
}
})
}
}
package main
import "testing"
func TestSum(t *testing.T) {
tables := []struct {
x int
y int
r int
}{
{1, 2, 3},
{2, 2, 4},
{3, 2, 5},
{25, 26, 51},
}
for _, table := range tables {
total := Sum(table.x, table.y)
if total != table.r {
t.Errorf("Sum(%d, %d) was incorrect, got: %d, want: %d.", table.x, table.y, total, table.r)
}
}
}
main
package main
func Sum(x, y int) int {
return x + y
}
func GetMax(x, y int) int {
if x > y {
return x
}
return y
}