Better error reporting for E2E test.

livekit · Dec 12, 2024 · b1dbc0d · b1dbc0d
1 parent c6a3cff
commit b1dbc0d
Show file tree

Hide file tree

Showing 7 changed files with 311 additions and 135 deletions.
diff --git a/go.mod b/go.mod
@@ -12,16 +12,16 @@ require (
 	github.com/jfreymuth/oggvorbis v1.0.5
 	github.com/livekit/mageutil v0.0.0-20230125210925-54e8a70427c1
 	github.com/livekit/mediatransportutil v0.0.0-20241128072814-c363618d4c98
-	github.com/livekit/protocol v1.28.2-0.20241128072830-b738aedbd841
+	github.com/livekit/protocol v1.29.5-0.20241209183753-f6b5078b2244
 	github.com/livekit/psrpc v0.6.1-0.20241018124827-1efff3d113a8
-	github.com/livekit/server-sdk-go/v2 v2.4.0
+	github.com/livekit/server-sdk-go/v2 v2.4.1-0.20241211082531-7610e1639c28
 	github.com/livekit/sipgo v0.13.2-0.20241209123643-27500ef99c39
 	github.com/mjibson/go-dsp v0.0.0-20180508042940-11479a337f12
 	github.com/ory/dockertest/v3 v3.10.0
 	github.com/pion/interceptor v0.1.37
 	github.com/pion/rtp v1.8.9
 	github.com/pion/sdp/v3 v3.0.9
-	github.com/pion/webrtc/v4 v4.0.4
+	github.com/pion/webrtc/v4 v4.0.5
 	github.com/pkg/errors v0.9.1
 	github.com/prometheus/client_golang v1.20.5
 	github.com/sirupsen/logrus v1.9.3

diff --git a/go.sum b/go.sum
@@ -122,12 +122,12 @@ github.com/livekit/mageutil v0.0.0-20230125210925-54e8a70427c1 h1:jm09419p0lqTkD
 github.com/livekit/mageutil v0.0.0-20230125210925-54e8a70427c1/go.mod h1:Rs3MhFwutWhGwmY1VQsygw28z5bWcnEYmS1OG9OxjOQ=
 github.com/livekit/mediatransportutil v0.0.0-20241128072814-c363618d4c98 h1:QA7DqIC/ZSsMj8HC0+zNfMMwssHbA0alZALK68r30LQ=
 github.com/livekit/mediatransportutil v0.0.0-20241128072814-c363618d4c98/go.mod h1:WIVFAGzVZ7VMjPC5+nbSfwdFjWcbuLgx97KeNSUDTEo=
-github.com/livekit/protocol v1.28.2-0.20241128072830-b738aedbd841 h1:69dSvfL6H6odFhL9q4s+RjDRDdfLY+WUUQ/Lz0av2Bs=
-github.com/livekit/protocol v1.28.2-0.20241128072830-b738aedbd841/go.mod h1:mqXSWNHbENjxM0/HG25wZ7wgja/K9fA0PeQxi+MPmWw=
+github.com/livekit/protocol v1.29.5-0.20241209183753-f6b5078b2244 h1:Eg9HK+5bMCDRKhh5g5g16oyNaMbCqMrJvxFBaBuP7Vo=
+github.com/livekit/protocol v1.29.5-0.20241209183753-f6b5078b2244/go.mod h1:NDg1btMpKCzr/w6QR5kDuXw/e4Y7yOBE+RUAHsc+Y/M=
 github.com/livekit/psrpc v0.6.1-0.20241018124827-1efff3d113a8 h1:Ibh0LoFl5NW5a1KFJEE0eLxxz7dqqKmYTj/BfCb0PbY=
 github.com/livekit/psrpc v0.6.1-0.20241018124827-1efff3d113a8/go.mod h1:CQUBSPfYYAaevg1TNCc6/aYsa8DJH4jSRFdCeSZk5u0=
-github.com/livekit/server-sdk-go/v2 v2.4.0 h1:ide41hppBf7btHLz/nj6rLIQSkaIOxP5tVSki74ZDhg=
-github.com/livekit/server-sdk-go/v2 v2.4.0/go.mod h1:0hzAkh/FegPZmXDp8Ai92ndP/mWVpBxeR5VnR3muQp4=
+github.com/livekit/server-sdk-go/v2 v2.4.1-0.20241211082531-7610e1639c28 h1:LadsWjdymTEST6ny/huFg5n4IoS7suvXnSrF+RhzBqo=
+github.com/livekit/server-sdk-go/v2 v2.4.1-0.20241211082531-7610e1639c28/go.mod h1:o6KTJ9UmNpurEbJBKWbHTDhBthILVG1kms5rAmKOIIY=
 github.com/livekit/sipgo v0.13.2-0.20241209123643-27500ef99c39 h1:Lm1cv4AlKKvprrjxsg7ilnzA3XC6ivxqLGAqTJkBdcM=
 github.com/livekit/sipgo v0.13.2-0.20241209123643-27500ef99c39/go.mod h1:nbNi0IsYn4tyY2ab7Rafvifty07miHYvgedPMKWbaI4=
 github.com/mackerelio/go-osstat v0.2.5 h1:+MqTbZUhoIt4m8qzkVoXUJg1EuifwlAJSk4Yl2GXh+o=
@@ -192,8 +192,8 @@ github.com/pion/transport/v3 v3.0.7 h1:iRbMH05BzSNwhILHoBoAPxoB9xQgOaJk+591KC9P1
 github.com/pion/transport/v3 v3.0.7/go.mod h1:YleKiTZ4vqNxVwh77Z0zytYi7rXHl7j6uPLGhhz9rwo=
 github.com/pion/turn/v4 v4.0.0 h1:qxplo3Rxa9Yg1xXDxxH8xaqcyGUtbHYw4QSCvmFWvhM=
 github.com/pion/turn/v4 v4.0.0/go.mod h1:MuPDkm15nYSklKpN8vWJ9W2M0PlyQZqYt1McGuxG7mA=
-github.com/pion/webrtc/v4 v4.0.4 h1:X+gkoBLKDsR6FliKKQ/VXGBjnMR3yOPcyXEPt3z7Ep0=
-github.com/pion/webrtc/v4 v4.0.4/go.mod h1:LvP8Np5b/sM0uyJIcUPvJcCvhtjHxJwzh2H2PYzE6cQ=
+github.com/pion/webrtc/v4 v4.0.5 h1:8cVPojcv3cQTwVga2vF1rzCNvkiEimnYdCCG7yF317I=
+github.com/pion/webrtc/v4 v4.0.5/go.mod h1:LvP8Np5b/sM0uyJIcUPvJcCvhtjHxJwzh2H2PYzE6cQ=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=

diff --git a/test/integration/sip_test.go b/test/integration/sip_test.go
@@ -132,7 +132,7 @@ func (s *SIPServer) CreateTrunkOut(t testing.TB, trunk *livekit.SIPOutboundTrunk
 	if err != nil {
 		t.Fatal(err)
 	}
-	t.Log("Trunk (out):", tr.SipTrunkId)
+	t.Log("New trunk (outbound):", tr.SipTrunkId)
 	return tr.SipTrunkId
 }
 
@@ -144,7 +144,7 @@ func (s *SIPServer) CreateTrunkIn(t testing.TB, trunk *livekit.SIPInboundTrunkIn
 	if err != nil {
 		t.Fatal(err)
 	}
-	t.Log("Trunk (in):", tr.SipTrunkId)
+	t.Log("New trunk (inbound):", tr.SipTrunkId)
 	return tr.SipTrunkId
 }
 
@@ -181,6 +181,7 @@ func (s *SIPServer) CreateTrunkAndIndividual(t testing.TB, trunk *livekit.SIPInb
 func (s *SIPServer) CreateDirectDispatch(t testing.TB, room, pin string, meta string, attrs map[string]string) string {
 	ctx := context.Background()
 	dr, err := s.Client.CreateSIPDispatchRule(ctx, &livekit.CreateSIPDispatchRuleRequest{
+		Name:       room,
 		Metadata:   meta,
 		Attributes: attrs,
 		Rule: &livekit.SIPDispatchRule{
@@ -194,7 +195,7 @@ func (s *SIPServer) CreateDirectDispatch(t testing.TB, room, pin string, meta st
 	if err != nil {
 		t.Fatal(err)
 	}
-	t.Log("Dispatch (direct):", dr.SipDispatchRuleId)
+	t.Log("New dispatch rule (direct):", dr.SipDispatchRuleId)
 	return dr.SipDispatchRuleId
 }
 
@@ -357,7 +358,7 @@ func TestSIPJoinOpenRoom(t *testing.T) {
 			Kind:     livekit.ParticipantInfo_SIP,
 			Metadata: meta,
 			Attributes: map[string]string{
-				"sip.callID":           "<test>", // special case
+				"sip.callID":           lktest.AttrTestAny, // special case
 				"sip.callStatus":       "active",
 				"sip.trunkPhoneNumber": serverNumber,
 				"sip.phoneNumber":      clientNumber,
@@ -519,7 +520,7 @@ func TestSIPJoinPinRoom(t *testing.T) {
 			Kind:     livekit.ParticipantInfo_SIP,
 			Metadata: meta,
 			Attributes: map[string]string{
-				"sip.callID":           "<test>", // special case
+				"sip.callID":           lktest.AttrTestAny, // special case
 				"sip.callStatus":       "active",
 				"sip.trunkPhoneNumber": serverNumber,
 				"sip.phoneNumber":      clientNumber,
@@ -592,7 +593,7 @@ func TestSIPJoinPinRoom(t *testing.T) {
 			Kind:     livekit.ParticipantInfo_SIP,
 			Metadata: meta,
 			Attributes: map[string]string{
-				"sip.callID":           "<test>", // special case
+				"sip.callID":           lktest.AttrTestAny, // special case
 				"sip.callStatus":       "active",
 				"sip.trunkPhoneNumber": serverNumber,
 				"sip.phoneNumber":      clientNumber,
@@ -649,7 +650,7 @@ func TestSIPJoinOpenRoomWithPin(t *testing.T) {
 			Kind:     livekit.ParticipantInfo_SIP,
 			Metadata: meta,
 			Attributes: map[string]string{
-				"sip.callID":           "<test>", // special case
+				"sip.callID":           lktest.AttrTestAny, // special case
 				"sip.callStatus":       "active",
 				"sip.trunkPhoneNumber": serverNumber,
 				"sip.phoneNumber":      clientNumber,
@@ -718,7 +719,7 @@ func TestSIPJoinRoomIndividual(t *testing.T) {
 				Kind:     livekit.ParticipantInfo_SIP,
 				Metadata: meta,
 				Attributes: map[string]string{
-					"sip.callID":           "<test>", // special case
+					"sip.callID":           lktest.AttrTestAny, // special case
 					"sip.callStatus":       "active",
 					"sip.trunkPhoneNumber": serverNumber,
 					"sip.phoneNumber":      clientNumber,
@@ -793,7 +794,7 @@ func TestSIPAudio(t *testing.T) {
 							Kind:     livekit.ParticipantInfo_SIP,
 							Metadata: meta,
 							Attributes: map[string]string{
-								"sip.callID":           "<test>", // special case
+								"sip.callID":           lktest.AttrTestAny, // special case
 								"sip.callStatus":       "active",
 								"sip.trunkPhoneNumber": serverNumber,
 								"sip.phoneNumber":      fmt.Sprintf("+%d", 111111111*(i+1)),
@@ -845,7 +846,6 @@ func TestSIPOutbound(t *testing.T) {
 		userName = "test-user"
 		userPass = "test-pass"
 		roomPin  = "*1234"
-		dtmfPin  = "ww*12w34ww#" // with added delays
 		meta     = `{"test":true}`
 	)
 
@@ -863,15 +863,16 @@ func TestSIPOutbound(t *testing.T) {
 					headersIn := map[string]string{
 						"X-LK-From-1": "inbound",
 					}
-					roomPin, dtmfPin := roomPin, dtmfPin
+					roomPin := roomPin
 					if withPin {
 						// We cannot set headers because of the PIN. See TestSIPJoinPinRoom for details.
 						delete(headersIn, "X-LK-From-1")
 					} else {
-						roomPin, dtmfPin = "", ""
+						roomPin = ""
 					}
 					// Configure Trunk for inbound server.
 					trunkIn := srvIn.CreateTrunkIn(t, &livekit.SIPInboundTrunkInfo{
+						Name:         "Test In",
 						Numbers:      []string{serverNumber},
 						AuthUsername: userName,
 						AuthPassword: userPass,
@@ -890,6 +891,7 @@ func TestSIPOutbound(t *testing.T) {
 
 					// Configure Trunk for outbound server and make a SIP call.
 					trunkOut := srvOut.CreateTrunkOut(t, &livekit.SIPOutboundTrunkInfo{
+						Name:         "Test Out",
 						Numbers:      []string{clientNumber},
 						Address:      srvIn.Address,
 						Transport:    tr,
@@ -923,18 +925,12 @@ func TestSIPOutbound(t *testing.T) {
 						// Running sub test here is important, because TestSIPOutbound registers Cleanup funcs.
 						t.Run(fmt.Sprintf("run %d", i+1), func(t *testing.T) {
 							lktest.TestSIPOutbound(t, ctx, lkOut.LiveKit, lkIn.LiveKit, lktest.SIPOutboundTestParams{
-								TrunkOut:  trunkOut,
-								NumberOut: clientNumber,
-								RoomOut:   "outbound",
-								TrunkIn:   trunkIn,
-								RuleIn:    ruleIn,
-								NumberIn:  serverNumber,
-								RoomIn:    roomIn,
-								RoomPin:   dtmfPin,
-								MetaIn:    meta,
-								AttrsIn:   expAttrsIn,
-								AttrsOut:  expAttrsOut,
-								TestDMTF:  true,
+								TrunkOut: trunkOut,
+								RoomOut:  "outbound",
+								TrunkIn:  trunkIn,
+								RuleIn:   ruleIn,
+								AttrsIn:  expAttrsIn,
+								AttrsOut: expAttrsOut,
 							})
 						})
 					}

diff --git a/test/lktest-sip-outbound/main.go b/test/lktest-sip-outbound/main.go
@@ -27,15 +27,11 @@ var (
 	fOutKey    = flag.String("key-out", "", "LiveKit API key (outbound)")
 	fOutSecret = flag.String("secret-out", "", "LiveKit API secret (outbound)")
 	fOutTrunk  = flag.String("trunk-out", "", "SIP Trunk ID (outbound)")
-	fOutNumber = flag.String("number-out", "", "Phone number (outbound)")
 	fOutRoom   = flag.String("room-out", "sip-test-out", "room name (outbound)")
 
-	fInURL     = flag.String("ws-in", "", "LiveKit WS URL (inbound)")
-	fInKey     = flag.String("key-in", "", "LiveKit API key (inbound)")
-	fInSecret  = flag.String("secret-in", "", "LiveKit API secret (inbound)")
-	fInNumber  = flag.String("number-in", "", "Phone number (inbound)")
-	fInRoom    = flag.String("room-in", "sip-test-in", "room name (inbound)")
-	fInRoomPin = flag.String("room-pin", "", "room pin (inbound)")
+	fInURL    = flag.String("ws-in", "", "LiveKit WS URL (inbound)")
+	fInKey    = flag.String("key-in", "", "LiveKit API key (inbound)")
+	fInSecret = flag.String("secret-in", "", "LiveKit API secret (inbound)")
 
 	fTimeout = flag.Duration("timeout", time.Minute, "timeout for the test")
 )
@@ -54,11 +50,7 @@ func run(ctx context.Context, t lktest.TB) {
 	lkIn := lktest.New(*fInURL, *fInKey, *fInSecret)
 
 	lktest.TestSIPOutbound(t, ctx, lkOut, lkIn, lktest.SIPOutboundTestParams{
-		TrunkOut:  *fOutTrunk,
-		NumberOut: *fOutNumber,
-		RoomOut:   *fOutRoom,
-		NumberIn:  *fInNumber,
-		RoomIn:    *fInRoom,
-		RoomPin:   *fInRoomPin,
+		TrunkOut: *fOutTrunk,
+		RoomOut:  *fOutRoom,
 	})
 }