Merge pull request #1 from kehoecj/main

Add Go Pipeline

.github/workflows/go.yml

@@ -0,0 +1,52 @@
+# This workflow will build a golang project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
+
+name: Go
+
+on: push
+
+jobs:
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.19
+
+    - name: Static Analysis
+      run: go vet ./...
+
+    - name: Check Formatting
+      run: if [ "$(gofmt -s -l -e . | wc -l)" -gt 0 ]; then exit 1; fi
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.19
+
+    - name: Build
+      run: CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags='-w -s -extldflags "-static"' -tags netgo -o validator cmd/validator/validator.go
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.19
+
+    - name: Test
+      run: go test -v ./...
+
+

cmd/validator/validator.go

@@ -2,7 +2,7 @@ package main
 
 import (
 	"flag"
-	"git.web.boeing.com/vle-oss/config-file-validator/pkg/cli"
+	"github.com/Boeing/config-file-validator/pkg/cli"
 	"log"
 	"os"
 	"strings"

go.mod

@@ -1,4 +1,4 @@
-module git.web.boeing.com/vle-oss/config-file-validator
+module github.com/Boeing/config-file-validator
 
 go 1.18
 

pkg/cli/cli.go

@@ -1,11 +1,11 @@
 package cli
 
 import (
-	"git.web.boeing.com/vle-oss/config-file-validator/pkg/filetype"
-	"git.web.boeing.com/vle-oss/config-file-validator/pkg/finder"
-	"git.web.boeing.com/vle-oss/config-file-validator/pkg/reporter"
-	"io/ioutil"
 	"fmt"
+	"github.com/Boeing/config-file-validator/pkg/filetype"
+	"github.com/Boeing/config-file-validator/pkg/finder"
+	"github.com/Boeing/config-file-validator/pkg/reporter"
+	"io/ioutil"
 )
 
 type CLI struct {

pkg/filetype/file_type.go

@@ -1,7 +1,7 @@
 package filetype
 
 import (
-	"git.web.boeing.com/vle-oss/config-file-validator/pkg/validator"
+	"github.com/Boeing/config-file-validator/pkg/validator"
 )
 
 // The FileType object stores information

pkg/finder/finder.go

@@ -1,7 +1,7 @@
 package finder
 
 import (
-	"git.web.boeing.com/vle-oss/config-file-validator/pkg/filetype"
+	"github.com/Boeing/config-file-validator/pkg/filetype"
 )
 
 // The File Metadata object stores the

pkg/finder/finder_test.go

@@ -1,7 +1,7 @@
 package finder
 
 import (
-	"git.web.boeing.com/vle-oss/config-file-validator/pkg/filetype"
+	"github.com/Boeing/config-file-validator/pkg/filetype"
 	"testing"
 )
 

pkg/finder/fsfinder.go

@@ -1,7 +1,7 @@
 package finder
 
 import (
-	"git.web.boeing.com/vle-oss/config-file-validator/pkg/filetype"
+	"github.com/Boeing/config-file-validator/pkg/filetype"
 	"io/fs"
 	"os"
 	"path/filepath"

pkg/validator/json.go

@@ -2,17 +2,16 @@ package validator
 
 import (
 	"encoding/json"
-	"strings"
 	"fmt"
-
+	"strings"
 )
 
 type JsonValidator struct{}
 
-// Returns a custom error message that contains the unmarshal 
+// Returns a custom error message that contains the unmarshal
 // error message along with the line and character
 // number where the error occurred when parsing the JSON
-func getCustomErr(input []byte, err error) (error) {
+func getCustomErr(input []byte, err error) error {
 	jsonError := err.(*json.SyntaxError)
 	offset := int(jsonError.Offset)
 	line := 1 + strings.Count(string(input)[:offset], "\n")

pkg/validator/validator_test.go

@@ -5,33 +5,32 @@ import (
 )
 
 var testData = []struct {
-	name string
-	testInput []byte
+	name           string
+	testInput      []byte
 	expectedResult bool
-	validator Validator
+	validator      Validator
 }{
-  {"validJson", []byte(`{"test": "test"}`), true, JsonValidator{}},
-  {"invalidJson", []byte(`{test": "test"}`), false, JsonValidator{}},
-  {"validYaml", []byte("a: 1\nb: 2"), true, YamlValidator{}},
-  {"invalidYaml", []byte("a: b\nc: d:::::::::::::::"), false, YamlValidator{}},
-  {"validXml", []byte("<test>\n</test>"), true, XmlValidator{}},
-  {"invalidXml", []byte("<xml\n"), false, XmlValidator{}},
+	{"validJson", []byte(`{"test": "test"}`), true, JsonValidator{}},
+	{"invalidJson", []byte(`{test": "test"}`), false, JsonValidator{}},
+	{"validYaml", []byte("a: 1\nb: 2"), true, YamlValidator{}},
+	{"invalidYaml", []byte("a: b\nc: d:::::::::::::::"), false, YamlValidator{}},
+	{"validXml", []byte("<test>\n</test>"), true, XmlValidator{}},
+	{"invalidXml", []byte("<xml\n"), false, XmlValidator{}},
 }
 
-
 func Test_ValidationInput(t *testing.T) {
 	for _, d := range testData {
-			valid, err := d.validator.Validate(d.testInput)
-			if valid != d.expectedResult {
-				t.Errorf("incorrect result: expected %v, got %v", d.expectedResult, valid)
-			}
-
-			if valid && err != nil {
-				t.Error("incorrect result: err was not nil", err)
-			}
+		valid, err := d.validator.Validate(d.testInput)
+		if valid != d.expectedResult {
+			t.Errorf("incorrect result: expected %v, got %v", d.expectedResult, valid)
+		}
 
-			if ! valid && err == nil {
-				t.Error("incorrect result: function returned a nil error")
-			}
+		if valid && err != nil {
+			t.Error("incorrect result: err was not nil", err)
 		}
-}
+
+		if !valid && err == nil {
+			t.Error("incorrect result: function returned a nil error")
+		}
+	}
+}

pkg/validator/xml.go

@@ -15,4 +15,4 @@ func (xv XmlValidator) Validate(b []byte) (bool, error) {
 		return false, err
 	}
 	return true, nil
-}
+}