├── .gitignore ├── Base.Dockerfile ├── Build.Dockerfile ├── Gopkg.lock ├── Gopkg.toml ├── Jenkinsfile ├── LICENSE ├── Makefile ├── README.md ├── Test.Dockerfile ├── app ├── handler │ └── handlers.go ├── main.go └── sample │ ├── sample.go │ └── sample_test.go └── docker-compose.yml /.gitignore: -------------------------------------------------------------------------------- 1 | vendor/ 2 | tmp/ 3 | report/ -------------------------------------------------------------------------------- /Base.Dockerfile: -------------------------------------------------------------------------------- 1 | ARG GOLANG_TAG 2 | FROM golang:${GOLANG_TAG} 3 | 4 | # Stuff needed for dep in alpine 5 | RUN apk --update add git openssh curl && \ 6 | rm -rf /var/lib/apt/lists/* && \ 7 | rm /var/cache/apk/* 8 | # install dep 9 | RUN curl -fsSL -o /usr/local/bin/dep https://github.com/golang/dep/releases/download/v0.3.2/dep-linux-amd64 && chmod +x /usr/local/bin/dep 10 | 11 | # Copy the local package files to the container's workspace. 12 | ARG APP_NAME 13 | WORKDIR /go/src/${APP_NAME} 14 | ADD app ./app 15 | 16 | #copies the Gopkg.toml and Gopkg.lock to WORKDIR 17 | ADD Gopkg.toml Gopkg.lock ./ 18 | 19 | # Install dependencies 20 | RUN dep ensure -vendor-only 21 | -------------------------------------------------------------------------------- /Build.Dockerfile: -------------------------------------------------------------------------------- 1 | ARG BASE_TAG 2 | ARG IMAGE_NAME 3 | FROM ${IMAGE_NAME}-base:${BASE_TAG} 4 | 5 | # Compile binary 6 | ARG APP_NAME 7 | RUN go install ${APP_NAME}/app 8 | 9 | HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 \ 10 | CMD curl -f http://localhost/healthz || exit 1 11 | 12 | # Run program 13 | ENTRYPOINT ["/go/bin/app"] 14 | 15 | # Document that the service listens on port 80. 16 | EXPOSE 80 17 | -------------------------------------------------------------------------------- /Gopkg.lock: -------------------------------------------------------------------------------- 1 | # This file is autogenerated, do not edit; changes may be undone by the next 'dep ensure'. 2 | 3 | 4 | [[projects]] 5 | name = "github.com/go-redis/redis" 6 | packages = [".","internal","internal/consistenthash","internal/hashtag","internal/pool","internal/proto"] 7 | revision = "35248155a505a84811be81a2aab1c423317447be" 8 | version = "v6.7.2" 9 | 10 | [[projects]] 11 | name = "github.com/gorilla/context" 12 | packages = ["."] 13 | revision = "1ea25387ff6f684839d82767c1733ff4d4d15d0a" 14 | version = "v1.1" 15 | 16 | [[projects]] 17 | name = "github.com/gorilla/handlers" 18 | packages = ["."] 19 | revision = "a4043c62cc2329bacda331d33fc908ab11ef0ec3" 20 | version = "v1.2.1" 21 | 22 | [[projects]] 23 | name = "github.com/gorilla/mux" 24 | packages = ["."] 25 | revision = "24fca303ac6da784b9e8269f724ddeb0b2eea5e7" 26 | version = "v1.5.0" 27 | 28 | [solve-meta] 29 | analyzer-name = "dep" 30 | analyzer-version = 1 31 | inputs-digest = "56d6318e2688b5579b1f2ac43805177e67aec1247c9c450cc9ceef91130acff3" 32 | solver-name = "gps-cdcl" 33 | solver-version = 1 34 | -------------------------------------------------------------------------------- /Gopkg.toml: -------------------------------------------------------------------------------- 1 | 2 | # Gopkg.toml example 3 | # 4 | # Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md 5 | # for detailed Gopkg.toml documentation. 6 | # 7 | # required = ["github.com/user/thing/cmd/thing"] 8 | # ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"] 9 | # 10 | # [[constraint]] 11 | # name = "github.com/user/project" 12 | # version = "1.0.0" 13 | # 14 | # [[constraint]] 15 | # name = "github.com/user/project2" 16 | # branch = "dev" 17 | # source = "github.com/myfork/project2" 18 | # 19 | # [[override]] 20 | # name = "github.com/x/y" 21 | # version = "2.4.0" 22 | 23 | 24 | [[constraint]] 25 | name = "github.com/go-redis/redis" 26 | version = "6.7.2" 27 | 28 | [[constraint]] 29 | name = "github.com/gorilla/handlers" 30 | version = "1.2.1" 31 | 32 | [[constraint]] 33 | name = "github.com/gorilla/mux" 34 | version = "1.5.0" 35 | -------------------------------------------------------------------------------- /Jenkinsfile: -------------------------------------------------------------------------------- 1 | // this will start an executor on a Jenkins agent with the docker label 2 | pipeline { 3 | agent any 4 | stages { 5 | stage('build base image') { 6 | steps { 7 | sh 'make build-base' 8 | } 9 | } 10 | stage('run tests') { 11 | steps { 12 | sh 'make build-test' 13 | sh 'make test-unit' 14 | sh 'ls' 15 | junit 'report/report.xml' 16 | } 17 | } 18 | stage('build image') { 19 | steps { 20 | sh 'make build' 21 | } 22 | } 23 | } 24 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | BASE_TAG=$(shell git rev-parse --short HEAD) 2 | # image name for docker 3 | IMAGE_NAME=charlires/webapp 4 | # app name for go packages 5 | APP_NAME=webapp 6 | # base golang image tag 7 | GOLANG_TAG=1.9.2-alpine 8 | # build args for Dockerfile's 9 | BUILD_BASE_ARGS=--build-arg APP_NAME=$(APP_NAME) --build-arg GOLANG_TAG=$(GOLANG_TAG) 10 | BUILD_TEST_ARGS=--build-arg IMAGE_NAME=$(IMAGE_NAME) --build-arg BASE_TAG=$(BASE_TAG) 11 | BUILD_ARGS=--build-arg IMAGE_NAME=$(IMAGE_NAME) --build-arg APP_NAME=$(APP_NAME) --build-arg BASE_TAG=$(BASE_TAG) 12 | # net port for webapp 13 | PORT=8080 14 | 15 | publish: 16 | @echo ":::build publish image" 17 | docker push $(IMAGE_NAME):$(BASE_TAG) 18 | 19 | build-base: 20 | @echo ":::building base image" 21 | docker build --rm -f Base.Dockerfile $(BUILD_BASE_ARGS) -t $(IMAGE_NAME)-base:$(BASE_TAG) . 22 | 23 | build: 24 | @echo ":::building image" 25 | docker build --rm -f Build.Dockerfile $(BUILD_ARGS) -t $(IMAGE_NAME):$(BASE_TAG) . 26 | 27 | build-test: 28 | @echo ":::building test image" 29 | docker build --rm -f Test.Dockerfile $(BUILD_TEST_ARGS) -t $(IMAGE_NAME)-test:$(BASE_TAG) . 30 | 31 | test-unit: 32 | @echo ":::running unit tests" 33 | docker run --rm -i -v $(shell pwd)/report:/go/src/${APP_NAME}/report $(IMAGE_NAME)-test:$(BASE_TAG) 34 | 35 | run: 36 | @echo ":::running dev environment" 37 | docker run --rm -it \ 38 | -p $(PORT):80 \ 39 | -v `pwd`:/go/src/$(APP_NAME) \ 40 | -w /go/src/$(APP_NAME) \ 41 | golang:$(GOLANG_TAG) go run app/main.go 42 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Sample Golang app for CI 2 | This sample app is made to help other developers start working with docker and jenkins 3 | 4 | Its a work in progress so any comment and suggestion is well received 5 | 6 | ## Build base image 7 | ``` 8 | make build-base 9 | ``` 10 | 11 | ## Build test image 12 | ``` 13 | make build-test 14 | ``` 15 | 16 | ## Run tests (make build-test first) 17 | ``` 18 | make test-units 19 | ``` 20 | 21 | ## Run project 22 | ``` bash 23 | make run 24 | ``` 25 | default port is 8080 26 | you can change the port using `PORT` argument 27 | > make run PORT=8081 28 | 29 | 38 | 39 | -------------------------------------------------------------------------------- /Test.Dockerfile: -------------------------------------------------------------------------------- 1 | ARG BASE_TAG 2 | ARG IMAGE_NAME 3 | FROM ${IMAGE_NAME}-base:${BASE_TAG} 4 | 5 | RUN go get -u github.com/jstemmer/go-junit-report 6 | 7 | CMD go test ./app/... -v 2>&1 | go-junit-report > report/report.xml -------------------------------------------------------------------------------- /app/handler/handlers.go: -------------------------------------------------------------------------------- 1 | package handler 2 | 3 | import ( 4 | "fmt" 5 | "net/http" 6 | "os" 7 | ) 8 | 9 | // Main Handler 10 | func Main(w http.ResponseWriter, r *http.Request) { 11 | w.WriteHeader(http.StatusOK) 12 | hostname, _ := os.Hostname() 13 | fmt.Fprintf(w, "Hello, World!\nHostname: %s\n", hostname) 14 | } 15 | 16 | // Healthz Handler for monitoring app health 17 | func Healthz(w http.ResponseWriter, r *http.Request) { 18 | w.WriteHeader(http.StatusOK) 19 | fmt.Fprintf(w, "Chilling\n") 20 | } 21 | -------------------------------------------------------------------------------- /app/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "fmt" 5 | "net/http" 6 | "os" 7 | 8 | "webapp/app/handler" 9 | 10 | "github.com/gorilla/handlers" 11 | "github.com/gorilla/mux" 12 | ) 13 | 14 | func main() { 15 | r := mux.NewRouter() 16 | r.HandleFunc("/", handler.Main) 17 | r.HandleFunc("/healthz", handler.Healthz) 18 | 19 | fmt.Println("running server") 20 | if err := http.ListenAndServe(":80", handlers.LoggingHandler(os.Stdout, r)); err != nil { 21 | fmt.Printf("unable to start server. %+v", err) 22 | return 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /app/sample/sample.go: -------------------------------------------------------------------------------- 1 | package sample 2 | 3 | import ( 4 | "fmt" 5 | ) 6 | 7 | func Hi(name string) string { 8 | return fmt.Sprintf("Hi, %s", name) 9 | } 10 | 11 | func Sum(a, b int) int { 12 | return a + b 13 | } 14 | -------------------------------------------------------------------------------- /app/sample/sample_test.go: -------------------------------------------------------------------------------- 1 | package sample_test 2 | 3 | import ( 4 | "testing" 5 | "webapp/app/sample" 6 | ) 7 | 8 | func TestHi(t *testing.T) { 9 | type args struct { 10 | name string 11 | } 12 | tests := []struct { 13 | name string 14 | args args 15 | want string 16 | }{ 17 | { 18 | name: "Test Hi Carlos", 19 | args: args{name: "Carlos"}, 20 | want: "Hi, Carlos", 21 | }, 22 | { 23 | name: "Test Hi Oscar", 24 | args: args{name: "Oscar"}, 25 | want: "Hi, Oscar", 26 | }, 27 | } 28 | for _, tt := range tests { 29 | t.Run(tt.name, func(t *testing.T) { 30 | if got := sample.Hi(tt.args.name); got != tt.want { 31 | t.Errorf("Hi() = %v, want %v", got, tt.want) 32 | } 33 | }) 34 | } 35 | } 36 | 37 | func TestSum(t *testing.T) { 38 | type args struct { 39 | a int 40 | b int 41 | } 42 | tests := []struct { 43 | name string 44 | args args 45 | want int 46 | }{ 47 | { 48 | name: "Test 2 + 3", 49 | args: args{a: 2, b: 3}, 50 | want: 5, 51 | }, 52 | { 53 | name: "Test -2 + 3", 54 | args: args{a: -2, b: 3}, 55 | want: 1, 56 | }, 57 | } 58 | for _, tt := range tests { 59 | t.Run(tt.name, func(t *testing.T) { 60 | if got := sample.Sum(tt.args.a, tt.args.b); got != tt.want { 61 | t.Errorf("Sum() = %v, want %v", got, tt.want) 62 | } 63 | }) 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/charlires/golang-docker-jenkins/960d5a382757c8f4726f8aba4e5af03b3ac9a8f3/docker-compose.yml --------------------------------------------------------------------------------