Add httpassert (#270)

## What

- add http assert lib from report team

## Why

- we use this in the report team and we need that for the notification
service too

## Checklist

<!-- Remove this section if not applicable to your changes -->

- [x] Tests

Author: stefanTolksdorf

go.mod

@@ -23,6 +23,8 @@ require (
 	github.com/swaggo/files/v2 v2.0.2
 	github.com/swaggo/swag v1.16.6
 	github.com/testcontainers/testcontainers-go v0.40.0
+	github.com/tidwall/sjson v1.2.5
+	github.com/yalp/jsonpath v0.0.0-20180802001716-5cc68e5049a0
 	gorm.io/driver/postgres v1.6.0
 	gorm.io/driver/sqlite v1.6.0
 	gorm.io/gorm v1.31.1
@@ -118,6 +120,9 @@ require (
 	github.com/spf13/pflag v1.0.10 // indirect
 	github.com/stretchr/objx v0.5.3 // indirect
 	github.com/subosito/gotenv v1.6.0 // indirect
+	github.com/tidwall/gjson v1.18.0 // indirect
+	github.com/tidwall/match v1.1.1 // indirect
+	github.com/tidwall/pretty v1.2.1 // indirect
 	github.com/tklauser/go-sysconf v0.3.16 // indirect
 	github.com/tklauser/numcpus v0.11.0 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect

go.sum

@@ -282,10 +282,12 @@ github.com/swaggo/swag v1.16.6 h1:qBNcx53ZaX+M5dxVyTrgQ0PJ/ACK+NzhwcbieTt+9yI=
 github.com/swaggo/swag v1.16.6/go.mod h1:ngP2etMK5a0P3QBizic5MEwpRmluJZPHjXcMoj4Xesg=
 github.com/testcontainers/testcontainers-go v0.40.0 h1:pSdJYLOVgLE8YdUY2FHQ1Fxu+aMnb6JfVz1mxk7OeMU=
 github.com/testcontainers/testcontainers-go v0.40.0/go.mod h1:FSXV5KQtX2HAMlm7U3APNyLkkap35zNLxukw9oBi/MY=
+github.com/tidwall/gjson v1.14.2/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
 github.com/tidwall/gjson v1.18.0 h1:FIDeeyB800efLX89e5a8Y0BNH+LOngJyGrIWxG2FKQY=
 github.com/tidwall/gjson v1.18.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
 github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=
 github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=
+github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
 github.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4=
 github.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
 github.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY=
@@ -300,6 +302,8 @@ github.com/ugorji/go/codec v1.3.1 h1:waO7eEiFDwidsBN6agj1vJQ4AG7lh2yqXyOXqhgQuyY
 github.com/ugorji/go/codec v1.3.1/go.mod h1:pRBVtBSKl77K30Bv8R2P+cLSGaTtex6fsA2Wjqmfxj4=
 github.com/wI2L/jsondiff v0.7.0 h1:1lH1G37GhBPqCfp/lrs91rf/2j3DktX6qYAKZkLuCQQ=
 github.com/wI2L/jsondiff v0.7.0/go.mod h1:KAEIojdQq66oJiHhDyQez2x+sRit0vIzC9KeK0yizxM=
+github.com/yalp/jsonpath v0.0.0-20180802001716-5cc68e5049a0 h1:6fRhSjgLCkTD3JnJxvaJ4Sj+TYblw757bqYgZaOq5ZY=
+github.com/yalp/jsonpath v0.0.0-20180802001716-5cc68e5049a0/go.mod h1:/LWChgwKmvncFJFHJ7Gvn9wZArjbV5/FppcK2fKk/tI=
 github.com/yusufpapurcu/wmi v1.2.4 h1:zFUKzehAFReQwLys1b/iSMl+JQGSCSjtVqQn9bBrPo0=
 github.com/yusufpapurcu/wmi v1.2.4/go.mod h1:SBZ9tNy3G9/m5Oi98Zks0QjeHVDvuK0qfxQmPyzfmi0=
 go.opentelemetry.io/auto/sdk v1.2.1 h1:jXsnJ4Lmnqd11kwkBV2LgLoFMZKizbCi5fNZ/ipaZ64=

pkg/httpassert/README.md

@@ -0,0 +1,164 @@
+<!-- gomarkdoc:embed:start -->
+
+<!-- Code generated by gomarkdoc. DO NOT EDIT -->
+
+# httpassert
+
+```go
+import "github.com/greenbone/opensight-golang-libraries/pkg/httpassert"
+```
+
+## Index
+
+- [Constants](<#constants>)
+- [type Extractor](<#Extractor>)
+  - [func ExtractTo\(ptr any\) Extractor](<#ExtractTo>)
+- [type Matcher](<#Matcher>)
+  - [func Contains\(v string\) Matcher](<#Contains>)
+  - [func HasSize\(e int\) Matcher](<#HasSize>)
+- [type Request](<#Request>)
+  - [func New\(t \*testing.T, router http.Handler\) Request](<#New>)
+- [type Response](<#Response>)
+
+
+## Constants
+
+<a name="IgnoreJsonValue"></a>
+
+```go
+const IgnoreJsonValue = "<IGNORE>"
+```
+
+<a name="Extractor"></a>
+## type [Extractor](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/httpassert/extracter.go#L15>)
+
+
+
+```go
+type Extractor func(t *testing.T, actual any) any
+```
+
+<a name="ExtractTo"></a>
+### func [ExtractTo](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/httpassert/extracter.go#L22>)
+
+```go
+func ExtractTo(ptr any) Extractor
+```
+
+ExtractTo sets the value read from JSONPath into the given pointer variable. Example:
+
+```
+var id string
+request.Expect().JsonPath("$.data.id", httpassert.ExtractTo(&id))
+```
+
+<a name="Matcher"></a>
+## type [Matcher](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/httpassert/matcher.go#L14>)
+
+
+
+```go
+type Matcher func(t *testing.T, actual any) bool
+```
+
+<a name="Contains"></a>
+### func [Contains](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/httpassert/matcher.go#L42>)
+
+```go
+func Contains(v string) Matcher
+```
+
+Contains checks if a string contains the value Example: ExpectJsonPath\("$.data.name", httpassert.Contains\("foo"\)\)
+
+<a name="HasSize"></a>
+### func [HasSize](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/httpassert/matcher.go#L18>)
+
+```go
+func HasSize(e int) Matcher
+```
+
+HasSize checks the length of arrays, maps, or strings. Example: ExpectJsonPath\("$.data", httpassert.HasSize\(11\)\)
+
+<a name="Request"></a>
+## type [Request](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/httpassert/request.go#L23-L55>)
+
+nolint:interfacebloat Request interface provides fluent HTTP request building.
+
+```go
+type Request interface {
+    Get(path string) Request
+    Getf(format string, a ...interface{}) Request
+    Post(path string) Request
+    Postf(format string, a ...interface{}) Request
+    Put(path string) Request
+    Putf(format string, a ...interface{}) Request
+    Delete(path string) Request
+    Deletef(format string, a ...interface{}) Request
+    Options(path string) Request
+    Optionsf(format string, a ...interface{}) Request
+    Patch(path string) Request
+    Patchf(format string, a ...interface{}) Request
+
+    Perform(verb string, path string) Request
+    Performf(verb string, path string, a ...interface{}) Request
+
+    AuthHeader(header string) Request
+    Headers(headers map[string]string) Request
+    Header(key, value string) Request
+    AuthJwt(jwt string) Request
+
+    ContentType(string) Request
+
+    Content(string) Request
+    JsonContent(string) Request
+    JsonContentObject(any) Request
+    ContentFile(string) Request
+    JsonContentFile(path string) Request
+
+    Expect() Response
+    ExpectEventually(check func(r Response), timeout time.Duration, interval time.Duration) Response
+}
+```
+
+<a name="New"></a>
+### func [New](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/httpassert/request.go#L119>)
+
+```go
+func New(t *testing.T, router http.Handler) Request
+```
+
+New returns a new Request instance for the given router.
+
+<a name="Response"></a>
+## type [Response](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/httpassert/response.go#L24-L44>)
+
+nolint:interfacebloat Response interface provides fluent response assertions.
+
+```go
+type Response interface {
+    StatusCode(int) Response
+
+    JsonPath(string, any) Response
+    JsonPathJson(path string, expectedJson string) Response
+
+    ContentType(contentType string) Response
+
+    NoContent() Response
+
+    Json(json string) Response
+    JsonTemplate(json string, values map[string]any) Response
+    JsonTemplateFile(path string, values map[string]any) Response
+    JsonFile(path string) Response
+
+    Body(body string) Response
+    GetJsonBodyObject(target any) Response
+    GetBody() string
+
+    Log() Response
+}
+```
+
+Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
+
+
+<!-- gomarkdoc:embed:end -->

pkg/httpassert/extracter.go

@@ -0,0 +1,88 @@
+// SPDX-FileCopyrightText: 2025 Greenbone AG
+//
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+package httpassert
+
+import (
+	"fmt"
+	"reflect"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+type Extractor func(t *testing.T, actual any) any
+
+// ExtractTo sets the value read from JSONPath into the given pointer variable.
+// Example:
+//
+//	var id string
+//	request.Expect().JsonPath("$.data.id", httpassert.ExtractTo(&id))
+func ExtractTo(ptr any) Extractor {
+	return func(t *testing.T, actual any) any {
+		targetVal := reflect.ValueOf(ptr)
+		if targetVal.Kind() != reflect.Ptr || targetVal.IsNil() {
+			assert.Fail(t, "ExtractTo requires a non-nil pointer")
+			return nil
+		}
+
+		if actual == nil {
+			assert.Fail(t, "ExtractTo actual value is nil")
+			return nil
+		}
+
+		outVal := reflect.ValueOf(actual)
+		targetType := targetVal.Elem().Type()
+
+		// Direct assign / convert for simple values (string, int, etc.)
+		if outVal.Type().AssignableTo(targetType) {
+			targetVal.Elem().Set(outVal)
+			return ptr
+		}
+
+		if outVal.Type().ConvertibleTo(targetType) {
+			targetVal.Elem().Set(outVal.Convert(targetType))
+			return ptr
+		}
+
+		// Special handling for slices, e.g. []interface{} -> []string
+		if outVal.Kind() == reflect.Slice && targetType.Kind() == reflect.Slice {
+			elemType := targetType.Elem()
+			n := outVal.Len()
+			dst := reflect.MakeSlice(targetType, n, n)
+
+			for i := 0; i < n; i++ {
+				src := outVal.Index(i)
+
+				// If it's interface{}, unwrap to the underlying concrete value.
+				if src.Kind() == reflect.Interface && !src.IsNil() {
+					src = reflect.ValueOf(src.Interface())
+				}
+
+				if src.Type().AssignableTo(elemType) {
+					dst.Index(i).Set(src)
+					continue
+				}
+
+				if src.Type().ConvertibleTo(elemType) {
+					dst.Index(i).Set(src.Convert(elemType))
+					continue
+				}
+
+				assert.Fail(t,
+					fmt.Sprintf("ExtractTo slice element type mismatch at index %d: cannot assign %v to %v",
+						i, src.Type(), elemType))
+				return nil
+			}
+
+			targetVal.Elem().Set(dst)
+			return ptr
+		}
+
+		assert.Fail(t,
+			fmt.Sprintf("ExtractTo type mismatch: cannot assign %v to %v",
+				outVal.Type(), targetType))
+		return nil
+	}
+}

pkg/httpassert/extracter_test.go

@@ -0,0 +1,77 @@
+// SPDX-FileCopyrightText: 2025 Greenbone AG
+//
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+package httpassert
+
+import (
+	"fmt"
+	"net/http"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestExtractTo(t *testing.T) {
+	router := http.NewServeMux()
+	router.HandleFunc("/data", func(w http.ResponseWriter, r *http.Request) {
+		_, err := fmt.Fprint(w, `{"data":{
+			"id":"abc-123", 
+			"ids":["a", "b"],
+			"number":123 ,
+			"numbers":[1,2]
+   		}}`)
+		assert.NoError(t, err)
+	})
+
+	request := New(t, router)
+
+	t.Run("string", func(t *testing.T) {
+		var id string
+		request.Post("/data").
+			Content(`{"name":"appliance1"}`).
+			Expect().
+			StatusCode(http.StatusOK).
+			JsonPath("$.data.id", ExtractTo(&id))
+
+		require.NotEmpty(t, id)
+		require.Equal(t, "abc-123", id)
+	})
+
+	t.Run("string list", func(t *testing.T) {
+		var ids []string
+		request.Post("/data").
+			Content(`{"name":"appliance1"}`).
+			Expect().
+			StatusCode(http.StatusOK).
+			JsonPath("$.data.ids", ExtractTo(&ids))
+
+		require.NotEmpty(t, ids)
+		require.Equal(t, []string{"a", "b"}, ids)
+	})
+
+	t.Run("number", func(t *testing.T) {
+		var number int
+		request.Post("/data").
+			Content(`{"name":"appliance1"}`).
+			Expect().
+			StatusCode(http.StatusOK).
+			JsonPath("$.data.number", ExtractTo(&number))
+
+		require.NotEmpty(t, number)
+		require.Equal(t, 123, number)
+	})
+
+	t.Run("number list", func(t *testing.T) {
+		var numbers []int
+		request.Post("/data").
+			Content(`{"name":"appliance1"}`).
+			Expect().
+			StatusCode(http.StatusOK).
+			JsonPath("$.data.numbers", ExtractTo(&numbers))
+
+		require.NotEmpty(t, numbers)
+		require.Equal(t, []int{1, 2}, numbers)
+	})
+}