¿Quién guarda a los guardianes? - Encontrando errores en tus pruebas

Rate this content
Bookmark

Hoy en día, las pruebas se han vuelto la norma. Hay muchas herramientas disponibles para escribir diferentes tipos de pruebas. Si bien las pruebas mantienen la guardia sobre el código principal de la aplicación, ¿cómo puedes estar seguro de que no tienes errores ocultos en tu código de prueba? ¿Deberías escribir pruebas para las pruebas?

En esta charla ilustrativa te mostraré un enfoque diferente sobre cómo puedes eliminar ciertos tipos de problemas de tus pruebas utilizando herramientas de análisis estático de código como SonarLint o SonarQube. Nos enfocaremos en problemas comunes encontrados en pruebas utilizando frameworks como Mocha y Chai.

8 min
18 Nov, 2021

Video Summary and Transcription

La charla discute las trampas comunes de las pruebas unitarias en JavaScript, incluyendo problemas con expectativas, afirmaciones y afirmaciones faltantes. También destaca la importancia de manejar excepciones correctamente e introduce SonarLint como una herramienta para el análisis de código y la corrección de problemas. Además, menciona SonarCube y SonarCloud como opciones para integrar pruebas de análisis estático en un flujo de trabajo de integración continua.

Available in English

1. Common Pitfalls of JavaScript Unit Testing

Short description:

Hola a todos, mi nombre es Tibor Blanesy y trabajo en análisis estático como fuente de sonar. Bienvenidos a esta charla que se llama ¿Quién cuida a los guardianes? Y me gustaría mostrarles tres problemas comunes en las pruebas unitarias de JavaScript. El primer problema que me gustaría mostrarles es el siguiente. Imaginen que tienen la siguiente prueba y escriben sus expectativas allí. ¿Ven el problema? Cualquier cosa que hagan dentro de la expectativa, esta prueba en realidad nunca falla. El siguiente problema que me gustaría mostrarles puede ser un poco estético. Sin embargo, a menudo ayuda tener una prueba clara para entender mejor el problema real. Entonces, en la siguiente prueba, cuando escriben su afirmación, siempre necesitan proporcionar el valor actual que es el resultado de la prueba y su expectativa. Y el orden en el que se proporcionan estos valores importa. El tercer problema que me gustaría mostrarles en esta charla relámpago es el siguiente. Imaginen que tienen una prueba y esta prueba siempre será exitosa. ¿Por qué? Porque en realidad no hay ninguna afirmación en ella. Así que no están probando nada.

Hola a todos, mi nombre es Tibor Blanesy y trabajo en análisis estático como fuente de sonar.

Bienvenidos a esta charla que se llama ¿Quién cuida a los guardianes?

Y me gustaría mostrarles tres problemas comunes en las pruebas unitarias de JavaScript.

El primer problema que me gustaría mostrarles es el siguiente.

Imaginen que tienen la siguiente prueba y escriben sus expectativas allí.

¿Ven el problema? Cualquier cosa que hagan dentro de la expectativa, esta prueba en realidad nunca falla.

Porque lo que falta es la afirmación después del expect.

Así que para tener pruebas significativas, debe verse así.

Les sorprendería lo común que es este problema.

Solo les mostraré dos ejemplos.

El primero es en el proyecto Kibana y el segundo es en Angular.

El siguiente problema que me gustaría mostrarles puede ser un poco estético.

Sin embargo, a menudo ayuda tener una prueba clara para entender mejor el problema real.

Entonces, en la siguiente prueba, cuando escriben su afirmación,

siempre necesitan proporcionar el valor actual que es el resultado de la prueba

y su expectativa.

Y el orden en el que se proporcionan estos valores importa.

Así que en el expect deben proporcionar el resultado del cálculo

y cuando invocan alguna afirmación como igual en este caso,

debe ser el valor esperado.

Si lo intercambian, recibirán un mensaje como este,

donde se espera que el valor esperado sea dos y sea igual a tres,

lo cual es incorrecto y puede ser confuso.

Correctamente debería verse así.

Deben tener la suma en la llamada a expect y debe ser igual

a lo que esperan, en este caso dos, lo que da un mejor mensaje

donde se espera que tres sea igual a dos.

Entonces el resultado de lo que calculamos es tres y nuestra expectativa era dos.

Y aquí está la prueba correcta donde deben corregir su cálculo

para que la prueba sea exitosa.

Esto es estético, pero cuando están depurando un problema más complejo,

puede ser realmente útil tener un buen mensaje de error.

Aquí está el proyecto de la vida real que tiene este problema.

Verán que en la expectativa, la prueba y los datos están intercambiados.

El tercer problema que me gustaría mostrarles en esta charla relámpago

es el siguiente.

Imaginen que tienen una prueba y esta prueba siempre será exitosa.

¿Por qué? Porque en realidad no hay ninguna afirmación en ella.

Así que no están probando nada.

Para corregir esta prueba, en realidad deberían afirmar algo.

Por ejemplo, quieren afirmar si esta cadena tiene el valor de cadena.

Y aquí está el ejemplo de la vida real del proyecto ESLink donde podrían tener este problema.

2. Handling Exceptions and Using SonarLint

Short description:

Esto suele ocurrir al tratar con excepciones. La mejor manera de manejarlo es envolver la llamada en la expectativa y afirmar que se lanza una excepción o que no se lanza ninguna excepción. SonarLint puede ayudarte a evitar este tipo de problemas en tu código. Es una extensión que se puede instalar en Visual Studio Code. Al usar SonarLint, puedes solucionar rápidamente problemas en tu IDE y tu editor te notificará cuando tengas un problema. Para integrar pruebas de análisis estático en tu canal de integración continua, puedes usar SonarCube para instalación local o SonarCloud para una solución en la nube.

Entonces, la siguiente prueba fallará si se lanza la excepción como sugiere el comentario, sin embargo, el mensaje no será muy claro. La mejor manera de hacerlo es envolver tu llamada en la expectativa y afirmar que se lanza la excepción o, en este caso, afirmar que no se lanza ninguna excepción. Aquí está la documentation del marco de afirmaciones CHI sobre cómo hacerlo.

Entonces, es posible que te preguntes cómo puedes evitar tener este tipo de problemas en tu código y te mostraré una pequeña demostración de cómo puedes hacerlo con SonarLint, SonarCloud o SonarQube. Primero, comenzaré con SonarLint. SonarLint es una extensión que puedes instalar en Visual Studio Code. Aquí está la extensión, ya está instalada y aquí tengo los tres ejemplos que te mostré. El primero aquí es la afirmación incompleta donde la expectativa contiene la comparación entre una función y el valor del resultado y en realidad, para que esta prueba sea más significativa, lo que debes hacer es eliminar la expectativa de aquí y agregar la afirmación de esta manera. Y los problemas aquí desaparecen. El segundo problema que mostré, donde puedes pasar el cursor aquí sobre la línea ondulada para ver la descripción. Dice que los dos argumentos en la afirmación deberían intercambiarse y el orden correcto es el valor actual primero y luego tu expectativa. Cuando intercambio los argumentos, el problema desaparece. Y el último problema que mostré fue el problema con la afirmación faltante. Entonces, aquí ves que cuando paso el cursor sobre la línea ondulada, veo que al menos debe haber una afirmación en esta prueba. Así que agreguemos una afirmación aquí. Digamos que esperamos que la cadena esté vacía de esta manera y el problema desaparece. Así es como puedes solucionarlo rápidamente en tu IDE y tu editor te notificará cuando tengas este problema. Y también, si deseas integrar este tipo de análisis estático testing para tus pruebas unitarias en tu canal de integración continua, puedes usar SonarCube, que se instala localmente o si prefieres la solución en la cloud, está Sonar cloud. Ambos se verán iguales. Aquí tengo SonarCube y aquí está el mismo archivo que se analizó en el canal de integración continua. Aquí ves nuevamente la línea ondulada donde se encuentran los problemas. Esto es todo en mi charla relámpago. ¡Gracias por tu atención y adiós!

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

TestJS Summit 2021TestJS Summit 2021
33 min
Network Requests with Cypress
Top Content
Whether you're testing your UI or API, Cypress gives you all the tools needed to work with and manage network requests. This intermediate-level task demonstrates how to use the cy.request and cy.intercept commands to execute, spy on, and stub network requests while testing your application in the browser. Learn how the commands work as well as use cases for each, including best practices for testing and mocking your network requests.
TestJS Summit 2021TestJS Summit 2021
38 min
Testing Pyramid Makes Little Sense, What We Can Use Instead
Top Content
Featured Video
The testing pyramid - the canonical shape of tests that defined what types of tests we need to write to make sure the app works - is ... obsolete. In this presentation, Roman Sandler and Gleb Bahmutov argue what the testing shape works better for today's web applications.
TestJS Summit 2022TestJS Summit 2022
27 min
Full-Circle Testing With Cypress
Top Content
Cypress has taken the world by storm by brining an easy to use tool for end to end testing. It’s capabilities have proven to be be useful for creating stable tests for frontend applications. But end to end testing is just a small part of testing efforts. What about your API? What about your components? Well, in my talk I would like to show you how we can start with end-to-end tests, go deeper with component testing and then move up to testing our API, circ
TestJS Summit 2021TestJS Summit 2021
31 min
Test Effective Development
Top Content
Developers want to sleep tight knowing they didn't break production. Companies want to be efficient in order to meet their customer needs faster and to gain competitive advantage sooner. We ALL want to be cost effective... or shall I say... TEST EFFECTIVE!But how do we do that?Are the "unit" and "integration" terminology serves us right?Or is it time for a change? When should we use either strategy to maximize our "test effectiveness"?In this talk I'll show you a brand new way to think about cost effective testing with new strategies and new testing terms!It’s time to go DEEPER!
TestJS Summit 2023TestJS Summit 2023
21 min
Everyone Can Easily Write Tests
Let’s take a look at how Playwright can help you get your end to end tests written with tools like Codegen that generate tests on user interaction. Let’s explore UI mode for a better developer experience and then go over some tips to make sure you don’t have flakey tests. Then let’s talk about how to get your tests up and running on CI, debugging on CI and scaling using shards.

Workshops on related topic

React Summit 2023React Summit 2023
151 min
Designing Effective Tests With React Testing Library
Featured Workshop
React Testing Library is a great framework for React component tests because there are a lot of questions it answers for you, so you don’t need to worry about those questions. But that doesn’t mean testing is easy. There are still a lot of questions you have to figure out for yourself: How many component tests should you write vs end-to-end tests or lower-level unit tests? How can you test a certain line of code that is tricky to test? And what in the world are you supposed to do about that persistent act() warning?
In this three-hour workshop we’ll introduce React Testing Library along with a mental model for how to think about designing your component tests. This mental model will help you see how to test each bit of logic, whether or not to mock dependencies, and will help improve the design of your components. You’ll walk away with the tools, techniques, and principles you need to implement low-cost, high-value component tests.
Table of contents- The different kinds of React application tests, and where component tests fit in- A mental model for thinking about the inputs and outputs of the components you test- Options for selecting DOM elements to verify and interact with them- The value of mocks and why they shouldn’t be avoided- The challenges with asynchrony in RTL tests and how to handle them
Prerequisites- Familiarity with building applications with React- Basic experience writing automated tests with Jest or another unit testing framework- You do not need any experience with React Testing Library- Machine setup: Node LTS, Yarn
TestJS Summit 2022TestJS Summit 2022
146 min
How to Start With Cypress
Featured WorkshopFree
The web has evolved. Finally, testing has also. Cypress is a modern testing tool that answers the testing needs of modern web applications. It has been gaining a lot of traction in the last couple of years, gaining worldwide popularity. If you have been waiting to learn Cypress, wait no more! Filip Hric will guide you through the first steps on how to start using Cypress and set up a project on your own. The good news is, learning Cypress is incredibly easy. You'll write your first test in no time, and then you'll discover how to write a full end-to-end test for a modern web application. You'll learn the core concepts like retry-ability. Discover how to work and interact with your application and learn how to combine API and UI tests. Throughout this whole workshop, we will write code and do practical exercises. You will leave with a hands-on experience that you can translate to your own project.
React Summit 2022React Summit 2022
117 min
Detox 101: How to write stable end-to-end tests for your React Native application
Top Content
WorkshopFree
Compared to unit testing, end-to-end testing aims to interact with your application just like a real user. And as we all know it can be pretty challenging. Especially when we talk about Mobile applications.
Tests rely on many conditions and are considered to be slow and flaky. On the other hand - end-to-end tests can give the greatest confidence that your app is working. And if done right - can become an amazing tool for boosting developer velocity.
Detox is a gray-box end-to-end testing framework for mobile apps. Developed by Wix to solve the problem of slowness and flakiness and used by React Native itself as its E2E testing tool.
Join me on this workshop to learn how to make your mobile end-to-end tests with Detox rock.
Prerequisites- iOS/Android: MacOS Catalina or newer- Android only: Linux- Install before the workshop
TestJS Summit 2023TestJS Summit 2023
48 min
API Testing with Postman Workshop
WorkshopFree
In the ever-evolving landscape of software development, ensuring the reliability and functionality of APIs has become paramount. "API Testing with Postman" is a comprehensive workshop designed to equip participants with the knowledge and skills needed to excel in API testing using Postman, a powerful tool widely adopted by professionals in the field. This workshop delves into the fundamentals of API testing, progresses to advanced testing techniques, and explores automation, performance testing, and multi-protocol support, providing attendees with a holistic understanding of API testing with Postman.
1. Welcome to Postman- Explaining the Postman User Interface (UI)2. Workspace and Collections Collaboration- Understanding Workspaces and their role in collaboration- Exploring the concept of Collections for organizing and executing API requests3. Introduction to API Testing- Covering the basics of API testing and its significance4. Variable Management- Managing environment, global, and collection variables- Utilizing scripting snippets for dynamic data5. Building Testing Workflows- Creating effective testing workflows for comprehensive testing- Utilizing the Collection Runner for test execution- Introduction to Postbot for automated testing6. Advanced Testing- Contract Testing for ensuring API contracts- Using Mock Servers for effective testing- Maximizing productivity with Collection/Workspace templates- Integration Testing and Regression Testing strategies7. Automation with Postman- Leveraging the Postman CLI for automation- Scheduled Runs for regular testing- Integrating Postman into CI/CD pipelines8. Performance Testing- Demonstrating performance testing capabilities (showing the desktop client)- Synchronizing tests with VS Code for streamlined development9. Exploring Advanced Features - Working with Multiple Protocols: GraphQL, gRPC, and more
Join us for this workshop to unlock the full potential of Postman for API testing, streamline your testing processes, and enhance the quality and reliability of your software. Whether you're a beginner or an experienced tester, this workshop will equip you with the skills needed to excel in API testing with Postman.
TestJS Summit - January, 2021TestJS Summit - January, 2021
173 min
Testing Web Applications Using Cypress
WorkshopFree
This workshop will teach you the basics of writing useful end-to-end tests using Cypress Test Runner.
We will cover writing tests, covering every application feature, structuring tests, intercepting network requests, and setting up the backend data.
Anyone who knows JavaScript programming language and has NPM installed would be able to follow along.
TestJS Summit 2023TestJS Summit 2023
148 min
Best Practices for Writing and Debugging Cypress Tests
Workshop
You probably know the story. You’ve created a couple of tests, and since you are using Cypress, you’ve done this pretty quickly. Seems like nothing is stopping you, but then – failed test. It wasn’t the app, wasn’t an error, the test was… flaky? Well yes. Test design is important no matter what tool you will use, Cypress included. The good news is that Cypress has a couple of tools behind its belt that can help you out. Join me on my workshop, where I’ll guide you away from the valley of anti-patterns into the fields of evergreen, stable tests. We’ll talk about common mistakes when writing your test as well as debug and unveil underlying problems. All with the goal of avoiding flakiness, and designing stable test.