Plots2: खोज API में प्रत्येक विधि के लिए अधिक कार्यात्मक परीक्षण जोड़ें

नमस्ते, यह एक प्रथम-टाइमर-ओनली मुद्दा है। इसका मतलब है कि हमने इसे उन लोगों के लिए अधिक सुपाठ्य बनाने के लिए काम किया है, जिन्होंने पहले हमारे कोडबेस में योगदान नहीं दिया है या यहां तक ​​कि उन लोगों के लिए भी जिन्होंने पहले ओपन सोर्स में योगदान नहीं दिया है।

अगर यह आप हैं, तो हम आपको पहला कदम उठाने में मदद करने में रुचि रखते हैं और हम सवालों के जवाब दे सकते हैं और आपकी मदद कर सकते हैं। ध्यान दें कि हम विशेष रूप से मुक्त और मुक्त स्रोत सॉफ़्टवेयर में कम प्रतिनिधित्व वाले समूहों के लोगों के योगदान में रुचि रखते हैं!

यदि आपने पहले योगदान दिया है, तो इसे किसी नए व्यक्ति के लिए छोड़ने पर विचार करें, और हमारी सामान्य सहायता वांछित समस्याओं को देखें। धन्यवाद!

समस्या

परीक्षण हमें यह सुनिश्चित करने में मदद करते हैं कि साइट हमारी अपेक्षा के अनुरूप व्यवहार करती है -- और जैसे ही नई सुविधाएँ जोड़ी जाती हैं, वे मौजूदा कार्यों को नहीं तोड़ती हैं। हम लगभग १००% "कवरेज" प्राप्त करने के लिए काम कर रहे हैं -- जिसका अर्थ है कि हमारे सभी कोड परीक्षणों द्वारा कवर किए गए हैं।
हमारे पास टाइपहेड एपीआई के लिए अच्छे परीक्षण लिखे गए हैं: https://github.com/publiclab/plots2/blob/master/test/functional/typeahead_api_test.rb

यह प्रत्येक विधि का परीक्षण करता है: https://github.com/publiclab/plots2/blob/master/app/api/srch/typeahead.rb

लेकिन हमारे पास प्रत्येक विधि के लिए खोज API के लिए समान होना चाहिए: https://github.com/publiclab/plots2/blob/master/app/api/srch/search.rb

(ध्यान दें कि ये इस फ़ाइल पर बहुत अधिक आकर्षित करते हैं, बदले में - यदि आप जानना चाहते हैं कि वे कैसे उत्पन्न होते हैं: https://github.com/publiclab/plots2/blob/master/app/services/search_service.rb)

समाधान

#1409 में, पहली बार योगदान करने वाले ने हाल ही में एक नई परीक्षण फ़ाइल बनाई, और एक एकल परीक्षण, जिसे आप test/functional/search_api_test.rb पर पा सकते हैं:

परीक्षण 'खोज नोट्स कार्यक्षमता' do
प्राप्त करें '/ api/src/नोट्स? srchString=ब्लॉग'
last_response.ok पर जोर दें?
#इसके बाद और सामान
यह एक बुनियादी परीक्षण है कि प्रतिक्रिया "ठीक" है और फिर यह परीक्षण करता है कि प्रतिक्रिया में क्या है। देखें कि यह इस लाइन पर नोट्स विधि तक पहुंचने के लिए यूआरएल का उपयोग कैसे करता है:

तो, इसे कॉपी करें, और एक अलग विधि के लिए एक नया परीक्षण बनाने के लिए search.rb में दिए गए यूआरएल उदाहरणों का पालन करें। उदाहरण के लिए, प्रोफाइल: https://github.com/publiclab/plots2/blob/master/app/api/srch/search.rb#L30

केवल last_response.ok कहकर प्रारंभ करें? ऊपरोक्त अनुसार; हम बाद में और अधिक वास्तविक परीक्षण जोड़ सकते हैं।

आप इसे रेक टेस्ट के साथ चलाने का प्रयास कर सकते हैं या (केवल कार्यात्मक परीक्षण चलाने के लिए) रेक टेस्ट टेस्ट = टेस्ट/फंक्शनल/search_api_test.rb - उम्मीद है कि यह पास हो जाएगा!

लेकिन आप केवल एक पुल अनुरोध खोल सकते हैं (नीचे देखें) और हमारी स्वचालित परीक्षण प्रणाली इसे चलाएगी, और आप वहां आउटपुट देख पाएंगे।

यदि आप इसमें मदद कर सकते हैं, तो कृपया इस परीक्षण के साथ एक पुल अनुरोध खोलें, और देखते हैं कि यह कैसे जाता है -- भले ही यह पास न हो, हम अगले चरणों में आपकी सहायता कर सकते हैं।

ठीक करने के लिए कदम

इस मुद्दे पर यहां, नीचे एक टिप्पणी के साथ दावा करें, और कोई भी स्पष्ट प्रश्न पूछें जो आपको चाहिए
README निर्देशों का पालन करते हुए स्थानीय रूप से एक रिपॉजिटरी स्थापित करें, और सुनिश्चित करें कि सभी परीक्षण पास हो गए हैं
ऊपर दिए गए चरणों का पालन करके समस्या को ठीक करने का प्रयास करें, लेकिन काम पूरा होने से पहले ही, आप यह कर सकते हैं:
अपने परिवर्तन करें और एक पुल अनुरोध शुरू करें (सार्वजनिक लैब सॉफ़्टवेयर में योगदान देखें) लेकिन यदि आपके कोई प्रश्न हैं या यदि आपने समाप्त नहीं किया है तो इसे "प्रगति में" के रूप में चिह्नित करें
अपने पुल अनुरोध को मर्ज करने के लिए डेवलपर सूची (नीचे देखें) के माध्यम से किसी को सचेत करें। आप इसे कब करते हैं, इसके आधार पर इसमें कुछ अतिरिक्त कदम हो सकते हैं, लेकिन हम आपकी मदद करेंगे!
कृपया डेवलपर सूची ईमेल करें (देखें https://publiclab.org/wiki/developers) या यदि आपके कोई प्रश्न हैं तो चैट रूम में जाएं, और अधिक जानकारी के लिए हमारे फर्स्ट-टाइमर लैंडिंग पृष्ठ पर एक नज़र डालें!