Tabla de contenidos
¿Estás escribiendo una especificación de prueba?
Hay varias formas de redactar especificaciones de prueba, como hacerlas como especificaciones de prueba o como código de prueba, dependiendo de la empresa. Creo que es común que las empresas grandes y históricas creen especificaciones de prueba en archivos de Excel. Al editar entre varias personas, creo que también es común, al menos en Japón, utilizar sufijos como _latest, _latest_20230103, _latest_5 para gestionar las versiones.
Me gustaría conocer las mejores prácticas para manejar archivos de Excel, pero no tengo una buena idea en este momento, así que decidí utilizar un programa para hacer que las diferencias sean visibles en un repositorio Git y gestionarlas.
Sin embargo, si colocas el archivo de Excel directamente en Git, las líneas de diferencia no se mostrarán claramente. TortoiseGit y otras herramientas también te mostrarán la diferencia, pero ¿puedes hacer pull requests y comentarios allí? Normalmente ves la diferencia en la página web del repositorio de todos modos. Y CSV también es un poco insatisfactorio. Hay herramientas que pueden editar CSV en formato de tabla como hoja de cálculo, pero la visualización de diferencias en el repositorio debería ser un texto delimitado por caracteres simple, que no es fácil de leer.
Entonces, pensé en gestionar casos de prueba en Markdown. Si puedes gestionarlo en texto, también puedes usar comandos *nix. Puedes escribir casos de prueba incluso si no tienes Excel, y si puedes convertirlo a Excel, nadie tendrá problemas. (La herramienta que utilicé también puede convertir a CSV, TSV.)
Resumen hasta ahora
- Si lo gestionas con Git, no tendrás que preguntarte cuál es la última versión.
- Si lo gestionas con Markdown, puedes ver la diferencia en la pull request. También puedes comentar allí.
- CSV también puede romper la visualización
- Si lo gestionas con Markdown, puedes usar comandos *nix.
- Si lo gestionas con Markdown, puedes crear y editarlo incluso si no tienes Microsoft Excel.
- Si puedes convertir de Markdown a Excel, no tendrás problemas cuando quieras usar el formato de tabla.
Entorno probado
- macOS Monterey Versión 12.6
- Python 3.10
- meal 0.0.3.32
Cómo convertir Markdown a Excel
Preparación
Instala una herramienta de Python llamada mael.
|
1 |
$ pip install mael |
Crea un directorio para almacenar las especificaciones de prueba.
|
1 |
$ mkdir test |
Inicializa la carpeta.
Se te preguntará qué plantilla deseas utilizar.
Para pruebas, 1: Caso de prueba es útil.
|
1 2 3 4 5 6 7 8 |
$ mael init test Initialize /directory/path/test. Which template do you use? 0: Normal 1: Test case Type number: 1[Enter] |
Luego, se generan los siguientes archivos.
|
1 2 3 4 5 6 7 8 |
|--.gitignore |--config | |--columns.yml | |--ignore.txt | `--variables.ini |--README.md |--Scenario 1.md `--Scenario 2.md |
Hay varios archivos de configuración en config, pero puedes cambiarlos más tarde, así que continuemos con la creación principal de casos de prueba.
Descripción del caso de prueba
Scenario 1.md, Scenario 2.md tienen casos de prueba de muestra escritos en ellos.
Actualicémoslos.
Edita con vim test/Scenario\ 1.md o algo así.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
# Scenario 1 ## Summary This is a test. ## List ### Item Login confirmation ### Description Try logging in ### Expected value You can log in --- ### Item Open my page ### Description Click the link "My Page" in the upper right corner ### Expected value My page is displayed. The following four menus are displayed. * Change email address * Change password * Change address * Withdrawal |
Generar archivo Excel
Ejecuta el siguiente comando.
|
1 |
$ mael build test |
Se genera test/output/test.xlsx.
La configuración en el directorio config agrega las columnas Result, Timestamp, Comment.
Puedes usarlas como campos para ingresar la hora de ejecución y comentarios al realizar la prueba.
Para ajustar el ancho de columna de «Item», «Description» y «Expected Value», cambia columns.yml.
|
1 2 3 4 5 6 7 |
column_conditions: Item: ancho: 20 Description: ancho: 30 Valor esperado: ancho: 30 |
(Ya hay configuraciones de columna para Categorías, Descripción, Esperado en column_conditions, pero puedes eliminarlas si no las utilizas.)
Y ejecuta el comando nuevamente. Luego, el ancho de columna cambia y se muestra como sigue.
Último paso
Guardemos los archivos Markdown en Git. Como aún no lo hemos inicializado, comenzaremos con git init.
|
1 2 3 4 5 |
$ git init $ git add . $ git commit -m inicial $ git remote add origin https://... $ git push -u origin |
Ahora, puedes gestionar casos de prueba en archivos Markdown.
mael puede generar tablas de Excel si coincides con el formato Markdown, así que es útil para gestionar varios datos en Markdown, no solo especificaciones de prueba.
Consejos
Usar variables
Creemos variables que se pueden usar repetidamente, como nombres de usuario y URL que aparecen muchas veces. Si fuera Excel, usaría referencias de celdas o definiría nombres.
Con mael, puedes definir variables en config/variables.ini. Bueno, son constantes.
|
1 2 3 |
URL=https://sample.com USERNAME=admin PASSWORD=abcdefg |
Para usar las variables definidas, encierra el nombre de la variable con {{ }}.
|
1 2 3 4 5 6 7 |
# Scenario 2 ## Summary Log in with {{ USERNAME }} / {{ PASSWORD }} at {{ URL }}. ## List ### Test Log in with {{ USERNAME }} / {{ PASSWORD }} at {{ URL }}. |
Cambiar el valor de la variable para cada entorno
A veces quieres cambiar el valor de la variable para cada entorno, como cuando la URL del sitio web o el nombre de usuario a utilizar es diferente entre el entorno de producción y el entorno de desarrollo.
En ese caso, creas una definición de variable en la forma de variables.{nombre del entorno}.ini.
Por ejemplo, crea variables.dev.ini de la siguiente manera.
|
1 |
URL=https://dev.sample.com |
Y utiliza el parámetro de opción -e para ejecutar el comando.
|
1 |
$ mael build test -e dev |
Esto creará test/output/test_dev.xlsx.
variables.ini se utiliza, pero si hay la misma definición de variable en variables.dev.ini, la definición en variables.dev.ini tiene prioridad.
Reducir el número de líneas en Markdown
Dado que todos los elementos en la tabla están dispuestos verticalmente, el número de líneas en el archivo Markdown será largo. Hay dos formas de reducir el número de líneas en Markdown.
No uses ---
Anteriormente, expliqué que se usa --- para pasar a la siguiente línea.
Esto es para la presentación visual en Markdown y no es necesariamente necesario.
Si el mismo valor de columna continúa, el segundo se trata como un nuevo valor de línea.
|
1 2 3 4 5 |
## List ### Column A ### Column B |
| Column |
|---|
| A |
| B |
También es posible configurarlo para sobrescribir la línea existente en lugar de agregar una nueva línea.
Copiar cuando esté en blanco
En las tablas de Excel, incluidas las especificaciones de prueba, hay casos en los que las primera y segunda filas son iguales para una columna específica. En la siguiente tabla, las categorías grande y mediana se repiten.
| Large category | Medium category | Small category | Remarks |
|---|---|---|---|
| Tokyo | Chuo-ku | Ginza | TEXT1 |
| Tokyo | Chuo-ku | Tsukiji | |
| Osaka | Kita-ku | Umeda | TEXT2 |
En este caso, puedes escribir la parte repetida una vez configurando config/columns.yml.
En el siguiente ejemplo, solo escribí la categoría grande «Tokyo» y la categoría mediana «Chuo-ku» una vez.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
## List ### Large category Tokyo ### Medium category Chuo-ku ### Small category Ginza ### Remarks TEXT1 ### Small category Tsukiji ### Large category Osaka ### Medium category Kita-ku ### Small category Umeda ### Remarks TEXT2 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
## Lista ### Categoría grande Tokyo ### Categoría mediana Chuo-ku ### Categoría pequeña Ginza ### Observaciones TEXT1 ### Categoría pequeña Tsukiji ### Categoría grande Osaka ### Categoría mediana Kita-ku ### Categoría pequeña Umeda ### Observaciones TEXT2 |
Hay varias formas de configurar config/columns.yml.
Un método para configurar todo para copiar la línea anterior cuando está en blanco y no copiar las observaciones,
|
1 2 3 4 5 6 |
global: duplicate_previous_for_blank: true column_conditions: Observaciones: duplicate_previous_for_blank: false |
Un método para configurar solo las categorías grande y mediana para copiar la línea anterior cuando está en blanco,
|
1 2 3 4 5 |
column_conditions: Large category: duplicate_previous_for_blank: true Medium category: duplicate_previous_for_blank: true |
La última configuración es configurar solo todo y escribir solo el título de «Observaciones» para «Tokyo», «Chuo-ku» y «Tsukiji». La última configuración requiere un pequeño cambio en el archivo Markdown.
|
1 2 |
global: duplicate_previous_for_blank: true |
|
1 2 3 4 5 6 7 |
... ### Small category Tsukiji ### Remarks ... |
Salida en CSV/TSV
Es posible que termines pensando en CSV de todos modos, pero CSV es un formato difícil de descartar para verificar en la CLI.
Puedes generar la salida en CSV/TSV usando la opción -f al ejecutar mael build. El valor predeterminado es -f excel.
|
1 2 |
$ mael build test -f csv $ mael build test -f tsv |
Convertir procedimiento existente de Excel a Markdown
Para usar mael, necesitas tener las especificaciones en Markdown. Sin embargo, es bastante difícil escribir las especificaciones existentes en Markdown a mano. Entonces, uso pandas para convertirlo a Markdown.
Puedes leer Excel con read_excel y generarlo como Markdown.
Código de muestra
Usé jupyter notebook y pandas para procesarlo.
Primero, lee los datos.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
import pandas as pd nombre_hoja = "pasos_de_prueba" df = pd.read_excel( 'prueba.xlsx', sheet_name=nombre_hoja, # si hay una especificación de hoja header=5, # fila de encabezado # especifica las columnas a usar aquí si las hay usecols=[ 'ID', 'Categoría grande', 'Categoría mediana', 'Categoría pequeña', 'Descripción', 'URL', 'Normal/Anormal', 'Resultado esperado', 'Comentario' ] ) |
Genera la salida de datos a la salida estándar y compruébalo.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
d = df.fillna('').to_dict(orient="record") l = len(d) def escribir(nombre, d, f=None): print("#", nombre, file=f) print("##", "Resumen", file=f) print("##", "Lista", file=f) for i in range(len(d)): h = d[i] for k, v in h.items(): print("###", k, file=f) if len(str(v)) > 0: print(v, "\n", file=f) print("\n", file=f) print("---", "\n", file=f) escribir(nombre_hoja, d) |
Finalmente, genera la salida a un archivo.
|
1 2 |
with open('exportado.md', "w") as f: escribir(nombre_hoja, d, f=f) |
Quiero poner un archivo README.md que no se puede poner en Excel.
Crea config/ignore.txt y escribe README.md en él.
|
1 |
README.md |
Se leen todos los archivos Markdown como escenarios de prueba, así que si tienes algo que quieres mantener separado, ponlo en ignore.txt.
Resumen: Cómo crear especificaciones de prueba en Excel con Markdown
- Inicializa con
mael init test_dir. -
Edita el archivo Markdown y crea casos de prueba
- Escribe un Resumen y una Lista.
- Las líneas son fáciles de leer como Markdown cuando están separadas por
---. Si deseas reducir el número de líneas, puedes omitirlas. - Si usas variables, utiliza
test_dir/config/variables.iniytest_dir/config/variables.{nombre del entorno}.ini. - Si deseas ajustar el ancho de la columna, utiliza
config/columns.yml.
-
Crea Excel con
mael build test_dirymael build test_dir -e {nombre del entorno}.- También puedes convertir a CSV/TSV con
-f csvy-f tsv.
- También puedes convertir a CSV/TSV con
Posdata
Pensé que Gauge podría ser bueno, pero me preguntaba si sería difícil de entender para los no ingenieros. También pensé que Pandoc podría ser una opción, pero no estoy seguro de si Pandoc es adecuado para especificaciones de prueba. mael no tiene la función de insertar figuras, así que creo que Pandoc también es bueno, pero creo que no es un problema porque de todos modos deberías escribirlo con palabras. Creo que mael es mejor porque Pandoc no tiene la función de copiar el valor de la línea anterior a la parte en blanco.
Now you can see all the content in English page.
