forked from TrueCloudLab/lego
294 lines
7.1 KiB
Go
294 lines
7.1 KiB
Go
package cloudflare
|
|
|
|
import (
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/go-acme/lego/v3/platform/tester"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
var envTest = tester.NewEnvTest(
|
|
"CLOUDFLARE_EMAIL",
|
|
"CLOUDFLARE_API_KEY",
|
|
"CLOUDFLARE_DNS_API_TOKEN",
|
|
"CLOUDFLARE_ZONE_API_TOKEN").
|
|
WithDomain("CLOUDFLARE_DOMAIN")
|
|
|
|
func TestNewDNSProvider(t *testing.T) {
|
|
testCases := []struct {
|
|
desc string
|
|
envVars map[string]string
|
|
expected string
|
|
}{
|
|
{
|
|
desc: "success email, API key",
|
|
envVars: map[string]string{
|
|
"CLOUDFLARE_EMAIL": "test@example.com",
|
|
"CLOUDFLARE_API_KEY": "123",
|
|
},
|
|
},
|
|
{
|
|
desc: "success API token",
|
|
envVars: map[string]string{
|
|
"CLOUDFLARE_DNS_API_TOKEN": "012345abcdef",
|
|
},
|
|
},
|
|
{
|
|
desc: "success separate API tokens",
|
|
envVars: map[string]string{
|
|
"CLOUDFLARE_DNS_API_TOKEN": "012345abcdef",
|
|
"CLOUDFLARE_ZONE_API_TOKEN": "abcdef012345",
|
|
},
|
|
},
|
|
{
|
|
desc: "missing credentials",
|
|
envVars: map[string]string{
|
|
"CLOUDFLARE_EMAIL": "",
|
|
"CLOUDFLARE_API_KEY": "",
|
|
"CLOUDFLARE_DNS_API_TOKEN": "",
|
|
},
|
|
expected: "cloudflare: some credentials information are missing: CLOUDFLARE_EMAIL,CLOUDFLARE_API_KEY or some credentials information are missing: CLOUDFLARE_DNS_API_TOKEN,CLOUDFLARE_ZONE_API_TOKEN",
|
|
},
|
|
{
|
|
desc: "missing email",
|
|
envVars: map[string]string{
|
|
"CLOUDFLARE_EMAIL": "",
|
|
"CLOUDFLARE_API_KEY": "key",
|
|
},
|
|
expected: "cloudflare: some credentials information are missing: CLOUDFLARE_EMAIL or some credentials information are missing: CLOUDFLARE_DNS_API_TOKEN,CLOUDFLARE_ZONE_API_TOKEN",
|
|
},
|
|
{
|
|
desc: "missing api key",
|
|
envVars: map[string]string{
|
|
"CLOUDFLARE_EMAIL": "awesome@possum.com",
|
|
"CLOUDFLARE_API_KEY": "",
|
|
},
|
|
expected: "cloudflare: some credentials information are missing: CLOUDFLARE_API_KEY or some credentials information are missing: CLOUDFLARE_DNS_API_TOKEN,CLOUDFLARE_ZONE_API_TOKEN",
|
|
},
|
|
}
|
|
|
|
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 len(test.expected) == 0 {
|
|
require.NoError(t, err)
|
|
require.NotNil(t, p)
|
|
assert.NotNil(t, p.config)
|
|
assert.NotNil(t, p.client)
|
|
} else {
|
|
require.EqualError(t, err, test.expected)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestNewDNSProviderWithToken(t *testing.T) {
|
|
type expected struct {
|
|
dnsToken string
|
|
zoneToken string
|
|
sameClient bool
|
|
error string
|
|
}
|
|
|
|
testCases := []struct {
|
|
desc string
|
|
|
|
// test input
|
|
envVars map[string]string
|
|
|
|
// expectations
|
|
expected expected
|
|
}{
|
|
{
|
|
desc: "same client when zone token is missing",
|
|
envVars: map[string]string{
|
|
"CLOUDFLARE_DNS_API_TOKEN": "123",
|
|
},
|
|
expected: expected{
|
|
dnsToken: "123",
|
|
zoneToken: "123",
|
|
sameClient: true,
|
|
},
|
|
},
|
|
{
|
|
desc: "same client when zone token equals dns token",
|
|
envVars: map[string]string{
|
|
"CLOUDFLARE_DNS_API_TOKEN": "123",
|
|
"CLOUDFLARE_ZONE_API_TOKEN": "123",
|
|
},
|
|
expected: expected{
|
|
dnsToken: "123",
|
|
zoneToken: "123",
|
|
sameClient: true,
|
|
},
|
|
},
|
|
{
|
|
desc: "failure when only zone api given",
|
|
envVars: map[string]string{
|
|
"CLOUDFLARE_ZONE_API_TOKEN": "123",
|
|
},
|
|
expected: expected{
|
|
error: "cloudflare: some credentials information are missing: CLOUDFLARE_EMAIL,CLOUDFLARE_API_KEY or some credentials information are missing: CLOUDFLARE_DNS_API_TOKEN",
|
|
},
|
|
},
|
|
{
|
|
desc: "different clients when zone and dns token differ",
|
|
envVars: map[string]string{
|
|
"CLOUDFLARE_DNS_API_TOKEN": "123",
|
|
"CLOUDFLARE_ZONE_API_TOKEN": "abc",
|
|
},
|
|
expected: expected{
|
|
dnsToken: "123",
|
|
zoneToken: "abc",
|
|
sameClient: false,
|
|
},
|
|
},
|
|
{
|
|
desc: "aliases work as expected", // CLOUDFLARE_* takes precedence over CF_*
|
|
envVars: map[string]string{
|
|
"CLOUDFLARE_DNS_API_TOKEN": "123",
|
|
"CF_DNS_API_TOKEN": "456",
|
|
"CLOUDFLARE_ZONE_API_TOKEN": "abc",
|
|
"CF_ZONE_API_TOKEN": "def",
|
|
},
|
|
expected: expected{
|
|
dnsToken: "123",
|
|
zoneToken: "abc",
|
|
sameClient: false,
|
|
},
|
|
},
|
|
}
|
|
|
|
defer envTest.RestoreEnv()
|
|
localEnvTest := tester.NewEnvTest(
|
|
"CLOUDFLARE_DNS_API_TOKEN", "CF_DNS_API_TOKEN",
|
|
"CLOUDFLARE_ZONE_API_TOKEN", "CF_ZONE_API_TOKEN",
|
|
).WithDomain("CLOUDFLARE_DOMAIN")
|
|
envTest.ClearEnv()
|
|
|
|
for _, test := range testCases {
|
|
t.Run(test.desc, func(t *testing.T) {
|
|
defer localEnvTest.RestoreEnv()
|
|
localEnvTest.ClearEnv()
|
|
localEnvTest.Apply(test.envVars)
|
|
|
|
p, err := NewDNSProvider()
|
|
|
|
if test.expected.error != "" {
|
|
require.EqualError(t, err, test.expected.error)
|
|
return
|
|
}
|
|
|
|
require.NoError(t, err)
|
|
require.NotNil(t, p)
|
|
assert.Equal(t, test.expected.dnsToken, p.config.AuthToken)
|
|
assert.Equal(t, test.expected.zoneToken, p.config.ZoneToken)
|
|
if test.expected.sameClient {
|
|
assert.Equal(t, p.client.clientRead, p.client.clientEdit)
|
|
} else {
|
|
assert.NotEqual(t, p.client.clientRead, p.client.clientEdit)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestNewDNSProviderConfig(t *testing.T) {
|
|
testCases := []struct {
|
|
desc string
|
|
authEmail string
|
|
authKey string
|
|
authToken string
|
|
expected string
|
|
}{
|
|
{
|
|
desc: "success with email and api key",
|
|
authEmail: "test@example.com",
|
|
authKey: "123",
|
|
},
|
|
{
|
|
desc: "success with api token",
|
|
authToken: "012345abcdef",
|
|
},
|
|
{
|
|
desc: "prefer api token",
|
|
authToken: "012345abcdef",
|
|
authEmail: "test@example.com",
|
|
authKey: "123",
|
|
},
|
|
{
|
|
desc: "missing credentials",
|
|
expected: "cloudflare: invalid credentials: key & email must not be empty",
|
|
},
|
|
{
|
|
desc: "missing email",
|
|
authKey: "123",
|
|
expected: "cloudflare: invalid credentials: key & email must not be empty",
|
|
},
|
|
{
|
|
desc: "missing api key",
|
|
authEmail: "test@example.com",
|
|
expected: "cloudflare: invalid credentials: key & email must not be empty",
|
|
},
|
|
{
|
|
desc: "missing api token, fallback to api key/email",
|
|
authToken: "",
|
|
expected: "cloudflare: invalid credentials: key & email must not be empty",
|
|
},
|
|
}
|
|
|
|
for _, test := range testCases {
|
|
t.Run(test.desc, func(t *testing.T) {
|
|
config := NewDefaultConfig()
|
|
config.AuthEmail = test.authEmail
|
|
config.AuthKey = test.authKey
|
|
config.AuthToken = test.authToken
|
|
|
|
p, err := NewDNSProviderConfig(config)
|
|
|
|
if len(test.expected) == 0 {
|
|
require.NoError(t, err)
|
|
require.NotNil(t, p)
|
|
assert.NotNil(t, p.config)
|
|
assert.NotNil(t, p.client)
|
|
} else {
|
|
require.EqualError(t, err, test.expected)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
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(2 * time.Second)
|
|
|
|
err = provider.CleanUp(envTest.GetDomain(), "", "123d==")
|
|
require.NoError(t, err)
|
|
}
|