Skip to content

Commit

Permalink
cmd/config/imap: refactor tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@vs49688
vs49688 committed Jul 30, 2022
1 parent 1cc5d62 commit 122a1d5
Showing 1 changed file with 136 additions and 118 deletions.
254 changes: 136 additions & 118 deletions cmd/config/imap_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ package config

import (
"crypto/tls"
"os"
"path"
"testing"

"github.com/emersion/go-sasl"
Expand All @@ -22,149 +24,165 @@ func getTestIMAPConfig() IMAPConfig {
return cfg
}

func TestIMAPConfig_Resolve_Basic(t *testing.T) {
cfg := getTestIMAPConfig()

connConfig, _, err := cfg.Resolve()
assert.NoError(t, err)
assert.Equal(t, imap.ConnectionConfig{
HostPort: "imap.hostname.com:1234",
Auth: imap.NewNormalAuthenticator("username", "password"),
Mailbox: "INBOX",
TLS: true,
TLSConfig: nil,
Debug: false,
}, connConfig)
}
func TestIMAPConfig_Resolve(t *testing.T) {
t.Run("factories", func(t *testing.T) {
t.Run("persistent", func(t *testing.T) {
cfg := getTestIMAPConfig()
cfg.Transport = "persistent"

func TestIMAPConfig_Resolve_Factories(t *testing.T) {
t.Parallel()
_, factory, err := cfg.Resolve()
assert.NoError(t, err)
assert.Equal(t, persistentclient.Factory{MaxDelay: 0}, factory)
})

t.Run("persistent", func(t *testing.T) {
cfg := getTestIMAPConfig()
cfg.Transport = "persistent"
t.Run("standard", func(t *testing.T) {
cfg := getTestIMAPConfig()
cfg.Transport = "standard"

_, factory, err := cfg.Resolve()
assert.NoError(t, err)
assert.Equal(t, persistentclient.Factory{MaxDelay: 0}, factory)
})
_, factory, err := cfg.Resolve()
assert.NoError(t, err)
assert.Equal(t, client.Factory{}, factory)
})

t.Run("standard", func(t *testing.T) {
cfg := getTestIMAPConfig()
cfg.Transport = "standard"
t.Run("anything_else", func(t *testing.T) {
cfg := getTestIMAPConfig()
cfg.Transport = "anything_else"

_, factory, err := cfg.Resolve()
assert.NoError(t, err)
assert.Equal(t, client.Factory{}, factory)
_, factory, err := cfg.Resolve()
assert.NoError(t, err)
assert.Equal(t, client.Factory{}, factory)
})
})

t.Run("anything_else", func(t *testing.T) {
cfg := getTestIMAPConfig()
cfg.Transport = "anything_else"

_, factory, err := cfg.Resolve()
assert.NoError(t, err)
assert.Equal(t, client.Factory{}, factory)
})
}
t.Run("passwords", func(t *testing.T) {
t.Run("password", func(t *testing.T) {
cfg := getTestIMAPConfig()

connConfig, _, err := cfg.Resolve()
assert.NoError(t, err)
assert.Equal(t, imap.ConnectionConfig{
HostPort: "imap.hostname.com:1234",
Auth: imap.NewNormalAuthenticator("username", "password"),
Mailbox: "INBOX",
TLS: true,
TLSConfig: nil,
Debug: false,
}, connConfig)
})

func TestIMAPConfig_Resolve_PasswordFile(t *testing.T) {
cfg := getTestIMAPConfig()
cfg.Password = ""
cfg.PasswordFile = "testdata/testpass.txt"

connConfig, _, err := cfg.Resolve()
assert.NoError(t, err)
assert.Equal(t, imap.ConnectionConfig{
HostPort: "imap.hostname.com:1234",
Auth: imap.NewNormalAuthenticator("username", "password"),
Mailbox: "INBOX",
TLS: true,
TLSConfig: nil,
Debug: false,
}, connConfig)
}
t.Run("password_file", func(t *testing.T) {
cfg := getTestIMAPConfig()
cfg.Password = ""
cfg.PasswordFile = "testdata/testpass.txt"

connConfig, _, err := cfg.Resolve()
assert.NoError(t, err)
assert.Equal(t, imap.ConnectionConfig{
HostPort: "imap.hostname.com:1234",
Auth: imap.NewNormalAuthenticator("username", "password"),
Mailbox: "INBOX",
TLS: true,
TLSConfig: nil,
Debug: false,
}, connConfig)
})

func TestIMAPConfig_Resolve_Systemd(t *testing.T) {
cfg := getTestIMAPConfig()
cfg.Password = ""
cfg.SystemdCredential = "testpass.txt"

t.Setenv("CREDENTIALS_DIRECTORY", "testdata")

connConfig, _, err := cfg.Resolve()
assert.NoError(t, err)
assert.Equal(t, imap.ConnectionConfig{
HostPort: "imap.hostname.com:1234",
Auth: imap.NewNormalAuthenticator("username", "password"),
Mailbox: "INBOX",
TLS: true,
TLSConfig: nil,
Debug: false,
}, connConfig)
}
t.Run("systemd_credential", func(t *testing.T) {
t.Setenv("CREDENTIALS_DIRECTORY", "testdata")

cfg := getTestIMAPConfig()
cfg.Password = ""
cfg.SystemdCredential = "testpass.txt"

connConfig, _, err := cfg.Resolve()
assert.NoError(t, err)
assert.Equal(t, imap.ConnectionConfig{
HostPort: "imap.hostname.com:1234",
Auth: imap.NewNormalAuthenticator("username", "password"),
Mailbox: "INBOX",
TLS: true,
TLSConfig: nil,
Debug: false,
}, connConfig)
})

func TestIMAPConfig_Resolve_TLS(t *testing.T) {
cfg := getTestIMAPConfig()
cfg.TLSSkipVerify = true

connConfig, _, err := cfg.Resolve()
assert.NoError(t, err)
assert.Equal(t, imap.ConnectionConfig{
HostPort: "imap.hostname.com:1234",
Auth: imap.NewNormalAuthenticator("username", "password"),
Mailbox: "INBOX",
TLS: true,
TLSConfig: &tls.Config{InsecureSkipVerify: true},
Debug: false,
}, connConfig)
}
t.Run("systemd_credential_invalid", func(t *testing.T) {
cwd, err := os.Getwd()
if !assert.NoError(t, err) {
t.FailNow()
}

func TestIMAPConfig_Resolve_Auth(t *testing.T) {
t.Parallel()
t.Setenv("CREDENTIALS_DIRECTORY", path.Join(cwd, "testdata"))

t.Run("login", func(t *testing.T) {
ctrl := gomock.NewController(t)
cfg := getTestIMAPConfig()
cfg.Password = ""
cfg.SystemdCredential = "../testpass.txt"

mockAuth := mock_imap.NewMockAuthenticatable(ctrl)
mockAuth.EXPECT().Login("username", "password")
_, _, err = cfg.Resolve()
assert.Error(t, err)
})
})

t.Run("tls", func(t *testing.T) {
cfg := getTestIMAPConfig()
cfg.AuthMethod = "LOGIN"
cfg.TLSSkipVerify = true

connConfig, _, err := cfg.Resolve()
if !assert.NoError(t, err) {
t.FailNow()
}

assert.NoError(t, connConfig.Auth.Authenticate(mockAuth))
assert.NoError(t, err)
assert.Equal(t, imap.ConnectionConfig{
HostPort: "imap.hostname.com:1234",
Auth: imap.NewNormalAuthenticator("username", "password"),
Mailbox: "INBOX",
TLS: true,
TLSConfig: &tls.Config{InsecureSkipVerify: true},
Debug: false,
}, connConfig)
})

t.Run("plain", func(t *testing.T) {
ctrl := gomock.NewController(t)
t.Run("auth", func(t *testing.T) {
t.Run("login", func(t *testing.T) {
ctrl := gomock.NewController(t)

mockAuth := mock_imap.NewMockAuthenticatable(ctrl)
mockAuth.EXPECT().Login("username", "password")

cfg := getTestIMAPConfig()
cfg.AuthMethod = "LOGIN"

mockAuth := mock_imap.NewMockAuthenticatable(ctrl)
mockAuth.EXPECT().Authenticate(gomock.Any()).DoAndReturn(func(c sasl.Client) error {
mech, ir, err := c.Start()
if err != nil {
return err
connConfig, _, err := cfg.Resolve()
if !assert.NoError(t, err) {
t.FailNow()
}

assert.Equal(t, "PLAIN", mech)
assert.Equal(t, []byte("\x00username\x00password"), ir)
return nil
assert.NoError(t, connConfig.Auth.Authenticate(mockAuth))
})

cfg := getTestIMAPConfig()
cfg.AuthMethod = "PLAIN"
t.Run("plain", func(t *testing.T) {
ctrl := gomock.NewController(t)

connConfig, _, err := cfg.Resolve()
if !assert.NoError(t, err) {
t.FailNow()
}
mockAuth := mock_imap.NewMockAuthenticatable(ctrl)
mockAuth.EXPECT().Authenticate(gomock.Any()).DoAndReturn(func(c sasl.Client) error {
mech, ir, err := c.Start()
if err != nil {
return err
}

assert.NoError(t, connConfig.Auth.Authenticate(mockAuth))
})
assert.Equal(t, "PLAIN", mech)
assert.Equal(t, []byte("\x00username\x00password"), ir)
return nil
})

// TODO: figure out how to test oauth
cfg := getTestIMAPConfig()
cfg.AuthMethod = "PLAIN"

connConfig, _, err := cfg.Resolve()
if !assert.NoError(t, err) {
t.FailNow()
}

assert.NoError(t, connConfig.Auth.Authenticate(mockAuth))
})

// TODO: figure out how to test oauth
})
}

0 comments on commit 122a1d5

Please sign in to comment.