Plots2: Agregue más pruebas funcionales para cada método en la API de búsqueda

Hola, este es un problema solo para principiantes. Esto significa que hemos trabajado para hacerlo más legible para las personas que no han contribuido a nuestro código base antes o incluso para las personas que no han contribuido antes al código abierto.

Si ese es usted, estamos interesados ​​en ayudarlo a dar el primer paso y podemos responder preguntas y ayudarlo mientras lo hace. Tenga en cuenta que estamos especialmente interesados ​​en las contribuciones de personas de grupos subrepresentados en software gratuito y de código abierto.

Si ha contribuido antes, considere dejar este para alguien nuevo y revise nuestros problemas de búsqueda de ayuda general. ¡Gracias!

El problema

Las pruebas nos ayudan a asegurarnos de que el sitio se comporta como esperamos y que, a medida que se agregan nuevas funciones, no rompen las funciones existentes. Estamos trabajando para llegar a una "cobertura" cercana al 100%, lo que significaría que todo nuestro código está cubierto por pruebas.
Tenemos buenas pruebas escritas para la API typeahead, aquí: https://github.com/publiclab/plots2/blob/master/test/functional/typeahead_api_test.rb

Esto prueba cada método en: https://github.com/publiclab/plots2/blob/master/app/api/srch/typeahead.rb

Pero deberíamos tener similares para la API de búsqueda, para cada uno de los métodos en: https://github.com/publiclab/plots2/blob/master/app/api/srch/search.rb

(Tenga en cuenta que estos se basan en gran medida en este archivo, a su vez, en caso de que desee saber cómo se generan: https://github.com/publiclab/plots2/blob/master/app/services/search_service.rb)

Solución

En el n. ° 1409, un colaborador por primera vez creó recientemente un nuevo archivo de prueba y una única prueba, que puede encontrar en test / funcional / search_api_test.rb:

prueba la 'funcionalidad de notas de búsqueda' hacer
obtener '/ api / srch / notes? srchString = Blog'
afirmar last_response.ok?
# cosas más después de esto
Esta es una prueba básica de que la respuesta es "correcta" y luego pasa a probar qué hay en la respuesta. Vea cómo usa una URL para acceder al método de notas en esta línea:

Por lo tanto, cópielo y siga los ejemplos de URL proporcionados en search.rb para crear una nueva prueba para un método diferente. Por ejemplo, perfiles: https://github.com/publiclab/plots2/blob/master/app/api/srch/search.rb#L30

Comience simplemente afirmando last_response.ok? como anteriormente; podemos agregar más pruebas sustantivas más adelante.

Puede intentar ejecutar esto con la prueba de rake o (solo para ejecutar las pruebas funcionales solamente) rake test TEST = test / funcional / search_api_test.rb - ¡con suerte pasará!

Pero también puede abrir una solicitud de extracción (ver más abajo) y nuestro sistema de prueba automatizado la ejecutará, y podrá ver el resultado allí.

Si puede ayudar con esto, abra una solicitud de extracción con esta prueba agregada y veamos cómo funciona; incluso si no pasa, podemos ayudarlo con los siguientes pasos.

Pasos para arreglar

Reclame este problema con un comentario aquí, a continuación, y haga las preguntas aclaratorias que necesite.
configure un repositorio localmente siguiendo las instrucciones README y asegúrese de que todas las pruebas pasen
Intente solucionar el problema siguiendo los pasos anteriores, pero incluso antes de que termine, puede:
Confirme sus cambios e inicie una solicitud de extracción (consulte Contribución al software Public Lab), pero márquelo como "en progreso" si tiene preguntas o si no ha terminado.
alertar a alguien a través de la lista de desarrolladores (ver más abajo) para que se fusione su solicitud de extracción. Esto puede requerir algunos pasos adicionales dependiendo de cuándo lo haga, ¡pero lo ayudaremos!
Envíe un correo electrónico a la lista de desarrolladores (consulte https://publiclab.org/wiki/developers) o vaya a la sala de chat si tiene preguntas, y eche un vistazo a nuestra página de inicio para principiantes para obtener más información.