पुलुमी के साथ कोड के रूप में अपने बुनियादी ढांचे का परीक्षण। भाग 1

शुभ दोपहर, दोस्तों। "DevOps Practices and Tools" पाठ्यक्रम पर एक नई स्ट्रीम की शुरुआत की प्रत्याशा में हम आपके साथ एक नया अनुवाद साझा कर रहे हैं । चलो चलते हैं।



इंफ्रास्ट्रक्चर के लिए कोड के रूप में पुलुमी और सामान्य-प्रयोजन प्रोग्रामिंग भाषाओं का उपयोग करना कई फायदे प्रदान करता है: कौशल और ज्ञान होना, अमूर्त के माध्यम से कोड में बॉयलरप्लेट को समाप्त करना, आपकी टीम से परिचित उपकरण, जैसे आईडीई और लिंटर। ये सभी सॉफ्टवेयर इंजीनियरिंग उपकरण न केवल हमें अधिक उत्पादक बनाते हैं, बल्कि कोड की गुणवत्ता में भी सुधार करते हैं। इसलिए, यह स्वाभाविक है कि सामान्य-प्रयोजन प्रोग्रामिंग भाषाओं का उपयोग आपको सॉफ़्टवेयर विकास - परीक्षण में एक और महत्वपूर्ण अभ्यास शुरू करने की अनुमति देता है।

इस लेख में, हम देखेंगे कि कैसे पुलुमी हमारे "बुनियादी ढांचे को कोड के रूप में परखने में मदद करती है।"

बुनियादी ढांचे का परीक्षण क्यों?

विवरण में जाने से पहले, यह सवाल पूछने के लायक है: "हमें बुनियादी ढांचे का परीक्षण करने की आवश्यकता क्यों है?" इसके कई कारण हैं, और उनमें से कुछ हैं:

• यूनिट अपने कार्यक्रम में व्यक्तिगत कार्यों या तर्क के टुकड़ों का परीक्षण करती है
• कुछ प्रतिबंधों के अनुपालन के लिए बुनियादी ढांचे की वांछित स्थिति की जाँच करें।
• सामान्य त्रुटियों का पता लगाना, जैसे भंडारण बाल्टी एन्क्रिप्शन की कमी या असुरक्षित, इंटरनेट से आभासी मशीनों तक खुली पहुंच।
• बुनियादी ढांचे के प्रावधान का सत्यापन।
• प्रोविजनिंग के बाद स्वास्थ्य की जांच करने के लिए आपके "प्रोग्राम्ड" इंफ्रास्ट्रक्चर के अंदर चल रहे एप्लिकेशन के तर्क का रनटाइम परीक्षण करना।
• जैसा कि हम देख सकते हैं, बुनियादी ढांचे के परीक्षण विकल्पों की एक विस्तृत श्रृंखला है। इस स्पेक्ट्रम में हर बिंदु पर परीक्षण के लिए पोलोमी के पास तंत्र हैं। आइए शुरू करें और देखें कि यह कैसे काम करता है।

इकाई परीक्षण

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

(इस लेख में, बहुभाषी और बहु-बादल होने के बावजूद, हम जावास्क्रिप्ट और मोचा का उपयोग करते हैं और AWS पर ध्यान केंद्रित करते हैं। आप Python unittest , Go परीक्षण ढाँचे या आपके द्वारा पसंद किए जाने वाले किसी भी अन्य परीक्षण ढाँचे का उपयोग कर सकते हैं। Kubernetes।)

जैसा कि हमने देखा है, ऐसे कई कारण हैं जिनकी वजह से आपको अपने इन्फ्रास्ट्रक्चर कोड का परीक्षण करना पड़ सकता है। उनमें से एक सामान्य इकाई परीक्षण है। चूंकि आपके कोड में फ़ंक्शन हो सकते हैं - उदाहरण के लिए, CIDR की गणना करने के लिए, गतिशील रूप से नाम, टैग आदि की गणना करें। - आप शायद उनका परीक्षण करना चाहते हैं। यह आपकी पसंदीदा प्रोग्रामिंग भाषा में अनुप्रयोगों के लिए नियमित इकाई परीक्षण लिखने के समान है।
यदि आप चीजों को थोड़ा जटिल करते हैं, तो आप जांच सकते हैं कि आपका प्रोग्राम संसाधनों को कैसे आवंटित करता है। उदाहरण के लिए, आइए कल्पना करें कि हमें एक सरल EC2 सर्वर बनाने की आवश्यकता है और हम निम्नलिखित के बारे में सुनिश्चित होना चाहते हैं:

• उदाहरणों में एक Name टैग है।
• उदाहरणों को उपयोगकर्ता डेटा इनलाइन स्क्रिप्ट का उपयोग नहीं करना चाहिए - हमें एएमआई (छवि) का उपयोग करना चाहिए।
• इंटरनेट पर एसएसएच खुला नहीं होना चाहिए।

यह उदाहरण मेरे aws-js-webserver उदाहरण के आधार पर लिखा गया है:

index.js:

 "use strict"; let aws = require("@pulumi/aws"); let group = new aws.ec2.SecurityGroup("web-secgrp", { ingress: [ { protocol: "tcp", fromPort: 22, toPort: 22, cidrBlocks: ["0.0.0.0/0"] }, { protocol: "tcp", fromPort: 80, toPort: 80, cidrBlocks: ["0.0.0.0/0"] }, ], }); let userData = `#!/bin/bash echo "Hello, World!" > index.html nohup python -m SimpleHTTPServer 80 &`; let server = new aws.ec2.Instance("web-server-www", { instanceType: "t2.micro", securityGroups: [ group.name ], // reference the group object above ami: "ami-c55673a0" // AMI for us-east-2 (Ohio), userData: userData // start a simple web server }); exports.group = group; exports.server = server; exports.publicIp = server.publicIp; exports.publicHostName = server.publicDns; 

यह मूल पुलुमी कार्यक्रम है: यह केवल EC2 सुरक्षा समूह और उदाहरण को आवंटित करता है। हालांकि, यह ध्यान दिया जाना चाहिए कि यहां हम उपरोक्त तीनों नियमों का उल्लंघन करते हैं। टेस्ट लिखते हैं!

लेखन परीक्षण

हमारे परीक्षणों की सामान्य संरचना नियमित मोचा परीक्षणों की तरह दिखाई देगी:

ec2tests.js

 test.js: let assert = require("assert"); let mocha = require("mocha"); let pulumi = require("@pulumi/pulumi"); let infra = require("./index"); describe("Infrastructure", function() { let server = infra.server; describe("#server", function() { // TODO(check 1):    Name. // TODO(check 2):    inline- userData. }); let group = infra.group; describe("#group", function() { // TODO(check 3):    SSH,   . }); }); 

अब हम अपना पहला परीक्षण लिखते हैं: सुनिश्चित करें कि उदाहरणों में एक Name टैग है। इसे सत्यापित करने के लिए, हमें बस EC2 इंस्टेंस ऑब्जेक्ट मिलता है और संबंधित tags प्रॉपर्टी की जाँच करें:

  // check 1:    Name. it("must have a name tag", function(done) { pulumi.all([server.urn, server.tags]).apply(([urn, tags]) => { if (!tags || !tags["Name"]) { done(new Error(`Missing a name tag on server ${urn}`)); } else { done(); } }); }); 

यह एक नियमित परीक्षण जैसा दिखता है, लेकिन ध्यान देने योग्य कुछ विशेषताओं के साथ:

• चूंकि हम तैनाती से पहले संसाधन की स्थिति का अनुरोध करते हैं, इसलिए हमारे परीक्षणों को हमेशा "योजना" (या "पूर्वावलोकन") मोड में निष्पादित किया जाता है। इस प्रकार, ऐसे कई गुण हैं जिनके मान बस प्राप्त नहीं होंगे या निर्धारित नहीं होंगे। इसमें सभी आउटपुट गुण शामिल हैं। आपके क्लाउड प्रदाता। हमारे परीक्षणों के लिए, यह सामान्य है - हम केवल इनपुट डेटा की जांच करते हैं। हम बाद में इस मुद्दे पर वापस आएंगे जब यह एकीकरण परीक्षणों की बात आती है।
• चूंकि पुलुमी संसाधनों के सभी गुण "आउटपुट" हैं, और उनमें से कई की गणना अतुल्यकालिक रूप से की जाती है, हमें मूल्यों तक पहुंचने के लिए आवेदन पद्धति का उपयोग करने की आवश्यकता है। यह वादों और then समान है।
• चूंकि हम त्रुटि संदेश में संसाधन URN दिखाने के लिए कई गुणों का उपयोग करते हैं, इसलिए हमें उन्हें संयोजित करने के लिए pulumi.all फ़ंक्शन का उपयोग करने की आवश्यकता है।
• अंत में, चूंकि इन मूल्यों की गणना अतुल्यकालिक रूप से की जाती है, हमें मोचा की अंतर्निहित एसिंक्रोनस सुविधा का उपयोग कॉलबैक या वादा रिटर्न के साथ करने की आवश्यकता है।

जब हम सब कुछ कॉन्फ़िगर करते हैं, तो हमारे पास इनपुट डेटा तक सरल जावास्क्रिप्ट मूल्यों के रूप में पहुंच होगी। tags संपत्ति एक नक्शा (साहचर्य सरणी) है, इसलिए हम केवल यह सुनिश्चित करेंगे कि यह (1) गलत नहीं है, और (2) Name लिए एक कुंजी है। यह बहुत सरल है और अब हम कुछ भी जांच सकते हैं!

अब हम अपना दूसरा चेक लिखते हैं। यह और भी सरल है:

  // check 2:    inline- userData. it("must not use userData (use an AMI instead)", function(done) { pulumi.all([server.urn, server.userData]).apply(([urn, userData]) => { if (userData) { done(new Error(`Illegal use of userData on server ${urn}`)); } else { done(); } }); }); 

और अंत में, हम तीसरा परीक्षण लिखेंगे। यह थोड़ा और अधिक जटिल होगा क्योंकि हम एक सुरक्षा समूह से जुड़े लॉगिन नियमों की तलाश कर रहे हैं, जो कई हो सकते हैं, और इन नियमों में सीआईडीआर रेंज शामिल हैं, जो कई भी हो सकते हैं। लेकिन हम कामयाब रहे:

  // check 3:    SSH,   . it("must not open port 22 (SSH) to the Internet", function(done) { pulumi.all([ group.urn, group.ingress ]).apply(([ urn, ingress ]) => { if (ingress.find(rule => rule.fromPort == 22 && rule.cidrBlocks.find(block => block === "0.0.0.0/0"))) { done(new Error(`Illegal SSH port 22 open to the Internet (CIDR 0.0.0.0/0) on group ${urn}`)); } else { done(); } }); }); 

वह सब है। अब चलो परीक्षण चलाते हैं!

परीक्षण चल रहा है

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

इस समस्या को हल करने के लिए, हमें केवल निम्नलिखित निर्दिष्ट करने की आवश्यकता है:

• प्रोजेक्ट का नाम, जो पर्यावरण चर PULUMI_NODEJS_PROJECT (या, आमतौर पर, PULUMI__PROJECT ).
  पर्यावरण चर PULUMI_NODEJS_STACK (या, आमतौर पर, PULUMI__ STACK). में निर्दिष्ट स्टैक का नाम PULUMI__ STACK).
  आपका स्टैक कॉन्फ़िगरेशन चर। उन्हें PULUMI_CONFIG पर्यावरण PULUMI_CONFIG का उपयोग करके प्राप्त किया जा सकता है और उनका प्रारूप कुंजी / मान जोड़े के साथ JSON मैप है।
  
  कार्यक्रम चेतावनी जारी करते हुए संकेत देगा कि रन टाइम में सीएलआई / इंजन के लिए एक कनेक्शन उपलब्ध नहीं है। यह महत्वपूर्ण है, क्योंकि वास्तव में, आपका कार्यक्रम कुछ भी तैनात नहीं करेगा और यह एक आश्चर्य के रूप में आ सकता है यदि यह वह नहीं है जो आप करना चाहते थे! पुलुमी को यह बताने के लिए कि आपको वास्तव में क्या चाहिए, आप PULUMI_TEST_MODE को true सेट कर सकते हैं।
  
  कल्पना करें कि my-ws में प्रोजेक्ट का नाम, dev स्टैक का नाम और AWS us-west-2 निर्दिष्ट करने की आवश्यकता us-west-2 । मोचा परीक्षण चलाने के लिए कमांड लाइन इस तरह दिखाई देगी:
  
  

   $ PULUMI_TEST_MODE=true \ PULUMI_NODEJS_STACK="my-ws" \ PULUMI_NODEJS_PROJECT="dev" \ PULUMI_CONFIG='{ "aws:region": "us-west-2" }' \ mocha tests.js 

  
  ऐसा करना, जैसा कि अपेक्षित था, हमें दिखाएगा कि हमारे पास तीन गिरे हुए परीक्षण हैं!
  
  

   Infrastructure #server 1) must have a name tag 2) must not use userData (use an AMI instead) #group 3) must not open port 22 (SSH) to the Internet 0 passing (17ms) 3 failing 1) Infrastructure #server must have a name tag: Error: Missing a name tag on server urn:pulumi:my-ws::my-dev::aws:ec2/instance:Instance::web-server-www 2) Infrastructure #server must not use userData (use an AMI instead): Error: Illegal use of userData on server urn:pulumi:my-ws::my-dev::aws:ec2/instance:Instance::web-server-www 3) Infrastructure #group must not open port 22 (SSH) to the Internet: Error: Illegal SSH port 22 open to the Internet (CIDR 0.0.0.0/0) on group 

  
  चलो हमारे कार्यक्रम को ठीक करें:
  
  

   "use strict"; let aws = require("@pulumi/aws"); let group = new aws.ec2.SecurityGroup("web-secgrp", { ingress: [ { protocol: "tcp", fromPort: 80, toPort: 80, cidrBlocks: ["0.0.0.0/0"] }, ], }); let server = new aws.ec2.Instance("web-server-www", { tags: { "Name": "web-server-www" }, instanceType: "t2.micro", securityGroups: [ group.name ], // reference the group object above ami: "ami-c55673a0" // AMI for us-east-2 (Ohio), }); exports.group = group; exports.server = server; exports.publicIp = server.publicIp; exports.publicHostName = server.publicDns; 

  
  और फिर परीक्षण फिर से चलाएं:
  
  

   Infrastructure #server ✓ must have a name tag ✓ must not use userData (use an AMI instead) #group ✓ must not open port 22 (SSH) to the Internet 3 passing (16ms) 

  
  सब कुछ ठीक हो गया ... हुर्रे! ✓ ✓ ✓
  
  आज के लिए बस इतना ही, लेकिन हम अनुवाद के दूसरे भाग में परीक्षण परिनियोजन के बारे में बात करेंगे ;-)