From 3fe11385535c8e0cfbb9bee58205ff801415a743 Mon Sep 17 00:00:00 2001 From: Sam Therapy Date: Fri, 2 Sep 2022 01:14:41 +0200 Subject: [PATCH] Completions and documentation Signed-off-by: Sam Therapy --- .github/workflows/ghrelease.yaml | 5 + .github/workflows/test.yaml | 2 +- .gitmodules | 3 + .golangci.yaml | 15 +-- GNUmakefile | 10 +- Makefile | 9 +- README.md | 2 +- cli/cli.go | 6 +- cli/dig.go | 2 +- cli/docs.go | 2 + cli/misc.go | 4 +- completions/zsh.zsh | 88 +++++++++++++ conf/docs.go | 2 + doc/awl.1.scd | 217 +++++++++++++++++++------------ doc/wiki | 2 +- docs.go | 2 + logawl/docs.go | 2 + logawl/logawl.go | 8 +- mkfile | 26 ++-- pkg/awl-dns-git | 1 + query/docs.go | 2 + query/query.go | 4 +- query/struct.go | 4 - template.mk | 25 +++- util/docs.go | 2 + 25 files changed, 309 insertions(+), 136 deletions(-) create mode 100644 completions/zsh.zsh create mode 160000 pkg/awl-dns-git diff --git a/.github/workflows/ghrelease.yaml b/.github/workflows/ghrelease.yaml index ba6a128..93e3e63 100644 --- a/.github/workflows/ghrelease.yaml +++ b/.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: diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index c2f1a04..f5b5c6b 100644 --- a/.github/workflows/test.yaml +++ b/.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 diff --git a/.gitmodules b/.gitmodules index 1b94379..964b727 100644 --- a/.gitmodules +++ b/.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 diff --git a/.golangci.yaml b/.golangci.yaml index c95c5a7..aa68c77 100644 --- a/.golangci.yaml +++ b/.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: diff --git a/GNUmakefile b/GNUmakefile index 7d8e21a..a5ab92d 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -1,4 +1,5 @@ # SPDX-License-Identifier: BSD-3-Clause +# GNU Makefile allowing for building on Windows (with GNU Make) include template.mk @@ -6,13 +7,10 @@ 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) . @@ -20,6 +18,6 @@ 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)/usr/$(SHARE)/zsh/site-functions/_$(PROG) endif - -.PHONY: install \ No newline at end of file diff --git a/Makefile b/Makefile index 1ce08b1..3c805e1 100644 --- a/Makefile +++ b/Makefile @@ -3,12 +3,11 @@ include template.mk -$(PROG): $(SOURCES) - $(GO) build -o $(PROG) $(GOFLAGS) . +EXE := $(PROG) -## install: installs awl and the manpage, RUN AS ROOT +## install: installs awl install: all install -Dm755 $(PROG) $(DESTDIR)$(PREFIX)/$(BIN)/$(PROG) install -Dm644 doc/$(PROG).1 $(DESTDIR)$(MAN)/man1/$(PROG).1 - -.PHONY: install \ No newline at end of file +# completions need to go in one specific place :) + install -Dm644 completions/zsh.zsh $(DESTDIR)/usr/$(SHARE)/zsh/site-functions/_$(PROG) \ No newline at end of file diff --git a/README.md b/README.md index e1a29d5..ad5370c 100644 --- a/README.md +++ b/README.md @@ -59,4 +59,4 @@ Found a bug or want a new feature? Create an issue ### Licence -See [LICENCE](./LICENCE) +Revised BSD, See [LICENCE](./LICENCE) diff --git a/cli/cli.go b/cli/cli.go index cd98ecf..2e176f2 100644 --- a/cli/cli.go +++ b/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") diff --git a/cli/dig.go b/cli/dig.go index 62b0986..59f49c0 100644 --- a/cli/dig.go +++ b/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: diff --git a/cli/docs.go b/cli/docs.go index d943551..8ce2a0c 100644 --- a/cli/docs.go +++ b/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. diff --git a/cli/misc.go b/cli/misc.go index aab9cfd..219c3f5 100644 --- a/cli/misc.go +++ b/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: diff --git a/completions/zsh.zsh b/completions/zsh.zsh new file mode 100644 index 0000000..6c76b80 --- /dev/null +++ b/completions/zsh.zsh @@ -0,0 +1,88 @@ +#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,}'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[display help information]' \ + '(- *)-V[display version information]' \ + '-v=+[set verbosity]:verbosity:compadd -M "m\:{\-1-3}={\-1-3}" - \-1 0 1 2 3' \ + '*-'{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' \ + '*--tls-no-verify[disable TLS verification]' \ + '*--tls-host+[set TLS lookup hostname]:host:_hosts' \ + '*-'{-,}'4[force IPv4 only]' \ + '*-'{-,}'6[force IPv6 only]' \ + '*-x+[reverse lookup]:IP address' \ + '*: :->args' && ret=0 + # '*--timeout+[timeout in seconds]:number [1]' \ + # '*--retry+[number of tries before failing]:number [2]' \ + +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 \ No newline at end of file diff --git a/conf/docs.go b/conf/docs.go index cae2ac7..22fd5e0 100644 --- a/conf/docs.go +++ b/conf/docs.go @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: BSD-3-Clause + /* Package conf contains helper functions for getting local nameservers diff --git a/doc/awl.1.scd b/doc/awl.1.scd index 51cb2d3..7cbd698 100644 --- a/doc/awl.1.scd +++ b/doc/awl.1.scd @@ -1,4 +1,5 @@ awl(1) +; SPDX-License-Identifier: BSD-3-Clause # NAME @@ -6,157 +7,207 @@ awl - DNS lookup tool # SYNOPSIS -_awl_ [ _OPTIONS_ ] _name_ [ _@server_ ] [ _type_ ], where +*awl* [ _OPTIONS_ ] _name_ [ _@server_ ] [ _type_ ], where -_name_ is the query to make (_example: froth.zone_)++ -_@server_ is the server to query (_example: dns.froth.zone_)++ -_type_ is the DNS resource type (_example: AAAA_) +_name_ is the query to make (example: froth.zone)++ +_@server_ is the server to query (example: dns.froth.zone)++ +_type_ is the DNS resource type (example: AAAA) # DESCRIPTION -_awl_ (*a*wls *w*ant *l*icorice) is a simple tool designed to make DNS queries, -much like the venerable _dig_(1). An awl is a tool used to make small holes, +*awl* (*a*wls *w*ant *l*icorice) is a simple tool designed to make DNS queries, +much like the venerable *dig*(1). An awl is a tool used to make small holes, typically used in leatherworking. -_awl_ is designed to be a more "modern" version of _drill_(1) by including -some more recent RFCs and output options. _awl_ is still heavily -Work-In-Progress so some features may get added or removed. +*awl* is designed to be a more "modern" version of *drill*(1) by including +some more recent RFCs and output options. + +When no arguments are given, *awl* will perform an _NS_ query on the root ('_._'). + +When a nameserver is not given, *awl* will query a random system nameserver. +If one cannot be found, *awl* will query localhost. # OPTIONS -Dig-like +[no]flags are supported, see dig(1) +Anything in [brackets] is optional. -_-D_, _--dnssec_, _+dnssec_ +*-D*, *--dnssec*, *+dnssec* Enable DNSSEC. This needs to be manually enabled. -_-v_ _value_ - Set verbosity (currently WIP) +*-v*[=_int_] + Set verbosity + Accepted values are as follows: + - _0_: Only log errors. + - _1_: Log warnings. *This is the default.* + - _2_: Log information *Default when specifying just* _-v_. + - _3_: Log information useful for debugging. + Setting a value lower than 0 disables logging entirely. -_-V_ +*-V* Print the version and exit. -_-h_ +*-h* Show a "short" help message. ## Query Options -_-4_ +*-4* Only make query over IPv4 -_-6_ +*-6* Only make query over IPv6 -_-p_, _--port_ _port_ +*-p*, *--port* *port* Sets the port to query. Default ports listed below. - - - _53_ for _UDP_ and _TCP_ - - _853_ for _TLS_ and _QUIC_ - - _443_ for _HTTPS_ + - _53_ for *UDP* and *TCP* + - _853_ for *TLS* and *QUIC* + - _443_ for *HTTPS* -_-q_, _--query_ _domain_ +*-q*, *--query* _domain_ Domain to query (eg. example.com) -_-c_, _--class_ _class_ +*-c*, *--class* _class_ DNS class to query (eg. IN, CH) + The default is IN. -_-t_, _--qType_ _type_ - DNS type to query (eg. A, NS) +*-t*, *--qType* _type_ + DNS type to query (eg. A, AAAA, NS) + The default is A. -_--no-truncate_, _+ignore_ - Ignore UDP truncation (by default, awl _retries with TCP_) +*--no-truncate*, *+ignore* + Ignore UDP truncation (by default, awl *retries with TCP*). -_--tcp_, _+tcp_, _+vc_ - Use TCP for the query (see _RFC 7766_) +*--tcp*, *+tcp*, *+vc* + Use TCP for the query (see *RFC 7766*). -_--dnscrypt_, _+dnscrypt_ - Use DNSCrypt +*--dnscrypt*, *+dnscrypt* + Use DNSCrypt. -_-T_, _--tls_, _+tls_ - Use DNS-over-TLS, implies _--tcp_ (see _RFC 7858_) +*-T*, *--tls*, *+tls* + Use DNS-over-TLS, implies _--tcp_ (see *RFC 7858*) -_--tls-host_ _string_ +*--tls-host* _string_ Set hostname to use for TLS certificate validation. Default is the name of the domain when querying over TLS, and empty for IPs. -_--tls-no-verify_ +*--tls-no-verify* Ignore TLS validation when performing a DNS query. -_-H_. _--https_, _+https_ - Use DNS-over-HTTPS (see _RFC 8484_) +*-H*. *--https*, *+https* + Use DNS-over-HTTPS (see *RFC 8484*). -_-Q_. _--quic_, _+quic_ - Use DNS-over-QUIC (see _RFC 9250_) +*-Q*. *--quic*, *+quic* + Use DNS-over-QUIC (see *RFC 9250*). -_-x_, _--reverse_ - Do a reverse lookup. Sets default _type_ to PTR.++ -_awl_ automatically makes an IP or phone number canonical. +*-x*, *--reverse* + Do a reverse lookup. Sets default *type* to PTR. + *awl* automatically makes an IP or phone number canonical. -_--timeout_ _seconds_, _+timeout=__seconds_ - Set the timeout period. Floating point numbers are accepted.++ -0.5 seconds is the minimum. +*--timeout* _seconds_, *+timeout*=_seconds_ + Set the timeout period. Floating point numbers are accepted. + 0.5 seconds is the minimum. -_--retries_ _int_, _+tries_=_int_, _+ retry_=_int_ +*--retries* _int_, *+tries*=_int_, *+retry*=_int_ Set the number of retries. - Retry is one more than tries, dig style + Retry is one more than tries, dig style. ## DNS Flags -_--aa=[false]_, _+[no]aaflag_ - (Set, Unset) AA (Authoritative Answer) flag +*--aa*=[_false_], *+[no]aaflag* + (Set, Unset) AA (Authoritative Answer) flag. -_--ad=[false]_, _+[no]adflag_ - (Set, Unset) AD (Authenticated Data) flag +*--ad*=[_false_], *+[no]adflag* + (Set, Unset) AD (Authenticated Data) flag. -_--tc=[false]_, _+[no]tcflag_ +*--tc*=[_false_], *+[no]tcflag* (Set, Unset) TC (TrunCated) flag -_-z=[false]_, _+[no]zflag_ - (Set, Unset) Z (Zero) flag +*-z*=[_false_], *+[no]zflag* + (Set, Unset) Z (Zero) flag. -_--cd=[false]_, _+[no]cdflag_ - (Set, Unset) CD (Checking Disabled) flag +*--cd*=[_false_], *+[no]cdflag* + (Set, Unset) CD (Checking Disabled) flag. -_--qr=[false]_, _+[no]qrflag_ - (Set, Unset) QR (QueRy) flag +*--qr*=[_false_], *+[no]qrflag* + (Set, Unset) QR (QueRy) flag. -_--rd=[true]_, _+[no]rdflag_ - (Set, Unset) RD (Recursion Desired) flag +*--rd*=[_true_], *+[no]rdflag* + (Set, Unset) RD (Recursion Desired) flag. -_--ra=[false]_, _+[no]raflag_ - (Set, Unset) RA (Recursion Available) flag +*--ra*=[_false_], *+[no]raflag* + (Set, Unset) RA (Recursion Available) flag. + +## EDNS +All of these options except disabling EDNS imply _+edns_. + +*--no-edns*, *+noedns* + Disable EDNS. + +*--edns-ver*, *+edns*[=_int_] + Enable EDNS and set EDNS version. + The maximum value is 255, and the minimum (default) value is 0. + +*--expire*. *+[no]expire* + Send an EDNS Expire. + +*--nsid*, *+[no]nsid* + Send an EDNS name server ID request. + +*--no-cookie*, *+[no]cookie*[=_string_] + Send an EDNS cookie. + This is enabled by default with a random string. + +*--keep-alive*, *+[no]keepalive*, *+[no]keepopen* + Send an EDNS keep-alive. + This does nothing unless using TCP. + +*--buffer-size* _int_, *+bufize*=_int_ + Set the UDP message buffer size, using EDNS. + Max is 65535, minimum is zero. + The default value is 1232. + +*--zflag* _int_, *+ednsflags*=_int_ + Set the must-be-zero EDNS flags. + Decimal, hexadecimal and octal are supported. + Trying to set DO will be ignored. + +*--subnet* _ip_[_/prefix_], *+[no]subnet*=_ip_[_/prefix_] + Send an EDNS Client Subnet option with the specified address.++ +++ +Like *dig*(1), setting the IP to _0.0.0.0/0_, _::/0_ or _0_ will signal the resolver to not use any client information when returning the query. ## Output Display -_--no-question_, _+noquestion_ - Do not display the Question section +*--no-question*, *+[no]question* + Toggle the display of the Question section. -_--no-answer_, _+noanswer_ - Do not display the Answer section +*--no-answer*, *+[no]answer* + Toggle the display of the Answer section. -_--no-answer_, _+noanswer_ - Do not display the Answer section +*--no-answer*, *+[no]answer* + Toggle the display of the Answer section. -_--no-authority_, _+noauthority_ - Do not display the Authority section +*--no-authority*, *+[no]authority* + Toggle the display of the Authority section. -_--no-additional_, _+noadditional_ - Do not display the Additional section +*--no-additional*, *+[no]additional* + Toggle the display of the Additional section. -_--no-statistics_, _+nostats_ - Do not display the Statistics (additional comments) section +*--no-statistics*, *+[no]stats* + Toggle the display of the Statistics (additional comments) section. ## Output Formats -_-j_, _--json_, _+json_ +*-j*, *--json*, *+json* Print the query results as JSON. -_-X_, _--xml_, _+xml_ +*-X*, *--xml*, *+xml* Print the query results as XML. -_-y_, _--yaml_, _+yaml_ +*-y*, *--yaml*, *+yaml* Print the query results as YAML. -_-s_, _--short_, _+short_ +*-s*, *--short*, *+short* Print just the address of the answer. # EXAMPLES @@ -182,4 +233,10 @@ Query dns.google over TLS for the PTR record to the IP address 8.8.4.4 # SEE ALSO -_drill_(1), _dig_(1), the many DNS RFCs +*drill*(1), *dig*(1), the many DNS RFCs +(https://www.statdns.com/rfc/) + +# BUGS + +Likely numerous, report them either to https://git.froth.zone/sam/awl/issues +or via email ~sammefishe/awl-dev@lists.sr.ht diff --git a/doc/wiki b/doc/wiki index d25a7f1..4974d31 160000 --- a/doc/wiki +++ b/doc/wiki @@ -1 +1 @@ -Subproject commit d25a7f13273737938d5e1e08c7332d39fffadc6b +Subproject commit 4974d316fc3be3c28b54af5188860f8cfb2bdd6b diff --git a/docs.go b/docs.go index f868989..392d1d7 100644 --- a/docs.go +++ b/docs.go @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: BSD-3-Clause + /* awl is a DNS lookup tool written in Go, similar to (and heavily inspired by) drill. diff --git a/logawl/docs.go b/logawl/docs.go index f1caa3b..fa0d5f9 100644 --- a/logawl/docs.go +++ b/logawl/docs.go @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: BSD-3-Clause + /* Package logawl is a package for custom logging needs diff --git a/logawl/logawl.go b/logawl/logawl.go index 30ff143..ee5032b 100644 --- a/logawl/logawl.go +++ b/logawl/logawl.go @@ -42,13 +42,13 @@ func (l *Logger) level() Level { // UnMarshalLevel unmarshalls the int value of level for writing the header. func (l *Logger) UnMarshalLevel(lv Level) (string, error) { switch lv { - case 0: + case ErrLevel: return "ERROR ", nil - case 1: + case WarnLevel: return "WARN ", nil - case 2: + case InfoLevel: return "INFO ", nil - case 3: + case DebugLevel: return "DEBUG ", nil } diff --git a/mkfile b/mkfile index b29b542..4c17538 100644 --- a/mkfile +++ b/mkfile @@ -4,27 +4,31 @@ GO = go PROG = awl +GOFLAGS = -ldflags=-s -ldflags=-w -ldflags=-X=main.version=PLAN9 -trimpath + CGO_ENABLED = 0 -$PROG: - $GO build -ldflags="-s -w -X=main.version=PLAN9" -o $PROG . +all:V: $PROG -install: - $GO install -ldflags="-s -w -X=main.version=PLAN9" . +$PROG: + $GO build $GOFLAGS -o $target . + +install:V: + $GO install $GOFLAGS . cp doc/$PROG.1 /sys/man/1/$PROG -test: - $GO test -cover -coverprofile=coverage/coverage.out ./... +test:V: + $GO test -v -cover ./... -fmt: +fmt:V: gofmt -w -s . -vet: +vet:V: $GO vet ./... -lint: fmt vet +lint:V: fmt vet -clean: +clean:V: $GO clean -nuke: clean +nuke:V: clean diff --git a/pkg/awl-dns-git b/pkg/awl-dns-git new file mode 160000 index 0000000..c8686b1 --- /dev/null +++ b/pkg/awl-dns-git @@ -0,0 +1 @@ +Subproject commit c8686b1e149b6c42db019c77caf36475aafadd03 diff --git a/query/docs.go b/query/docs.go index 5318e7a..d5f654b 100644 --- a/query/docs.go +++ b/query/docs.go @@ -1,2 +1,4 @@ +// SPDX-License-Identifier: BSD-3-Clause + // Package query is for the various query types. package query diff --git a/query/query.go b/query/query.go index 7e75045..673d559 100644 --- a/query/query.go +++ b/query/query.go @@ -74,9 +74,9 @@ func CreateQuery(opts util.Options) (util.Response, error) { opts.Logger.Info("Setting EDNS padding") } - o.SetUDPSize(opts.BufSize) + o.SetUDPSize(opts.EDNS.BufSize) - opts.Logger.Info("EDNS UDP buffer set to", opts.BufSize) + opts.Logger.Info("EDNS UDP buffer set to", opts.EDNS.BufSize) o.SetZ(opts.EDNS.ZFlag) diff --git a/query/struct.go b/query/struct.go index f9a487e..4a64cf8 100644 --- a/query/struct.go +++ b/query/struct.go @@ -12,8 +12,6 @@ import ( ) // Message is for overall DNS responses. -// -//nolint:fieldalignment // IMO this looks better when printed like this type Message struct { Question []Question `json:"question,omitempty" xml:"question,omitempty" yaml:",omitempty"` Answer []Answer `json:"answer,omitempty" xml:"answer,omitempty" yaml:",omitempty"` @@ -39,8 +37,6 @@ type RRHeader struct { } // Answer is for a DNS Response. -// -//nolint:fieldalignment // IMO this looks better when printed like this type Answer struct { Value string `json:"response,omitempty" xml:"response,omitempty" yaml:"response,omitempty"` RRHeader `json:"header,omitempty" xml:"header,omitempty" yaml:"header,omitempty"` diff --git a/template.mk b/template.mk index f029ff7..093bdb2 100644 --- a/template.mk +++ b/template.mk @@ -8,24 +8,34 @@ TEST_SOURCES ?= $(shell find . -name "*_test.go" -type f) CGO_ENABLED ?= 0 GO ?= go -TEST ?= $(GO) test -race +TEST ?= $(GO) test -race -cover COVER ?= $(GO) tool cover -GOFLAGS ?= -ldflags "-s -w -X=main.version=$(HASH)" -trimpath +GOFLAGS ?= -ldflags="-s -w -X=main.version=$(HASH)" -trimpath DESTDIR := PREFIX ?= /usr/local BIN ?= bin +SHARE ?= share SCDOC ?= scdoc -MAN ?= $(PREFIX)/share/man +MAN ?= $(PREFIX)/$(SHARE)/man PROG ?= awl # hehe all: $(PROG) doc/$(PROG).1 +$(PROG): $(SOURCES) + $(GO) build -o $(EXE) $(GOFLAGS) . + doc/$(PROG).1: doc/$(PROG).1.scd - $(SCDOC) doc/$(PROG).1 + $(SCDOC) <$< >$@ + +doc/wiki/$(PROG).1.md: doc/$(PROG).1 + pandoc --from man --to gfm -o $@ $< + +## update_doc: update documentation (requires pandoc) +update_doc: doc/wiki/$(PROG).1.md .PHONY: fmt fmt: @@ -42,8 +52,9 @@ lint: fmt vet ## test: run go test test: $(TEST_SOURCES) - $(TEST) -cover -coverprofile=coverage/coverage.out ./... + $(TEST) -coverprofile=coverage/coverage.out ./... +.PHONY: test-ci test-ci: $(TEST) -v @@ -59,8 +70,8 @@ fuzz: $(TEST_SOURCES) full_test: test fuzz coverage/coverage.out: test - $(COVER) -func=coverage/coverage.out - $(COVER) -html=coverage/coverage.out -o coverage/cover.html + $(COVER) -func=$@ + $(COVER) -html=$@ -o coverage/cover.html ## cover: generates test coverage, output as HTML cover: coverage/coverage.out diff --git a/util/docs.go b/util/docs.go index 58c7fde..174cbd5 100644 --- a/util/docs.go +++ b/util/docs.go @@ -1,2 +1,4 @@ +// SPDX-License-Identifier: BSD-3-Clause + // Package util contains helper functions that don't belong anywhere else package util