go-unifi/codegen/version_test.go

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
	"net/http/httptest"
	"net/url"
	"os"
	"path/filepath"
	"testing"

	"github.com/hashicorp/go-version"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func assertLatestVersionUsingProvider(t *testing.T, provider func() (*UnifiVersion, error)) {
	t.Helper()
	assert := assert.New(t)
	require := require.New(t)

	fwVersion, err := version.NewVersion("7.3.83+atag-7.3.83-19645")
	require.NoError(err)

	fwDownload, err := url.Parse("https://fw-download.ubnt.com/data/unifi-controller/c31c-debian-7.3.83-c9249c913b91416693b869b9548850c3.deb")
	require.NoError(err)

	respData := firmwareUpdateApiResponse{
		Embedded: firmwareUpdateApiResponseEmbedded{
			Firmware: []firmwareUpdateApiResponseEmbeddedFirmware{
				{
					Channel:  releaseChannel,
					Created:  "2023-02-06T08:55:31+00:00",
					Id:       "c9249c91-3b91-4166-93b8-69b9548850c3",
					Platform: debianPlatform,
					Product:  unifiControllerProduct,
					Version:  fwVersion,
					Links: firmwareUpdateApiResponseEmbeddedFirmwareLinks{
						Data: firmwareUpdateApiResponseEmbeddedFirmwareDataLink{
							Href: fwDownload,
						},
					},
				},
				{
					Channel:  releaseChannel,
					Created:  "2023-02-06T08:51:36+00:00",
					Id:       "2a600108-7f79-4b3e-b6e0-4dd262460457",
					Platform: "document",
					Product:  unifiControllerProduct,
					Version:  fwVersion,
					Links: firmwareUpdateApiResponseEmbeddedFirmwareLinks{
						Data: firmwareUpdateApiResponseEmbeddedFirmwareDataLink{
							Href: nil,
						},
					},
				},
				{
					Channel:  releaseChannel,
					Created:  "2023-02-06T08:51:37+00:00",
					Id:       "9d2d413d-36ce-4742-a10d-4351aac6f08d",
					Platform: "windows",
					Product:  unifiControllerProduct,
					Version:  fwVersion,
					Links: firmwareUpdateApiResponseEmbeddedFirmwareLinks{
						Data: firmwareUpdateApiResponseEmbeddedFirmwareDataLink{
							Href: nil,
						},
					},
				},
			},
		},
	}

	server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
		query := req.URL.Query()
		assert.Contains(query["filter"], firmwareUpdateApiFilter("channel", releaseChannel))
		assert.Contains(query["filter"], firmwareUpdateApiFilter("product", unifiControllerProduct))

		resp, err := json.Marshal(respData)
		assert.NoError(err)

		_, err = rw.Write(resp)
		assert.NoError(err)
	}))
	defer server.Close()

	firmwareUpdateApi = server.URL
	gotVersion, err := provider()
	require.NoError(err)

	assert.Equal(fwVersion.Core(), gotVersion.Version)
	assert.Equal(fwDownload, gotVersion.DownloadUrl)
}

func TestLatestUnifiVersion(t *testing.T) {
	t.Parallel()
	assertLatestVersionUsingProvider(t, func() (*UnifiVersion, error) {
		return latestUnifiVersion()
	})
}

func TestDetermineUnifiVersion_latest(t *testing.T) {
	t.Parallel()
	assertLatestVersionUsingProvider(t, func() (*UnifiVersion, error) {
		return determineUnifiVersion(LatestVersionMarker)
	})
}

func TestDetermineUnifiVersion_provided(t *testing.T) {
	t.Parallel()
	testCases := map[string]string{
		"7.3.83+atag-7.3.83-19645": "7.3.83",
		"7.3.83":                   "7.3.83",
		"7.3":                      "7.3.0",
		"7":                        "7.0.0",
	}

	for providedVersion, expectedVersion := range testCases {
		t.Run(providedVersion, func(t *testing.T) {
			t.Parallel()
			a := assert.New(t)

			unifiVersion, err := determineUnifiVersion(providedVersion)
			require.NoError(t, err)

			a.Equal(expectedVersion, unifiVersion.Version.String())
			a.Equal(fmt.Sprintf(baseDownloadUrl, expectedVersion), unifiVersion.DownloadUrl.String())
		})
	}
}

func TestDetermineUnifiVersion_invalid(t *testing.T) {
	t.Parallel()
	testCases := []string{
		"a7.3.83",
		"7.3.83 ",
		"invalid",
		"-1",
		"",
	}

	for _, providedVersion := range testCases {
		t.Run(providedVersion, func(t *testing.T) {
			t.Parallel()
			_, err := determineUnifiVersion(providedVersion)
			require.ErrorContains(t, err, providedVersion)
		})
	}
}

func TestNewUnifiVersion(t *testing.T) {
	t.Parallel()
	a := assert.New(t)

	v, err := version.NewVersion("7.3.83")
	require.NoError(t, err)
	downloadUrl, err := url.Parse("https://example.com/download")
	require.NoError(t, err)

	unifiVersion := NewUnifiVersion(v, downloadUrl)
	a.Equal(v, unifiVersion.Version)
	a.Equal(downloadUrl, unifiVersion.DownloadUrl)
}

func TestLatestUnifiVersion_HttpError(t *testing.T) {
	t.Parallel()

	server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
		rw.WriteHeader(http.StatusInternalServerError)
	}))
	defer server.Close()

	firmwareUpdateApi = server.URL
	_, err := latestUnifiVersion()
	require.Error(t, err)
}

func TestLatestUnifiVersion_InvalidJson(t *testing.T) {
	t.Parallel()

	server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
		_, err := rw.Write([]byte("invalid json"))
		if err != nil {
			rw.WriteHeader(http.StatusInternalServerError)
		}
	}))
	defer server.Close()

	firmwareUpdateApi = server.URL
	_, err := latestUnifiVersion()
	require.Error(t, err)
	require.ErrorContains(t, err, "invalid")
}

func TestLatestUnifiVersion_NoDebianFirmware(t *testing.T) {
	t.Parallel()

	fwVersion, err := version.NewVersion("7.3.83")
	require.NoError(t, err)

	respData := firmwareUpdateApiResponse{
		Embedded: firmwareUpdateApiResponseEmbedded{
			Firmware: []firmwareUpdateApiResponseEmbeddedFirmware{
				{
					Channel:  releaseChannel,
					Platform: "windows",
					Product:  unifiControllerProduct,
					Version:  fwVersion,
				},
			},
		},
	}

	server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
		resp, err := json.Marshal(respData)
		if err != nil {
			rw.WriteHeader(http.StatusInternalServerError)
		}
		_, err = rw.Write(resp)
		if err != nil {
			rw.WriteHeader(http.StatusInternalServerError)
		}
	}))
	defer server.Close()

	firmwareUpdateApi = server.URL
	_, err = latestUnifiVersion()
	require.Error(t, err)
	require.ErrorContains(t, err, "no Unifi Controller firmware found")
}

func TestWriteVersionFile(t *testing.T) {
	t.Parallel()
	a := assert.New(t)

	tmpDir := t.TempDir()
	v, err := version.NewVersion("7.3.83")
	require.NoError(t, err)

	err = writeVersionFile(v, tmpDir)
	require.NoError(t, err)

	content, err := os.ReadFile(filepath.Join(tmpDir, "version.generated.go"))
	require.NoError(t, err)
	a.Contains(string(content), `const UnifiVersion = "7.3.83"`)
}

func TestWriteVersionRepoMarkerFile(t *testing.T) {
	t.Parallel()
	a := assert.New(t)

	tmpDir := t.TempDir()
	v, err := version.NewVersion("7.3.83")
	require.NoError(t, err)

	err = writeVersionRepoMarkerFile(v, tmpDir)
	require.NoError(t, err)

	content, err := os.ReadFile(filepath.Join(tmpDir, ".unifi-version"))
	require.NoError(t, err)
	a.Equal("7.3.83", string(content))
}

func TestLatestUnifiVersion_InvalidUrl(t *testing.T) {
	t.Parallel()

	firmwareUpdateApi = ":\\invalid"
	_, err := latestUnifiVersion()
	require.Error(t, err)
	require.ErrorContains(t, err, "invalid")
}

func TestWriteVersionFile_InvalidDir(t *testing.T) {
	t.Parallel()

	v, err := version.NewVersion("7.3.83")
	require.NoError(t, err)

	err = writeVersionFile(v, "/nonexistent/directory")
	require.Error(t, err)
	require.ErrorContains(t, err, "no such file or directory")
}

func TestWriteVersionRepoMarkerFile_InvalidDir(t *testing.T) {
	t.Parallel()

	v, err := version.NewVersion("7.3.83")
	require.NoError(t, err)

	err = writeVersionRepoMarkerFile(v, "/nonexistent/directory")
	require.Error(t, err)
	require.ErrorContains(t, err, "no such file or directory")
}

func TestLatestUnifiVersion_NilVersion(t *testing.T) {
	t.Parallel()

	respData := firmwareUpdateApiResponse{
		Embedded: firmwareUpdateApiResponseEmbedded{
			Firmware: []firmwareUpdateApiResponseEmbeddedFirmware{
				{
					Channel:  releaseChannel,
					Platform: debianPlatform,
					Product:  unifiControllerProduct,
					Version:  nil,
				},
			},
		},
	}

	server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
		resp, err := json.Marshal(respData)
		if err != nil {
			rw.WriteHeader(http.StatusInternalServerError)
		}
		_, err = rw.Write(resp)
		if err != nil {
			rw.WriteHeader(http.StatusInternalServerError)
		}
	}))
	defer server.Close()

	firmwareUpdateApi = server.URL
	_, err := latestUnifiVersion()
	require.Error(t, err)
}

func TestWriteVersionFile_EmptyVersion(t *testing.T) {
	t.Parallel()

	tmpDir := t.TempDir()
	v, err := version.NewVersion("0.0.0")
	require.NoError(t, err)

	err = writeVersionFile(v, tmpDir)
	require.NoError(t, err)

	content, err := os.ReadFile(filepath.Join(tmpDir, "version.generated.go"))
	require.NoError(t, err)
	assert.Contains(t, string(content), `const UnifiVersion = "0.0.0"`)
}

func TestWriteVersionRepoMarkerFile_Permissions(t *testing.T) {
	t.Parallel()

	if os.Getuid() == 0 {
		t.Skip("Skipping test when running as root")
	}

	tmpDir := t.TempDir()
	readOnlyDir := filepath.Join(tmpDir, "readonly")
	err := os.Mkdir(readOnlyDir, 0o555)
	require.NoError(t, err)

	v, err := version.NewVersion("7.3.83")
	require.NoError(t, err)

	err = writeVersionRepoMarkerFile(v, readOnlyDir)
	require.Error(t, err)
	require.ErrorContains(t, err, "permission denied")
}