fix: properly detect netbox version when using netbox-docker

Author: fbreckle

netbox/provider.go

@@ -331,7 +331,12 @@ func providerConfigure(ctx context.Context, data *schema.ResourceData) (interfac
 			return nil, diag.FromErr(err)
 		}
 
-		netboxVersion := res.GetPayload().(map[string]interface{})["netbox-version"].(string)
+		netboxVersionStringFromAPI := res.GetPayload().(map[string]interface{})["netbox-version"].(string)
+
+		netboxVersion, err := extractSemanticVersionFromString(netboxVersionStringFromAPI)
+		if err != nil {
+			return nil, diag.FromErr(fmt.Errorf("error extracting netbox version. try using the `skip_version_check` provider parameter to bypass this error. original error: %w", err))
+		}
 
 		supportedVersions := []string{"4.2.2", "4.2.3", "4.2.4", "4.2.5", "4.2.6", "4.2.7", "4.2.8", "4.2.9"}
 
@@ -340,7 +345,7 @@ func providerConfigure(ctx context.Context, data *schema.ResourceData) (interfac
 			diags = append(diags, diag.Diagnostic{
 				Severity: diag.Warning,
 				Summary:  "Possibly unsupported Netbox version",
-				Detail:   fmt.Sprintf("Your Netbox version is v%v. The provider was successfully tested against the following versions:\n\n  %v\n\nUnexpected errors may occur.", netboxVersion, strings.Join(supportedVersions, ", ")),
+				Detail:   fmt.Sprintf("Your Netbox reports version %v. From that, the provider extracted Netbox version %v.\nThe provider was successfully tested against the following versions:\n\n  %v\n\nUnexpected errors may occur.", netboxVersionStringFromAPI, netboxVersion, strings.Join(supportedVersions, ", ")),
 			})
 		}
 	}

netbox/util.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"reflect"
+	"regexp"
 	"strings"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -132,3 +133,18 @@ func jsonSemanticCompare(a, b string) (equal bool, err error) {
 
 	return reflect.DeepEqual(aDecoded, bDecoded), nil
 }
+
+// extractNetboxVersionFromString extracts the first semantic versioning string
+// from a given string. The string must be preceded with "v".
+// This is needed since netbox-docker recently started displaying its version string
+// as, for example, v4.2.8-Docker-3.2.1 and we want to ignore the Docker part
+// ref: https://github.com/e-breuninger/terraform-provider-netbox/issues/729
+func extractSemanticVersionFromString(s string) (version string, err error) {
+	re := regexp.MustCompile(`^v?(\d+\.\d+\.\d+)`)
+
+	matches := re.FindStringSubmatch(s)
+	if len(matches) < 2 {
+		return "", fmt.Errorf("no semantic version found in version string")
+	}
+	return matches[1], nil
+}

netbox/util_test.go

@@ -84,3 +84,39 @@ func TestJsonSemanticCompareUnequal(t *testing.T) {
 		t.Errorf("expected 'a' and 'b' to be semantically unequal\n\na: %s\nb: %s\n", a, b)
 	}
 }
+
+func TestExtractSemanticVersionFromString(t *testing.T) {
+	for _, tt := range []struct {
+		name     string
+		input    string
+		expected string
+	}{
+		{
+			name:     "Incomplete",
+			input:    "v1.3",
+			expected: "",
+		},
+		{
+			name:     "SimpleWithV",
+			input:    "v1.2.3",
+			expected: "1.2.3",
+		},
+		{
+			name:     "SimpleWithoutV",
+			input:    "1.2.3",
+			expected: "1.2.3",
+		},
+		{
+			name:     "Docker",
+			input:    "v4.5.6-Docker-3.2",
+			expected: "4.5.6",
+		},
+	} {
+		t.Run(tt.name, func(t *testing.T) {
+			actual, _ := extractSemanticVersionFromString(tt.input)
+			if actual != tt.expected {
+				t.Fatalf("\n\nexpected:\n\n%#v\n\ngot:\n\n%#v\n\n", tt.expected, actual)
+			}
+		})
+	}
+}