Plots2: Adicione mais testes funcionais para cada método na API de pesquisa

Olá, este é um problema apenas para os iniciantes. Isso significa que trabalhamos para torná-lo mais legível para as pessoas que não contribuíram com nossa base de código antes ou mesmo para as pessoas que não contribuíram com o código aberto antes.

Se for você, estamos interessados ​​em ajudá-lo a dar o primeiro passo e podemos responder a perguntas e ajudá-lo como você faz. Observe que estamos especialmente interessados ​​em contribuições de pessoas de grupos sub-representados em software livre e de código aberto!

Se você já contribuiu antes, considere deixar este para alguém novo e olhar através de nossos problemas de necessidade de ajuda geral. Obrigado!

O problema

Os testes nos ajudam a garantir que o site se comporte como esperamos - e que, à medida que novos recursos são adicionados, eles não interrompem as funções existentes. Estamos trabalhando para chegar a quase 100% de "cobertura" - o que significaria que todo o nosso código é coberto por testes.
Temos bons testes escritos para a API Typeahead, aqui: https://github.com/publiclab/plots2/blob/master/test/functional/typeahead_api_test.rb

Isso testa cada método em: https://github.com/publiclab/plots2/blob/master/app/api/srch/typeahead.rb

Mas devemos ter outros semelhantes para a API de pesquisa, para cada um dos métodos em: https://github.com/publiclab/plots2/blob/master/app/api/srch/search.rb

(Observe que eles dependem muito deste arquivo, por sua vez - caso você queira saber como eles são gerados: https://github.com/publiclab/plots2/blob/master/app/services/search_service.rb)

Solução

No # 1409, um colaborador pela primeira vez criou recentemente um novo arquivo de teste e um único teste, que você pode encontrar em test / funcional / search_api_test.rb:

testar a 'funcionalidade de notas de pesquisa' fazer
get '/ api / srch / notes? srchString = Blog'
afirmar last_response.ok?
mais # coisas depois disso
Este é um teste básico de que a resposta está "ok" e, em seguida, testa o que está na resposta. Veja como ele usa um URL para acessar o método de notas nesta linha:

Portanto, copie-o e siga os exemplos de URL fornecidos em search.rb para criar um novo teste para um método diferente. Por exemplo, perfis: https://github.com/publiclab/plots2/blob/master/app/api/srch/search.rb#L30

Comece afirmando apenas last_response.ok? como acima; podemos adicionar mais testes substantivos posteriormente.

Você pode tentar rodar isso com o rake test ou (apenas para rodar apenas os testes funcionais) rake test TEST = test / funcional / search_api_test.rb - espero que passe!

Mas você também pode simplesmente abrir uma solicitação pull (veja abaixo) e nosso sistema de teste automatizado irá executá-la, e você poderá ver o resultado lá.

Se você puder ajudar com isso, abra uma solicitação pull com este teste adicionado e vamos ver como funciona - mesmo se não passar, podemos ajudá-lo nas próximas etapas.

Passos para corrigir

reivindique este problema com um comentário aqui, abaixo, e faça as perguntas de esclarecimento de que precisar
configurar um repositório localmente seguindo as instruções README, e certifique-se de que todos os testes passam
tente corrigir o problema seguindo as etapas acima, mas mesmo antes de terminar, você pode:
confirme suas alterações e inicie uma solicitação pull (consulte contribuição para o software Public Lab), mas marque-a como "em andamento" se tiver dúvidas ou se não tiver terminado
alerte alguém por meio da lista de desenvolvedores (veja abaixo) para que sua solicitação pull seja mesclada. Isso pode exigir algumas etapas extras, dependendo de quando você fizer isso, mas nós o ajudaremos!
Envie um e-mail para a lista de desenvolvedores (consulte https://publiclab.org/wiki/developers) ou vá para a sala de bate-papo se tiver dúvidas e dê uma olhada em nossa página de destino para iniciantes para mais informações!