Skip to content

craymaru/serverless-todo-backend

BranchesTags

Repository files navigation

serverless-todo API

serverless-todo API は Todo を登録、取得(検索)、更新、削除することができるシンプルな REST API です。

この API は AWS Lambda と Amazon DynamoDB を基盤としたサーバーレスアーキテクチャで設計しました。

このドキュメントでは AWS の各名称について Amazon, AWS などのプリフィックスを省略し、Amazon Cognito → Cognito、AWS CloudFormation → CloudFormation のように表現することがありますので予めご留意ください。

References

API の仕様についてはこちらを参照してください

serverless-todo API: Reference

serverless-todo API: Cognito UserPool Auth Reference

デプロイ手順はこちらを参照してください

serverless-todo API: Deploy

使用技術／構成

ローカル環境

Name Version Note
macOS Big Sur 11.1 Beta（20C5061b）
Xcode 12.2 beta 3 (12B5035g)
pyenv 3.8.6 Python のバージョン管理
pipenv 2020.11.15 仮想環境/パッケージ管理

API 開発

アプリケーション

Name Version Note
Python 3.8.6 Lambda の言語として採用
Chalice 1.21.4 API Gateway と Lambda の管理、デプロイ
boto3 1.16.25 AWS SDK for Python

依存ライブラリは省略。詳細は Pipfile.lock から確認可能。

ユニットテスト

Name Version Note
pytest 6.1.2 Python のテストフレームワーク
pytest-chalice 0.0.5 インターフェイスの公開、応答のモック
moto 1.3.16 AWS サービスをモック DynamoDB のテストに使用

アーキテクチャ

サーバレスアプリケーション

Lambda と API Gateway は AWS Chalice を使って実装しました。 デプロイは CI/CD パイプラインを構築したので後述します。

Service Name Note
Amazon API Gateway Chalice を使用して開発
AWS Lambda Chalice を使用して開発
Amazon DynamoDB Lambda と相性の良い NoSQL を採用
AWS CloudFormation テスト後の自動デプロイ段階で使用
Stack: serverless-todo-backendBetaStack

認証

認証/認可は Amazon Cognito で実装しました。

Service Name Note
Amazon Cognito ServerlessToDoUserPool ユーザープールを作成
AWS CloudFormation デプロイに使用
Stack:ServerlessToDoUserPool
Path:release/cognito_userpool.yml

CI/CD パイプライン

CI/CD パイプラインを構築しました。 （理由は学習のため、あとで楽するため、カッコイイからです！:satisfied:）

Service Name Note
AWS CloudFormation CodePipeline、CodeCommit、CodeBuild、DynamoDB、S3 のデプロイに使用
Stack: ServerlessToDoPipeline
File: release/pipeline.json
AWS CodePipeline CodeCommit と CodeBuild の連携
AWS CodeCommit Git リモートリポジトリ
AWS CodeBuild pytest の実行、Chalice のパッケージング、デプロイのトリガー
File: buildspec.yml
Amazon S3 Chalice がパッケージング時に使用
AWS CloudFormation 自動デプロイ段階で使用
Stack: serverless-todo-backendBetaStack

その他

Service Name Note
AWS IAM 以下のエンティティを許可
serverless-todo-backendBetaStack
Lambda
ServerlessToDoPipeline
CloudFormation、CodeBuild、CodePipeline
Amazon CloudWatch 各種ロギング

Lambda の仕様

各メソッドに Docstring を記載しているので、ご参照ください。


テストの仕様

今回はユニットテストのみ実施しています。 app.py のテストでは current_response.json_body を差し替える必要があったため、pytest-chalice を使用しています。

chalicelib/db.py のテストではAWS サービスをモックすることのできるライブラリ moto を使用し、DynamoDB をモックしています。

テストの実施

テストは ./tests に格納されています。 以下のコマンドにて、すべてのテストを詳細表示で実行できます。

pytest -vvs --durations=10

テストデータ

共通で使用するテストデータは tests/testdata に格納されています。 個別のテストケースへの関連が強いテストデータは、@pytest.mark.parametrize デコレータ、またはテストケース内に内包しています。

テストケース

現在実装されている、テストケースを以下にリストしています。(2020-12-04 15:28) 詳しくは各ソースコードをご確認ください。

テスト対象のメソッド
テストケース

app のテスト

get_index
ステータスコード 200 と JSON を返すことができる
get_app_db
get_app_db の返り値クラスと、元のクラスが一致する
get_todos
すべてのアイテムを取得することができる
add_new_todo
subject と description があるケース、uid を受け取ることができる
subject のみのケース、uid を受け取ることができる
subject がないケース、例外を発生させることができる
description のみのケース、例外を発生させることができる
json_body が None のケース、例外を発生させることができる
get_todo
取得に指定した uid、username の Todo を受け取ることができる
delete_todo
削除に指定した uid、username の Todo の uid を受け取ることができる
update_todo
すべての属性のケース、特定の Todo の uid を受け取ることができる
subject のみのケース、特定の Todo の uid を受け取ることができる
discription のみのケース、特定の Todo の uid を受け取ることができる
state のみのケース、特定の Todoの uid を受け取ることができる
json_body が None のケース、例外を発生させることができる

DynamoDBTodo クラスのテスト

DynamoDBTodo.list_all_items
すべてのアイテムを取得することができる
DynamoDBTodo.list_items
ユーザー default のアイテムをすべて取得することができる
ユーザー default のアイテムからクエリを満たすものをすべて取得することができる
DynamoDBTodo.add_item
subject と description があるケース、正常にクエリを投げ uid を受け取ることができる
description のみのケース、例外を発生させることができる
DynamoDBTodo.get_item
uid が存在するケース、item を正常に返すことができる
uid が存在しないケース、例外を発生させることができる
DynamoDBTodo.delete_item
uid が存在するケース、削除した item の uid を正常に返すことができる
uid が存在しないケース、例外を発生させることができる
DynamoDBTodo.update_item
すべての属性を更新するケース、更新した item の uid を正常に返すことができる
subject を更新するケース、更新した item の uid を正常に返すことができる
description を更新するケース、更新した item の uid を正常に返すことができる
state を更新するケース、更新した item の uid を正常に返すことができる
uid が存在しないケース、例外を発生させることができる

バリデーションのテスト

Validates.subject
通常のケース、例外をパスできる
None のケース、例外を発生させることができる
str 以外の型のケース、例外を発生させることができる
文字の長さが境界値の限界のケース、例外をパスできる
文字の長さが境界値を超過しているケース、例外を発生させることができる
Validates.description
通常のケース、例外をパスできる
None のケース、例外をパスできる
str 以外の型のケース、例外を発生させることができる
文字の長さが境界値の限界のケース、例外をパスできる
文字の長さが境界値を超過しているケース、例外を発生させることができる
Validates.state
通常のケース、例外をパスできる
None のケース、例外を発生させることができる
str 以外の型のケース、例外を発生させることができる
Validates.STATE_ENUM に含まれる場合、例外をパスできる
Validates.STATE_ENUM に含まれない場合、例外を発生させることができる
Validates.username
通常のケース、例外をパスできる
None のケース、例外を発生させることができる
str 以外の型のケース、例外を発生させることができる
文字の長さが境界値の限界のケース、例外をパスできる
文字の長さが境界値を超過しているケース、例外を発生させることができる

Licenses Released under the MIT license © 2020 Taiki Takayama

About

サーバーレスアーキテクチャ Todo API

Resources

Readme
Activity

Stars

1 star

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages