chore: print a message that a new version is available (#4895)

Author: chengxiangdong

.goreleaser.yml

@@ -15,7 +15,7 @@ builds:
     - -mod=readonly
     - -trimpath
   ldflags:
-    - '-s -w -X main.version={{.Version}} -X main.commit={{.Commit}}'
+    - '-s -w -X github.com/huaweicloud/terraform-provider-huaweicloud/huaweicloud.Version={{.Version}}'
   goos:
     - freebsd
     - windows

huaweicloud/config/upgrade.go

@@ -0,0 +1,165 @@
+package config
+
+import (
+	"bytes"
+	"crypto/tls"
+	"encoding/json"
+	"io"
+	"log"
+	"net/http"
+	"strconv"
+	"strings"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+)
+
+const (
+	versionURL     = "https://provider.obs.cn-north-4.myhuaweicloud.com/terraform-provider-huaweicloud/version.json"
+	defaultSummary = "Newer Version Available"
+	defaultDetail  = "The provider version is out of date, please upgrade to the latest version."
+)
+
+type VersionConfig struct {
+	Latest  string            `json:"latest"`
+	Version map[string]string `json:"version"`
+	Warning string            `json:"warning"`
+	Message string            `json:"message"`
+}
+
+func CheckUpgrade(version string) diag.Diagnostics {
+	log.Printf("[DEBUG] current version: %s", version)
+	if version == "" {
+		return nil
+	}
+
+	defer func() {
+		if r := recover(); r != nil {
+			log.Printf("[ERROR] CheckUpgrade recover: %#v", r)
+		}
+	}()
+
+	body, _, err := httpRequest("GET", versionURL, nil, nil)
+	if err != nil {
+		log.Printf("[WARN] failed to query version config : %s", err)
+		return nil
+	}
+
+	verCfg := &VersionConfig{}
+	err = json.Unmarshal(body, verCfg)
+	if err != nil {
+		log.Printf("[WARN] failed to unmarshal version config : %s", err)
+		return nil
+	}
+
+	if verCfg.Latest == "" {
+		log.Printf("[WARN] failed to get latest version")
+		return nil
+	}
+
+	if compareVersion(version, verCfg.Latest) != -1 {
+		return nil
+	}
+
+	summary := defaultSummary
+	if verCfg.Warning != "" {
+		summary = verCfg.Warning
+		summary = strings.ReplaceAll(summary, "${latest}", verCfg.Latest)
+		summary = strings.ReplaceAll(summary, "${version}", version)
+	}
+
+	detail := defaultDetail
+	if verCfg.Message != "" {
+		detail = verCfg.Message
+		detail = strings.ReplaceAll(detail, "${latest}", verCfg.Latest)
+		detail = strings.ReplaceAll(detail, "${version}", version)
+	}
+	return diag.Diagnostics{
+		diag.Diagnostic{
+			Severity: diag.Warning,
+			Summary:  summary,
+			Detail:   detail,
+		},
+	}
+}
+
+// compareVersion compares two version strings and returns:
+// ver1 < ver2 -> -1
+// ver1 > ver2 -> 1
+// ver1 == ver2 -> 0
+func compareVersion(ver1, ver2 string) int {
+	parts1 := strings.Split(ver1, ".")
+	parts2 := strings.Split(ver2, ".")
+
+	if len(parts1) != len(parts2) {
+		if len(parts1) > len(parts2) {
+			return 1
+		}
+		return -1
+	}
+
+	for i := range parts1 {
+		num1, _ := strconv.Atoi(parts1[i])
+		num2, _ := strconv.Atoi(parts2[i])
+
+		if num1 < num2 {
+			return -1
+		} else if num1 > num2 {
+			return 1
+		}
+	}
+
+	return 0
+}
+
+func httpRequest(method, requestUrl string, jsonBody any, headers map[string]string) ([]byte, int, error) {
+	var body io.Reader
+	var contentType string
+	if jsonBody != nil {
+		rendered, err := json.Marshal(jsonBody)
+		if err != nil {
+			return nil, 0, err
+		}
+		body = bytes.NewReader(rendered)
+		contentType = "application/json"
+	}
+
+	client := http.Client{
+		Transport: &LogRoundTripper{
+			Rt: &http.Transport{
+				Proxy: http.ProxyFromEnvironment,
+				TLSClientConfig: &tls.Config{
+					MinVersion:         tls.VersionTLS12,
+					InsecureSkipVerify: true, //nolint:gosec
+				},
+			},
+			MaxRetries: 3,
+		},
+	}
+	defer client.CloseIdleConnections()
+
+	request, err := http.NewRequest(method, requestUrl, body)
+	if err != nil {
+		return nil, 0, err
+	}
+
+	if contentType != "" {
+		request.Header.Set("Content-Type", contentType)
+	}
+	for k, v := range headers {
+		request.Header.Add(k, v)
+	}
+
+	response, err := client.Do(request)
+	if err != nil {
+		return nil, 0, err
+	}
+	defer func() {
+		if err := response.Body.Close(); err != nil {
+			log.Printf("[WARN] failed to close response: %s", err)
+		}
+	}()
+
+	bodyByte, err := io.ReadAll(response.Body)
+
+	return bodyByte, response.StatusCode, err
+}

huaweicloud/provider.go

@@ -115,6 +115,8 @@ const (
 	prefixEuropeRegion string = "eu-west-1"
 )
 
+var Version string
+
 // Provider returns a schema.Provider for HuaweiCloud.
 func Provider() *schema.Provider {
 	provider := &schema.Provider{
@@ -2056,7 +2058,7 @@ func configureProvider(_ context.Context, d *schema.ResourceData, terraformVersi
 		conf.SetServiceEndpoint("cdn", cdnEndpoint)
 	}
 
-	return &conf, nil
+	return &conf, config.CheckUpgrade(Version)
 }
 
 func flattenProviderEndpoints(d *schema.ResourceData) (map[string]string, error) {