Merge pull request #36 from brunopadz/chore/write-tests

chore: write tests

Author: brunopadz

.github/workflows/tests.yml

@@ -0,0 +1,41 @@
+name: Run tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  lint:
+    name: Check lint
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - uses: reviewdog/action-staticcheck@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          reporter: github-pr-review
+          filter_mode: nofilter
+          fail_on_error: true
+
+  tests:
+    name: Run tests
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Set up
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.16
+      -
+        name: Download modules
+        run: go mod download
+      -
+        name: Unit tests
+        run: go test ./pkg/...
+      -
+        name: Generate coverage
+        run: go test -coverpkg=./pkg/... -coverprofile=coverage.out ./pkg/...

cmd/awsInspect.go

@@ -5,14 +5,12 @@ import (
 	"fmt"
 	"log"
 
-	"github.com/brunopadz/amictl/pkg/utils"
-
-	"github.com/pterm/pterm"
-
 	"github.com/aws/aws-sdk-go-v2/aws"
 	"github.com/aws/aws-sdk-go-v2/service/ec2"
 	cfg "github.com/brunopadz/amictl/config"
 	aaws "github.com/brunopadz/amictl/pkg/providers/aws"
+	"github.com/brunopadz/amictl/pkg/utils"
+	"github.com/pterm/pterm"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )

cmd/awsListUnused.go

@@ -9,8 +9,8 @@ import (
 	"github.com/aws/aws-sdk-go-v2/service/ec2"
 	"github.com/aws/aws-sdk-go-v2/service/ec2/types"
 	cfg "github.com/brunopadz/amictl/config"
-	"github.com/brunopadz/amictl/pkg/commons"
 	aaws "github.com/brunopadz/amictl/pkg/providers/aws"
+	"github.com/brunopadz/amictl/pkg/utils"
 	"github.com/pterm/pterm"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -92,7 +92,7 @@ func runUnused(cmd *cobra.Command, _ []string) error {
 			}
 		}
 
-		x = commons.Compare(AllImages, UsedImages)
+		x = utils.Compare(AllImages, UsedImages)
 
 		for _, id := range x {
 			d = append(d, []string{id, v})
@@ -104,13 +104,13 @@ func runUnused(cmd *cobra.Command, _ []string) error {
 
 	err = pterm.DefaultTable.WithHasHeader().WithData(d).Render()
 
-	if (l <= 20){
+	if l <= 20 {
 		pterm.Println(pterm.Green(fmt.Sprintf("%d AMIs are not being utilized.", l)))
 	} else if (l > 20) && (l < 50) {
 		pterm.Println(pterm.Yellow(fmt.Sprintf("%d AMIs are not being utilized.", l)))
-	} else if ( l >= 50) { 
+	} else if l >= 50 {
 		pterm.Println(pterm.Red(fmt.Sprintf("%d AMIs are not being utilized.", l)))
 	}
-		
+
 	return nil
 }

pkg/commons/compare.go pkg/utils/compare.go

@@ -1,5 +1,7 @@
-package commons
+package utils
 
+// Compare returns a slice of string with values that are not duplicated
+// by comparing two slice of strings
 func Compare(a, b []string) []string {
 	for i := len(a) - 1; i >= 0; i-- {
 		for _, v := range b {

pkg/utils/compare_test.go

@@ -0,0 +1,15 @@
+package utils
+
+import (
+	"testing"
+)
+
+func TestCompare(t *testing.T) {
+	a := []string{"foo", "bar", "baz"}
+	b := []string{"bar", "baz"}
+
+	r := Compare(a, b)
+	if r[0] != a[0] {
+		t.Errorf("Compare(a, b) = %v,; want \"foo\"", Compare(a, b))
+	}
+}

pkg/utils/empty_test.go

@@ -0,0 +1,14 @@
+package utils
+
+import (
+	"testing"
+)
+
+func TestEmptyString(t *testing.T) {
+	a := ""
+
+	if EmptyString(a) != "-" && len(a) == 0 {
+		t.Errorf("EmptyString(\"\") = %v; want \"-\"", EmptyString(a))
+	}
+
+}