1
0
mirror of https://github.com/go-acme/lego.git synced 2024-12-23 01:07:23 +02:00
lego/providers/dns/cpanel/cpanel_test.go

306 lines
6.4 KiB
Go
Raw Permalink Normal View History

package cpanel
import (
"testing"
"time"
"github.com/go-acme/lego/v4/platform/tester"
"github.com/go-acme/lego/v4/providers/dns/cpanel/internal/shared"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
const envDomain = envNamespace + "DOMAIN"
var envTest = tester.NewEnvTest(
EnvMode,
EnvUsername,
EnvToken,
2024-02-06 18:17:59 +02:00
EnvBaseURL).
WithDomain(envDomain)
func TestNewDNSProvider(t *testing.T) {
testCases := []struct {
desc string
envVars map[string]string
expected string
expectedMode string
}{
{
desc: "success cpanel mode (default)",
envVars: map[string]string{
2024-02-06 18:17:59 +02:00
EnvUsername: "user",
EnvToken: "secret",
EnvBaseURL: "https://example.com",
},
expectedMode: "cpanel",
},
{
desc: "success whm mode",
envVars: map[string]string{
2024-02-06 18:17:59 +02:00
EnvMode: "whm",
EnvUsername: "user",
EnvToken: "secret",
EnvBaseURL: "https://example.com",
},
expectedMode: "whm",
},
{
desc: "missing user",
envVars: map[string]string{
2024-02-06 18:17:59 +02:00
EnvToken: "secret",
EnvBaseURL: "https://example.com",
},
expected: "cpanel: some credentials information are missing: CPANEL_USERNAME",
},
{
desc: "missing token",
envVars: map[string]string{
2024-02-06 18:17:59 +02:00
EnvUsername: "user",
EnvBaseURL: "https://example.com",
},
expected: "cpanel: some credentials information are missing: CPANEL_TOKEN",
},
{
desc: "missing base URL",
envVars: map[string]string{
2024-02-06 18:17:59 +02:00
EnvUsername: "user",
EnvToken: "secret",
EnvBaseURL: "",
},
expected: "cpanel: some credentials information are missing: CPANEL_BASE_URL",
},
}
for _, test := range testCases {
t.Run(test.desc, func(t *testing.T) {
defer envTest.RestoreEnv()
envTest.ClearEnv()
envTest.Apply(test.envVars)
p, err := NewDNSProvider()
if test.expected == "" {
assert.Equal(t, test.expectedMode, p.config.Mode)
require.NoError(t, err)
require.NotNil(t, p)
require.NotNil(t, p.config)
} else {
require.EqualError(t, err, test.expected)
}
})
}
}
func TestNewDNSProviderConfig(t *testing.T) {
testCases := []struct {
2024-02-06 18:17:59 +02:00
desc string
mode string
username string
token string
baseURL string
expected string
}{
{
2024-02-06 18:17:59 +02:00
desc: "success",
mode: "whm",
username: "user",
token: "secret",
baseURL: "https://example.com",
},
{
2024-02-06 18:17:59 +02:00
desc: "missing mode",
username: "user",
token: "secret",
baseURL: "https://example.com",
expected: `cpanel: create client error: unsupported mode: ""`,
},
{
2024-02-06 18:17:59 +02:00
desc: "invalid mode",
mode: "test",
username: "user",
token: "secret",
baseURL: "https://example.com",
expected: `cpanel: create client error: unsupported mode: "test"`,
},
{
2024-02-06 18:17:59 +02:00
desc: "missing username",
mode: "whm",
username: "",
token: "secret",
baseURL: "https://example.com",
expected: "cpanel: some credentials information are missing",
},
{
2024-02-06 18:17:59 +02:00
desc: "missing token",
mode: "whm",
username: "user",
token: "",
baseURL: "https://example.com",
expected: "cpanel: some credentials information are missing",
},
{
2024-02-06 18:17:59 +02:00
desc: "missing base URL",
mode: "whm",
username: "user",
token: "secret",
baseURL: "",
expected: "cpanel: server information are missing",
},
}
for _, test := range testCases {
t.Run(test.desc, func(t *testing.T) {
config := NewDefaultConfig()
config.Mode = test.mode
config.Username = test.username
config.Token = test.token
config.BaseURL = test.baseURL
p, err := NewDNSProviderConfig(config)
if test.expected == "" {
require.NoError(t, err)
require.NotNil(t, p)
require.NotNil(t, p.config)
require.NotNil(t, p.client)
} else {
require.EqualError(t, err, test.expected)
}
})
}
}
func Test_getZoneSerial(t *testing.T) {
zones := []shared.ZoneRecord{
{
Type: "comment",
LineIndex: 1,
TextB64: "OyBab25lIGZpbGUgZm9yIGV4YW1wbGUuY29t",
},
{
Type: "control",
LineIndex: 2,
TextB64: "JFRUTCAxNDQwMA==",
},
{
DNameB64: "ZXhhbXBsZS5jb20u",
LineIndex: 4,
RecordType: "NS",
Type: "record",
TTL: 86400,
DataB64: []string{"YWxsMS5kbnNyb3VuZHJvYmluLm5ldC4="},
},
{
DataB64: []string{
"YWxsMS5kbnNyb3VuZHJvYmluLm5ldC4=",
"ZW1haWwuaXB4Y29yZS5jb20u",
"MjAyNDAyMDQwOQ==",
"MzYwMA==",
"MTgwMA==",
"MTIwOTYwMA==",
"ODY0MDA=",
},
RecordType: "SOA",
Type: "record",
TTL: 86400,
LineIndex: 3,
DNameB64: "ZXhhbXBsZS5jb20u",
},
{
RecordType: "A",
Type: "record",
TTL: 3600,
DataB64: []string{"MTAuMTAuMTAuMTA="},
LineIndex: 9,
DNameB64: "ZXhhbXBsZS5jb20u",
},
}
serial, err := getZoneSerial("example.com.", zones)
require.NoError(t, err)
assert.EqualValues(t, 2024020409, serial)
}
func Test_getZoneSerial_error(t *testing.T) {
zones := []shared.ZoneRecord{
{
Type: "comment",
LineIndex: 1,
TextB64: "OyBab25lIGZpbGUgZm9yIGV4YW1wbGUuY29t",
},
{
Type: "control",
LineIndex: 2,
TextB64: "JFRUTCAxNDQwMA==",
},
{
DNameB64: "ZXhhbXBsZS5jb20u",
LineIndex: 4,
RecordType: "NS",
Type: "record",
TTL: 86400,
DataB64: []string{"YWxsMS5kbnNyb3VuZHJvYmluLm5ldC4="},
},
{
DataB64: []string{
"YWxsMS5kbnNyb3VuZHJvYmluLm5ldC4=",
"ZW1haWwuaXB4Y29yZS5jb20u",
"MjAyNDAyMDQwOQ==",
"MzYwMA==",
"MTgwMA==",
"MTIwOTYwMA==",
"ODY0MDA=",
},
RecordType: "SOA",
Type: "record",
TTL: 86400,
LineIndex: 3,
DNameB64: "ZXhhbXBsZS5vcmcu",
},
{
RecordType: "A",
Type: "record",
TTL: 3600,
DataB64: []string{"MTAuMTAuMTAuMTA="},
LineIndex: 9,
DNameB64: "ZXhhbXBsZS5jb20u",
},
}
serial, err := getZoneSerial("example.com.", zones)
require.Error(t, err)
assert.EqualValues(t, 0, serial)
}
func TestLivePresent(t *testing.T) {
if !envTest.IsLiveTest() {
t.Skip("skipping live test")
}
envTest.RestoreEnv()
provider, err := NewDNSProvider()
require.NoError(t, err)
err = provider.Present(envTest.GetDomain(), "", "123d==")
require.NoError(t, err)
}
func TestLiveCleanUp(t *testing.T) {
if !envTest.IsLiveTest() {
t.Skip("skipping live test")
}
envTest.RestoreEnv()
provider, err := NewDNSProvider()
require.NoError(t, err)
time.Sleep(1 * time.Second)
err = provider.CleanUp(envTest.GetDomain(), "", "123d==")
require.NoError(t, err)
}