Initial commit

Author: cgossain

.gcloudignore

@@ -0,0 +1,17 @@
+# This file specifies files that are *not* uploaded to Google Cloud Platform
+# using gcloud. It follows the same syntax as .gitignore, with the addition of
+# "#!include" directives (which insert the entries of the given .gitignore-style
+# file at that point).
+#
+# For more information, run:
+#   $ gcloud topic gcloudignore
+#
+.gcloudignore
+# If you would like to upload your .git directory, .gitignore file or files
+# from your .gitignore file, remove the corresponding line
+# below:
+.git
+.gitignore
+
+node_modules
+.serverless

.gitignore

@@ -0,0 +1,20 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Other
+.DS_Store
+node_modules
+.serverless

README.md

@@ -0,0 +1,96 @@
+# Serverless Google Cloud Functions Golang Template
+
+This template project is designed to be used as a starting point for a Google Cloud Functions project using the Golang runtime and the Serverless Framework.
+
+## Requirements
+
+- Install [Serverless Framework](https://www.serverless.com/framework/docs/getting-started/)
+- Setup you serverless environment to work with GCP by working you way through the Serverless Framework [GCP guides](https://www.serverless.com/framework/docs/providers/google/guide/intro/)
+
+## Usage
+
+Create a new service for each logical microservice you intend to deploy.
+
+Each microservice could be made up of a single or several cloud functions.
+
+### Create a new service
+
+Use the `serverless create` command to download the template into a new project folder:
+
+<pre>
+serverless create --template-url https://github.com/cgossain/serverless-google-cloud-functions-golang-template.git --path <b>mynewservice</b>
+</pre>
+
+### Configure the template
+
+1. Navigate to the template directory and install the Google Cloud Functions Provider Plugin:
+
+<pre>
+cd <b>mynewservice</b> && serverless plugin install --name serverless-google-cloudfunctions
+</pre>
+
+2. Update `go.mod` with your module name. For example:
+
+<pre>
+module github.com/<b>my-gcp-project-name</b>/<b>mynewservice</b>
+
+go 1.13
+</pre>
+
+3. Change the root package name in both `fn.go` adn `fn_test.go` to match you service name:
+
+<pre>
+package <b>mynewservice</b>
+
+...
+</pre>
+
+4. Open `serverless.yml` and update the configuration (i.e. service name, provider details, etc.):
+
+<pre>
+service: <b>mynewservice</b>
+
+provider:
+  name: google
+  runtime: go113
+  project: <b>my-gcp-project-name</b>
+  credentials: ~/.gcloud/keyfile.json # https://www.serverless.com/framework/docs/providers/google/guide/credentials/
+
+plugins:
+  - serverless-google-cloudfunctions
+
+package:
+  exclude:
+    - .gitignore
+    - .git/**
+
+functions:
+  hello:
+    handler: Hello
+    events:
+      - http: path # https://www.serverless.com/framework/docs/providers/google/events/http#http-events
+
+...
+</pre>
+
+5. Take a look at [this guide](https://cloud.google.com/functions/docs/writing#structuring_source_code) for ideas on how to structure your source code for different scenarios:
+
+## Deploy
+
+Run the following command from your service directory to build and deploy all functions:
+
+<pre>
+cd <b>mynewservice</b> && serverless deploy
+</pre>
+
+## Remove Deployment
+
+Run the following command from your service directory to remove the deployment of all functions:
+
+<pre>
+cd <b>mynewservice</b> && serverless remove
+</pre>
+
+## References
+
+1. [Serverless GCP Golang Example](https://github.com/serverless/examples/tree/master/google-golang-simple-http-endpoint)

fn.go

@@ -0,0 +1,14 @@
+package templateService
+
+import (
+	"fmt"
+	"net/http"
+)
+
+func Hello(w http.ResponseWriter, r *http.Request) {
+	name := r.URL.Query().Get("name")
+	if name == "" {
+		name = "someone"
+	}
+	fmt.Fprintf(w, "Hello, %s!", name)
+}

fn_test.go

@@ -0,0 +1,44 @@
+package templateService
+
+import (
+	"io/ioutil"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+)
+
+func TestHello(t *testing.T) {
+	tests := map[string]struct {
+		name       string
+		wantStatus int
+		wantString string
+	}{
+		"name specified":     {"jdoe", http.StatusOK, "Hello, jdoe!"},
+		"name not specified": {"", http.StatusOK, "Hello, someone!"},
+	}
+
+	for name, te := range tests {
+		t.Run(name, func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodGet, "/", nil)
+			q := r.URL.Query()
+			q.Add("name", te.name)
+			r.URL.RawQuery = q.Encode()
+
+			Hello(w, r)
+
+			rw := w.Result()
+			defer rw.Body.Close()
+			if s := rw.StatusCode; s != te.wantStatus {
+				t.Fatalf("got: %d, want: %d", s, te.wantStatus)
+			}
+			b, err := ioutil.ReadAll(rw.Body)
+			if err != nil {
+				t.Fatal("failed to read res body")
+			}
+			if s := string(b); s != te.wantString {
+				t.Fatalf("got: %s, want: %s", s, te.wantString)
+			}
+		})
+	}
+}

go.mod

@@ -0,0 +1,3 @@
+module github.com/project-m45/gcp-golang/myNewService
+
+go 1.13

serverless.yml

@@ -0,0 +1,38 @@
+service: templateservice
+
+provider:
+  name: google
+  runtime: go113
+  project: my-gcp-project-name
+  credentials: ~/.gcloud/keyfile.json
+
+plugins:
+  - serverless-google-cloudfunctions
+
+package:
+  exclude:
+    - .gitignore
+    - .git/**
+
+functions:
+  hello:
+    handler: Hello
+    events:
+      - http: path # https://www.serverless.com/framework/docs/providers/google/events/http#http-events
+  # NOTE: the following uses an "event" event (pubSub event in this case).
+  # Please create the corresponding resources in the Google Cloud
+  # before deploying this service through Serverless
+  #second:
+  #  handler: event
+  #  events:
+  #    - event:
+  #        eventType: providers/cloud.pubsub/eventTypes/topic.publish
+  #        resource: projects/*/topics/my-topic
+# you can define resources, templates etc. the same way you would in a
+# Google Cloud deployment configuration
+#resources:
+#  resources:
+#    - type: storage.v1.bucket
+#      name: my-serverless-service-bucket
+#  imports:
+#    - path: my_template.jinja