diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml new file mode 100644 index 00000000..b4568988 --- /dev/null +++ b/.github/workflows/pr.yml @@ -0,0 +1,19 @@ +name: Continuous Integration +on: + push: + branches: + - main + pull_request: + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-go@v5 + with: + go-version: 1.22 + + - name: Run tests + run: go test -v ./... diff --git a/_content/tour/eng/algorithms/fun/freq_concurrent.go b/_content/tour/eng/algorithms/fun/freq_concurrent.go index 3b91df41..edfa678f 100644 --- a/_content/tour/eng/algorithms/fun/freq_concurrent.go +++ b/_content/tour/eng/algorithms/fun/freq_concurrent.go @@ -1,3 +1,5 @@ +//go:build OMIT + // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/arrays/example2.go b/_content/tour/eng/arrays/example2.go index ce6e4299..5c41c454 100644 --- a/_content/tour/eng/arrays/example2.go +++ b/_content/tour/eng/arrays/example2.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/channels/example10.go b/_content/tour/eng/channels/example10.go index e680c74a..ed01faa0 100644 --- a/_content/tour/eng/channels/example10.go +++ b/_content/tour/eng/channels/example10.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || norun // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/composition/assertions/example1.go b/_content/tour/eng/composition/assertions/example1.go index 5d1191cb..f0e81147 100644 --- a/_content/tour/eng/composition/assertions/example1.go +++ b/_content/tour/eng/composition/assertions/example1.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/composition/decoupling/exercise1.go b/_content/tour/eng/composition/decoupling/exercise1.go index db2f3a41..98bd38df 100644 --- a/_content/tour/eng/composition/decoupling/exercise1.go +++ b/_content/tour/eng/composition/decoupling/exercise1.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/composition/grouping/example1.go b/_content/tour/eng/composition/grouping/example1.go index 474b91ca..59d0bea8 100644 --- a/_content/tour/eng/composition/grouping/example1.go +++ b/_content/tour/eng/composition/grouping/example1.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/composition/mocking/example1.go b/_content/tour/eng/composition/mocking/example1.go index e72930c1..445b6e18 100644 --- a/_content/tour/eng/composition/mocking/example1.go +++ b/_content/tour/eng/composition/mocking/example1.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/constants/example4.go b/_content/tour/eng/constants/example4.go index 1b735f9c..64560df1 100644 --- a/_content/tour/eng/constants/example4.go +++ b/_content/tour/eng/constants/example4.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/context/answer1.go b/_content/tour/eng/context/answer1.go index 8291bcf3..49fca71b 100644 --- a/_content/tour/eng/context/answer1.go +++ b/_content/tour/eng/context/answer1.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || norun // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/context/example5.go b/_content/tour/eng/context/example5.go index cf819766..a04854fa 100644 --- a/_content/tour/eng/context/example5.go +++ b/_content/tour/eng/context/example5.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || norun // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/context/exercise1.go b/_content/tour/eng/context/exercise1.go index d7225c6c..cf7d6224 100644 --- a/_content/tour/eng/context/exercise1.go +++ b/_content/tour/eng/context/exercise1.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/data_race/example5.go b/_content/tour/eng/data_race/example5.go index dd7cb0fc..fda16cd5 100644 --- a/_content/tour/eng/data_race/example5.go +++ b/_content/tour/eng/data_race/example5.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || norun // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/data_race/example6.go b/_content/tour/eng/data_race/example6.go index 61243b57..8ab7578d 100644 --- a/_content/tour/eng/data_race/example6.go +++ b/_content/tour/eng/data_race/example6.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || norun // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/error-handling/example4.go b/_content/tour/eng/error-handling/example4.go index 40f8303e..5e2e7f48 100644 --- a/_content/tour/eng/error-handling/example4.go +++ b/_content/tour/eng/error-handling/example4.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || norun // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/error-handling/example5.go b/_content/tour/eng/error-handling/example5.go index de920b11..4c677b32 100644 --- a/_content/tour/eng/error-handling/example5.go +++ b/_content/tour/eng/error-handling/example5.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || norun // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/error-handling/exercise1.go b/_content/tour/eng/error-handling/exercise1.go index 0fb21e45..378257d8 100644 --- a/_content/tour/eng/error-handling/exercise1.go +++ b/_content/tour/eng/error-handling/exercise1.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/error-handling/exercise2.go b/_content/tour/eng/error-handling/exercise2.go index 59310aa9..e2883ef2 100644 --- a/_content/tour/eng/error-handling/exercise2.go +++ b/_content/tour/eng/error-handling/exercise2.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/exporting/answer1.go b/_content/tour/eng/exporting/answer1.go index f0abc4c6..dcd28e17 100644 --- a/_content/tour/eng/exporting/answer1.go +++ b/_content/tour/eng/exporting/answer1.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/exporting/example1.go b/_content/tour/eng/exporting/example1.go index 5cd1820c..a828b2f6 100644 --- a/_content/tour/eng/exporting/example1.go +++ b/_content/tour/eng/exporting/example1.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/exporting/example2.go b/_content/tour/eng/exporting/example2.go index cec2201e..91735097 100644 --- a/_content/tour/eng/exporting/example2.go +++ b/_content/tour/eng/exporting/example2.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/exporting/example3.go b/_content/tour/eng/exporting/example3.go index 00a1dda7..1ba82103 100644 --- a/_content/tour/eng/exporting/example3.go +++ b/_content/tour/eng/exporting/example3.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/exporting/example4.go b/_content/tour/eng/exporting/example4.go index f2b0174a..93d06902 100644 --- a/_content/tour/eng/exporting/example4.go +++ b/_content/tour/eng/exporting/example4.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/exporting/example5.go b/_content/tour/eng/exporting/example5.go index 70da23ed..8ae0fa09 100644 --- a/_content/tour/eng/exporting/example5.go +++ b/_content/tour/eng/exporting/example5.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/exporting/exercise1.go b/_content/tour/eng/exporting/exercise1.go index bafbd5a5..4ff23346 100644 --- a/_content/tour/eng/exporting/exercise1.go +++ b/_content/tour/eng/exporting/exercise1.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/generics/type-constraints/exercise1.go b/_content/tour/eng/generics/type-constraints/exercise1.go index 01dd1324..13c74e40 100644 --- a/_content/tour/eng/generics/type-constraints/exercise1.go +++ b/_content/tour/eng/generics/type-constraints/exercise1.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || norun // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/interfaces/example2.go b/_content/tour/eng/interfaces/example2.go index a9e10aa4..3b56f6fd 100644 --- a/_content/tour/eng/interfaces/example2.go +++ b/_content/tour/eng/interfaces/example2.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/interfaces/example3.go b/_content/tour/eng/interfaces/example3.go index 2ed6c756..cbd2a139 100644 --- a/_content/tour/eng/interfaces/example3.go +++ b/_content/tour/eng/interfaces/example3.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/interfaces/example4.go b/_content/tour/eng/interfaces/example4.go index acb8e2f6..e8cab8ba 100644 --- a/_content/tour/eng/interfaces/example4.go +++ b/_content/tour/eng/interfaces/example4.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/interfaces/example6.go b/_content/tour/eng/interfaces/example6.go index 68825182..5187153e 100644 --- a/_content/tour/eng/interfaces/example6.go +++ b/_content/tour/eng/interfaces/example6.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/maps/example3.go b/_content/tour/eng/maps/example3.go index a1fb2fa6..a9913573 100644 --- a/_content/tour/eng/maps/example3.go +++ b/_content/tour/eng/maps/example3.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/maps/example6.go b/_content/tour/eng/maps/example6.go index bfffd74e..e79d9f1a 100644 --- a/_content/tour/eng/maps/example6.go +++ b/_content/tour/eng/maps/example6.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/maps/example8.go b/_content/tour/eng/maps/example8.go index 359f752a..0d72d9e7 100644 --- a/_content/tour/eng/maps/example8.go +++ b/_content/tour/eng/maps/example8.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || norun // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/methods/example5.go b/_content/tour/eng/methods/example5.go index fb0d8cf7..13275785 100644 --- a/_content/tour/eng/methods/example5.go +++ b/_content/tour/eng/methods/example5.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/methods/exercise1.go b/_content/tour/eng/methods/exercise1.go index 555d0ef1..8e09f37c 100644 --- a/_content/tour/eng/methods/exercise1.go +++ b/_content/tour/eng/methods/exercise1.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || nobuild // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/slices/example1.go b/_content/tour/eng/slices/example1.go index 36f418d4..f86c3764 100644 --- a/_content/tour/eng/slices/example1.go +++ b/_content/tour/eng/slices/example1.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || norun // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/slices/example8.go b/_content/tour/eng/slices/example8.go index af4361da..ad9b748d 100644 --- a/_content/tour/eng/slices/example8.go +++ b/_content/tour/eng/slices/example8.go @@ -1,4 +1,4 @@ -//go:build OMIT +//go:build OMIT || norun // All material is licensed under the Apache License Version 2.0, January 2004 // http://www.apache.org/licenses/LICENSE-2.0 diff --git a/_content/tour/eng/welcome/sandbox.go b/_content/tour/eng/welcome/sandbox.go index 183bb929..9525b562 100644 --- a/_content/tour/eng/welcome/sandbox.go +++ b/_content/tour/eng/welcome/sandbox.go @@ -1,3 +1,5 @@ +//go:build OMIT + package main import ( diff --git a/_content/tour/eng/content_test.go b/content_test.go similarity index 54% rename from _content/tour/eng/content_test.go rename to content_test.go index 6c7b22d4..a1819a2c 100644 --- a/_content/tour/eng/content_test.go +++ b/content_test.go @@ -2,48 +2,38 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. -package content +package website import ( "bytes" "errors" "fmt" - "io/ioutil" "os" "os/exec" "path/filepath" "strings" "testing" - - // Keep github.com/ardanlabs/gotour/external/tour/wc in our go.mod require list for use during test. - _ "github.com/ardanlabs/gotour/external/tour/wc" ) // Test that all the .go files inside the content file build // and execute (without checking for output correctness). -// Files that contain the string "// +build no-build" are not built. -// Files that contain the string "// +build no-run" are not executed. -func TestContent(t *testing.T) { +// Files that contain the build constraint "nobuild" are not built. +// Files that contain the build constraint "norun" are not executed. +func TestContentEngTour(t *testing.T) { if _, err := exec.LookPath("go"); err != nil { t.Skipf("skipping because 'go' executable not available: %v", err) } - scratch, err := ioutil.TempDir("", "tour-content-test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(scratch) - - err = filepath.Walk(".", func(path string, fi os.FileInfo, err error) error { - if filepath.Ext(path) != ".go" { - return nil + err := filepath.Walk(filepath.Join("_content", "tour", "eng"), func(path string, fi os.FileInfo, err error) error { + if err != nil { + return err } - if filepath.Base(path) == "content_test.go" { + if filepath.Ext(path) != ".go" { return nil } t.Run(path, func(t *testing.T) { t.Parallel() - if err := testSnippet(t, filepath.ToSlash(path), scratch); err != nil { + if err := testSnippet(filepath.ToSlash(path), t.TempDir()); err != nil { t.Errorf("%v: %v", path, err) } }) @@ -54,21 +44,21 @@ func TestContent(t *testing.T) { } } -func testSnippet(t *testing.T, path, scratch string) error { - b, err := ioutil.ReadFile(path) +func testSnippet(path, scratch string) error { + b, err := os.ReadFile(path) if err != nil { return err } build := string(bytes.SplitN(b, []byte{'\n'}, 2)[0]) - if !strings.HasPrefix(build, "// +build ") { - return errors.New("first line is not a +build comment") + if !strings.HasPrefix(build, "//go:build ") { + return errors.New("first line is not a go:build comment") } if !strings.Contains(build, "OMIT") { - return errors.New(`+build comment does not contain "OMIT"`) + return errors.New(`go:build comment does not contain "OMIT"`) } - if strings.Contains(build, "no-build") { + if strings.Contains(build, "nobuild") { return nil } bin := filepath.Join(scratch, filepath.Base(path)+".exe") @@ -78,7 +68,7 @@ func testSnippet(t *testing.T, path, scratch string) error { } defer os.Remove(bin) - if strings.Contains(build, "no-run") { + if strings.Contains(build, "norun") { return nil } out, err = exec.Command(bin).CombinedOutput()