faas-cli/config/config_file_test.go

// Copyright (c) OpenFaaS Author(s) 2017. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

package config

import (
	"fmt"
	"io/ioutil"
	"os"
	"regexp"
	"strings"
	"testing"
)

func Test_LookupAuthConfig_WithNoConfigFile(t *testing.T) {
	configDir, err := ioutil.TempDir("", "faas-cli-file-test")
	if err != nil {
		t.Fatalf("can not create test config directory: %s", err)
	}
	defer os.RemoveAll(configDir)

	os.Setenv(ConfigLocationEnv, configDir)
	defer os.Unsetenv(ConfigLocationEnv)

	_, err = LookupAuthConfig("http://openfaas.test1")
	if err == nil {
		t.Errorf("Error was not returned")
	}

	r := regexp.MustCompile(`(?m:config file not found)`)
	if !r.MatchString(err.Error()) {
		t.Errorf("Error not matched: %s", err.Error())
	}
}

func Test_LookupAuthConfig_GatewayWithNoConfig(t *testing.T) {
	configDir, err := ioutil.TempDir("", "faas-cli-file-test")
	if err != nil {
		t.Fatalf("can not create test config directory: %s", err)
	}
	defer os.RemoveAll(configDir)

	os.Setenv(ConfigLocationEnv, configDir)
	defer os.Unsetenv(ConfigLocationEnv)

	u := "admin"
	p := "some pass"
	gatewayURL := strings.TrimRight("http://openfaas.test/", "/")
	token := EncodeAuth(u, p)
	err = UpdateAuthConfig(gatewayURL, token, BasicAuthType)
	if err != nil {
		t.Fatalf("unexpected error when updating auth config: %s", err)
	}

	_, err = LookupAuthConfig("http://openfaas.com")
	if err == nil {
		t.Errorf("Error was not returned")
	}

	r := regexp.MustCompile(`(?m:no auth config found for)`)
	if !r.MatchString(err.Error()) {
		t.Errorf("Error not matched: %s", err.Error())
	}
}

func Test_UpdateAuthConfig_Insert(t *testing.T) {
	configDir, err := ioutil.TempDir("", "faas-cli-file-test")
	if err != nil {
		t.Fatalf("can not create test config directory: %s", err)
	}
	defer os.RemoveAll(configDir)

	os.Setenv(ConfigLocationEnv, configDir)
	defer os.Unsetenv(ConfigLocationEnv)

	u := "admin"
	p := "some pass"
	gatewayURL := strings.TrimRight("http://openfaas.test/", "/")
	token := EncodeAuth(u, p)
	err = UpdateAuthConfig(gatewayURL, token, BasicAuthType)
	if err != nil {
		t.Fatalf("unexpected error when updating auth config: %s", err)
	}

	authConfig, err := LookupAuthConfig(gatewayURL)
	if err != nil {
		t.Errorf("got error %s", err.Error())
		t.Errorf(authConfig.Token)
	}

	user, pass, err := DecodeAuth(authConfig.Token)
	fmt.Println(user, pass)
	if err != nil {
		t.Errorf("got error %s", err.Error())
	}

	if user != u || pass != p {
		t.Errorf("got user %s and pass %s, expected %s %s", user, pass, u, p)
	}
}

func Test_UpdateAuthConfig_Update(t *testing.T) {
	configDir, err := ioutil.TempDir("", "faas-cli-file-test")
	if err != nil {
		t.Fatalf("can not create test config directory: %s", err)
	}
	defer os.RemoveAll(configDir)

	os.Setenv(ConfigLocationEnv, configDir)
	defer os.Unsetenv(ConfigLocationEnv)

	u := "admin"
	p := "pass"
	gatewayURL := strings.TrimRight("http://openfaas.test/", "/")
	token := EncodeAuth(u, p)
	err = UpdateAuthConfig(gatewayURL, token, BasicAuthType)
	if err != nil {
		t.Fatalf("unexpected error when updating auth config: %s", err)
	}

	authConfig, err := LookupAuthConfig(gatewayURL)
	if err != nil {
		t.Errorf("got error %s", err.Error())
	}

	user, pass, err := DecodeAuth(authConfig.Token)
	if err != nil {
		t.Errorf("got error %s", err.Error())
	}
	if user != u || pass != p {
		t.Errorf("got user %s and pass %s, expected %s %s", user, pass, u, p)
	}

	u = "admin2"
	p = "pass2"
	token = EncodeAuth(u, p)
	err = UpdateAuthConfig(gatewayURL, token, BasicAuthType)
	if err != nil {
		t.Fatalf("unexpected error when updating auth config: %s", err)
	}

	authConfig, err = LookupAuthConfig(gatewayURL)
	if err != nil {
		t.Errorf("got error %s", err.Error())
	}

	user, pass, err = DecodeAuth(authConfig.Token)
	if err != nil {
		t.Errorf("got error %s", err.Error())
	}

	if user != u || pass != p {
		t.Errorf("got user %s and pass %s, expected %s %s", user, pass, u, p)
	}
}

func Test_UpdateAuthConfig_InvaidGatewayURL(t *testing.T) {
	gateway := "http//test.test"
	err := UpdateAuthConfig(gateway, "a", "b")
	if err == nil {
		t.Errorf("Error was not returned")
	}

	r := regexp.MustCompile(`(?m:invalid gateway)`)
	if !r.MatchString(err.Error()) {
		t.Errorf("Error not matched: %s", err.Error())
	}
}

func Test_UpdateAuthConfig_EmptyGatewayURL(t *testing.T) {
	gateway := ""
	err := UpdateAuthConfig(gateway, "a", "b")
	if err == nil {
		t.Errorf("Error was not returned")
	}

	r := regexp.MustCompile(`(?m:invalid gateway)`)
	if !r.MatchString(err.Error()) {
		t.Errorf("Error not matched: %s", err.Error())
	}
}

func Test_New_NoFile(t *testing.T) {
	_, err := New("")
	if err == nil {
		t.Error("expected to fail on empty file path")
	}
}

func Test_EnsureFile(t *testing.T) {
	configDir, err := ioutil.TempDir("", "faas-cli-file-test")
	if err != nil {
		t.Fatalf("can not create test config directory: %s", err)
	}
	defer os.RemoveAll(configDir)

	os.Setenv(ConfigLocationEnv, configDir)
	defer os.Unsetenv(ConfigLocationEnv)

	cfg, err := EnsureFile()
	if err != nil {
		t.Error(err.Error())
	}
	_, err = os.Stat(cfg)
	if os.IsNotExist(err) {
		t.Errorf("expected config at %s", cfg)
	}
}

func Test_EncodeAuth(t *testing.T) {
	token := EncodeAuth("admin", "admin")
	if token != "YWRtaW46YWRtaW4=" {
		t.Errorf("Token not matched: %s", token)
	}
}

func Test_DecodeAuth(t *testing.T) {
	u, p, err := DecodeAuth("YWRtaW46YWRtaW4=")
	if err != nil || u != "admin" || p != "admin" {
		t.Errorf("invalid base64 decoding")
	}
}

func Test_RemoveAuthConfig(t *testing.T) {
	configDir, err := ioutil.TempDir("", "faas-cli-file-test")
	if err != nil {
		t.Fatalf("can not create test config directory: %s", err)
	}
	defer os.RemoveAll(configDir)

	os.Setenv(ConfigLocationEnv, configDir)
	defer os.Unsetenv(ConfigLocationEnv)

	u := "admin"
	p := "pass"
	token := EncodeAuth(u, p)
	gatewayURL := strings.TrimRight("http://openfaas.test/", "/")
	err = UpdateAuthConfig(gatewayURL, token, BasicAuthType)
	if err != nil {
		t.Fatalf("unexpected error when updating auth config: %s", err)
	}

	gatewayURL2 := strings.TrimRight("http://openfaas.test2/", "/")
	err = UpdateAuthConfig(gatewayURL2, token, BasicAuthType)
	if err != nil {
		t.Fatalf("unexpected error when updating auth config: %s", err)
	}

	err = RemoveAuthConfig(gatewayURL)
	if err != nil {
		t.Errorf("got error %s", err.Error())
	}

	_, err = LookupAuthConfig(gatewayURL)
	if err == nil {
		t.Fatal("Error was not returned")
	}
	r := regexp.MustCompile(`(?m:no auth config found)`)
	if !r.MatchString(err.Error()) {
		t.Errorf("Error not matched: %s", err.Error())
	}
}

func Test_RemoveAuthConfig_WithNoConfigFile(t *testing.T) {
	configDir, err := ioutil.TempDir("", "faas-cli-file-test")
	if err != nil {
		t.Fatalf("can not create test config directory: %s", err)
	}
	defer os.RemoveAll(configDir)

	os.Setenv(ConfigLocationEnv, configDir)
	defer os.Unsetenv(ConfigLocationEnv)

	err = RemoveAuthConfig("http://openfaas.test1")
	if err == nil {
		t.Errorf("Error was not returned")
	}

	r := regexp.MustCompile(`(?m:config file not found)`)
	if !r.MatchString(err.Error()) {
		t.Errorf("Error not matched: %s", err.Error())
	}
}

func Test_RemoveAuthConfig_WithUnknownGateway(t *testing.T) {
	configDir, err := ioutil.TempDir("", "faas-cli-file-test")
	if err != nil {
		t.Fatalf("can not create test config directory: %s", err)
	}
	defer os.RemoveAll(configDir)

	os.Setenv(ConfigLocationEnv, configDir)
	defer os.Unsetenv(ConfigLocationEnv)

	u := "admin"
	p := "pass"
	token := EncodeAuth(u, p)
	gatewayURL := strings.TrimRight("http://openfaas.test/", "/")
	err = UpdateAuthConfig(gatewayURL, token, BasicAuthType)
	if err != nil {
		t.Fatalf("unexpected error when updating auth config: %s", err)
	}

	err = RemoveAuthConfig("http://openfaas.test1")
	if err == nil {
		t.Errorf("Error was not returned")
	}

	r := regexp.MustCompile(`(?m:gateway)`)
	if !r.MatchString(err.Error()) {
		t.Errorf("Error not matched: %s", err.Error())
	}
}

func Test_UpdateAuthConfig_Oauth2Insert(t *testing.T) {
	configDir, err := ioutil.TempDir("", "faas-cli-file-test")
	if err != nil {
		t.Fatalf("can not create test config directory: %s", err)
	}
	defer os.RemoveAll(configDir)

	os.Setenv(ConfigLocationEnv, configDir)
	defer os.Unsetenv(ConfigLocationEnv)

	token := "somebase64encodedstring"
	gatewayURL := strings.TrimRight("http://openfaas.test/", "/")
	err = UpdateAuthConfig(gatewayURL, token, Oauth2AuthType)
	if err != nil {
		t.Fatalf("unexpected error when updating auth config: %s", err)
	}

	authConfig, err := LookupAuthConfig(gatewayURL)
	if err != nil {
		t.Errorf("got error %s", err.Error())
		t.Errorf(authConfig.Token)
	}

	if authConfig.Token != token {
		t.Errorf("got token %s, expected %s", authConfig.Token, token)
	}
}

func Test_ConfigDir(t *testing.T) {

	cases := []struct {
		name         string
		env          map[string]string
		expectedPath string
	}{
		{
			name: "override value is returned",
			env: map[string]string{
				"OPENFAAS_CONFIG": "/tmp/foo",
			},
			expectedPath: "/tmp/foo",
		},
		{
			name: "override value is returned, when CI is set but false",
			env: map[string]string{
				"OPENFAAS_CONFIG": "/tmp/foo",
				"CI":              "false",
			},
			expectedPath: "/tmp/foo",
		},
		{
			name: "override value is returned even when CI is set",
			env: map[string]string{
				"OPENFAAS_CONFIG": "/tmp/foo",
				"CI":              "true",
			},
			expectedPath: "/tmp/foo",
		},
		{
			name: "when CI is true, return the default CI directory",
			env: map[string]string{
				"CI": "true",
			},
			expectedPath: DefaultCIDir,
		},
		{
			name: "when CI is false, return the default directory",
			env: map[string]string{
				"CI": "false",
			},
			expectedPath: DefaultDir,
		},
		{
			name:         "when no other env variables are set, the default path is returned",
			expectedPath: DefaultDir,
		},
	}

	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {

			for name, value := range tc.env {
				os.Setenv(name, value)
				defer os.Unsetenv(name)
			}

			path := ConfigDir()
			if path != tc.expectedPath {
				t.Fatalf("expected config path '%s', got '%s'", tc.expectedPath, path)
			}
		})
	}

}