doit_test.go

/*
Copyright 2018 The Doctl Authors All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package doctl

import (
	"os"
	"regexp"
	"testing"
)

func TestMain(m *testing.M) {
	os.Exit(m.Run())
}

func TestUserAgent(t *testing.T) {
	pattern := `doctl\/([0-9]+\.?){3}(-dev)? \(([\w ]+){2}\)`
	re := regexp.MustCompile(pattern)

	t.Run("release version", func(t *testing.T) {
		dv := DoitVersion
		DoitVersion = Version{Major: 0, Minor: 1, Patch: 2}

		ua := userAgent()
		if !re.MatchString(ua) {
			t.Errorf("expected %s to match %s", ua, pattern)
		}
		DoitVersion = dv
	})

	t.Run("dev version", func(t *testing.T) {
		ua := userAgent()
		if !re.MatchString(ua) {
			t.Errorf("expected %s to match %s", ua, pattern)
		}
	})
}

func TestVersion(t *testing.T) {
	slr1 := &stubLatestRelease{version: "0.1.0"}
	slr2 := &stubLatestRelease{version: "1.0.0"}

	cases := []struct {
		v    Version
		s    string
		json string
		ver  string
		slr  LatestVersioner
	}{
		// version with no label
		{
			v:    Version{Major: 0, Minor: 1, Patch: 2},
			s:    `doctl version 0.1.2`,
			json: "{\n  \"version\": \"0.1.2\",\n  \"latestRelease\": \"0.1.0\"\n}",
			ver:  "0.1.2",
			slr:  slr1,
		},
		// version with label
		{
			v:    Version{Major: 0, Minor: 1, Patch: 2, Label: "dev"},
			s:    `doctl version 0.1.2-dev`,
			json: "{\n  \"version\": \"0.1.2-dev\",\n  \"latestRelease\": \"0.1.0\"\n}",
			ver:  "0.1.2-dev",
			slr:  slr1,
		},
		// version with label and build
		{
			v:    Version{Major: 0, Minor: 1, Patch: 2, Label: "dev", Build: "12345"},
			s:    "doctl version 0.1.2-dev\nGit commit hash: 12345",
			json: "{\n  \"version\": \"0.1.2-dev\",\n  \"commit\": \"12345\",\n  \"latestRelease\": \"0.1.0\"\n}",
			ver:  "0.1.2-dev",
			slr:  slr1,
		},
		// version with no label and higher released version
		{
			v:    Version{Major: 0, Minor: 1, Patch: 2},
			s:    "doctl version 0.1.2\nrelease 1.0.0 is available, check it out! ",
			json: "{\n  \"version\": \"0.1.2\",\n  \"latestRelease\": \"1.0.0\",\n  \"notification\": \"release 1.0.0 is available, check it out!\"\n}",
			ver:  `0.1.2`,
			slr:  slr2,
		},
		// version with dev label and released version
		{
			v:    Version{Major: 1, Minor: 0, Patch: 0, Label: "dev"},
			s:    "doctl version 1.0.0-dev\nrelease 1.0.0 is available, check it out! ",
			json: "{\n  \"version\": \"1.0.0-dev\",\n  \"latestRelease\": \"1.0.0\",\n  \"notification\": \"release 1.0.0 is available, check it out!\"\n}",
			ver:  `1.0.0-dev`,
			slr:  slr2,
		},
		// version with release label and released version available
		{
			v:    Version{Major: 1, Minor: 0, Patch: 0, Label: "release"},
			s:    "doctl version 1.0.0-release",
			json: "{\n  \"version\": \"1.0.0-release\",\n  \"latestRelease\": \"1.0.0\"\n}",
			ver:  `1.0.0-release`,
			slr:  slr2,
		},
	}

	for _, c := range cases {
		if got, want := c.v.String(), c.ver; got != want {
			t.Errorf("version string for %#v = %q; want = %q", c.v, got, want)
		}
		if got, want := c.v.Complete(c.slr), c.s; got != want {
			t.Errorf("complete version string for %#v = %q; want = %q", c.v, got, want)
		}
		if got, want := c.v.CompleteJSON(c.slr), c.json; got != want {
			t.Errorf("complete version json for %#v = %q; want = %q", c.v, got, want)
		}
	}
}

type stubLatestRelease struct {
	version string
}

func (slr stubLatestRelease) LatestVersion() (string, error) {
	return slr.version, nil
}

func TestCommandName(t *testing.T) {
	t.Run("snap name set to goland", func(t *testing.T) {
		const snapName = "goland"

		if err := os.Setenv("SNAP_NAME", snapName); err != nil {
			t.Errorf("failed to set environment variable: %#v", err)
		}

		// When run under `go test`, os.Args[0] will be different every time,
		// so only check that the Snap name is not "goland".
		if actual := CommandName(); actual == snapName {
			t.Errorf("expected name not to equal %s, got %s", snapName, actual)
		}

		if err := os.Unsetenv("SNAP_NAME"); err != nil {
			t.Errorf("failed to unset environment variable: %#v", err)
		}
	})

	t.Run("snap name set to doctl", func(t *testing.T) {
		const expected = "doctl"

		if err := os.Setenv("SNAP_NAME", "doctl"); err != nil {
			t.Errorf("failed to set environment variable: %#v", err)
		}

		if actual := CommandName(); actual != expected {
			t.Errorf("got %s, want %s", actual, expected)
		}

		if err := os.Unsetenv("SNAP_NAME"); err != nil {
			t.Errorf("failed to unset environment variable: %#v", err)
		}
	})
}