needed components for kiota based modules

Author: michaeldcanady

.vscode/settings.json

@@ -9,5 +9,17 @@
   "go.formatFlags": ["-s", "-w"],
   "go.lintOnSave": "package",
   "go.lintTool": "golangci-lint",
-  "go.lintFlags": []
+  "go.lintFlags": [],
+  "cSpell.words": [
+    "formserialization",
+    "jsonserialization",
+    "kiota",
+    "michaeldcanady",
+    "multipartserialization",
+    "nethttplibrary",
+    "nolint",
+    "servicenowsdkgo",
+    "stylecheck",
+    "textserialization"
+  ]
 }

go.mod

@@ -11,11 +11,26 @@ require (
 )
 
 require (
+	github.com/cjlapao/common-go v0.0.39 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/go-logr/logr v1.4.1 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/google/uuid v1.6.0 // indirect
 	github.com/kr/pretty v0.3.1 // indirect
 	github.com/kr/text v0.2.0 // indirect
+	github.com/microsoft/kiota-abstractions-go v1.8.1 // indirect
+	github.com/microsoft/kiota-http-go v1.4.7 // indirect
+	github.com/microsoft/kiota-serialization-form-go v1.0.0 // indirect
+	github.com/microsoft/kiota-serialization-json-go v1.0.9 // indirect
+	github.com/microsoft/kiota-serialization-multipart-go v1.0.0 // indirect
+	github.com/microsoft/kiota-serialization-text-go v1.0.0 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/rogpeppe/go-internal v1.9.0 // indirect
+	github.com/std-uritemplate/std-uritemplate/go/v2 v2.0.1 // indirect
+	github.com/stretchr/objx v0.5.2 // indirect
+	go.opentelemetry.io/otel v1.24.0 // indirect
+	go.opentelemetry.io/otel/metric v1.24.0 // indirect
+	go.opentelemetry.io/otel/trace v1.24.0 // indirect
 	golang.org/x/net v0.35.0 // indirect
 	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect

go.sum

@@ -1,12 +1,21 @@
+github.com/cjlapao/common-go v0.0.39 h1:bAAUrj2B9v0kMzbAOhzjSmiyDy+rd56r2sy7oEiQLlA=
+github.com/cjlapao/common-go v0.0.39/go.mod h1:M3dzazLjTjEtZJbbxoA5ZDiGCiHmpwqW9l4UWaddwOA=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/gabriel-vasile/mimetype v1.4.8 h1:FfZ3gj38NjllZIeJAmMhr+qKL8Wu+nOoI3GqacKw1NM=
 github.com/gabriel-vasile/mimetype v1.4.8/go.mod h1:ByKUIKGjh1ODkGM1asKUbQZOLGrPjydw3hYPU2YU9t8=
+github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
+github.com/go-logr/logr v1.4.1 h1:pKouT5E8xu9zeFC39JXRDukb6JFQPXM5p5I91188VAQ=
+github.com/go-logr/logr v1.4.1/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
+github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
+github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
 github.com/google/go-cmp v0.5.2 h1:X2ev0eStA3AbceY54o37/0PQ/UWqKEiiO2dKL5OPaFM=
 github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
 github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
@@ -17,19 +26,41 @@ github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/microsoft/kiota-abstractions-go v1.8.1 h1:0gtK3KERmbKYm5AxJLZ8WPlNR9eACUGWuofFIa01PnA=
+github.com/microsoft/kiota-abstractions-go v1.8.1/go.mod h1:YO2QCJyNM9wzvlgGLepw6s9XrPgNHODOYGVDCqQWdLI=
+github.com/microsoft/kiota-http-go v1.4.7 h1:yFmwYLlCCkeYGDZyvBgfoHWAadOwmg4XQyx35CBkwU8=
+github.com/microsoft/kiota-http-go v1.4.7/go.mod h1:Kup5nMDD3a9sjdgRKHCqZWqtrv3FbprjcPaGjLR6FzM=
+github.com/microsoft/kiota-serialization-form-go v1.0.0 h1:UNdrkMnLFqUCccQZerKjblsyVgifS11b3WCx+eFEsAI=
+github.com/microsoft/kiota-serialization-form-go v1.0.0/go.mod h1:h4mQOO6KVTNciMF6azi1J9QB19ujSw3ULKcSNyXXOMA=
+github.com/microsoft/kiota-serialization-json-go v1.0.9 h1:lJivec0G0tI6T8McBTnucyyYXczXytwcu1pt0UjWSBY=
+github.com/microsoft/kiota-serialization-json-go v1.0.9/go.mod h1:AxrS/Gbmr8y/hIp2pJcpTup/2wCE8ED+VEXkf/9xKb4=
+github.com/microsoft/kiota-serialization-multipart-go v1.0.0 h1:3O5sb5Zj+moLBiJympbXNaeV07K0d46IfuEd5v9+pBs=
+github.com/microsoft/kiota-serialization-multipart-go v1.0.0/go.mod h1:yauLeBTpANk4L03XD985akNysG24SnRJGaveZf+p4so=
+github.com/microsoft/kiota-serialization-text-go v1.0.0 h1:XOaRhAXy+g8ZVpcq7x7a0jlETWnWrEum0RhmbYrTFnA=
+github.com/microsoft/kiota-serialization-text-go v1.0.0/go.mod h1:sM1/C6ecnQ7IquQOGUrUldaO5wj+9+v7G2W3sQ3fy6M=
 github.com/mozillazg/go-httpheader v0.4.0 h1:aBn6aRXtFzyDLZ4VIRLsZbbJloagQfMnCiYgOq6hK4w=
 github.com/mozillazg/go-httpheader v0.4.0/go.mod h1:PuT8h0pw6efvp8ZeUec1Rs7dwjK08bt6gKSReGMqtdA=
 github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
 github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
+github.com/std-uritemplate/std-uritemplate/go/v2 v2.0.1 h1:/m2cTZHpqgofDsrwPqsASI6fSNMNhb+9EmUYtHEV2Uk=
+github.com/std-uritemplate/std-uritemplate/go/v2 v2.0.1/go.mod h1:Z5KcoM0YLC7INlNhEezeIZ0TZNYf7WSNO0Lvah4DSeQ=
+github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
+github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/yosida95/uritemplate/v3 v3.0.2 h1:Ed3Oyj9yrmi9087+NczuL5BwkIc4wvTb5zIM+UJPGz4=
 github.com/yosida95/uritemplate/v3 v3.0.2/go.mod h1:ILOh0sOhIJR3+L/8afwt/kE++YT040gmv5BQTMR2HP4=
+go.opentelemetry.io/otel v1.24.0 h1:0LAOdjNmQeSTzGBzduGe/rU4tZhMwL5rWgtp9Ku5Jfo=
+go.opentelemetry.io/otel v1.24.0/go.mod h1:W7b9Ozg4nkF5tWI5zsXkaKKDjdVjpD4oAt9Qi/MArHo=
+go.opentelemetry.io/otel/metric v1.24.0 h1:6EhoGWWK28x1fbpA4tYTOWBkPefTDQnb8WSGXlc88kI=
+go.opentelemetry.io/otel/metric v1.24.0/go.mod h1:VYhLe1rFfxuTXLgj4CBiyz+9WYBA8pNGJgDcSFRKBco=
+go.opentelemetry.io/otel/trace v1.24.0 h1:CsKnnL4dUAr/0llH9FKuc698G04IrpWV0MQA/Y1YELI=
+go.opentelemetry.io/otel/trace v1.24.0/go.mod h1:HPc3Xr/cOApsBI154IU0OI0HJexz+aw5uPdbs3UCjNU=
 golang.org/x/net v0.33.0 h1:74SYHlV8BIgHIFC/LrYkOGIwL19eTYXQ5wc6TBuO36I=
 golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4=
 golang.org/x/net v0.35.0 h1:T5GQRQb2y08kTAByq9L4/bz8cipCdA8FbRTXewonqY8=

internal/mocking/Readme.md

@@ -0,0 +1,5 @@
+# Mocking
+
+This is where mocking structs live, it allows for a centralized repository for all mocking implements.
+
+if a mocking struct can't exist here, due to specific constraints, they should be within a `mocking.go` file within the sub-module 

internal/mocking/mock_authentication_provider.go

@@ -0,0 +1,24 @@
+package mocking
+
+import (
+	"context"
+
+	abstractions "github.com/microsoft/kiota-abstractions-go"
+	"github.com/stretchr/testify/mock"
+)
+
+type MockAuthenticationProvider struct {
+	mock.Mock
+}
+
+func NewMockAuthenticationProvider() *MockAuthenticationProvider {
+	return &MockAuthenticationProvider{
+		mock.Mock{},
+	}
+}
+
+func (aP *MockAuthenticationProvider) AuthenticateRequest(context context.Context, request *abstractions.RequestInformation, additionalAuthenticationContext map[string]interface{}) error {
+	args := aP.Called(context, request, additionalAuthenticationContext)
+
+	return args.Error(0)
+}

internal/mocking/mock_middleware.go

@@ -0,0 +1,25 @@
+package mocking
+
+import (
+	nethttp "net/http"
+
+	nethttplibrary "github.com/microsoft/kiota-http-go"
+	"github.com/stretchr/testify/mock"
+)
+
+var _ nethttplibrary.Middleware = (*MockMiddleware)(nil)
+
+type MockMiddleware struct {
+	mock.Mock
+}
+
+func NewMockMiddleware() *MockMiddleware {
+	return &MockMiddleware{
+		mock.Mock{},
+	}
+}
+
+func (m *MockMiddleware) Intercept(pipeline nethttplibrary.Pipeline, middlewareIndex int, request *nethttp.Request) (*nethttp.Response, error) {
+	args := m.Mock.Called(pipeline, middlewareIndex, request)
+	return args.Get(0).(*nethttp.Response), args.Error(1)
+}

internal/new/Readme.md

@@ -0,0 +1,3 @@
+# New
+
+This will be the "new" internal when 2.0 is released.

internal/new/base_request_builder.go

@@ -0,0 +1,46 @@
+package internal
+
+import abstractions "github.com/microsoft/kiota-abstractions-go"
+
+type BaseRequestBuilder interface {
+	GetPathParameters() map[string]string
+	SetPathParameters(map[string]string)
+	GetRequestAdapter() abstractions.RequestAdapter
+	SetRequestAdapter(abstractions.RequestAdapter)
+	GetURLTemplate() string
+	SetURLTemplate(string)
+}
+
+type RequestBuilder struct {
+	abstractions.BaseRequestBuilder
+}
+
+func NewRequestBuilder(requestAdapter abstractions.RequestAdapter, urlTemplate string, pathParameters map[string]string) *RequestBuilder {
+	return &RequestBuilder{
+		*abstractions.NewBaseRequestBuilder(requestAdapter, urlTemplate, pathParameters),
+	}
+}
+
+func (rB *RequestBuilder) GetPathParameters() map[string]string {
+	return rB.PathParameters
+}
+
+func (rB *RequestBuilder) SetPathParameters(pathParameters map[string]string) {
+	rB.PathParameters = pathParameters
+}
+
+func (rB *RequestBuilder) GetRequestAdapter() abstractions.RequestAdapter {
+	return rB.RequestAdapter
+}
+
+func (rB *RequestBuilder) SetRequestAdapter(requestAdapter abstractions.RequestAdapter) {
+	rB.RequestAdapter = requestAdapter
+}
+
+func (rB *RequestBuilder) GetURLTemplate() string {
+	return rB.UrlTemplate
+}
+
+func (rB *RequestBuilder) SetURLTemplate(urlTemplate string) {
+	rB.UrlTemplate = urlTemplate
+}

internal/new/helper.go

@@ -0,0 +1,9 @@
+package internal
+
+import "reflect"
+
+// IsNil checks if a value is nil or a nil interface
+func IsNil(a interface{}) bool {
+	defer func() { _ = recover() }()
+	return a == nil || reflect.ValueOf(a).IsNil()
+}

internal/new/mocking.go

@@ -0,0 +1,33 @@
+package internal
+
+import "github.com/stretchr/testify/mock"
+
+type mockServiceNowClientOption struct {
+	mock.Mock
+}
+
+func newMockServiceNowClientOption() *mockServiceNowClientOption {
+	return &mockServiceNowClientOption{
+		mock.Mock{},
+	}
+}
+
+func (opt *mockServiceNowClientOption) ServiceNowClientOption(config *serviceNowClientConfig) error {
+	args := opt.Called(config)
+	return args.Error(0)
+}
+
+type mockServiceNowRequestAdapterOption struct {
+	mock.Mock
+}
+
+func newMockServiceNowRequestAdapterOption() *mockServiceNowRequestAdapterOption {
+	return &mockServiceNowRequestAdapterOption{
+		mock.Mock{},
+	}
+}
+
+func (opt *mockServiceNowRequestAdapterOption) ServiceNowClientOption(config *serviceNowRequestAdapterConfig) error {
+	args := opt.Called(config)
+	return args.Error(0)
+}

internal/new/servicenow_client_config.go

@@ -0,0 +1,53 @@
+package internal
+
+import (
+	"net/http"
+
+	nethttplibrary "github.com/microsoft/kiota-http-go"
+)
+
+// serviceNowClientConfig represents configurations for a ServiceNowClient
+type serviceNowClientConfig struct {
+	// middleware the middleware for the client
+	middleware []nethttplibrary.Middleware
+}
+
+// buildServiceNowClientConfig constructs new serviceNowClientConfig from provided options
+func buildServiceNowClientConfig(opts ...serviceNowClientOption) (*serviceNowClientConfig, error) {
+	opts = append(opts, serviceNowClientDefaultOptions())
+
+	config := new(serviceNowClientConfig)
+
+	for _, opt := range opts {
+		if err := opt(config); err != nil {
+			return nil, err
+		}
+	}
+
+	return config, nil
+}
+
+// getDefaultMiddleware returns the default middleware for a ServiceNowClient
+func getDefaultMiddleware() []nethttplibrary.Middleware {
+	kiotaMiddlewares := nethttplibrary.GetDefaultMiddlewares()
+
+	serviceNowMiddlewares := []nethttplibrary.Middleware{
+		//NewGraphTelemetryHandler(options),
+		nethttplibrary.NewHeadersInspectionHandler(),
+	}
+	graphMiddlewaresLen := len(serviceNowMiddlewares)
+	resultMiddlewares := make([]nethttplibrary.Middleware, len(kiotaMiddlewares)+graphMiddlewaresLen)
+	copy(resultMiddlewares, serviceNowMiddlewares)
+	copy(resultMiddlewares[graphMiddlewaresLen:], kiotaMiddlewares)
+	return resultMiddlewares
+}
+
+// GetDefaultClient constructs default client using provided options
+func GetDefaultClient(opts ...serviceNowClientOption) (*http.Client, error) {
+	config, err := buildServiceNowClientConfig(opts...)
+	if err != nil {
+		return nil, err
+	}
+
+	return nethttplibrary.GetDefaultClient(config.middleware...), nil
+}

internal/new/servicenow_client_config_test.go

@@ -0,0 +1,32 @@
+package internal
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/mock"
+)
+
+func TestGetDefaultClient(t *testing.T) {
+	tests := []struct {
+		name string
+		test func(*testing.T)
+	}{
+		{
+			name: "opt error",
+			test: func(t *testing.T) {
+				strct := newMockServiceNowClientOption()
+				strct.On("ServiceNowClientOption", mock.IsType(&serviceNowClientConfig{})).Return(errors.New("opt error"))
+				opt := strct.ServiceNowClientOption
+
+				_, err := GetDefaultClient(opt)
+				assert.Equal(t, errors.New("opt error"), err)
+			},
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, test.test)
+	}
+}

internal/new/servicenow_client_option.go

@@ -0,0 +1,37 @@
+package internal
+
+import (
+	"errors"
+
+	nethttplibrary "github.com/microsoft/kiota-http-go"
+)
+
+// serviceNowClientOption represents options for the ServiceNowClient
+type serviceNowClientOption func(*serviceNowClientConfig) error
+
+// WithMiddleware adds supplied middleware to the ServiceNowClientConfig
+func WithMiddleware(middleware ...nethttplibrary.Middleware) serviceNowClientOption {
+	return func(config *serviceNowClientConfig) error {
+		if len(middleware) == 0 {
+			return errors.New("middleware is empty")
+		}
+		if IsNil(config) {
+			return errors.New("config is nil")
+		}
+		if IsNil(config.middleware) {
+			config.middleware = []nethttplibrary.Middleware{}
+		}
+		config.middleware = append(config.middleware, middleware...)
+		return nil
+	}
+}
+
+func serviceNowClientDefaultOptions() serviceNowClientOption {
+	return func(config *serviceNowClientConfig) error {
+		if len(config.middleware) == 0 {
+			config.middleware = getDefaultMiddleware()
+		}
+
+		return nil
+	}
+}