run: add hello-broken sample

run/hello-broken/.dockerignore

@@ -0,0 +1 @@
+vendor/

run/hello-broken/Dockerfile

@@ -0,0 +1,48 @@
+# Copyright 2019 Google 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
+#
+#    https://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.
+
+# [START run_broken_dockerfile]
+
+# Use the offical Golang image to create a build artifact.
+# This is based on Debian and sets the GOPATH to /go.
+# https://hub.docker.com/_/golang
+FROM golang:1.13 as builder
+
+# Create and change to the app directory.
+WORKDIR /app
+
+# Retrieve application dependencies.
+# This allows the container build to reuse cached dependencies.
+COPY go.* ./
+RUN go mod download
+
+# Copy local code to the container image.
+COPY . ./
+
+# Build the binary.
+RUN CGO_ENABLED=0 GOOS=linux go build -mod=readonly -v -o server
+
+# Use the official Alpine image for a lean production container.
+# https://hub.docker.com/_/alpine
+# https://docs.docker.com/develop/develop-images/multistage-build/#use-multi-stage-builds
+FROM alpine:3
+RUN apk add --no-cache ca-certificates
+
+# Copy the binary to the production image from the builder stage.
+COPY --from=builder /app/server /server
+
+# Run the web service on container startup.
+CMD ["/server"]
+
+# [END run_broken_dockerfile]

run/hello-broken/go.mod

@@ -0,0 +1,3 @@
+module github.com/GoogleCloudPlatform/golang-samples/run/hello-broken
+
+go 1.13

run/hello-broken/main.go

@@ -0,0 +1,80 @@
+// Copyright 2019 Google 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
+//
+//     https://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.
+
+// [START run_broken_service]
+
+// Sample hello-broken demonstrates a difficult to troubleshoot service.
+package main
+
+import (
+	"fmt"
+	"log"
+	"net/http"
+	"os"
+)
+
+func main() {
+	log.Print("hello-broken: service started")
+
+	http.HandleFunc("/", brokenHandler)
+
+	// [END run_broken_service]
+	http.HandleFunc("/improved", improvedHandler)
+
+	// [START run_broken_service]
+
+	port := os.Getenv("PORT")
+	if port == "" {
+		port = "8080"
+		log.Printf("Defaulting to port %s", port)
+	}
+
+	log.Printf("Listening on port %s", port)
+	log.Fatal(http.ListenAndServe(fmt.Sprintf(":%s", port), nil))
+}
+
+func brokenHandler(w http.ResponseWriter, r *http.Request) {
+	log.Print("hello-broken: received request")
+
+	// [START run_broken_service_problem]
+
+	name := os.Getenv("NAME")
+	if name == "" {
+		log.Printf("Missing required server parameter")
+		// The panic stack trace appears in Stackdriver Error Reporting.
+		panic("Missing required server parameter")
+	}
+
+	// [END run_broken_service_problem]
+
+	fmt.Fprintf(w, "Hello %s!\n", name)
+}
+
+// [END run_broken_service]
+
+func improvedHandler(w http.ResponseWriter, r *http.Request) {
+	log.Print("hello-broken: received request")
+
+	// [START run_broken_service_upgrade]
+
+	name := os.Getenv("NAME")
+	if name == "" {
+		name = "World"
+		log.Printf("warning: NAME not set, default to %s", name)
+	}
+
+	// [END run_broken_service_upgrade]
+
+	fmt.Fprintf(w, "Hello %s!\n", name)
+}

run/hello-broken/main_test.go

@@ -0,0 +1,103 @@
+// Copyright 2019 Google 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
+//
+//     https://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 (
+	"net/http"
+	"net/http/httptest"
+	"os"
+	"strings"
+	"testing"
+)
+
+func TestBrokenErrors(t *testing.T) {
+	payload := strings.NewReader("")
+	req := httptest.NewRequest("GET", "/", payload)
+	rr := httptest.NewRecorder()
+
+	os.Setenv("NAME", "")
+
+	defer func() {
+		if r := recover(); r == nil {
+			t.Errorf("brokenHandler: got (no panic), want (panic)")
+		}
+	}()
+	brokenHandler(rr, req)
+}
+
+func TestBrokenHandler(t *testing.T) {
+	tests := []struct {
+		label string
+		name  string
+		want  string
+	}{
+		{
+			label: "<SET>",
+			name:  "Testers",
+			want:  "Hello Testers!\n",
+		},
+	}
+
+	for _, test := range tests {
+		req := httptest.NewRequest("GET", "/", strings.NewReader(""))
+		rr := httptest.NewRecorder()
+
+		os.Setenv("NAME", test.name)
+		improvedHandler(rr, req)
+
+		if code := rr.Result().StatusCode; code != http.StatusOK {
+			t.Errorf("brokenHandler(%s): got (%q), want (%q)", test.label, code, http.StatusOK)
+		}
+
+		if got := rr.Body.String(); test.want != got {
+			t.Errorf("brokenHandler(%s): got (%q), want (%q)", test.label, got, test.want)
+		}
+	}
+}
+
+func TestImprovedHandler(t *testing.T) {
+	tests := []struct {
+		label string
+		name  string
+		want  string
+	}{
+		{
+			label: "<EMPTY>",
+			name:  "",
+			want:  "Hello World!\n",
+		},
+		{
+			label: "<SET>",
+			name:  "Testers",
+			want:  "Hello Testers!\n",
+		},
+	}
+
+	for _, test := range tests {
+		req := httptest.NewRequest("GET", "/", strings.NewReader(""))
+		rr := httptest.NewRecorder()
+
+		os.Setenv("NAME", test.name)
+		improvedHandler(rr, req)
+
+		if code := rr.Result().StatusCode; code != http.StatusOK {
+			t.Errorf("brokenHandler(%s): got (%q), want (%q)", test.label, code, http.StatusOK)
+		}
+
+		if got := rr.Body.String(); test.want != got {
+			t.Errorf("brokenHandler(%s): got (%q), want (%q)", test.label, got, test.want)
+		}
+	}
+}