Pulumi संग कोड रूपमा पूर्वाधार परीक्षण। भाग 1

शुभ दिउँसो साथीहरू। दरमा नयाँ प्रवाहको सुरुवातको प्रत्याशामा "DevOps अभ्यास र उपकरणहरू" हामी तपाईसँग नयाँ अनुवाद साझा गर्दैछौं। जानुहोस्।

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

यस लेखमा, हामी कसरी Pulumi ले हाम्रो पूर्वाधार-कोड-कोड परीक्षण गर्न मद्दत गर्छ भनेर हेर्नेछौं।

किन पूर्वाधार परीक्षण?

विस्तारमा जानु अघि, यो प्रश्न सोध्न लायक छ: "किन पूर्वाधार परीक्षण सबैमा?" यसका धेरै कारणहरू छन् र तिनीहरूमध्ये केही यहाँ छन्:

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

एकाइ परीक्षण

Pulumi प्रोग्रामहरू JavaScript, Python, TypeScript वा Go जस्ता सामान्य-उद्देश्यीय प्रोग्रामिङ भाषाहरूमा लेखिन्छन्। तसर्थ, यी भाषाहरूको पूर्ण शक्ति, तिनीहरूका उपकरणहरू र पुस्तकालयहरू, परीक्षण ढाँचाहरू सहित, तिनीहरूका लागि उपलब्ध छ। Pulumi बहु-क्लाउड हो, जसको मतलब यो कुनै पनि क्लाउड प्रदायकबाट परीक्षणको लागि प्रयोग गर्न सकिन्छ।

(यस लेखमा, बहुभाषी र बहुक्लाउड भएता पनि, हामी JavaScript र Mocha प्रयोग गर्छौं र AWS मा फोकस गर्छौं। तपाईं पाइथन प्रयोग गर्न सक्नुहुन्छ। unittest, जानुहोस् परीक्षण फ्रेमवर्क, वा तपाइँलाई मनपर्ने कुनै अन्य परीक्षण फ्रेमवर्क। र, निस्सन्देह, Pulumi Azure, Google Cloud, Kubernetes सँग राम्रो काम गर्दछ।)

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

• उदाहरणहरूमा ट्याग छ Name.
• उदाहरणहरूले इनलाइन लिपि प्रयोग गर्नु हुँदैन userData - हामीले AMI (छवि) प्रयोग गर्नुपर्छ।
• त्यहाँ कुनै SSH इन्टरनेटमा उजागर हुनु हुँदैन।

यो उदाहरण मा आधारित छ मेरो उदाहरण 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;

यो आधारभूत Pulumi कार्यक्रम हो: यो केवल एक 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();
                }
            });
        });

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

• हामीले डिप्लोइमेन्ट गर्नु अघि स्रोतको अवस्था सोध्ने हुनाले, हाम्रा परीक्षणहरू सधैं "योजना" (वा "पूर्वावलोकन") मोडमा चलाइन्छ। यसैले, त्यहाँ धेरै गुणहरू छन् जसको मानहरू मात्र पुन: प्राप्त हुनेछैन वा परिभाषित गरिने छैनन्। यसमा तपाईंको क्लाउड प्रदायक द्वारा गणना गरिएका सबै आउटपुट गुणहरू समावेश छन्। यो हाम्रो परीक्षणहरूको लागि सामान्य हो - हामी इनपुट डेटा मात्र जाँच गर्छौं। हामी यस मुद्दामा पछि फर्कनेछौं, जब यो एकीकरण परीक्षणको कुरा आउँछ।
• किनकि सबै Pulumi स्रोत गुणहरू आउटपुटहरू हुन्, र तिनीहरूमध्ये धेरैलाई एसिन्क्रोनस रूपमा मूल्याङ्कन गरिन्छ, हामीले मानहरू पहुँच गर्न लागू विधि प्रयोग गर्न आवश्यक छ। यो प्रतिज्ञा र कार्यसँग धेरै मिल्दोजुल्दो छ then .
• हामी त्रुटि सन्देशमा स्रोत URN देखाउन धेरै गुणहरू प्रयोग गर्दैछौं, हामीले प्रकार्य प्रयोग गर्न आवश्यक छ pulumi.allतिनीहरूलाई संयोजन गर्न।
• अन्तमा, यी मानहरू एसिन्क्रोनस रूपमा गणना गरिएको हुनाले, हामीले Mocha को निर्मित async कलब्याक सुविधा प्रयोग गर्न आवश्यक छ। done वा वाचा फिर्ता गर्दै।

एकपटक हामीले सबै कुरा सेट अप गरिसकेपछि, हामीसँग साधारण JavaScript मानहरूको रूपमा इनपुटहरूमा पहुँच हुनेछ। सम्पत्ति tags नक्सा (सहयोगी एरे) हो, त्यसैले हामी यो सुनिश्चित गर्नेछौं कि यो (१) गलत छैन, र (२) को लागि एउटा कुञ्जी छ 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();
                }
            });
        });

र अन्तमा, तेस्रो परीक्षण लेखौं। यो अलि बढी जटिल हुनेछ किनभने हामी सुरक्षा समूहसँग सम्बन्धित लगइन नियमहरू खोजिरहेका छौं, जसमध्ये धेरै हुन सक्छन्, र ती नियमहरूमा CIDR दायराहरू पनि धेरै हुन सक्छन्। तर हामीले व्यवस्थापन गर्यौं:

    // 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();
                }
            });
        });

यति नै। अब परीक्षणहरू चलाउनुहोस्!

चलिरहेको परीक्षणहरू

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

यो मुद्दा वरिपरि प्राप्त गर्न, हामीले केवल निम्न निर्दिष्ट गर्न आवश्यक छ:

• परियोजनाको नाम, जुन वातावरण चरमा समावेश छ PULUMI_NODEJS_PROJECT (वा, सामान्यतया, PULUMI__PROJECT для других языков).
  वातावरण चरमा निर्दिष्ट गरिएको स्ट्याकको नाम PULUMI_NODEJS_STACK (वा, सामान्यतया, PULUMI__ STACK).
  तपाईंको स्ट्याक कन्फिगरेसन चरहरू। तिनीहरू वातावरण चर प्रयोग गरेर प्राप्त गर्न सकिन्छ PULUMI_CONFIG र तिनीहरूको ढाँचा कुञ्जी/मान जोडीहरूसँग JSON नक्सा हो।

  कार्यक्रमले कार्यान्वयनको क्रममा CLI/इन्जिनमा जडान उपलब्ध छैन भनी संकेत गर्दै चेतावनीहरू जारी गर्नेछ। यो महत्त्वपूर्ण छ किनभने तपाईंको कार्यक्रमले वास्तवमा केहि पनि डिप्लोइ गर्ने छैन र यो अचम्मको रूपमा आउन सक्छ यदि तपाईंले गर्न चाहेको होइन भने! Pulumi लाई भन्नको लागि यो वास्तवमा तपाईलाई चाहिने कुरा हो, तपाईले स्थापना गर्न सक्नुहुन्छ PULUMI_TEST_MODE в true.

  कल्पना गर्नुहोस् कि हामीले परियोजनाको नाम निर्दिष्ट गर्न आवश्यक छ my-ws, स्ट्याक नाम dev, र AWS क्षेत्र us-west-2। Mocha परीक्षणहरू चलाउनको लागि आदेश रेखा यस्तो देखिन्छ:

  $ 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