├── LICENSE ├── README.md ├── build ├── event └── event.go ├── examples ├── bucket │ ├── README.md │ ├── event.json │ └── main.go ├── http │ ├── README.md │ ├── main.go │ └── request.json └── topic │ ├── README.md │ ├── event.json │ └── main.go ├── main.go └── shim ├── handlers.go └── main.go /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Google Cloud Functions Go 2 | 3 | This project contains a collection of tutorials and hacks for using Go with [Google Cloud Functions](https://cloud.google.com/functions). 4 | 5 | ## Disclaimer 6 | This is not an official Google product (experimental or otherwise), it is just code that happens to be owned by Google. 7 | 8 | ## How it Works 9 | 10 | Google Cloud Functions only supports node.js so shims must be used to wrap calls to Go code. The `cloud-functions-go-shim` binary bridges node.js and Go functions. Each Go function to be executed must be exported from a [Go plugin](https://golang.org/pkg/plugin/). 11 | 12 | > The use of Go plugins limit the runtime environment to Linux. 13 | 14 | ## Install 15 | 16 | [Download](https://github.com/kelseyhightower/google-cloud-functions-go/releases) the `cloud-functions-go` and `cloud-functions-go-shim` binaries and put them in your path. 17 | 18 | ## Usage 19 | 20 | ### Build 21 | 22 | Create a Go plugin holding the function to be executed: 23 | 24 | ``` 25 | go build -buildmode=plugin -o functions.so examples/topic/main.go 26 | ``` 27 | 28 | ### Test 29 | 30 | Use the `cloud-functions-go-shim` to test your function: 31 | 32 | ``` 33 | cat examples/topic/event.json | \ 34 | cloud-functions-go-shim -entry-point F -event-type topic -plugin-path functions.so 35 | ``` 36 | 37 | > Testing only works on Linux; a current limitation of Go plugins. 38 | 39 | ### Package 40 | 41 | The `cloud-functions-go` command is used to package your function along with the necessary shims for execution in the Cloud Functions environment. 42 | 43 | ``` 44 | cloud-functions-go -entry-point F -event-type topic -plugin-path functions.so 45 | ``` 46 | 47 | Output 48 | 49 | ``` 50 | wrote F-topic-1491796383.zip 51 | ``` 52 | 53 | The zip archive containes the following files: 54 | 55 | * index.js - node.js shim that calls out to the `cloud-functions-go-shim` binary 56 | * functions.so - the Go function to be executed 57 | * cloud-functions-go-shim - the shim between node.js and Go 58 | 59 | ### Deploy 60 | 61 | Upload the zip archive and set the function to `F` and the trigger to `topic`. 62 | -------------------------------------------------------------------------------- /build: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | go build -o cloud-functions-go . 4 | go build -o cloud-functions-go-shim ./shim 5 | -------------------------------------------------------------------------------- /event/event.go: -------------------------------------------------------------------------------- 1 | // Copyright 2017 Google Inc. All Rights Reserved. 2 | // Licensed under the Apache License, Version 2.0 (the "License"); 3 | // you may not use this file except in compliance with the License. 4 | // You may obtain a copy of the License at 5 | // http://www.apache.org/licenses/LICENSE-2.0 6 | // Unless required by applicable law or agreed to in writing, software 7 | // distributed under the License is distributed on an "AS IS" BASIS, 8 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 9 | // See the License for the specific language governing permissions and 10 | // limitations under the License. 11 | 12 | package event 13 | 14 | type ObjectChange struct { 15 | Data StorageObject `json:"data"` 16 | EventId string `json:"eventId"` 17 | Timestamp string `json:"timestamp"` 18 | EventType string `json:"eventType"` 19 | Resource string `json:"resource"` 20 | } 21 | 22 | type StorageObject struct { 23 | Kind string `json:"kind"` 24 | ResourceState string `json:"resourceState"` 25 | Id string `json:"id"` 26 | SelfLink string `json:"selfLink"` 27 | Name string `json:"name"` 28 | Bucket string `json:"bucket"` 29 | Generation string `json:"generation"` 30 | Metageneration string `json:"metageneration"` 31 | ContentType string `json:"contentType"` 32 | TimeCreated string `json:"timeCreated"` 33 | Updated string `json:"updated"` 34 | TimeDeleted string `json:"timeDeleted"` 35 | StorageClass string `json:"storageClass"` 36 | Size string `json:"size"` 37 | MD5Hash string `json:"md5Hash"` 38 | MediaLink string `json:"mediaLink"` 39 | CRC32c string `json:"crc32c"` 40 | } 41 | 42 | type TopicPublish struct { 43 | Data PubSubMessage `json:"data"` 44 | EventId string `json:"eventId"` 45 | Timestamp string `json:"timestamp"` 46 | EventType string `json:"eventType"` 47 | Resource string `json:"resource"` 48 | } 49 | 50 | type PubSubMessage struct { 51 | Attributes map[string]string `json:"attributes"` 52 | Data string `json:"data"` 53 | } 54 | 55 | type HTTP struct { 56 | Body string `json:"body"` 57 | Header map[string]string `json:"header"` 58 | Method string `json:"method"` 59 | RemoteAddr string `json:"remote_addr"` 60 | URL string `json:"url"` 61 | } 62 | 63 | type HTTPResponse struct { 64 | Body string `json:"body"` 65 | Header map[string]string `json:"header"` 66 | StatusCode int `json:"status_code"` 67 | } 68 | -------------------------------------------------------------------------------- /examples/bucket/README.md: -------------------------------------------------------------------------------- 1 | # Google Cloud Functions Go: Bucket Example 2 | 3 | ## Usage 4 | 5 | Build the Go plugin: 6 | 7 | ``` 8 | go build -buildmode=plugin -o functions.so main.go 9 | ``` 10 | 11 | Test the function: 12 | 13 | ``` 14 | cat event.json | cloud-functions-go-shim -entry-point F -event-type bucket -plugin-path functions.so 15 | ``` 16 | 17 | Create the Cloud Function zip archive: 18 | 19 | ``` 20 | cloud-functions-go -entry-point F -event-type bucket -plugin-path functions.so 21 | ``` 22 | 23 | ``` 24 | wrote F-bucket-1491804101.zip 25 | ``` 26 | 27 | Use the Cloud Functions UI to deploy the fuction from a `ZIP upload`, set the fuction to execute to `F`, and the trigger to `Cloud Storage bucket`. 28 | -------------------------------------------------------------------------------- /examples/bucket/event.json: -------------------------------------------------------------------------------- 1 | { 2 | "timestamp":"2017-04-10T02:08:41.559Z", 3 | "eventType":"providers/cloud.storage/eventTypes/object.change", 4 | "resource":"projects/_/buckets/cloudfunctionstest/objects/go-serverless.zip#1491782113967685", 5 | "data":{ 6 | "kind":"storage#object", 7 | "resourceState":"not_exists", 8 | "id":"cloudfunctionstest/go-serverless.zip/1491782113967685", 9 | "selfLink":"https://www.googleapis.com/storage/v1/b/cloudfunctionstest/o/go-serverless.zip", 10 | "name":"go-serverless.zip", 11 | "bucket":"cloudfunctionstest", 12 | "generation":"1491782113967685", 13 | "metageneration":"1", 14 | "contentType":"application/zip", 15 | "timeCreated":"2017-04-09T23:55:13.947Z", 16 | "updated":"2017-04-09T23:55:13.947Z", 17 | "timeDeleted":"2017-04-10T02:08:41.559Z", 18 | "storageClass":"REGIONAL", 19 | "size":"12669466", 20 | "md5Hash":"NDg1NDgzN2EyYzZmMjEwYWU4ZGQ3MzE3OGI3MTE1OTI=", 21 | "mediaLink":"https://www.googleapis.com/storage/v1/b/cloudfunctionstest/o/go-serverless.zip?generation=1491782113967685&alt=media", 22 | "crc32c":"SsHDlA==" 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /examples/bucket/main.go: -------------------------------------------------------------------------------- 1 | // Copyright 2017 Google Inc. All Rights Reserved. 2 | // Licensed under the Apache License, Version 2.0 (the "License"); 3 | // you may not use this file except in compliance with the License. 4 | // You may obtain a copy of the License at 5 | // http://www.apache.org/licenses/LICENSE-2.0 6 | // Unless required by applicable law or agreed to in writing, software 7 | // distributed under the License is distributed on an "AS IS" BASIS, 8 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 9 | // See the License for the specific language governing permissions and 10 | // limitations under the License. 11 | 12 | package main 13 | 14 | import ( 15 | "log" 16 | 17 | "github.com/kelseyhightower/google-cloud-functions-go/event" 18 | ) 19 | 20 | func F(e event.ObjectChange) (string, error) { 21 | log.SetFlags(0) 22 | 23 | log.Printf("processing object: %s", e.Data.Id) 24 | log.Printf("bucket: %s", e.Data.Bucket) 25 | log.Printf("filename: %s", e.Data.Name) 26 | log.Printf("resource state: %s", e.Data.ResourceState) 27 | 28 | return "", nil 29 | } 30 | -------------------------------------------------------------------------------- /examples/http/README.md: -------------------------------------------------------------------------------- 1 | # Google Cloud Functions Go: HTTP Example 2 | 3 | ## Usage 4 | 5 | Build the Go plugin: 6 | 7 | ``` 8 | go build -buildmode=plugin -o functions.so main.go 9 | ``` 10 | 11 | Test the function: 12 | 13 | ``` 14 | cat request.json | cloud-functions-go-shim -entry-point F -event-type http -plugin-path functions.so 15 | ``` 16 | 17 | > {"body":"{\"message\":\"Go Serverless!\"}\n","header":{"Content-Type":"text/plain; charset=utf-8"},"status_code":200} 18 | 19 | Create the Cloud Function zip archive: 20 | 21 | ``` 22 | cloud-functions-go -entry-point F -event-type http -plugin-path functions.so 23 | ``` 24 | 25 | Use the Cloud Functions UI to deploy the fuction from a `ZIP upload`, set the fuction to execute to `F`, and the trigger to `HTTP trigger`. 26 | 27 | Once the function is deployed [invoke it with an HTTP trigger](https://cloud.google.com/functions/docs/calling/http) 28 | 29 | Example: 30 | 31 | ``` 32 | curl -X POST https://us-central1-cloud-functions-go.cloudfunctions.net/http-test \ 33 | -H "Content-Type: text/plain" \ 34 | --data 'Go Serverless!' 35 | ``` 36 | ``` 37 | {"message":"Go Serverless!"} 38 | ``` 39 | -------------------------------------------------------------------------------- /examples/http/main.go: -------------------------------------------------------------------------------- 1 | // Copyright 2016 Google Inc. All Rights Reserved. 2 | // Licensed under the Apache License, Version 2.0 (the "License"); 3 | // you may not use this file except in compliance with the License. 4 | // You may obtain a copy of the License at 5 | // http://www.apache.org/licenses/LICENSE-2.0 6 | // Unless required by applicable law or agreed to in writing, software 7 | // distributed under the License is distributed on an "AS IS" BASIS, 8 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 9 | // See the License for the specific language governing permissions and 10 | // limitations under the License. 11 | 12 | package main 13 | 14 | import ( 15 | "encoding/json" 16 | "io/ioutil" 17 | "net/http" 18 | ) 19 | 20 | type response struct { 21 | Message string `json:"message"` 22 | } 23 | 24 | func F(w http.ResponseWriter, r *http.Request) { 25 | d, err := ioutil.ReadAll(r.Body) 26 | if err != nil { 27 | w.WriteHeader(500) 28 | return 29 | } 30 | if err := json.NewEncoder(w).Encode(response{Message: string(d)}); err != nil { 31 | w.WriteHeader(500) 32 | return 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /examples/http/request.json: -------------------------------------------------------------------------------- 1 | { 2 | "body": "Go Serverless!", 3 | "header": {"agent": "Go"}, 4 | "method": "GET", 5 | "remote_addr": "127.0.0.1", 6 | "url": "http://127.0.0.1:80" 7 | } 8 | -------------------------------------------------------------------------------- /examples/topic/README.md: -------------------------------------------------------------------------------- 1 | # Google Cloud Functions Go: Topic Example 2 | 3 | ## Usage 4 | 5 | Build the Go plugin: 6 | 7 | ``` 8 | go build -buildmode=plugin -o functions.so main.go 9 | ``` 10 | 11 | Test the function: 12 | 13 | ``` 14 | cat event.json | cloud-functions-go-shim -entry-point F -event-type topic -plugin-path functions.so 15 | ``` 16 | 17 | Create the Cloud Function zip archive: 18 | 19 | ``` 20 | cloud-functions-go -entry-point F -event-type topic -plugin-path functions.so 21 | ``` 22 | 23 | ``` 24 | wrote F-topic-1491763297.zip 25 | ``` 26 | 27 | Use the Cloud Functions UI to deploy the fuction from a `ZIP upload`, set the fuction to execute to `F`, and the trigger to `Cloud Pub/Sub topic`. 28 | -------------------------------------------------------------------------------- /examples/topic/event.json: -------------------------------------------------------------------------------- 1 | { 2 | "eventId":"91625316029748", 3 | "timestamp":"2017-04-10T01:53:56.293Z", 4 | "eventType":"providers/cloud.pubsub/eventTypes/topic.publish", 5 | "resource":"projects/kubestack/topics/functions", 6 | "data":{ 7 | "data":"dGVzdA==", 8 | "attributes":{ 9 | "age":"22" 10 | }, 11 | "@type":"type.googleapis.com/google.pubsub.v1.PubsubMessage" 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /examples/topic/main.go: -------------------------------------------------------------------------------- 1 | // Copyright 2017 Google Inc. All Rights Reserved. 2 | // Licensed under the Apache License, Version 2.0 (the "License"); 3 | // you may not use this file except in compliance with the License. 4 | // You may obtain a copy of the License at 5 | // http://www.apache.org/licenses/LICENSE-2.0 6 | // Unless required by applicable law or agreed to in writing, software 7 | // distributed under the License is distributed on an "AS IS" BASIS, 8 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 9 | // See the License for the specific language governing permissions and 10 | // limitations under the License. 11 | 12 | package main 13 | 14 | import ( 15 | "encoding/base64" 16 | "fmt" 17 | "log" 18 | 19 | "github.com/kelseyhightower/google-cloud-functions-go/event" 20 | ) 21 | 22 | func F(e event.TopicPublish) (string, error) { 23 | log.SetFlags(0) 24 | 25 | log.Printf("processing event: %s", e.EventId) 26 | 27 | data, err := base64.StdEncoding.DecodeString(e.Data.Data) 28 | if err != nil { 29 | return "", fmt.Errorf("unable to decode message data: %s", err) 30 | } 31 | 32 | log.Printf("message data: %s", string(data)) 33 | 34 | return "", nil 35 | } 36 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | // Copyright 2017 Google Inc. All Rights Reserved. 2 | // Licensed under the Apache License, Version 2.0 (the "License"); 3 | // you may not use this file except in compliance with the License. 4 | // You may obtain a copy of the License at 5 | // http://www.apache.org/licenses/LICENSE-2.0 6 | // Unless required by applicable law or agreed to in writing, software 7 | // distributed under the License is distributed on an "AS IS" BASIS, 8 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 9 | // See the License for the specific language governing permissions and 10 | // limitations under the License. 11 | 12 | package main 13 | 14 | import ( 15 | "archive/zip" 16 | "flag" 17 | "fmt" 18 | "html/template" 19 | "io" 20 | "log" 21 | "os" 22 | "os/exec" 23 | "path" 24 | "time" 25 | ) 26 | 27 | var ( 28 | entryPoint string 29 | eventType string 30 | outputFilename string 31 | pluginPath string 32 | shimPath string 33 | ) 34 | 35 | func generateOutputFilename() string { 36 | return fmt.Sprintf("%s-%s-%d.zip", entryPoint, eventType, time.Now().Unix()) 37 | } 38 | 39 | func main() { 40 | flag.StringVar(&entryPoint, "entry-point", "F", "the name of a Go function that will be executed when the Cloud Function is triggered.") 41 | flag.StringVar(&eventType, "event-type", "event", "The Cloud Function event type. (bucket, http, or topic)") 42 | flag.StringVar(&outputFilename, "o", "", "The output file name.") 43 | flag.StringVar(&pluginPath, "plugin-path", "functions.so", "The path to the Go plugin that exports the function to be executed.") 44 | flag.StringVar(&shimPath, "shim-path", "cloud-functions-go-shim", "The path to the cloud-functions-go-shim binary.") 45 | flag.Parse() 46 | 47 | if outputFilename == "" { 48 | outputFilename = generateOutputFilename() 49 | } 50 | 51 | // Set the log format to basic to omit timestamps. 52 | log.SetFlags(0) 53 | 54 | var err error 55 | 56 | shimPath, err = exec.LookPath(shimPath) 57 | if err != nil { 58 | log.Fatalf("unable to locate the cloud-functions-go-shim binary: %s", err) 59 | } 60 | 61 | zipfile, err := os.Create(outputFilename) 62 | if err != nil { 63 | log.Fatalf("unable to create %s: %s", outputFilename, err) 64 | } 65 | defer zipfile.Close() 66 | 67 | archive := zip.NewWriter(zipfile) 68 | 69 | // Add the index.js file to the zip archive. 70 | 71 | // Generate the node.js shim based on the event type. 72 | nodejsShim, err := archive.Create("index.js") 73 | if err != nil { 74 | log.Fatalf("unable to generate the node.js shim: %s", err) 75 | } 76 | 77 | var tmpl string 78 | 79 | switch eventType { 80 | case "topic": 81 | tmpl = nodejsEventTemplate 82 | case "bucket": 83 | tmpl = nodejsEventTemplate 84 | case "http": 85 | tmpl = nodejsHTTPTemplate 86 | } 87 | 88 | t, err := template.New("index.js").Parse(tmpl) 89 | if err != nil { 90 | log.Fatalf("unable to generated the node.js shim: %s", err) 91 | } 92 | 93 | data := struct { 94 | EntryPoint string 95 | EventType string 96 | PluginPath string 97 | }{ 98 | EntryPoint: entryPoint, 99 | EventType: eventType, 100 | PluginPath: path.Base(pluginPath), 101 | } 102 | 103 | t.Execute(nodejsShim, data) 104 | 105 | // Add the Go plugin to the zip archive. 106 | functions, err := archive.Create(path.Base(pluginPath)) 107 | if err != nil { 108 | log.Fatalf("unable to create %s: %s", outputFilename, err) 109 | } 110 | 111 | p, err := os.Open(pluginPath) 112 | if err != nil { 113 | log.Fatalf("unable to create %s: %s", outputFilename, err) 114 | } 115 | defer p.Close() 116 | 117 | _, err = io.Copy(functions, p) 118 | if err != nil { 119 | log.Fatalf("unable to create %s: %s", outputFilename, err) 120 | } 121 | 122 | // Add the cloud-functions-go-shim binary to the zip archive. 123 | shimFile, err := os.Open(shimPath) 124 | if err != nil { 125 | log.Fatalf("unable to create %s: %s", outputFilename, err) 126 | } 127 | defer shimFile.Close() 128 | 129 | shimInfo, err := shimFile.Stat() 130 | if err != nil { 131 | log.Fatalf("unable to create %s: %s", outputFilename, err) 132 | } 133 | 134 | shimHeader, err := zip.FileInfoHeader(shimInfo) 135 | if err != nil { 136 | log.Fatalf("unable to create %s: %s", outputFilename, err) 137 | } 138 | shimHeader.Name = "cloud-functions-go-shim" 139 | 140 | shim, err := archive.CreateHeader(shimHeader) 141 | if err != nil { 142 | log.Fatalf("unable to create %s: %s", outputFilename, err) 143 | } 144 | 145 | _, err = io.Copy(shim, shimFile) 146 | if err != nil { 147 | log.Fatalf("unable to create %s: %s", outputFilename, err) 148 | } 149 | 150 | err = archive.Close() 151 | if err != nil { 152 | log.Fatalf("unable to create %s: %s", outputFilename, err) 153 | } 154 | 155 | fmt.Printf("wrote %s\n", outputFilename) 156 | 157 | os.Exit(0) 158 | } 159 | 160 | const nodejsEventTemplate = `const spawnSync = require('child_process').spawnSync; 161 | 162 | exports.{{.EntryPoint}} = function {{.EntryPoint}}(event, callback) { 163 | var args = [ 164 | '--entry-point', '{{.EntryPoint}}', 165 | '--event-type', '{{.EventType}}', 166 | '--plugin-path', '{{.PluginPath}}' 167 | ]; 168 | 169 | result = spawnSync('./cloud-functions-go-shim', args, { 170 | input: JSON.stringify(event), 171 | stdio: 'pipe', 172 | }); 173 | 174 | console.log(result.stderr.toString()); 175 | 176 | if (result.status !== 0) { 177 | callback(new Error(result.stderr.toString())); 178 | return; 179 | } else { 180 | callback(null, result.stdout.toString()); 181 | } 182 | }; 183 | ` 184 | 185 | const nodejsHTTPTemplate = `const spawnSync = require('child_process').spawnSync; 186 | 187 | exports.{{.EntryPoint}} = function {{.EntryPoint}}(req, res) { 188 | var requestBody; 189 | 190 | switch (req.get('content-type')) { 191 | case 'application/json': 192 | requestBody = JSON.stringify(req.body); 193 | break; 194 | case 'application/octet-stream': 195 | requestBody = req.body; 196 | break; 197 | case 'text/plain': 198 | requestBody = req.body; 199 | break; 200 | } 201 | 202 | var fullUrl = req.protocol + '://' + req.get('host') + req.originalUrl; 203 | var httpRequest = { 204 | 'body': requestBody, 205 | 'header': req.headers, 206 | 'method': req.method, 207 | 'remote_addr': req.ip, 208 | 'url': fullUrl 209 | }; 210 | 211 | var args = [ 212 | '--entry-point', '{{.EntryPoint}}', 213 | '--event-type', '{{.EventType}}', 214 | '--plugin-path', '{{.PluginPath}}' 215 | ]; 216 | 217 | result = spawnSync('./cloud-functions-go-shim', args, { 218 | input: JSON.stringify(httpRequest), 219 | stdio: 'pipe', 220 | }); 221 | 222 | if (result.status !== 0) { 223 | console.log(result.stderr.toString()); 224 | res.status(500); 225 | return; 226 | } 227 | 228 | data = JSON.parse(result.stdout); 229 | res.status(data.status_code); 230 | res.send(data.body); 231 | }; 232 | ` 233 | -------------------------------------------------------------------------------- /shim/handlers.go: -------------------------------------------------------------------------------- 1 | // Copyright 2017 Google Inc. All Rights Reserved. 2 | // Licensed under the Apache License, Version 2.0 (the "License"); 3 | // you may not use this file except in compliance with the License. 4 | // You may obtain a copy of the License at 5 | // http://www.apache.org/licenses/LICENSE-2.0 6 | // Unless required by applicable law or agreed to in writing, software 7 | // distributed under the License is distributed on an "AS IS" BASIS, 8 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 9 | // See the License for the specific language governing permissions and 10 | // limitations under the License. 11 | 12 | package main 13 | 14 | import ( 15 | "bytes" 16 | "encoding/json" 17 | "fmt" 18 | "net/http" 19 | "net/http/httptest" 20 | "plugin" 21 | "strings" 22 | 23 | "github.com/kelseyhightower/google-cloud-functions-go/event" 24 | ) 25 | 26 | func objectChangeHandler(f plugin.Symbol, data []byte) (string, error) { 27 | var e event.ObjectChange 28 | var message string 29 | 30 | err := json.Unmarshal(data, &e) 31 | if err != nil { 32 | return "", fmt.Errorf("unable to load the event: %s", err) 33 | } 34 | 35 | message, err = f.(func(event.ObjectChange) (string, error))(e) 36 | if err != nil { 37 | return "", err 38 | } 39 | 40 | return message, nil 41 | } 42 | 43 | func topicPublishHandler(f plugin.Symbol, data []byte) (string, error) { 44 | var e event.TopicPublish 45 | var message string 46 | 47 | err := json.Unmarshal(data, &e) 48 | if err != nil { 49 | return "", fmt.Errorf("unable to load the event: %s", err) 50 | } 51 | 52 | message, err = f.(func(event.TopicPublish) (string, error))(e) 53 | if err != nil { 54 | return "", err 55 | } 56 | 57 | return message, nil 58 | } 59 | 60 | func httpHandler(f plugin.Symbol, data []byte) (string, error) { 61 | var httpRequest event.HTTP 62 | 63 | err := json.Unmarshal(data, &httpRequest) 64 | if err != nil { 65 | return "", fmt.Errorf("unable to load the event: %s", err) 66 | } 67 | 68 | r := httptest.NewRequest(httpRequest.Method, httpRequest.URL, bytes.NewBufferString(httpRequest.Body)) 69 | for k, v := range httpRequest.Header { 70 | r.Header.Add(k, v) 71 | } 72 | 73 | r.RemoteAddr = httpRequest.RemoteAddr 74 | 75 | w := httptest.NewRecorder() 76 | 77 | f.(func(http.ResponseWriter, *http.Request))(w, r) 78 | 79 | resp := w.Result() 80 | 81 | header := make(map[string]string) 82 | for k, v := range resp.Header { 83 | header[k] = strings.Join(v, ",") 84 | } 85 | 86 | out, err := json.Marshal(&event.HTTPResponse{ 87 | Body: w.Body.String(), 88 | Header: header, 89 | StatusCode: resp.StatusCode, 90 | }) 91 | 92 | if err != nil { 93 | return "", err 94 | } 95 | 96 | return string(out), nil 97 | } 98 | -------------------------------------------------------------------------------- /shim/main.go: -------------------------------------------------------------------------------- 1 | // Copyright 2017 Google Inc. All Rights Reserved. 2 | // Licensed under the Apache License, Version 2.0 (the "License"); 3 | // you may not use this file except in compliance with the License. 4 | // You may obtain a copy of the License at 5 | // http://www.apache.org/licenses/LICENSE-2.0 6 | // Unless required by applicable law or agreed to in writing, software 7 | // distributed under the License is distributed on an "AS IS" BASIS, 8 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 9 | // See the License for the specific language governing permissions and 10 | // limitations under the License. 11 | 12 | package main 13 | 14 | import ( 15 | "flag" 16 | "io/ioutil" 17 | "log" 18 | "os" 19 | "plugin" 20 | ) 21 | 22 | var ( 23 | entryPoint string 24 | eventType string 25 | pluginPath string 26 | ) 27 | 28 | func main() { 29 | flag.StringVar(&entryPoint, "entry-point", "F", "the name of a Go function that will be executed when the Cloud Function is triggered.") 30 | flag.StringVar(&eventType, "event-type", "", "The Cloud Function event type. (bucket, http, or topic)") 31 | flag.StringVar(&pluginPath, "plugin-path", "functions.so", "The path to the Go plugin that exports the function to be executed.") 32 | flag.Parse() 33 | 34 | if eventType == "" { 35 | log.Fatal("Event type required; set using the --event-type flag.") 36 | } 37 | 38 | p, err := plugin.Open(pluginPath) 39 | if err != nil { 40 | log.Fatalf("unable to load the Go plugin: %s", err) 41 | } 42 | 43 | f, err := p.Lookup(entryPoint) 44 | if err != nil { 45 | log.Fatalf("unable to load the entrypoint function: %s", err) 46 | } 47 | 48 | stdin, err := ioutil.ReadAll(os.Stdin) 49 | if err != nil { 50 | log.Fatalf("unable to load the event: %s", err) 51 | } 52 | 53 | var message string 54 | 55 | switch eventType { 56 | case "bucket": 57 | message, err = objectChangeHandler(f, stdin) 58 | case "http": 59 | message, err = httpHandler(f, stdin) 60 | case "topic": 61 | message, err = topicPublishHandler(f, stdin) 62 | default: 63 | log.Fatalf("invalid event type: %s", eventType) 64 | } 65 | 66 | if err != nil { 67 | log.Fatal(err) 68 | } 69 | 70 | if message != "" { 71 | os.Stdout.WriteString(message) 72 | } 73 | 74 | os.Exit(0) 75 | } 76 | --------------------------------------------------------------------------------