Skip to content
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.

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

chore: make empty data cleanup more aggressive #82

Merged
merged 1 commit into from
Aug 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions models/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,23 @@ func StripEmptyEntries(data map[string]any) {
} else if nested, ok := value.(map[string]any); ok { // recursively strip nested maps
StripEmptyEntries(nested)
} else if slice, ok := value.([]any); ok {
value = make([]any, len(value.([]any)))
i := 0
for _, item := range slice {
if mapValue, ok := item.(map[string]any); ok {
StripEmptyEntries(mapValue)
}
if !isEmpty(reflect.ValueOf(item)) {
value.([]any)[i] = item
i++
}
}
value = value.([]any)[:i]
}

// Strip top level if empty post recursive strip
if _, ok := data[key]; ok && isEmpty(reflect.ValueOf(value)) {
delete(data, key)
}
}
}
Expand Down
41 changes: 31 additions & 10 deletions models/utils_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package models_test

import (
"encoding/json"
"fmt"
"testing"

"github.com/bloodhoundad/azurehound/v2/models"
Expand Down Expand Up @@ -89,7 +88,14 @@ func TestStripEmptyEntries(t *testing.T) {

t.Run("should recursively strip non-empty, nested map[string]any entries", func(t *testing.T) {
data := map[string]any{
"empty": map[string]any{},
"empty": map[string]any{
"false": false,
"emptystring": "",
"emptynest": map[string]any{
"false": false,
"emptystring": "",
},
},
"nonempty": map[string]any{
"emptyprop": 0,
"nonemptyprop": 1,
Expand All @@ -106,9 +112,25 @@ func TestStripEmptyEntries(t *testing.T) {
require.Equal(t, 1, nested["nonemptyprop"])
})

t.Run("should strip non-empty slice entries of type map[string]any", func(t *testing.T) {
t.Run("should strip empty slice entries of type map[string]any", func(t *testing.T) {
data := map[string]any{
"empty": []any{},
"empty": []any{
map[string]any{
"false": false,
"emptystring": "",
},
},
"emptynestedslice": []any{
map[string]any{
"nestedslice": []any{
map[string]any{
"false": false,
"emptystring": "",
},
},
"emptystring": "",
},
},
"nonempty": []any{
map[string]any{
"emptyprop": 0,
Expand All @@ -117,13 +139,12 @@ func TestStripEmptyEntries(t *testing.T) {
},
}

fmt.Println(data["nonempty"])
models.StripEmptyEntries(data)
require.Nil(t, data["empty"])
require.Nil(t, data["emptynestedslice"])
require.NotNil(t, data["nonempty"])
require.IsType(t, []any{}, data["nonempty"])
slice := data["nonempty"].([]any)
fmt.Println(slice)
require.IsType(t, map[string]any{}, slice[0])
entry := slice[0].(map[string]any)
require.Nil(t, entry["emptyprop"])
Expand All @@ -147,7 +168,7 @@ func TestOmitEmpty(t *testing.T) {
require.Equal(t, `{}`, string(filtered))
})

t.Run("should not omit non-empty basic types", func(t *testing.T) {
t.Run("should not omit non-empty basic types except empty structs", func(t *testing.T) {
data := json.RawMessage(`{
"string": "foo",
"number": 1,
Expand All @@ -158,17 +179,17 @@ func TestOmitEmpty(t *testing.T) {

filtered, err := models.OmitEmpty(data)
require.Nil(t, err)
require.Equal(t, `{"array":[1],"boolean":true,"number":1,"object":{},"string":"foo"}`, string(filtered))
require.Equal(t, `{"array":[1],"boolean":true,"number":1,"string":"foo"}`, string(filtered))
})

t.Run("should not omit empty struct/object types, just their empty properties", func(t *testing.T) {
t.Run("should omit empty struct/object types, just their empty properties", func(t *testing.T) {
data := json.RawMessage(`{
"object": { "bar": "" }
}`)

filtered, err := models.OmitEmpty(data)
require.Nil(t, err)
require.Equal(t, `{"object":{}}`, string(filtered))
require.Equal(t, `{}`, string(filtered))
})

t.Run("should recursively strip non-empty, nested object entries", func(t *testing.T) {
Expand Down
Loading