Merge pull request #167 from jpinsonneau/316_mocks

NETOBSERV-316 loki json mocks

Author: jpinsonneau

Dockerfile

@@ -6,6 +6,7 @@ RUN npm install [email protected] -g
 RUN mkdir web && chown $USER: web
 COPY Makefile Makefile
 COPY web web
+COPY mocks mocks
 
 RUN NPM_INSTALL=ci make build-frontend
 

Makefile

@@ -2,6 +2,8 @@ IMG_USER ?= netobserv
 TAG ?= dev
 BUILD_VERSION := $(shell git describe --long HEAD)
 BUILD_DATE := $(shell date +%Y-%m-%d\ %H:%M)
+# You can add GO Build flags like -gcflags=all="-N -l" here to remove optimizations for debugging
+BUILD_FLAGS ?= -ldflags "-X 'main.buildVersion=${BUILD_VERSION}' -X 'main.buildDate=${BUILD_DATE}'"
 BUILD_SHA := $(shell git rev-parse --short HEAD)
 
 BASE_IMAGE ?= quay.io/${IMG_USER}/network-observability-console-plugin
@@ -82,7 +84,7 @@ test: test-backend test-frontend
 .PHONY: build-backend
 build-backend: fmt-backend
 	@echo "### Building backend"
-	go build -ldflags "-X 'main.buildVersion=${BUILD_VERSION}' -X 'main.buildDate=${BUILD_DATE}'" -mod vendor -o plugin-backend cmd/plugin-backend.go
+	go build ${BUILD_FLAGS} -mod vendor -o plugin-backend cmd/plugin-backend.go
 
 .PHONY: build-frontend
 build-frontend: install-frontend fmt-frontend
@@ -121,6 +123,10 @@ push:
 serve:
 	./plugin-backend
 
+.PHONY: serve-mock
+serve-mock:
+	./plugin-backend --loki-mock --loglevel trace
+
 .PHONY: start
 start: build-backend 
 	@echo "### Starting backend on http://localhost:9002"

cmd/plugin-backend.go

@@ -31,6 +31,7 @@ var (
 	lokiTimeout    = flag.Duration("loki-timeout", 10*time.Second, "Timeout of the Loki query to retrieve logs")
 	lokiTenantID   = flag.String("loki-tenant-id", "", "Tenant organization ID for multi-tenant-loki (submitted as the X-Scope-OrgID HTTP header)")
 	lokiSkipTLS    = flag.Bool("loki-skip-tls", false, "Skip TLS checks for loki HTTPS connection")
+	lokiMock       = flag.Bool("loki-mock", false, "Fake loki results using saved mocks")
 	logLevel       = flag.String("loglevel", "info", "log level (default: info)")
 	frontendConfig = flag.String("frontend-config", "", "path to the console plugin config file")
 	versionFlag    = flag.Bool("v", false, "print version")
@@ -73,7 +74,7 @@ func main() {
 		CORSAllowMethods: *corsMethods,
 		CORSAllowHeaders: *corsHeaders,
 		CORSMaxAge:       *corsMaxAge,
-		Loki:             loki.NewConfig(lURL, *lokiTimeout, *lokiTenantID, *lokiSkipTLS, strings.Split(lLabels, ",")),
+		Loki:             loki.NewConfig(lURL, *lokiTimeout, *lokiTenantID, *lokiSkipTLS, *lokiMock, strings.Split(lLabels, ",")),
 		FrontendConfig:   *frontendConfig,
 	})
 }

mocks/loki/flows.json

@@ -0,0 +1 @@
+{"status":"success","data":["","default","network-observability","openshift-apiserver","openshift-apiserver-operator","openshift-authentication","openshift-authentication-operator","openshift-cloud-credential-operator","openshift-cloud-network-config-controller","openshift-cluster-csi-drivers","openshift-cluster-node-tuning-operator","openshift-cluster-samples-operator","openshift-cluster-storage-operator","openshift-config-operator","openshift-console","openshift-console-operator","openshift-controller-manager","openshift-controller-manager-operator","openshift-dns","openshift-dns-operator","openshift-etcd-operator","openshift-image-registry","openshift-ingress","openshift-ingress-canary","openshift-ingress-operator","openshift-insights","openshift-kube-apiserver","openshift-kube-apiserver-operator","openshift-kube-controller-manager-operator","openshift-kube-scheduler-operator","openshift-kube-storage-version-migrator","openshift-kube-storage-version-migrator-operator","openshift-machine-api","openshift-machine-config-operator","openshift-marketplace","openshift-monitoring","openshift-multus","openshift-network-diagnostics","openshift-oauth-apiserver","openshift-operator-lifecycle-manager","openshift-service-ca","openshift-service-ca-operator"]}

mocks/loki/namespaces.json

@@ -0,0 +1,12 @@
+# This shell script allow you to update fake loki results from a running instance.
+# Simply run your loki on http://localhost:3100
+# or port forward it using 'oc port-forward service/loki 3100:3100 -n network-observability'
+
+# flows.json contains query result for table display
+curl -o ./loki/flows.json 'http://localhost:3100/loki/api/v1/query_range?query=\{app=%22netobserv-flowcollector%22,FlowDirection=%221%22\}&limit=100' \
+
+# topology.json contains query result for topology display
+curl -o ./loki/topology.json 'http://localhost:3100/loki/api/v1/query_range?query=topk(100,sum%20by(SrcK8S_Name,SrcK8S_Type,SrcK8S_OwnerName,SrcK8S_OwnerType,SrcK8S_Namespace,SrcAddr,SrcK8S_HostName,DstK8S_Name,DstK8S_Type,DstK8S_OwnerName,DstK8S_OwnerType,DstK8S_Namespace,DstAddr,DstK8S_HostName)%20(sum_over_time(\{app=%22netobserv-flowcollector%22,FlowDirection=%220%22\}|json|unwrap%20Bytes|__error__=%22%22\[300s\])))&limit=100&step=60s' \
+
+# namespaces.json contains label values for autocomplete 
+curl -o ./loki/namespaces.json 'http://localhost:3100/loki/api/v1/label/SrcK8S_Namespace/values'

mocks/loki/topology.json

@@ -11,6 +11,7 @@ import (
 
 	"github.com/sirupsen/logrus"
 
+	"github.com/netobserv/network-observability-console-plugin/pkg/handler/lokiclientmock"
 	"github.com/netobserv/network-observability-console-plugin/pkg/httpclient"
 	"github.com/netobserv/network-observability-console-plugin/pkg/loki"
 	"github.com/netobserv/network-observability-console-plugin/pkg/metrics"
@@ -30,6 +31,12 @@ func newLokiClient(cfg *loki.Config) httpclient.Caller {
 			lokiOrgIDHeader: {cfg.TenantID},
 		}
 	}
+
+	if cfg.UseMocks {
+		hlog.Debug("Mocking Loki Client")
+		return new(lokiclientmock.LokiClientMock)
+	}
+
 	// TODO: loki with auth
 	return httpclient.NewHTTPClient(cfg.Timeout, headers, cfg.SkipTLS)
 }

mocks/updateMocks.sh

@@ -0,0 +1,32 @@
+package lokiclientmock
+
+import (
+	"io/ioutil"
+	"strings"
+)
+
+type LokiClientMock struct {
+}
+
+func (o *LokiClientMock) Get(url string) ([]byte, int, error) {
+	var path string
+
+	isLabel := strings.Contains(url, "/label/")
+	if isLabel {
+		path = "mocks/loki/namespaces.json"
+	} else {
+		isTopology := strings.Contains(url, "query=topk")
+		if isTopology {
+			path = "mocks/loki/topology.json"
+		} else {
+			path = "mocks/loki/flows.json"
+		}
+	}
+
+	file, err := ioutil.ReadFile(path)
+	if err != nil {
+		return nil, 500, err
+	}
+
+	return []byte(file), 200, nil
+}

pkg/handler/loki.go

@@ -12,15 +12,17 @@ type Config struct {
 	Timeout  time.Duration
 	TenantID string
 	SkipTLS  bool
+	UseMocks bool
 	Labels   map[string]struct{}
 }
 
-func NewConfig(url *url.URL, timeout time.Duration, tenantID string, skipTLS bool, labels []string) Config {
+func NewConfig(url *url.URL, timeout time.Duration, tenantID string, skipTLS bool, useMocks bool, labels []string) Config {
 	return Config{
 		URL:      url,
 		Timeout:  timeout,
 		TenantID: tenantID,
 		SkipTLS:  skipTLS,
+		UseMocks: useMocks,
 		Labels:   utils.GetMapInterface(labels),
 	}
 }