Merge branch 'master' into wipInIndex

.golangcilint.yml

@@ -3,6 +3,7 @@ linters:
   disable-all: true
   enable:
     # Default linters.
+    - forbidigo
     - errcheck
     - gosimple
     - govet
@@ -19,6 +20,15 @@ linters:
     - misspell
     - goheader
 linters-settings:
+  # ...
+  forbidigo:
+    forbid:
+    - p: "([iI][fF][iI]d)|([iI]F[iI][dD])|([iI][fF]i[dD])"
+      msg: "spell interface ID as ifID / IfID"
+    - p: "(?i)interfaceID"  # case insensitive
+      msg: "spell interface ID as ifID / IfID"
+    - p: "Trc"
+      msg: "spell trust root certificate as trc / TRC"
   lll:
     line-length: 100
     tab-width: 4

control/beacon/beacon.go

@@ -25,8 +25,8 @@ import (
 type Beacon struct {
 	// Segment is the path segment.
 	Segment *seg.PathSegment
-	// InIfId is the interface the beacon is received on.
-	InIfId uint16
+	// InIfID is the interface the beacon is received on.
+	InIfID uint16
 }
 
 // Diversity returns the link diversity between this and the other beacon. The
@@ -39,11 +39,11 @@ func (b Beacon) Diversity(other Beacon) int {
 	}
 	var diff int
 	for _, asEntry := range b.Segment.ASEntries {
-		ia, ifid := link(asEntry)
+		ia, ifID := link(asEntry)
 		var found bool
 		for _, otherEntry := range other.Segment.ASEntries {
-			oia, oifid := link(otherEntry)
-			if ia.Equal(oia) && ifid == oifid {
+			oia, oifID := link(otherEntry)
+			if ia.Equal(oia) && ifID == oifID {
 				found = true
 				break
 			}
@@ -56,7 +56,7 @@ func (b Beacon) Diversity(other Beacon) int {
 }
 
 func (b Beacon) String() string {
-	return fmt.Sprintf("Ingress: %d Segment: [ %s ]", b.InIfId, b.Segment)
+	return fmt.Sprintf("Ingress: %d Segment: [ %s ]", b.InIfID, b.Segment)
 }
 
 func link(entry seg.ASEntry) (addr.IA, uint16) {

control/beacon/beacondbtest/beacondbtest.go

@@ -318,13 +318,13 @@ func CheckResults(t *testing.T, results []beacon.Beacon, expectedBeacons []beaco
 			}
 			assert.Equal(t, expected, actual)
 		}
-		assert.Equal(t, expected.InIfId, res.InIfId, "InIfId %d should match", i)
+		assert.Equal(t, expected.InIfID, res.InIfID, "InIfID %d should match", i)
 	}
 }
 
 func InsertBeacon(t *testing.T, db beacon.DB, ases []IfInfo,
-	inIfId uint16, infoTS uint32, allowed beacon.Usage) beacon.Beacon {
-	b, _ := AllocBeacon(t, ases, inIfId, infoTS)
+	inIfID uint16, infoTS uint32, allowed beacon.Usage) beacon.Beacon {
+	b, _ := AllocBeacon(t, ases, inIfID, infoTS)
 	ctx, cancelF := context.WithTimeout(context.Background(), timeout)
 	defer cancelF()
 	_, err := db.InsertBeacon(ctx, b, allowed)
@@ -334,21 +334,21 @@ func InsertBeacon(t *testing.T, db beacon.DB, ases []IfInfo,
 
 type PeerEntry struct {
 	IA      addr.IA
-	Ingress common.IFIDType
+	Ingress common.IfIDType
 }
 
 type IfInfo struct {
 	IA      addr.IA
 	Next    addr.IA
-	Ingress common.IFIDType
-	Egress  common.IFIDType
+	Ingress common.IfIDType
+	Egress  common.IfIDType
 	Peers   []PeerEntry
 }
 
 func AllocBeacon(
 	t *testing.T,
 	ases []IfInfo,
-	inIfId uint16,
+	inIfID uint16,
 	infoTS uint32,
 ) (beacon.Beacon, []byte) {
 
@@ -401,5 +401,5 @@ func AllocBeacon(
 		err := pseg.AddASEntry(context.Background(), entry, signer)
 		require.NoError(t, err)
 	}
-	return beacon.Beacon{Segment: pseg, InIfId: inIfId}, pseg.ID()
+	return beacon.Beacon{Segment: pseg, InIfID: inIfID}, pseg.ID()
 }

control/beacon/store_test.go

@@ -269,13 +269,13 @@ func testBeacon(g *graph.Graph, desc ...uint16) beacon.Beacon {
 	pseg := testSegment(g, desc)
 	asEntry := pseg.ASEntries[pseg.MaxIdx()]
 	return beacon.Beacon{
-		InIfId:  asEntry.HopEntry.HopField.ConsIngress,
+		InIfID:  asEntry.HopEntry.HopField.ConsIngress,
 		Segment: pseg,
 	}
 }
 
-func testSegment(g *graph.Graph, ifids []uint16) *seg.PathSegment {
-	pseg := g.Beacon(ifids)
+func testSegment(g *graph.Graph, ifIDs []uint16) *seg.PathSegment {
+	pseg := g.Beacon(ifIDs)
 	pseg.ASEntries = pseg.ASEntries[:len(pseg.ASEntries)-1]
 	return pseg
 }

control/beaconing/export_test.go

@@ -20,7 +20,7 @@ import (
 	"github.com/scionproto/scion/private/topology"
 )
 
-func (cfg StaticInfoCfg) TestGenerate(ifType map[common.IFIDType]topology.LinkType,
-	ingress, egress common.IFIDType) *staticinfo.Extension {
+func (cfg StaticInfoCfg) TestGenerate(ifType map[common.IfIDType]topology.LinkType,
+	ingress, egress common.IfIDType) *staticinfo.Extension {
 	return cfg.generate(ifType, ingress, egress)
 }

control/beaconing/extender.go

@@ -298,13 +298,13 @@ func (s *DefaultExtender) remoteMTU(ifID uint16) (uint16, error) {
 	return topoInfo.MTU, nil
 }
 
-func (s *DefaultExtender) remoteInfo(ifid uint16) (
+func (s *DefaultExtender) remoteInfo(ifID uint16) (
 	addr.IA, uint16, uint16, error) {
 
-	if ifid == 0 {
+	if ifID == 0 {
 		return 0, 0, 0, nil
 	}
-	intf := s.Intfs.Get(ifid)
+	intf := s.Intfs.Get(ifID)
 	if intf == nil {
 		return 0, 0, 0, serrors.New("interface not found")
 	}

control/beaconing/grpc/beacon_sender.go

@@ -39,12 +39,12 @@ type BeaconSenderFactory struct {
 func (f *BeaconSenderFactory) NewSender(
 	ctx context.Context,
 	dstIA addr.IA,
-	egIfId uint16,
+	egIfID uint16,
 	nextHop *net.UDPAddr,
 ) (beaconing.Sender, error) {
 	addr := &onehop.Addr{
 		IA:      dstIA,
-		Egress:  egIfId,
+		Egress:  egIfID,
 		SVC:     addr.SvcCS,
 		NextHop: nextHop,
 	}

control/beaconing/grpc/creation_server.go

@@ -68,7 +68,7 @@ func (s SegmentCreationServer) Beacon(ctx context.Context,
 	}
 	b := beacon.Beacon{
 		Segment: ps,
-		InIfId:  ingress,
+		InIfID:  ingress,
 	}
 	if err := s.Handler.HandleBeacon(ctx, b, peer); err != nil {
 		logger.Debug("Failed to handle beacon", "peer", peer, "err", err)

control/beaconing/handler.go

@@ -54,19 +54,19 @@ type Handler struct {
 // HandleBeacon handles a baeacon received from peer.
 func (h Handler) HandleBeacon(ctx context.Context, b beacon.Beacon, peer *snet.UDPAddr) error {
 	span := opentracing.SpanFromContext(ctx)
-	labels := handlerLabels{Ingress: b.InIfId}
+	labels := handlerLabels{Ingress: b.InIfID}
 
-	intf := h.Interfaces.Get(b.InIfId)
+	intf := h.Interfaces.Get(b.InIfID)
 	if intf == nil {
 		err := serrors.New("received beacon on non-existent interface",
-			"ingress_interface", b.InIfId)
+			"ingress_interface", b.InIfID)
 		h.updateMetric(span, labels.WithResult(prom.ErrNotClassified), err)
 		return err
 	}
 
 	upstream := intf.TopoInfo().IA
 	if span != nil {
-		span.SetTag("ingress_interface", b.InIfId)
+		span.SetTag("ingress_interface", b.InIfID)
 		span.SetTag("upstream", upstream)
 	}
 	labels.Neighbor = upstream
@@ -106,7 +106,7 @@ func (h Handler) validateASEntry(b beacon.Beacon, intf *ifstate.Interface) error
 	topoInfo := intf.TopoInfo()
 	if topoInfo.LinkType != topology.Parent && topoInfo.LinkType != topology.Core {
 		return serrors.New("beacon received on invalid link",
-			"ingress_interface", b.InIfId, "link_type", topoInfo.LinkType)
+			"ingress_interface", b.InIfID, "link_type", topoInfo.LinkType)
 	}
 	asEntry := b.Segment.ASEntries[b.Segment.MaxIdx()]
 	if !asEntry.Local.Equal(topoInfo.IA) {

control/beaconing/handler_test.go

@@ -51,7 +51,7 @@ func TestHandlerHandleBeacon(t *testing.T) {
 		g := graph.NewDefaultGraph(mctrl)
 		return beacon.Beacon{
 			Segment: testSegment(g, []uint16{graph.If_220_X_120_B, graph.If_120_A_110_X}),
-			InIfId:  localIF,
+			InIfID:  localIF,
 		}
 	}()
 
@@ -104,7 +104,7 @@ func TestHandlerHandleBeacon(t *testing.T) {
 					Segment: testSegment(g, []uint16{
 						graph.If_220_X_120_B, graph.If_120_A_110_X,
 					}),
-					InIfId: 12,
+					InIfID: 12,
 				}
 			},
 			Peer: func() *snet.UDPAddr {
@@ -130,7 +130,7 @@ func TestHandlerHandleBeacon(t *testing.T) {
 					Segment: testSegment(g, []uint16{
 						graph.If_220_X_120_B, graph.If_120_A_110_X,
 					}),
-					InIfId: 42,
+					InIfID: 42,
 				}
 			},
 			Peer: func() *snet.UDPAddr {
@@ -156,7 +156,7 @@ func TestHandlerHandleBeacon(t *testing.T) {
 					Segment: testSegment(g, []uint16{
 						graph.If_220_X_120_B, graph.If_120_A_110_X,
 					}),
-					InIfId: localIF,
+					InIfID: localIF,
 				}
 				b.Segment.ASEntries[b.Segment.MaxIdx()].Local = addr.MustParseIA("1-ff00:0:111")
 				return b
@@ -185,7 +185,7 @@ func TestHandlerHandleBeacon(t *testing.T) {
 					Segment: testSegment(g, []uint16{
 						graph.If_220_X_120_B, graph.If_120_A_110_X,
 					}),
-					InIfId: localIF,
+					InIfID: localIF,
 				}
 				b.Segment.ASEntries[b.Segment.MaxIdx()].Next = addr.MustParseIA("1-ff00:0:111")
 				return b
@@ -276,8 +276,8 @@ func TestHandlerHandleBeacon(t *testing.T) {
 	}
 }
 
-func testSegment(g *graph.Graph, ifids []uint16) *seg.PathSegment {
-	pseg := g.Beacon(ifids)
+func testSegment(g *graph.Graph, ifIDs []uint16) *seg.PathSegment {
+	pseg := g.Beacon(ifIDs)
 	pseg.ASEntries = pseg.ASEntries[:len(pseg.ASEntries)-1]
 	return pseg
 }

control/beaconing/originator.go

@@ -140,11 +140,11 @@ func (o *Originator) needBeacon(active []*ifstate.Interface) []*ifstate.Interfac
 
 func (o *Originator) logSummary(logger log.Logger, s *summary) {
 	if o.Tick.Passed() {
-		logger.Debug("Originated beacons", "egress_interfaces", s.IfIds())
+		logger.Debug("Originated beacons", "egress_interfaces", s.IfIDs())
 		return
 	}
 	if s.count > 0 {
-		logger.Debug("Originated beacons on stale interfaces", "egress_interfaces", s.IfIds())
+		logger.Debug("Originated beacons on stale interfaces", "egress_interfaces", s.IfIDs())
 	}
 }
 
@@ -156,7 +156,7 @@ type beaconOriginator struct {
 	summary   *summary
 }
 
-// originateBeacon originates a beacon on the given ifid.
+// originateBeacon originates a beacon on the given ifID.
 func (o *beaconOriginator) originateBeacon(ctx context.Context) error {
 	labels := originatorLabels{intf: o.intf}
 	topoInfo := o.intf.TopoInfo()
@@ -213,7 +213,7 @@ func (o *beaconOriginator) createBeacon(ctx context.Context) (*seg.PathSegment,
 
 func (o *beaconOriginator) onSuccess(intf *ifstate.Interface) {
 	intf.Originate(o.Tick.Now())
-	o.summary.AddIfid(o.intf.TopoInfo().ID)
+	o.summary.AddIfID(o.intf.TopoInfo().ID)
 	o.summary.Inc()
 }
 

control/beaconing/originator_test.go

@@ -61,7 +61,7 @@ func TestOriginatorRun(t *testing.T) {
 		}
 		return false
 	}
-	t.Run("run originates ifid packets on all active interfaces", func(t *testing.T) {
+	t.Run("run originates ifID packets on all active interfaces", func(t *testing.T) {
 		mctrl := gomock.NewController(t)
 		defer mctrl.Finish()
 		intfs := ifstate.NewInterfaces(interfaceInfos(topo), ifstate.Config{})
@@ -90,7 +90,7 @@ func TestOriginatorRun(t *testing.T) {
 
 		senderFactory.EXPECT().NewSender(gomock.Any(), gomock.Any(), gomock.Any(),
 			gomock.Any()).Times(4).DoAndReturn(
-			func(_ context.Context, dstIA addr.IA, egIfId uint16,
+			func(_ context.Context, dstIA addr.IA, egIfID uint16,
 				nextHop *net.UDPAddr) (beaconing.Sender, error) {
 
 				sender := mock_beaconing.NewMockSender(mctrl)
@@ -103,9 +103,9 @@ func TestOriginatorRun(t *testing.T) {
 						// Extract the hop field from the current AS entry to compare.
 						hopF := b.ASEntries[b.MaxIdx()].HopEntry.HopField
 						// Check the interface matches.
-						assert.Equal(t, hopF.ConsEgress, egIfId)
+						assert.Equal(t, hopF.ConsEgress, egIfID)
 						// Check that the beacon is sent to the correct border router.
-						br := net.UDPAddrFromAddrPort(interfaceInfos(topo)[egIfId].InternalAddr)
+						br := net.UDPAddrFromAddrPort(interfaceInfos(topo)[egIfID].InternalAddr)
 						assert.Equal(t, br, nextHop)
 						return nil
 					},