Merge pull request #17 from alfrunes/device-ids

Change device ID data type from uuid.UUID to string
mendersoftware · Mar 9, 2021 · b2f86fc · b2f86fc
2 parents 0a6b516 + 607b5c5
commit b2f86fc
Show file tree

Hide file tree

Showing 20 changed files with 116 additions and 261 deletions.
diff --git a/api/http/devices.go b/api/http/devices.go
@@ -18,7 +18,6 @@ import (
 	"net/http"
 
 	"github.com/gin-gonic/gin"
-	"github.com/google/uuid"
 	"github.com/mendersoftware/go-lib-micro/identity"
 	"github.com/mendersoftware/go-lib-micro/rest.utils"
 	"github.com/pkg/errors"
@@ -50,16 +49,8 @@ func (api *DevicesAPI) SetConfiguration(c *gin.Context) {
 		return
 	}
 
-	devID, err := uuid.Parse(identity.Subject)
-	if err != nil {
-		rest.RenderError(c,
-			http.StatusBadRequest,
-			errors.Wrap(err, "malformed device ID"),
-		)
-		return
-	}
-
-	err = c.ShouldBindJSON(&configuration)
+	devID := identity.Subject
+	err := c.ShouldBindJSON(&configuration)
 	if err != nil {
 		rest.RenderError(c,
 			http.StatusBadRequest,
@@ -98,15 +89,7 @@ func (api *DevicesAPI) GetConfiguration(c *gin.Context) {
 		return
 	}
 
-	devID, err := uuid.Parse(identity.Subject)
-	if err != nil {
-		rest.RenderError(c,
-			http.StatusBadRequest,
-			errors.Wrap(err, "malformed device ID"),
-		)
-		return
-	}
-
+	devID := identity.Subject
 	device, err := api.App.GetDevice(ctx, devID)
 	if err != nil {
 		switch cause := errors.Cause(err); cause {

diff --git a/api/http/devices_test.go b/api/http/devices_test.go
@@ -65,7 +65,7 @@ func TestDevicesSetConfiguration(t *testing.T) {
 				app := new(mapp.App)
 				app.On("SetReportedConfiguration",
 					contextMatcher,
-					mock.AnythingOfType("uuid.UUID"),
+					mock.AnythingOfType("string"),
 					model.Attributes{
 						{
 							Key:   "key0",
@@ -99,7 +99,7 @@ func TestDevicesSetConfiguration(t *testing.T) {
 				app := new(mapp.App)
 				app.On("SetReportedConfiguration",
 					contextMatcher,
-					mock.AnythingOfType("uuid.UUID"),
+					mock.AnythingOfType("string"),
 					model.Attributes{
 						{
 							Key:   "key0",
@@ -231,7 +231,7 @@ func TestDevicesGetConfiguration(t *testing.T) {
 	t.Parallel()
 
 	device := model.Device{
-		ID: uuid.New(),
+		ID: uuid.New().String(),
 		ConfiguredAttributes: []model.Attribute{
 			{
 				Key:   "key1",
@@ -283,7 +283,7 @@ func TestDevicesGetConfiguration(t *testing.T) {
 				app := new(mapp.App)
 				app.On("GetDevice",
 					contextMatcher,
-					mock.AnythingOfType("uuid.UUID"),
+					mock.AnythingOfType("string"),
 				).Return(device, nil)
 				return app
 			}(),
@@ -365,7 +365,7 @@ func TestDevicesGetConfiguration(t *testing.T) {
 				app := new(mapp.App)
 				app.On("GetDevice",
 					contextMatcher,
-					mock.AnythingOfType("uuid.UUID"),
+					mock.AnythingOfType("string"),
 				).Return(device, errors.New("some other error"))
 				return app
 			}(),

diff --git a/api/http/internal.go b/api/http/internal.go
@@ -18,7 +18,6 @@ import (
 	"net/http"
 
 	"github.com/gin-gonic/gin"
-	"github.com/google/uuid"
 	"github.com/pkg/errors"
 
 	"github.com/mendersoftware/go-lib-micro/identity"
@@ -136,15 +135,7 @@ func (api *InternalAPI) DecommissionDevice(c *gin.Context) {
 	)
 	c.Request = c.Request.WithContext(ctx)
 
-	deviceUUID, err := uuid.Parse(deviceID)
-	if err != nil {
-		rest.RenderError(c, http.StatusBadRequest,
-			errors.New("device_id is not a valid UUID."),
-		)
-		return
-	}
-
-	err = api.App.DecommissionDevice(ctx, deviceUUID)
+	err := api.App.DecommissionDevice(ctx, deviceID)
 	if err != nil {
 		switch errors.Cause(err) {
 		case store.ErrDeviceNoExist:

diff --git a/api/http/internal_test.go b/api/http/internal_test.go
@@ -245,7 +245,7 @@ func TestProvisionTenant(t *testing.T) {
 
 func TestProvisionDevice(t *testing.T) {
 	t.Parallel()
-	newDeviceMatcher := func(expected uuid.UUID) interface{} {
+	newDeviceMatcher := func(expected string) interface{} {
 		return mock.MatchedBy(func(dev model.NewDevice) bool {
 			return assert.Equal(t, expected, dev.ID)
 		})
@@ -281,7 +281,7 @@ func TestProvisionDevice(t *testing.T) {
 				contextMatcher,
 				newDeviceMatcher(uuid.NewSHA1(
 					uuid.NameSpaceDNS, []byte("mender.io"),
-				)),
+				).String()),
 			).Return(nil)
 			return app
 		}(),
@@ -353,7 +353,7 @@ func TestProvisionDevice(t *testing.T) {
 				contextMatcher,
 				newDeviceMatcher(uuid.NewSHA1(
 					uuid.NameSpaceDNS, []byte("mender.io"),
-				)),
+				).String()),
 			).Return(errors.New("something went wrong!"))
 			return app
 		}(),
@@ -386,7 +386,7 @@ func TestProvisionDevice(t *testing.T) {
 				contextMatcher,
 				newDeviceMatcher(uuid.NewSHA1(
 					uuid.NameSpaceDNS, []byte("mender.io"),
-				)),
+				).String()),
 			).Return(store.ErrDeviceAlreadyExists)
 			return app
 		}(),
@@ -449,7 +449,7 @@ func TestDecommissionDevice(t *testing.T) {
 				contextMatcher,
 				uuid.NewSHA1(
 					uuid.NameSpaceDNS, []byte("mender.io"),
-				),
+				).String(),
 			).Return(nil)
 			return app
 		}(),
@@ -479,7 +479,7 @@ func TestDecommissionDevice(t *testing.T) {
 				contextMatcher,
 				uuid.NewSHA1(
 					uuid.NameSpaceDNS, []byte("mender.io"),
-				),
+				).String(),
 			).Return(errors.Wrap(store.ErrDeviceNoExist, "mongo"))
 			return app
 		}(),
@@ -488,29 +488,6 @@ func TestDecommissionDevice(t *testing.T) {
 			RequestID: "test",
 		},
 		Status: http.StatusNotFound,
-	}, {
-		Name: "error invalid request parameters",
-
-		Request: func() *http.Request {
-			repl := strings.NewReplacer(
-				":tenant_id", "123456789012345678901234",
-				":device_id", "notUUID",
-			)
-			req, _ := http.NewRequest("DELETE",
-				"http://localhost"+URIInternal+
-					repl.Replace(URITenantDevice),
-				nil,
-			)
-			req.Header.Set("X-Men-Requestid", "test")
-			return req
-		}(),
-
-		App: new(mapp.App),
-		Error: &rest.Error{
-			Err:       "device_id is not a valid UUID.",
-			RequestID: "test",
-		},
-		Status: http.StatusBadRequest,
 	}, {
 		Name: "error, internal server error",
 
@@ -536,7 +513,7 @@ func TestDecommissionDevice(t *testing.T) {
 				contextMatcher,
 				uuid.NewSHA1(
 					uuid.NameSpaceDNS, []byte("mender.io"),
-				),
+				).String(),
 			).Return(errors.New("Oh noez!"))
 			return app
 		}(),

diff --git a/api/http/management.go b/api/http/management.go
@@ -23,7 +23,6 @@ import (
 	"github.com/mendersoftware/deviceconfig/store"
 
 	"github.com/gin-gonic/gin"
-	"github.com/google/uuid"
 	"github.com/pkg/errors"
 
 	"github.com/mendersoftware/go-lib-micro/rest.utils"
@@ -50,16 +49,9 @@ func (api *ManagementAPI) SetConfiguration(c *gin.Context) {
 	var configuration model.Attributes
 
 	ctx := c.Request.Context()
-	devID, err := uuid.Parse(c.Param("device_id"))
-	if err != nil {
-		rest.RenderError(c,
-			http.StatusBadRequest,
-			errors.Wrap(err, "correctly formatted device id is needed"),
-		)
-		return
-	}
+	devID := c.Param("device_id")
 
-	err = c.ShouldBindJSON(&configuration)
+	err := c.ShouldBindJSON(&configuration)
 	if err != nil {
 		rest.RenderError(c,
 			http.StatusBadRequest,
@@ -71,7 +63,7 @@ func (api *ManagementAPI) SetConfiguration(c *gin.Context) {
 	// RBAC
 	if len(c.Request.Header.Get(model.RBACHeaderDeploymentsGroups)) > 1 {
 		allowed, err := api.isAllowed(
-			ctx, c.Request, devID.String(), model.RBACHeaderDeploymentsGroups)
+			ctx, c.Request, devID, model.RBACHeaderDeploymentsGroups)
 		if err != nil {
 			c.Error(err) //nolint:errcheck
 			rest.RenderError(c,
@@ -112,19 +104,12 @@ func (api *ManagementAPI) SetConfiguration(c *gin.Context) {
 func (api *ManagementAPI) GetConfiguration(c *gin.Context) {
 	ctx := c.Request.Context()
 
-	devID, err := uuid.Parse(c.Param("device_id"))
-	if err != nil {
-		rest.RenderError(c,
-			http.StatusBadRequest,
-			errors.Wrap(err, "correctly formatted device id is needed"),
-		)
-		return
-	}
+	devID := c.Param("device_id")
 
 	// RBAC
 	if len(c.Request.Header.Get(model.RBACHeaderInvetoryGroups)) > 1 {
 		allowed, err := api.isAllowed(
-			ctx, c.Request, devID.String(), model.RBACHeaderInvetoryGroups)
+			ctx, c.Request, devID, model.RBACHeaderInvetoryGroups)
 		if err != nil {
 			c.Error(err) //nolint:errcheck
 			rest.RenderError(c,
@@ -165,19 +150,12 @@ func (api *ManagementAPI) GetConfiguration(c *gin.Context) {
 
 func (api *ManagementAPI) DeployConfiguration(c *gin.Context) {
 	ctx := c.Request.Context()
-	devID, err := uuid.Parse(c.Param("device_id"))
-	if err != nil {
-		rest.RenderError(c,
-			http.StatusBadRequest,
-			errors.Wrap(err, "correctly formatted device id is needed"),
-		)
-		return
-	}
+	devID := c.Param("device_id")
 
 	// RBAC
 	if len(c.Request.Header.Get(model.RBACHeaderDeploymentsGroups)) > 1 {
 		allowed, err := api.isAllowed(
-			ctx, c.Request, devID.String(), model.RBACHeaderDeploymentsGroups)
+			ctx, c.Request, devID, model.RBACHeaderDeploymentsGroups)
 		if err != nil {
 			c.Error(err) //nolint:errcheck
 			rest.RenderError(c,