Cloud9・Codeサービス・Taskcatで実現するCloudFormationテンプレート開発環境を作る

pip install cfn-lint

pip install yamllint

pip3 install taskcat

.
├── .cfnlintrc.yaml
├── .gitignore
├── .taskcat.yml
├── .yamllint.yaml
├── README.md
├── buildspec.yaml
├── cloudformation
│   └── main.yaml
└── junit_xml.py

---
templates:
  - cloudformation/*.yaml

taskcat_outputs/*

---
project:
  name: cfn-development
  s3_bucket: "taskcat-output-xxxxxxxxxxxx"
tests:
  main:
    regions:
      - ap-northeast-1
    template: "cloudformation/main.yaml"
    parameters:
      VpcCidr: "10.0.0.0/16"
      PublicSubnetCidr: "10.0.1.0/24"
      PrivateSubnetCidr: "10.0.2.0/24"

---

yaml-files:
  - '*.yaml'
  - '*.yml'
  - '.yamllint'

rules:
  anchors: enable
  braces: enable
  brackets: enable
  colons: enable
  commas: enable
  comments:
    level: warning
  comments-indentation:
    level: warning
  document-end: disable
  document-start:
    level: warning
  empty-lines: enable
  empty-values: disable
  float-values: disable
  hyphens: enable
  indentation: enable
  key-duplicates: enable
  key-ordering: disable
  line-length: enable
  new-line-at-end-of-file: enable
  new-lines: enable
  octal-values: disable
  quoted-strings: disable
  trailing-spaces: enable
  truthy:
    level: warning

---
version: 0.2

phases:
  install:
    runtime-versions:
      python: 3.12
    commands:
      - pip install yamllint
      - pip install cfn-lint
      - pip3 install taskcat
  pre_build:
    commands:
      - yamllint --version
      - cfn-lint --version
      - taskcat --version
      - aws s3 rm s3://cfn-development-xxxxxxxxxxxx/cloudformation --recursive
  build:
    commands:
      - yamllint .
      - cfn-lint
      - taskcat test run
  post_build:
    commands:
      - cat taskcat_outputs/*.txt
      - report=`ls -rt taskcat_outputs/*.txt |tail -n 1`
      - python3 junit_xml.py $report
reports:
  taskcat_outputs:
    files:
      - taskcat_outputs/*.xml
    file-format: JunitXml
artifacts:
  files:
    - 'cloudformation/*'
    - 'taskcat_outputs/*'

import sys
import os
import xml.etree.ElementTree as ET

def convert_to_junit_xml(log):
    # Create the root element
    testsuite = ET.Element("testsuite")

    # Create a testsuite element
    testsuite = ET.SubElement(testsuite, "testsuite", name="taskcat-cnf-development")

    # Parse the log and create testcases
    lines = log.split("\n")
    success_count = 0
    failure_count = 0
    for line in lines:
        if "CREATE_COMPLETE" in line or "CREATE_FAILED" in line:
            date, time, resource_status, resource_type, logical_resource_id, *rest = line.split()
            if len(rest) >= 6:
                resource_status_reason = ' '.join(rest)
            else:
                resource_status_reason = ""
            testcase = ET.SubElement(testsuite, "testcase", classname=resource_type, name=logical_resource_id)

            if resource_status == "CREATE_COMPLETE":
                ET.SubElement(testcase, "success")
                success_count += 1
            else:
                ET.SubElement(testcase, "failure", message=resource_status_reason)
                failure_count += 1

    # Add summary information
    testsuite.set("tests", str(success_count + failure_count))
    testsuite.set("failures", str(failure_count))

    # Return the string representation of the XML
    return ET.tostring(testsuite, encoding="unicode")

if __name__ == "__main__":
    # Check if the log file path is provided as a command line argument
    if len(sys.argv) < 2:
        print("Please provide the path to the log file as a command line argument.")
        sys.exit(1)

    # Read the log file
    log_file_path = sys.argv[1]
    with open(log_file_path, "r") as file:
        log = file.read()

    # Convert the log to JUnit XML format
    junit_xml = convert_to_junit_xml(log)
    print(junit_xml)

    # Save the XML as a file named "report.xml" in the same directory as the log file
    log_file_directory = os.path.dirname(log_file_path)
    report_file_path = os.path.join(log_file_directory, "report.xml")
    with open(report_file_path, "w") as file:
        file.write(junit_xml)

---
AWSTemplateFormatVersion: "2010-09-09"
Description: "CloudFormation template"

Parameters:
    VpcCidr:
        Type: String
        Description: "The CIDR block for the VPC"
        Default: 10.0.0.0/16
    PublicSubnetCidr:
        Type: String
        Description: "The CIDR block for the public subnet"
        Default: 10.0.1.0/24
    PrivateSubnetCidr:
        Type: String
        Description: "The CIDR block for the private subnet"
        Default: 10.0.2.0/24

Resources:
    MyVPC:
        Type: "AWS::EC2::VPC"
        Properties:
            CidrBlock: !Ref VpcCidr
            Tags:
                - Key: Name
                  Value: MyVPC

    MyInternetGateway:
        Type: "AWS::EC2::InternetGateway"

    MyVPCGatewayAttachment:
        Type: "AWS::EC2::VPCGatewayAttachment"
        Properties:
            VpcId: !Ref MyVPC
            InternetGatewayId: !Ref MyInternetGateway

    MyPublicSubnet:
        Type: "AWS::EC2::Subnet"
        Properties:
            VpcId: !Ref MyVPC
            CidrBlock: !Ref PublicSubnetCidr
            AvailabilityZone: !Select [0, !GetAZs ""]

    MyPrivateSubnet:
        Type: "AWS::EC2::Subnet"
        Properties:
            VpcId: !Ref MyVPC
            CidrBlock: !Ref PrivateSubnetCidr
            AvailabilityZone: !Select [0, !GetAZs ""]

    MyRouteTable:
        Type: "AWS::EC2::RouteTable"
        Properties:
            VpcId: !Ref MyVPC

    MyPublicRoute:
        Type: "AWS::EC2::Route"
        DependsOn: MyVPCGatewayAttachment
        Properties:
            RouteTableId: !Ref MyRouteTable
            DestinationCidrBlock: "0.0.0.0/0"
            GatewayId: !Ref MyInternetGateway

    MyPublicSubnetRouteTableAssociation:
        Type: "AWS::EC2::SubnetRouteTableAssociation"
        Properties:
            SubnetId: !Ref MyPublicSubnet
            RouteTableId: !Ref MyRouteTable

    MyPrivateSubnetRouteTableAssociation:
        Type: "AWS::EC2::SubnetRouteTableAssociation"
        Properties:
            SubnetId: !Ref MyPrivateSubnet
            RouteTableId: !Ref MyRouteTable