5 |
6 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Code of Conduct
2 |
3 | This project is covered under the [Go Code of Conduct][]. In summary:
4 |
5 | - Treat everyone with respect and kindness.
6 | - Be thoughtful in how you communicate.
7 | - Don’t be destructive or inflammatory.
8 | - If you encounter an issue, please mail conduct@golang.org.
9 |
10 | [Go Code of Conduct]: https://golang.org/conduct
11 |
--------------------------------------------------------------------------------
/internal/website/layouts/_default/list.html:
--------------------------------------------------------------------------------
1 | {{ define "main" -}}
2 |
18 |
19 |
30 |
31 |
32 |
--------------------------------------------------------------------------------
/docstore/mongodocstore/localmongo.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | # Copyright 2019 The Go Cloud Development Kit Authors
3 | #
4 | # Licensed under the Apache License, Version 2.0 (the "License");
5 | # you may not use this file except in compliance with the License.
6 | # You may obtain a copy of the License at
7 | #
8 | # https://www.apache.org/licenses/LICENSE-2.0
9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 |
16 | # Starts two local MongoDB instances (v3 and v4) via Docker listening on two
17 | # different ports.
18 |
19 | # https://coderwall.com/p/fkfaqq/safer-bash-scripts-with-set-euxo-pipefail
20 | set -euo pipefail
21 |
22 | echo "Starting MongoDB v4 listening on 27017..."
23 | docker rm -f mongo4 &> /dev/null || :
24 | docker run -d --name mongo4 -p 27017:27017 mongo:4 &> /dev/null
25 | echo "...done. Run \"docker rm -f mongo4\" to clean up the container."
26 | echo
27 |
28 | echo "Starting MongoDB v3 listening on 27018..."
29 | docker rm -f mongo3 &> /dev/null || :
30 | docker run -d --name mongo3 -p 27018:27017 mongo:3 &> /dev/null
31 | echo "...done. Run \"docker rm -f mongo3\" to clean up the container."
32 | echo
33 |
34 |
--------------------------------------------------------------------------------
/samples/appengine/helloworld.go:
--------------------------------------------------------------------------------
1 | // Copyright 2018 The Go Cloud Development Kit Authors
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // A simple "hello world" application using server.Server, to be run on
16 | // Google App Engine (GAE).
17 | package main
18 |
19 | import (
20 | "fmt"
21 | "log"
22 | "net/http"
23 | "os"
24 |
25 | "github.com/gorilla/mux"
26 | "gocloud.dev/server"
27 | )
28 |
29 | func main() {
30 | r := mux.NewRouter()
31 | r.HandleFunc("/", handle)
32 |
33 | port := os.Getenv("PORT")
34 | if port == "" {
35 | port = "8080"
36 | }
37 | srv := server.New(r, nil)
38 | log.Printf("Listening on port %s", port)
39 | log.Fatal(srv.ListenAndServe(fmt.Sprintf(":%s", port)))
40 | }
41 |
42 | func handle(w http.ResponseWriter, r *http.Request) {
43 | if r.URL.Path != "/" {
44 | http.NotFound(w, r)
45 | return
46 | }
47 | fmt.Fprint(w, "Hello world!")
48 | }
49 |
--------------------------------------------------------------------------------
/internal/testing/listdeps.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | # Copyright 2019 The Go Cloud Development Kit Authors
3 | #
4 | # Licensed under the Apache License, Version 2.0 (the "License");
5 | # you may not use this file except in compliance with the License.
6 | # You may obtain a copy of the License at
7 | #
8 | # https://www.apache.org/licenses/LICENSE-2.0
9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 |
16 | set -euo pipefail
17 |
18 | # To run this script manually to update alldeps:
19 | #
20 | # $ internal/testing/listdeps.sh > internal/testing/alldeps
21 | #
22 | # Make sure to use the same version of Go as used by tests
23 | # (see .github/actions/tests.yml) when updating the alldeps file.
24 | tmpfile=$(mktemp)
25 | function cleanup() {
26 | rm -rf "$tmpfile"
27 | }
28 | trap cleanup EXIT
29 |
30 |
31 | sed -e '/^#/d' -e '/^$/d' allmodules | awk '{print $1}' | while read -r path || [[ -n "$path" ]]; do
32 | ( cd "$path" && go list -mod=readonly -deps -f '{{with .Module}}{{.Path}}{{end}}' ./... >> "$tmpfile")
33 | done
34 |
35 | # Sort using the native byte values to keep results from different environment consistent.
36 | LC_ALL=C sort "$tmpfile" | uniq
37 |
--------------------------------------------------------------------------------
/samples/order/order-form.htmlt:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Create Order - Go CDK Image Conversion Sample
6 |
7 |
8 |
9 |
10 |
11 |
15 |
32 |
33 |
34 |
35 |
--------------------------------------------------------------------------------
/mysql/gcpmysql/example_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2018 The Go Cloud Development Kit Authors
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package gcpmysql_test
16 |
17 | import (
18 | "context"
19 | "log"
20 |
21 | "gocloud.dev/mysql"
22 | _ "gocloud.dev/mysql/gcpmysql"
23 | )
24 |
25 | func Example() {
26 | // PRAGMA: This example is used on gocloud.dev; PRAGMA comments adjust how it is shown and can be ignored.
27 | // PRAGMA: On gocloud.dev, add a blank import: _ "gocloud.dev/mysql/gcpmysql"
28 | // PRAGMA: On gocloud.dev, hide lines until the next blank line.
29 | ctx := context.Background()
30 |
31 | // Replace this with your actual settings.
32 | db, err := mysql.Open(ctx,
33 | "gcpmysql://user:password@example-project/region/my-instance01/testdb")
34 | if err != nil {
35 | log.Fatal(err)
36 | }
37 | defer db.Close()
38 |
39 | // Use database in your program.
40 | db.Exec("CREATE TABLE foo (bar INT);")
41 | }
42 |
--------------------------------------------------------------------------------
/mysql/azuremysql/example_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 The Go Cloud Development Kit Authors
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package azuremysql_test
16 |
17 | import (
18 | "context"
19 | "log"
20 |
21 | "gocloud.dev/mysql"
22 | _ "gocloud.dev/mysql/azuremysql"
23 | )
24 |
25 | func Example() {
26 | // PRAGMA: This example is used on gocloud.dev; PRAGMA comments adjust how it is shown and can be ignored.
27 | // PRAGMA: On gocloud.dev, add a blank import: _ "gocloud.dev/mysql/azuremysql"
28 | // PRAGMA: On gocloud.dev, hide lines until the next blank line.
29 | ctx := context.Background()
30 |
31 | // Replace this with your actual settings.
32 | db, err := mysql.Open(ctx,
33 | "azuremysql://user:password@example00.mysql.database.azure.com/testdb")
34 | if err != nil {
35 | log.Fatal(err)
36 | }
37 | defer db.Close()
38 |
39 | // Use database in your program.
40 | db.Exec("CREATE TABLE foo (bar INT);")
41 | }
42 |
--------------------------------------------------------------------------------
/samples/gocdk-blob/main_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 The Go Cloud Development Kit Authors
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package main
16 |
17 | import (
18 | "flag"
19 | "os"
20 | "path/filepath"
21 | "strings"
22 | "testing"
23 |
24 | "github.com/google/go-cmdtest"
25 | )
26 |
27 | var update = flag.Bool("update", false, "replace test file contents with output")
28 |
29 | func Test(t *testing.T) {
30 | ts, err := cmdtest.Read(".")
31 | if err != nil {
32 | t.Fatal(err)
33 | }
34 | ts.Commands["gocdk-blob"] = cmdtest.InProcessProgram("gocdk-blob", run)
35 | ts.Setup = func(rootdir string) error {
36 | // On Windows, convert "\" to "/" and add a leading "/":
37 | slashdir := filepath.ToSlash(rootdir)
38 | if os.PathSeparator != '/' && !strings.HasPrefix(slashdir, "/") {
39 | slashdir = "/" + slashdir
40 | }
41 | return os.Setenv("ROOTDIR_URL", "file://"+slashdir)
42 | }
43 | ts.Run(t, *update)
44 | }
45 |
--------------------------------------------------------------------------------
/samples/gocdk-docstore/docstore.ct:
--------------------------------------------------------------------------------
1 | # Copyright 2019 The Go Cloud Development Kit Authors
2 | #
3 | # Licensed under the Apache License, Version 2.0 (the "License");
4 | # you may not use this file except in compliance with the License.
5 | # You may obtain a copy of the License at
6 | #
7 | # https://www.apache.org/licenses/LICENSE-2.0
8 | #
9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 |
15 | # Tests of the gocdk-doctore program.
16 |
17 | $ setenv url mem://sample-coll/ID?filename=save
18 |
19 | # Collection is initially empty.
20 | $ gocdk-docstore ls ${url}
21 |
22 | $ gocdk-docstore put -d 2019-05-01 -id first ${url} message1
23 | Put message: first 2019-05-01: message1
24 |
25 | $ gocdk-docstore ls -d 2019-05-01 ${url}
26 | first 2019-05-01: message1
27 |
28 | $ gocdk-docstore put -d 2019-05-02 -id second ${url} message2
29 | $ gocdk-docstore ls -d 2019-05-02 ${url}
30 | Put message: second 2019-05-02: message2
31 | second 2019-05-02: message2
32 |
33 | $ gocdk-docstore update first ${url} new-message
34 | updated: first 2019-05-01: new-message
35 |
36 |
37 | # Delete everything.
38 | $ gocdk-docstore delete ${url}
39 |
40 | # Collection is empty again.
41 | $ gocdk-docstore ls ${url}
42 |
43 |
44 |
45 |
--------------------------------------------------------------------------------
/mysql/awsmysql/example_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2018 The Go Cloud Development Kit Authors
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package awsmysql_test
16 |
17 | import (
18 | "context"
19 | "log"
20 |
21 | "gocloud.dev/mysql"
22 | _ "gocloud.dev/mysql/awsmysql"
23 | )
24 |
25 | func Example() {
26 | // PRAGMA: This example is used on gocloud.dev; PRAGMA comments adjust how it is shown and can be ignored.
27 | // PRAGMA: On gocloud.dev, add a blank import: _ "gocloud.dev/mysql/awsmysql"
28 | // PRAGMA: On gocloud.dev, hide lines until the next blank line.
29 | ctx := context.Background()
30 |
31 | // Replace these with your actual settings.
32 | db, err := mysql.Open(ctx,
33 | "awsmysql://myrole:swordfish@example01.xyzzy.us-west-1.rds.amazonaws.com/testdb")
34 | if err != nil {
35 | log.Fatal(err)
36 | }
37 | defer db.Close()
38 |
39 | // Use database in your program.
40 | db.ExecContext(ctx, "CREATE TABLE foo (bar INT);")
41 | }
42 |
--------------------------------------------------------------------------------
/postgres/gcppostgres/example_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2018 The Go Cloud Development Kit Authors
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package gcppostgres_test
16 |
17 | import (
18 | "context"
19 | "log"
20 |
21 | "gocloud.dev/postgres"
22 | _ "gocloud.dev/postgres/gcppostgres"
23 | )
24 |
25 | func Example() {
26 | // PRAGMA: This example is used on gocloud.dev; PRAGMA comments adjust how it is shown and can be ignored.
27 | // PRAGMA: On gocloud.dev, add a blank import: _ "gocloud.dev/postgres/gcppostgres"
28 | // PRAGMA: On gocloud.dev, hide lines until the next blank line.
29 | ctx := context.Background()
30 |
31 | // Replace this with your actual settings.
32 | db, err := postgres.Open(ctx,
33 | "gcppostgres://user:password@example-project/region/my-instance01/testdb")
34 | if err != nil {
35 | log.Fatal(err)
36 | }
37 | defer db.Close()
38 |
39 | // Use database in your program.
40 | db.Exec("CREATE TABLE foo (bar INT);")
41 | }
42 |
--------------------------------------------------------------------------------
/postgres/awspostgres/example_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 The Go Cloud Development Kit Authors
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package awspostgres_test
16 |
17 | import (
18 | "context"
19 | "log"
20 |
21 | "gocloud.dev/postgres"
22 | _ "gocloud.dev/postgres/awspostgres"
23 | )
24 |
25 | func Example() {
26 | // PRAGMA: This example is used on gocloud.dev; PRAGMA comments adjust how it is shown and can be ignored.
27 | // PRAGMA: On gocloud.dev, add a blank import: _ "gocloud.dev/postgres/awspostgres"
28 | // PRAGMA: On gocloud.dev, hide lines until the next blank line.
29 | ctx := context.Background()
30 |
31 | // Replace these with your actual settings.
32 | db, err := postgres.Open(ctx,
33 | "awspostgres://myrole:swordfish@example01.xyzzy.us-west-1.rds.amazonaws.com/testdb")
34 | if err != nil {
35 | log.Fatal(err)
36 | }
37 | defer db.Close()
38 |
39 | // Use database in your program.
40 | db.ExecContext(ctx, "CREATE TABLE foo (bar INT);")
41 | }
42 |
--------------------------------------------------------------------------------
/internal/testing/git_tag_modules.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | # Copyright 2021 The Go Cloud Development Kit Authors
3 | #
4 | # Licensed under the Apache License, Version 2.0 (the "License");
5 | # you may not use this file except in compliance with the License.
6 | # You may obtain a copy of the License at
7 | #
8 | # https://www.apache.org/licenses/LICENSE-2.0
9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 |
16 | # This script should be run from the root directory.
17 | # It creates git tags for all marked modules listed in the allmodules file.
18 | set -euo pipefail
19 |
20 | function usage() {
21 | echo
22 | echo "Usage: git_tag_modules.sh vX.X.X" 1>&2
23 | echo " vX.X.X: the git tag version"
24 | exit 64
25 | }
26 |
27 | if [[ $# -ne 1 ]] ; then
28 | echo "Need at least one argument"
29 | usage
30 | fi
31 | version="$1"
32 |
33 | sed -e '/^#/d' -e '/^$/d' allmodules | awk '{ print $1, $2}' | while read -r path update || [[ -n "$path" ]] ; do
34 | if [[ "$update" != "yes" ]]; then
35 | echo "$path is not marked to be released"
36 | continue
37 | fi
38 |
39 | tag="$version"
40 | if [[ "$path" != "." ]]; then
41 | tag="$path/$version"
42 | fi
43 | echo "Creating tag: ${tag}"
44 | git tag "$tag"
45 | done
46 |
--------------------------------------------------------------------------------
/internal/website/makeimports.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | # Copyright 2018 The Go Cloud Development Kit Authors
3 | #
4 | # Licensed under the Apache License, Version 2.0 (the "License");
5 | # you may not use this file except in compliance with the License.
6 | # You may obtain a copy of the License at
7 | #
8 | # https://www.apache.org/licenses/LICENSE-2.0
9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 |
16 | # This script generates Markdown files that will include suitable for
17 | # "go get"'s import path redirection feature (see
18 | # https://golang.org/cmd/go/#hdr-Remote_import_paths) in the final Hugo output.
19 |
20 |
21 | # https://coderwall.com/p/fkfaqq/safer-bash-scripts-with-set-euxo-pipefail
22 | # except x is too verbose
23 | set -euo pipefail
24 |
25 | # Change into repository root.
26 | cd "$(dirname "$0")/../.."
27 | OUTDIR=internal/website/content
28 |
29 | for pkg in $(internal/website/listnewpkgs.sh); do
30 | # Only consider directories that contain Go source files.
31 | outfile="$OUTDIR/$pkg/_index.md"
32 | mkdir -p "$OUTDIR/$pkg"
33 | echo "Generating gocloud.dev/$pkg"
34 | echo "---" >> "$outfile"
35 | echo "title: gocloud.dev/$pkg" >> "$outfile"
36 | echo "type: pkg" >> "$outfile"
37 | echo "---" >> "$outfile"
38 | done
39 |
40 |
--------------------------------------------------------------------------------
/samples/gocdk-blob/blob.ct:
--------------------------------------------------------------------------------
1 | # Copyright 2019 The Go Cloud Development Kit Authors
2 | #
3 | # Licensed under the Apache License, Version 2.0 (the "License");
4 | # you may not use this file except in compliance with the License.
5 | # You may obtain a copy of the License at
6 | #
7 | # https://www.apache.org/licenses/LICENSE-2.0
8 | #
9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 |
15 | # Tests of the gocdk-blob program.
16 |
17 | # ROOTDIR_URL is a platform-specific environment variable set
18 | # in main_test.go.
19 |
20 | # Create a subdirectory so we can use fileblob.
21 | $ mkdir bucket
22 |
23 | # List an empty bucket: valid, but no output.
24 | $ gocdk-blob ls ${ROOTDIR_URL}/bucket
25 |
26 | $ fecho hello.txt hello world
27 | $ gocdk-blob upload ${ROOTDIR_URL}/bucket hw < hello.txt
28 |
29 | $ gocdk-blob ls ${ROOTDIR_URL}/bucket
30 | hw
31 |
32 | $ gocdk-blob download ${ROOTDIR_URL}/bucket hw
33 | hello world
34 |
35 | # Error downloading a bucket that doesn't exist.
36 | # For now we can't use this test case, because the output won't be the same across operating systems.
37 | #$ gocdk-blob download ${ROOTDIR_URL}/bucket noexist --> FAIL
38 | #gocdk-blob: Failed to read "noexist": blob (code=NotFound): stat ${SLASHDIR}/bucket/noexist: no such file or directory
39 |
40 |
--------------------------------------------------------------------------------
/samples/order/common.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 The Go Cloud Development Kit Authors
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package main
16 |
17 | import (
18 | "time"
19 | )
20 |
21 | // Order represents an order for a single image operation.
22 | type Order struct {
23 | ID string // unique ID, randomly generated
24 | Email string // email address of customer
25 | InImage string // name of input image
26 | OutImage string // name of output image; empty if there was an error
27 | CreateTime time.Time // time the order was created
28 | FinishTime time.Time // time the order was finished
29 | Note string // note to the customer from the processor, describing success or error
30 | DocstoreRevision interface{}
31 | }
32 |
33 | // OrderRequest is a request for an order. It is the contents of the messages
34 | // sent to the requests topic.
35 | type OrderRequest struct {
36 | ID string
37 | Email string
38 | InImage string
39 | CreateTime time.Time
40 | }
41 |
--------------------------------------------------------------------------------
/samples/guestbook/aws/outputs.tf:
--------------------------------------------------------------------------------
1 | # Copyright 2018 The Go Cloud Development Kit Authors
2 | #
3 | # Licensed under the Apache License, Version 2.0 (the "License");
4 | # you may not use this file except in compliance with the License.
5 | # You may obtain a copy of the License at
6 | #
7 | # https://www.apache.org/licenses/LICENSE-2.0
8 | #
9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 |
15 | output "region" {
16 | value = var.region
17 | description = "Region the resources were created in."
18 | }
19 |
20 | output "bucket" {
21 | value = aws_s3_bucket.guestbook.id
22 | description = "Name of the S3 bucket created to store images."
23 | }
24 |
25 | output "database_host" {
26 | value = aws_db_instance.guestbook.address
27 | description = "Host name of the RDS MySQL database."
28 | }
29 |
30 | output "database_root_password" {
31 | value = random_string.db_password.result
32 | sensitive = true
33 | description = "Password for the root user of the RDS MySQL databse."
34 | }
35 |
36 | output "paramstore_var" {
37 | value = var.paramstore_var
38 | description = "Location of the SSM Parameter Store Message of the Day variable."
39 | }
40 |
41 | output "instance_host" {
42 | value = aws_instance.guestbook.public_ip
43 | description = "Address of the EC2 instance."
44 | }
45 |
46 |
--------------------------------------------------------------------------------
/blob/blob_reader_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2022 The Go Cloud Development Kit Authors
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package blob_test
16 |
17 | import (
18 | "context"
19 | "testing"
20 | "testing/iotest"
21 |
22 | "gocloud.dev/blob/memblob"
23 | )
24 |
25 | // TestReader verifies that blob.Reader implements io package interfaces correctly.
26 | func TestReader(t *testing.T) {
27 | const myKey = "testkey"
28 |
29 | bucket := memblob.OpenBucket(nil)
30 | defer bucket.Close()
31 |
32 | // Get some random data, of a large enough size to require multiple
33 | // reads/writes given our buffer size of 1024.
34 | data, err := randomData(1024*10 + 10)
35 | if err != nil {
36 | t.Fatal(err)
37 | }
38 |
39 | // Write the data to a key.
40 | ctx := context.Background()
41 | bucket.WriteAll(ctx, myKey, data, nil)
42 |
43 | // Create a blob.Reader.
44 | r, err := bucket.NewReader(ctx, myKey, nil)
45 | if err != nil {
46 | t.Fatal(err)
47 | }
48 | defer r.Close()
49 | if err := iotest.TestReader(r, data); err != nil {
50 | t.Error(err)
51 | }
52 | }
53 |
--------------------------------------------------------------------------------
/gcerrors/errors_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 The Go Cloud Development Kit Authors
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package gcerrors
16 |
17 | import (
18 | "context"
19 | "io"
20 | "testing"
21 |
22 | "gocloud.dev/internal/gcerr"
23 | )
24 |
25 | type wrappedErr struct {
26 | err error
27 | }
28 |
29 | func (w wrappedErr) Error() string { return "wrapped" }
30 |
31 | func (w wrappedErr) Unwrap() error { return w.err }
32 |
33 | func TestCode(t *testing.T) {
34 | for _, test := range []struct {
35 | in error
36 | want ErrorCode
37 | }{
38 | {nil, OK},
39 | {gcerr.New(AlreadyExists, nil, 1, ""), AlreadyExists},
40 | {wrappedErr{gcerr.New(PermissionDenied, nil, 1, "")}, PermissionDenied},
41 | {context.Canceled, Canceled},
42 | {context.DeadlineExceeded, DeadlineExceeded},
43 | {wrappedErr{context.Canceled}, Canceled},
44 | {wrappedErr{context.DeadlineExceeded}, DeadlineExceeded},
45 | {io.EOF, Unknown},
46 | } {
47 | got := Code(test.in)
48 | if got != test.want {
49 | t.Errorf("%v: got %s, want %s", test.in, got, test.want)
50 | }
51 | }
52 | }
53 |
--------------------------------------------------------------------------------
/docstore/drivertest/util.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 The Go Cloud Development Kit Authors
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package drivertest
16 |
17 | import (
18 | "math/rand"
19 | "sync"
20 |
21 | "github.com/google/uuid"
22 | "gocloud.dev/docstore/driver"
23 | )
24 |
25 | // MakeUniqueStringDeterministicForTesting uses a specified seed value to
26 | // produce the same sequence of values in driver.UniqueString for testing.
27 | //
28 | // Call when running tests that will be replayed.
29 | func MakeUniqueStringDeterministicForTesting(seed int64) {
30 | r := &randReader{r: rand.New(rand.NewSource(seed))}
31 | uuid.SetRand(r)
32 | }
33 |
34 | type randReader struct {
35 | mu sync.Mutex
36 | r *rand.Rand
37 | }
38 |
39 | func (r *randReader) Read(buf []byte) (int, error) {
40 | r.mu.Lock()
41 | defer r.mu.Unlock()
42 | return r.r.Read(buf)
43 | }
44 |
45 | // MustDocument is like driver.NewDocument, but panics on error.
46 | func MustDocument(doc interface{}) driver.Document {
47 | dd, err := driver.NewDocument(doc)
48 | if err != nil {
49 | panic(err)
50 | }
51 | return dd
52 | }
53 |
--------------------------------------------------------------------------------
/.github/workflows/tests.yml:
--------------------------------------------------------------------------------
1 | # Copyright 2021 The Go Cloud Development Kit Authors
2 | #
3 | # Licensed under the Apache License, Version 2.0 (the "License");
4 | # you may not use this file except in compliance with the License.
5 | # You may obtain a copy of the License at
6 | #
7 | # https://www.apache.org/licenses/LICENSE-2.0
8 | #
9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 |
15 | name: tests
16 | on: [push, pull_request]
17 | jobs:
18 | build:
19 | strategy:
20 | fail-fast: false
21 | matrix:
22 | # Note: we used to include windows-latest, but it's super
23 | # flaky on Github runners, lots of OOMs.
24 | os: [ubuntu-latest, macos-latest]
25 | # When updating this, make sure to also update the
26 | # latest_go_version variable in internal/testing/runchecks.sh.
27 | go-version: [1.20.x]
28 | include:
29 | - go-version: 1.19.x
30 | os: ubuntu-latest
31 |
32 | runs-on: ${{ matrix.os }}
33 | steps:
34 | - name: Install Go
35 | uses: actions/setup-go@v2
36 | with:
37 | go-version: ${{ matrix.go-version }}
38 | - name: Checkout code
39 | uses: actions/checkout@v2
40 | with:
41 | fetch-depth: 2 # required for codecov
42 | - name: Run Tests
43 | shell: bash
44 | run: 'internal/testing/runchecks.sh'
45 |
--------------------------------------------------------------------------------
/internal/testing/terraform/terraform.go:
--------------------------------------------------------------------------------
1 | // Copyright 2018 The Go Cloud Development Kit Authors
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package terraform provides a function to read Terraform output.
16 | package terraform // import "gocloud.dev/internal/testing/terraform"
17 |
18 | import (
19 | "encoding/json"
20 | "fmt"
21 | "os/exec"
22 | )
23 |
24 | // ReadOutput runs `terraform output` on the given directory and returns
25 | // the parsed result.
26 | func ReadOutput(dir string) (map[string]Output, error) {
27 | c := exec.Command("terraform", "output", "-json")
28 | c.Dir = dir
29 | data, err := c.Output()
30 | if err != nil {
31 | return nil, fmt.Errorf("read terraform output: %v", err)
32 | }
33 | var parsed map[string]Output
34 | if err := json.Unmarshal(data, &parsed); err != nil {
35 | return nil, fmt.Errorf("read terraform output: %v", err)
36 | }
37 | return parsed, nil
38 | }
39 |
40 | // Output describes a single output value.
41 | type Output struct {
42 | Type string `json:"type"` // one of "string", "list", or "map"
43 | Sensitive bool `json:"sensitive"`
44 | Value interface{} `json:"value"`
45 | }
46 |
--------------------------------------------------------------------------------
/internal/website/content/concepts/as.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Using provider-specific APIs
3 | date: 2019-05-10T11:17:09-07:00
4 | weight: 3
5 | ---
6 |
7 | It is not feasible or desirable for APIs like `blob.Bucket` to encompass the
8 | full functionality of every provider. Rather, we intend to provide a subset
9 | of the most commonly used functionality. There will be cases where a
10 | developer wants to access provider-specific functionality, such as unexposed
11 | APIs or data fields, errors, or options. This can be accomplished using `As`
12 | functions.
13 |
14 |
15 |
16 | ## `As` {#as}
17 |
18 | `As` functions in the APIs provide the user a way to escape the Go CDK
19 | abstraction to access provider-specific types. They might be used as an
20 | interim solution until a feature request to the Go CDK is implemented. Or,
21 | the Go CDK may choose not to support specific features, and the use of `As`
22 | will be permanent.
23 |
24 | Using `As` implies that the resulting code is no longer portable; the
25 | provider-specific code will need to be ported in order to switch providers.
26 | Therefore, it should be avoided if possible.
27 |
28 | Each API includes examples demonstrating how to use its various `As`
29 | functions, and each provider implementation documents what types it supports
30 | for each.
31 |
32 | Usage:
33 |
34 | 1. Declare a variable of the provider-specific type you want to access.
35 | 2. Pass a pointer to it to `As`.
36 | 3. If the type is supported, `As` will return `true` and copy the
37 | provider-specific type into your variable. Otherwise, it will return `false`.
38 |
39 | Provider-specific types that are intended to be mutable will be exposed
40 | as a pointer to the underlying type.
41 |
--------------------------------------------------------------------------------
/pubsub/kafkapubsub/localkafka.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | # Copyright 2019 The Go Cloud Development Kit Authors
3 | #
4 | # Licensed under the Apache License, Version 2.0 (the "License");
5 | # you may not use this file except in compliance with the License.
6 | # You may obtain a copy of the License at
7 | #
8 | # https://www.apache.org/licenses/LICENSE-2.0
9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 |
16 | # Starts a local Kafka instance (plus supporting Zookeeper) via Docker.
17 |
18 | # https://coderwall.com/p/fkfaqq/safer-bash-scripts-with-set-euxo-pipefail
19 | set -euo pipefail
20 |
21 | # Clean up and run Zookeeper.
22 | echo "Starting Zookeeper (for Kafka)..."
23 | docker rm -f zookeeper &> /dev/null || :
24 | docker run -d --net=host --name=zookeeper -e ZOOKEEPER_CLIENT_PORT=2181 confluentinc/cp-zookeeper:6.0.1 &> /dev/null
25 | echo "...done. Run \"docker rm -f zookeeper\" to clean up the container."
26 | echo
27 |
28 | # Clean up and run Kafka.
29 | echo "Starting Kafka..."
30 | docker rm -f kafka &> /dev/null || :
31 | docker run -d --net=host -p 9092:9092 --name=kafka -e KAFKA_ZOOKEEPER_CONNECT=localhost:2181 -e KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://localhost:9092 -e KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR=1 -e KAFKA_AUTO_CREATE_TOPICS_ENABLE=false -e KAFKA_GROUP_INITIAL_REBALANCE_DELAY_MS=100 confluentinc/cp-kafka:6.0.1 &> /dev/null
32 | echo "...done. Run \"docker rm -f kafka\" to clean up the container."
33 | echo
34 |
--------------------------------------------------------------------------------
/internal/website/listnewpkgs.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | # Copyright 2019 The Go Cloud Development Kit Authors
3 | #
4 | # Licensed under the Apache License, Version 2.0 (the "License");
5 | # you may not use this file except in compliance with the License.
6 | # You may obtain a copy of the License at
7 | #
8 | # https://www.apache.org/licenses/LICENSE-2.0
9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 |
16 | # This script lists the package names that makeimports.sh would create
17 | # _index.md files for, one per line.
18 |
19 |
20 | # https://coderwall.com/p/fkfaqq/safer-bash-scripts-with-set-euxo-pipefail
21 | # except x is too verbose
22 | set -euo pipefail
23 |
24 | # Change into repository root.
25 | cd "$(dirname "$0")/../.."
26 | OUTDIR=internal/website/content
27 |
28 | shopt -s nullglob # glob patterns that don't match turn into the empty string, instead of themselves
29 |
30 | function files_exist() { # assumes nullglob
31 | [[ ${1:-""} != "" ]]
32 | }
33 |
34 | # Find all directories that do not begin with '.' or '_' or contain 'testdata'. Use the %P printf
35 | # directive to remove the initial './'.
36 | for pkg in $(find . -type d \( -name '[._]?*' -prune -o -name testdata -prune -o -printf '%P ' \)); do
37 | # Only consider directories that contain Go source files.
38 | outfile="$OUTDIR/$pkg/_index.md"
39 | if files_exist $pkg/*.go && [[ ! -e "$outfile" ]]; then
40 | echo "$pkg"
41 | fi
42 | done
43 |
44 |
--------------------------------------------------------------------------------
/runtimevar/oc_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 The Go Cloud Development Kit Authors
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package runtimevar_test
16 |
17 | import (
18 | "context"
19 | "testing"
20 |
21 | "go.opencensus.io/stats/view"
22 | "gocloud.dev/internal/oc"
23 | "gocloud.dev/internal/testing/octest"
24 | "gocloud.dev/runtimevar"
25 | "gocloud.dev/runtimevar/constantvar"
26 | )
27 |
28 | func TestOpenCensus(t *testing.T) {
29 | ctx := context.Background()
30 | te := octest.NewTestExporter(runtimevar.OpenCensusViews)
31 | defer te.Unregister()
32 |
33 | v := constantvar.New(1)
34 | defer v.Close()
35 | if _, err := v.Watch(ctx); err != nil {
36 | t.Fatal(err)
37 | }
38 | cctx, cancel := context.WithCancel(ctx)
39 | cancel()
40 | _, _ = v.Watch(cctx)
41 |
42 | seen := false
43 | const driver = "gocloud.dev/runtimevar/constantvar"
44 | for _, row := range te.Counts() {
45 | if _, ok := row.Data.(*view.CountData); !ok {
46 | continue
47 | }
48 | if row.Tags[0].Key == oc.ProviderKey && row.Tags[0].Value == driver {
49 | seen = true
50 | break
51 | }
52 | }
53 | if !seen {
54 | t.Errorf("did not see count row with provider=%s", driver)
55 | }
56 | }
57 |
--------------------------------------------------------------------------------
/docstore/oc_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 The Go Cloud Development Kit Authors
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package docstore_test
16 |
17 | import (
18 | "context"
19 | "testing"
20 |
21 | "gocloud.dev/docstore"
22 | "gocloud.dev/docstore/memdocstore"
23 | "gocloud.dev/gcerrors"
24 | "gocloud.dev/internal/testing/octest"
25 | )
26 |
27 | func TestOpenCensus(t *testing.T) {
28 | ctx := context.Background()
29 | te := octest.NewTestExporter(docstore.OpenCensusViews)
30 | defer te.Unregister()
31 |
32 | coll, err := memdocstore.OpenCollection("_id", nil)
33 | if err != nil {
34 | t.Fatal(err)
35 | }
36 | defer coll.Close()
37 |
38 | // ActionList.Do.
39 | if err := coll.Create(ctx, map[string]interface{}{"_id": "a", "count": 0}); err != nil {
40 | t.Fatal(err)
41 | }
42 |
43 | // Query.Get.
44 | iter := coll.Query().Get(ctx)
45 | iter.Stop()
46 |
47 | const driver = "gocloud.dev/docstore/memdocstore"
48 |
49 | diff := octest.Diff(te.Spans(), te.Counts(), "gocloud.dev/docstore", driver, []octest.Call{
50 | {Method: "ActionList.Do", Code: gcerrors.OK},
51 | {Method: "Query.Get", Code: gcerrors.OK},
52 | })
53 | if diff != "" {
54 | t.Error(diff)
55 | }
56 | }
57 |
--------------------------------------------------------------------------------
/blob/wrapped_bucket_test.go:
--------------------------------------------------------------------------------
1 | package blob_test
2 |
3 | import (
4 | "context"
5 | "os"
6 | "path/filepath"
7 | "strings"
8 | "testing"
9 |
10 | "gocloud.dev/blob"
11 | "gocloud.dev/blob/fileblob"
12 | )
13 |
14 | func TestPrefixedBucket(t *testing.T) {
15 | dir, cleanup := newTempDir()
16 | defer cleanup()
17 | bucket, err := fileblob.OpenBucket(dir, nil)
18 | if err != nil {
19 | t.Fatal(err)
20 | }
21 |
22 | const contents = "contents"
23 | ctx := context.Background()
24 | if err := bucket.WriteAll(ctx, "foo/bar/baz.txt", []byte(contents), nil); err != nil {
25 | t.Fatal(err)
26 | }
27 |
28 | wrapped := blob.PrefixedBucket(bucket, "foo/bar/")
29 | defer wrapped.Close()
30 |
31 | got, err := wrapped.ReadAll(ctx, "baz.txt")
32 | if err != nil {
33 | t.Fatal(err)
34 | }
35 | if string(got) != contents {
36 | t.Errorf("got %q want %q", string(got), contents)
37 | }
38 | }
39 |
40 | func TestSingleKeyBucket(t *testing.T) {
41 | dir, cleanup := newTempDir()
42 | defer cleanup()
43 | bucket, err := fileblob.OpenBucket(dir, nil)
44 | if err != nil {
45 | t.Fatal(err)
46 | }
47 |
48 | const contents = "contents"
49 | ctx := context.Background()
50 | if err := bucket.WriteAll(ctx, "foo/bar.txt", []byte(contents), nil); err != nil {
51 | t.Fatal(err)
52 | }
53 |
54 | dirpath := filepath.ToSlash(dir)
55 | if os.PathSeparator != '/' && !strings.HasPrefix(dirpath, "/") {
56 | dirpath = "/" + dirpath
57 | }
58 |
59 | wrapped, err := blob.OpenBucket(ctx, "file://"+dirpath+"?key=foo/bar.txt")
60 | if err != nil {
61 | t.Fatal(err)
62 | }
63 | defer wrapped.Close()
64 | got, err := wrapped.ReadAll(ctx, "")
65 | if err != nil {
66 | t.Fatal(err)
67 | }
68 | if string(got) != contents {
69 | t.Errorf("got %q want %q", string(got), contents)
70 | }
71 | }
72 |
--------------------------------------------------------------------------------