Capybara पेज ऑब्जेक्ट्स के साथ वेबसाइट उपयोगकर्ता की कार्यक्षमता का परीक्षण करना

पृष्ठ वस्तुओं का उपयोग तकनीकी कार्यान्वयन से आपके परीक्षणों के अमूर्त (अलगाव) की एक शक्तिशाली विधि के रूप में किया जा सकता है। यह याद रखना महत्वपूर्ण है कि वे (पृष्ठ ऑब्जेक्ट) का उपयोग परीक्षणों की स्थिरता को बढ़ाने और DRY के सिद्धांत को बनाए रखने के लिए किया जा सकता है (खुद को दोहराएं नहीं) - कार्यक्षमता (वेबसाइट) को सरल तरीकों से एनकैप्सुलेट करके।

दूसरे शब्दों में

पृष्ठ ऑब्जेक्ट एक वर्ग का एक उदाहरण है जो परीक्षण वातावरण से उपयोगकर्ता इंटरफ़ेस को अलग करता है (अलग करता है), उपयोगकर्ता इंटरफ़ेस के साथ बातचीत करने के लिए तरीके प्रस्तुत करता है, और आवश्यक जानकारी निकालता है।

शब्दावली

पेज ऑब्जेक्ट शब्द बहुत सामान्य है। मेरे अनुभव में, पेज ऑब्जेक्ट में निम्न 3 प्रकार शामिल हैं:

• घटक ऑब्जेक्ट उपयोगकर्ता इंटरफ़ेस में विशिष्ट घटकों या विजेट का प्रतिनिधित्व करते हैं। उदाहरण के लिए: टेबल, मेनू, लेख और अन्य ब्लॉक जिसमें घटकों का एक समूह होता है।
• पेज ऑब्जेक्ट वेब एप्लिकेशन में एक विशिष्ट क्षेत्र या उपयोगकर्ता इंटरफ़ेस का वर्णन करता है। इसमें कई घटक ऑब्जेक्ट शामिल हो सकते हैं और इस ऑब्जेक्ट के भीतर निहित अमूर्त के साथ बातचीत के लिए सुविधाजनक तरीके शामिल हो सकते हैं।
• अनुभव का उपयोग जटिल कार्यक्षमता को समूहीकृत करने के लिए किया जाता है, जिसके परीक्षण के लिए कई चरणों या कई पृष्ठों के साथ सहभागिता की आवश्यकता होती है। अपने स्वयं के अनुभव से, मैंने इस अवधारणा को एक पृष्ठ पर जटिल व्यवहार के लिए इस्तेमाल किया (शैक्षिक पृष्ठों का परीक्षण, एक नया उपयोगकर्ता बनाना, आदि)

उदाहरण

सरल RSpec Capybara परीक्षण पर विचार करें, जो ब्लॉग बनाता है और पेज ऑब्जेक्ट का उपयोग नहीं करता है:

require 'feature_helper' feature 'Blog management', type: :feature do scenario 'Successfully creating a new blog' do visit '/' click_on 'Form Examples' expect(page).to have_content('Create Blog') fill_in 'blog_title', with: 'My Blog Title' fill_in 'blog_text', with: 'My new blog text' click_on 'Save Blog' expect(page).to have_selector('.blog--show') expect(page).to have_content('My Blog Title') expect(page).to have_content('My new blog text') end scenario 'Entering no data' do visit '/' click_on 'Form Examples' expect(page).to have_content('Create Blog') click_on 'Save Blog' expect(page).to have_content('4 errors stopped this form being submitted') expect(page).to have_content("Title can't be blank") expect(page).to have_content("Text can't be blank") expect(page).to have_content('Title is too short') expect(page).to have_content('Text is too short') end end 

आइए कोड पर करीब से नज़र डालें, इसमें कई समस्याएं हैं। निम्नलिखित क्रियाएं हैं: संबंधित पृष्ठ पर स्विच करना, पृष्ठ के साथ बातचीत करना और सामग्री की जांच करना। कोड का हिस्सा डुप्लिकेट है, लेकिन यह DRY सिद्धांत का पालन करके तय किया जा सकता है।

यह समझना महत्वपूर्ण है कि परीक्षण के तहत आवेदन में परिवर्तन होने पर इस कोड को बनाए रखना मुश्किल है। उदाहरण के लिए, तत्व वर्ग, नाम और पहचानकर्ता बदल सकते हैं, जिन्हें परीक्षण कोड के नियमित अपडेट की आवश्यकता होती है।

इस कोड में भी कोई 'सिमेंटिक संदर्भ' नहीं है, यह समझना मुश्किल है कि कोड की कौन सी लाइनें तार्किक रूप से समूहबद्ध हैं।

पेज ऑब्जेक्ट का परिचय

जैसा कि शब्दावली अनुभाग में चर्चा की गई है, प्रस्तुति-स्तर के सार का प्रतिनिधित्व करने के लिए पृष्ठ ऑब्जेक्ट का उपयोग किया जा सकता है।

पिछले उदाहरण को लेते हुए और नए ब्लॉग बनाने और ब्लॉग देखने के लिए पेज ऑब्जेक्ट का उपयोग करके, हम पिछले उदाहरण के कोड को साफ़ कर सकते हैं।

तकनीकी कार्यान्वयन के बारे में विशिष्ट जानकारी से छुटकारा पाने के बाद, अंतिम परिणाम (कोड) पढ़ने योग्य होना चाहिए और इसमें उपयोगकर्ता इंटरफ़ेस (आईडी, सीएसएस कक्षाएं, आदि) के बारे में विशिष्ट जानकारी नहीं होनी चाहिए।

 require 'feature_helper' require_relative '../pages/new_blog' require_relative '../pages/view_blog' feature 'Blog management', type: :feature do let(:new_blog_page) { ::Pages::NewBlog.new } let(:view_blog_page) { ::Pages::ViewBlog.new } before :each do new_blog_page.visit_location end scenario 'Successfully creating a new blog' do new_blog_page.create title: 'My Blog Title', text: 'My new blog text' expect(view_blog_page).to have_loaded expect(view_blog_page).to have_blog title: 'My Blog Title', text: 'My new blog text' end scenario 'Entering no data' do new_blog_page.create title: '', text: '' expect(view_blog_page).to_not have_loaded expect(new_blog_page).to have_errors "Title can't be blank", "Text can't be blank", "Title is too short", "Text is too short" end end 

पेज ऑब्जेक्ट बनाना

पेज ऑब्जेक्ट बनाने में पहला कदम एक मूल पेज क्लास संरचना बनाना है:

 module Pages class NewBlog include RSpec::Matchers include Capybara::DSL # ... end end 

कनेक्ट करना (सक्षम करना) Capybara :: पृष्ठ ऑब्जेक्ट्स को Capybara में उपलब्ध विधियों का उपयोग करने की अनुमति देने के लिए DSL

 has_css? '.foo' has_content? 'hello world' find('.foo').click 

इसके अलावा, मैंने इस्तेमाल किया

RSpec :: माचिस शामिल करें

उपरोक्त उदाहरणों में उम्मीद RSpec पुस्तकालय का उपयोग करने के लिए।

समझौते का उल्लंघन न करें, पृष्ठ ऑब्जेक्ट में अपेक्षा (अपेक्षाएं) शामिल नहीं होनी चाहिए। हालाँकि, जहाँ उपयुक्त हो, मैं परिस्थितियों को संभालने के लिए कैपिबारा के अंतर्निहित तंत्र पर भरोसा करने के लिए इस दृष्टिकोण को प्राथमिकता देता हूं।

उदाहरण के लिए, निम्नलिखित Capybara कोड पेज ऑब्जेक्ट्स के अंदर 'foo' की उपस्थिति की उम्मीद करेगा (इस मामले में, स्वयं ):

 expect(self).to have_content 'foo' 

हालाँकि, निम्नलिखित कोड में:

 expect(page_object.content).to match 'foo' 

अनपेक्षित त्रुटियां संभव हैं (एक फ्लोटिंग टेस्ट हो सकता है), चूंकि पेज_बजेक्ट। कॉन्टेंट को स्थिति के अनुपालन के लिए तुरंत जांच की जाती है, और अभी तक घोषित नहीं किया जा सकता है। अधिक उदाहरणों के लिए, मैं विचारशील के लेखन को Capybara के साथ विश्वसनीय अतुल्यकालिक एकीकरण परीक्षण पढ़ने की सलाह दूंगा ।

विधि निर्माण

हम उस स्थान (क्षेत्र) का सार (वर्णन) कर सकते हैं जहाँ से हम एक विधि के ढांचे के भीतर डेटा प्राप्त करना चाहते हैं:

 def visit_location visit '/blogs/new' # It can be beneficial to assert something positive about the page # before progressing with your tests at this point # # This can be useful to ensures that the page has loaded successfully, and any # asynchronous JavaScript has been loaded and retrieved etc. # # This is required to avoid potential race conditions. expect(self).to have_loaded end def has_loaded? self.has_selector? 'h1', text: 'Create Blog' end 

आपके पेज ऑब्जेक्ट्स के लिए विधियों के लिए शब्द का सही नाम चुनना महत्वपूर्ण है

 def create(title:, text:) # ... end def has_errors?(*errors) # ... end def has_error?(error) # ... end 

सामान्य तौर पर, कार्यात्मक रूप से एकीकृत तरीकों के सिद्धांत का पालन करना महत्वपूर्ण है और जहां संभव हो, एकल जिम्मेदारी (एकल जिम्मेदारी सिद्धांत) के सिद्धांत का पालन करें।

घटक वस्तुओं

हमारे उदाहरण में, हम NewBlog वर्ग का उपयोग करते हैं, लेकिन बनाने के लिए कोई कार्यान्वयन नहीं है।

चूंकि हम फॉर्म के साथ बातचीत करते हैं, इसलिए हम इस घटक का प्रतिनिधित्व करने के लिए एक वर्ग जोड़ सकते हैं:

 # ... def create(title:, text:) blog_form.new.create title: title, text: text end # ... private def blog_form ::Components::BlogForm end 

जहां BlogForm के लिए तरीके लागू किए जा सकते हैं:

 module Components class BlogForm include RSpec::Matchers include Capybara::DSL def create(title:, text:) within blog_form do fill_in 'blog_title', with: title fill_in 'blog_text', with: text click_on 'Save Blog' end end private def blog_form find('.blog--new') end end end 

सब एक साथ

उपरोक्त वर्गों का उपयोग करके, आप अब ऑब्जेक्ट विवरण के भाग के रूप में अपने पृष्ठ की पृष्ठ वस्तुओं को क्वेरी और इंस्टेंट कर सकते हैं।

 require 'feature_helper' require_relative '../pages/new_blog' require_relative '../pages/view_blog' feature 'Blog management', type: :feature do let(:new_blog_page) { ::Pages::NewBlog.new } let(:view_blog_page) { ::Pages::ViewBlog.new } # ... end 

नोट: मैंने जानबूझकर ऑब्जेक्ट फ़ाइल के शीर्ष पर मैन्युअल रूप से एक पृष्ठ ऑब्जेक्ट बनाया है। कुछ RSpec परीक्षणों में, सभी समर्थन फ़ाइलों को स्वचालित रूप से डाउनलोड करने और ऑब्जेक्ट फ़ाइलों में उन तक पहुंच प्रदान करने के लिए सुविधाजनक हो सकता है, हालांकि, कोड के बड़े टुकड़ों का उपयोग करते समय यह अत्यधिक कार्यभार हो सकता है। विशेष रूप से, यह धीमी गति से स्टार्टअप और संभावित अनपेक्षित चक्रीय निर्भरता को जन्म देगा।

पेज ऑब्जेक्ट्स को कॉल करें

अब प्रत्येक परिदृश्य में, हमारे पास new_blog_page और view_blog_page के उदाहरणों तक पहुंच होगी:

 scenario 'Successfully creating a new blog' do new_blog_page.create title: 'My Blog Title', text: 'My new blog text' expect(view_blog_page).to have_loaded expect(view_blog_page).to have_blog title: 'My Blog Title', text: 'My new blog text' end 

नामकरण सम्मेलनों / विधेय विधियों

रेल / रूबी में अधिकांश चीजों के साथ, ऐसे सम्मेलन हैं जो एक नज़र में पूरी तरह से महत्वहीन (बाध्यकारी नहीं) हो सकते हैं।

हमारे परीक्षणों में, हमने has_loaded और has_blog का उपयोग करते हुए पृष्ठ ऑब्जेक्ट के साथ बातचीत की:

 expect(view_blog_page).to have_loaded expect(view_blog_page).to have_blog title: 'My Blog Title', text: 'My new blog text' 

हालाँकि, हमारे पेज ऑब्जेक्ट का विधि नाम वास्तव में has_loaded है? और has_blog है? :

 def has_loaded? # ... end def has_blog?(title:, text:) # ... end 

यह एक सूक्ष्म अंतर है जिस पर ध्यान देने की आवश्यकता है। इस अधिवेशन की अधिक जानकारी के लिए, मैं निम्नलिखित विधेय लिंक को पढ़ने की सलाह दूंगा ।

Git, उदाहरणों में प्रयुक्त स्रोत कोड
मूल