1927964654

Committed 15 Jul 2025 01:18PM UTC coverage: 65.511% (+0.06%) from 65.454%

Build # 1927964654

Build Type

Pull #783

gitlab-ci

Committed by

bahaa-ghazal

Commit Message

feat: Integrate requestsize middleware into useradm

Title: None
Signed-off-by: Bahaa Aldeen Ghazal <bahaa.ghazal@northern.tech>

Pull Request Pull Request #783: feat: Implemented gin request body size limiter middleware

Run Details

131 of 139 new or added lines in 17 files covered. (94.24%)

6 existing lines in 1 file now uncovered.

32173 of 49111 relevant lines covered (65.51%)

1.4 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

81.58

/backend/services/reporting/api/http/router.go

// Copyright 2023 Northern.tech AS
//
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.

package http

import (
        "github.com/gin-gonic/gin"

        "github.com/mendersoftware/mender-server/pkg/identity"
        "github.com/mendersoftware/mender-server/pkg/rbac"
        "github.com/mendersoftware/mender-server/pkg/requestsize"
        "github.com/mendersoftware/mender-server/pkg/routing"

        "github.com/mendersoftware/mender-server/services/reporting/app/reporting"
        dconfig "github.com/mendersoftware/mender-server/services/reporting/config"
)

// API URL used by the HTTP router
const (
        URIInternal   = "/api/internal/v1/reporting"
        URIManagement = "/api/management/v1/reporting"

        URIAlive                   = "/alive"
        URIHealth                  = "/health"
        URIDeploymentsAggregate    = "/deployments/devices/aggregate"
        URIDeploymentsSearch       = "/deployments/devices/search"
        URIInventoryAggregate      = "/devices/aggregate"
        URIInventoryAttrs          = "/devices/attributes"
        URIInventorySearch         = "/devices/search"
        URIInventorySearchAttrs    = "/devices/search/attributes"
        URIInventorySearchInternal = "/tenants/:tenant_id/devices/search"
)

type Config struct {
        MaxRequestSize int64
}

func NewConfig() *Config {
        return &Config{
                MaxRequestSize: dconfig.SettingMaxRequestSizeDefault,
        }
}

type Option func(c *Config)

func SetMaxRequestSize(size int64) Option {
        return func(c *Config) {
                c.MaxRequestSize = size
        }
}

// NewRouter returns the gin router
func NewRouter(reporting reporting.App, options ...Option) *gin.Engine {
        config := NewConfig()
        for _, option := range options {
                if option != nil {
                        option(config)
                }
        }

        router := routing.NewGinRouter()
        router.Use(requestsize.Middleware(config.MaxRequestSize))

        internal := NewInternalController(reporting)
        internalAPI := router.Group(URIInternal)
        internalAPI.GET(URIAlive, internal.Alive)
        internalAPI.GET(URIHealth, internal.Health)
        internalAPI.POST(URIInventorySearchInternal, internal.SearchDevices)

        mgmt := NewManagementController(reporting)
        mgmtAPI := router.Group(URIManagement)
        mgmtAPI.Use(identity.Middleware())
        mgmtAPI.Use(rbac.Middleware())
        // devices
        mgmtAPI.POST(URIInventoryAggregate, mgmt.AggregateDevices)
        mgmtAPI.GET(URIInventoryAttrs, mgmt.DeviceAttrs)
        mgmtAPI.POST(URIInventorySearch, mgmt.SearchDevices)
        mgmtAPI.GET(URIInventorySearchAttrs, mgmt.SearchDeviceAttrs)
        // deployments
        mgmtAPI.POST(URIDeploymentsAggregate, mgmt.AggregateDeployments)
        mgmtAPI.POST(URIDeploymentsSearch, mgmt.SearchDeployments)

        return router
}

1	// Copyright 2023 Northern.tech AS
2	//
3	// Licensed under the Apache License, Version 2.0 (the "License");
4	// you may not use this file except in compliance with the License.
5	// You may obtain a copy of the License at
6	//
7	// http://www.apache.org/licenses/LICENSE-2.0
8	//
9	// Unless required by applicable law or agreed to in writing, software
10	// distributed under the License is distributed on an "AS IS" BASIS,
11	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12	// See the License for the specific language governing permissions and
13	// limitations under the License.
14
15	package http
16
17	import (
18	"github.com/gin-gonic/gin"
19
20	"github.com/mendersoftware/mender-server/pkg/identity"
21	"github.com/mendersoftware/mender-server/pkg/rbac"
22	"github.com/mendersoftware/mender-server/pkg/requestsize"
23	"github.com/mendersoftware/mender-server/pkg/routing"
24
25	"github.com/mendersoftware/mender-server/services/reporting/app/reporting"
26	dconfig "github.com/mendersoftware/mender-server/services/reporting/config"
27	)
28
29	// API URL used by the HTTP router
30	const (
31	URIInternal = "/api/internal/v1/reporting"
32	URIManagement = "/api/management/v1/reporting"
33
34	URIAlive = "/alive"
35	URIHealth = "/health"
36	URIDeploymentsAggregate = "/deployments/devices/aggregate"
37	URIDeploymentsSearch = "/deployments/devices/search"
38	URIInventoryAggregate = "/devices/aggregate"
39	URIInventoryAttrs = "/devices/attributes"
40	URIInventorySearch = "/devices/search"
41	URIInventorySearchAttrs = "/devices/search/attributes"
42	URIInventorySearchInternal = "/tenants/:tenant_id/devices/search"
43	)
44
45	type Config struct {
46	MaxRequestSize int64
47	}
48
49	func NewConfig() *Config {	1✔
50	return &Config{	1✔
51	MaxRequestSize: dconfig.SettingMaxRequestSizeDefault,	1✔
52	}	1✔
53	}	1✔
54
55	type Option func(c *Config)
56
NEW 57	func SetMaxRequestSize(size int64) Option {	×
NEW 58	return func(c *Config) {	×
NEW 59	c.MaxRequestSize = size	×
NEW 60	}	×
61	}
62
63	// NewRouter returns the gin router
64	func NewRouter(reporting reporting.App, options ...Option) *gin.Engine {	1✔
65	config := NewConfig()	1✔
66	for _, option := range options {	1✔
NEW 67	if option != nil {	×
NEW 68	option(config)	×
NEW 69	}	×
70	}
71
72	router := routing.NewGinRouter()	1✔
73	router.Use(requestsize.Middleware(config.MaxRequestSize))	1✔
74		1✔
75	internal := NewInternalController(reporting)	1✔
76	internalAPI := router.Group(URIInternal)	1✔
77	internalAPI.GET(URIAlive, internal.Alive)	1✔
78	internalAPI.GET(URIHealth, internal.Health)	1✔
79	internalAPI.POST(URIInventorySearchInternal, internal.SearchDevices)	1✔
80		1✔
81	mgmt := NewManagementController(reporting)	1✔
82	mgmtAPI := router.Group(URIManagement)	1✔
83	mgmtAPI.Use(identity.Middleware())	1✔
84	mgmtAPI.Use(rbac.Middleware())	1✔
85	// devices	1✔
86	mgmtAPI.POST(URIInventoryAggregate, mgmt.AggregateDevices)	1✔
87	mgmtAPI.GET(URIInventoryAttrs, mgmt.DeviceAttrs)	1✔
88	mgmtAPI.POST(URIInventorySearch, mgmt.SearchDevices)	1✔
89	mgmtAPI.GET(URIInventorySearchAttrs, mgmt.SearchDeviceAttrs)	1✔
90	// deployments	1✔
91	mgmtAPI.POST(URIDeploymentsAggregate, mgmt.AggregateDeployments)	1✔
92	mgmtAPI.POST(URIDeploymentsSearch, mgmt.SearchDeployments)	1✔
93		1✔
94	return router	1✔
95	}

mendersoftware / mender-server / 1927964654

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous