Plots2: Tambahkan lebih banyak pengujian fungsional untuk setiap metode di Search API

Hai, ini hanya masalah pertama kali. Ini berarti kami telah bekerja untuk membuatnya lebih mudah dibaca oleh orang-orang yang belum pernah berkontribusi pada basis kode kami sebelumnya atau bahkan orang-orang yang belum pernah berkontribusi pada open source sebelumnya.

Jika itu Anda, kami tertarik untuk membantu Anda mengambil langkah pertama dan dapat menjawab pertanyaan serta membantu Anda seperti yang Anda lakukan. Perhatikan bahwa kami sangat tertarik pada kontribusi dari orang-orang dari kelompok yang kurang terwakili dalam perangkat lunak bebas dan sumber terbuka!

Jika Anda telah berkontribusi sebelumnya, pertimbangkan untuk meninggalkan yang satu ini untuk seseorang yang baru, dan lihat melalui bantuan umum kami masalah yang diinginkan. Terima kasih!

Masalah

Pengujian membantu kami memastikan bahwa situs berperilaku seperti yang kami harapkan -- dan bahwa saat fitur baru ditambahkan, fitur tersebut tidak merusak fungsi yang ada. Kami sedang berupaya untuk mendekati 100% "cakupan" -- yang berarti semua kode kami tercakup oleh pengujian.
Kami memiliki tes bagus yang ditulis untuk API typeahead, di sini: https://github.com/publiclab/plots2/blob/master/test/functional/typeahead_api_test.rb

Ini menguji setiap metode di: https://github.com/publiclab/plots2/blob/master/app/api/srch/typeahead.rb

Tetapi kita harus memiliki yang serupa untuk API pencarian, untuk setiap metode di: https://github.com/publiclab/plots2/blob/master/app/api/srch/search.rb

(Perhatikan bahwa ini sangat bergantung pada file ini -- jika Anda ingin tahu cara pembuatannya: https://github.com/publiclab/plots2/blob/master/app/services/search_service.rb)

Larutan

Di #1409, kontributor pertama kali baru-baru ini membuat file pengujian baru, dan satu pengujian, yang dapat Anda temukan di test/functional/search_api_test.rb:

uji 'fungsi catatan pencarian' lakukan
dapatkan '/api/srch/notes?srchString=Blog'
tegaskan last_response.ok?
# barang lagi setelah ini
Ini adalah tes dasar bahwa responsnya "ok" dan kemudian melanjutkan untuk menguji apa yang ada di respons. Lihat bagaimana ia menggunakan URL untuk mengakses metode catatan di baris ini:

Jadi, salin, dan ikuti contoh URL yang disediakan di search.rb untuk membuat tes baru untuk metode yang berbeda. Misalnya, profil: https://github.com/publiclab/plots2/blob/master/app/api/srch/search.rb#L30

Mulailah dengan hanya menegaskan last_response.ok? seperti di atas; kita dapat menambahkan lebih banyak tes substantif nanti.

Anda dapat mencoba menjalankan ini dengan rake test atau (hanya untuk menjalankan tes fungsional saja) rake test TEST=test/functional/search_api_test.rb -- semoga lulus!

Tetapi Anda juga dapat membuka permintaan tarik (lihat di bawah) dan sistem pengujian otomatis kami akan menjalankannya, dan Anda akan dapat melihat hasilnya di sana.

Jika Anda dapat membantu dengan ini, silakan buka permintaan tarik dengan tes ini ditambahkan, dan mari kita lihat bagaimana kelanjutannya -- meskipun tidak lulus, kami dapat membantu Anda dengan langkah selanjutnya.

Langkah-langkah untuk Memperbaiki to

klaim masalah ini dengan komentar di sini, di bawah, dan ajukan pertanyaan klarifikasi yang Anda butuhkan
siapkan repositori secara lokal dengan mengikuti instruksi README, dan pastikan semua tes lulus
coba perbaiki masalah dengan mengikuti langkah-langkah di atas, tetapi bahkan sebelum Anda selesai, Anda dapat:
komit perubahan Anda dan mulai permintaan tarik (lihat berkontribusi ke perangkat lunak Lab Publik) tetapi tandai sebagai "sedang berlangsung" jika Anda memiliki pertanyaan atau jika Anda belum selesai
beri tahu seseorang melalui daftar pengembang (lihat di bawah) agar permintaan tarik Anda digabungkan. Ini mungkin memerlukan beberapa langkah tambahan tergantung kapan Anda melakukannya, tetapi kami akan membantu Anda!
Silakan kirim email ke daftar pengembang (lihat https://publiclab.org/wiki/developers) atau buka ruang obrolan jika Anda memiliki pertanyaan, dan lihat halaman arahan pemula kami untuk informasi lebih lanjut!