Merge pull request #33 from mach-composer/feat/update-vercel-plugin-provider-version

Jeffrey-Zutt · web-flow · commit d3343f25c389 · 2024-08-12T15:06:19.000+02:00
feat: make plugin compatible with provider v1.12.0
diff --git a/.changes/unreleased/changes.md b/.changes/unreleased/changes.md
@@ -0,0 +1,2 @@
+### Compatibility
+* Vercel provider now requires field deployment_type instead of protect_production.
diff --git a/internal/config.go b/internal/config.go
@@ -18,10 +18,10 @@ func NewVercelConfig() VercelConfig {
 
 		ProjectConfig: ProjectConfig{
 			PasswordProtection: PasswordProtection{
-				ProtectProduction: true,
+				DeploymentType: "standard_protection",
 			},
 			VercelAuthentication: VercelAuthentication{
-				ProtectProduction: true,
+				DeploymentType: "standard_protection",
 			},
 		},
 	}
@@ -130,11 +130,11 @@ func (c *ProjectConfig) extendConfig(o *ProjectConfig) *ProjectConfig {
 			cfg.ProtectionBypassForAutomation = c.ProtectionBypassForAutomation
 		}
 
-		if !c.VercelAuthentication.ProtectProduction {
-			cfg.VercelAuthentication.ProtectProduction = c.VercelAuthentication.ProtectProduction
+		if c.VercelAuthentication.DeploymentType != "" {
+			cfg.VercelAuthentication.DeploymentType = c.VercelAuthentication.DeploymentType
 		}
 
-		if c.PasswordProtection.Password != "" || !c.PasswordProtection.ProtectProduction {
+		if c.PasswordProtection.Password != "" {
 			cfg.PasswordProtection = c.PasswordProtection
 		}
 
@@ -189,12 +189,12 @@ func (c *GitRepository) extendConfig(o *GitRepository) *GitRepository {
 }
 
 type PasswordProtection struct {
-	Password          string `mapstructure:"password"`
-	ProtectProduction bool   `mapstructure:"protect_production"`
+	Password       string `mapstructure:"password"`
+	DeploymentType string `mapstructure:"deployment_type"`
 }
 
 type VercelAuthentication struct {
-	ProtectProduction bool `mapstructure:"protect_production"`
+	DeploymentType string `mapstructure:"deployment_type"`
 }
 
 type ProjectEnvironmentVariable struct {
diff --git a/internal/plugin.go b/internal/plugin.go
@@ -20,7 +20,7 @@ type VercelPlugin struct {
 
 func NewVercelPlugin() schema.MachComposerPlugin {
 	state := &VercelPlugin{
-		provider:    "0.15.1", // Provider version of `vercel/vercel`
+		provider:    "1.12.0", // Provider version of `vercel/vercel`
 		siteConfigs: map[string]*VercelConfig{},
 	}
 	return plugin.NewPlugin(&schema.PluginSchema{
@@ -188,11 +188,11 @@ func (p *VercelPlugin) RenderTerraformComponent(site string, component string) (
 		{{ renderProperty "vercel_project_manual_production_deployment" .ProjectConfig.ManualProductionDeployment }}
 		{{ renderProperty "vercel_project_protection_bypass_for_automation" .ProjectConfig.ProtectionBypassForAutomation }}
 		vercel_project_vercel_authentication = {
-			{{ renderProperty "protect_production" .ProjectConfig.VercelAuthentication.ProtectProduction }}
+			{{ renderProperty "deployment_type" .ProjectConfig.VercelAuthentication.DeploymentType }}
 		}
 		vercel_project_password_protection = {
 			{{ renderProperty "password" .ProjectConfig.PasswordProtection.Password }}
-			{{ renderProperty "protect_production" .ProjectConfig.PasswordProtection.ProtectProduction }}
+			{{ renderProperty "deployment_type" .ProjectConfig.PasswordProtection.DeploymentType }}
 		}
 		vercel_project_git_repository = {	
 			{{ renderProperty "production_branch" .ProjectConfig.GitRepository.ProductionBranch }}
diff --git a/internal/plugin_test.go b/internal/plugin_test.go
@@ -52,11 +52,11 @@ func TestSetVercelConfig(t *testing.T) {
 			"domains":                          domains,
 			"protection_bypass_for_automation": true,
 			"vercel_authentication": map[string]any{
-				"protect_production": true,
+				"deployment_type": "only_preview_deployments",
 			},
 			"password_protection": map[string]any{
-				"password":           "MyPassword",
-				"protect_production": true,
+				"password":        "MyPassword",
+				"deployment_type": "only_preview_deployments",
 			},
 		},
 	}
@@ -89,7 +89,7 @@ func TestSetVercelConfig(t *testing.T) {
 	assert.Contains(t, component.Variables, "type = \"github\"")
 	assert.Contains(t, component.Variables, "repo = \"mach-composer/my-project\"")
 	assert.Contains(t, component.Variables, "protection_bypass_for_automation = true")
-	assert.Contains(t, component.Variables, "protect_production = true")
+	assert.Contains(t, component.Variables, "deployment_type = \"only_preview_deployments\"")
 	assert.Contains(t, component.Variables, "password = \"MyPassword\"")
 
 	// Test environment variables
@@ -121,11 +121,11 @@ func TestInheritance(t *testing.T) {
 			"manual_production_deployment":     true,
 			"protection_bypass_for_automation": true,
 			"vercel_authentication": map[string]any{
-				"protect_production": true,
+				"deployment_type": "standard_protection",
 			},
 			"password_protection": map[string]any{
-				"password":           "MyPassword",
-				"protect_production": true,
+				"password":        "MyPassword",
+				"deployment_type": "standard_protection",
 			},
 			"environment_variables": globalVariables,
 		},
@@ -145,10 +145,11 @@ func TestInheritance(t *testing.T) {
 		"api_token": "test-token-override",
 		"project_config": map[string]any{
 			"vercel_authentication": map[string]any{
-				"protect_production": false,
+				"deployment_type": "standard_protection",
 			},
 			"password_protection": map[string]any{
-				"protect_production": false,
+				"password":        "MyPassword",
+				"deployment_type": "standard_protection",
 			},
 			"environment_variables": siteVariables,
 		},
@@ -175,7 +176,7 @@ func TestInheritance(t *testing.T) {
 	// Test whether environment variables get extended
 	assert.Contains(t, component.Variables, "environment = [\"development\", \"preview\", \"production\"]")
 	assert.Contains(t, component.Variables, "environment = [\"production\", \"preview\"]")
-	assert.Contains(t, component.Variables, "protect_production = false")
+	assert.Contains(t, component.Variables, "deployment_type = \"standard_protection\"")
 
 	assert.Contains(t, component.Variables, "environment")
 }
diff --git a/internal/schemas/component-config.json b/internal/schemas/component-config.json
@@ -95,8 +95,8 @@
         "vercel_authentication": {
           "type": "object",
           "properties": {
-            "protect_production": {
-              "type": "boolean"
+            "deployment_type": {
+              "enum": ["standard_protection", "all_deployments", "only_production_deployments", "only_preview_deployments"]
             }
           }
         },
@@ -106,8 +106,8 @@
             "password": {
               "type": "string"
             },
-            "protect_production": {
-              "type": "boolean"
+            "deployment_type": {
+              "enum": ["standard_protection", "all_deployments", "only_production_deployments", "only_preview_deployments"]
             }
           }
         }
diff --git a/internal/schemas/global-config.json b/internal/schemas/global-config.json
@@ -95,8 +95,8 @@
         "vercel_authentication": {
           "type": "object",
           "properties": {
-            "protect_production": {
-              "type": "boolean"
+            "deployment_type": {
+              "enum": ["standard_protection", "all_deployments", "only_production_deployments", "only_preview_deployments"]
             }
           }
         },
@@ -106,8 +106,8 @@
             "password": {
               "type": "string"
             },
-            "protect_production": {
-              "type": "boolean"
+            "deployment_type": {
+              "enum": ["standard_protection", "all_deployments", "only_production_deployments", "only_preview_deployments"]
             }
           }
         }
diff --git a/internal/schemas/site-config.json b/internal/schemas/site-config.json
@@ -94,8 +94,8 @@
         "vercel_authentication": {
           "type": "object",
           "properties": {
-            "protect_production": {
-              "type": "boolean"
+            "deployment_type": {
+              "enum": ["standard_protection", "all_deployments", "only_production_deployments", "only_preview_deployments"]
             }
           }
         },
@@ -105,8 +105,8 @@
             "password": {
               "type": "string"
             },
-            "protect_production": {
-              "type": "boolean"
+            "deployment_type": {
+              "enum": ["standard_protection", "all_deployments", "only_production_deployments", "only_preview_deployments"]
             }
           }
         }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+### Compatibility`
	`2`	`+* Vercel provider now requires field deployment_type instead of protect_production.`
Original file line number	Diff line number	Diff line change
`@@ -18,10 +18,10 @@ func NewVercelConfig() VercelConfig {`
`18`	`18`
`19`	`19`	`ProjectConfig: ProjectConfig{`
`20`	`20`	`PasswordProtection: PasswordProtection{`
`21`		`- ProtectProduction: true,`
	`21`	`+ DeploymentType: "standard_protection",`
`22`	`22`	`},`
`23`	`23`	`VercelAuthentication: VercelAuthentication{`
`24`		`- ProtectProduction: true,`
	`24`	`+ DeploymentType: "standard_protection",`
`25`	`25`	`},`
`26`	`26`	`},`
`27`	`27`	`}`
`@@ -130,11 +130,11 @@ func (c ProjectConfig) extendConfig(o ProjectConfig) *ProjectConfig {`
`130`	`130`	`cfg.ProtectionBypassForAutomation = c.ProtectionBypassForAutomation`
`131`	`131`	`}`
`132`	`132`
`133`		`- if !c.VercelAuthentication.ProtectProduction {`
`134`		`- cfg.VercelAuthentication.ProtectProduction = c.VercelAuthentication.ProtectProduction`
	`133`	`+ if c.VercelAuthentication.DeploymentType != "" {`
	`134`	`+ cfg.VercelAuthentication.DeploymentType = c.VercelAuthentication.DeploymentType`
`135`	`135`	`}`
`136`	`136`
`137`		`- if c.PasswordProtection.Password != "" \|\| !c.PasswordProtection.ProtectProduction {`
	`137`	`+ if c.PasswordProtection.Password != "" {`
`138`	`138`	`cfg.PasswordProtection = c.PasswordProtection`
`139`	`139`	`}`
`140`	`140`
`@@ -189,12 +189,12 @@ func (c GitRepository) extendConfig(o GitRepository) *GitRepository {`
`189`	`189`	`}`
`190`	`190`
`191`	`191`	`type PasswordProtection struct {`
`192`		- Password string `mapstructure:"password"`
`193`		- ProtectProduction bool `mapstructure:"protect_production"`
	`192`	+ Password string `mapstructure:"password"`
	`193`	+ DeploymentType string `mapstructure:"deployment_type"`
`194`	`194`	`}`
`195`	`195`
`196`	`196`	`type VercelAuthentication struct {`
`197`		- ProtectProduction bool `mapstructure:"protect_production"`
	`197`	+ DeploymentType string `mapstructure:"deployment_type"`
`198`	`198`	`}`
`199`	`199`
`200`	`200`	`type ProjectEnvironmentVariable struct {`
Original file line number	Diff line number	Diff line change
`@@ -95,8 +95,8 @@`
`95`	`95`	`"vercel_authentication": {`
`96`	`96`	`"type": "object",`
`97`	`97`	`"properties": {`
`98`		`- "protect_production": {`
`99`		`- "type": "boolean"`
	`98`	`+ "deployment_type": {`
	`99`	`+ "enum": ["standard_protection", "all_deployments", "only_production_deployments", "only_preview_deployments"]`
`100`	`100`	`}`
`101`	`101`	`}`
`102`	`102`	`},`
`@@ -106,8 +106,8 @@`
`106`	`106`	`"password": {`
`107`	`107`	`"type": "string"`
`108`	`108`	`},`
`109`		`- "protect_production": {`
`110`		`- "type": "boolean"`
	`109`	`+ "deployment_type": {`
	`110`	`+ "enum": ["standard_protection", "all_deployments", "only_production_deployments", "only_preview_deployments"]`
`111`	`111`	`}`
`112`	`112`	`}`
`113`	`113`	`}`
Original file line number	Diff line number	Diff line change
`@@ -94,8 +94,8 @@`
`94`	`94`	`"vercel_authentication": {`
`95`	`95`	`"type": "object",`
`96`	`96`	`"properties": {`
`97`		`- "protect_production": {`
`98`		`- "type": "boolean"`
	`97`	`+ "deployment_type": {`
	`98`	`+ "enum": ["standard_protection", "all_deployments", "only_production_deployments", "only_preview_deployments"]`
`99`	`99`	`}`
`100`	`100`	`}`
`101`	`101`	`},`
`@@ -105,8 +105,8 @@`
`105`	`105`	`"password": {`
`106`	`106`	`"type": "string"`
`107`	`107`	`},`
`108`		`- "protect_production": {`
`109`		`- "type": "boolean"`
	`108`	`+ "deployment_type": {`
	`109`	`+ "enum": ["standard_protection", "all_deployments", "only_production_deployments", "only_preview_deployments"]`
`110`	`110`	`}`
`111`	`111`	`}`
`112`	`112`	`}`