Refactor NewAccessKey to return an error instead of a boolean and update tests for consistency

Author: klaidliadon

access_key.go

@@ -49,18 +49,20 @@ func (a AccessKey) GetPrefix() string {
 	return strings.Join(parts[:len(parts)-1], Separator)
 }
 
-func NewAccessKey(ctx context.Context, projectID uint64) (AccessKey, bool) {
+var ErrUnsupportedEncoding = errors.New("unsupported access key encoding")
+
+func NewAccessKey(ctx context.Context, projectID uint64) (AccessKey, error) {
 	version, ok := GetVersion(ctx)
 	if !ok {
-		return DefaultEncoding.Encode(ctx, projectID), true
+		return DefaultEncoding.Encode(ctx, projectID), nil
 	}
 
 	for _, e := range SupportedEncodings {
 		if e.Version() == version {
-			return e.Encode(ctx, projectID), true
+			return e.Encode(ctx, projectID), nil
 		}
 	}
-	return "", false
+	return "", ErrUnsupportedEncoding
 }
 
 type Encoding interface {

access_key_test.go

@@ -14,8 +14,8 @@ func TestAccessKeyEncoding(t *testing.T) {
 	t.Run("v0", func(t *testing.T) {
 		ctx := authcontrol.WithVersion(context.Background(), 0)
 		projectID := uint64(12345)
-		accessKey, ok := authcontrol.NewAccessKey(ctx, projectID)
-		require.True(t, ok)
+		accessKey, err := authcontrol.NewAccessKey(ctx, projectID)
+		require.NoError(t, err)
 		t.Log("=> k", accessKey)
 
 		outID, err := accessKey.GetProjectID()
@@ -26,8 +26,8 @@ func TestAccessKeyEncoding(t *testing.T) {
 	t.Run("v1", func(t *testing.T) {
 		ctx := authcontrol.WithVersion(context.Background(), 1)
 		projectID := uint64(12345)
-		accessKey, ok := authcontrol.NewAccessKey(ctx, projectID)
-		require.True(t, ok)
+		accessKey, err := authcontrol.NewAccessKey(ctx, projectID)
+		require.NoError(t, err)
 		t.Log("=> k", accessKey)
 		outID, err := accessKey.GetProjectID()
 		require.NoError(t, err)
@@ -36,17 +36,17 @@ func TestAccessKeyEncoding(t *testing.T) {
 	t.Run("v2", func(t *testing.T) {
 		ctx := authcontrol.WithVersion(context.Background(), 2)
 		projectID := uint64(12345)
-		accessKey, ok := authcontrol.NewAccessKey(ctx, projectID)
-		require.True(t, ok)
+		accessKey, err := authcontrol.NewAccessKey(ctx, projectID)
+		require.NoError(t, err)
 		t.Log("=> k", accessKey, "| prefix =>", accessKey.GetPrefix())
 		outID, err := accessKey.GetProjectID()
 		require.NoError(t, err)
 		require.Equal(t, projectID, outID)
 
 		ctx = authcontrol.WithPrefix(ctx, "newprefix:dev")
 
-		accessKey2, ok := authcontrol.NewAccessKey(ctx, projectID)
-		require.True(t, ok)
+		accessKey2, err := authcontrol.NewAccessKey(ctx, projectID)
+		require.NoError(t, err)
 		t.Log("=> k", accessKey2, "| prefix =>", accessKey2.GetPrefix())
 		outID, err = accessKey2.GetProjectID()
 		require.NoError(t, err)
@@ -60,8 +60,8 @@ func TestAccessKeyEncoding(t *testing.T) {
 
 func TestDecode(t *testing.T) {
 	ctx := authcontrol.WithVersion(context.Background(), 2)
-	accessKey, ok := authcontrol.NewAccessKey(ctx, 237)
-	require.True(t, ok)
+	accessKey, err := authcontrol.NewAccessKey(ctx, 237)
+	require.NoError(t, err)
 	t.Log("=> k", accessKey, "| prefix =>", accessKey.GetPrefix())
 }