This repository has been archived by the owner on May 4, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 154
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for HEALTHCHECK directive (#100)
* Add support for healthcheck * Add test
- Loading branch information
1 parent
d10c012
commit 74e9b38
Showing
8 changed files
with
388 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| // Copyright (c) 2018 Uber Technologies, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package step | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/uber/makisu/lib/context" | ||
| "github.com/uber/makisu/lib/docker/image" | ||
| ) | ||
|
|
||
| // HealthcheckStep implements BuildStep and execute HEALTHCHECK directive | ||
| type HealthcheckStep struct { | ||
| *baseStep | ||
|
|
||
| Interval time.Duration | ||
| Timeout time.Duration | ||
| StartPeriod time.Duration | ||
| Retries int | ||
|
|
||
| Test []string | ||
| } | ||
|
|
||
| // NewHealthcheckStep returns a BuildStep from given arguments. | ||
| func NewHealthcheckStep( | ||
| args string, interval, timeout, startPeriod time.Duration, retries int, | ||
| test []string, commit bool) (BuildStep, error) { | ||
|
|
||
| return &HealthcheckStep{ | ||
| baseStep: newBaseStep(Healthcheck, args, commit), | ||
| Interval: interval, | ||
| Timeout: timeout, | ||
| StartPeriod: startPeriod, | ||
| Retries: retries, | ||
| Test: test, | ||
| }, nil | ||
| } | ||
|
|
||
| // UpdateCtxAndConfig updates mutable states in build context, and generates a | ||
| // new image config base on config from previous step. | ||
| func (s *HealthcheckStep) UpdateCtxAndConfig( | ||
| ctx *context.BuildContext, imageConfig *image.Config) (*image.Config, error) { | ||
|
|
||
| config, err := image.NewImageConfigFromCopy(imageConfig) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("copy image config: %s", err) | ||
| } | ||
| config.Config.Healthcheck = &image.HealthConfig{ | ||
| Interval: s.Interval, | ||
| Timeout: s.Timeout, | ||
| StartPeriod: s.StartPeriod, | ||
| Retries: s.Retries, | ||
| Test: s.Test, | ||
| } | ||
| return config, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| // Copyright (c) 2018 Uber Technologies, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package step | ||
|
|
||
| import ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/uber/makisu/lib/context" | ||
| "github.com/uber/makisu/lib/docker/image" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestHealthcheckStepUpdateCtxAndConfig(t *testing.T) { | ||
| require := require.New(t) | ||
|
|
||
| ctx, cleanup := context.BuildContextFixture() | ||
| defer cleanup() | ||
|
|
||
| cmd := []string{"CMD", "ls", "/"} | ||
| d5, _ := time.ParseDuration("5s") | ||
| d0, _ := time.ParseDuration("0s") | ||
| step, err := NewHealthcheckStep("", d0, d5, d0, 0, cmd, false) | ||
| require.NoError(err) | ||
|
|
||
| c := image.NewDefaultImageConfig() | ||
| result, err := step.UpdateCtxAndConfig(ctx, &c) | ||
| require.NoError(err) | ||
| require.Equal(result.Config.Healthcheck, &image.HealthConfig{ | ||
| Interval: d0, | ||
| Timeout: d5, | ||
| StartPeriod: d0, | ||
| Retries: 0, | ||
| Test: cmd, | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| // Copyright (c) 2018 Uber Technologies, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package dockerfile | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "regexp" | ||
| "strconv" | ||
| "time" | ||
| ) | ||
|
|
||
| // HeathcheckDirective represents the "LABEL" dockerfile command. | ||
| type HealthcheckDirective struct { | ||
| *baseDirective | ||
|
|
||
| Interval time.Duration | ||
| Timeout time.Duration | ||
| StartPeriod time.Duration | ||
| Retries int | ||
|
|
||
| Test []string | ||
| } | ||
|
|
||
| // Variables: | ||
| // Replaced from ARGs and ENVs from within our stage. | ||
| // Formats: | ||
| // HEALTHCHECK NONE | ||
| // HEALTHCHECK [--interval=<t>] [--timeout=<t>] [--start-period=<t>] [--retries=<n>] \ | ||
| // CMD ["<param>"...] | ||
| // HEALTHCHECK [--interval=<t>] [--timeout=<t>] [--start-period=<t>] [--retries=<n>] \ | ||
| // CMD <command> <param>... | ||
| func newHealthcheckDirective(base *baseDirective, state *parsingState) (Directive, error) { | ||
| // TODO: regexp is not the ideal solution. | ||
| if isNone := regexp.MustCompile(`(?i)^[\s|\\]*none[\s|\\]*$`).MatchString(base.Args); isNone { | ||
| return &HealthcheckDirective{ | ||
| baseDirective: base, | ||
| Test: []string{"None"}, | ||
| }, nil | ||
| } | ||
| cmdIndices := regexp.MustCompile(`(?i)[\s|\\]*cmd[\s|\\]*`).FindStringIndex(base.Args) | ||
| if len(cmdIndices) < 2 { | ||
| return nil, base.err(fmt.Errorf("CMD not defined")) | ||
| } | ||
|
|
||
| flags, err := splitArgs(base.Args[:cmdIndices[0]]) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to parse interval") | ||
| } | ||
|
|
||
| var interval, timeout, startPeriod time.Duration | ||
| var retries int | ||
| for _, flag := range flags { | ||
| if val, ok, err := parseFlag(flag, "interval"); err != nil { | ||
| return nil, base.err(err) | ||
| } else if ok { | ||
| interval, err = time.ParseDuration(val) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to parse interval") | ||
| } | ||
| continue | ||
| } | ||
|
|
||
| if val, ok, err := parseFlag(flag, "timeout"); err != nil { | ||
| return nil, base.err(err) | ||
| } else if ok { | ||
| timeout, err = time.ParseDuration(val) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to parse timeout") | ||
| } | ||
| continue | ||
| } | ||
|
|
||
| if val, ok, err := parseFlag(flag, "start-period"); err != nil { | ||
| return nil, base.err(err) | ||
| } else if ok { | ||
| startPeriod, err = time.ParseDuration(val) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to parse start-period") | ||
| } | ||
| continue | ||
| } | ||
|
|
||
| if val, ok, err := parseFlag(flag, "retries"); err != nil { | ||
| return nil, base.err(err) | ||
| } else if ok { | ||
| retries, err = strconv.Atoi(val) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to parse retries") | ||
| } | ||
| continue | ||
| } | ||
|
|
||
| return nil, base.err(fmt.Errorf("Unsupported flag %s", flag)) | ||
| } | ||
|
|
||
| // Replace variables. | ||
| if state.stageVars == nil { | ||
| return nil, base.err(errBeforeFirstFrom) | ||
| } | ||
| remaining := base.Args[cmdIndices[1]:] | ||
| replaced, err := replaceVariables(remaining, state.stageVars) | ||
| if err != nil { | ||
| return nil, base.err(fmt.Errorf("Failed to replace variables in input: %s", err)) | ||
| } | ||
| remaining = replaced | ||
|
|
||
| // Parse CMD. | ||
| if cmd, ok := parseJSONArray(remaining); ok { | ||
| if len(cmd) == 0 { | ||
| return nil, base.err(fmt.Errorf("missing CMD arguments: %s", err)) | ||
| } | ||
|
|
||
| return &HealthcheckDirective{ | ||
| baseDirective: base, | ||
| Interval: interval, | ||
| Timeout: timeout, | ||
| StartPeriod: startPeriod, | ||
| Retries: retries, | ||
| Test: append([]string{"CMD"}, cmd...), | ||
| }, nil | ||
| } | ||
|
|
||
| // Verify cmd arg is a valid array, but return the whole arg as one string. | ||
| args, err := splitArgs(remaining) | ||
| if err != nil { | ||
| return nil, base.err(err) | ||
| } | ||
| if len(args) == 0 { | ||
| return nil, base.err(fmt.Errorf("missing CMD arguments: %s", err)) | ||
| } | ||
|
|
||
| return &HealthcheckDirective{ | ||
| baseDirective: base, | ||
| Interval: interval, | ||
| Timeout: timeout, | ||
| StartPeriod: startPeriod, | ||
| Retries: retries, | ||
| Test: append([]string{"CMD-SHELL"}, remaining), | ||
| }, nil | ||
| } | ||
|
|
||
| // Add this command to the build stage. | ||
| func (d *HealthcheckDirective) update(state *parsingState) error { | ||
| return state.addToCurrStage(d) | ||
| } |
Oops, something went wrong.