សាកល្បងហេដ្ឋារចនាសម្ព័ន្ធជាកូដជាមួយ Pulumi ។ ផ្នែកទី 1

សួស្តីមិត្តភ័ក្តិ។ នៅក្នុងការរំពឹងទុកនៃការចាប់ផ្តើមនៃលំហូរថ្មីមួយនៅក្នុងអត្រា "ការអនុវត្ត និងឧបករណ៍ DevOps" យើងកំពុងចែករំលែកជាមួយអ្នកនូវការបកប្រែថ្មី។ ទៅ។

ការប្រើប្រាស់ Pulumi និងភាសាសរសេរកម្មវិធីដែលមានគោលបំណងទូទៅសម្រាប់កូដហេដ្ឋារចនាសម្ព័ន្ធ (Infrastructure as Code) ផ្តល់នូវអត្ថប្រយោជន៍ជាច្រើន៖ ភាពអាចរកបាននៃជំនាញ និងចំណេះដឹង ការលុបបំបាត់ boilerplate នៅក្នុងកូដតាមរយៈ abstraction ឧបករណ៍ដែលស៊ាំនឹងក្រុមរបស់អ្នក ដូចជា IDEs និង linters។ ឧបករណ៍វិស្វកម្មសូហ្វវែរទាំងអស់នេះមិនត្រឹមតែធ្វើឱ្យយើងកាន់តែមានផលិតភាពប៉ុណ្ណោះទេ ប៉ុន្តែថែមទាំងធ្វើអោយគុណភាពនៃកូដរបស់យើងកាន់តែប្រសើរឡើងផងដែរ។ ដូច្នេះ វាគ្រាន់តែជារឿងធម្មតាដែលការប្រើប្រាស់ភាសាសរសេរកម្មវិធីដែលមានគោលបំណងទូទៅអនុញ្ញាតឱ្យយើងណែនាំការអនុវត្តការអភិវឌ្ឍន៍កម្មវិធីសំខាន់មួយទៀត - ការធ្វើតេស្ត.

នៅក្នុងអត្ថបទនេះ យើងនឹងពិនិត្យមើលពីរបៀបដែល Pulumi ជួយយើងសាកល្បងហេដ្ឋារចនាសម្ព័ន្ធដូចកូដរបស់យើង។

ហេតុអ្វីត្រូវសាកល្បងហេដ្ឋារចនាសម្ព័ន្ធ?

មុន​នឹង​និយាយ​លម្អិត វា​គួរ​សួរ​សំណួរ​ថា "ហេតុអ្វី​បាន​ជា​សាកល្បង​ហេដ្ឋារចនាសម្ព័ន្ធ​ទាំងអស់?" មានហេតុផលជាច្រើនសម្រាប់រឿងនេះ ហើយនេះគឺជាមួយចំនួននៃពួកគេ៖

• ការធ្វើតេស្តឯកតានៃមុខងារនីមួយៗ ឬបំណែកនៃតក្កវិជ្ជាកម្មវិធីរបស់អ្នក។
• ផ្ទៀងផ្ទាត់ស្ថានភាពដែលចង់បាននៃហេដ្ឋារចនាសម្ព័ន្ធប្រឆាំងនឹងឧបសគ្គជាក់លាក់។
• ការរកឃើញកំហុសទូទៅ ដូចជាកង្វះការអ៊ិនគ្រីបធុងផ្ទុក ឬមិនមានការការពារ ការចូលប្រើពីអ៊ីនធឺណិតទៅម៉ាស៊ីននិម្មិត។
• ពិនិត្យការអនុវត្តការផ្តល់ហេដ្ឋារចនាសម្ព័ន្ធ។
• អនុវត្តការសាកល្បងពេលដំណើរការនៃតក្កវិជ្ជាកម្មវិធីដែលកំពុងដំណើរការនៅក្នុងហេដ្ឋារចនាសម្ព័ន្ធ "កម្មវិធី" របស់អ្នក ដើម្បីពិនិត្យមើលមុខងារបន្ទាប់ពីការផ្តល់។
• ដូចដែលយើងអាចឃើញមានជម្រើសជាច្រើននៃការធ្វើតេស្តហេដ្ឋារចនាសម្ព័ន្ធ។ Polumi មានយន្តការសម្រាប់ការធ្វើតេស្តនៅគ្រប់ចំណុចនៅលើវិសាលគមនេះ។ តោះចាប់ផ្តើម ហើយមើលពីរបៀបដែលវាដំណើរការ។

ការធ្វើតេស្តឯកតា

កម្មវិធី Pulumi ត្រូវបានសរសេរជាភាសាសរសេរកម្មវិធីដែលមានគោលបំណងទូទៅដូចជា JavaScript, Python, TypeScript ឬ Go ។ ដូច្នេះហើយ ថាមពលពេញលេញនៃភាសាទាំងនេះ រួមទាំងឧបករណ៍ និងបណ្ណាល័យរបស់ពួកគេ រួមទាំងក្របខ័ណ្ឌសាកល្បង មានសម្រាប់ពួកគេ។ Pulumi គឺជាពហុពពក ដែលមានន័យថាវាអាចត្រូវបានប្រើសម្រាប់ការធ្វើតេស្តពីអ្នកផ្តល់សេវាពពកណាមួយ។

(នៅក្នុងអត្ថបទនេះ ទោះបីជាមានពហុភាសា និងពហុពពកក៏ដោយ យើងប្រើ JavaScript និង Mocha ហើយផ្តោតលើ AWS ។ អ្នកអាចប្រើ Python 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 និងឧទាហរណ៍មួយ។ ទោះជាយ៉ាងណាក៏ដោយគួរកត់សំគាល់ថានៅទីនេះយើងកំពុងបំពានច្បាប់ទាំងបីដែលមានចែងខាងលើ។ តោះសាកល្បងសរសេរ!

ការធ្វើតេស្តសរសេរ

រចនាសម្ព័ន្ធទូទៅនៃការធ្វើតេស្តរបស់យើងនឹងមើលទៅដូចជាការធ្វើតេស្ត Mocha ធម្មតា៖

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ដើម្បីផ្សំពួកវា។
• ជាចុងក្រោយ ដោយសារតម្លៃទាំងនេះត្រូវបានគណនាដោយអសមកាល យើងត្រូវប្រើមុខងារហៅត្រឡប់មកវិញ async ដែលមានស្រាប់របស់ Mocha done ឬការសន្យាត្រឡប់មកវិញ។

នៅពេល​យើង​បាន​កំណត់​អ្វីៗ​គ្រប់យ៉ាង​ហើយ យើង​នឹង​មាន​សិទ្ធិ​ចូល​ប្រើ​ការ​បញ្ចូល​ជា​តម្លៃ JavaScript សាមញ្ញ។ ទ្រព្យសម្បត្តិ 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();
                }
            });
        });

ហើយចុងក្រោយ ចូរយើងសរសេរការធ្វើតេស្តទីបី។ វានឹងមានភាពស្មុគស្មាញបន្តិច ដោយសារយើងកំពុងស្វែងរកច្បាប់ចូលដែលភ្ជាប់ជាមួយក្រុមសុវត្ថិភាព ដែលវាអាចមានច្រើន ហើយជួរ 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();
                }
            });
        });

អស់ហើយ។ ឥឡូវ​យើង​រត់​ការ​ធ្វើ​តេ​ស្ត​!

កំពុងដំណើរការការធ្វើតេស្ត

ក្នុងករណីភាគច្រើន អ្នកអាចដំណើរការការធ្វើតេស្តតាមវិធីធម្មតា ដោយប្រើក្របខ័ណ្ឌសាកល្បងនៃជម្រើសរបស់អ្នក។ ប៉ុន្តែមានលក្ខណៈពិសេសមួយរបស់ Pulumi ដែលគួរយកចិត្តទុកដាក់។
ជាធម្មតា ដើម្បីដំណើរការកម្មវិធី Pulumi នោះ pulimi CLI (ចំណុចប្រទាក់បន្ទាត់ពាក្យបញ្ជា) ត្រូវបានប្រើ ដែលកំណត់រចនាសម្ព័ន្ធពេលវេលាដំណើរការភាសា គ្រប់គ្រងការបើកដំណើរការម៉ាស៊ីន Pulumi ដូច្នេះប្រតិបត្តិការជាមួយធនធានអាចត្រូវបានកត់ត្រា និងបញ្ចូលក្នុងផែនការ។ល។ ទោះយ៉ាងណាក៏ដោយមានបញ្ហាមួយ។ នៅពេលដំណើរការក្រោមការគ្រប់គ្រងនៃក្របខ័ណ្ឌសាកល្បងរបស់អ្នក វានឹងមិនមានទំនាក់ទំនងរវាង 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