Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: use entrypoint/command from template when possibile #29

Merged
merged 2 commits into from
Feb 23, 2024
Merged

fix: use entrypoint/command from template when possibile #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5bee676
fix: use entrypoint/command from template when possible
francesco-racciatti Feb 11, 2024
8fe6906
build: add test target for runtime/cloudformation
francesco-racciatti Feb 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/presubmit.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@ jobs:

- name: Test
run: |
cd runtimes/cloudformation
go test -v ./...
make -C runtimes/cloudformation test

build-cfn-runtime:
name: Build CloudFormation runtime
Expand Down
5 changes: 4 additions & 1 deletion runtimes/cloudformation/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,7 @@ clean:
rm agent-kilt.zip || true
rm cmd/handler/handler || true

.PHONY: clean
test:
go test -v ./...

.PHONY: clean test
23 changes: 23 additions & 0 deletions runtimes/cloudformation/cfnpatcher/cfn_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,13 @@ var defaultTests = [...]string{
"patching/volumes_from",
}

var enableHints = [...]string{
"patching/hints_no_overrides",
"patching/hints_override_command",
"patching/hints_override_entrypoint",
"patching/hints_override_entrypoint_command",
}

var parameterizedEnvarsTests = [...]string{
"patching/parameterize_env_add",
"patching/parameterize_env_merge",
Expand Down Expand Up @@ -205,6 +212,22 @@ func TestPatching(t *testing.T) {
}
}

func TestPatchingWithRepoHints(t *testing.T) {
l := log.Output(zerolog.ConsoleWriter{Out: os.Stderr}).With().Caller().Logger()

for _, testName := range enableHints {
t.Run(testName, func(t *testing.T) {
runTest(t, testName, l.WithContext(context.Background()),
Configuration{
Kilt: defaultConfig,
OptIn: false,
RecipeConfig: "{}",
UseRepositoryHints: true,
})
})
}
}

func TestPatchingSidecarEnv(t *testing.T) {
l := log.Output(zerolog.ConsoleWriter{Out: os.Stderr}).With().Caller().Logger()

Expand Down
18 changes: 18 additions & 0 deletions runtimes/cloudformation/cfnpatcher/fixtures/patching/hints_no_overrides.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"Resources": {
"taskdef": {
"Type": "AWS::ECS::TaskDefinition",
"Properties": {
"RequiresCompatibilities": [
"FARGATE"
],
"ContainerDefinitions": [
{
"Name": "app",
"Image": "nginx"
}
]
}
}
}
}
46 changes: 46 additions & 0 deletions runtimes/cloudformation/cfnpatcher/fixtures/patching/hints_no_overrides.patched.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"Resources": {
"taskdef": {
"Properties": {
"ContainerDefinitions": [
{
"Command": [
"/docker-entrypoint.sh",
"nginx",
"-g",
"daemon off;"
],
"EntryPoint": [
"/kilt/run",
"--"
],
"Image": "nginx",
"Name": "app",
"LinuxParameters": {
"Capabilities": {
"Add": ["SYS_PTRACE"]
}
},
"VolumesFrom": [
{
"ReadOnly": true,
"SourceContainer": "KiltImage"
}
]
},
{
"EntryPoint": [
"/kilt/wait"
],
"Image": "KILT:latest",
"Name": "KiltImage"
}
],
"RequiresCompatibilities": [
"FARGATE"
]
},
"Type": "AWS::ECS::TaskDefinition"
}
}
}
19 changes: 19 additions & 0 deletions runtimes/cloudformation/cfnpatcher/fixtures/patching/hints_override_command.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"Resources": {
"taskdef": {
"Type": "AWS::ECS::TaskDefinition",
"Properties": {
"RequiresCompatibilities": [
"FARGATE"
],
"ContainerDefinitions": [
{
"Name": "app",
"Image": "nginx",
"Command": ["my-command"]
}
]
}
}
}
}
44 changes: 44 additions & 0 deletions runtimes/cloudformation/cfnpatcher/fixtures/patching/hints_override_command.patched.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"Resources": {
"taskdef": {
"Properties": {
"ContainerDefinitions": [
{
"Command": [
"/docker-entrypoint.sh",
"my-command"
],
"EntryPoint": [
"/kilt/run",
"--"
],
"Image": "nginx",
"Name": "app",
"LinuxParameters": {
"Capabilities": {
"Add": ["SYS_PTRACE"]
}
},
"VolumesFrom": [
{
"ReadOnly": true,
"SourceContainer": "KiltImage"
}
]
},
{
"EntryPoint": [
"/kilt/wait"
],
"Image": "KILT:latest",
"Name": "KiltImage"
}
],
"RequiresCompatibilities": [
"FARGATE"
]
},
"Type": "AWS::ECS::TaskDefinition"
}
}
}
19 changes: 19 additions & 0 deletions runtimes/cloudformation/cfnpatcher/fixtures/patching/hints_override_entrypoint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"Resources": {
"taskdef": {
"Type": "AWS::ECS::TaskDefinition",
"Properties": {
"RequiresCompatibilities": [
"FARGATE"
],
"ContainerDefinitions": [
{
"Name": "app",
"Image": "nginx",
"EntryPoint": ["my-entrypoint"]
}
]
}
}
}
}
43 changes: 43 additions & 0 deletions runtimes/cloudformation/cfnpatcher/fixtures/patching/hints_override_entrypoint.patched.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"Resources": {
"taskdef": {
"Properties": {
"ContainerDefinitions": [
{
"Command": [
"my-entrypoint"
],
"EntryPoint": [
"/kilt/run",
"--"
],
"Image": "nginx",
"Name": "app",
"LinuxParameters": {
"Capabilities": {
"Add": ["SYS_PTRACE"]
}
},
"VolumesFrom": [
{
"ReadOnly": true,
"SourceContainer": "KiltImage"
}
]
},
{
"EntryPoint": [
"/kilt/wait"
],
"Image": "KILT:latest",
"Name": "KiltImage"
}
],
"RequiresCompatibilities": [
"FARGATE"
]
},
"Type": "AWS::ECS::TaskDefinition"
}
}
}
20 changes: 20 additions & 0 deletions runtimes/cloudformation/cfnpatcher/fixtures/patching/hints_override_entrypoint_command.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"Resources": {
"taskdef": {
"Type": "AWS::ECS::TaskDefinition",
"Properties": {
"RequiresCompatibilities": [
"FARGATE"
],
"ContainerDefinitions": [
{
"Name": "app",
"Image": "nginx",
"Command": ["my-command"],
"EntryPoint": ["my-entrypoint"]
}
]
}
}
}
}
44 changes: 44 additions & 0 deletions ...loudformation/cfnpatcher/fixtures/patching/hints_override_entrypoint_command.patched.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"Resources": {
"taskdef": {
"Properties": {
"ContainerDefinitions": [
{
"Command": [
"my-entrypoint",
"my-command"
],
"EntryPoint": [
"/kilt/run",
"--"
],
"Image": "nginx",
"Name": "app",
"LinuxParameters": {
"Capabilities": {
"Add": ["SYS_PTRACE"]
}
},
"VolumesFrom": [
{
"ReadOnly": true,
"SourceContainer": "KiltImage"
}
]
},
{
"EntryPoint": [
"/kilt/wait"
],
"Image": "KILT:latest",
"Name": "KiltImage"
}
],
"RequiresCompatibilities": [
"FARGATE"
]
},
"Type": "AWS::ECS::TaskDefinition"
}
}
}
13 changes: 10 additions & 3 deletions runtimes/cloudformation/cfnpatcher/template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ import (
func fillContainerInfo(ctx context.Context, container *gabs.Container, parameters *gabs.Container, configuration *Configuration) {
l := log.Ctx(ctx)

if container.Exists("Command") && container.Exists("EntryPoint") {
hasOverriddenEntrypoint := container.Exists("EntryPoint")
hasOverriddenCommand := container.Exists("Command")

if hasOverriddenEntrypoint && hasOverriddenCommand {
return
}

Expand Down Expand Up @@ -44,10 +47,14 @@ func fillContainerInfo(ctx context.Context, container *gabs.Container, parameter
if err != nil {
l.Warn().Str("image", image).Err(err).Msg("could not retrieve metadata from repository")
} else {
if repoInfo.Entrypoint != nil {
// Use the image's entrypoint if the task definition does not override it
if repoInfo.Entrypoint != nil && !hasOverriddenEntrypoint {
l.Info().Str("image", container.S("Image").String()).Msgf("using default entrypoint %s", repoInfo.Entrypoint)
container.Set(repoInfo.Entrypoint, "EntryPoint")
}
if repoInfo.Command != nil {
// Use the image's command if the task definition overrides neither the entrypoint nor the command
if repoInfo.Command != nil && !hasOverriddenCommand && !hasOverriddenEntrypoint {
l.Info().Str("image", container.S("Image").String()).Msgf("using default command %s", repoInfo.Command)
container.Set(repoInfo.Command, "Command")
}
}
Expand Down
Loading