Merge pull request #2 from wojas/add-close

Add Close() receiver and go.mod

.golangci.yml

@@ -0,0 +1,12 @@
+# See https://github.com/golangci/golangci-lint/blob/master/.golangci.yml for more examples
+
+linters:
+    enabled:
+        # In addition to default standard linters (see: golangci-lint help linters)
+        # Try extra ones line this: golangci-lint run --disable-all --enable=lll
+        - goimports
+        # For future consideration (requires some extra work, but suggestions look useful)
+        # - gocritic
+        # - golint # can sometimes be a bit pedantic
+        # - lll
+

.travis.yml

@@ -1,7 +1,9 @@
 sudo: false
 language: go
-before_script:
-  - go get github.com/golangci/golangci-lint/cmd/golangci-lint
-  - go install github.com/golangci/golangci-lint/cmd/golangci-lint
+env:
+  - GO111MODULE=on
+go:
+  - 1.x  # latest version
+  - 1.12 # lowest supported version
 script:
-  - golangci-lint run --enable-all # this is excessive but we get away with it for now
+  - ./test.sh

dnsdist/client.go

@@ -12,13 +12,16 @@ import (
 	"golang.org/x/crypto/nacl/secretbox"
 )
 
+// Conn is a connection to the dnsdist console
 type Conn struct {
 	conn         net.Conn
 	readingNonce [24]byte
 	writingNonce [24]byte
 	key          [32]byte
 }
 
+// Dial connects to a dnsdist server. The target address is a host with port.
+// The secret is a base64 encoded 32 byte key as returned by makeKey() in the console.
 func Dial(target string, secret string) (*Conn, error) {
 	ourNonce := make([]byte, 24)
 	_, err := rand.Read(ourNonce)
@@ -82,6 +85,8 @@ func incrementNonce(nonce *[24]byte) {
 	binary.BigEndian.PutUint32(nonce[:4], value)
 }
 
+// Command sends one command to dnsdist. It returns an error if the call failed.
+// Application level (dnsdist Lua) errors do not result in a Go error.
 func (dc *Conn) Command(cmd string) (string, error) {
 	encodedcommand := secretbox.Seal(nil, []byte(cmd), &dc.writingNonce, &dc.key)
 	incrementNonce(&dc.writingNonce)
@@ -117,3 +122,8 @@ func (dc *Conn) Command(cmd string) (string, error) {
 	}
 	return string(decodedresponse), nil
 }
+
+// Close closes the connection
+func (dc *Conn) Close() error {
+	return dc.conn.Close()
+}

go.mod

@@ -0,0 +1,8 @@
+module github.com/PowerDNS/go-dnsdist-client
+
+go 1.14
+
+require (
+	github.com/golangci/golangci-lint v1.27.0
+	golang.org/x/crypto v0.0.0-20200604202706-70a84ac30bf9
+)

test.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -ex
+go test ./...
+go run github.com/golangci/golangci-lint/cmd/golangci-lint run

tools/tools.go

@@ -0,0 +1,7 @@
+// +build tools
+
+package tools
+
+import (
+	_ "github.com/golangci/golangci-lint/cmd/golangci-lint"
+)