plugin_test.go

package server

import (
	"os"
	"testing"
	"time"

	"github.com/spf13/viper"
	"github.com/stretchr/testify/require"
	"go.uber.org/zap"
)

type Cfg struct {
	v *viper.Viper
}

func InitMockCfg(v *viper.Viper) (*Cfg, error) {
	return &Cfg{
		v: v,
	}, nil
}

func (c *Cfg) UnmarshalKey(name string, out interface{}) error {
	return c.v.UnmarshalKey(name, out)
}

func (c *Cfg) Unmarshal(_ interface{}) error {
	return nil
}

func (c *Cfg) Get(_ string) interface{} {
	return nil
}

func (c *Cfg) Overwrite(_ map[string]interface{}) error {
	return nil
}

func (c *Cfg) Has(_ string) bool {
	return true
}

func (c *Cfg) GracefulTimeout() time.Duration {
	return time.Second
}

func (c *Cfg) RRVersion() string {
	return "2.8.0"
}

type TestLogger struct {
	log *zap.Logger
}

func NewTestLogger(log *zap.Logger) *TestLogger {
	return &TestLogger{
		log: log,
	}
}

func (tl *TestLogger) NamedLogger(string) *zap.Logger {
	return tl.log
}

func TestCommandUnknownUser(t *testing.T) {
	require.Panics(t, func() {
		log, _ := zap.NewDevelopment()
		p := &Plugin{
			preparedEnvs: make([]string, 0),
			cfg:          &Config{User: "foo"},
			log:          log,
		}

		_ = p.customCmd(nil)([]string{"php foo/bar"})
	})
}

func TestCommand1(t *testing.T) {
	log, _ := zap.NewDevelopment()
	p := &Plugin{
		preparedEnvs: make([]string, 0),
		cfg:          &Config{},
		log:          log,
	}

	cmd := p.customCmd(nil)([]string{"php foo/bar"})
	require.Equal(t, "php", cmd.Args[0])
	require.Equal(t, "foo/bar", cmd.Args[1])
}

func TestCommand2(t *testing.T) {
	log, _ := zap.NewDevelopment()
	p := &Plugin{
		preparedEnvs: make([]string, 0),
		cfg:          &Config{},
		log:          log,
	}

	cmd := p.customCmd(nil)([]string{"php foo bar"})
	require.Equal(t, "php", cmd.Args[0])
	require.Equal(t, "foo", cmd.Args[1])
	require.Equal(t, "bar", cmd.Args[2])
}

func TestCommand3(t *testing.T) {
	log, _ := zap.NewDevelopment()
	p := &Plugin{
		preparedEnvs: make([]string, 0),
		cfg:          &Config{},
		log:          log,
	}

	cmd := p.customCmd(nil)([]string{"php", "foo/bar"})
	require.Equal(t, "php", cmd.Args[0])
	require.Equal(t, "foo/bar", cmd.Args[1])
}

func TestCommand4_spaces(t *testing.T) {
	log, _ := zap.NewDevelopment()
	p := &Plugin{
		preparedEnvs: make([]string, 0),
		cfg:          &Config{},
		log:          log,
	}

	cmd := p.customCmd(nil)([]string{"/Application Support/folder/php", "foo/bar"})
	require.Equal(t, "/Application Support/folder/php", cmd.Args[0])
	require.Equal(t, "foo/bar", cmd.Args[1])
}

func TestEnv(t *testing.T) {
	log, _ := zap.NewDevelopment()
	p := &Plugin{
		preparedEnvs: make([]string, 0),
		cfg:          &Config{},
		log:          log,
	}

	err := os.Setenv("MYSQL_USER", "foo")
	require.NoError(t, err)
	err = os.Setenv("MYSQL_PASSWORD", "foo1")
	require.NoError(t, err)
	err = os.Setenv("MYSQL_HOST", "foo2")
	require.NoError(t, err)
	err = os.Setenv("MYSQL_PORT", "foo3")
	require.NoError(t, err)
	err = os.Setenv("MYSQL_DATABASE", "foo4")
	require.NoError(t, err)

	v := viper.New()
	v.Set("server.command", "php php_test_files/client.php echo pipes")

	m := make(map[string]interface{})
	m["env"] = `DATABASE_URL: "mysql://${MYSQL_USER}:${MYSQL_PASSWORD}@${MYSQL_HOST}:${MYSQL_PORT}/${MYSQL_DATABASE}?serverVersion=5.7`

	v.Set("server.env", m)
	cfg, err := InitMockCfg(v)
	require.NoError(t, err)

	err = p.Init(cfg, NewTestLogger(log))
	require.NoError(t, err)

	for i := 0; i < len(p.preparedEnvs); i++ {
		if p.preparedEnvs[i] == `ENV=DATABASE_URL: "mysql://foo:foo1@foo2:foo3/foo4?serverVersion=5.7` { //nolint:gosec
			return
		}
	}

	t.Fatal("DATABASE_ENV not found")
}

func TestEnv2(t *testing.T) {
	log, _ := zap.NewDevelopment()
	p := &Plugin{
		preparedEnvs: make([]string, 0),
		cfg:          &Config{},
		log:          log,
	}

	err := os.Setenv("MYSQL_USER", "foo")
	require.NoError(t, err)
	err = os.Setenv("MYSQL_PASSWORD", "foo1")
	require.NoError(t, err)
	err = os.Setenv("MYSQL_HOST", "foo2")
	require.NoError(t, err)
	err = os.Setenv("MYSQL_PORT", "foo3")
	require.NoError(t, err)
	err = os.Setenv("MYSQL_DATABASE", "foo4")
	require.NoError(t, err)

	v := viper.New()
	v.Set("server.command", "php php_test_files/client.php echo pipes")

	m := make(map[string]interface{})
	m["env"] = `DATABASE_URL: "mysql://$MYSQL_USER:$MYSQL_PASSWORD@$MYSQL_HOST:$MYSQL_PORT/$MYSQL_DATABASE?serverVersion=5.7`

	v.Set("server.env", m)
	cfg, err := InitMockCfg(v)
	require.NoError(t, err)

	err = p.Init(cfg, NewTestLogger(log))
	require.NoError(t, err)

	for i := 0; i < len(p.preparedEnvs); i++ {
		if p.preparedEnvs[i] == `ENV=DATABASE_URL: "mysql://foo:foo1@foo2:foo3/foo4?serverVersion=5.7` { //nolint:gosec
			return
		}
	}

	t.Fatal("DATABASE_ENV not found")
}

func TestEnv3(t *testing.T) {
	log, _ := zap.NewDevelopment()
	p := &Plugin{
		preparedEnvs: make([]string, 0),
		cfg:          &Config{},
		log:          log,
	}

	err := os.Setenv("MYSQL_USER", "foo")
	require.NoError(t, err)
	err = os.Setenv("MYSQL_PASSWORD", "foo1")
	require.NoError(t, err)
	err = os.Setenv("MYSQL_HOST", "foo2")
	require.NoError(t, err)
	err = os.Setenv("MYSQL_PORT", "foo3")
	require.NoError(t, err)
	err = os.Setenv("MYSQL_DATABASE", "foo4")
	require.NoError(t, err)

	v := viper.New()
	v.Set("server.command", "php php_test_files/client.php echo pipes")

	m := make(map[string]interface{})
	m["env"] = `DATABASE_URL: "mysql://$MYSQL_USE:$MYSQL_PASSWORD@$MYSQL_HOST:$MYSQL_PORT/$MYSQL_DATABASE?serverVersion=5.7`

	v.Set("server.env", m)
	cfg, err := InitMockCfg(v)
	require.NoError(t, err)

	err = p.Init(cfg, NewTestLogger(log))
	require.NoError(t, err)

	for i := 0; i < len(p.preparedEnvs); i++ {
		if p.preparedEnvs[i] == `ENV=DATABASE_URL: "mysql://:foo1@foo2:foo3/foo4?serverVersion=5.7` {
			return
		}
	}

	t.Fatal("DATABASE_ENV not found")
}

func TestEnv4(t *testing.T) {
	log, _ := zap.NewDevelopment()
	p := &Plugin{
		preparedEnvs: make([]string, 0),
		cfg:          &Config{},
		log:          log,
	}

	v := viper.New()
	v.Set("server.command", "php php_test_files/client.php echo pipes")

	m := make(map[string]interface{})
	m["env"] = `FOO: "$FOO_BAR`

	v.Set("server.env", m)
	cfg, err := InitMockCfg(v)
	require.NoError(t, err)

	err = p.Init(cfg, NewTestLogger(log))
	require.NoError(t, err)

	for i := 0; i < len(p.preparedEnvs); i++ {
		if p.preparedEnvs[i] == `ENV=FOO: "` {
			return
		}
	}

	t.Fatal("FOO not found")
}