Added unit tests from library-registry repo

Author: cmaglie

internal/cli/check-registry/check-registry.go

@@ -1,6 +1,7 @@
 package checkregistry
 
 import (
+	"errors"
 	"fmt"
 	"os"
 	"reflect"
@@ -9,32 +10,34 @@ import (
 )
 
 func CheckRegistry(reposFile string) {
+	if err := runcheck(reposFile); err != nil {
+		fmt.Fprintf(os.Stderr, "Error: %s\n", err.Error())
+		os.Exit(1)
+	}
+}
+
+func runcheck(reposFile string) error {
 	info, err := os.Stat(reposFile)
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "error: While loading registry data file: %s\n", err)
-		os.Exit(1)
+		return fmt.Errorf("while loading registry data file: %w", err)
 	}
 
 	if info.IsDir() {
-		fmt.Fprintf(os.Stderr, "error: Registry data file argument %s is a folder, not a file\n", reposFile)
-		os.Exit(1)
+		return fmt.Errorf("registry data file argument %s is a folder, not a file", reposFile)
 	}
 
 	rawRepos, err := libraries.LoadRepoListFromFile(reposFile)
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "error: While loading registry data file: %s\n", err)
-		os.Exit(1)
+		return fmt.Errorf("while loading registry data file: %w", err)
 	}
 
 	filteredRepos, err := libraries.ListRepos(reposFile)
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "error: While filtering registry data file: %s\n", err)
-		os.Exit(1)
+		return fmt.Errorf("while filtering registry data file: %w", err)
 	}
 
 	if !reflect.DeepEqual(rawRepos, filteredRepos) {
-		fmt.Fprintln(os.Stderr, "error: Registry data file contains duplicate URLs")
-		os.Exit(1)
+		return errors.New("registry data file contains duplicate URLs")
 	}
 
 	validTypes := map[string]bool{
@@ -49,21 +52,19 @@ func CheckRegistry(reposFile string) {
 	for _, entry := range rawRepos {
 		// Check entry types
 		if len(entry.Types) == 0 {
-			fmt.Fprintf(os.Stderr, "error: Type not specified for library '%s'\n", entry.LibraryName)
-			os.Exit(1)
+			return fmt.Errorf("type not specified for library '%s'", entry.LibraryName)
 		}
 		for _, entryType := range entry.Types {
 			if _, valid := validTypes[entryType]; !valid {
-				fmt.Fprintf(os.Stderr, "error: Invalid type '%s' used by library '%s'\n", entryType, entry.LibraryName)
-				os.Exit(1)
+				return fmt.Errorf("invalid type '%s' used by library '%s'", entryType, entry.LibraryName)
 			}
 		}
 
 		// Check library name of the entry
 		if _, found := nameMap[entry.LibraryName]; found {
-			fmt.Fprintf(os.Stderr, "error: Registry data file contains duplicates of name '%s'\n", entry.LibraryName)
-			os.Exit(1)
+			return fmt.Errorf("registry data file contains duplicates of name '%s'", entry.LibraryName)
 		}
 		nameMap[entry.LibraryName] = true
 	}
+	return nil
 }

internal/cli/check-registry/check-registry_test.go

@@ -0,0 +1,37 @@
+package checkregistry
+
+import (
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestRegistryValidation(t *testing.T) {
+	type testcase struct {
+		Name           string
+		TestFile       string
+		ExpectedResult string
+	}
+	tests := []testcase{
+		{"EmptyArg", "", "registry data file argument testdata is a folder, not a file"},
+		{"NonExistentFile", "nonexistent.txt", "while loading registry data file: stat testdata/nonexistent.txt: no such file or directory"},
+		//{"InvalidDataFormat", "invalid-data-format.txt", "while loading registry data file: invalid line format (3 fields are required): https://github.com/arduino-libraries/SD.git|Partner;SD"},
+		{"InvalidUrlFormat", "invalid-url-format.txt", "while filtering registry data file: Following URL are unknown or unsupported git repos:\nhttps://github.com/arduino-libraries/SD\n"},
+		{"MissingType", "no-type.txt", "invalid type '' used by library 'SD'"},
+		{"InvalidType", "invalid-type.txt", "invalid type 'foo' used by library 'SD'"},
+		{"DuplicateRepoURL", "duplicate-url.txt", "registry data file contains duplicate URLs"},
+		{"DuplicateLibName", "duplicate-name.txt", "registry data file contains duplicates of name 'SD'"},
+		{"ValidList", "valid.txt", ""},
+	}
+	for _, test := range tests {
+		t.Run(test.Name, func(t *testing.T) {
+			err := runcheck(filepath.Join("testdata", test.TestFile))
+			if test.ExpectedResult == "" {
+				require.NoError(t, err)
+			} else {
+				require.EqualError(t, err, test.ExpectedResult)
+			}
+		})
+	}
+}

internal/cli/check-registry/testdata/duplicate-name.txt

@@ -0,0 +1,4 @@
+https://github.com/arduino-libraries/Scheduler.git|Arduino|Scheduler
+https://github.com/arduino-libraries/SD.git|Partner|SD
+https://github.com/arduino-libraries/Servo.git|Recommended|Servo
+https://github.com/arduino-libraries/Foo.git|Contributed|SD

internal/cli/check-registry/testdata/duplicate-url.txt

@@ -0,0 +1,4 @@
+https://github.com/arduino-libraries/Scheduler.git|Arduino|Scheduler
+https://github.com/arduino-libraries/SD.git|Partner|SD
+https://github.com/arduino-libraries/Servo.git|Recommended|Servo
+https://github.com/arduino-libraries/SD.git|Contributed|Foo

internal/cli/check-registry/testdata/invalid-data-format.txt

@@ -0,0 +1,3 @@
+https://github.com/arduino-libraries/Scheduler.git|Arduino|Scheduler
+https://github.com/arduino-libraries/SD.git|Partner;SD
+https://github.com/arduino-libraries/Servo.git|Recommended|Servo

internal/cli/check-registry/testdata/invalid-type.txt

@@ -0,0 +1,3 @@
+https://github.com/arduino-libraries/Scheduler.git|Arduino|Scheduler
+https://github.com/arduino-libraries/SD.git|foo|SD
+https://github.com/arduino-libraries/Servo.git|Recommended|Servo

internal/cli/check-registry/testdata/invalid-url-format.txt

@@ -0,0 +1,3 @@
+https://github.com/arduino-libraries/Scheduler.git|Arduino|Scheduler
+https://github.com/arduino-libraries/SD|Partner|SD
+https://github.com/arduino-libraries/Servo.git|Recommended|Servo

internal/cli/check-registry/testdata/no-type.txt

@@ -0,0 +1,3 @@
+https://github.com/arduino-libraries/Scheduler.git|Arduino|Scheduler
+https://github.com/arduino-libraries/SD.git||SD
+https://github.com/arduino-libraries/Servo.git|Recommended|Servo

internal/cli/check-registry/testdata/valid.txt

@@ -0,0 +1,3 @@
+https://github.com/arduino-libraries/Scheduler.git|Arduino|Scheduler
+https://github.com/arduino-libraries/SD.git|Partner|SD
+https://github.com/arduino-libraries/Servo.git|Recommended|Servo