| 1 |
package octenium |
| 2 |
|
| 3 |
import ( |
| 4 |
"net/http/httptest" |
| 5 |
"net/url" |
| 6 |
"testing" |
| 7 |
|
| 8 |
"github.com/go-acme/lego/v4/platform/tester" |
| 9 |
"github.com/go-acme/lego/v4/platform/tester/servermock" |
| 10 |
"github.com/stretchr/testify/require" |
| 11 |
) |
| 12 |
|
| 13 |
const envDomain = envNamespace + "DOMAIN" |
| 14 |
|
| 15 |
var envTest = tester.NewEnvTest(EnvAPIKey).WithDomain(envDomain) |
| 16 |
|
| 17 |
func TestNewDNSProvider(t *testing.T) { |
| 18 |
testCases := []struct { |
| 19 |
desc string |
| 20 |
envVars map[string]string |
| 21 |
expected string |
| 22 |
}{ |
| 23 |
{ |
| 24 |
desc: "success", |
| 25 |
envVars: map[string]string{ |
| 26 |
EnvAPIKey: "secret", |
| 27 |
}, |
| 28 |
}, |
| 29 |
{ |
| 30 |
desc: "missing API key", |
| 31 |
envVars: map[string]string{ |
| 32 |
EnvAPIKey: "", |
| 33 |
}, |
| 34 |
expected: "octenium: some credentials information are missing: OCTENIUM_API_KEY", |
| 35 |
}, |
| 36 |
{ |
| 37 |
desc: "missing credentials", |
| 38 |
envVars: map[string]string{}, |
| 39 |
expected: "octenium: some credentials information are missing: OCTENIUM_API_KEY", |
| 40 |
}, |
| 41 |
} |
| 42 |
|
| 43 |
for _, test := range testCases { |
| 44 |
t.Run(test.desc, func(t *testing.T) { |
| 45 |
defer envTest.RestoreEnv() |
| 46 |
|
| 47 |
envTest.ClearEnv() |
| 48 |
|
| 49 |
envTest.Apply(test.envVars) |
| 50 |
|
| 51 |
p, err := NewDNSProvider() |
| 52 |
|
| 53 |
if test.expected == "" { |
| 54 |
require.NoError(t, err) |
| 55 |
require.NotNil(t, p) |
| 56 |
require.NotNil(t, p.config) |
| 57 |
require.NotNil(t, p.client) |
| 58 |
} else { |
| 59 |
require.EqualError(t, err, test.expected) |
| 60 |
} |
| 61 |
}) |
| 62 |
} |
| 63 |
} |
| 64 |
|
| 65 |
func TestNewDNSProviderConfig(t *testing.T) { |
| 66 |
testCases := []struct { |
| 67 |
desc string |
| 68 |
apiKey string |
| 69 |
expected string |
| 70 |
}{ |
| 71 |
{ |
| 72 |
desc: "success", |
| 73 |
apiKey: "secret", |
| 74 |
}, |
| 75 |
{ |
| 76 |
desc: "missing API key", |
| 77 |
expected: "octenium: credentials missing", |
| 78 |
}, |
| 79 |
{ |
| 80 |
desc: "missing credentials", |
| 81 |
expected: "octenium: credentials missing", |
| 82 |
}, |
| 83 |
} |
| 84 |
|
| 85 |
for _, test := range testCases { |
| 86 |
t.Run(test.desc, func(t *testing.T) { |
| 87 |
config := NewDefaultConfig() |
| 88 |
config.APIKey = test.apiKey |
| 89 |
|
| 90 |
p, err := NewDNSProviderConfig(config) |
| 91 |
|
| 92 |
if test.expected == "" { |
| 93 |
require.NoError(t, err) |
| 94 |
require.NotNil(t, p) |
| 95 |
require.NotNil(t, p.config) |
| 96 |
require.NotNil(t, p.client) |
| 97 |
} else { |
| 98 |
require.EqualError(t, err, test.expected) |
| 99 |
} |
| 100 |
}) |
| 101 |
} |
| 102 |
} |
| 103 |
|
| 104 |
func TestLivePresent(t *testing.T) { |
| 105 |
if !envTest.IsLiveTest() { |
| 106 |
t.Skip("skipping live test") |
| 107 |
} |
| 108 |
|
| 109 |
envTest.RestoreEnv() |
| 110 |
|
| 111 |
provider, err := NewDNSProvider() |
| 112 |
require.NoError(t, err) |
| 113 |
|
| 114 |
err = provider.Present(envTest.GetDomain(), "", "123d==") |
| 115 |
require.NoError(t, err) |
| 116 |
} |
| 117 |
|
| 118 |
func TestLiveCleanUp(t *testing.T) { |
| 119 |
if !envTest.IsLiveTest() { |
| 120 |
t.Skip("skipping live test") |
| 121 |
} |
| 122 |
|
| 123 |
envTest.RestoreEnv() |
| 124 |
|
| 125 |
provider, err := NewDNSProvider() |
| 126 |
require.NoError(t, err) |
| 127 |
|
| 128 |
err = provider.CleanUp(envTest.GetDomain(), "", "123d==") |
| 129 |
require.NoError(t, err) |
| 130 |
} |
| 131 |
|
| 132 |
func mockBuilder() *servermock.Builder[*DNSProvider] { |
| 133 |
return servermock.NewBuilder( |
| 134 |
func(server *httptest.Server) (*DNSProvider, error) { |
| 135 |
config := NewDefaultConfig() |
| 136 |
config.APIKey = "secret" |
| 137 |
config.HTTPClient = server.Client() |
| 138 |
|
| 139 |
p, err := NewDNSProviderConfig(config) |
| 140 |
if err != nil { |
| 141 |
return nil, err |
| 142 |
} |
| 143 |
|
| 144 |
p.client.BaseURL, _ = url.Parse(server.URL) |
| 145 |
|
| 146 |
return p, nil |
| 147 |
}, |
| 148 |
servermock.CheckHeader(). |
| 149 |
WithAccept("application/json"). |
| 150 |
With("X-Api-Key", "secret"), |
| 151 |
) |
| 152 |
} |
| 153 |
|
| 154 |
func TestDNSProvider_Present(t *testing.T) { |
| 155 |
provider := mockBuilder(). |
| 156 |
Route("GET /domains", |
| 157 |
servermock.ResponseFromFixture("list_domains.json"), |
| 158 |
servermock.CheckQueryParameter().Strict(). |
| 159 |
With("domain-name", "example.com")). |
| 160 |
Route("POST /domains/dns-records/add", |
| 161 |
servermock.ResponseFromFixture("add_dns_record.json"), |
| 162 |
servermock.CheckHeader(). |
| 163 |
WithContentType("application/x-www-form-urlencoded"), |
| 164 |
servermock.CheckForm().Strict(). |
| 165 |
With("order-id", "2976"). |
| 166 |
With("name", "_acme-challenge.example.com."). |
| 167 |
With("ttl", "120"). |
| 168 |
With("type", "TXT"). |
| 169 |
With("value", "w6uP8Tcg6K2QR905Rms8iXTlksL6OD1KOWBxTK7wxPI")). |
| 170 |
Build(t) |
| 171 |
|
| 172 |
err := provider.Present("example.com", "", "foobar") |
| 173 |
require.NoError(t, err) |
| 174 |
} |
| 175 |
|
| 176 |
func TestDNSProvider_CleanUp(t *testing.T) { |
| 177 |
provider := mockBuilder(). |
| 178 |
Route("POST /domains/dns-records/list", |
| 179 |
servermock.ResponseFromFixture("list_dns_records.json"), |
| 180 |
servermock.CheckHeader(). |
| 181 |
WithContentType("application/x-www-form-urlencoded"), |
| 182 |
servermock.CheckForm().Strict(). |
| 183 |
With("order-id", "2976"). |
| 184 |
With("types[]", "TXT")). |
| 185 |
Route("POST /domains/dns-records/delete", |
| 186 |
servermock.ResponseFromFixture("delete_dns_record.json"), |
| 187 |
servermock.CheckHeader(). |
| 188 |
WithContentType("application/x-www-form-urlencoded"), |
| 189 |
servermock.CheckForm().Strict(). |
| 190 |
With("order-id", "2976"). |
| 191 |
With("line", "123")). |
| 192 |
Build(t) |
| 193 |
|
| 194 |
provider.domainIDs["token"] = "2976" |
| 195 |
|
| 196 |
err := provider.CleanUp("example.com", "token", "foobar") |
| 197 |
require.NoError(t, err) |
| 198 |
} |