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.

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

add method to extract some metadata from raw json #10

Merged
merged 3 commits into from
Nov 16, 2023
Merged

add method to extract some metadata from raw json #10

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
1f3a3e1
add method to extract some metadata from raw json
matthyx Nov 16, 2023
ea914f8
add more fields to ExtractMetadataFromJsonBytes
matthyx Nov 16, 2023
1319e6c
add benchmark
matthyx Nov 16, 2023
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
59 changes: 59 additions & 0 deletions armometadata/k8sutils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
package armometadata

import (
"bytes"
"encoding/json"
"fmt"
"hash/fnv"
"path"
"strings"

"github.com/armosec/utils-k8s-go/wlid"
"github.com/olvrng/ujson"
"github.com/spf13/viper"

metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
Expand Down Expand Up @@ -102,3 +104,60 @@ func LoadConfig(configPath string) (*ClusterConfig, error) {
err = json.Unmarshal(res, &config)
return config, err
}

// ExtractMetadataFromBytes extracts metadata from the JSON bytes of a Kubernetes object
func ExtractMetadataFromJsonBytes(input []byte) (error, map[string]string, map[string]string, map[string]string, string, string) {
// output values
annotations := map[string]string{}
labels := map[string]string{}
ownerReferences := map[string]string{}
creationTs := ""
resourceVersion := ""
// ujson parsing
var parent string
err := ujson.Walk(input, func(level int, key, value []byte) bool {
switch level {
case 1:
// skip everything except metadata
if !bytes.EqualFold(key, []byte(`"metadata"`)) {
return false
}
case 2:
// read creationTimestamp
if bytes.EqualFold(key, []byte(`"creationTimestamp"`)) {
creationTs = unquote(value)
}
// read resourceVersion
if bytes.EqualFold(key, []byte(`"resourceVersion"`)) {
resourceVersion = unquote(value)
}
// record parent for level 3
parent = unquote(key)
case 3:
// read annotations
if parent == "annotations" {
annotations[unquote(key)] = unquote(value)
}
// read labels
if parent == "labels" {
labels[unquote(key)] = unquote(value)
}
case 4:
// read ownerReferences
if parent == "ownerReferences" {
ownerReferences[unquote(key)] = unquote(value)
}

}
return true
})
return err, annotations, labels, ownerReferences, creationTs, resourceVersion
}

func unquote(value []byte) string {
buf, err := ujson.Unquote(value)
if err != nil {
return string(value)
}
return string(buf)
}
95 changes: 95 additions & 0 deletions armometadata/k8sutils_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package armometadata

import (
"fmt"
"os"
"testing"

"github.com/armosec/armoapi-go/armotypes"
Expand Down Expand Up @@ -119,3 +121,96 @@ func TestLoadClusterConfig(t *testing.T) {
func BoolPtr(b bool) *bool {
return &b
}

func TestExtractMetadataFromJsonBytes(t *testing.T) {
tests := []struct {
name string
want error
annotations map[string]string
labels map[string]string
ownerReferences map[string]string
creationTs string
resourceVersion string
}{
{
name: "applicationactivity",
annotations: map[string]string{
"kubescape.io/status": "",
"kubescape.io/wlid": "wlid://cluster-gke_armo-test-clusters_us-central1-c_danielg/namespace-kubescape/deployment-storage",
},
labels: map[string]string{
"kubescape.io/workload-api-group": "apps",
"kubescape.io/workload-api-version": "v1",
"kubescape.io/workload-kind": "Deployment",
"kubescape.io/workload-name": "storage",
"kubescape.io/workload-namespace": "kubescape",
},
ownerReferences: map[string]string{},
creationTs: "2023-11-16T10:15:05Z",
resourceVersion: "1",
},
{
name: "pod",
annotations: map[string]string{
"cni.projectcalico.org/containerID": "d2e279e2ac8fda015bce3d0acf86121f9df8fdf9bf9e028d99d41110ab1b81dc",
"cni.projectcalico.org/podIP": "10.0.2.169/32",
"cni.projectcalico.org/podIPs": "10.0.2.169/32",
},
labels: map[string]string{
"app": "kubescape",
"app.kubernetes.io/instance": "kubescape",
"app.kubernetes.io/name": "kubescape",
"helm.sh/chart": "kubescape-operator-1.16.2",
"helm.sh/revision": "1",
"otel": "enabled",
"pod-template-hash": "549f95c69",
"tier": "ks-control-plane",
},
ownerReferences: map[string]string{
"apiVersion": "apps/v1",
"blockOwnerDeletion": "true",
"controller": "true",
"kind": "ReplicaSet",
"name": "kubescape-549f95c69",
"uid": "c0ff7d3b-4183-482c-81c5-998faf0b6150",
},
creationTs: "2023-11-16T10:12:35Z",
resourceVersion: "59348379",
},
{
name: "sbom",
annotations: map[string]string{
"kubescape.io/image-id": "quay.io/kubescape/kubescape@sha256:608b85d3de51caad84a2bfe089ec2c5dbc192dbe9dc319849834bf0e678e0523",
"kubescape.io/status": "",
},
labels: map[string]string{
"kubescape.io/image-id": "quay-io-kubescape-kubescape-sha256-608b85d3de51caad84a2bfe089ec",
"kubescape.io/image-name": "quay-io-kubescape-kubescape",
},
ownerReferences: map[string]string{},
creationTs: "2023-11-16T10:13:40Z",
resourceVersion: "1",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
input, err := os.ReadFile(fmt.Sprintf("testdata/%s.json", tt.name))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@matthyx I think you forgot to commit the testdata dir?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, done

assert.NoError(t, err)
got, annotations, labels, ownerReferences, creationTs, resourceVersion := ExtractMetadataFromJsonBytes(input)
assert.Equal(t, tt.want, got)
assert.Equal(t, tt.annotations, annotations)
assert.Equal(t, tt.labels, labels)
assert.Equal(t, tt.ownerReferences, ownerReferences)
assert.Equal(t, tt.creationTs, creationTs)
assert.Equal(t, tt.resourceVersion, resourceVersion)
})
}
}

func BenchmarkExtractMetadataFromJsonBytes(b *testing.B) {
input, err := os.ReadFile("testdata/applicationactivity.json")
assert.NoError(b, err)
for i := 0; i < b.N; i++ {
_, _, _, _, _, _ = ExtractMetadataFromJsonBytes(input)
}
}
88 changes: 88 additions & 0 deletions armometadata/testdata/applicationactivity.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
{
"apiVersion": "spdx.softwarecomposition.kubescape.io/v1beta1",
"kind": "ApplicationActivity",
"metadata": {
"annotations": {
"kubescape.io/status": "",
"kubescape.io/wlid": "wlid://cluster-gke_armo-test-clusters_us-central1-c_danielg/namespace-kubescape/deployment-storage"
},
"creationTimestamp": "2023-11-16T10:15:05Z",
"labels": {
"kubescape.io/workload-api-group": "apps",
"kubescape.io/workload-api-version": "v1",
"kubescape.io/workload-kind": "Deployment",
"kubescape.io/workload-name": "storage",
"kubescape.io/workload-namespace": "kubescape"
},
"name": "kubescape-replicaset-storage-76d8b6ddfc-aced-6fcf",
"namespace": "kubescape",
"resourceVersion": "1",
"uid": "1e06cb11-4bab-4bed-bca1-8e95982a0d2e"
},
"spec": {
"syscalls": [
"newfstatat",
"setgroups",
"getpeername",
"mmap",
"getdents64",
"rt_sigreturn",
"epoll_pwait",
"execve",
"fcntl",
"getsockopt",
"prctl",
"sched_getaffinity",
"accept4",
"connect",
"pread64",
"sendto",
"uname",
"epoll_create1",
"getppid",
"mkdirat",
"readlinkat",
"madvise",
"recvfrom",
"rt_sigprocmask",
"close",
"gettid",
"setgid",
"statfs",
"getrlimit",
"nanosleep",
"getrandom",
"inotify_init1",
"clone",
"futex",
"fchown",
"fstatfs",
"getpid",
"read",
"tgkill",
"arch_prctl",
"faccessat2",
"ioctl",
"listen",
"openat",
"capset",
"getuid",
"pipe2",
"setuid",
"sigaltstack",
"bind",
"fstat",
"write",
"inotify_add_watch",
"sched_yield",
"getsockname",
"setsockopt",
"socket",
"capget",
"epoll_ctl",
"rt_sigaction",
"chdir"
]
},
"status": {}
}
Loading
Loading