(feat)Completions and documentation (#78)

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

Author: SamTherapy

.drone.jsonnet

@@ -9,17 +9,17 @@ local testing(version, arch) = {
   },
   steps: [
     {
-      name: "submodules",
-      image: "alpine/git",
+      name: "compile",
+      image: "golang:" + version,
       commands: [
-        "git submodule update --init --recursive"
-      ]
+        "make awl"
+      ],
     },
     {
       name: "lint",
       image: "rancher/drone-golangci-lint:latest",
       depends_on: [
-        "submodules",
+        "compile",
       ],
     },
     {
@@ -29,7 +29,7 @@ local testing(version, arch) = {
         "make test-ci"
       ],
       depends_on: [
-        "submodules",
+        "lint",
       ],
     },
     {
@@ -39,7 +39,7 @@ local testing(version, arch) = {
         "make fuzz",
       ],
       depends_on: [
-        "submodules",
+        "lint",
       ],
     },
   ],
@@ -68,7 +68,6 @@ local release() = {
       image: "alpine/git",
       commands : [
         "git fetch --tags",
-        "git submodule update --init --recursive"
       ]
     },
     {
@@ -95,9 +94,9 @@ local release() = {
 
 [
   testing("1.19", "amd64"),
-  testing("1.19", "arm64"),
-  testing("1.18", "amd64"),
-  testing("1.18", "arm64"),
+  // testing("1.19", "arm64"),
+  // testing("1.18", "amd64"),
+  // testing("1.18", "arm64"),
 
   release()
 ]

.github/workflows/ghrelease.yaml

@@ -17,6 +17,11 @@ jobs:
       - name: Checkout submodules
         run: git submodule update --init --recursive
 
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
+
       - name: Release with GoReleaser
         uses: goreleaser/goreleaser-action@v3
         with:

.github/workflows/test.yaml

@@ -22,4 +22,4 @@ jobs:
         run: git submodule update --init --recursive
 
       - name: Test
-        run: go test -race -v ./...
+        run: make test-ci

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "doc/wiki"]
 	path = doc/wiki
 	url = ../awl.wiki
+[submodule "pkg/awl-dns-git"]
+	path = pkg/awl-dns-git
+	url = https://aur.archlinux.org/awl-dns-git.git

.golangci.yaml

@@ -32,7 +32,7 @@ linters:
     - predeclared
     - revive
     - staticcheck
-    # - testpackage
+    #- testpackage
     - whitespace
     - wrapcheck
     - wsl
@@ -49,26 +49,25 @@ linters-settings:
     errorCode: 1
     warningCode: 1
     rules:
-      # rules can be uncommented after https://github.com/golangci/golangci-lint/issues/2997 is fixed
       - name: blank-imports
       - name: context-as-argument
-      # - name: context-keys-type
+      - name: context-keys-type
       - name: dot-imports
       - name: duplicated-imports
       - name: error-return
       - name: error-strings
       - name: error-naming
-      # - name: errorf
+      - name: errorf
       - name: exported
       - name: if-return
       - name: increment-decrement
-      # - name: modifies-value-receiver
+      - name: modifies-value-receiver
       - name: package-comments
       - name: range
       - name: receiver-naming
-      # - name: time-naming
-      # - name: unexported-return
-      # - name: var-declaration
+      - name: time-naming
+      - name: unexported-return
+      - name: var-declaration
       - name: var-naming
 
 issues:

GNUmakefile

@@ -1,25 +1,23 @@
 # SPDX-License-Identifier: BSD-3-Clause
+# GNU Makefile allowing for building on Windows (with GNU Make)
 
 include template.mk
 
 ifeq ($(OS),Windows_NT)
 	EXE := $(PROG).exe
 else
 	EXE := $(PROG)
-
 endif
 
-$(PROG): $(SOURCES)
-	$(GO) build -o $(EXE) $(GOFLAGS) .
-
 ## install: installs awl
+.PHONY: install
 ifeq ($(OS),Windows_NT)
 install:
 	$(GO) install $(GOFLAGS) .
 else
 install: all
 	install -Dm755 $(PROG) $(DESTDIR)$(PREFIX)/$(BIN)/$(PROG)
 	install -Dm644 doc/$(PROG).1 $(DESTDIR)$(MAN)/man1/$(PROG).1
+# completions need to go in one specific place :)
+	install -Dm644 completions/zsh.zsh $(DESTDIR)/$(PREFIX)/$(SHARE)/zsh/site-functions/_$(PROG)
 endif
-
-.PHONY: install

Makefile

@@ -3,12 +3,12 @@
 
 include template.mk
 
-$(PROG): $(SOURCES)
-	$(GO) build -o $(PROG) $(GOFLAGS) .
+EXE := $(PROG)
 
-## install: installs awl and the manpage, RUN AS ROOT
+## install: installs awl
+.PHONY: install
 install: all
 	install -Dm755 $(PROG) $(DESTDIR)$(PREFIX)/$(BIN)/$(PROG)
 	install -Dm644 doc/$(PROG).1 $(DESTDIR)$(MAN)/man1/$(PROG).1
-
-.PHONY: install
+# completions need to go in one specific place :)
+	install -Dm644 completions/zsh.zsh $(DESTDIR)/$(PREFIX)/$(SHARE)/zsh/site-functions/_$(PROG)

README.md

@@ -34,6 +34,7 @@ Dependencies:
 
 - Go >= 1.18
 - GNU/BSD make or Plan 9 mk (if using the makefile/mkfile)
+- scdoc (optional, for man page)
 
 Using `go install` (recommended):
 
@@ -45,7 +46,7 @@ Using the makefile:
 
 ```sh
 make
-sudo make install
+make && sudo make install
 ```
 
 ## Contributing
@@ -59,4 +60,4 @@ Found a bug or want a new feature? Create an issue
 
 ### Licence
 
-See [LICENCE](./LICENCE)
+Revised BSD, See [LICENCE](./LICENCE)

cli/cli.go

@@ -35,14 +35,14 @@ func ParseCLI(version string) (util.Options, error) {
 		flag.PrintDefaults()
 	}
 
-	// CLI flag
+	// CLI flags
 	var (
 		port  = flag.Int("port", 0, "`port` to make DNS query (default: 53 for UDP/TCP, 853 for TLS/QUIC)", flag.OptShorthand('p'), flag.OptDisablePrintDefault(true))
 		query = flag.String("query", "", "domain name to `query` (default: .)", flag.OptShorthand('q'))
 		class = flag.String("class", "IN", "DNS `class` to query", flag.OptShorthand('c'))
 		qType = flag.String("qType", "", "`type` to query (default: A)", flag.OptShorthand('t'))
 
-		ipv4    = flag.Bool("4", false, "force IPv4", flag.OptShorthandStr("4"))
+		ipv4    = flag.Bool("4", false, "force IPv4", flag.OptShorthand('4'))
 		ipv6    = flag.Bool("6", false, "force IPv6", flag.OptShorthand('6'))
 		reverse = flag.Bool("reverse", false, "do a reverse lookup", flag.OptShorthand('x'))
 
@@ -57,7 +57,7 @@ func ParseCLI(version string) (util.Options, error) {
 		cookie       = flag.Bool("no-cookie", false, "disable sending EDNS cookie (default: cookie sent)")
 		tcpKeepAlive = flag.Bool("keep-alive", false, "send EDNS TCP keep-alive")
 		udpBufSize   = flag.Uint16("buffer-size", 1232, "set EDNS UDP buffer size", flag.OptShorthand('b'))
-		mbzflag      = flag.String("zflag", "0", "set EDNS z-flag")
+		mbzflag      = flag.String("zflag", "0", "set EDNS z-flag `value`")
 		subnet       = flag.String("subnet", "", "set EDNS subnet")
 		padding      = flag.Bool("pad", false, "set EDNS padding")
 

cli/dig.go

@@ -117,7 +117,7 @@ func ParseDig(arg string, opts *util.Options) error {
 		opts.Display.Authority = isNo
 		opts.Display.Additional = isNo
 		opts.Display.Statistics = isNo
-	case "idnout":
+	case "idnin", "idnout":
 		opts.Display.UcodeTranslate = isNo
 
 	default:

cli/docs.go

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: BSD-3-Clause
+
 /*
 Package cli is the CLI part of the package, including both POSIX
 flag parsing and dig-like flag parsing.

cli/misc.go

@@ -117,8 +117,8 @@ func ParseMiscArgs(args []string, opts *util.Options) error {
 
 			if err != nil {
 				// :^)
-				opts.Logger.Warn("Could not query system for server. Using default")
-				opts.Request.Server = "95.216.99.249"
+				opts.Logger.Warn("Could not query system for server. Using localhost")
+				opts.Request.Server = "127.0.0.1"
 			} else {
 				// Make sure that if IPv4 or IPv6 is asked for it actually uses it
 			harmful:

completions/zsh.zsh

@@ -0,0 +1,110 @@
+#compdef awl
+# SPDX-License-Identifier: BSD-3-Clause
+
+local curcontext="$curcontext" state line expl
+local -a alts args
+[[ -prefix + ]] && args=(
+  '*+'{no,}'tcp[use TCP instead of UDP for queries]'
+  '*+'{no,}'ignore[ignore truncation in UDP responses]'
+  '*+'{no,}'tls[use DNS-over-TLS for queries]'
+  '*+'{no,}'dnscrypt[use DNSCrypt for queries]'
+  '*+'{no,}'https[use DNS-over-HTTPS for queries]'
+  '*+'{no,}'quic[use DNS-over-QUIC for queries]'
+  '*+'{no,}'aaonly[set aa flag in the query]'
+  '*+'{no,}'additional[print additional section of a reply]'
+  '*+'{no,}'adflag[set the AD (authentic data) bit in the query]'
+  '*+'{no,}'cdflag[set the CD (checking disabled) bit in the query]'
+  '*+'{no,}'cookie[add a COOKIE option to the request]'
+  '*+edns=[specify EDNS version for query]:version (0-255)'
+  '*+noedns[clear EDNS version to be sent]'
+  '*+ednsflags=[set EDNS flags bits]:flags'
+  # '*+ednsopt=[specify EDNS option]:code point'
+  '*+noedns[clear EDNS options to be sent]'
+  '*+'{no,}'expire[send an EDNS Expire option]'
+  # '*+'{no,}'idnin[set processing of IDN domain names on input]'
+  '*+'{no,}'idnout[set conversion of IDN puny code on output]'
+  '*+'{no,}'keepalive[request EDNS TCP keepalive]'
+  '*+'{no,}'keepopen[keep TCP socket open between queries]'
+  '*+'{no,}'recurse[set the RD (recursion desired) bit in the query]'
+  # '*+'{no,}'nssearch[search all authoritative nameservers]'
+  # '*+'{no,}'trace[trace delegation down from root]'
+  # '*+'{no,}'cmd[print initial comment in output]'
+  '*+'{no,}'short[print terse output]'
+  '*+'{no,}'identify[print IP and port of responder]'
+  '*+'{no,}'comments[print comment lines in output]'
+  '*+'{no,}'stats[print statistics]'
+  '*+padding[set padding block size]:size [0]'
+  '*+'{no,}'qr[print query as it was sent]'
+  '*+'{no,}'question[print question section of a query]'
+  '*+'{no,}'raflag[set RA flag in the query]'
+  '*+'{no,}'answer[print answer section of a reply]'
+  '*+'{no,}'authority[print authority section of a reply]'
+  '*+'{no,}'all[set all print/display flags]'
+  '*+'{no,}'subnet=[send EDNS client subnet option]:addr/prefix-length'
+  '*+'{no,}'tcflag[set TC flag in the query]'
+  '*+time=[set query timeout]:timeout (seconds) [1]'
+  '*+timeout=[set query timeout]:timeout (seconds) [1]'
+  '*+tries=[specify number of UDP query attempts]:tries [3]'
+  '*+retry=[specify number of UDP query retries]:retries [2]'
+  # '*+'{no,}'rrcomments[set display of per-record comments]'
+  # '*+ndots=[specify number of dots to be considered absolute]:dots'
+  '*+bufsize=[specify UDP buffer size]:size (bytes)'
+  '*+'{no,}'dnssec[enable DNSSEC]'
+  '*+'{no,}'nsid[include EDNS name server ID request in query]'
+  '*+'{no,}'class[display the class whening printing the answer]'
+  '*+'{no,}'ttlid[display the TTL whening printing the record]'
+  '*+'{no,}'ttlunits[display the TTL in human-readable units]'
+  # '*+'{no,}'unknownformat[print RDATA in RFC 3597 "unknown" format]'
+  '*+'{no,}'json[present the results as JSON]'
+  '*+'{no,}'xml[present the results as XML]'
+  '*+'{no,}'yaml[present the results as YAML]'
+  '*+'{no,}'zflag[set Z flag in query]'
+)
+# TODO: Add the regular (POSIX/GNU) flags
+_arguments -s -C $args \
+  '(- *)-'{h,-help}'[display help information]' \
+  '(- *)-'{V,-version}'[display version information]' \
+  '-'{v,-verbosity}'=+[set verbosity to custom level]:verbosity:compadd -M "m\:{\-1-3}={\-1-3}" - \-1 0 1 2 3' \
+  '-'{v,-verbosity}'+[set verbosity to info]' \
+  '*-'{p,-port}'+[specify port number]:port:_ports' \
+  '*-'{q,-query}'+[specify host name to query]:host:_hosts' \
+  '*-'{c,-class}'+[specify class]:class:compadd -M "m\:{a-z}={A-Z}" - IN CS CH HS' \
+  '*-'{t,-qType}'+[specify type]:type:_dns_types' \
+  '*-4+[force IPv4 only]' \
+  '*-6+[force IPv6 only]' \
+  '*-'{x,-reverse}'+[reverse lookup]' \
+  '*--timeout+[timeout in seconds]:number [1]' \
+  '*--retry+[specify number of UDP query retries]:number [2]' \
+  '*--no-edns+[disable EDNS]' \
+  '*--edns-ver+[specify EDNS version for query]:version (0-255) [0]' \
+  '*-'{D,-dnssec}'+[enable DNSSEC]' \
+  '*--expire+[send EDNS expire]' \
+  '*-'{n,-nsid}'+[include EDNS name server ID request in query]' \
+  '*--no-cookie+[disable sending EDNS cookie]' \
+  '*--keep-alive+[request EDNS TCP keepalive]' \
+  '*-'{b,-buffer-size}'+[specify UDP buffer size]:size (bytes) [1232]' \
+  '*--zflag+[set EDNS z-flag]:decimal, hex or octal [0]' \
+  '*--subnet+[set EDNS client subnet]:addr/prefix-length' \
+  '*--no-truncate+[ignore truncation in UDP responses]' \
+  '*--tcp+[use TCP instead of UDP for queries]' \
+  '*--dnscrypt+[use DNSCrypt for queries]' \
+  '*-'{T,-tls}'+[use DNS-over-TLS for queries]' \
+  '*-'{H,-https}'+[use DNS-over-HTTPS for queries]' \
+  '*-'{Q,-quic}'+[use DNS-over-QUIC for queries]' \
+  '*--tls-no-verify+[disable TLS verification]' \
+  '*--tls-host+[set TLS lookup hostname]:host:_hosts' \
+  '*-'{s,-short}'+[print terse output]' \
+  '*-'{j,-json}'+[present the results as JSON]' \
+  '*-'{x,-xml}'+[present the results as XML]' \
+  '*-'{y,-yaml}'+[present the results as YAML]' \
+  '*: :->args' && ret=0
+
+if [[ -n $state ]]; then
+  if compset -P @; then
+    _wanted hosts expl 'DNS server' _hosts && ret=0;
+  else
+    _alternative 'hosts:host:_hosts' 'types:query type:_dns_types' && ret=0
+  fi
+fi
+
+return ret

conf/docs.go

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: BSD-3-Clause
+
 /*
 Package conf contains helper functions for getting local nameservers