Add support for Redis for simplified init (#2904)

Add support for Redis as an in-memory DB. Python and JS libraries are autodetected. The bicep generated will host Redis using Azure Container Apps' managed add-on. Tests have been added to validate bicep correctness which largely covers the feature. Manual tests were ran additionally to verify the Container App functionality. Fixes #2902
Azure · Oct 27, 2023 · a8bfac4 · a8bfac4
1 parent 76e99cf
commit a8bfac4
Show file tree

Hide file tree

Showing 14 changed files with 85 additions and 2 deletions.
diff --git a/cli/azd/internal/appdetect/appdetect.go b/cli/azd/internal/appdetect/appdetect.go
@@ -102,6 +102,7 @@ const (
 	DbMongo     DatabaseDep = "mongo"
 	DbMySql     DatabaseDep = "mysql"
 	DbSqlServer DatabaseDep = "sqlserver"
+	DbRedis     DatabaseDep = "redis"
 )
 
 func (db DatabaseDep) Display() string {
@@ -114,6 +115,8 @@ func (db DatabaseDep) Display() string {
 		return "MySQL"
 	case DbSqlServer:
 		return "SQL Server"
+	case DbRedis:
+		return "Redis"
 	}
 
 	return ""

diff --git a/cli/azd/internal/appdetect/appdetect_test.go b/cli/azd/internal/appdetect/appdetect_test.go
@@ -59,6 +59,7 @@ func TestDetect(t *testing.T) {
 						DbMongo,
 						DbMySql,
 						DbPostgres,
+						DbRedis,
 						DbSqlServer,
 					},
 				},
@@ -80,6 +81,7 @@ func TestDetect(t *testing.T) {
 						DbMongo,
 						DbMySql,
 						DbPostgres,
+						DbRedis,
 					},
 				},
 				{

diff --git a/cli/azd/internal/appdetect/javascript.go b/cli/azd/internal/appdetect/javascript.go
@@ -69,6 +69,8 @@ func (nd *javaScriptDetector) DetectProject(path string, entries []fs.DirEntry)
 					databaseDepMap[DbPostgres] = struct{}{}
 				case "tedious":
 					databaseDepMap[DbSqlServer] = struct{}{}
+				case "redis", "redis-om":
+					databaseDepMap[DbRedis] = struct{}{}
 				}
 			}
 

diff --git a/cli/azd/internal/appdetect/python.go b/cli/azd/internal/appdetect/python.go
@@ -71,6 +71,8 @@ func (pd *pythonDetector) DetectProject(path string, entries []fs.DirEntry) (*Pr
 					"beanie",
 					"motor":
 					databaseDepMap[DbMongo] = struct{}{}
+				case "redis", "redis-om":
+					databaseDepMap[DbRedis] = struct{}{}
 				}
 			}
 

diff --git a/cli/azd/internal/appdetect/testdata/javascript-full/package.json b/cli/azd/internal/appdetect/testdata/javascript-full/package.json
@@ -15,6 +15,7 @@
     "mongodb": "^5.7.0",
     "mysql": "^2.18.1",
     "pg-promise": "^11.5.3",
-    "tedious": "^16.4.0"
+    "tedious": "^16.4.0",
+    "redis": "^4.6.10"
   }
 }
diff --git a/cli/azd/internal/appdetect/testdata/python-full/requirements.txt b/cli/azd/internal/appdetect/testdata/python-full/requirements.txt
@@ -9,3 +9,4 @@ psycopg2
 pymongo
 psycopg2-binary
 beanie
+redis
diff --git a/cli/azd/internal/repository/app_init.go b/cli/azd/internal/repository/app_init.go
@@ -33,6 +33,7 @@ var languageMap = map[appdetect.Language]project.ServiceLanguageKind{
 var dbMap = map[appdetect.DatabaseDep]struct{}{
 	appdetect.DbMongo:    {},
 	appdetect.DbPostgres: {},
+	appdetect.DbRedis:    {},
 }
 
 var ErrNoServicesDetected = errors.New("no services detected in the current directory")

diff --git a/cli/azd/internal/repository/detect_confirm.go b/cli/azd/internal/repository/detect_confirm.go
@@ -2,11 +2,13 @@ package repository
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"log"
 	"path/filepath"
 	"time"
 
+	"github.com/AlecAivazis/survey/v2/terminal"
 	"github.com/azure/azure-dev/cli/azd/internal/appdetect"
 	"github.com/azure/azure-dev/cli/azd/internal/tracing"
 	"github.com/azure/azure-dev/cli/azd/internal/tracing/fields"
@@ -124,12 +126,18 @@ func (d *detectConfirm) Confirm(ctx context.Context) error {
 			return nil
 		case 1:
 			if err := d.remove(ctx); err != nil {
+				if errors.Is(err, terminal.InterruptErr) {
+					continue
+				}
 				return err
 			}
 
 			tracing.IncrementUsageAttribute(fields.AppInitModifyRemoveCount.Int(1))
 		case 2:
 			if err := d.add(ctx); err != nil {
+				if errors.Is(err, terminal.InterruptErr) {
+					continue
+				}
 				return err
 			}
 
@@ -175,6 +183,8 @@ func (d *detectConfirm) render(ctx context.Context) error {
 			recommendedServices = append(recommendedServices, "Azure Database for PostgreSQL flexible server")
 		case appdetect.DbMongo:
 			recommendedServices = append(recommendedServices, "Azure CosmosDB API for MongoDB")
+		case appdetect.DbRedis:
+			recommendedServices = append(recommendedServices, "Azure Container Apps Redis add-on")
 		}
 
 		status := ""

diff --git a/cli/azd/internal/repository/infra_confirm.go b/cli/azd/internal/repository/infra_confirm.go
@@ -24,6 +24,10 @@ func (i *Initializer) infraSpecFromDetect(
 	detect detectConfirm) (scaffold.InfraSpec, error) {
 	spec := scaffold.InfraSpec{}
 	for database := range detect.Databases {
+		if database == appdetect.DbRedis { // no configuration needed for redis
+			continue
+		}
+
 	dbPrompt:
 		for {
 			dbName, err := i.console.Prompt(ctx, input.ConsoleOptions{
@@ -122,6 +126,10 @@ func (i *Initializer) infraSpecFromDetect(
 				serviceSpec.DbPostgres = &scaffold.DatabaseReference{
 					DatabaseName: spec.DbPostgres.DatabaseName,
 				}
+			case appdetect.DbRedis:
+				serviceSpec.DbRedis = &scaffold.DatabaseReference{
+					DatabaseName: "redis",
+				}
 			}
 		}
 		spec.Services = append(spec.Services, serviceSpec)

diff --git a/cli/azd/internal/scaffold/scaffold_test.go b/cli/azd/internal/scaffold/scaffold_test.go
@@ -111,6 +111,20 @@ func TestExecInfra(t *testing.T) {
 				},
 			},
 		},
+		{
+			"API with Redis",
+			InfraSpec{
+				Services: []ServiceSpec{
+					{
+						Name: "api",
+						Port: 3100,
+						DbRedis: &DatabaseReference{
+							DatabaseName: "redis",
+						},
+					},
+				},
+			},
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {

diff --git a/cli/azd/internal/scaffold/spec.go b/cli/azd/internal/scaffold/spec.go
@@ -40,9 +40,10 @@ type ServiceSpec struct {
 	// Back-end properties
 	Backend *Backend
 
-	// Connection to a database. Only one should be set.
+	// Connection to a database
 	DbPostgres    *DatabaseReference
 	DbCosmosMongo *DatabaseReference
+	DbRedis       *DatabaseReference
 }
 
 type Frontend struct {

diff --git a/cli/azd/resources/scaffold/templates/host-containerapp.bicept b/cli/azd/resources/scaffold/templates/host-containerapp.bicept
@@ -18,6 +18,9 @@ param databaseName string
 @secure()
 param databasePassword string
 {{- end}}
+{{- if .DbRedis}}
+param redisName string
+{{- end}}
 {{- if (and .Frontend .Frontend.Backends)}}
 param apiUrls array
 {{- end}}
@@ -74,6 +77,29 @@ module fetchLatestImage '../modules/fetch-container-image.bicep' = {
     name: name
   }
 }
+{{- if .DbRedis}}
+
+resource redis 'Microsoft.App/containerApps@2023-04-01-preview' = {
+  name: redisName
+  location: location
+  properties: {
+    environmentId: containerAppsEnvironment.id
+    configuration: {
+      service: {
+        type: 'redis'
+      }
+    }
+    template: {
+      containers: [
+        {
+          image: 'redis'
+          name: 'redis'
+        }
+      ]
+    }
+  }
+}
+{{- end}}
 
 resource app 'Microsoft.App/containerApps@2023-04-01-preview' = {
   name: name
@@ -190,6 +216,14 @@ resource app 'Microsoft.App/containerApps@2023-04-01-preview' = {
           }
         }
       ]
+      {{- if .DbRedis}}
+      serviceBinds: [
+        {
+          serviceId: redis.id
+          name: 'redis'
+        }
+      ]
+      {{- end}}
       scale: {
         minReplicas: 1
         maxReplicas: 10

diff --git a/cli/azd/resources/scaffold/templates/main.bicept b/cli/azd/resources/scaffold/templates/main.bicept
@@ -140,6 +140,9 @@ module {{bicepName .Name}} './app/{{.Name}}.bicep' = {
     containerRegistryName: registry.outputs.name
     exists: {{bicepName .Name}}Exists
     appDefinition: {{bicepName .Name}}Definition
+    {{- if .DbRedis}}
+    redisName: 'rd-{{containerAppName .Name}}-${resourceToken}'
+    {{- end}}
     {{- if .DbCosmosMongo}}
     cosmosDbConnectionString: vault.getSecret(cosmosDb.outputs.connectionStringKey)
     {{- end}}

diff --git a/cli/azd/resources/scaffold/templates/next-steps.mdt b/cli/azd/resources/scaffold/templates/next-steps.mdt
@@ -17,6 +17,7 @@
 {{- range .Services}}
     - [app/{{.Name}}.bicep](./infra/app/{{.Name}}.bicep)
 {{- end}}
+3. For services using Redis, environment variables will not show up under `env` explicitly, but are available as: `REDIS_ENDPOINT`, `REDIS_HOST`, `REDIS_PASSWORD`, and `REDIS_PORT`.
 
 ### Provision infrastructure and deploy application code