Adozione di un approccio di sviluppo basato su test

Ti consigliamo di seguire un approccio di sviluppo basato sui test (TDD) con. AWS CDK TDDè un approccio di sviluppo software in cui si sviluppano casi di test per specificare e convalidare il codice. In parole povere, per prima cosa si creano casi di test per ciascuna funzionalità e, se il test ha esito negativo, si scrive il nuovo codice per superare il test e fare in modo che sia semplice e privo di bug.

Puoi usarlo TDD per scrivere prima il test case. Ciò consente di verificare l'infrastruttura con diversi vincoli di progettazione in termini di applicazione della politicy di sicurezza per le risorse e di rispetto di una convenzione di denominazione esclusiva per il progetto. L'approccio standard per testare AWS CDK le applicazioni consiste nell'utilizzare il modulo AWS CDKassertions e i framework di test più diffusi, come Jest for e/o pytest for TypeScript JavaScript Python.

Esistono due categorie di test che puoi scrivere per le tue applicazioni: AWS CDK

• Utilizza asserzioni dettagliate per testare un aspetto specifico del CloudFormation modello generato, ad esempio «questa risorsa ha questa proprietà con questo valore». Questi test possono rilevare regressioni e sono utili anche quando sviluppi nuove funzionalità utilizzando TDD (scrivi prima un test, poi fallo passare scrivendo un'implementazione corretta). Le asserzioni granulari sono i test che scriverai più spesso.

• Utilizza i test di istantanea per testare il modello sintetizzato rispetto a un CloudFormation modello di base memorizzato in precedenza. I test snapshot consentono di rifattorizzare liberamente, perché hai la certezza che il codice rifattorizzato funziona esattamente allo stesso modo dell'originale. Se le modifiche sono state intenzionali, puoi accettare una nuova base per i test futuri. Tuttavia, AWS CDK gli aggiornamenti possono anche causare modifiche ai modelli sintetizzati, quindi non puoi fare affidamento solo sulle istantanee per assicurarti che l'implementazione sia corretta.

Test unitario

Questa guida si concentra TypeScript specificamente sull'integrazione dei test unitari. Per abilitare i test, verifica che il file package.json disponga delle seguenti librerie: @types/jest, jest ets-jest in devDependencies. Per aggiungere questi pacchetti, esegui il comando cdk init lib --language=typescript. Dopo aver eseguito il comando precedente, visualizzerai la struttura seguente.

Il codice seguente è un esempio di package.json file abilitato con la libreria Jest.

{
  ...
  "scripts": {
    "build": "npm run lint && tsc",
    "watch": "tsc -w",
    "test": "jest",
  },
  "devDependencies": {
    ...
    "@types/jest": "27.5.2",
    "jest": "27.5.1",
    "ts-jest": "27.1.5",
    ...
  }
}

Nella cartella Test, puoi scrivere il caso di test. L'esempio seguente mostra un test case per un AWS CodePipeline costrutto.

import {App,Stack} from 'aws-cdk-lib';
import { Template } from 'aws-cdk-lib/assertions';
import * as CodepipelineModule from '../lib/index';
import { Role, ServicePrincipal } from 'aws-cdk-lib/aws-iam';
import { Repository } from 'aws-cdk-lib/aws-codecommit';
import { PipelineProject } from 'aws-cdk-lib/aws-codebuild';

const testData:CodepipelineModule.CodepipelineModuleProps = {

    pipelineName: "validate-test-pipeline",
    serviceRoleARN: "",
    codeCommitRepositoryARN: "",
    branchName: "master",
    buildStages:[]
}


test('Code Pipeline Created', () => {
    const app = new App();
    const stack = new Stack(app, "TestStack");
    // WHEN
    const serviceRole = new Role(stack, "testRole", { assumedBy: new ServicePrincipal('codepipeline.amazonaws.com') })
    const codeCommit = new Repository(stack, "testRepo", {
        repositoryName: "validate-codeCommit-repo"
    });
    const codeBuildProject=new PipelineProject(stack,"TestCodeBuildProject",{});
    testData.serviceRoleARN = serviceRole.roleArn;
    testData.codeCommitRepositoryARN = codeCommit.repositoryArn;
    testData["buildStages"].push({
        stageName:"Deploy",
        codeBuildProject:codeBuildProject
    })
    new CodepipelineModule.CodepipelineModule(stack, 'MyTestConstruct', testData);
    // THEN
    const template = Template.fromStack(stack);

    template.hasResourceProperties('AWS::CodePipeline::Pipeline', {
        Name:testData.pipelineName
    });
});

Per avviare un test, esegui il comando npm run test nel progetto. Il test restituisce i risultati seguenti.

PASS  test/codepipeline-module.test.ts (5.972 s)
  ✓ Code Pipeline Created (97 ms)
Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        6.142 s, estimated 9 s

Per ulteriori informazioni sui casi di test, consultate Testing constructs nella AWS Cloud Development Kit (AWS CDK) Developer Guide.

Test di integrazione

I test di integrazione per AWS CDK i costrutti possono essere inclusi anche utilizzando un integ-tests modulo. Un test di integrazione deve essere definito come un' AWS CDK applicazione. Dovrebbe esserci una one-to-one relazione tra un test di integrazione e un' AWS CDK applicazione. Per ulteriori informazioni, visita il integ-tests-alpha modulo nel AWS CDK APIReference.