cheat/internal/config/validate_test.go

package config

import (
	"testing"

	"github.com/cheat/cheat/internal/cheatpath"
)

// TestValidateCorrect asserts that valid configs are validated successfully
func TestValidateCorrect(t *testing.T) {

	// mock a config
	conf := Config{
		Colorize:  true,
		Editor:    "vim",
		Formatter: "terminal16m",
		Cheatpaths: []cheatpath.Path{
			cheatpath.Path{
				Name:     "foo",
				Path:     "/foo",
				ReadOnly: false,
				Tags:     []string{},
			},
		},
	}

	// assert that no errors are returned
	if err := conf.Validate(); err != nil {
		t.Errorf("failed to validate valid config: %v", err)
	}
}

// TestInvalidateMissingEditor asserts that configs with unspecified editors
// are invalidated
func TestInvalidateMissingEditor(t *testing.T) {

	// mock a config
	conf := Config{
		Colorize:  true,
		Formatter: "terminal16m",
		Cheatpaths: []cheatpath.Path{
			cheatpath.Path{
				Name:     "foo",
				Path:     "/foo",
				ReadOnly: false,
				Tags:     []string{},
			},
		},
	}

	// assert that no errors are returned
	if err := conf.Validate(); err == nil {
		t.Errorf("failed to invalidate config with unspecified editor")
	}
}

// TestInvalidateMissingCheatpaths asserts that configs without cheatpaths are
// invalidated
func TestInvalidateMissingCheatpaths(t *testing.T) {

	// mock a config
	conf := Config{
		Colorize:  true,
		Editor:    "vim",
		Formatter: "terminal16m",
	}

	// assert that no errors are returned
	if err := conf.Validate(); err == nil {
		t.Errorf("failed to invalidate config without cheatpaths")
	}
}

// TestInvalidateInvalidFormatter asserts that configs which contain invalid
// formatters are invalidated
func TestInvalidateInvalidFormatter(t *testing.T) {

	// mock a config with a valid editor and cheatpaths but invalid formatter
	conf := Config{
		Colorize:  true,
		Editor:    "vim",
		Formatter: "html",
		Cheatpaths: []cheatpath.Path{
			cheatpath.Path{
				Name:     "foo",
				Path:     "/foo",
				ReadOnly: false,
				Tags:     []string{},
			},
		},
	}

	// assert that the config is invalidated due to the formatter
	if err := conf.Validate(); err == nil {
		t.Errorf("failed to invalidate config with invalid formatter")
	}
}

// TestInvalidateDuplicateCheatpathNames asserts that configs which contain
// cheatpaths with duplcated names are invalidated
func TestInvalidateDuplicateCheatpathNames(t *testing.T) {

	// mock a config
	conf := Config{
		Colorize:  true,
		Editor:    "vim",
		Formatter: "terminal16m",
		Cheatpaths: []cheatpath.Path{
			cheatpath.Path{
				Name:     "foo",
				Path:     "/foo",
				ReadOnly: false,
				Tags:     []string{},
			},
			cheatpath.Path{
				Name:     "foo",
				Path:     "/bar",
				ReadOnly: false,
				Tags:     []string{},
			},
		},
	}

	// assert that no errors are returned
	if err := conf.Validate(); err == nil {
		t.Errorf("failed to invalidate config with cheatpaths with duplicate names")
	}
}

// TestInvalidateDuplicateCheatpathPaths asserts that configs which contain
// cheatpaths with duplcated paths are invalidated
func TestInvalidateDuplicateCheatpathPaths(t *testing.T) {

	// mock a config
	conf := Config{
		Colorize:  true,
		Editor:    "vim",
		Formatter: "terminal16m",
		Cheatpaths: []cheatpath.Path{
			cheatpath.Path{
				Name:     "foo",
				Path:     "/foo",
				ReadOnly: false,
				Tags:     []string{},
			},
			cheatpath.Path{
				Name:     "bar",
				Path:     "/foo",
				ReadOnly: false,
				Tags:     []string{},
			},
		},
	}

	// assert that no errors are returned
	if err := conf.Validate(); err == nil {
		t.Errorf("failed to invalidate config with cheatpaths with duplicate paths")
	}
}

// TestInvalidateInvalidCheatpath asserts that configs containing a cheatpath
// with an empty name are invalidated
func TestInvalidateInvalidCheatpath(t *testing.T) {

	// mock a config with a cheatpath that has an empty name
	conf := Config{
		Colorize:  true,
		Editor:    "vim",
		Formatter: "terminal16m",
		Cheatpaths: []cheatpath.Path{
			cheatpath.Path{
				Name:     "",
				Path:     "/foo",
				ReadOnly: false,
				Tags:     []string{},
			},
		},
	}

	// assert that an error is returned
	if err := conf.Validate(); err == nil {
		t.Errorf("failed to invalidate config with invalid cheatpath (empty name)")
	}
}