Modularity(?)

Reviewed-on: https://git.froth.zone/sam/awl/pulls/77

Author: SamTherapy

.github/ISSUE_TEMPLATE/bug.md

@@ -17,7 +17,9 @@ Steps to reproduce the behavior:
 A clear and concise description of what you expected to happen.
 
 **Screenshots / Logs**
+```
 Add `-v=4` and add the debug logs to the report here:
+```
 
 **System information (please complete the following information):**
 

.github/pull_request_template.md

@@ -3,7 +3,7 @@
 Please check the following:
 
 1. Make sure you are targeting the `master` branch.
-2. Make sure that you test and format your contributions: `make test && make lint`
+2. Make sure that you test and format your contributions: `make full_test && make lint`
 3. Describe what your pull request does and which issue you're targeting (if any)
 
 -->

GNUmakefile

@@ -12,9 +12,8 @@ endif
 $(PROG): $(SOURCES)
 	$(GO) build -o $(EXE) $(GOFLAGS) .
 
-
-ifeq ($(OS),Windows_NT)
 ## install: installs awl
+ifeq ($(OS),Windows_NT)
 install:
 	$(GO) install $(GOFLAGS) .
 else

README.md

@@ -24,17 +24,21 @@ newer RFC query types, such as DNS-over-HTTPS and DNS-over-QUIC.
 Grab a prebuilt binary from the
 [release](https://git.froth.zone/sam/awl/releases) section.
 
+### Package Managers
+
+- AUR: [awl-dns-git](https://aur.archlinux.org/packages/awl-dns-git)
+
 ### From source
 
 Dependencies:
 
 - Go >= 1.18
-- GNU/BSD make or Plan 9 mk
+- GNU/BSD make or Plan 9 mk (if using the makefile/mkfile)
 
-Make sure to recursively clone the repo:
+Using `go install` (recommended):
 
 ```sh
-git clone --recursive https://git.froth.zone/sam/awl
+go install git.froth.zone/sam/awl@latest
 ```
 
 Using the makefile:
@@ -44,12 +48,6 @@ make
 sudo make install
 ```
 
-Alternatively, using `go install`:
-
-```sh
-go install git.froth.zone/sam/awl@latest
-```
-
 ## Contributing
 
 Send a [pull request](https://git.froth.zone/sam/awl/pulls) our way. Prefer

cli/misc.go

@@ -16,8 +16,6 @@ import (
 // ParseMiscArgs parses the wildcard arguments, drill style.
 // Only one command is supported at a time, so any extra information overrides previous.
 func ParseMiscArgs(args []string, opts *util.Options) error {
-	var err error
-
 	for _, arg := range args {
 		r, ok := dns.StringToType[strings.ToUpper(arg)]
 
@@ -31,15 +29,15 @@ func ParseMiscArgs(args []string, opts *util.Options) error {
 			switch {
 			case strings.HasPrefix(arg, "tls://"):
 				opts.TLS = true
-				opts.Request.Server = arg[6:]
+				opts.Request.Server = strings.TrimPrefix(opts.Request.Server, "tls://")
 				opts.Logger.Info("DNS-over-TLS implicitly set")
 			case strings.HasPrefix(arg, "https://"):
 				opts.HTTPS = true
 				opts.Request.Server = arg
 				opts.Logger.Info("DNS-over-HTTPS implicitly set")
 			case strings.HasPrefix(arg, "quic://"):
 				opts.QUIC = true
-				opts.Request.Server = arg[7:]
+				opts.Request.Server = strings.TrimPrefix(opts.Request.Server, "quic://")
 				opts.Logger.Info("DNS-over-QUIC implicitly set.")
 			case strings.HasPrefix(arg, "sdns://"):
 				opts.DNSCrypt = true
@@ -52,14 +50,15 @@ func ParseMiscArgs(args []string, opts *util.Options) error {
 		// Dig-style +queries
 		case strings.HasPrefix(arg, "+"):
 			opts.Logger.Info(arg, "detected as a dig query")
-			err = ParseDig(strings.ToLower(arg[1:]), opts)
 
-			if err != nil {
+			if err := ParseDig(strings.ToLower(arg[1:]), opts); err != nil {
 				return err
 			}
 
 		// Domain names
 		case strings.Contains(arg, "."):
+			var err error
+
 			opts.Logger.Info(arg, "detected as a domain name")
 			opts.Request.Name, err = idna.ToASCII(arg)
 
@@ -74,6 +73,8 @@ func ParseMiscArgs(args []string, opts *util.Options) error {
 
 		// Domain?
 		default:
+			var err error
+
 			opts.Logger.Info(arg, "is unknown. Assuming domain")
 			opts.Request.Name, err = idna.ToASCII(arg)
 
@@ -89,16 +90,14 @@ func ParseMiscArgs(args []string, opts *util.Options) error {
 		opts.Request.Name = "."
 
 		if opts.Request.Type == 0 {
+			opts.Logger.Info("Query not specified, making an \"NS\" query")
 			opts.Request.Type = dns.StringToType["NS"]
 		}
-	} else {
+	} else if opts.Request.Type == 0 {
 		opts.Logger.Info("Query not specified, making an \"A\" query")
-
-		if opts.Request.Type == 0 {
-			opts.Request.Type = dns.StringToType["A"]
-		}
+		opts.Request.Type = dns.StringToType["A"]
 	}
-	//
+
 	if opts.Request.Server == "" {
 		opts.Logger.Info("Server not specified, selecting a default")
 		// Set "defaults" for each if there is no input
@@ -113,7 +112,7 @@ func ParseMiscArgs(args []string, opts *util.Options) error {
 		case opts.QUIC:
 			opts.Request.Server = "dns.adguard.com"
 		default:
-			//nolint:govet // This shadow is intentional
+			var err error
 			resolv, err := conf.GetDNSConfig()
 
 			if err != nil {
@@ -150,8 +149,10 @@ func ParseMiscArgs(args []string, opts *util.Options) error {
 
 	opts.Logger.Info("DNS server set to", opts.Request.Server)
 
-	// Make reverse adresses proper addresses
+	// Make reverse addresses proper addresses
 	if opts.Reverse {
+		var err error
+
 		opts.Logger.Info("Making reverse DNS query proper *.arpa domain")
 
 		if dns.TypeToString[opts.Request.Type] == "A" {
@@ -168,7 +169,7 @@ func ParseMiscArgs(args []string, opts *util.Options) error {
 	if !strings.HasSuffix(opts.Request.Name, ".") {
 		opts.Request.Name = fmt.Sprintf("%s.", opts.Request.Name)
 
-		opts.Logger.Debug("Domain made canonical")
+		opts.Logger.Info("Domain made canonical")
 	}
 
 	return nil

conf/plan9.go

@@ -1,20 +1,30 @@
 // SPDX-License-Identifier: BSD-3-Clause
+//go:build plan9
 
 package conf
 
 import (
 	"errors"
+	"fmt"
+	"os"
 	"strings"
 
 	"github.com/miekg/dns"
 )
 
-// GetPlan9Config gets DNS information from Plan 9, because it's different from UNIX and Windows.
+// GetDNSConfig gets DNS information from Plan 9, because it's different from UNIX and Windows.
 // Plan 9 stores its network data in /net/ndb, which seems to be formatted a specific way
 // Yoink it and use it.
 //
 // See ndb(7).
-func GetPlan9Config(str string) (*dns.ClientConfig, error) {
+func GetDNSConfig() (*dns.ClientConfig, error) {
+	dat, err := os.ReadFile("/net/ndb")
+	if err != nil {
+		return nil, fmt.Errorf("read ndb: %w", err)
+	}
+
+	str := string(dat)
+
 	str = strings.ReplaceAll(str, "\n", "")
 	spl := strings.FieldsFunc(str, splitChars)
 

conf/plan9_test.go

@@ -1,4 +1,5 @@
 // SPDX-License-Identifier: BSD-3-Clause
+//go:build plan9
 
 package conf_test
 
@@ -11,6 +12,9 @@ import (
 
 func TestGetPlan9Config(t *testing.T) {
 	t.Parallel()
+	if runtime.GOOS != "plan9" {
+		t.Skip("Not running Plan 9, skipping")
+	}
 
 	ndbs := []struct {
 		in   string

conf/unix.go

@@ -1,31 +1,22 @@
 // SPDX-License-Identifier: BSD-3-Clause
-//go:build !windows
+//go:build unix || (!windows && !plan9 && !js && !zos)
+
+// FIXME: Can remove the or on the preprocessor when Go 1.18 becomes obsolete
 
 package conf
 
 import (
 	"fmt"
-	"os"
-	"runtime"
 
 	"github.com/miekg/dns"
 )
 
 // GetDNSConfig gets the DNS configuration, either from /etc/resolv.conf or somewhere else.
 func GetDNSConfig() (*dns.ClientConfig, error) {
-	if runtime.GOOS == "plan9" {
-		dat, err := os.ReadFile("/net/ndb")
-		if err != nil {
-			return nil, fmt.Errorf("plan9 ndb: %w", err)
-		}
-
-		return GetPlan9Config(string(dat))
-	} else {
-		conf, err := dns.ClientConfigFromFile("/etc/resolv.conf")
-		if err != nil {
-			return nil, fmt.Errorf("unix config: %w", err)
-		}
-
-		return conf, nil
+	conf, err := dns.ClientConfigFromFile("/etc/resolv.conf")
+	if err != nil {
+		return nil, fmt.Errorf("unix config: %w", err)
 	}
+
+	return conf, nil
 }

conf/unix_test.go

@@ -1,5 +1,7 @@
 // SPDX-License-Identifier: BSD-3-Clause
-//go:build !windows
+//go:build unix || (!windows && !plan9 && !js && !zos)
+
+// FIXME: Can remove the or on the preprocessor when Go 1.18 becomes obsolete
 
 package conf_test
 
@@ -12,8 +14,8 @@ import (
 )
 
 func TestNonWinConfig(t *testing.T) {
-	if runtime.GOOS == "windows" {
-		t.Skip("Running Windows, skipping")
+	if runtime.GOOS == "windows" || runtime.GOOS == "plan9" {
+		t.Skip("Not running Unix-like, skipping")
 	}
 
 	conf, err := conf.GetDNSConfig()

conf/win_test.go

@@ -12,6 +12,8 @@ import (
 )
 
 func TestWinConfig(t *testing.T) {
+	t.Parallel()
+
 	if runtime.GOOS != "windows" {
 		t.Skip("Not running Windows, skipping")
 	}

go.mod

@@ -20,20 +20,17 @@ require (
 	github.com/ameshkov/dnsstamps v1.0.3 // indirect
 	github.com/golang/mock v1.6.0 // indirect
 	github.com/google/go-cmp v0.5.8 // indirect
+	github.com/kr/pretty v0.3.0 // indirect
 	github.com/marten-seemann/qtls-go1-19 v0.1.0 // indirect
-	golang.org/x/exp v0.0.0-20220722155223-a9213eeb770e // indirect
+	golang.org/x/exp v0.0.0-20220827204233-334a2380cb91 // indirect
 )
 
 require (
-	github.com/cheekybits/genny v1.0.0 // indirect
 	github.com/fsnotify/fsnotify v1.5.4 // indirect
 	github.com/go-task/slim-sprig v0.0.0-20210107165309-348f09dbbbc0 // indirect
-	github.com/marten-seemann/qtls-go1-16 v0.1.5 // indirect
-	github.com/marten-seemann/qtls-go1-17 v0.1.2 // indirect
 	github.com/marten-seemann/qtls-go1-18 v0.1.2 // indirect
 	github.com/nxadm/tail v1.4.8 // indirect
 	github.com/onsi/ginkgo v1.16.5 // indirect
-	github.com/stretchr/testify v1.8.0 // indirect
 	golang.org/x/crypto v0.0.0-20220826181053-bd7e27e6170d // indirect
 	golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 // indirect
 	golang.org/x/sys v0.0.0-20220829200755-d48e67d00261