treewide: run gofmt -s and enable linter
Change-Id: I90b8ef48c955dccfddc5bbc0a57205b7da844b60
Reviewed-on: https://review.monogon.dev/c/monogon/+/3828
Tested-by: Jenkins CI
Reviewed-by: Leopold Schabel <leo@monogon.tech>
diff --git a/build/analysis/BUILD.bazel b/build/analysis/BUILD.bazel
index b97a58e..f55a2ad 100644
--- a/build/analysis/BUILD.bazel
+++ b/build/analysis/BUILD.bazel
@@ -91,7 +91,7 @@
"//build/analysis/checkcompilerdirectives",
"//build/analysis/noioutil",
"//build/analysis/importsort",
- # "//build/analysis/gofmt", # TODO(tim): Enable when formatted
+ "//build/analysis/gofmt",
]
# NOGO_CONFIG_OVERRIDES contains the overrides for nogo to exempt specific files
@@ -213,6 +213,7 @@
"returnerrcheck",
"hash",
"errcmp",
+ "gofmt",
] + ALL_STATICCHECK_ANALYZERS
# We override the variable with itself unioned with the other
diff --git a/build/toolbase/workspace.go b/build/toolbase/workspace.go
index b8582af..f1d9f08 100644
--- a/build/toolbase/workspace.go
+++ b/build/toolbase/workspace.go
@@ -19,9 +19,9 @@
// WorkspaceDirectory returns the workspace directory from which a given
// command line tool is running. This handles the following cases:
//
-// 1. The command line tool was invoked via `bazel run`.
-// 2. The command line tool was started directly in a workspace directory (but
-// not a subdirectory).
+// 1. The command line tool was invoked via `bazel run`.
+// 2. The command line tool was started directly in a workspace directory (but
+// not a subdirectory).
//
// If the workspace directory path cannot be inferred based on the above
// assumptions, an error is returned.
diff --git a/cloud/bmaas/bmdb/sessions_test.go b/cloud/bmaas/bmdb/sessions_test.go
index 9806ddb..36fb4a4 100644
--- a/cloud/bmaas/bmdb/sessions_test.go
+++ b/cloud/bmaas/bmdb/sessions_test.go
@@ -613,9 +613,9 @@
// Wait for at least three workers to be alive.
for i := 0; i < 3; i++ {
select {
- case workStarted <- struct{}{}:
- case <-ctx.Done():
- t.FailNow()
+ case workStarted <- struct{}{}:
+ case <-ctx.Done():
+ t.FailNow()
}
}
diff --git a/cloud/equinix/cli/cmd_list.go b/cloud/equinix/cli/cmd_list.go
index bfbb21d..ab6b9cf 100644
--- a/cloud/equinix/cli/cmd_list.go
+++ b/cloud/equinix/cli/cmd_list.go
@@ -16,10 +16,10 @@
)
var listCmd = &cobra.Command{
- Use: "list",
+ Use: "list",
Long: `This lists all hardware reservations inside a specified organization or project.`,
- Args: cobra.NoArgs,
- Run: doList,
+ Args: cobra.NoArgs,
+ Run: doList,
}
func init() {
diff --git a/cloud/shepherd/manager/provider_test.go b/cloud/shepherd/manager/provider_test.go
index c88c996..3f6b139 100644
--- a/cloud/shepherd/manager/provider_test.go
+++ b/cloud/shepherd/manager/provider_test.go
@@ -96,8 +96,8 @@
}
type dummyProvider struct {
- capacity int
- machines map[shepherd.ProviderID]*dummyMachine
+ capacity int
+ machines map[shepherd.ProviderID]*dummyMachine
muMachines sync.RWMutex
}
diff --git a/metropolis/node/core/curator/impl_leader_test.go b/metropolis/node/core/curator/impl_leader_test.go
index 36b0c53..dc8bdee 100644
--- a/metropolis/node/core/curator/impl_leader_test.go
+++ b/metropolis/node/core/curator/impl_leader_test.go
@@ -1201,28 +1201,28 @@
// Define the test payloads. Each role is optional, and will be updated
// only if it's not nil, and its value differs from the current state.
ue := []*apb.UpdateNodeRolesRequest{
- &apb.UpdateNodeRolesRequest{
+ {
Node: &apb.UpdateNodeRolesRequest_Pubkey{
Pubkey: tn[0].pubkey,
},
KubernetesWorker: ptr.To(false),
ConsensusMember: ptr.To(false),
},
- &apb.UpdateNodeRolesRequest{
+ {
Node: &apb.UpdateNodeRolesRequest_Pubkey{
Pubkey: tn[1].pubkey,
},
KubernetesWorker: ptr.To(false),
ConsensusMember: ptr.To(true),
},
- &apb.UpdateNodeRolesRequest{
+ {
Node: &apb.UpdateNodeRolesRequest_Pubkey{
Pubkey: tn[2].pubkey,
},
KubernetesWorker: ptr.To(true),
ConsensusMember: ptr.To(true),
},
- &apb.UpdateNodeRolesRequest{
+ {
Node: &apb.UpdateNodeRolesRequest_Pubkey{
Pubkey: tn[2].pubkey,
},
@@ -1270,14 +1270,14 @@
// currently can't be a KubernetesController if it's not a ConsensusMember as
// well.
uf := []*apb.UpdateNodeRolesRequest{
- &apb.UpdateNodeRolesRequest{
+ {
Node: &apb.UpdateNodeRolesRequest_Pubkey{
Pubkey: tn[0].pubkey,
},
KubernetesController: ptr.To(true),
ConsensusMember: ptr.To(false),
},
- &apb.UpdateNodeRolesRequest{
+ {
Node: &apb.UpdateNodeRolesRequest_Pubkey{
Pubkey: tn[0].pubkey,
},
diff --git a/metropolis/node/core/localstorage/declarative/declarative.go b/metropolis/node/core/localstorage/declarative/declarative.go
index 4f9b087..5e194b5 100644
--- a/metropolis/node/core/localstorage/declarative/declarative.go
+++ b/metropolis/node/core/localstorage/declarative/declarative.go
@@ -160,10 +160,10 @@
// Validate checks that a given pointer to a Directory or pointer to a
// structure containing Directory does not contain any programmer errors in its
// definition:
-// - all subdirectories/files must be named
-// - all subdirectory/file names within a directory must be unique
-// - all subdirectory/file names within a directory must not contain the '/'
-// character (as it is a common path delimiter)
+// - all subdirectories/files must be named
+// - all subdirectory/file names within a directory must be unique
+// - all subdirectory/file names within a directory must not contain the '/'
+// character (as it is a common path delimiter)
func Validate(d interface{}) error {
names := make(map[string]bool)
diff --git a/metropolis/node/core/network/dhcp4c/doc.go b/metropolis/node/core/network/dhcp4c/doc.go
index 49aece5..292bb28 100644
--- a/metropolis/node/core/network/dhcp4c/doc.go
+++ b/metropolis/node/core/network/dhcp4c/doc.go
@@ -17,36 +17,36 @@
// Package dhcp4c provides a client implementation of the DHCPv4 protocol
// (RFC2131) and a few extensions for Linux-based systems.
// The code is split into three main parts:
-// - The core DHCP state machine, which lives in dhcpc.go
-// - Mechanisms to send and receive DHCP messages, which live in transport/
-// - Standard callbacks which implement necessary kernel configuration steps in
-// a simple and standalone way living in callback/
+// - The core DHCP state machine, which lives in dhcpc.go
+// - Mechanisms to send and receive DHCP messages, which live in transport/
+// - Standard callbacks which implement necessary kernel configuration steps in
+// a simple and standalone way living in callback/
//
// Since the DHCP protocol is ugly and underspecified (see
// https://tools.ietf.org/html/draft-ietf-dhc-implementation-02 for a subset of
// known issues), this client slightly bends the specification in the following
// cases:
-// - IP fragmentation for DHCP messages is not supported for both sending and
-// receiving messages This is because the major servers (ISC, dnsmasq, ...)
-// do not implement it and just drop fragmented packets, so it would be
-// counterproductive to try to send them. The client just attempts to send
-// the full message and hopes it passes through to the server.
-// - The suggested timeouts and wait periods have been tightened significantly.
-// When the standard was written 10Mbps Ethernet with hubs was a common
-// interconnect. Using these would make the client extremely slow on today's
-// 1Gbps+ networks.
-// - Wrong data in DHCP responses is fixed up if possible. This fixing includes
-// dropping prohibited options, clamping semantically invalid data and
-// defaulting not set options as far as it's possible. Non-recoverable
-// responses (for example because a non-Unicast IP is handed out or lease
-// time is not set or zero) are still ignored. All data which can be stored
-// in both DHCP fields and options is also normalized to the corresponding
-// option.
-// - Duplicate Address Detection is not implemented by default. It's slow, hard
-// to implement correctly and generally not necessary on modern networks as
-// the servers already waste time checking for duplicate addresses. It's
-// possible to hook it in via a LeaseCallback if necessary in a given
-// application.
+// - IP fragmentation for DHCP messages is not supported for both sending and
+// receiving messages This is because the major servers (ISC, dnsmasq, ...)
+// do not implement it and just drop fragmented packets, so it would be
+// counterproductive to try to send them. The client just attempts to send
+// the full message and hopes it passes through to the server.
+// - The suggested timeouts and wait periods have been tightened significantly.
+// When the standard was written 10Mbps Ethernet with hubs was a common
+// interconnect. Using these would make the client extremely slow on today's
+// 1Gbps+ networks.
+// - Wrong data in DHCP responses is fixed up if possible. This fixing includes
+// dropping prohibited options, clamping semantically invalid data and
+// defaulting not set options as far as it's possible. Non-recoverable
+// responses (for example because a non-Unicast IP is handed out or lease
+// time is not set or zero) are still ignored. All data which can be stored
+// in both DHCP fields and options is also normalized to the corresponding
+// option.
+// - Duplicate Address Detection is not implemented by default. It's slow, hard
+// to implement correctly and generally not necessary on modern networks as
+// the servers already waste time checking for duplicate addresses. It's
+// possible to hook it in via a LeaseCallback if necessary in a given
+// application.
//
// Operationally, there's one known caveat to using this client: If the lease
// offered during the select phase (in a DHCPOFFER) is not the same as the one
diff --git a/metropolis/node/core/network/dhcp4c/lease.go b/metropolis/node/core/network/dhcp4c/lease.go
index ab75c94..5f1db6f 100644
--- a/metropolis/node/core/network/dhcp4c/lease.go
+++ b/metropolis/node/core/network/dhcp4c/lease.go
@@ -129,16 +129,16 @@
// sanitizeRoutes filters the list of routes by removing routes that are
// obviously invalid. It filters out routes according to the following criteria:
-// 1. The route is not an interface route and its router is not a unicast or
-// link-local address.
-// 2. Each route's router must be reachable according to the routes listed
-// before it and the assigned network.
-// 3. The network mask must consist of all-ones followed by all-zeros. Non-
-// contiguous routes are not allowed.
-// 4. If multiple routes match the same destination, only the first one is kept.
-// 5. Routes covering the loopback IP space (127.0.0.0/8) will be ignored if
-// they are smaller than a /9 to prevent them from interfering with loopback
-// IPs.
+// 1. The route is not an interface route and its router is not a unicast or
+// link-local address.
+// 2. Each route's router must be reachable according to the routes listed
+// before it and the assigned network.
+// 3. The network mask must consist of all-ones followed by all-zeros. Non-
+// contiguous routes are not allowed.
+// 4. If multiple routes match the same destination, only the first one is kept.
+// 5. Routes covering the loopback IP space (127.0.0.0/8) will be ignored if
+// they are smaller than a /9 to prevent them from interfering with loopback
+// IPs.
func sanitizeRoutes(routes []*dhcpv4.Route, assignedNet *net.IPNet) []*dhcpv4.Route {
var saneRoutes []*dhcpv4.Route
for _, route := range routes {
diff --git a/osbase/event/etcd/etcd_test.go b/osbase/event/etcd/etcd_test.go
index ee3672f..5effa6e 100644
--- a/osbase/event/etcd/etcd_test.go
+++ b/osbase/event/etcd/etcd_test.go
@@ -79,7 +79,7 @@
// testClient is an etcd connection to the test cluster.
type testClient struct {
- client *clientv3.Client
+ client *clientv3.Client
}
func newTestClient(t *testing.T) *testClient {
@@ -95,7 +95,7 @@
}
return &testClient{
- client: cli,
+ client: cli,
}
}
diff --git a/osbase/logtree/doc.go b/osbase/logtree/doc.go
index ab3c537..1fe6d46 100644
--- a/osbase/logtree/doc.go
+++ b/osbase/logtree/doc.go
@@ -19,42 +19,42 @@
glog-like API and io.Writer API, with loggers placed in a hierarchical structure defined by a dot-delimited path
(called a DN, short for Distinguished Name).
- tree.MustLeveledFor("foo.bar.baz").Warningf("Houston, we have a problem: %v", err)
- fmt.Fprintf(tree.MustRawFor("foo.bar.baz"), "some\nunstructured\ndata\n")
+ tree.MustLeveledFor("foo.bar.baz").Warningf("Houston, we have a problem: %v", err)
+ fmt.Fprintf(tree.MustRawFor("foo.bar.baz"), "some\nunstructured\ndata\n")
Logs in this context are unstructured, operational and developer-centric human readable text messages presented as lines
of text to consumers, with some attached metadata. Logtree does not deal with 'structured' logs as some parts of the
industry do, and instead defers any machine-readable logs to either be handled by metrics systems like Prometheus or
event sourcing systems like Kafka.
-Tree Structure
+# Tree Structure
As an example, consider an application that produces logs with the following DNs:
- listener.http
- listener.grpc
- svc
- svc.cache
- svc.cache.gc
+ listener.http
+ listener.grpc
+ svc
+ svc.cache
+ svc.cache.gc
This would correspond to a tree as follows:
- .------.
- | "" |
- | (root) |
- '------'
- .----------------' '------.
- .--------------. .---------------.
- | svc | | listener |
- '--------------' '---------------'
- | .----' '----.
- .--------------. .---------------. .---------------.
- | svc.cache | | listener.http | | listener.grpc |
- '--------------' '---------------' '---------------'
- |
- .--------------.
- | svc.cache.gc |
- '--------------'
+ .------.
+ | "" |
+ | (root) |
+ '------'
+ .----------------' '------.
+ .--------------. .---------------.
+ | svc | | listener |
+ '--------------' '---------------'
+ | .----' '----.
+ .--------------. .---------------. .---------------.
+ | svc.cache | | listener.http | | listener.grpc |
+ '--------------' '---------------' '---------------'
+ |
+ .--------------.
+ | svc.cache.gc |
+ '--------------'
In this setup, every DN acts as a separate logging target, each with its own retention policy and quota. Logging to a DN
under foo.bar does NOT automatically log to foo - all tree mechanisms are applied on log access by consumers. Loggers
@@ -70,14 +70,14 @@
logs of the entire tree, just a single DN (like svc), or a subtree (like everything under listener, ie. messages emitted
to listener.http and listener.grpc).
-Leveled Log Producer API
+# Leveled Log Producer API
As part of the glog-like logging API available to producers, the following metadata is attached to emitted logs in
addition to the DN of the logger to which the log entry was emitted:
- - timestamp at which the entry was emitted
- - a severity level (one of FATAL, ERROR, WARN or INFO)
- - a source of the message (file name and line number)
+ - timestamp at which the entry was emitted
+ - a severity level (one of FATAL, ERROR, WARN or INFO)
+ - a source of the message (file name and line number)
In addition, the logger mechanism supports a variable verbosity level (so-called 'V-logging') that can be set at every
node of the tree. For more information about the producer-facing logging API, see the documentation of the LeveledLogger
@@ -88,14 +88,14 @@
with other entries, and allows for access API consumers to maintain semantic linking between multiple lines being emitted
as a single atomic entry.
-Raw Log Producer API
+# Raw Log Producer API
In addition to leveled, glog-like logging, LogTree supports 'raw logging'. This is implemented as an io.Writer that will
split incoming bytes into newline-delimited lines, and log them into that logtree's DN. This mechanism is primarily
intended to support storage of unstructured log data from external processes - for example binaries running with redirected
stdout/stderr.
-Log Access API
+# Log Access API
The Log Access API is mostly exposed via a single function on the LogTree struct: Read. It allows access to log entries
that have been already buffered inside LogTree and to subscribe to receive future entries over a channel. As outlined
@@ -111,6 +111,5 @@
logging entry. Helper functions are available on LogEntry that allow canonical string representations to be returned, for
easy use in consuming tools/interfaces. Alternatively, the consumer can itself access the internal raw/leveled entries and
print them according to their own preferred format.
-
*/
package logtree
diff --git a/osbase/pki/certificate.go b/osbase/pki/certificate.go
index b925958..93e6ed9 100644
--- a/osbase/pki/certificate.go
+++ b/osbase/pki/certificate.go
@@ -115,7 +115,8 @@
// Client makes a Kubernetes PKI-compatible client certificate template.
// Directly derived from Kubernetes PKI requirements documented at
-// https://kubernetes.io/docs/setup/best-practices/certificates/#configure-certificates-manually
+//
+// https://kubernetes.io/docs/setup/best-practices/certificates/#configure-certificates-manually
func Client(identity string, groups []string) x509.Certificate {
return x509.Certificate{
Subject: pkix.Name{
diff --git a/osbase/tpm/eventlog/eventlog.go b/osbase/tpm/eventlog/eventlog.go
index 03aaf69..2166e54 100644
--- a/osbase/tpm/eventlog/eventlog.go
+++ b/osbase/tpm/eventlog/eventlog.go
@@ -96,7 +96,7 @@
// TPM algorithms. See the TPM 2.0 specification section 6.3.
//
-// https://trustedcomputinggroup.org/wp-content/uploads/TPM-Rev-2.0-Part-2-Structures-01.38.pdf#page=42
+// https://trustedcomputinggroup.org/wp-content/uploads/TPM-Rev-2.0-Part-2-Structures-01.38.pdf#page=42
const (
algSHA1 uint16 = 0x0004
algSHA256 uint16 = 0x000B
@@ -383,7 +383,7 @@
// parser instead of holding a measurement. For TPM 2.0, this event type is
// used to signal switching from SHA1 format to a variable length digest.
//
-// https://trustedcomputinggroup.org/wp-content/uploads/TCG_PCClientSpecPlat_TPM_2p0_1p04_pub.pdf#page=110
+// https://trustedcomputinggroup.org/wp-content/uploads/TCG_PCClientSpecPlat_TPM_2p0_1p04_pub.pdf#page=110
const eventTypeNoAction = 0x03
// ParseEventLog parses an unverified measurement log.
@@ -445,7 +445,8 @@
}
// Expected values for various Spec ID Event fields.
-// https://trustedcomputinggroup.org/wp-content/uploads/EFI-Protocol-Specification-rev13-160330final.pdf#page=19
+//
+// https://trustedcomputinggroup.org/wp-content/uploads/EFI-Protocol-Specification-rev13-160330final.pdf#page=19
var wantSignature = [16]byte{0x53, 0x70,
0x65, 0x63, 0x20, 0x49,
0x44, 0x20, 0x45, 0x76,
@@ -459,7 +460,8 @@
)
// parseSpecIDEvent parses a TCG_EfiSpecIDEventStruct structure from the reader.
-// https://trustedcomputinggroup.org/wp-content/uploads/EFI-Protocol-Specification-rev13-160330final.pdf#page=18
+//
+// https://trustedcomputinggroup.org/wp-content/uploads/EFI-Protocol-Specification-rev13-160330final.pdf#page=18
func parseSpecIDEvent(b []byte) (*specIDEvent, error) {
r := bytes.NewReader(b)
var header struct {
@@ -522,7 +524,8 @@
}
// TPM 1.2 event log format. See "5.1 SHA1 Event Log Entry Format"
-// https://trustedcomputinggroup.org/wp-content/uploads/EFI-Protocol-Specification-rev13-160330final.pdf#page=15
+//
+// https://trustedcomputinggroup.org/wp-content/uploads/EFI-Protocol-Specification-rev13-160330final.pdf#page=15
type rawEventHeader struct {
PCRIndex uint32
Type uint32
@@ -567,7 +570,8 @@
}
// TPM 2.0 event log format. See "5.2 Crypto Agile Log Entry Format"
-// https://trustedcomputinggroup.org/wp-content/uploads/EFI-Protocol-Specification-rev13-160330final.pdf#page=15
+//
+// https://trustedcomputinggroup.org/wp-content/uploads/EFI-Protocol-Specification-rev13-160330final.pdf#page=15
type rawEvent2Header struct {
PCRIndex uint32
Type uint32
diff --git a/osbase/tpm/eventlog/internal/events.go b/osbase/tpm/eventlog/internal/events.go
index eb121b2..23b00c2 100644
--- a/osbase/tpm/eventlog/internal/events.go
+++ b/osbase/tpm/eventlog/internal/events.go
@@ -57,7 +57,8 @@
// EventType describes the type of event signalled in the event log.
type EventType uint32
-// BIOS Events (TCG PC Client Specific Implementation Specification for Conventional BIOS 1.21)
+// BIOS Events (TCG PC Client Specific Implementation Specification for
+// Conventional BIOS 1.21)
const (
PrebootCert EventType = 0x00000000
PostCode EventType = 0x00000001
@@ -193,7 +194,7 @@
// ParseUEFIVariableData parses the data section of an event structured as a
// UEFI variable.
//
-// https://trustedcomputinggroup.org/wp-content/uploads/TCG_PCClient_Specific_Platform_Profile_for_TPM_2p0_1p04_PUBLIC.pdf#page=100
+// https://trustedcomputinggroup.org/wp-content/uploads/TCG_PCClient_Specific_Platform_Profile_for_TPM_2p0_1p04_PUBLIC.pdf#page=100
func ParseUEFIVariableData(r io.Reader) (ret UEFIVariableData, err error) {
err = binary.Read(r, binary.LittleEndian, &ret.Header)
if err != nil {