initial commit of 'starting state'

Author: xiao

module1/main.go

@@ -0,0 +1,7 @@
+package module1
+
+import "fmt"
+
+func main() {
+	fmt.Println("hello world")
+}

module1/module1_test.go

@@ -0,0 +1,17 @@
+package module1
+
+import (
+	"os"
+	"path"
+	"testing"
+)
+
+func TestModule1CheckEnv(t *testing.T) {
+	actual := os.Getenv("GOPATH")
+	expected0 := ""
+	expected1 := path.Join(os.Getenv("HOME"), "go")
+
+	if actual != expected0 && actual != expected1 {
+		t.Errorf("environment variable GOPATH not set properly")
+	}
+}

module2/main.go

@@ -0,0 +1,7 @@
+package module2
+
+import "fmt"
+
+func main() {
+	fmt.Println("hello world")
+}

module2/module2_code.go

@@ -0,0 +1,8 @@
+package module2
+import (
+	"fmt"
+	"runtime"
+)
+func content() {
+	fmt.Println(runtime.GOOS)
+}

module2/module2_test.go

@@ -0,0 +1,34 @@
+package module2
+
+import (
+	"bufio"
+	"log"
+	"os"
+	"testing"
+)
+
+func TestModule2GoFormatContent(t *testing.T) {
+	numOfLines := OpenFileAndCountLines("./module2_code.go")
+	if numOfLines != 8 {
+		t.Errorf("it looks your 'go fmt' does not work as we expected")
+	}
+
+	// TODO: add more tests
+}
+
+// OpenFileAndCountLines opens a file and returns number of lines in the file
+func OpenFileAndCountLines(filename string) int {
+	f, err := os.Open(filename)
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer f.Close()
+
+	scanner := bufio.NewScanner(f)
+	number := 0
+	for scanner.Scan() {
+		number++
+	}
+
+	return number
+}

module3/main.go

@@ -0,0 +1,7 @@
+package module3
+
+import "fmt"
+
+func main() {
+	fmt.Println("hello world")
+}

module3/module3_test.go

@@ -0,0 +1,45 @@
+package module3
+
+import (
+	"bufio"
+	"log"
+	"os"
+	"strings"
+	"testing"
+)
+
+func TestModule3GoFormatContent(t *testing.T) {
+	expected := "	github.com/nathan-osman/go-sunrise"
+	found := OpenFileAndFindNthString("../go.mod", 0, expected)
+	if found != true {
+		t.Errorf("the go-sunrise package is not found")
+	}
+}
+
+// OpenFileAndFindNthString opens a file, look for Nth string splitted by a space, and return if given expected string is found or not
+func OpenFileAndFindNthString(filename string, nth int, expected string) bool {
+	f, err := os.Open(filename)
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer f.Close()
+
+	scanner := bufio.NewScanner(f)
+	scanner.Split(bufio.ScanLines)
+
+	for scanner.Scan() {
+		t := scanner.Text()
+		trimmed := strings.Trim(t, " ")
+		if trimmed == "" {
+			continue
+		}
+
+		// matching logic
+		ss := strings.Split(trimmed, " ")
+		if ss[nth] == expected {
+			return true
+		}
+	}
+
+	return false
+}

module4/main.go

@@ -0,0 +1,7 @@
+package module4
+
+import "fmt"
+
+func main() {
+	fmt.Println("hello world")
+}

module4/module4_test.go

@@ -0,0 +1,45 @@
+package module4
+
+import (
+	"bufio"
+	"log"
+	"os"
+	"strings"
+	"testing"
+)
+
+func TestModule4GoFormatContent(t *testing.T) {
+	expected := "	github.com/codemodus/kace"
+	found := OpenFileAndFindNthString("../go.mod", 0, expected)
+	if found != true {
+		t.Errorf("the kace package is not found")
+	}
+}
+
+// OpenFileAndFindNthString opens a file, look for Nth string splitted by a space, and return if given expected string is found or not
+func OpenFileAndFindNthString(filename string, nth int, expected string) bool {
+	f, err := os.Open(filename)
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer f.Close()
+
+	scanner := bufio.NewScanner(f)
+	scanner.Split(bufio.ScanLines)
+
+	for scanner.Scan() {
+		t := scanner.Text()
+		trimmed := strings.Trim(t, " ")
+		if trimmed == "" {
+			continue
+		}
+
+		// matching logic
+		ss := strings.Split(trimmed, " ")
+		if ss[nth] == expected {
+			return true
+		}
+	}
+
+	return false
+}

module5/main.go

@@ -0,0 +1,7 @@
+package module5
+
+import "fmt"
+
+func main() {
+	fmt.Println("hello world")
+}

module5/module5_code.go

@@ -0,0 +1,11 @@
+package module5
+
+// GetExampleDotCom uses the "net/http" package to send a GET request to example.com
+func GetExampleDotCom() {
+	resp, err := http.Get("http://example.com/")
+	if err != nil {
+		fmt.Println("something went wrong")
+	}
+
+	defer resp.Body.Close()
+}

module5/module5_test.go

@@ -0,0 +1,24 @@
+package module5
+
+import (
+	"os"
+	"path"
+	"testing"
+)
+
+func TestModule5InstallationOfgoimports(t *testing.T) {
+	binPath := path.Join(os.Getenv("GOPATH"), "bin")
+	found := FindFileAtPath(binPath, "goimports")
+
+	if !found {
+		t.Errorf("goimports cannot be found")
+	}
+}
+
+// FindFileAtPath returns if theFilename is found at thePath
+func FindFileAtPath(thePath string, theFilename string) bool {
+	if _, err := os.Stat(path.Join(thePath, theFilename)); os.IsNotExist(err) {
+		return false
+	}
+	return true
+}

module6/main.go

@@ -0,0 +1,7 @@
+package module6
+
+import "fmt"
+
+func main() {
+	fmt.Println("hello world")
+}

module6/module6.go

@@ -0,0 +1,5 @@
+package module6
+
+// FunctionForModule6GoDoc is a function with some comment
+func FunctionForModule6GoDoc() {
+}

module6/module6.txt

@@ -0,0 +1,46 @@
+package module6
+
+import (
+	"bufio"
+	"log"
+	"os"
+	"strings"
+	"testing"
+)
+
+func TestModule6DummyTest(t *testing.T) {
+	found := OpenFileAndFindString("module6.txt", "func FunctionForModule6GoDoc()")
+
+	if !found {
+		t.Errorf("go doc does not work as expected")
+	}
+
+	// TODO: add more tests
+}
+
+// OpenFileAndFindString opens a file and return if the given string is found or not
+func OpenFileAndFindString(filename string, expected string) bool {
+	f, err := os.Open(filename)
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer f.Close()
+
+	scanner := bufio.NewScanner(f)
+	scanner.Split(bufio.ScanLines)
+
+	for scanner.Scan() {
+		t := scanner.Text()
+		trimmed := strings.Trim(t, " ")
+		if trimmed == "" {
+			continue
+		}
+
+		// matching logic
+		if trimmed == expected {
+			return true
+		}
+	}
+
+	return false
+}

module6/module6_test.go

@@ -0,0 +1,7 @@
+package module7
+
+import "fmt"
+
+func main() {
+	fmt.Println("hello world")
+}

module7/main.go

@@ -0,0 +1,3 @@
+package module7
+
+//go:generate goimports -w module7_code.go

module7/module7.go

@@ -0,0 +1,5 @@
+package module7
+
+func content() {
+	fmt.Println(runtime.GOOS)
+}

module7/module7_code.go

@@ -0,0 +1,9 @@
+## Purpose of this module
+This module will give you the guidance of installing `go` on MacOS and Windows.
+At the end of the module, you will have a working environment of `go`.
+
+## Installation on MacOS
+(see video)
+
+## Installation on Windows
+(see video)

task/module0.md

@@ -0,0 +1,32 @@
+## Purpose of this module
+This module will provide information about retrieving the environment information in `go`.
+Then you can examining the `go` environment manually or through a tool like `grep`.
+
+## Verify locally
+To test this module locally:
+* Open up a terminal at the project root
+* Run command `cd module1` to change to the `module1` directory
+* Run command `go test -run Module1` to run all tests for module 1, or
+* Run command `go test -v -run Module1` to run all tests for module 1 with verbose information
+
+
+## Task 1: Print the environment information
+First, refer to the [Print Go environment information](https://golang.org/cmd/go/#hdr-Print_Go_environment_information) section in the official documentation.
+
+Then, type in the command for printing the environment information.
+In this task, we only need to specify the sub-command after `go`, and do not need to specify any flags after it.
+
+## Task 2: Print the environment information and in JSON format
+By default, `go env` outputs as a shell script on Linux / MacOS and a batch script on Windows.
+
+[JavaScript Object Notation (JSON)](https://en.wikipedia.org/wiki/JSON) is a common format for data exchanging.
+
+Recall what you have read in the above documentation and check flags that are available to the `go env` command.
+What is the flag to specify the output to be in JSON format?
+
+Write the complete command (go + sub-command + flag) under your answer for Task 1.
+
+## Extra help
+Here are the commands to get more information on `go env` and `Go` environment:
+- `go help env`
+- `go help environment`