Amazon CodeCatalyst は新規のお客様には提供されなくなりました。既存のお客様は、通常どおりサービスを引き続き使用できます。詳細については、「[CodeCatalyst から移行する方法](migration.md)」を参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# チュートリアル: サーバーレスアプリケーションをデプロイする
このチュートリアルでは、ワークフローを使用してサーバーレスアプリケーションを CloudFormation スタックとしてビルド、テスト、デプロイする方法について説明します。
このチュートリアルのアプリケーションは、「Hello World」メッセージを出力するシンプルなウェブアプリケーションです。これは AWS Lambda 関数と Amazon API Gateway で構成され、 の拡張機能である [AWS Serverless Application Model (AWS SAM)](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html) を使用して構築します[CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html)。
**Topics**
+ [
## 前提条件
](#deploy-tut-lambda-cfn-prereqs)
+ [
## ステップ 1: ソースレポジトリを作成する
](#deploy-tut-lambda-cfn-source)
+ [
## ステップ 2: AWS ロールを作成する
](#deploy-tut-lambda-cfn-roles)
+ [
## ステップ 3: CodeCatalyst に AWS ロールを追加する
](#deploy-tut-lambda-cfn-roles-add)
+ [
## ステップ 4: Amazon S3 バケットを作成する
](#deploy-tut-lambda-cfn-s3)
+ [
## ステップ 5: ソースファイルを追加する
](#deploy-tut-lambda-cfn-files)
+ [
## ステップ 6: ワークフローを作成して実行する
](#deploy-tut-lambda-cfn-workflow)
+ [
## ステップ 7: 変更を行う
](#deploy-tut-lambda-cfn-change)
+ [
## クリーンアップ
](#deploy-tut-lambda-cfn-clean-up)
## 前提条件
開始する前に:
+ 接続された AWS アカウントを持つ CodeCatalyst **スペース**が必要です。詳細については、「[スペースを作成する](spaces-create.md)」を参照してください。
+ スペースには、次の名前の空のプロジェクトが必要です。
```
codecatalyst-cfn-project
```
このプロジェクトを作成するには、**[ゼロから開始]** オプションを使用します。
詳細については、「[Amazon CodeCatalyst での空のプロジェクトの作成](projects-create.md#projects-create-empty)」を参照してください。
+ プロジェクトには、以下と呼ばれる CodeCatalyst **[環境]** が必要です。
```
codecatalyst-cfn-environment
```
この環境を次のように設定します。
+ **[非本番稼働用]** など、任意のタイプを選択します。
+ AWS アカウントを接続します。
+ **[デフォルトの IAM ロール]** で、任意のロールを選択します。後で別のロールを指定します。
詳細については、「[AWS アカウント と VPCs へのデプロイ](deploy-environments.md)」を参照してください。
## ステップ 1: ソースレポジトリを作成する
このステップでは、CodeCatalyst に空のソースリポジトリを作成します。このリポジトリは、Lambda 関数ファイルなどのチュートリアルのソースファイルを保存するために使用されます。
ソースリポジトリの詳細については、「[ソースリポジトリを作成する](source-repositories-create.md)」を参照してください。
**ソースリポジトリを作成するには**
1. ナビゲーションペインの CodeCatalyst で **[コード]** を選択してから、**[ソースリポジトリ]** を選択します。
1. **[リポジトリの追加]** を選択し、**[リポジトリの作成]** を選択します。
1. **[リポジトリ名]** に次のように入力します。
```
codecatalyst-cfn-source-repository
```
1. **[作成]** を選択します。
これで、`codecatalyst-cfn-source-repository` というリポジトリが作成されました。
## ステップ 2: AWS ロールを作成する
このステップでは、次の IAM AWS ロールを作成します。
+ **ロールのデプロイ** – サーバーレスアプリケーションをデプロイする AWS アカウントと CloudFormation サービスにアクセスするアクセス許可を CodeCatalyst **Deploy CloudFormation スタック**アクションに付与します。** CloudFormation スタックのデプロイ**アクションはワークフローの一部です。
+ **ビルドロール** – CodeCatalyst ビルドアクションに、 AWS アカウントにアクセスし、サーバーレスアプリケーションパッケージが保存される Amazon S3 に書き込むアクセス許可を付与します。ビルドアクションはワークフローの一部です。
+ **スタックロール** – 後で指定する AWS SAM テンプレートで指定されたリソースを読み取って変更するアクセス許可を CloudFormation に付与します。また、CloudWatch にアクセス許可を付与します。
IAM ロールの詳細については、「*AWS Identity and Access Management ユーザーガイド*」の「[IAM ロール](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)」を参照してください。
**注記**
時間を節約するため、前に一覧表示した 3 つのロールではなく、`CodeCatalystWorkflowDevelopmentRole-spaceName` ロールと呼ばれる 1 つのロールを作成できます。詳細については、「[アカウントとスペース用の **CodeCatalystWorkflowDevelopmentRole-*spaceName*** ロールを作成する](ipa-iam-roles.md#ipa-iam-roles-service-create)」を参照してください。`CodeCatalystWorkflowDevelopmentRole-spaceName` ロールには、セキュリティリスクをもたらす可能性のある非常に広範なアクセス許可があることを理解します。このロールは、セキュリティが懸念されないチュートリアルやシナリオでのみ使用することをお勧めします。このチュートリアルでは、前述の 3 つのロールを作成することを前提としています。
**注記**
[[Lambda 実行ロール]](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html) も必要ですが、ステップ 5 でワークフローを実行するときに `sam-template.yml` ファイルが作成するため、今すぐ作成する必要はありません。
**デプロイロールを作成するには**
1. ロールのポリシーを以下の手順で作成します。
1. にサインインします AWS。
1. IAM コンソール ([https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/)) を開きます。
1. ナビゲーションペインで、**ポリシー** を選択してください。
1. **[Create policy]** (ポリシーを作成) を選択します。
1. **JSON** タブを選択します。
1. 既存のコードを削除します。
1. 次のコードを貼り付けます。
**注記**
ロールがワークフローアクションの実行に初めて使用されるときは、リソースポリシーステートメントでワイルドカードを使用し、利用可能になった後にリソース名でポリシーの範囲を絞り込みます。
```
"Resource": "*"
```
1. [**Next: Tags (次へ: タグ)**] を選択します。
1. **[次へ: レビュー]** を選択します。
1. **[名前]** に次のように入力します。
```
codecatalyst-deploy-policy
```
1. [**Create policy**] (ポリシーの作成) を選択します。
これで、アクセス許可ポリシーが作成されました。
1. 次のようにデプロイロールを作成します。
1. ナビゲーションペインで **ロール** を選択してから、**ロールを作成する** を選択します。
1. **[カスタム信頼ポリシー]** を選択します。
1. 既存のカスタム信頼ポリシーを削除します。
1. 次の信頼ポリシーを追加します。
1. [**次へ**] を選択します。
1. **[アクセス許可ポリシー]** で `codecatalyst-deploy-policy` を検索し、チェックボックスをオンにします。
1. [**次へ**] を選択します。
1. **[ロール名]** には、次のように入力します。
```
codecatalyst-deploy-role
```
1. **[ロールの説明]** には、次のように入力します。
```
CodeCatalyst deploy role
```
1. [**ロールの作成**] を選択してください。
これで、信頼ポリシーとアクセス許可ポリシーを使用してデプロイロールが作成されました。
1. デプロイロール ARN を次のように取得します。
1. ナビゲーションペインで **Roles (ロール) ** を選択してください。
1. 検索ボックスに、作成したロールの名前 (`codecatalyst-deploy-role`) を入力します。
1. 使用するロールを一覧から選択します。
ロールの **[概要]** ページが表示されます。
1. 上部で、**[ARN]** 値をコピーします。
これで、適切なアクセス許可を持つデプロイロールを作成し、ARN を取得しました。
**ビルドロールを作成するには**
1. ロールのポリシーを以下の手順で作成します。
1. にサインインします AWS。
1. IAM コンソール ([https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/)) を開きます。
1. ナビゲーションペインで、**ポリシー** を選択してください。
1. **[Create policy]** (ポリシーを作成) を選択します。
1. **JSON** タブを選択します。
1. 既存のコードを削除します。
1. 次のコードを貼り付けます。
**注記**
ロールがワークフローアクションの実行に初めて使用されるときは、リソースポリシーステートメントでワイルドカードを使用し、利用可能になった後にリソース名でポリシーの範囲を絞り込みます。
```
"Resource": "*"
```
1. [**Next: Tags (次へ: タグ)**] を選択します。
1. **[次へ: レビュー]** を選択します。
1. **[名前]** に次のように入力します。
```
codecatalyst-build-policy
```
1. [**Create policy**] (ポリシーの作成) を選択します。
これで、アクセス許可ポリシーが作成されました。
1. 次のようにビルドロールを作成します。
1. ナビゲーションペインで **ロール** を選択してから、**ロールを作成する** を選択します。
1. **[カスタム信頼ポリシー]** を選択します。
1. 既存のカスタム信頼ポリシーを削除します。
1. 次の信頼ポリシーを追加します。
1. [**次へ**] を選択します。
1. **[アクセス許可ポリシー]** で `codecatalyst-build-policy` を検索し、チェックボックスをオンにします。
1. [**次へ**] を選択します。
1. **[ロール名]** には、次のように入力します。
```
codecatalyst-build-role
```
1. **[ロールの説明]** には、次のように入力します。
```
CodeCatalyst build role
```
1. [**ロールの作成**] を選択してください。
これで、信頼ポリシーとアクセス許可ポリシーを使用してビルドロールが作成されました。
1. 次のようにビルドロール ARN を取得します。
1. ナビゲーションペインで **Roles (ロール) ** を選択してください。
1. 検索ボックスに、作成したロールの名前 (`codecatalyst-build-role`) を入力します。
1. 使用するロールを一覧から選択します。
ロールの **[概要]** ページが表示されます。
1. 上部で、**[ARN]** 値をコピーします。
これで、適切なアクセス許可を持つビルドロールを作成し、その ARN を取得しました。
**スタックロールを作成するには**
1. スタックをデプロイするアカウント AWS を使用して にサインインします。
1. IAM コンソール ([https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/)) を開きます。
1. 次のようにスタックロールを作成します。
1. ナビゲーションペインで **Roles (ロール) ** を選択してください。
1. [**ロールの作成**] を選択してください。
1. **[AWS サービス]** を選択してください。
1. **[ユースケース]** セクションで、ドロップダウンリストから **[CloudFormation]** を選択します。
1. **[CloudFormation]** ラジオボタンを選択します。
1. 下部で、**[次へ]** を選択します。
1. 検索ボックスを使用して、次のアクセス許可ポリシーを検索し、それぞれのチェックボックスをオンにします。
**注記**
ポリシーを検索してもポリシーが表示されない場合は、**[フィルターをクリア]** を選択して再試行してください。
+ **CloudWatchFullAccess**
+ **AWS CloudFormationFullAccess**
+ **IAMFullAccess**
+ **AWS Lambda\$1FullAccess**
+ **AmazonAPIGatewayAdministrator**
+ **AmazonS3FullAccess**
+ **AmazonEC2ContainerRegistryFullAccess**
最初のポリシーでは、CloudWatch へのアクセスを許可し、アラームが発生したときにスタックのロールバックを有効にします。
残りのポリシー AWS SAM では、このチュートリアルでデプロイされるスタック内のサービスとリソースへのアクセスを に許可します。詳細については、「*AWS Serverless Application Model デベロッパーガイド*」の「[アクセス許可](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-permissions.html)」を参照してください。
1. [**次へ**] を選択します。
1. **[ロール名]** には、次のように入力します。
```
codecatalyst-stack-role
```
1. [**ロールの作成**] を選択してください。
1. 次のように、スタックロールの ARN を取得します。
1. ナビゲーションペインで **Roles (ロール) ** を選択してください。
1. 検索ボックスに、作成したロールの名前 (`codecatalyst-stack-role`) を入力します。
1. 使用するロールを一覧から選択します。
1. **[概要]** セクションの **[ARN]** 値をコピーします。これは後で必要になります。
これで、適切なアクセス許可を持つスタックロールを作成し、ARN を取得しました。
## ステップ 3: CodeCatalyst に AWS ロールを追加する
このステップでは、ビルドロール (`codecatalyst-build-role`) を追加し、スペース内の CodeCatalyst アカウント接続にロール (`codecatalyst-deploy-role`) をデプロイします。
**注記**
スタックロール (`codecatalyst-stack-role`) を接続に追加する必要はありません。これは、デプロイロールを使用して、CodeCatalyst と AWS 間で接続が既に確立された*後*、スタックロールが *[CloudFormation]* (CodeCatalyst ではない) で使用されるためです。スタックロールは、CodeCatalyst が AWSにアクセスするために使用するものではないため、アカウント接続に関連付ける必要はありません。
**ビルドロールとデプロイロールをアカウント接続に追加するには**
1. CodeCatalyst で、スペースに移動します。
1. **[AWS アカウント]** を選択します。アカウント接続が一覧表示されます。
1. ビルドロールとデプロイロールを作成したアカウントを表す AWS アカウント接続を選択します。
1. ** AWS 管理コンソールからロールの管理**を選択します。
**[Amazon CodeCatalyst スペースに IAM ロールの追加]** ページが表示されます。ページにアクセスするには、サインインが必要な場合があります。
1. **[IAM で作成した既存のロールを追加]** を選択します。
ドロップダウンリストが表示されます。この一覧表示には、`codecatalyst-runner.amazonaws.com` および `codecatalyst.amazonaws.com` サービスプリンシパルを含む信頼ポリシーを持つすべての IAM ロールが表示されます。
1. ドロップダウンリストで [`codecatalyst-build-role`] を選択し、**[ロールを追加]** を選択します。
1. **[IAM ロールを追加]** を選択し、**[IAM で作成した既存のロールを追加]** を選択し、ドロップダウンリストから [`codecatalyst-deploy-role`] を選択します。[**Add role**] を選択します。
これで、ビルドロールとデプロイロールをスペースに追加しました。
1. **[Amazon CodeCatalyst 表示名]** の値をコピーします。この値は、ワークフローを作成するときに後で必要になります。
## ステップ 4: Amazon S3 バケットを作成する
このステップでは、サーバーレスアプリケーションのデプロイパッケージ .zip ファイルを保存する Amazon S3 バケットを作成します。
**Amazon S3 バケットを作成するには**
1. Amazon S3 コンソール ([https://console.aws.amazon.com/s3/](https://console.aws.amazon.com/s3/)) を開きます。
1. メインペインで、**[バケットを作成]** を選択します。
1. **[バケット名]** に、次のように入力します。
```
codecatalyst-cfn-s3-bucket
```
1. **[AWS リージョン]** で、リージョンを選択します。このチュートリアルは、**[米国西部 (オレゴン) us-west-2]** を選択していることを前提としています。Amazon S3 がサポートしているリージョンについては、「*AWS 全般のリファレンス*」の「[Amazon Simple Storage Service エンドポイントとクォータ](https://docs.aws.amazon.com/general/latest/gr/s3.html)」を参照してください。
1. ページ下部にある **[バケットを作成]** ボタンを選択します。
これで、米国西部 (オレゴン) us-west-2 リージョンで **codecatalyst-cfn-s3-bucket** という名前のバケットが作成されました。
## ステップ 5: ソースファイルを追加する
このステップでは、CodeCatalyst ソースリポジトリに複数のアプリケーションソースファイルを追加します。`hello-world` フォルダには、デプロイするアプリケーションファイルが含まれています。`tests` フォルダにはユニットテストが含まれています。フォルダは次のような構造になっています。
```
.
|— hello-world
| |— tests
| |— unit
| |— test-handler.js
| |— app.js
|— .npmignore
|— package.json
|— sam-template.yml
|— setup-sam.sh
```
### .npmignore ファイル
`.npmignore` ファイルは、アプリケーションパッケージから npm を除外するファイルとフォルダを示します。このチュートリアルでは、npm はアプリケーションの一部ではないため、`tests` フォルダを除外します。
**.npmignore ファイルを追加するには**
1. [https://codecatalyst.aws/](https://codecatalyst.aws/) で CodeCatalyst コンソールを開きます。
1. プロジェクト「`codecatalyst-cfn-project`」を選択します。
1. ナビゲーションペインで **[コード]** を選択してから、**[ソースリポジトリ]** を選択します。
1. ソースリポジトリのリストから、リポジトリ `codecatalyst-cfn-source-repository` を選択します。
1. **[ファイル]** で、**[ファイルを作成]** を選択します。
1. **[ファイル名]** に次のように入力します。
```
.npmignore
```
1. テキストボックスに次のコードを入力します。
```
tests/*
```
1. **[コミット]** を選択し、再度 **[コミット]** を選択します。
これで、リポジトリのルートに `.npmignore` という名前のファイルが作成されました。
### package.json ファイル
`package.json` ファイルには、プロジェクト名、バージョン番号、説明、依存関係、およびアプリケーションとやり取りして実行する方法を説明するその他の詳細など、Node プロジェクトに関する重要なメタデータが含まれています。
このチュートリアルの `package.json` には、依存関係の一覧と `test` スクリプトが含まれています。スクリプトは、次を実行します。
+ [[mocha]](https://mochajs.org/) を使用して、テストスクリプトは `hello-world/tests/unit/` で指定されたユニットテストを実行し、[[xunit]]() レポーターを使用して結果を `junit.xml` ファイルに書き込みます。
+ [[Istanbul (nyc)]](https://istanbul.js.org/) を使用すると、テストスクリプトは [[clover]](https://openclover.org/doc/manual/4.2.0/general--about-openclover.html) レポーターを使用してコードカバレッジレポート (`clover.xml`) を生成します。詳細については、「Istanbul ドキュメント」の「[代替レポーターの使用](https://istanbul.js.org/docs/advanced/alternative-reporters/#clover)」を参照してください。
**package.json ファイルを追加するには**
1. リポジトリの **[ファイル]** で、**[ファイルを作成]** を選択します。
1. **[ファイル名]** に次のように入力します。
```
package.json
```
1. テキストボックスに次のコードを入力します。
```
{
"name": "hello_world",
"version": "1.0.0",
"description": "hello world sample for NodeJS",
"main": "app.js",
"repository": "https://github.com/awslabs/aws-sam-cli/tree/develop/samcli/local/init/templates/cookiecutter-aws-sam-hello-nodejs",
"author": "SAM CLI",
"license": "MIT",
"dependencies": {
"axios": "^0.21.1",
"nyc": "^15.1.0"
},
"scripts": {
"test": "nyc --reporter=clover mocha hello-world/tests/unit/ --reporter xunit --reporter-option output=junit.xml"
},
"devDependencies": {
"aws-sdk": "^2.815.0",
"chai": "^4.2.0",
"mocha": "^8.2.1"
}
}
```
1. **[コミット]** を選択し、再度 **[コミット]** を選択します。
これで、リポジトリのルートに「`package.json`」という名前のファイルが追加されました。
### sam-template.yml ファイル
`sam-template.yml` ファイルには、Lambda 関数と API Gateway をデプロイし、それらを一緒に設定するための手順が含まれています。テンプレート[AWS Serverless Application Model 仕様](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-specification.html)に従っており、 CloudFormation テンプレート仕様を拡張します。
は便利な [AWS::Serverless::Function](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-function.html) リソースタイプ AWS SAM を提供するため、このチュートリアル AWS SAM では通常のテンプレートの代わりに CloudFormation テンプレートを使用します。このタイプは、基本的な CloudFormation 構文を使用するために通常書き出す必要がある behind-the-scenes の設定を多く実行します。例えば、`AWS::Serverless::Function` は、関数を開始する Lambda 関数、Lambda 実行ロール、イベントソースマッピングを作成します。基本的な CloudFormation を使用して書き込む場合は、これらすべてをコーディングする必要があります。
このチュートリアルでは、事前に作成されたテンプレートを使用しますが、ビルドアクションを使用してワークフローの一部として作成できます。詳細については、「[CloudFormation スタックのデプロイ](deploy-action-cfn.md)」を参照してください。
**sam-template.yml ファイルを追加するには**
1. リポジトリの **[ファイル]** で、**[ファイルを作成]** を選択します。
1. **[ファイル名]** に次のように入力します。
```
sam-template.yml
```
1. テキストボックスに次のコードを入力します。
```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: >
serverless-api
Sample SAM Template for serverless-api
# More info about Globals: https://github.com/awslabs/serverless-application-model/blob/master/docs/globals.rst
Globals:
Function:
Timeout: 3
Resources:
HelloWorldFunction:
Type: AWS::Serverless::Function # For details on this resource type, see https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Properties:
CodeUri: hello-world/
Handler: app.lambdaHandler
Runtime: nodejs12.x
Events:
HelloWorld:
Type: Api # For details on this event source type, see https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api
Properties:
Path: /hello
Method: get
Outputs:
# ServerlessRestApi is an implicit API created out of the events key under Serverless::Function
# Find out about other implicit resources you can reference within AWS SAM at
# https://github.com/awslabs/serverless-application-model/blob/master/docs/internals/generated_resources.rst#api
HelloWorldApi:
Description: "API Gateway endpoint URL for the Hello World function"
Value: !Sub "https://${ServerlessRestApi}.execute-api.${AWS::Region}.amazonaws.com/Prod/hello/"
HelloWorldFunction:
Description: "Hello World Lambda function ARN"
Value: !GetAtt HelloWorldFunction.Arn
HelloWorldFunctionIamRole:
Description: "Implicit Lambda execution role created for the Hello World function"
Value: !GetAtt HelloWorldFunctionRole.Arn
```
1. **[コミット]** を選択し、再度 **[コミット]** を選択します。
これで、リポジトリのルートフォルダに「`sam-template.yml`」という名前のファイルが追加されました。
### setup-sam.sh ファイル
`setup-sam.sh` ファイルには、 CLI AWS SAM ユーティリティをダウンロードしてインストールする手順が含まれています。ワークフローは、このユーティリティを使用して `hello-world` ソースをパッケージ化します。
**setup-sam.sh ファイルを追加するには**
1. リポジトリの **[ファイル]** で、**[ファイルを作成]** を選択します。
1. **[ファイル名]** に次のように入力します。
```
setup-sam.sh
```
1. テキストボックスに次のコードを入力します。
```
#!/usr/bin/env bash
echo "Setting up sam"
yum install unzip -y
curl -LO https://github.com/aws/aws-sam-cli/releases/latest/download/aws-sam-cli-linux-x86_64.zip
unzip -qq aws-sam-cli-linux-x86_64.zip -d sam-installation-directory
./sam-installation-directory/install; export AWS_DEFAULT_REGION=us-west-2
```
上記のコードでは、*[us-west-2]* を AWS リージョンに置き換えます。
1. **[コミット]** を選択し、再度 **[コミット]** を選択します。
これで、リポジトリのルートに「`setup-sam.sh`」という名前のファイルが追加されました。
### app.js ファイル
`app.js` には、Lambda 関数のコードが含まれます。このチュートリアルでは、`hello world` コードはテキストを返します。
**app.js ファイルを追加するには**
1. リポジトリの **[ファイル]** で、**[ファイルを作成]** を選択します。
1. **[ファイル名]** に次のように入力します。
```
hello-world/app.js
```
1. テキストボックスに次のコードを入力します。
```
// const axios = require('axios')
// const url = 'http://checkip.amazonaws.com/';
let response;
/**
*
* Event doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format
* @param {Object} event - API Gateway Lambda Proxy Input Format
*
* Context doc: https://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-context.html
* @param {Object} context
*
* Return doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html
* @returns {Object} object - API Gateway Lambda Proxy Output Format
*
*/
exports.lambdaHandler = async (event, context) => {
try {
// const ret = await axios(url);
response = {
'statusCode': 200,
'body': JSON.stringify({
message: 'hello world',
// location: ret.data.trim()
})
}
} catch (err) {
console.log(err);
return err;
}
return response
};
```
1. **[コミット]** を選択し、再度 **[コミット]** を選択します。
これで、「`hello-world`」というフォルダと「`app.js`」というファイルが作成されました。
### test-handler.js ファイル
`test-handler.js` ファイルには、Lambda 関数の単位テストが含まれています。
**test-handler.js ファイルを追加するには**
1. リポジトリの **[ファイル]** で、**[ファイルを作成]** を選択します。
1. **[ファイル名]** に次のように入力します。
```
hello-world/tests/unit/test-handler.js
```
1. テキストボックスに次のコードを入力します。
```
'use strict';
const app = require('../../app.js');
const chai = require('chai');
const expect = chai.expect;
var event, context;
describe('Tests index', function () {
it('verifies successful response', async () => {
const result = await app.lambdaHandler(event, context)
expect(result).to.be.an('object');
expect(result.statusCode).to.equal(200);
expect(result.body).to.be.an('string');
let response = JSON.parse(result.body);
expect(response).to.be.an('object');
expect(response.message).to.be.equal("hello world");
// expect(response.location).to.be.an("string");
});
});
```
1. **[コミット]** を選択し、再度 **[コミット]** を選択します。
これで、`hello-world/tests/unit` フォルダの下位に「`test-handler.js`」というファイルが追加されました。
これで、すべてのソースファイルが追加されました。
少し時間を取って作業を再確認し、すべてのファイルを正しいフォルダに配置してください。フォルダは次のような構造になっています。
```
.
|— hello-world
| |— tests
| |— unit
| |— test-handler.js
| |— app.js
|— .npmignore
|— README.md
|— package.json
|— sam-template.yml
|— setup-sam.sh
```
## ステップ 6: ワークフローを作成して実行する
このステップでは、Lambda ソースコードをパッケージ化し、デプロイするワークフローを作成します。ワークフローは、連続して実行される次の構成要素で構成されます。
+ トリガー – このトリガーは、ソースリポジトリに変更をプッシュすると、ワークフローを自動的に開始します。トリガーについての詳細は、「[トリガーを使用したワークフロー実行の自動的な開始](workflows-add-trigger.md)」を参照してください。
+ テストアクション (`Test`) – トリガー時に、このアクションは [[Node パッケージマネージャー (npm)]](https://www.npmjs.com/) をインストールし、`npm run test` コマンドを実行します。このコマンドは、`package.json` ファイルで定義された `test` スクリプトを実行するように npm に指示します。次に、`test` スクリプトはユニットテストを実行し、テストレポート (`junit.xml`) とコードカバレッジレポート (`clover.xml`) の 2 つのレポートを生成します。詳細については、「[package.json ファイル](#deploy-tut-lambda-cfn-files-package-json)」を参照してください。
次に、テストアクションは XML レポートを CodeCatalyst レポートに変換し、テストアクションの **[Reports]** タブの CodeCatalyst コンソールに表示します。
テストアクションの詳細については、「[ワークフローを使用したテストワークフローを使用したテスト](test-workflow-actions.md)」を参照してください。
+ ビルドアクション (`BuildBackend`) – テストアクションが完了すると、ビルドアクションは CLI AWS SAM をダウンロードしてインストールし、`hello-world`ソースをパッケージ化し、パッケージを Lambda サービスが想定する Amazon S3 バケットにコピーします。アクションは、 という新しい AWS SAM テンプレートファイルも出力`sam-template-packaged.yml`し、 という出力アーティファクトに配置します`buildArtifact`。
ビルドアクションの詳細については、「[ワークフローを使用したビルド](build-workflow-actions.md)」を参照してください。
+ デプロイアクション (`DeployCloudFormationStack`) – ビルドアクションが完了すると、デプロイアクションはビルドアクション (`buildArtifact`) によって生成された出力アーティファクトを検索し、その中に AWS SAM テンプレートを見つけて、テンプレートを実行します。 AWS SAM テンプレートは、サーバーレスアプリケーションをデプロイするスタックを作成します。
**ワークフローを作成するには**
1. ナビゲーションペインで **[CI/CD]**、**[ワークフロー]** の順に選択します。
1. **[ワークフローを作成]** を選択します。
1. **[ソースリポジトリ]** で、`codecatalyst-cfn-source-repository` を選択します。
1. **[ブランチ]** で、`main` を選択します。
1. **[作成]** を選択します。
1. YAML サンプルコードを削除します。
1. 次の YAML コードを追加します。
**注記**
次の YAML コードでは、必要に応じて `Connections:` セクションを省略できます。このセクションを省略する場合は、環境の **[デフォルト IAM ロール]** フィールドで指定されたロールに、[ステップ 2: AWS ロールを作成する](#deploy-tut-lambda-cfn-roles) で記述されている両方のロールのアクセス許可と信頼ポリシーが含まれていることを確認する必要があります。デフォルトの IAM ロールを使用して環境を設定する方法の詳細については、「[環境を作成する](deploy-environments-creating-environment.md)」を参照してください。
```
Name: codecatalyst-cfn-workflow
SchemaVersion: 1.0
Triggers:
- Type: PUSH
Branches:
- main
Actions:
Test:
Identifier: aws/managed-test@v1
Inputs:
Sources:
- WorkflowSource
Outputs:
Reports:
CoverageReport:
Format: CLOVERXML
IncludePaths:
- "coverage/*"
TestReport:
Format: JUNITXML
IncludePaths:
- junit.xml
Configuration:
Steps:
- Run: npm install
- Run: npm run test
BuildBackend:
Identifier: aws/build@v1
DependsOn:
- Test
Environment:
Name: codecatalyst-cfn-environment
Connections:
- Name: codecatalyst-account-connection
Role: codecatalyst-build-role
Inputs:
Sources:
- WorkflowSource
Configuration:
Steps:
- Run: . ./setup-sam.sh
- Run: sam package --template-file sam-template.yml --s3-bucket codecatalyst-cfn-s3-bucket --output-template-file sam-template-packaged.yml --region us-west-2
Outputs:
Artifacts:
- Name: buildArtifact
Files:
- "**/*"
DeployCloudFormationStack:
Identifier: aws/cfn-deploy@v1
DependsOn:
- BuildBackend
Environment:
Name: codecatalyst-cfn-environment
Connections:
- Name: codecatalyst-account-connection
Role: codecatalyst-deploy-role
Inputs:
Artifacts:
- buildArtifact
Sources: []
Configuration:
name: codecatalyst-cfn-stack
region: us-west-2
role-arn: arn:aws:iam::111122223333:role/StackRole
template: ./sam-template-packaged.yml
capabilities: CAPABILITY_IAM,CAPABILITY_AUTO_EXPAND
```
上記のコードで置き換えます。
+ 環境の名前を持つ *[codecatalyst-cfn-environment]* の両方のインスタンス。
+ アカウント接続の表示名を持つ *[codecatalyst-account-connection]* の両方のインスタンス。表示名は数値である場合があります。詳細については、「[ステップ 3: CodeCatalyst に AWS ロールを追加する](#deploy-tut-lambda-cfn-roles-add)」を参照してください。
+ [ステップ 2: AWS ロールを作成する](#deploy-tut-lambda-cfn-roles) で作成したビルドロールの名前を持つ「*codecatalyst-build-role*」
+ [ステップ 4: Amazon S3 バケットを作成する](#deploy-tut-lambda-cfn-s3) で作成した Amazon S3 バケットの名前を持つ *[codecatalyst-cfn-s3-bucket]*。
+ Amazon S3 バケットが存在するリージョン (1 番目のインスタンス) とスタックがデプロイされるリージョン (2 番目のインスタンス) を持つ *[us-west-2]* のインスタンスの両方。これらのリージョンは異なる場合があります。このチュートリアルでは、両方のリージョンが `us-west-2` に設定されていることを前提としています。Amazon S3 および でサポートされているリージョンの詳細については CloudFormation、の[「サービスエンドポイントとクォータ](https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html)」を参照してください*AWS 全般のリファレンス*。
+ [ステップ 2: AWS ロールを作成する](#deploy-tut-lambda-cfn-roles) で作成したデプロイロールの名前を持つ「*codecatalyst-deploy-role*」
+ 「[前提条件](#deploy-tut-lambda-cfn-prereqs)」で作成した環境の名前を持つ *[codecatalyst-cfn-environment]*。
+ [ステップ 2: AWS ロールを作成する](#deploy-tut-lambda-cfn-roles) で作成したスタックロールの Amazon リソースネーム (ARN) を持つ *[arn:aws:iam::111122223333:role/StackRole]*。
**注記**
ビルド、デプロイ、スタックロールを作成しない場合、*codecatalyst-build-role*、*codecatalyst-deploy-role*、および *arn:aws:iam::111122223333:role/StackRole* を `CodeCatalystWorkflowDevelopmentRole-spaceName` ロールの名前または ARN に置き換えます。このロールの詳細については、「[ステップ 2: AWS ロールを作成する](#deploy-tut-lambda-cfn-roles)」を参照してください。
前述のコードのプロパティの詳細については、「[CloudFormation 「スタックをデプロイ」アクション YAML](deploy-action-ref-cfn.md)」を参照してください。
1. (オプション) **[検証]** を選択して、コミットする前に YAML コードが有効であることを確認します。
1. **[コミット]** を選択します。
1. **[ワークフローをコミット]** ダイアログボックスで、次のように入力します。
1. **[ワークフローファイル名]** は、デフォルトの「`codecatalyst-cfn-workflow`」のままにします。
1. **[コミットメッセージ]** には、次のように入力します。
```
add initial workflow file
```
1. **[リポジトリ]** で、**[codecatalyst-cfn-source-repository]** を選択します。
1. **[ブランチ名]** で、**[main]** を選択します。
1. **[コミット]** を選択します。
これでワークフローが作成されました。ワークフローの先頭で定義されているトリガーにより、ワークフローの実行が自動的に開始されます。具体的には、`codecatalyst-cfn-workflow.yaml` ファイルをソースリポジトリにコミット (およびプッシュ) すると、トリガーによってワークフローの実行が開始します。
**ワークフロー実行の進行状況を確認するには**
1. ナビゲーションペインで **[CI/CD]**、**[ワークフロー]** の順に選択します。
1. 先ほど作成したワークフロー「`codecatalyst-cfn-workflow`」を選択します。
1. **[実行]** タブを選択します。
1. **[Run ID]** 列で、実行 ID を選択します。
1. **[Test]** を選択して、テストの進行状況を確認します。
1. **[BuildBackend]** を選択すると、ビルドの進行状況が表示されます。
1. **[DeployCloudFormationStack]** を選択してデプロイの進行状況を確認します。
実行の詳細を表示する方法については、「[ワークフロー実行のステータスと詳細の表示](workflows-view-run.md)」を参照してください。
1. **[DeployCloudFormationStack]** アクションが完了したら、以下を実行します。
+ ワークフローの実行が成功したら、次の手順に進みます。
+ **[Test]** または **[BuildBackend]** ワークフローの実行が失敗した場合は、**[Logs]** を選択して問題をトラブルシューティングします。
+ **[DeployCloudFormationStack]** アクションでワークフローの実行が失敗した場合は、デプロイアクションを選択し、**[概要]** タブを選択します。**[CloudFormation イベント]** セクションにスクロールして、詳細なエラーメッセージを表示します。ロールバックが発生した場合は、ワークフローを再実行する前に、 の CloudFormation コンソール AWS から`codecatalyst-cfn-stack`スタックを削除します。
**デプロイを確認するには**
1. デプロイが成功したら、上部付近の水平メニューバーから **[変数 (7)]** を選択します。(右側のペインで **[変数]** を選択しないでください)。
1. **[HelloWorldApi]** の横にある `https://` URL をブラウザに貼り付けます。
Lambda 関数からの **[hello world]** JSON メッセージが表示され、ワークフローが Lambda 関数と API Gateway を正常にデプロイおよび設定したことを示します。
**ヒント**
CodeCatalyst が、いくつかの細かい設定を持つワークフロー図に、この URL を表示するようにできます。詳細については、「[ワークフロー図でのアプリケーション URL の表示](deploy-app-url.md)」を参照してください。
**ユニットテスト結果とコードカバレッジを検証するには**
1. ワークフロー図で、**[Test]** を選択し、**[Reports]** を選択します。
1. **[TestReport]** を選択してユニットテスト結果を表示するか、**[CoverageReport]** を選択してテスト対象のファイルのコードカバレッジの詳細を表示します。この場合、`app.js` と `test-handler.js` です。
**デプロイされたリソースを確認するには**
1. にサインイン AWS マネジメントコンソール し、[https://console.aws.amazon.com/apigateway/](https://console.aws.amazon.com/apigateway/) で API Gateway コンソールを開きます。
1. AWS SAM テンプレートが作成した **codecatalyst-cfn-stack** API を確認します。API 名は、ワークフロー定義ファイル (`codecatalyst-cfn-workflow.yaml`) の `Configuration/name` の値から取得します。
1. [https://console.aws.amazon.com/lambda/](https://console.aws.amazon.com/lambda/) で AWS Lambda コンソールを開きます。
1. ナビゲーションペインで、**[関数]** を選択します。
1. Lambda 関数「`codecatalyst-cfn-stack-HelloWorldFunction-string`」を選択します。
1. API Gateway が 関数のトリガーであることを確認できます。この統合は、 リソースタイプによって自動的に設定されました AWS SAM `AWS::Serverless::Function`。
## ステップ 7: 変更を行う
このステップでは、Lambda ソースコードを変更してコミットします。このコミットにより、新しいワークフロー実行が開始します。この実行では、Lambda コンソールで指定されたデフォルトのトラフィックシフト設定を使用するブルーグリーンスキームで新しい Lambda 関数をデプロイします。
**Lambda ソースを変更するには**
1. CodeCatalyst で、プロジェクトに移動します。
1. ナビゲーションペインで **[コード]** を選択してから、**[ソースリポジトリ]** を選択します。
1. ソースリポジトリ「`codecatalyst-cfn-source-repository`」を選択します。
1. アプリケーションファイルを変更します。
1. `hello-world` フォルダを選択します。
1. `app.js` ファイルを選択します。
1. **[編集]** を選択します。
1. 行 23 において、`hello world` を **Tutorial complete\$1** に変更します。
1. **[コミット]** を選択し、再度 **[コミット]** を選択します。
コミットにより、ワークフローの実行が開始します。名前の変更を反映するようにユニットテストを更新していないため、この実行は失敗します。
1. ユニットテストを更新します。
1. `hello-world\tests\unit\test-handler.js` を選択してください。
1. **[編集]** を選択します。
1. 行 19 において、`hello world` を **Tutorial complete\$1** に変更します。
1. **[コミット]** を選択し、再度 **[コミット]** を選択します。
コミットにより、もう 1 つのワークフローの実行が開始します。この実行は成功します。
1. ナビゲーションペインで **[CI/CD]**、**[ワークフロー]** の順に選択します。
1. [`codecatalyst-cfn-workflow`] を選択し、**[実行]** を選択します。
1. 最新の実行の実行 ID を選択します。この時点では実行中です。
1. **[Test]**、**[BuildBackend]**、**[DeployCloudFormationStack]** を選択し、ワークフローの実行の進行状況を確認します。
1. ワークフローが完了したら、上部の近くの **[変数 (7)]** を選択します。
1. **[HelloWorldApi]** の横にある `https://` URL をブラウザに貼り付けます。
`Tutorial complete!` メッセージがブラウザに表示されます。これは、アプリケーションが正常にデプロイされたことを示しています。
## クリーンアップ
このチュートリアルで使用されているファイルとサービスをクリーンアップして、料金が発生しないようにします。
**CodeCatalyst コンソールでクリーンアップするには**
1. [https://codecatalyst.aws/](https://codecatalyst.aws/) で CodeCatalyst コンソールを開きます。
1. `codecatalyst-cfn-workflow` を削除します。
1. `codecatalyst-cfn-environment` を削除します。
1. `codecatalyst-cfn-source-repository` を削除します。
1. `codecatalyst-cfn-project` を削除します。
**でクリーンアップするには AWS マネジメントコンソール**
1. CloudFormation で次のようにクリーンアップします。
1. [https://console.aws.amazon.com/cloudformation](https://console.aws.amazon.com/cloudformation/) で CloudFormation コンソールを開きます。
1. `codecatalyst-cfn-stack` を削除します。
スタックを削除すると、API Gateway および Lambda サービスからすべてのチュートリアルリソースが削除されます。
1. Amazon S3 で次のようにクリーンアップします。
1. Amazon S3 コンソール ([https://console.aws.amazon.com/s3/](https://console.aws.amazon.com/s3/)) を開きます。
1. [`codecatalyst-cfn-s3-bucket`] を選択します。
1. バケットのコンテンツを削除します。
1. バケットを削除します。
1. IAM で次のようにクリーンアップします。
1. IAM コンソール ([https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/)) を開きます。
1. `codecatalyst-deploy-policy` を削除します。
1. `codecatalyst-build-policy` を削除します。
1. `codecatalyst-stack-policy` を削除します。
1. `codecatalyst-deploy-role` を削除します。
1. `codecatalyst-build-role` を削除します。
1. `codecatalyst-stack-role` を削除します。
このチュートリアルでは、CodeCatalyst ワークフローとデプロイスタックアクションを使用して、サーバーレスアプリケーションを CloudFormation ** CloudFormation スタックとしてデプロイ**する方法を学習しました。