lego/providers/dns/internal/rimuhosting/client_test.go

package rimuhosting

import (
	"context"
	"encoding/xml"
	"fmt"
	"io"
	"net/http"
	"net/http/httptest"
	"net/url"
	"os"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func setupTest(t *testing.T) (*Client, *http.ServeMux) {
	t.Helper()

	mux := http.NewServeMux()
	server := httptest.NewServer(mux)
	t.Cleanup(server.Close)

	client := NewClient("apikeyvaluehere")
	client.BaseURL = server.URL
	client.HTTPClient = server.Client()

	return client, mux
}

func TestClient_FindTXTRecords(t *testing.T) {
	client, mux := setupTest(t)

	mux.HandleFunc("/", func(rw http.ResponseWriter, req *http.Request) {
		query := req.URL.Query()

		var fixture string
		switch query.Get("name") {
		case "example.com":
			fixture = "./fixtures/find_records.xml"
		case "**.example.com":
			fixture = "./fixtures/find_records_pattern.xml"
		default:
			fixture = "./fixtures/find_records_empty.xml"
		}

		err := writeResponse(rw, fixture)
		if err != nil {
			http.Error(rw, err.Error(), http.StatusInternalServerError)
			return
		}
	})

	testCases := []struct {
		desc     string
		domain   string
		expected []Record
	}{
		{
			desc:   "simple",
			domain: "example.com",
			expected: []Record{
				{
					Name:     "example.org",
					Type:     "TXT",
					Content:  "txttxtx",
					TTL:      "3600 seconds",
					Priority: "0",
				},
			},
		},
		{
			desc:   "pattern",
			domain: "**.example.com",
			expected: []Record{
				{
					Name:     "_test.example.org",
					Type:     "TXT",
					Content:  "txttxtx",
					TTL:      "3600 seconds",
					Priority: "0",
				},
				{
					Name:     "example.org",
					Type:     "TXT",
					Content:  "txttxtx",
					TTL:      "3600 seconds",
					Priority: "0",
				},
			},
		},
		{
			desc:     "empty",
			domain:   "empty.com",
			expected: nil,
		},
	}

	for _, test := range testCases {
		t.Run(test.desc, func(t *testing.T) {
			records, err := client.FindTXTRecords(context.Background(), test.domain)
			require.NoError(t, err)

			assert.Equal(t, test.expected, records)
		})
	}
}

func TestClient_DoActions(t *testing.T) {
	type expected struct {
		Query string
		Resp  *DNSAPIResult
		Error string
	}

	testCases := []struct {
		desc     string
		actions  []ActionParameter
		fixture  string
		expected expected
	}{
		{
			desc: "SET error",
			actions: []ActionParameter{
				NewAddRecordAction("example.com", "txttxtx", 0),
			},
			fixture: "./fixtures/add_record_error.xml",
			expected: expected{
				Query: "action=SET&api_key=apikeyvaluehere&name=example.com&type=TXT&value=txttxtx",
				Error: "ERROR: No zone found for example.com",
			},
		},
		{
			desc: "SET simple",
			actions: []ActionParameter{
				NewAddRecordAction("example.org", "txttxtx", 0),
			},
			fixture: "./fixtures/add_record.xml",
			expected: expected{
				Query: "action=SET&api_key=apikeyvaluehere&name=example.org&type=TXT&value=txttxtx",
				Resp: &DNSAPIResult{
					XMLName:      xml.Name{Space: "", Local: "dnsapi_result"},
					IsOk:         "OK:",
					ResultCounts: ResultCounts{Added: "1", Changed: "0", Unchanged: "0", Deleted: "0"},
					Actions: Actions{
						Action: Action{
							Action: "SET",
							Host:   "example.org",
							Type:   "TXT",
							Records: []Record{{
								Name:     "example.org",
								Type:     "TXT",
								Content:  "txttxtx",
								TTL:      "3600 seconds",
								Priority: "0",
							}},
						},
					},
				},
			},
		},
		{
			desc: "SET multiple values",
			actions: []ActionParameter{
				NewAddRecordAction("example.org", "txttxtx", 0),
				NewAddRecordAction("example.org", "sample", 0),
			},
			fixture: "./fixtures/add_record_same_domain.xml",
			expected: expected{
				Query: "action[0]=SET&action[1]=SET&api_key=apikeyvaluehere&name[0]=example.org&name[1]=example.org&ttl[0]=0&ttl[1]=0&type[0]=TXT&type[1]=TXT&value[0]=txttxtx&value[1]=sample",
				Resp: &DNSAPIResult{
					XMLName:      xml.Name{Space: "", Local: "dnsapi_result"},
					IsOk:         "OK:",
					ResultCounts: ResultCounts{Added: "2", Changed: "0", Unchanged: "0", Deleted: "0"},
					Actions: Actions{
						Action: Action{
							Action: "SET",
							Host:   "example.org",
							Type:   "TXT",
							Records: []Record{
								{
									Name:     "example.org",
									Type:     "TXT",
									Content:  "txttxtx",
									TTL:      "0 seconds",
									Priority: "0",
								},
								{
									Name:     "example.org",
									Type:     "TXT",
									Content:  "sample",
									TTL:      "0 seconds",
									Priority: "0",
								},
							},
						},
					},
				},
			},
		},
		{
			desc: "DELETE error",
			actions: []ActionParameter{
				NewDeleteRecordAction("example.com", "txttxtx"),
			},
			fixture: "./fixtures/delete_record_error.xml",
			expected: expected{
				Query: "action=DELETE&api_key=apikeyvaluehere&name=example.com&type=TXT&value=txttxtx",
				Error: "ERROR: No zone found for example.com",
			},
		},
		{
			desc: "DELETE nothing",
			actions: []ActionParameter{
				NewDeleteRecordAction("example.org", "nothing"),
			},
			fixture: "./fixtures/delete_record_nothing.xml",
			expected: expected{
				Query: "action=DELETE&api_key=apikeyvaluehere&name=example.org&type=TXT&value=nothing",
				Resp: &DNSAPIResult{
					XMLName:      xml.Name{Space: "", Local: "dnsapi_result"},
					IsOk:         "OK:",
					ResultCounts: ResultCounts{Added: "0", Changed: "0", Unchanged: "0", Deleted: "0"},
					Actions: Actions{
						Action: Action{
							Action:  "DELETE",
							Host:    "example.org",
							Type:    "TXT",
							Records: nil,
						},
					},
				},
			},
		},
		{
			desc: "DELETE simple",
			actions: []ActionParameter{
				NewDeleteRecordAction("example.org", "txttxtx"),
			},
			fixture: "./fixtures/delete_record.xml",
			expected: expected{
				Query: "action=DELETE&api_key=apikeyvaluehere&name=example.org&type=TXT&value=txttxtx",
				Resp: &DNSAPIResult{
					XMLName:      xml.Name{Space: "", Local: "dnsapi_result"},
					IsOk:         "OK:",
					ResultCounts: ResultCounts{Added: "0", Changed: "0", Unchanged: "0", Deleted: "1"},
					Actions: Actions{
						Action: Action{
							Action: "DELETE",
							Host:   "example.org",
							Type:   "TXT",
							Records: []Record{{
								Name:     "example.org",
								Type:     "TXT",
								Content:  "txttxtx",
								TTL:      "3600 seconds",
								Priority: "0",
							}},
						},
					},
				},
			},
		},
	}

	for _, test := range testCases {
		t.Run(test.desc, func(t *testing.T) {
			client, mux := setupTest(t)

			mux.HandleFunc("/", func(rw http.ResponseWriter, req *http.Request) {
				query, err := url.QueryUnescape(req.URL.RawQuery)
				if err != nil {
					http.Error(rw, err.Error(), http.StatusInternalServerError)
					return
				}

				if test.expected.Query != query {
					http.Error(rw, fmt.Sprintf("invalid query: %s", query), http.StatusBadRequest)
					return
				}

				if test.expected.Error != "" {
					rw.WriteHeader(http.StatusInternalServerError)
				}

				err = writeResponse(rw, test.fixture)
				if err != nil {
					http.Error(rw, err.Error(), http.StatusInternalServerError)
					return
				}
			})

			resp, err := client.DoActions(context.Background(), test.actions...)
			if test.expected.Error != "" {
				require.EqualError(t, err, test.expected.Error)
				return
			}

			require.NoError(t, err)

			assert.Equal(t, test.expected.Resp, resp)
		})
	}
}

func writeResponse(rw io.Writer, filename string) error {
	file, err := os.Open(filename)
	if err != nil {
		return err
	}

	defer func() { _ = file.Close() }()

	_, err = io.Copy(rw, file)
	return err
}