feat: Add API Speculator module for OAS

Signed-off-by: Anurag Rajawat <[email protected]>

speculator/Dockerfile

@@ -0,0 +1,4 @@
+FROM ubuntu:latest
+LABEL authors="anurag"
+
+ENTRYPOINT ["top", "-b"]

speculator/Makefile

@@ -0,0 +1,73 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2024 Authors of SentryFlow
+
+BINARY_NAME ?= speculator
+REGISTRY ?= docker.io/5gsec
+VERSION ?= $(shell git rev-parse HEAD)
+BUILD_TS ?= $(shell date)
+DOCKER_IMAGE ?= $(REGISTRY)/$(BINARY_NAME)
+DOCKER_TAG ?= latest
+CONTAINER_TOOL ?= docker
+
+.PHONY: help
+help: ## Display this help
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+.DEFAULT_GOAL := help
+
+##@ Development
+.PHONY: run
+run: fmt vet build ## Run speculator on your host
+	@./bin/"${BINARY_NAME}" --development true
+
+.PHONY: fmt
+fmt: ## Run go fmt against code
+	@go fmt ./...
+
+.PHONY: vet
+vet: ## Run go vet against code
+	@go vet ./...
+
+GOLANGCI_LINT = $(shell pwd)/bin/golangci-lint
+GOLANGCI_LINT_VERSION ?= v1.60.3
+golangci-lint:
+	@[ -f $(GOLANGCI_LINT) ] || { \
+	set -e ;\
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell dirname $(GOLANGCI_LINT)) $(GOLANGCI_LINT_VERSION) ;\
+	}
+
+.PHONY: lint
+lint: golangci-lint ## Run golangci-lint linter
+	@$(GOLANGCI_LINT) run
+
+.PHONY: license
+license: ## Check and fix license header on all go files
+	@../scripts/add-license-header
+
+.PHONY: test
+test: ## Run unit tests
+	@go test -v ./...
+##@ Build
+
+.PHONY: build
+build: fmt vet ## Build speculator binary
+	@CGO_ENABLED=0 go build -ldflags="-s" -o bin/"${BINARY_NAME}" .
+
+.PHONY: image
+image: ## Build speculator's container image
+	$(CONTAINER_TOOL) build -t ${DOCKER_IMAGE}:${DOCKER_TAG} -f Dockerfile ../
+
+.PHONY: push
+push: ## Push speculator's container image
+	$(CONTAINER_TOOL) push ${DOCKER_IMAGE}:${DOCKER_TAG}
+
+PLATFORMS ?= linux/arm64,linux/amd64
+.PHONY: imagex
+imagex: ## Build and push speculator's container image for cross-platform support
+	# copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile
+	sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross
+	- $(CONTAINER_TOOL) buildx create --name project-v3-builder
+	$(CONTAINER_TOOL) buildx use project-v3-builder
+	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${DOCKER_IMAGE}:${DOCKER_TAG} -f Dockerfile.cross ../ || { $(CONTAINER_TOOL) buildx rm project-v3-builder; rm Dockerfile.cross; exit 1; }
+	- $(CONTAINER_TOOL) buildx rm project-v3-builder
+	rm Dockerfile.cross

speculator/cmd/root.go

@@ -0,0 +1,56 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2024 Authors of SentryFlow
+
+package cmd
+
+import (
+	"context"
+
+	"github.com/spf13/cobra"
+	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
+	ctrl "sigs.k8s.io/controller-runtime"
+
+	"github.com/5gsec/sentryflow/speculator/pkg/core"
+	"github.com/5gsec/sentryflow/speculator/pkg/util"
+)
+
+var (
+	configFilePath string
+	//kubeConfig     string
+	debugMode bool
+	logger    *zap.SugaredLogger
+)
+
+func init() {
+	RootCmd.PersistentFlags().StringVar(&configFilePath, "config", "", "config file path")
+	//RootCmd.PersistentFlags().StringVar(&kubeConfig, "kubeconfig", "", "kubeconfig file path")
+	RootCmd.PersistentFlags().BoolVar(&debugMode, "debug", false, "run in debug mode")
+}
+
+var RootCmd = &cobra.Command{
+	Use: "speculator",
+	Run: func(cmd *cobra.Command, args []string) {
+		run()
+	},
+}
+
+func run() {
+	initLogger(debugMode)
+	logBuildInfo()
+	ctx := context.WithValue(ctrl.SetupSignalHandler(), util.LoggerContextKey{}, logger)
+	core.Run(ctx, configFilePath)
+}
+
+func initLogger(debug bool) {
+	cfg := zap.NewProductionConfig()
+	cfg.EncoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
+	if debug {
+		cfg = zap.NewDevelopmentConfig()
+		cfg.EncoderConfig.EncodeLevel = zapcore.CapitalColorLevelEncoder
+	}
+	cfg.EncoderConfig.TimeKey = "timestamp"
+	cfg.EncoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
+	coreLogger, _ := cfg.Build()
+	logger = coreLogger.Sugar()
+}

speculator/cmd/version.go

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2024 Authors of SentryFlow
+
+package cmd
+
+import (
+	"runtime"
+	"runtime/debug"
+)
+
+func logBuildInfo() {
+	info, _ := debug.ReadBuildInfo()
+	vcsRev := ""
+	vcsTime := ""
+	for _, s := range info.Settings {
+		if s.Key == "vcs.revision" {
+			vcsRev = s.Value
+		} else if s.Key == "vcs.time" {
+			vcsTime = s.Value
+		}
+	}
+	logger.Infof("git revision: %s, build time: %s, build version: %s, go os/arch: %s/%s",
+		vcsRev,
+		vcsTime,
+		info.Main.Version,
+		runtime.GOOS,
+		runtime.GOARCH,
+	)
+}

speculator/config/default.yaml

@@ -0,0 +1,30 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2024 Authors of SentryFlow
+#
+#kmux:
+#  sink:
+#    stream: rabbitmq
+
+rabbitmq:
+  host: 127.0.0.1
+  port: 5672
+  username: ""
+  password: ""
+  exchange:
+    name: sentryflow
+    type: direct
+    durable: true
+    auto-delete: true
+  queueName: test
+
+database:
+  logLevel: debug
+  uri: mongodb://127.0.0.1:27017/?directConnection=true
+  user: speculator
+  password: speculator
+  name: speculator
+
+#  tls:
+#    enabled: false
+#    cert-file: ""
+#    skip-verify: false

speculator/go.mod

@@ -0,0 +1,106 @@
+module github.com/5gsec/sentryflow/speculator
+
+go 1.23.3
+
+require (
+	github.com/getkin/kin-openapi v0.128.0
+	github.com/ghodss/yaml v1.0.0
+	github.com/gofrs/uuid v4.4.0+incompatible
+	github.com/golang-jwt/jwt/v5 v5.2.1
+	github.com/sirupsen/logrus v1.9.3
+	github.com/spf13/cast v1.7.0
+	github.com/spf13/cobra v1.8.1
+	github.com/spf13/viper v1.19.0
+	github.com/xeipuuv/gojsonschema v1.2.0
+	github.com/yudai/gojsondiff v1.0.0
+	go.mongodb.org/mongo-driver v1.17.1
+	go.uber.org/zap v1.27.0
+	k8s.io/utils v0.0.0-20240711033017-18e509b52bc8
+	sigs.k8s.io/controller-runtime v0.19.2
+)
+
+require (
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
+	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
+	github.com/emicklei/go-restful/v3 v3.11.0 // indirect
+	github.com/evanphx/json-patch/v5 v5.9.0 // indirect
+	github.com/fsnotify/fsnotify v1.7.0 // indirect
+	github.com/fxamacker/cbor/v2 v2.7.0 // indirect
+	github.com/go-logr/logr v1.4.2 // indirect
+	github.com/go-openapi/jsonpointer v0.21.0 // indirect
+	github.com/go-openapi/jsonreference v0.20.2 // indirect
+	github.com/go-openapi/swag v0.23.0 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
+	github.com/golang/protobuf v1.5.4 // indirect
+	github.com/golang/snappy v0.0.4 // indirect
+	github.com/google/gnostic-models v0.6.8 // indirect
+	github.com/google/go-cmp v0.6.0 // indirect
+	github.com/google/gofuzz v1.2.0 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/imdario/mergo v0.3.6 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/invopop/yaml v0.3.1 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/klauspost/compress v1.17.2 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 // indirect
+	github.com/montanaflynn/stats v0.7.1 // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/onsi/ginkgo v1.16.5 // indirect
+	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
+	github.com/perimeterx/marshmallow v1.1.5 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/prometheus/client_golang v1.19.1 // indirect
+	github.com/prometheus/client_model v0.6.1 // indirect
+	github.com/prometheus/common v0.55.0 // indirect
+	github.com/prometheus/procfs v0.15.1 // indirect
+	github.com/sagikazarmark/locafero v0.4.0 // indirect
+	github.com/sagikazarmark/slog-shim v0.1.0 // indirect
+	github.com/sergi/go-diff v1.3.1 // indirect
+	github.com/sourcegraph/conc v0.3.0 // indirect
+	github.com/spf13/afero v1.11.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/subosito/gotenv v1.6.0 // indirect
+	github.com/x448/float16 v0.8.4 // indirect
+	github.com/xdg-go/pbkdf2 v1.0.0 // indirect
+	github.com/xdg-go/scram v1.1.2 // indirect
+	github.com/xdg-go/stringprep v1.0.4 // indirect
+	github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f // indirect
+	github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
+	github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78 // indirect
+	github.com/yudai/golcs v0.0.0-20170316035057-ecda9a501e82 // indirect
+	github.com/yudai/pp v2.0.1+incompatible // indirect
+	go.uber.org/multierr v1.11.0 // indirect
+	golang.org/x/crypto v0.26.0 // indirect
+	golang.org/x/exp v0.0.0-20230905200255-921286631fa9 // indirect
+	golang.org/x/net v0.26.0 // indirect
+	golang.org/x/oauth2 v0.21.0 // indirect
+	golang.org/x/sync v0.8.0 // indirect
+	golang.org/x/sys v0.23.0 // indirect
+	golang.org/x/term v0.23.0 // indirect
+	golang.org/x/text v0.17.0 // indirect
+	golang.org/x/time v0.5.0 // indirect
+	gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
+	google.golang.org/protobuf v1.34.2 // indirect
+	gopkg.in/inf.v0 v0.9.1 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	k8s.io/api v0.31.0 // indirect
+	k8s.io/apiextensions-apiserver v0.31.0 // indirect
+	k8s.io/apimachinery v0.31.0 // indirect
+	k8s.io/client-go v0.31.0 // indirect
+	k8s.io/klog/v2 v2.130.1 // indirect
+	k8s.io/kube-openapi v0.0.0-20240228011516-70dd3763d340 // indirect
+	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
+	sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
+	sigs.k8s.io/yaml v1.4.0 // indirect
+)