initial commit
Change-Id: Iecee6de665d30e5db1587444d8112c44bb592b4e
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ 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
+
+ http://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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..befcde4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# Go example projects
+
+This repository contains a collection of Go programs and libraries that
+demonstrate the language, standard libraries, and tools.
+
+## The examples
+
+### [hello](hello/) and [stringutil](stringutil/)
+
+ go get github.com/golang/example/hello
+
+A trivial "Hello, world" program that uses a stringutil package.
+
+Command [hello](hello/) covers:
+
+* The basic form of an executable command
+* Importing packages (from the standard library and the local repository)
+* Printing strings ([fmt](//golang.org/pkg/fmt/))
+
+Library [stringutil](stringutil/) covers:
+
+* The basic form of a library
+* Conversion between string and []rune
+* Table-driven unit tests ([testing](//golang.org/pkg/testing/))
+
+### [outyet](outyet/)
+
+ go get github.com/golang/example/outyet
+
+A web server that answers the question: "Is Go 1.x out yet?"
+
+Topics covered:
+
+* Command-line flags ([flag](//golang.org/pkg/flag/))
+* Web servers ([net/http](//golang.org/pkg/net/http/))
+* HTML Templates ([html/template](//golang.org/pkg/html/template/))
+* Logging ([log](//golang.org/pkg/log/))
+* Long-running background processes
+* Synchronizing data access between goroutines ([sync](//golang.org/pkg/sync/))
+* Exporting server state for monitoring ([expvar](//golang.org/pkg/expvar/))
+* Unit and integration tests ([testing](//golang.org/pkg/testing/))
+* Dependency injection
+* Time ([time](//golang.org/pkg/time/))
+
diff --git a/hello/hello.go b/hello/hello.go
new file mode 100644
index 0000000..9353cc8
--- /dev/null
+++ b/hello/hello.go
@@ -0,0 +1,27 @@
+/*
+Copyright 2014 Google Inc.
+
+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
+
+ http://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 (
+ "fmt"
+
+ "github.com/golang/example/stringutil"
+)
+
+func main() {
+ fmt.Println(stringutil.Reverse("!selpmaxe oG ,olleH"))
+}
diff --git a/outyet/main.go b/outyet/main.go
new file mode 100644
index 0000000..7d64edd
--- /dev/null
+++ b/outyet/main.go
@@ -0,0 +1,140 @@
+/*
+Copyright 2014 Google Inc.
+
+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
+
+ http://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.
+*/
+
+// outyet is a web server that announces whether or not a particular Go version
+// has been tagged.
+package main
+
+import (
+ "expvar"
+ "flag"
+ "fmt"
+ "html/template"
+ "log"
+ "net/http"
+ "sync"
+ "time"
+)
+
+// Command-line flags.
+var (
+ httpAddr = flag.String("http", ":8080", "Listen address")
+ pollPeriod = flag.Duration("poll", 5*time.Second, "Poll period")
+ version = flag.String("version", "1.4", "Go version")
+)
+
+const baseChangeURL = "https://code.google.com/p/go/source/detail?r="
+
+func main() {
+ flag.Parse()
+ changeURL := fmt.Sprintf("%sgo%s", baseChangeURL, *version)
+ http.Handle("/", NewServer(*version, changeURL, *pollPeriod))
+ log.Fatal(http.ListenAndServe(*httpAddr, nil))
+}
+
+// Exported variables for monitoring the server.
+// These are exported via HTTP as a JSON object at /debug/vars.
+var (
+ hitCount = expvar.NewInt("hitCount")
+ pollCount = expvar.NewInt("pollCount")
+ pollError = expvar.NewString("pollError")
+ pollErrorCount = expvar.NewInt("pollErrorCount")
+)
+
+// Server implements the outyet server.
+// It serves the user interface (it's an http.Handler)
+// and polls the remote repository for changes.
+type Server struct {
+ version string
+ url string
+ period time.Duration
+
+ mu sync.RWMutex // protects the yes variable
+ yes bool
+}
+
+// NewServer returns an initialized outyet server.
+func NewServer(version, url string, period time.Duration) *Server {
+ s := &Server{version: version, url: url, period: period}
+ go s.poll()
+ return s
+}
+
+// poll polls the change URL for the specified period until the tag exists.
+// Then it sets the Server's yes field true and exits.
+func (s *Server) poll() {
+ for !isTagged(s.url) {
+ pollSleep(s.period)
+ }
+ s.mu.Lock()
+ s.yes = true
+ s.mu.Unlock()
+ pollDone()
+}
+
+// Hooks that may be overridden for integration tests.
+var (
+ pollSleep = time.Sleep
+ pollDone = func() {}
+)
+
+// isTagged makes an HTTP HEAD request to the given URL and reports whether it
+// returned a 200 OK response.
+func isTagged(url string) bool {
+ pollCount.Add(1)
+ r, err := http.Head(url)
+ if err != nil {
+ log.Print(err)
+ pollError.Set(err.Error())
+ pollErrorCount.Add(1)
+ return false
+ }
+ return r.StatusCode == http.StatusOK
+}
+
+// ServeHTTP implements the HTTP user interface.
+func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+ hitCount.Add(1)
+ s.mu.RLock()
+ data := struct {
+ URL string
+ Version string
+ Yes bool
+ }{
+ s.url,
+ s.version,
+ s.yes,
+ }
+ s.mu.RUnlock()
+ err := tmpl.Execute(w, data)
+ if err != nil {
+ log.Print(err)
+ }
+}
+
+// tmpl is the HTML template that drives the user interface.
+var tmpl = template.Must(template.New("tmpl").Parse(`
+<!DOCTYPE html><html><body><center>
+ <h2>Is Go {{.Version}} out yet?</h2>
+ <h1>
+ {{if .Yes}}
+ <a href="{{.URL}}">YES!</a>
+ {{else}}
+ No. :-(
+ {{end}}
+ </h1>
+</center></body></html>
+`))
diff --git a/outyet/main_test.go b/outyet/main_test.go
new file mode 100644
index 0000000..d21a22c
--- /dev/null
+++ b/outyet/main_test.go
@@ -0,0 +1,99 @@
+/*
+Copyright 2014 Google Inc.
+
+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
+
+ http://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"
+ "strings"
+ "testing"
+ "time"
+)
+
+// statusHandler is an http.Handler that writes an empty response using itself
+// as the response status code.
+type statusHandler int
+
+func (h *statusHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+ w.WriteHeader(int(*h))
+}
+
+func TestIsTagged(t *testing.T) {
+ // Set up a fake "Google Code" web server reporting 404 not found.
+ status := statusHandler(http.StatusNotFound)
+ s := httptest.NewServer(&status)
+ defer s.Close()
+
+ if isTagged(s.URL) {
+ t.Fatal("isTagged == true, want false")
+ }
+
+ // Change fake server status to 200 OK and try again.
+ status = http.StatusOK
+
+ if !isTagged(s.URL) {
+ t.Fatal("isTagged == false, want true")
+ }
+}
+
+func TestIntegration(t *testing.T) {
+ status := statusHandler(http.StatusNotFound)
+ ts := httptest.NewServer(&status)
+ defer ts.Close()
+
+ // Replace the pollSleep with a closure that we can block and unblock.
+ sleep := make(chan bool)
+ pollSleep = func(time.Duration) {
+ sleep <- true
+ sleep <- true
+ }
+
+ // Replace pollDone with a closure that will tell us when the poller is
+ // exiting.
+ done := make(chan bool)
+ pollDone = func() { done <- true }
+
+ // Put things as they were when the test finishes.
+ defer func() {
+ pollSleep = time.Sleep
+ pollDone = func() {}
+ }()
+
+ s := NewServer("1.x", ts.URL, 1*time.Millisecond)
+
+ <-sleep // Wait for poll loop to start sleeping.
+
+ // Make first request to the server.
+ r, _ := http.NewRequest("GET", "/", nil)
+ w := httptest.NewRecorder()
+ s.ServeHTTP(w, r)
+ if b := w.Body.String(); !strings.Contains(b, "No.") {
+ t.Fatalf("body = %s, want no", b)
+ }
+
+ status = http.StatusOK
+
+ <-sleep // Permit poll loop to stop sleeping.
+ <-done // Wait for poller to see the "OK" status and exit.
+
+ // Make second request to the server.
+ w = httptest.NewRecorder()
+ s.ServeHTTP(w, r)
+ if b := w.Body.String(); !strings.Contains(b, "YES!") {
+ t.Fatalf("body = %q, want yes", b)
+ }
+}
diff --git a/stringutil/reverse.go b/stringutil/reverse.go
new file mode 100644
index 0000000..dea9f6b
--- /dev/null
+++ b/stringutil/reverse.go
@@ -0,0 +1,27 @@
+/*
+Copyright 2014 Google Inc.
+
+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
+
+ http://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 stringutil contains utility functions for working with strings.
+package stringutil
+
+// Reverse returns the provided string with its runes in reverse order.
+func Reverse(s string) string {
+ r := []rune(s)
+ for i, j := 0, len(r)-1; i < len(r)/2; i, j = i+1, j-1 {
+ r[i], r[j] = r[j], r[i]
+ }
+ return string(r)
+}
diff --git a/stringutil/reverse_test.go b/stringutil/reverse_test.go
new file mode 100644
index 0000000..263a420
--- /dev/null
+++ b/stringutil/reverse_test.go
@@ -0,0 +1,34 @@
+/*
+Copyright 2014 Google Inc.
+
+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
+
+ http://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 stringutil
+
+import "testing"
+
+func TestReverse(t *testing.T) {
+ for _, c := range struct {
+ in, want string
+ }{
+ {"Hello, world", "dlrow ,olleH"},
+ {"Hello, 世界", "界世 ,olleH"},
+ {"", ""},
+ } {
+ got := Reverse(c.in)
+ if got != want {
+ t.Errorf("Reverse(%q) == %q, want %q", c.in, got, want)
+ }
+ }
+}