Skip to content

GH-133: [GO] Tabular and Graph Attribute Validator #233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

GH-133: [GO] Tabular and Graph Attribute Validator #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54a3c1c
add attribute validator for tabular and graph structures
sehansi-9 Jun 30, 2025
1a55080
add test cases for attribute validation
sehansi-9 Jun 30, 2025
fa3dc1d
remove: remove redundant test cases from attribute validators for tab…
sehansi-9 Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions nexoan/crud-api/pkg/schema/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,3 +387,39 @@ func validateTabularValue(value interface{}, schema *SchemaInfo) error {

return nil
}

// validateTabularAttributes checks that only 'columns' and 'rows' are present as keys in the map.
func validateTabularAttributes(obj map[string]interface{}) error {
required := []string{"columns", "rows"}
// Check required keys
for _, key := range required {
if _, exists := obj[key]; !exists {
return fmt.Errorf("tabular data must contain '%s' field", key)
}
}
// Check for extra keys
for key := range obj {
if key != "columns" && key != "rows" {
return fmt.Errorf("unexpected key '%s' in tabular data; only 'columns' and 'rows' are allowed", key)
}
}
return nil
}

// validateGraphAttributes checks that only 'nodes' and 'edges' are present as keys in the map.
func validateGraphAttributes(obj map[string]interface{}) error {
required := []string{"nodes", "edges"}
// Check required keys
for _, key := range required {
if _, exists := obj[key]; !exists {
return fmt.Errorf("graph data must contain '%s' field", key)
}
}
// Check for extra keys
for key := range obj {
if key != "nodes" && key != "edges" {
return fmt.Errorf("unexpected key '%s' in graph data; only 'nodes' and 'edges' are allowed", key)
}
}
return nil
}
253 changes: 253 additions & 0 deletions nexoan/crud-api/pkg/schema/utils_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,3 +582,256 @@ func TestValidateTabularData(t *testing.T) {
})
}
}

func TestValidateTabularAttributes(t *testing.T) {
testCases := []struct {
name string
input map[string]interface{}
expectError bool
errorMsg string
}{
{
name: "valid tabular data with both required fields",
input: map[string]interface{}{
"columns": []interface{}{"id", "name", "age"},
"rows": []interface{}{
[]interface{}{1, "Alice", 30},
[]interface{}{2, "Bob", 25},
},
},
expectError: false,
},
{
name: "missing columns field",
input: map[string]interface{}{
"rows": []interface{}{
[]interface{}{1, "Alice", 30},
},
},
expectError: true,
errorMsg: "tabular data must contain 'columns' field",
},
{
name: "missing rows field",
input: map[string]interface{}{
"columns": []interface{}{"id", "name", "age"},
},
expectError: true,
errorMsg: "tabular data must contain 'rows' field",
},
{
name: "missing both required fields",
input: map[string]interface{}{
"data": "some data",
},
expectError: true,
errorMsg: "tabular data must contain 'columns' field",
},
{
name: "extra field present",
input: map[string]interface{}{
"columns": []interface{}{"id", "name"},
"rows": []interface{}{[]interface{}{1, "Alice"}},
"extra": "should not be here",
},
expectError: true,
errorMsg: "unexpected key 'extra' in tabular data; only 'columns' and 'rows' are allowed",
},
{
name: "multiple extra fields present",
input: map[string]interface{}{
"columns": []interface{}{"id", "name"},
"rows": []interface{}{[]interface{}{1, "Alice"}},
"extra1": "should not be here",
"extra2": "also should not be here",
},
expectError: true,
errorMsg: "unexpected key 'extra", // Check for partial match since order is non-deterministic
},
{
name: "empty object",
input: map[string]interface{}{},
expectError: true,
errorMsg: "tabular data must contain 'columns' field",
},
}

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
err := validateTabularAttributes(tc.input)
if tc.expectError {
assert.Error(t, err)
if tc.errorMsg != "" {
assert.Contains(t, err.Error(), tc.errorMsg)
}
} else {
assert.NoError(t, err)
}
})
}
}

func TestValidateGraphAttributes(t *testing.T) {
testCases := []struct {
name string
input map[string]interface{}
expectError bool
errorMsg string
}{
{
name: "valid graph data with both required fields",
input: map[string]interface{}{
"nodes": []interface{}{
map[string]interface{}{
"id": "1",
"type": "user",
"name": "Alice",
},
},
"edges": []interface{}{
map[string]interface{}{
"source": "1",
"target": "2",
"type": "follows",
},
},
},
expectError: false,
},
{
name: "missing nodes field",
input: map[string]interface{}{
"edges": []interface{}{
map[string]interface{}{
"source": "1",
"target": "2",
"type": "follows",
},
},
},
expectError: true,
errorMsg: "graph data must contain 'nodes' field",
},
{
name: "missing edges field",
input: map[string]interface{}{
"nodes": []interface{}{
map[string]interface{}{
"id": "1",
"type": "user",
"name": "Alice",
},
},
},
expectError: true,
errorMsg: "graph data must contain 'edges' field",
},
{
name: "missing both required fields",
input: map[string]interface{}{
"data": "some data",
},
expectError: true,
errorMsg: "graph data must contain 'nodes' field",
},
{
name: "extra field present",
input: map[string]interface{}{
"nodes": []interface{}{
map[string]interface{}{
"id": "1",
"type": "user",
},
},
"edges": []interface{}{
map[string]interface{}{
"source": "1",
"target": "2",
},
},
"extra": "should not be here",
},
expectError: true,
errorMsg: "unexpected key 'extra' in graph data; only 'nodes' and 'edges' are allowed",
},
{
name: "multiple extra fields present",
input: map[string]interface{}{
"nodes": []interface{}{
map[string]interface{}{
"id": "1",
"type": "user",
},
},
"edges": []interface{}{
map[string]interface{}{
"source": "1",
"target": "2",
},
},
"extra1": "should not be here",
"extra2": "also should not be here",
},
expectError: true,
errorMsg: "unexpected key 'extra", // Check for partial match since order is non-deterministic
},
{
name: "empty object",
input: map[string]interface{}{},
expectError: true,
errorMsg: "graph data must contain 'nodes' field",
},
{
name: "case sensitive field names",
input: map[string]interface{}{
"Nodes": []interface{}{
map[string]interface{}{
"id": "1",
"type": "user",
},
},
"Edges": []interface{}{
map[string]interface{}{
"source": "1",
"target": "2",
},
},
},
expectError: true,
errorMsg: "graph data must contain 'nodes' field",
},
{
name: "mixed case field names",
input: map[string]interface{}{
"nodes": []interface{}{
map[string]interface{}{
"id": "1",
"type": "user",
},
},
"Edges": []interface{}{
map[string]interface{}{
"source": "1",
"target": "2",
},
},
},
expectError: true,
errorMsg: "graph data must contain 'edges' field",
},
}

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
err := validateGraphAttributes(tc.input)
if tc.expectError {
assert.Error(t, err)
if tc.errorMsg != "" {
assert.Contains(t, err.Error(), tc.errorMsg)
}
} else {
assert.NoError(t, err)
}
})
}
}
Loading