मुख्य कंटेंट तक स्किप करें

परिदृश्य परीक्षण और रिपोर्ट

एक अनुरोध एक कॉल जाँचता है। परिदृश्य परीक्षण पूरे कार्यप्रवाह को जाँचता है: अनुरोधों का ऐसा क्रम जिसमें एक प्रतिक्रिया का मान बाद के अनुरोध में जाता है और हर चरण पर असर्शन जाँचे जाते हैं। परिदृश्य उन शुरू-से-अंत तक के प्रवाहों को दर्ज करते हैं जो अन्यथा केवल डेवलपर के मन में रहते।

परिदृश्य में क्या होता है​

  • क्रमबद्ध चरण, जिनमें हर चरण स्पेसिफ़िकेशन के किसी ऑपरेशन का संदर्भ देता है;
  • चरणों के बीच डेटा भेजना, जैसे बनाए गए संसाधन का id लेकर अगले अनुरोध में इस्तेमाल करना;
  • स्टेटस कोड, हेडर या प्रतिक्रिया फ़ील्ड पर असर्शन;
  • वे मान जो उपयोगकर्ता को चलाने से पहले देने होंगे।

क्रम और असर्शन मुख्य घटक हैं; निष्पादन के दौरान उन्हें चुपचाप हटाया नहीं जाता।

परिदृश्य चलाना​

परिदृश्य मुख्य प्रोसेस में @powerduck/openapi-cli के runScenario इंजन से चलते हैं:

  • scenario:run, परिदृश्य, स्पेसिफ़िकेशन और अनुरोध कॉन्फ़िगरेशन के साथ रन शुरू करता है;
  • चरण चलते समय scenario:event से प्रगति भेजी जाती है;
  • scenario:cancel चल रहा काम रोकता है।

आप हर चरण देख सकते हैं, प्रवाह में विफलता की जगह पहचान सकते हैं और लंबे रन रद्द कर सकते हैं।

सहायक परिदृश्य कैसे बनाता है​

सहायक स्पेसिफ़िकेशन के अंदर मनगढ़ंत टेस्ट परिभाषाएँ नहीं जोड़ता। परिदृश्य ऐप का अलग कार्यप्रवाह हैं और कभी OpenAPI दस्तावेज़ में सहेजे नहीं जाते; न x-scenarios कुंजी होती है, न एम्बेड किए गए चरण।

जब आप एंडपॉइंट डिज़ाइन करने और उनका परीक्षण करने को कहते हैं, तो काम इस क्रम में होता है:

  1. पहले सहायक केवल एंडपॉइंट पैच प्रस्तावित करता है;
  2. उन्हें लागू करने के बाद, प्रवाह चलाने के लिए एक्शन कार्ड देता है:
    • एक एंडपॉइंट के लिए test.single;
    • ऐप द्वारा शुरू-से-अंत तक के प्रवाह खोजने के लिए scenario.plan;
    • क्रमबद्ध प्रवाह तैयार करने और चलाने के लिए scenario.run।

scenario.run कार्ड में दो से आठ ऑपरेशन निष्पादन क्रम में होते हैं। लक्ष्य में यह भी बताया जाता है कि कौन-सा प्रतिक्रिया फ़ील्ड, हेडर या स्टेटस अगले अनुरोध को डेटा देगा। हर संदर्भ वर्तमान स्पेसिफ़िकेशन से हूबहू लिया जाता है।

रिपोर्ट​

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

निर्यात करते समय भाषा चुनें। दस भाषाएँ पहले से उपलब्ध हैं:

  1. English (अंग्रेज़ी)
  2. 简体中文 (सरलीकृत चीनी)
  3. 繁體中文 (पारंपरिक चीनी)
  4. 日本語 (जापानी)
  5. 한국어 (कोरियाई)
  6. Français (फ़्रेंच)
  7. Deutsch (जर्मन)
  8. Español (स्पेनिश)
  9. Português — Brasil (ब्राज़ीलियाई पुर्तगाली)
  10. العربية (अरबी)

अन्य/कस्टम विकल्प में दूसरी भाषा लिख सकते हैं, लेकिन अनुवाद उपलब्ध न होने पर रिपोर्ट के अंतर्निहित लेबल अंग्रेज़ी में रहते हैं। भाषा लिखने से रिपोर्ट का अपने-आप अनुवाद नहीं होता।

साझा करने से पहले निर्यात की गई रिपोर्ट जाँचें:

  • पहचाने गए क्रेडेंशियल फ़ील्ड अपने-आप छिपाए जाते हैं। मनमाने पेलोड, URL और कस्टम फ़ील्ड में फिर भी संवेदनशील डेटा हो सकता है; साझा करने से पहले उसे जाँचकर हटाएँ;
  • बड़े पेलोड संक्षिप्त खंडों में दिखाए जाते हैं, ताकि पढ़ना आसान हो। किसी खंड को बंद करने से उसका डेटा निर्यात किए गए HTML से नहीं हटता।

HTML फ़ाइल स्वतंत्र है, इसलिए उसे टिकट के साथ संलग्न कर सकते हैं या रिलीज़ के साथ सुरक्षित रख सकते हैं।

परिदृश्य कब इस्तेमाल करें​

  • बनाने, पढ़ने, अपडेट करने और हटाने जैसे कई चरण वाले कारोबारी प्रवाह को जाँचने के लिए;
  • कॉल के बीच प्रमाणीकरण और टोकन हस्तांतरण सही चलने की पुष्टि के लिए;
  • रिलीज़ या हस्तांतरण के लिए API व्यवहार का प्रमाण तैयार करने के लिए;
  • कॉन्ट्रैक्ट बदलने के बाद प्रवाह का रिग्रेशन परीक्षण करने के लिए।

संबंधित: अनुरोध कार्यक्षेत्र, सहायक के साथ डिज़ाइन, मॉक सर्वर।