[SERV-1241] Check visibility values (#151)

* [SERV-1241] new check, related error msg, some styling

* [SERV-1241] fix typo, add test

---------

Co-authored-by: Kevin S. Clarke <[email protected]>

Author: DRickard

errors/errors.go

@@ -2,24 +2,25 @@ package errors
 
 // Error messages
 var (
-	NilProfileErr        = "supplied profile cannot be nil"
-	NoPrefixErr          = "ARK must start with 'ark:/'"
-	NaanTooShortErr      = "NAAN must be at least 5 digits long"
-	NaanProfileErr       = "The supplied NAAN is not allowed for the supplied profile"
-	NoObjIdErr           = "The ARK must contain an object identifier"
-	InvalidObjIdErr      = "The object identifier and qualifier is not valid"
-	ArkValFailed         = "ARK validation failed"
-	EolFoundErr          = "character for EOL found in cell"
-	BadHeaderErr         = "could not retrieve CSV header: %s"
-	FieldNotFoundErr     = "required field `%s` was not found"
-	FieldDataNotFoundErr = "data for required field `%s` was not found"
-	UnknownProfileErr    = "unknown profile `%s`"
-	ProfileConfigErr     = "supplied profile has objTypes and notObjTypes set: %s"
-	NoHostDir            = "a HOST_DIR must be set"
-	FileNotExist         = "the file path given does not exist: %s"
-	UrlFormatErr         = "license URL is not in a proper format (check for HTTPS)"
-	UrlConnectErr        = "problem connecting to license URL"
-	UrlReadErr           = "problem reading body of license URL"
-	TypeWhitespaceError  = "field contains invalid characters (e.g., spaces, line breaks)"
-	TypeValueError       = "object type field doesn't contain valid value"
+	NilProfileErr         = "supplied profile cannot be nil"
+	NoPrefixErr           = "ARK must start with 'ark:/'"
+	NaanTooShortErr       = "NAAN must be at least 5 digits long"
+	NaanProfileErr        = "The supplied NAAN is not allowed for the supplied profile"
+	NoObjIdErr            = "The ARK must contain an object identifier"
+	InvalidObjIdErr       = "The object identifier and qualifier is not valid"
+	ArkValFailed          = "ARK validation failed"
+	EolFoundErr           = "character for EOL found in cell"
+	BadHeaderErr          = "could not retrieve CSV header: %s"
+	FieldNotFoundErr      = "required field `%s` was not found"
+	FieldDataNotFoundErr  = "data for required field `%s` was not found"
+	UnknownProfileErr     = "unknown profile `%s`"
+	ProfileConfigErr      = "supplied profile has objTypes and notObjTypes set: %s"
+	NoHostDir             = "a HOST_DIR must be set"
+	FileNotExist          = "the file path given does not exist: %s"
+	UrlFormatErr          = "license URL is not in a proper format (check for HTTPS)"
+	UrlConnectErr         = "problem connecting to license URL"
+	UrlReadErr            = "problem reading body of license URL"
+	TypeWhitespaceError   = "field contains invalid characters (e.g., spaces, line breaks)"
+	TypeValueError        = "object type field doesn't contain valid value"
+	VisibilityValueError  = "ovisibility field doesn't contain valid value"
 )

validation/checks/visibility_check.go

@@ -0,0 +1,50 @@
+package checks
+
+import (
+	"regexp"
+
+	"github.com/UCLALibrary/validation-service/errors"
+	"github.com/UCLALibrary/validation-service/validation/csv"
+	"github.com/UCLALibrary/validation-service/validation/util"
+)
+
+type VisibilityCheck struct{}
+
+func NewVisibilityCheck(profiles *util.Profiles) (*VisibilityCheck, error) {
+	if profiles == nil {
+		return nil, csv.NewError(errors.NilProfileErr, csv.Location{}, "nil")
+	}
+
+	return &VisibilityCheck{}, nil
+}
+
+func (check *VisibilityCheck) Validate(profile string, location csv.Location, csvData [][]string) error {
+	if err := csv.IsValidLocation(location, csvData, profile); err != nil {
+		return err
+	}
+
+	// find the header and determine if it matches Object Type
+	header, err := csv.GetHeader(location, csvData, profile)
+
+	if err != nil {
+		return err
+	}
+
+	// Skip if we don't have an object tpe cell, or we're on the first (i.e., header) row
+	if header != "Visibility" || location.RowIndex == 0 {
+		return nil
+	}
+
+	value := csvData[location.RowIndex][location.ColIndex]
+
+	whitespace := regexp.MustCompile(`\s`)
+	if whitespace.MatchString(value) {
+		return csv.NewError(errors.TypeWhitespaceError, location, profile)
+	}
+	valid := regexp.MustCompile(`open|ucla|private`)
+	if !valid.MatchString(value) {
+		return csv.NewError(errors.VisibilityValueError, location, profile)
+	}
+
+	return nil
+}

validation/checks/visibility_check_test.go

@@ -0,0 +1,55 @@
+//go:build unit
+
+// Package checks consists of individual validation checks.
+//
+package checks
+
+import (
+	"github.com/UCLALibrary/validation-service/validation/csv"
+	"github.com/UCLALibrary/validation-service/validation/util"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+// TestObjTypeCheck_Validate tests the Validate method on ObjTypeCheck.
+func TestVisibilityCheck_Validate(t *testing.T) {
+	check, err := NewVisibilityCheck(util.NewProfiles())
+	assert.NoError(t, err)
+
+	// Data variations to check the VisibilityCheck.Validate method against
+	tests := []struct {
+		name     string
+		location csv.Location
+		data     [][]string
+		result   bool
+	}{
+		{
+			name:     "valid",
+			location: csv.Location{RowIndex: 1, ColIndex: 0},
+			data:     [][]string{{"Visibility"}, {"ucla"}},
+			result:   true,
+		},
+		{
+			name:     "invalid Bad Value",
+			location: csv.Location{RowIndex: 1, ColIndex: 0},
+			data:     [][]string{{"Visibility"}, {"Other"}},
+			result:   false,
+		},
+		{
+			name:     "invalid Bad Chars",
+			location: csv.Location{RowIndex: 1, ColIndex: 0},
+			data:     [][]string{{"Visibility"}, {"private "}},
+			result:   false,
+		},
+	}
+
+	// Iterate over test cases; fail if there isn't an error when we expect one or if there is an unexpected error
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			err = check.Validate("default", tt.location, tt.data)
+			if (err != nil && tt.result) || (err == nil && !tt.result) {
+				t.Errorf("Expected '%v' response was not found: %v", tt.name, err)
+			}
+		})
+	}
+}