Merge pull request #213 from RedisLabs/feat/OPCR-18-upgrade-redis-endpoint

burythehammer · web-flow · commit d9d8d7c1a545 · 2025-08-13T10:09:34.000+01:00
OPCR-18 upgrade redis endpoint
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,18 @@
 All notable changes to this project will be documented in this file.
 See updating [Changelog example here](https://keepachangelog.com/en/1.0.0/).
 
+## 0.33.0
+
+### Added:
+* Adding Upgrade Redis database endpoint
+* Adding Get Redis versions for subscription endpoint
+
+## 0.32.0
+
+### Added
+
+* Adding redisVersion support on the create, get and list endpoints for pro databases.
+
 ## 0.31.0
 
 ### Added
diff --git a/database_test.go b/database_test.go
@@ -3,6 +3,7 @@ package rediscloud_api
 import (
 	"context"
 	"fmt"
+	"net/http"
 	"net/http/httptest"
 	"testing"
 	"time"
@@ -339,67 +340,51 @@ func TestDatabase_Get_wraps404Error(t *testing.T) {
 }
 
 func TestDatabase_Update(t *testing.T) {
-	s := httptest.NewServer(testServer("key", "secret", putRequest(t, "/subscriptions/42/databases/18", `{
-  "dryRun": false,
-  "name": "example",
-  "datasetSizeInGb": 1,
-  "supportOSSClusterApi": false,
-  "respVersion": "resp3",
-  "useExternalEndpointForOSSClusterApi": false,
-  "dataEvictionPolicy": "allkeys-lru",
-  "replication": true,
-  "throughputMeasurement": {
-    "by": "operations-per-second",
-    "value": 1000
-  },
-  "regexRules": [".*"],
-  "dataPersistence": "none",
-  "replicaOf": [
-    "another"
-  ],
-  "periodicBackupPath": "s3://bucket-name",
-  "sourceIp": [
-    "10.0.0.1"
-  ],
-  "clientSslCertificate": "something",
-  "clientTlsCertificates": ["something", "new"],
-  "enableTls": false,
-  "password": "fooBar",
-  "alerts": [
-    {
-      "name": "dataset-size",
-      "value": 80
-    }
-  ],
-  "enableDefaultUser": false,
-  "queryPerformanceFactor": "2x"
-}`, `{
-  "taskId": "task",
-  "commandType": "databaseUpdateRequest",
-  "status": "received",
-  "description": "Task request received and is being queued for processing.",
-  "timestamp": "2020-11-02T09:05:34.3Z",
-  "_links": {
-    "task": {
-      "href": "https://example.org",
-      "title": "getTaskStatusUpdates",
-      "type": "GET"
-    }
-  }
-}`), getRequest(t, "/tasks/task", `{
-  "taskId": "task",
-  "commandType": "databaseUpdateRequest",
-  "status": "processing-completed",
-  "timestamp": "2020-10-28T09:58:16.798Z",
-  "response": {
-  },
-  "_links": {
-    "self": {
-      "href": "https://example.com",
-      "type": "GET"
-    }
-  }
-}`)))
+	flow := taskFlow(
+		t,
+		http.MethodPut,
+		"/subscriptions/42/databases/18",
+		`{
+		  "dryRun": false,
+		  "name": "example",
+		  "datasetSizeInGb": 1,
+		  "supportOSSClusterApi": false,
+		  "respVersion": "resp3",
+		  "useExternalEndpointForOSSClusterApi": false,
+		  "dataEvictionPolicy": "allkeys-lru",
+		  "replication": true,
+		  "throughputMeasurement": {
+		    "by": "operations-per-second",
+		    "value": 1000
+		  },
+		  "regexRules": [".*"],
+		  "dataPersistence": "none",
+		  "replicaOf": [
+		    "another"
+		  ],
+		  "periodicBackupPath": "s3://bucket-name",
+		  "sourceIp": [
+		    "10.0.0.1"
+		  ],
+		  "clientSslCertificate": "something",
+		  "clientTlsCertificates": ["something", "new"],
+		  "enableTls": false,
+		  "password": "fooBar",
+		  "alerts": [
+		    {
+		      "name": "dataset-size",
+		      "value": 80
+		    }
+		  ],
+		  "enableDefaultUser": false,
+		  "queryPerformanceFactor": "2x"
+		}`,
+		"task",
+		"databaseUpdateRequest",
+	)
+
+	s := httptest.NewServer(testServer("key", "secret", flow...))
+	defer s.Close()
 
 	subject, err := clientFromTestServer(s, "key", "secret")
 	require.NoError(t, err)
@@ -439,33 +424,17 @@ func TestDatabase_Update(t *testing.T) {
 }
 
 func TestDatabase_Delete(t *testing.T) {
-	s := httptest.NewServer(testServer("key", "secret", deleteRequest(t, "/subscriptions/42/databases/4291", `{
-  "taskId": "task",
-  "commandType": "databaseDeleteRequest",
-  "status": "received",
-  "description": "Task request received and is being queued for processing.",
-  "timestamp": "2020-11-02T09:05:34.3Z",
-  "_links": {
-    "task": {
-      "href": "https://example.org",
-      "title": "getTaskStatusUpdates",
-      "type": "GET"
-    }
-  }
-}`), getRequest(t, "/tasks/task", `{
-  "taskId": "e02b40d6-1395-4861-a3b9-ecf829d835fd",
-  "commandType": "databaseDeleteRequest",
-  "status": "processing-completed",
-  "timestamp": "2020-10-28T09:58:16.798Z",
-  "response": {
-  },
-  "_links": {
-    "self": {
-      "href": "https://example.com",
-      "type": "GET"
-    }
-  }
-}`)))
+	flow := taskFlow(
+		t,
+		http.MethodDelete,
+		"/subscriptions/42/databases/4291",
+		"",
+		"task",
+		"databaseDeleteRequest",
+	)
+
+	s := httptest.NewServer(testServer("key", "secret", flow...))
+	defer s.Close()
 
 	subject, err := clientFromTestServer(s, "key", "secret")
 	require.NoError(t, err)
@@ -475,33 +444,17 @@ func TestDatabase_Delete(t *testing.T) {
 }
 
 func TestDatabase_Backup(t *testing.T) {
-	s := httptest.NewServer(testServer("key", "secret", postRequestWithNoRequest(t, "/subscriptions/42/databases/18/backup", `{
-  "taskId": "task-uuid",
-  "commandType": "databaseBackupRequest",
-  "status": "received",
-  "description": "Task request received and is being queued for processing.",
-  "timestamp": "2020-11-02T09:05:34.3Z",
-  "_links": {
-    "task": {
-      "href": "https://example.org",
-      "title": "getTaskStatusUpdates",
-      "type": "GET"
-    }
-  }
-}`), getRequest(t, "/tasks/task-uuid", `{
-  "taskId": "task-uuid",
-  "commandType": "databaseBackupRequest",
-  "status": "processing-completed",
-  "timestamp": "2020-10-28T09:58:16.798Z",
-  "response": {
-  },
-  "_links": {
-    "self": {
-      "href": "https://example.com",
-      "type": "GET"
-    }
-  }
-}`)))
+	flow := taskFlow(
+		t,
+		http.MethodPost,
+		"/subscriptions/42/databases/18/backup",
+		"",
+		"task-uuid",
+		"databaseBackupRequest",
+	)
+
+	s := httptest.NewServer(testServer("key", "secret", flow...))
+	defer s.Close()
 
 	subject, err := clientFromTestServer(s, "key", "secret")
 	require.NoError(t, err)
@@ -511,36 +464,20 @@ func TestDatabase_Backup(t *testing.T) {
 }
 
 func TestDatabase_Import(t *testing.T) {
-	s := httptest.NewServer(testServer("key", "secret", postRequest(t, "/subscriptions/42/databases/81/import", `{
-  "sourceType": "magic",
-  "importFromUri": ["tinkerbell"]
-}`, `{
-  "taskId": "task-uuid",
-  "commandType": "databaseImportRequest",
-  "status": "received",
-  "description": "Task request received and is being queued for processing.",
-  "timestamp": "2020-11-02T09:05:34.3Z",
-  "_links": {
-    "task": {
-      "href": "https://example.org",
-      "title": "getTaskStatusUpdates",
-      "type": "GET"
-    }
-  }
-}`), getRequest(t, "/tasks/task-uuid", `{
-  "taskId": "task-uuid",
-  "commandType": "databaseImportRequest",
-  "status": "processing-completed",
-  "timestamp": "2020-10-28T09:58:16.798Z",
-  "response": {
-  },
-  "_links": {
-    "self": {
-      "href": "https://example.com",
-      "type": "GET"
-    }
-  }
-}`)))
+	flow := taskFlow(
+		t,
+		http.MethodPost,
+		"/subscriptions/42/databases/81/import",
+		`{
+		  "sourceType": "magic",
+		  "importFromUri": ["tinkerbell"]
+		}`,
+		"task-uuid",
+		"databaseImportRequest",
+	)
+
+	s := httptest.NewServer(testServer("key", "secret", flow...))
+	defer s.Close()
 
 	subject, err := clientFromTestServer(s, "key", "secret")
 	require.NoError(t, err)
@@ -567,3 +504,30 @@ func TestDatabase_Certificate(t *testing.T) {
 	}, certificate)
 
 }
+
+func TestDatabase_UpgradeRedisVersion(t *testing.T) {
+	flow := taskFlow(
+		t,
+		http.MethodPost,
+		"/subscriptions/42/databases/18/upgrade",
+		`{ "targetRedisVersion": "7.2" }`,
+		"upgrade-task-id",
+		"databaseUpgradeRequest",
+	)
+
+	s := httptest.NewServer(testServer("key", "secret", flow...))
+	defer s.Close()
+
+	subject, err := clientFromTestServer(s, "key", "secret")
+	require.NoError(t, err)
+
+	err = subject.Database.UpgradeRedisVersion(
+		context.TODO(),
+		42,
+		18,
+		databases.UpgradeRedisVersion{
+			TargetRedisVersion: redis.String("7.2"),
+		},
+	)
+	require.NoError(t, err)
+}
diff --git a/service/databases/model.go b/service/databases/model.go
@@ -198,6 +198,14 @@ type Import struct {
 	ImportFromURI []*string `json:"importFromUri,omitempty"`
 }
 
+type UpgradeRedisVersion struct {
+	TargetRedisVersion *string `json:"targetRedisVersion,omitempty"`
+}
+
+func (o UpgradeRedisVersion) String() string {
+	return internal.ToString(o)
+}
+
 func (o Import) String() string {
 	return internal.ToString(o)
 }
diff --git a/service/databases/service.go b/service/databases/service.go
@@ -86,6 +86,19 @@ func (a *API) Update(ctx context.Context, subscription int, database int, update
 	return a.taskWaiter.Wait(ctx, *task.ID)
 }
 
+// UpgradeRedisVersion will upgrade the Redis version of an existing database.
+func (a *API) UpgradeRedisVersion(ctx context.Context, subscription int, database int, upgradeVersion UpgradeRedisVersion) error {
+	var task internal.TaskResponse
+	err := a.client.Post(ctx, fmt.Sprintf("upgrade database %d version for subscription %d", database, subscription), fmt.Sprintf("/subscriptions/%d/databases/%d/upgrade", subscription, database), upgradeVersion, &task)
+	if err != nil {
+		return err
+	}
+
+	a.logger.Printf("Waiting for database %d for subscription %d to finish being upgraded", database, subscription)
+
+	return a.taskWaiter.Wait(ctx, *task.ID)
+}
+
 // Delete will destroy an existing database.
 func (a *API) Delete(ctx context.Context, subscription int, database int) error {
 	var task internal.TaskResponse
diff --git a/service/subscriptions/model.go b/service/subscriptions/model.go
@@ -320,6 +320,17 @@ type ActiveActiveDatabase struct {
 	WriteOperationsPerSecond *int    `json:"writeOperationsPerSecond,omitempty"`
 }
 
+type RedisVersion struct {
+	Version   *string `json:"version,omitempty"`
+	EolDate   *string `json:"eolDate,omitempty"`
+	IsPreview *bool   `json:"isPreview,omitempty"`
+	IsDefault *bool   `json:"isDefault,omitempty"`
+}
+
+type RedisVersions struct {
+	RedisVersions []*RedisVersion `json:"redisVersions,omitempty"`
+}
+
 type NotFound struct {
 	ID int
 }
diff --git a/service/subscriptions/service.go b/service/subscriptions/service.go
@@ -267,6 +267,25 @@ func (a *API) ListActiveActiveRegions(ctx context.Context, subscription int) ([]
 	return response.Regions, nil
 }
 
+// GetRedisVersions retrieves the Redis database versions available for this subscription.
+func (a *API) GetRedisVersions(ctx context.Context, subscription int) (*RedisVersions, error) {
+	var redisVersions RedisVersions
+	getRedisVersionsUrl := "/subscriptions/redis-versions?subscriptionId=%d"
+
+	path := fmt.Sprintf(getRedisVersionsUrl, subscription)
+	err := a.client.Get(
+		ctx,
+		fmt.Sprintf("get versions for subscription %d", subscription),
+		path,
+		&redisVersions,
+	)
+
+	if err != nil {
+		return nil, wrap404Error(subscription, err)
+	}
+	return &redisVersions, nil
+}
+
 func wrap404Error(id int, err error) error {
 	if v, ok := err.(*internal.HTTPError); ok && v.StatusCode == http.StatusNotFound {
 		return &NotFound{ID: id}
diff --git a/subscription_test.go b/subscription_test.go
diff --git a/util_test.go b/util_test.go

Original file line number	Diff line number	Diff line change
`@@ -198,6 +198,14 @@ type Import struct {`
`198`	`198`	ImportFromURI []*string `json:"importFromUri,omitempty"`
`199`	`199`	`}`
`200`	`200`
	`201`	`+type UpgradeRedisVersion struct {`
	`202`	+ TargetRedisVersion *string `json:"targetRedisVersion,omitempty"`
	`203`	`+}`
	`204`	`+`
	`205`	`+func (o UpgradeRedisVersion) String() string {`
	`206`	`+ return internal.ToString(o)`
	`207`	`+}`
	`208`	`+`
`201`	`209`	`func (o Import) String() string {`
`202`	`210`	`return internal.ToString(o)`
`203`	`211`	`}`