-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve Application Versioning (#108)
* Improve Application Versioning This will allow for better bug reports and information the binary running. This information can be retrieved upon providing the -v or --version flag * fixup: fix update-version and use variables to be more consistent
- Loading branch information
1 parent
8b3c443
commit b3582c2
Showing
6 changed files
with
174 additions
and
19 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
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 |
|---|---|---|
|
|
@@ -2,12 +2,15 @@ FROM golang:alpine as builder | |
| MAINTAINER Jack Murdock <[email protected]> | ||
|
|
||
| WORKDIR /go/src/github.com/xmidt-org/talaria | ||
| ARG VERSION=undefined | ||
| ARG GITCOMMIT=undefined | ||
| ARG BUILDTIME=undefined | ||
|
|
||
| RUN apk update && apk upgrade && \ | ||
| apk add --no-cache bash git openssh | ||
|
|
||
| COPY . . | ||
| RUN GO111MODULE=on go build -o talaria_linux_amd64 | ||
| RUN GO111MODULE=on go build -ldflags "-X 'main.BuildTime=${BUILDTIME}' -X main.GitCommit=${GITCOMMIT} -X main.Version=${VERSION}" -o talaria_linux_amd64 | ||
|
|
||
| FROM alpine | ||
|
|
||
|
|
||
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 |
|---|---|---|
|
|
@@ -2,12 +2,15 @@ FROM golang:alpine as builder | |
| MAINTAINER Jack Murdock <[email protected]> | ||
|
|
||
| WORKDIR /go/src/github.com/xmidt-org/talaria | ||
| ARG VERSION=undefined | ||
| ARG GITCOMMIT=undefined | ||
| ARG BUILDTIME=undefined | ||
|
|
||
| RUN apk add --update git curl | ||
|
|
||
| COPY . . | ||
|
|
||
| RUN go build -o talaria_linux_amd64 | ||
| RUN go build -ldflags "-X 'main.BuildTime=${BUILDTIME}' -X main.GitCommit=${GITCOMMIT} -X main.Version=${VERSION}" -o talaria_linux_amd64 | ||
|
|
||
| FROM alpine | ||
|
|
||
|
|
||
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,96 @@ | ||
| /** | ||
| * Copyright 2017 Comcast Cable Communications Management, LLC | ||
| * | ||
| * 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 main | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestPrintVersionInfo(t *testing.T) { | ||
| testCases := []struct { | ||
| name string | ||
| expectedOutput []string | ||
| overrideValues func() | ||
| lineCount int | ||
| }{ | ||
| { | ||
| "default", | ||
| []string{ | ||
| "talaria:", | ||
| "version: \tundefined", | ||
| "go version: \tgo", | ||
| "built time: \tundefined", | ||
| "git commit: \tundefined", | ||
| "os/arch: \t", | ||
| }, | ||
| func() {}, | ||
| 6, | ||
| }, | ||
| { | ||
| "set values", | ||
| []string{ | ||
| "talaria:", | ||
| "version: \t1.0.0\n", | ||
| "go version: \tgo", | ||
| "built time: \tsome time\n", | ||
| "git commit: \tgit sha\n", | ||
| "os/arch: \t", | ||
| }, | ||
| func() { | ||
| Version = "1.0.0" | ||
| BuildTime = "some time" | ||
| GitCommit = "git sha" | ||
| }, | ||
| 6, | ||
| }, | ||
| } | ||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| resetGlobals() | ||
| tc.overrideValues() | ||
| buf := &bytes.Buffer{} | ||
| printVersionInfo(buf) | ||
| count := 0 | ||
| for { | ||
| line, err := buf.ReadString(byte('\n')) | ||
| if err != nil { | ||
| break | ||
| } | ||
| assert.Contains(t, line, tc.expectedOutput[count]) | ||
| if strings.Contains(line, "\t") { | ||
| keyAndValue := strings.Split(line, "\t") | ||
| // The value after the tab should have more than 2 characters | ||
| // 1) the first character of the value and the new line | ||
| assert.True(t, len(keyAndValue[1]) > 2) | ||
| } | ||
| count++ | ||
| } | ||
| assert.Equal(t, tc.lineCount, count) | ||
| resetGlobals() | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func resetGlobals() { | ||
| Version = "undefined" | ||
| BuildTime = "undefined" | ||
| GitCommit = "undefined" | ||
| } |