Skip to content

Commit 57dbfc1

Browse files
samuel-phanSamuel Phanantonbabenko
authored
feat: Add control to use timestamp to trigger the package creation or not (useful for CI/CD) (#521)
Co-authored-by: Samuel Phan <[email protected]> Co-authored-by: Anton Babenko <[email protected]>
1 parent fd5a4c8 commit 57dbfc1

File tree

12 files changed

+235
-2
lines changed

12 files changed

+235
-2
lines changed

‎README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -621,7 +621,7 @@ Q2: How to force recreate deployment package?
621621
622622
Q3: `null_resource.archive[0] must be replaced`
623623

624-
> Answer: This probably mean that zip-archive has been deployed, but is currently absent locally, and it has to be recreated locally. When you run into this issue during CI/CD process (where workspace is clean) or from multiple workspaces, you can set environment variable `TF_RECREATE_MISSING_LAMBDA_PACKAGE=false` or pass `recreate_missing_package = false` as a parameter to the module and run `terraform apply`.
624+
> Answer: This probably mean that zip-archive has been deployed, but is currently absent locally, and it has to be recreated locally. When you run into this issue during CI/CD process (where workspace is clean) or from multiple workspaces, you can set environment variable `TF_RECREATE_MISSING_LAMBDA_PACKAGE=false` or pass `recreate_missing_package = false` as a parameter to the module and run `terraform apply`. Alternatively, you can pass `trigger_on_package_timestamp = false` as a parameter to ignore the file timestamp when deciding to create the archive or not.
625625
626626
Q4: What does this error mean - `"We currently do not support adding policies for $LATEST."` ?
627627

@@ -651,6 +651,7 @@ Q4: What does this error mean - `"We currently do not support adding policies fo
651651
- [Event Source Mapping](https://github.com/terraform-aws-modules/terraform-aws-lambda/tree/master/examples/event-source-mapping) - Create Lambda Function with event source mapping configuration (SQS, DynamoDB, Amazon MQ, and Kinesis).
652652
- [Triggers](https://github.com/terraform-aws-modules/terraform-aws-lambda/tree/master/examples/triggers) - Create Lambda Function with some triggers (eg, Cloudwatch Events, EventBridge).
653653
- [Code Signing](https://github.com/terraform-aws-modules/terraform-aws-lambda/tree/master/examples/code-signing) - Create Lambda Function with code signing configuration.
654+
- [Simple CI/CD](https://github.com/terraform-aws-modules/terraform-aws-lambda/tree/master/examples/simple-cicd) - Create Lambda Function as if it runs on CI/CD platform where `builds` directory is often absent.
654655

655656
# Examples by the users of this module
656657

@@ -852,6 +853,7 @@ No modules.
852853
| <a name="input_timeout"></a> [timeout](#input\_timeout) | The amount of time your Lambda Function has to run in seconds. | `number` | `3` | no |
853854
| <a name="input_timeouts"></a> [timeouts](#input\_timeouts) | Define maximum timeout for creating, updating, and deleting Lambda Function resources | `map(string)` | `{}` | no |
854855
| <a name="input_tracing_mode"></a> [tracing\_mode](#input\_tracing\_mode) | Tracing mode of the Lambda Function. Valid value can be either PassThrough or Active. | `string` | `null` | no |
856+
| <a name="input_trigger_on_package_timestamp"></a> [trigger\_on\_package\_timestamp](#input\_trigger\_on\_package\_timestamp) | Whether to recreate the Lambda package if the timestamp changes | `bool` | `true` | no |
855857
| <a name="input_trusted_entities"></a> [trusted\_entities](#input\_trusted\_entities) | List of additional trusted entities for assuming Lambda Function role (trust relationship) | `any` | `[]` | no |
856858
| <a name="input_use_existing_cloudwatch_log_group"></a> [use\_existing\_cloudwatch\_log\_group](#input\_use\_existing\_cloudwatch\_log\_group) | Whether to use an existing CloudWatch log group or create new | `bool` | `false` | no |
857859
| <a name="input_vpc_security_group_ids"></a> [vpc\_security\_group\_ids](#input\_vpc\_security\_group\_ids) | List of security group ids when Lambda Function should run in the VPC. | `list(string)` | `null` | no |

‎examples/fixtures/python3.10-app1/index.py

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
def lambda_handler(event, context):
2+
print("Hello from app1!")
3+
4+
return event

‎examples/simple-cicd/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/src

‎examples/simple-cicd/README.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Simple CI/CD example
2+
3+
Configuration in this directory creates AWS Lambda Function as it would run in a context of CICD executions, where the Terraform working directory is empty and there is no `builds` directory, that:
4+
5+
- `terraform plan` doesn't trigger a diff if the source code of the lambda function didn't change.
6+
- `terraform plan` does trigger a diff if the source code of the lambda function has changed.
7+
- `terraform apply` works if the code has changed.
8+
9+
## Usage
10+
11+
To run this example you need to execute:
12+
13+
```bash
14+
./test.sh
15+
```
16+
17+
Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
18+
19+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
20+
## Requirements
21+
22+
| Name | Version |
23+
|------|---------|
24+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
25+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.63 |
26+
| <a name="requirement_random"></a> [random](#requirement\_random) | >= 2.0 |
27+
28+
## Providers
29+
30+
| Name | Version |
31+
|------|---------|
32+
| <a name="provider_random"></a> [random](#provider\_random) | >= 2.0 |
33+
34+
## Modules
35+
36+
| Name | Source | Version |
37+
|------|--------|---------|
38+
| <a name="module_lambda_function"></a> [lambda\_function](#module\_lambda\_function) | ../../ | n/a |
39+
40+
## Resources
41+
42+
| Name | Type |
43+
|------|------|
44+
| [random_pet.this](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | resource |
45+
46+
## Inputs
47+
48+
No inputs.
49+
50+
## Outputs
51+
52+
No outputs.
53+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/simple-cicd/main.tf

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
provider "aws" {
2+
region = "eu-west-1"
3+
# region = "us-east-1"
4+
5+
# Make it faster by skipping something
6+
skip_metadata_api_check = true
7+
skip_region_validation = true
8+
skip_credentials_validation = true
9+
}
10+
11+
resource "random_pet" "this" {
12+
length = 2
13+
}
14+
15+
module "lambda_function" {
16+
source = "../../"
17+
18+
function_name = "${random_pet.this.id}-lambda-simple"
19+
handler = "index.lambda_handler"
20+
runtime = "python3.10"
21+
22+
source_path = [
23+
"${path.module}/src/python3.10-app1",
24+
]
25+
trigger_on_package_timestamp = false
26+
}

‎examples/simple-cicd/outputs.tf

Whitespace-only changes.

‎examples/simple-cicd/test.sh

+126
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
#!/usr/bin/env bash
2+
# vim:ts=4:sw=4:noet
3+
4+
set -eo pipefail
5+
6+
trap ctrl_c INT
7+
8+
ctrl_c() {
9+
echo "** Trapped CTRL-C"
10+
exit 1
11+
}
12+
13+
failed=0
14+
15+
:echo() {
16+
local color=${2:-"33;1"}
17+
echo -e "\e[${color}m$1\e[0m"
18+
}
19+
20+
:note() {
21+
:echo "$1" "35;1"
22+
}
23+
24+
:case() {
25+
if [ $? -ne 0 ]
26+
then failed=1
27+
fi
28+
29+
if [ "$failed" -eq 1 ]
30+
then :echo "SKIPPED: $1"; return 1
31+
else echo; :echo "CASE: $1"
32+
fi
33+
}
34+
35+
:check_diff() {
36+
expected="$1"
37+
38+
set +e
39+
terraform plan -detailed-exitcode
40+
status=$?
41+
set -e
42+
# ${status} possible values:
43+
# 0 - Succeeded, diff is empty (no changes)
44+
# 1 - Errored
45+
# 2 - Succeeded, there is a diff
46+
if [ "${status}" -ne "${expected}" ]; then
47+
case "${expected}" in
48+
0)
49+
:echo "Error: we don't expect any diff here!"
50+
return 1
51+
;;
52+
2)
53+
echo "Error: we DO expect some diff here!"
54+
return 1
55+
;;
56+
esac
57+
fi
58+
}
59+
60+
terraform=$(which terraform)
61+
terraform() {
62+
$terraform "$@" < <(yes yes)
63+
}
64+
65+
:note "Preparing ..."
66+
rm -rf src
67+
mkdir -p src
68+
cp -r "../fixtures/python3.10-app1" src
69+
terraform init
70+
:echo "Destroy / Remove ZIP files"
71+
terraform destroy
72+
rm -rf builds 2>/dev/null || true
73+
74+
#############################################################
75+
# Part 1: Check that CICD environment won't detect any diff #
76+
#############################################################
77+
78+
:echo
79+
:note "Starting Part 1: Check that CICD environment won't detect any diff"
80+
81+
:case "Apply / No diff" && {
82+
terraform apply
83+
:check_diff 0
84+
}
85+
86+
:case "Remove 'builds' dir / No diff" && {
87+
rm -rf builds
88+
:check_diff 0
89+
}
90+
91+
###############################################################################
92+
# Part 2: Check that CICD environment will detect diff if lambda code changes #
93+
###############################################################################
94+
95+
:echo
96+
:note "Starting Part 2: Check that CICD environment will detect diff if lambda code changes"
97+
98+
:note "Change the source code / Remove 'builds' dir"
99+
echo "" >> src/python3.10-app1/index.py
100+
rm -rf builds
101+
102+
:case "Plan / Expect diff" && {
103+
terraform plan
104+
:check_diff 2
105+
}
106+
107+
:case "Apply / No diff" && {
108+
terraform apply
109+
:check_diff 0
110+
}
111+
112+
:note "Remove 'builds' dir"
113+
rm -rf builds
114+
115+
:case "Plan / No diff" && {
116+
terraform plan
117+
:check_diff 0
118+
}
119+
120+
#:case "Destroy / Remove ZIP files" && {
121+
# terraform plan -destroy
122+
# terraform destroy -auto-approve
123+
# rm builds/*.zip
124+
#}
125+
126+
:note "All tests have passed successfully."

‎examples/simple-cicd/variables.tf

Whitespace-only changes.

‎examples/simple-cicd/versions.tf

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
terraform {
2+
required_version = ">= 1.0"
3+
4+
required_providers {
5+
aws = {
6+
source = "hashicorp/aws"
7+
version = ">= 4.63"
8+
}
9+
random = {
10+
source = "hashicorp/random"
11+
version = ">= 2.0"
12+
}
13+
}
14+
}

‎package.tf

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ resource "null_resource" "archive" {
6161

6262
triggers = {
6363
filename = data.external.archive_prepare[0].result.filename
64-
timestamp = data.external.archive_prepare[0].result.timestamp
64+
timestamp = var.trigger_on_package_timestamp ? data.external.archive_prepare[0].result.timestamp : null
6565
}
6666

6767
provisioner "local-exec" {

‎variables.tf

+6
Original file line numberDiff line numberDiff line change
@@ -761,3 +761,9 @@ variable "recreate_missing_package" {
761761
type = bool
762762
default = true
763763
}
764+
765+
variable "trigger_on_package_timestamp" {
766+
description = "Whether to recreate the Lambda package if the timestamp changes"
767+
type = bool
768+
default = true
769+
}

‎wrappers/main.tf

+1
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ module "wrapper" {
119119
timeout = try(each.value.timeout, var.defaults.timeout, 3)
120120
timeouts = try(each.value.timeouts, var.defaults.timeouts, {})
121121
tracing_mode = try(each.value.tracing_mode, var.defaults.tracing_mode, null)
122+
trigger_on_package_timestamp = try(each.value.trigger_on_package_timestamp, var.defaults.trigger_on_package_timestamp, true)
122123
trusted_entities = try(each.value.trusted_entities, var.defaults.trusted_entities, [])
123124
use_existing_cloudwatch_log_group = try(each.value.use_existing_cloudwatch_log_group, var.defaults.use_existing_cloudwatch_log_group, false)
124125
vpc_security_group_ids = try(each.value.vpc_security_group_ids, var.defaults.vpc_security_group_ids, null)

0 commit comments

Comments
 (0)