ooni-probe-cli/internal/tutorial/netxlite/chapter05
Simone Basso 8a0c062844
feat: clearly indicate which resolver we're using (#885)
See what we documented at https://github.com/ooni/spec/pull/257

Reference issue: https://github.com/ooni/probe/issues/2238

See also the related ooni/spec PR: https://github.com/ooni/spec/pull/257

See also https://github.com/ooni/probe/issues/2237

While there, bump webconnectivity@v0.5 version because this change
has an impact onto the generated data format.

The drop in coverage is unavoidable because we've written some
tests for `measurex` to ensure we deal with DNS resolvers and transport
names correctly depending on the splitting policy we use.

(However, `measurex` is only used for the `tor` experiment and, per
the step-by-step design document, new experiments should use
`measurexlite` instead, so this is hopefully fine(TM).)

While there, fix a broken integration test that does not run in `-short` mode.
2022-08-27 15:47:48 +02:00
..
main.go feat: clearly indicate which resolver we're using (#885) 2022-08-27 15:47:48 +02:00
README.md feat: clearly indicate which resolver we're using (#885) 2022-08-27 15:47:48 +02:00

Chapter I: Using the "stdlib" DNS resolver

In this chapter we will write together a main.go file that uses the "stdlib" DNS resolver to lookup domain names.

The "stdlib" resolver is getaddrinfo on Unix. If we're compiled with CGO_ENABLED=1, we use the getaddrinfo stdlib call directly. Otherwise, we use the net.Resolver resolver, which may or may not use getaddrinfo (or equivalent stdlib calls) under the hood.

(This file is auto-generated from the corresponding source file, so make sure you don't edit it manually.)

The main.go file

We define main.go file using package main.

package main

import (
	"context"
	"errors"
	"flag"
	"os"
	"time"

	"github.com/apex/log"
	"github.com/ooni/probe-cli/v3/internal/netxlite"
)

func main() {

The beginning of the program is equal to the previous chapters, so there is not much to say about it.

	log.SetLevel(log.DebugLevel)
	hostname := flag.String("hostname", "dns.google", "Hostname to resolve")
	timeout := flag.Duration("timeout", 60*time.Second, "Timeout")
	flag.Parse()
	ctx, cancel := context.WithTimeout(context.Background(), *timeout)
	defer cancel()

We create a new resolver using the standard library to perform domain name resolutions. Unless you're cross compiling, this resolver will call the system resolver using a C API. On Unix the called C API is getaddrinfo.

The returned resolver implements an interface that is very close to the API of the net.Resolver struct.

	reso := netxlite.NewStdlibResolver(log.Log)

We call LookupHost to map the hostname to IP addrs. The returned value is either a list of addrs or an error.

	addrs, err := reso.LookupHost(ctx, *hostname)
	if err != nil {
		fatal(err)
	}
	log.Infof("resolver addrs: %+v", addrs)
}

This function is exactly like it was in previous chapters.

func fatal(err error) {
	var ew *netxlite.ErrWrapper
	if !errors.As(err, &ew) {
		log.Fatal("cannot get ErrWrapper")
	}
	log.Warnf("error string    : %s", err.Error())
	log.Warnf("OONI failure    : %s", ew.Failure)
	log.Warnf("failed operation: %s", ew.Operation)
	log.Warnf("underlying error: %+v", ew.WrappedErr)
	os.Exit(1)
}

Running the code

Vanilla run

You can now run this code as follows:

go run -race ./internal/tutorial/netxlite/chapter05

You will see debug logs describing what is happening along with timing info.

NXDOMAIN error

go run -race ./internal/tutorial/netxlite/chapter05 -hostname antani.ooni.io

should cause a dns_nxdomain_error, because the domain does not exist.

Timeout

go run -race ./internal/tutorial/netxlite/chapter05 -timeout 10us

should cause a timeout error, because the timeout is ridicolously small.

Conclusions

We have seen how to use the "stdlib" DNS resolver.