Add support of using deprecated images (#549)

Fixes #527

Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>

Author: LKaemmerling

go.mod

@@ -3,6 +3,7 @@ module github.com/hetznercloud/terraform-provider-hcloud
 require (
 	github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320
 	github.com/hashicorp/go-multierror v1.1.1
+	github.com/hashicorp/terraform-plugin-log v0.3.0
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.14.0
 	github.com/hetznercloud/hcloud-go v1.35.1
 	github.com/stretchr/testify v1.7.0
@@ -33,7 +34,6 @@ require (
 	github.com/hashicorp/terraform-exec v0.16.1 // indirect
 	github.com/hashicorp/terraform-json v0.13.0 // indirect
 	github.com/hashicorp/terraform-plugin-go v0.9.0 // indirect
-	github.com/hashicorp/terraform-plugin-log v0.3.0 // indirect
 	github.com/hashicorp/terraform-registry-address v0.0.0-20210412075316-9b2996cce896 // indirect
 	github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734 // indirect
 	github.com/hashicorp/yamux v0.0.0-20210707203944-259a57b3608c // indirect

internal/e2etests/server/resource_test.go

@@ -67,7 +67,7 @@ func TestServerResource_Basic(t *testing.T) {
 				ImportState:       true,
 				ImportStateVerify: true,
 				ImportStateVerifyIgnore: []string{
-					"ssh_keys", "user_data", "keep_disk", "ignore_remote_firewall_ids",
+					"ssh_keys", "user_data", "keep_disk", "ignore_remote_firewall_ids", "allow_deprecated_images",
 				},
 			},
 			{

internal/server/resource.go

@@ -11,6 +11,8 @@ import (
 	"strings"
 	"time"
 
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+
 	"github.com/hashicorp/go-cty/cty"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/primaryip"
@@ -97,6 +99,11 @@ func Resource() *schema.Resource {
 				Optional: true,
 				Default:  false,
 			},
+			"allow_deprecated_images": {
+				Type:     schema.TypeBool,
+				Optional: true,
+				Default:  false,
+			},
 			"backup_window": {
 				Type:       schema.TypeString,
 				Deprecated: "You should remove this property from your terraform configuration.",
@@ -262,10 +269,30 @@ func resourceServerCreate(ctx context.Context, d *schema.ResourceData, m interfa
 	c := m.(*hcloud.Client)
 
 	var err error
-	image, _, err := c.Image.Get(ctx, d.Get("image").(string))
+	var image *hcloud.Image
+	images, err := c.Image.AllWithOpts(ctx, hcloud.ImageListOpts{Name: d.Get("image").(string), IncludeDeprecated: true})
 	if err != nil {
 		return hcclient.ErrorToDiag(err)
 	}
+	switch len(images) {
+	case 1:
+		image = images[0]
+	case 0:
+		image, _, err = c.Image.Get(ctx, d.Get("image").(string))
+		if err != nil {
+			return hcclient.ErrorToDiag(err)
+		}
+	default:
+		return diag.Errorf("more than one Image found for name %s", d.Get("image").(string))
+	}
+
+	if image.IsDeprecated() {
+		if d.Get("allow_deprecated_images").(bool) {
+			tflog.Warn(ctx, fmt.Sprintf("image %s is deprecated. It will continue to be available until %s", image.Name, image.Deprecated.AddDate(0, 3, 0).Format("2006-01-02")))
+		} else {
+			return diag.Errorf("image %s is deprecated. It will continue to be available until %s. If you want to use it, specify the allow_deprecated_images option.", image.Name, image.Deprecated.AddDate(0, 3, 0).Format("2006-01-02"))
+		}
+	}
 	opts := hcloud.ServerCreateOpts{
 		Name: d.Get("name").(string),
 		ServerType: &hcloud.ServerType{

internal/server/testing.go

@@ -89,25 +89,26 @@ func (d *DDataList) TFID() string {
 type RData struct {
 	testtemplate.DataCommon
 
-	Name              string
-	Type              string
-	Image             string
-	LocationName      string
-	Datacenter        string
-	PublicNet         map[string]interface{}
-	SSHKeys           []string
-	KeepDisk          bool
-	Rescue            bool
-	Backups           bool
-	ISO               string
-	Labels            map[string]string
-	UserData          string
-	Network           RDataInlineNetwork
-	FirewallIDs       []string
-	DependsOn         []string
-	PlacementGroupID  string
-	DeleteProtection  bool
-	RebuildProtection bool
+	Name                  string
+	Type                  string
+	Image                 string
+	LocationName          string
+	Datacenter            string
+	PublicNet             map[string]interface{}
+	SSHKeys               []string
+	KeepDisk              bool
+	Rescue                bool
+	Backups               bool
+	ISO                   string
+	Labels                map[string]string
+	UserData              string
+	Network               RDataInlineNetwork
+	FirewallIDs           []string
+	DependsOn             []string
+	PlacementGroupID      string
+	DeleteProtection      bool
+	RebuildProtection     bool
+	AllowDeprecatedImages bool
 }
 
 // RDataInlineNetwork defines the information required to attach a server

internal/testdata/r/hcloud_server.tf.tmpl

@@ -19,6 +19,9 @@ resource "hcloud_server" "{{ .RName }}" {
   {{- if .KeepDisk }}
   keep_disk   = {{ .KeepDisk }}
   {{ end }}
+  {{- if .AllowDeprecatedImages }}
+  allow_deprecated_images   = {{ .AllowDeprecatedImages }}
+  {{ end }}
   {{- if .ISO }}
   iso         = {{ .ISO }}
   {{ end }}

website/docs/r/server.html.md

@@ -150,15 +150,16 @@ The following arguments are supported:
 - `labels` - (Optional, map) User-defined labels (key-value pairs) should be created with.
 - `backups` - (Optional, boolean) Enable or disable backups.
 - `firewall_ids` - (Optional, list) Firewall IDs the server should be attached to on creation.
-- `ignore_remote_firewall_ids` - (Optional, boolean) Ingores any updates
+- `ignore_remote_firewall_ids` - (Optional, boolean) Ignores any updates
   to the `firewall_ids` argument which were received from the server.
   This should not be used in normal cases. See the documentation of the
-  `hcloud_firewall_attachment` resouce for a reason to use this
+  `hcloud_firewall_attachment` resource for a reason to use this
   argument.
 - `network` - (Optional)  Network the server should be attached to on creation. (Can be specified multiple times)
 - `placement_group_id` - (Optional, string) Placement Group ID the server added to on creation.
 - `delete_protection` - (Optional, boolean) Enable or disable delete protection (Needs to be the same as `rebuild_protection`).
 - `rebuild_protection` - (Optional, boolean) Enable or disable rebuild protection (Needs to be the same as `delete_protection`).
+- `allow_deprecated_images` - (Optional, boolean) Enable the use of deprecated images (default: false). **Note** Deprecated images will be removed after three months. Using them is then no longer possible.
 
 `network` support the following fields:
 - `network_id` - (Required, int) ID of the network