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

अच्छा दोपहर दोस्तों। दर पर एक नए प्रवाह की शुरुआत की प्रत्याशा में "DevOps अभ्यास और उपकरण" हम आपके साथ एक नया अनुवाद साझा कर रहे हैं. जाना।

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

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

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

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

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

इकाई का परीक्षण

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

(इस लेख में, बहुभाषी और मल्टीक्लाउड होने के बावजूद, हम जावास्क्रिप्ट और मोचा का उपयोग करते हैं और एडब्ल्यूएस पर ध्यान केंद्रित करते हैं। आप पायथन का उपयोग कर सकते हैं unittest, परीक्षण ढाँचा, या कोई अन्य परीक्षण ढाँचा जो आपको पसंद हो, पर जाएँ। और, निःसंदेह, पुलुमी Azure, Google Cloud, Kubernetes के साथ बढ़िया काम करता है।)

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

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

यह उदाहरण पर आधारित है मेरा उदाहरण aws-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 .
• चूँकि हम त्रुटि संदेश में संसाधन यूआरएन दिखाने के लिए कई गुणों का उपयोग कर रहे हैं, हमें फ़ंक्शन का उपयोग करने की आवश्यकता है pulumi.allउन्हें संयोजित करने के लिए.
• अंत में, चूंकि इन मानों की गणना अतुल्यकालिक रूप से की जाती है, इसलिए हमें मोचा की अंतर्निहित एसिंक कॉलबैक सुविधा का उपयोग करने की आवश्यकता है done या कोई वादा वापस कर रहा हूँ.

एक बार जब हम सब कुछ सेट कर लेंगे, तो हमारे पास सरल जावास्क्रिप्ट मानों के रूप में इनपुट तक पहुंच होगी। संपत्ति 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_CONFIG और उनका प्रारूप कुंजी/मूल्य जोड़े के साथ JSON मानचित्र है।

  प्रोग्राम यह संकेत देते हुए चेतावनी जारी करेगा कि निष्पादन के दौरान सीएलआई/इंजन से कनेक्शन उपलब्ध नहीं है। यह महत्वपूर्ण है क्योंकि आपका प्रोग्राम वास्तव में कुछ भी तैनात नहीं करेगा और यदि आप ऐसा करने का इरादा नहीं रखते हैं तो यह आश्चर्य की बात हो सकती है! पुलुमी को यह बताने के लिए कि यह वही है जो आपको चाहिए, आप इंस्टॉल कर सकते हैं PULUMI_TEST_MODE в true.

  कल्पना कीजिए कि हमें प्रोजेक्ट का नाम निर्दिष्ट करने की आवश्यकता है my-ws, स्टैक नाम dev, और AWS क्षेत्र 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)

  सब कुछ ठीक रहा...हुर्रे! ✓✓✓

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

स्रोत: www.habr.com