LoginSignup
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

@Tomato_otamoTin株式会社ONE WEDGE

AWSとPythonでモックを使ったテスト

Posted at

モックテストとは？

モックテストは、システムの特定部分（例えば、外部APIやリソース）を模擬的に再現する「モック」を利用して行うテスト手法です。これにより、実際のリソースを操作することなく、システム全体の動作を確認できます。特にAWSのように外部依存が多い環境では、モックテストが非常に効果的です。

モックテストを行う理由

1. コスト削減

AWSサービスを実際に使用すると料金が発生しますが、モックテストでは模擬環境を使用するため、コストを抑えながらテストを行うことができます。特に大規模なサービスを扱う場合や繰り返しテストを行う場合に効果的です。

2. 安全なテスト環境

実際のリソースやデータを操作すると、誤った設定や操作でデータを破壊するリスクがあります。モックテストでは本番環境を変更せずにテストできるため、リスクを最小限に抑えられます。

3. テストの簡易化

モックテストではリソースの作成や削除がコード内で簡単に行えます。本物のAWS環境をセットアップする手間が省け、開発速度が向上します。

4. 依存関係の分離

他のサービスや外部システムへの依存を取り除くことで、テスト対象の機能に集中できます。例えば、Lambda関数のテスト時に、実際のS3やDynamoDBに依存せず、モックしたリソースを使うことで、予期せぬ外部エラーを防ぎます。

5. CI/CDパイプラインでの利用

モックテストは本物のAWSリソースを必要としないため、継続的インテグレーション/デプロイ（CI/CD）パイプラインに組み込みやすいです。これにより、自動化されたテストを迅速に行えます。

必要なライブラリのインストール

まずはmotoとboto3をインストールします。

pip install moto boto3

実際のコード例とモックテストコードの関連性

Amazon S3の例

実際のコード

import boto3

def upload_to_s3(bucket_name, key, data):
    s3 = boto3.client("s3")
    s3.put_object(Bucket=bucket_name, Key=key, Body=data)
    print(f"Uploaded {key} to bucket {bucket_name}")

解説:

  • boto3.client("s3")でS3クライアントを作成します。
  • put_objectメソッドを使って、指定したバケットにファイル（データ）をアップロードします。
  • アップロード成功時にメッセージを表示します。

モックテストコード

import boto3
from moto import mock_s3
import pytest

@mock_s3
def test_s3_upload():
    s3 = boto3.client("s3", region_name="us-east-1")
    bucket_name = "test-bucket"
    s3.create_bucket(Bucket=bucket_name)

    # 実際の関数を呼び出し
    upload_to_s3(bucket_name, "test.txt", b"Hello, World!")

    # 結果を検証
    response = s3.get_object(Bucket=bucket_name, Key="test.txt")
    assert response["Body"].read() == b"Hello, World!"

解説:

  • mock_s3デコレータでS3のモック環境を作成します。
  • テスト内でバケットを作成し、実際のupload_to_s3関数を呼び出します。
  • アップロードされたデータを取得し、期待したデータと一致するかを検証します。

AWS Lambdaの例

実際のコード

import boto3

def invoke_lambda(function_name, payload):
    lambda_client = boto3.client("lambda")
    response = lambda_client.invoke(
        FunctionName=function_name,
        Payload=payload
    )
    return response["StatusCode"]

解説:

  • boto3.client("lambda")でLambdaクライアントを作成します。
  • invokeメソッドを使って指定したLambda関数を呼び出します。
  • レスポンスからステータスコードを返します。

モックテストコード

from moto import mock_lambda

@mock_lambda
def test_lambda_function():
    lambda_client = boto3.client("lambda", region_name="us-east-1")
    function_name = "test-function"

    lambda_client.create_function(
        FunctionName=function_name,
        Runtime="python3.8",
        Role="test-role",
        Handler="lambda_function.lambda_handler",
        Code={"ZipFile": b""},
    )

    # 実際の関数を呼び出し
    status_code = invoke_lambda(function_name, b"{}")

    # 結果を検証
    assert status_code == 200

解説:

  • mock_lambdaデコレータでLambdaのモック環境を作成します。
  • テスト内でモックのLambda関数を作成し、invoke_lambda関数を呼び出します。
  • 関数の呼び出し結果（ステータスコード）が期待通りかを検証します。

AWS Step Functionsの例

実際のコード

import boto3

def start_step_function(state_machine_arn, input_data):
    client = boto3.client("stepfunctions")
    response = client.start_execution(
        stateMachineArn=state_machine_arn,
        input=input_data
    )
    return response["executionArn"]

解説:

  • boto3.client("stepfunctions")でStep Functionsクライアントを作成します。
  • start_executionメソッドを使ってステートマシンを実行します。
  • 実行のARNを返します。

モックテストコード

from moto import mock_stepfunctions

@mock_stepfunctions
def test_step_function():
    stepfunctions_client = boto3.client("stepfunctions", region_name="us-east-1")
    state_machine_name = "test-state-machine"

    definition = """
    {
      "Comment": "A simple AWS Step Functions state machine that says Hello World",
      "StartAt": "HelloWorld",
      "States": {
        "HelloWorld": {
          "Type": "Pass",
          "Result": "Hello World!",
          "End": true
        }
      }
    }
    """
    response = stepfunctions_client.create_state_machine(
        name=state_machine_name,
        definition=definition,
        roleArn="test-role",
    )

    # 実際の関数を呼び出し
    execution_arn = start_step_function(response["stateMachineArn"], "{}")

    # 結果を検証
    assert execution_arn

解説:

  • mock_stepfunctionsデコレータでStep Functionsのモック環境を作成します。
  • テスト内でモックのステートマシンを作成し、start_step_function関数を呼び出します。
  • 実行結果のARNが正しく返されるかを検証します。

モックテストを書く際の概念

1. モック環境の初期化と終了

すべてのモックテストで共通するのは、モック環境を適切に初期化し、終了することです。たとえば、motoライブラリを使用する場合、以下の方法でモック環境を管理します。

方法:

  • デコレータ: 関数単位でモック環境を適用する。
  • コンテキストマネージャー: テストの一部または全体をモック環境で囲む。

コード例:

from moto import mock_s3

@mock_s3
def test_example():
    # モック環境内での操作
    pass

# コンテキストマネージャーを使用
with mock_s3():
    # モック環境内での操作
    pass

2. サービス固有の構成要素のモック作成

各AWSサービスには、独自の構成要素（S3バケット、DynamoDBテーブル、Lambda関数など）があり、それらをテストの準備段階で作成する必要があります。

ポイント:

  • リソース（例: バケット、テーブル）はテスト内で作成する。
  • 実際のプロジェクト設定に合わせて、適切な名前やパラメータを使用する。

コード例:

import boto3
from moto import mock_s3

@mock_s3
def test_s3_operations():
    s3 = boto3.client("s3")
    s3.create_bucket(Bucket="test-bucket")

    # テスト対象の操作を実行
    s3.put_object(Bucket="test-bucket", Key="example.txt", Body="data")

    # 結果を検証
    response = s3.get_object(Bucket="test-bucket", Key="example.txt")
    assert response["Body"].read() == b"data"

3. 依存関係の分離

モックテストの主な目的の1つは、外部リソースや依存関係からテストを切り離すことです。これにより、以下の利点があります:

  • テストの実行速度が向上。
  • 他のサービスのエラーに影響されない。
  • 一貫性のあるテスト結果が得られる。

ベストプラクティス:

  • 外部リソースへの依存を最小化する。
  • 各テストケースで必要なモックリソースのみ作成する。

4. エラーシナリオの再現

実際のAWS環境でエラーを意図的に発生させることは困難ですが、モック環境では容易に再現できます。これにより、エラーケースや異常系のハンドリングをテストできます。

ポイント:

  • 特定のエラーコードや例外をモックする。
  • テストケースでエラーシナリオを明示的に記述する。

コード例:

from moto import mock_s3
import botocore

@mock_s3
def test_s3_error_handling():
    s3 = boto3.client("s3")
    try:
        # 存在しないバケットへの操作でエラーを発生させる
        s3.get_object(Bucket="non-existent-bucket", Key="example.txt")
    except botocore.exceptions.ClientError as e:
        # エラーコードを検証
        assert e.response["Error"]["Code"] == "NoSuchBucket"

5. テストデータの準備とクリーンアップ

テストデータの準備とクリーンアップを適切に行うことで、テストの独立性が保たれます。

ポイント:

  • 各テストケースでリソースを作成し、終了時に削除する。
  • 不要なリソースが残らないようにする。

コード例:

from moto import mock_dynamodb2
import boto3

@mock_dynamodb2
def test_dynamodb_operations():
    dynamodb = boto3.resource("dynamodb", region_name="us-east-1")
    table = dynamodb.create_table(
        TableName="test-table",
        KeySchema=[{"AttributeName": "id", "KeyType": "HASH"}],
        AttributeDefinitions=[{"AttributeName": "id", "AttributeType": "S"}],
        ProvisionedThroughput={"ReadCapacityUnits": 1, "WriteCapacityUnits": 1},
    )

    # データの挿入
    table.put_item(Item={"id": "123", "data": "example"})

    # データの取得
    response = table.get_item(Key={"id": "123"})
    assert response["Item"]["data"] == "example"

注意点

モック環境と本番環境の違いを意識する

モックテストが本番環境を完全に再現できるわけではないことを理解し、それを踏まえてテストケースを設計する必要があります。

モック環境はAWSの動作を模倣するものであり、本番環境と比較して以下のような違いがあります。それを意識することで、過信によるテスト設計のミスや誤った結論を防ぐことができます。

具体的な違いと注意点

1. モック環境でサポートされていない機能がある

  • 例:
    • motoでは、Amazon S3のイベント通知やDynamoDB Streamsなど、一部の高度な機能はサポートされていません。
    • Lambdaの一部ランタイムやStep Functionsの複雑な状態遷移は再現できない場合があります。
  • 注意点:
    • サポート外の機能がある場合、それらをテストしたい場合には、統合テストや本番環境での検証が必要です。

2. パフォーマンスが異なる

  • 例:
    • 本番環境ではS3のデータ転送速度やDynamoDBのクエリ性能が実際のクラウドインフラに依存しますが、モック環境ではすべてローカルで処理されるため、これらの特性をテストすることはできません。
  • 注意点:
    • モック環境はパフォーマンスの計測やスケーラビリティの確認には不向きです。そのため、負荷テストやパフォーマンス測定は本番環境で行う必要があります。

3. エラーの再現が容易

  • 例:
    • モック環境では意図的にエラーを発生させることができます（例: 存在しないバケットにアクセスする、IAMポリシーエラーをモックする）。
  • 注意点:
    • 実際のAWSでは、エラー条件が環境設定やサービスの状態によって変化することがあります。本番環境でのエラーハンドリングが、モック環境でのテスト通りに動作するとは限りません。

4. セキュリティ設定の違い

  • 例:
    • モック環境ではIAMポリシーやセキュリティグループのチェックがスキップされることが多いです。
  • 注意点:
    • 本番環境で発生するセキュリティ関連の問題（例: IAMポリシーの誤設定によるAccessDeniedエラー）を完全に検証するには、実際の環境でのテストが必要です。

5. サービス間の連携

  • 例:
    • 本番環境では、複数のサービス間でイベントが非同期に処理されますが、モック環境ではサービス間の連携をシミュレートする必要があります。
  • 注意点:
    • モック環境では、連携部分のロジックを独自にモックする必要があるため、実際のイベント駆動型の処理を完全に再現するのは困難です。
0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?