Plots2: Fügen Sie weitere Funktionstests für jede Methode in der Such-API hinzu

Hallo, dies ist ein Problem nur für Erstbesucher. Das bedeutet, dass wir daran gearbeitet haben, es für Leute lesbarer zu machen, die entweder noch nie zu unserer Codebasis beigetragen haben oder sogar für Leute, die noch nie zu Open Source beigetragen haben.

Wenn das Sie sind, sind wir daran interessiert, Ihnen beim ersten Schritt zu helfen, können Fragen beantworten und Ihnen dabei helfen. Beachten Sie, dass wir besonders an Beiträgen von Personen aus Gruppen interessiert sind, die in freier und Open-Source-Software unterrepräsentiert sind!

Wenn Sie schon einmal einen Beitrag geleistet haben, ziehen Sie in Erwägung, diesen Beitrag jemandem Neuem zu überlassen und unsere allgemeinen Hilfeanfragen durchzusehen. Vielen Dank!

Das Problem

Tests helfen uns sicherzustellen, dass sich die Site so verhält, wie wir es erwarten – und dass neue Funktionen hinzugefügt werden, ohne dass bestehende Funktionen beeinträchtigt werden. Wir arbeiten daran, eine "Abdeckung" von nahezu 100 % zu erreichen - was bedeuten würde, dass unser gesamter Code durch Tests abgedeckt ist.
Wir haben gute Tests für die typeahead API geschrieben, hier: https://github.com/publiclab/plots2/blob/master/test/functional/typeahead_api_test.rb

Dies testet jede Methode in: https://github.com/publiclab/plots2/blob/master/app/api/srch/typeahead.rb

Aber wir sollten ähnliche für die Such-API haben, für jede der Methoden in: https://github.com/publiclab/plots2/blob/master/app/api/srch/search.rb

(Beachten Sie, dass diese wiederum stark auf dieser Datei basieren - falls Sie wissen möchten, wie sie generiert werden: https://github.com/publiclab/plots2/blob/master/app/services/search_service.rb)

Lösung

In #1409 hat ein Erstautor kürzlich eine neue Testdatei und einen einzelnen Test erstellt, die Sie unter test/functional/search_api_test.rb finden:

Testen Sie die Funktion "Notizen suchen"
Hole '/api/srch/notes?srchString=Blog'
last_response.ok behaupten?
# mehr Zeug danach
Dies ist ein grundlegender Test, bei dem die Antwort "ok" ist, und dann wird getestet, was in der Antwort enthalten ist. Sehen Sie sich an, wie eine URL verwendet wird, um auf die Notes-Methode in dieser Zeile zuzugreifen:

Kopieren Sie ihn also und folgen Sie den bereitgestellten URL-Beispielen in search.rb, um einen neuen Test für eine andere Methode zu erstellen. Zum Beispiel Profile: https://github.com/publiclab/plots2/blob/master/app/api/srch/search.rb#L30

Beginnen Sie damit, nur last_response.ok zu bestätigen? wie oben; wir können später weitere inhaltliche Tests hinzufügen.

Sie können versuchen, dies mit Rake-Test oder (nur um die Funktionstests auszuführen) auszuführen: Rake-Test TEST=test/functional/search_api_test.rb -- hoffentlich wird es bestehen!

Sie können aber auch einfach einen Pull-Request öffnen (siehe unten) und unser automatisiertes Testsystem führt ihn aus und Sie können dort die Ausgabe sehen.

Wenn Sie dabei helfen können, öffnen Sie bitte einen Pull-Request mit diesem hinzugefügten Test und lassen Sie uns sehen, wie er läuft – selbst wenn er nicht besteht, können wir Ihnen bei den nächsten Schritten helfen.

Schritte zur Behebung

Beanspruchen Sie dieses Problem mit einem Kommentar hier unten und stellen Sie alle klärenden Fragen, die Sie benötigen
Richten Sie ein Repository lokal gemäß den README-Anweisungen ein und stellen Sie sicher, dass alle Tests erfolgreich sind
Versuchen Sie, das Problem mit den obigen Schritten zu beheben, aber noch bevor Sie fertig sind, können Sie:
Übernehmen Sie Ihre Änderungen und starten Sie einen Pull-Request (siehe Beiträge zur Public Lab-Software), aber markieren Sie ihn als "in Bearbeitung", wenn Sie Fragen haben oder noch nicht fertig sind
Benachrichtigen Sie jemanden über die Entwicklerliste (siehe unten), damit Ihr Pull-Request zusammengeführt wird. Dies kann ein paar zusätzliche Schritte erfordern, je nachdem, wann Sie es tun, aber wir helfen Ihnen dabei!
Bitte senden Sie eine E-Mail an die Entwicklerliste (siehe https://publiclab.org/wiki/developers) oder besuchen Sie den Chatroom, wenn Sie Fragen haben, und werfen Sie einen Blick auf unsere Landingpage für Erstbesucher, um weitere Informationen zu erhalten!