feat(debug): add netcheck

add netcheck

Signed-off-by: ysicing <i@ysicing.me>

Author: ysicing

cmd/debug.go

@@ -25,5 +25,6 @@ func newCmdDebug(f factory.Factory) *cobra.Command {
 	debugCmd.AddCommand(debug.DownloadCommand(f))
 	debugCmd.AddCommand(debug.CleanCacheCommand(f))
 	debugCmd.AddCommand(debug.GOpsCommand(f))
+	debugCmd.AddCommand(debug.NetCheckCommand(f))
 	return debugCmd
 }

cmd/debug/netcheck.go

@@ -0,0 +1,43 @@
+// Copyright (c) 2023 ysicing(ysicing.me, ysicing@ysicing.cloud) All rights reserved.
+// Use of this source code is covered by the following dual licenses:
+// (1) Y PUBLIC LICENSE 1.0 (YPL 1.0)
+// (2) Affero General Public License 3.0 (AGPL 3.0)
+// License that can be found in the LICENSE file.
+
+package debug
+
+import (
+	"github.com/spf13/cobra"
+	"github.com/ysicing/tiga/pkg/factory"
+	"github.com/ysicing/tiga/pkg/util/netutil"
+)
+
+func NetCheckCommand(f factory.Factory) *cobra.Command {
+	logpkg := f.GetLog()
+	cmd := &cobra.Command{
+		Use:   "netcheck",
+		Short: "netcheck",
+		Run: func(cmd *cobra.Command, args []string) {
+			if gw, err := netutil.CheckDefaultRoute(); err == nil {
+				logpkg.Donef("default route %s reachable via icmp", gw.String())
+			} else {
+				logpkg.Warnf("default route %s unreachable via icmp", gw.String())
+			}
+			if ns, err := netutil.GetDefaultNameserver(); err == nil {
+				a := ""
+
+				if !netutil.CheckReachabilityWithICMP(ns) {
+					a = "un"
+				}
+				if err := netutil.CheckNameserverAvailability(ns + ":53"); err != nil {
+					logpkg.Warnf("Default nameserver: %s (ICMP %s reachable, DNS unreachable: %s)", ns, a, err)
+				} else {
+					logpkg.Donef("Default nameserver: %s (ICMP %s reachable, DNS reachable)", ns, a)
+				}
+			} else {
+				logpkg.Warnf("failed to reading default nameserver from system: %s", err)
+			}
+		},
+	}
+	return cmd
+}

go.mod

@@ -10,12 +10,15 @@ require (
 	github.com/cockroachdb/errors v1.9.1
 	github.com/containerd/continuity v0.3.0
 	github.com/ergoapi/util v0.4.0
+	github.com/go-ping/ping v1.1.0
 	github.com/google/gops v0.3.27
 	github.com/inconshreveable/go-update v0.0.0-20160112193335-8152e7eb6ccf
+	github.com/jackpal/gateway v1.0.10
 	github.com/k0kubun/go-ansi v0.0.0-20180517002512-3bf9e2903213
 	github.com/loft-sh/utils v0.0.18
 	github.com/mattn/go-isatty v0.0.18
 	github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d
+	github.com/miekg/dns v1.1.54
 	github.com/moby/term v0.5.0
 	github.com/morikuni/aec v1.0.0
 	github.com/muesli/mango-cobra v1.2.0

go.sum

@@ -114,6 +114,8 @@ github.com/go-openapi/jsonreference v0.20.1 h1:FBLnyygC4/IZZr893oiomc9XaghoveYTr
 github.com/go-openapi/jsonreference v0.20.1/go.mod h1:Bl1zwGIM8/wsvqjsOQLJ/SH+En5Ap4rVB5KVcIDZG2k=
 github.com/go-openapi/swag v0.22.3 h1:yMBqmnQ0gyZvEb/+KzuWZOXgllrXT4SADYbvDaXHv/g=
 github.com/go-openapi/swag v0.22.3/go.mod h1:UzaqsxGiab7freDnrUUra0MwWfN/q7tE4j+VcZ0yl14=
+github.com/go-ping/ping v1.1.0 h1:3MCGhVX4fyEUuhsfwPrsEdQw6xspHkv5zHsiSoDFZYw=
+github.com/go-ping/ping v1.1.0/go.mod h1:xIFjORFzTxqIV/tDVGO4eDy/bLuSyawEeojSm3GfRGk=
 github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 h1:tfuBGBXKqDEevZMzYi5KSi8KkcZtzBcTgAUUtapy0OI=
 github.com/gobwas/httphead v0.0.0-20180130184737-2c6c146eadee/go.mod h1:L0fX3K22YWvt/FAX9NnzrNzcI4wNYi9Yku4O0LKYflo=
 github.com/gobwas/pool v0.2.0/go.mod h1:q8bcK0KcYlCgd9e7WYLm9LpyS+YeLd8JVDW6WezmKEw=
@@ -172,6 +174,7 @@ github.com/google/pprof v0.0.0-20230510103437-eeec1cb781c3 h1:2XF1Vzq06X+inNqgJ9
 github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 h1:El6M4kTTCOh6aBiKaUGG7oYTSPP8MxqL4YI3kZKwcP4=
 github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ=
 github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/google/uuid v1.2.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY=
@@ -198,6 +201,8 @@ github.com/iris-contrib/go.uuid v2.0.0+incompatible/go.mod h1:iz2lgM/1UnEf1kP0L/
 github.com/iris-contrib/jade v1.1.3/go.mod h1:H/geBymxJhShH5kecoiOCSssPX7QWYH7UaeZTSWddIk=
 github.com/iris-contrib/pongo2 v0.0.1/go.mod h1:Ssh+00+3GAZqSQb30AvBRNxBx7rf0GqwkjqxNd0u65g=
 github.com/iris-contrib/schema v0.0.1/go.mod h1:urYA3uvUNG1TIIjOSCzHr9/LmbQo8LrOcOqfqxa4hXw=
+github.com/jackpal/gateway v1.0.10 h1:7g3fDo4Cd3RnTu6PzAfw6poO4Y81uNxrxFQFsBFSzJM=
+github.com/jackpal/gateway v1.0.10/go.mod h1:+uPBgIllrbkwYCAoDkGSZbjvpre/bGYAFCYIcrH+LHs=
 github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY=
 github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y=
 github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU=
@@ -263,6 +268,8 @@ github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b/go.mod h1:01TrycV0kFyex
 github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d h1:5PJl274Y63IEHC+7izoQE9x6ikvDFZS2mDVS3drnohI=
 github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE=
 github.com/microcosm-cc/bluemonday v1.0.2/go.mod h1:iVP4YcDBq+n/5fb23BhYFvIMq/leAFZyRl6bYmGDlGc=
+github.com/miekg/dns v1.1.54 h1:5jon9mWcb0sFJGpnI99tOMhCPyJ+RPVz5b63MQG0VWI=
+github.com/miekg/dns v1.1.54/go.mod h1:uInx36IzPl7FYnDcMeVWxj9byh7DutNykX4G9Sj60FY=
 github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y=
 github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
 github.com/mitchellh/go-wordwrap v1.0.1 h1:TLuKupo69TCn6TQSyGxwI1EblZZEsQ0vMlAFQflz0v0=
@@ -448,6 +455,7 @@ golang.org/x/net v0.0.0-20191209160850-c0dbc17a3553/go.mod h1:z5CRVTTTmAJ677TzLL
 golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
 golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
+golang.org/x/net v0.0.0-20210316092652-d523dce5a7f4/go.mod h1:RBQZq4jEuRlivfhVLdyRGr576XBO4/greRjx4P4O3yc=
 golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM=
 golang.org/x/net v0.0.0-20211008194852-3b03d305991f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
 golang.org/x/net v0.10.0 h1:X2//UzNDwYmtCLn7To6G58Wr6f5ahEAQgKNzv9Y951M=
@@ -479,6 +487,7 @@ golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20201204225414-ed752295db88/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210315160823-c6e025ad8005/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210403161142-5e06dd20ab57/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=

pkg/util/netutil/netutil.go

@@ -0,0 +1,92 @@
+// Copyright (c) 2023 ysicing(ysicing.me, ysicing@ysicing.cloud) All rights reserved.
+// Use of this source code is covered by the following dual licenses:
+// (1) Y PUBLIC LICENSE 1.0 (YPL 1.0)
+// (2) Affero General Public License 3.0 (AGPL 3.0)
+// License that can be found in the LICENSE file.
+
+package netutil
+
+import (
+	"fmt"
+	"github.com/cockroachdb/errors"
+	"github.com/go-ping/ping"
+	"github.com/jackpal/gateway"
+	"github.com/miekg/dns"
+	"io/fs"
+	"net"
+	"os"
+	"regexp"
+	"time"
+)
+
+// CheckDefaultRoute checks if the default route is reachable
+func CheckDefaultRoute() (net.IP, error) {
+	// check default gateway
+	gw, err := gateway.DiscoverGateway()
+
+	if err != nil {
+		return nil, fmt.Errorf("error reading default route: %s", err)
+	}
+
+	if CheckReachabilityWithICMP(gw.String()) {
+		return gw, nil
+	}
+
+	return gw, fmt.Errorf("default route is unreachable")
+}
+
+// CheckReachabilityWithICMP checks if a host is reachable using ICMP
+func CheckReachabilityWithICMP(host string) bool {
+	pinger, err := ping.NewPinger(host)
+	if err != nil {
+		return false
+	}
+
+	pinger.Count = 3
+	pinger.Debug = true
+	pinger.Interval = 200 * time.Millisecond
+	pinger.Timeout = 3 * time.Second
+
+	err = pinger.Run()
+
+	if err != nil {
+		return false
+	}
+
+	stats := pinger.Statistics()
+
+	return stats.PacketsRecv != 0
+}
+
+// GetDefaultNameserver returns the default nameserver
+func GetDefaultNameserver() (string, error) {
+	// get default ns from /etc/resolv.conf
+	byteString, err := fs.ReadFile(os.DirFS("/etc"), "resolv.conf")
+	if err != nil {
+		return "", err
+	}
+	s := string(byteString)
+	re := regexp.MustCompile(`(?m)^nameserver( *|\t*)(.*?)$`)
+	match := re.FindStringSubmatch(s)
+
+	if len(match) < 2 {
+		return "", errors.New("nameserver not found")
+	}
+	return match[2], nil
+}
+
+// CheckNameserverAvailability checks if a nameserver is reachable using DNS
+func CheckNameserverAvailability(s string) error {
+	c := new(dns.Client)
+	c.Dialer = &net.Dialer{
+		Timeout: 3 * time.Second,
+	}
+	m := new(dns.Msg)
+	m.SetQuestion("apple.com.", dns.TypeA)
+	_, _, err := c.Exchange(m, s)
+
+	if err != nil {
+		return err
+	}
+	return nil
+}