package injector
import (
"errors"
"strings"
"testing"
"github.com/prebid/openrtb/v20/openrtb2"
"github.com/prebid/prebid-server/v4/exchange/entities"
"github.com/prebid/prebid-server/v4/macros"
"github.com/prebid/prebid-server/v4/openrtb_ext"
"github.com/prebid/prebid-server/v4/util/ptrutil"
"github.com/stretchr/testify/assert"
)
var reqWrapper = &openrtb_ext.RequestWrapper{
BidRequest: &openrtb2.BidRequest{
ID: "123",
Site: &openrtb2.Site{
Domain: "testdomain",
Publisher: &openrtb2.Publisher{
Domain: "publishertestdomain",
ID: "testpublisherID",
},
Page: "pageurltest",
},
App: &openrtb2.App{
Domain: "testdomain",
Bundle: "testbundle",
Publisher: &openrtb2.Publisher{
Domain: "publishertestdomain",
ID: "testpublisherID",
},
},
Device: &openrtb2.Device{
Lmt: ptrutil.ToPtr(int8(1)),
},
User: &openrtb2.User{Consent: "1", Ext: []byte(`{"consent":"2" }`)},
Ext: []byte(`{"prebid":{"channel": {"name":"test1"},"macros":{"CUSTOMMACR1":"value1"}}}`),
},
}
func TestInjectTracker(t *testing.T) {
b := macros.NewProvider(reqWrapper)
b.PopulateBidMacros(&entities.PbsOrtbBid{
Bid: &openrtb2.Bid{
ID: "bid123",
},
}, "testSeat")
ti := NewTrackerInjector(
macros.NewStringIndexBasedReplacer(),
b,
VASTEvents{
Errors: []string{"http://errortracker.com?macro1=##PBS-BIDID##¯o2=##PBS-APPBUNDLE##¯o3=##PBS-APPBUNDLE##¯o4=##PBS-PUBDOMAIN##¯o5=##PBS-PAGEURL##¯o6=##PBS-ACCOUNTID##¯o6=##PBS-LIMITADTRACKING##¯o7=##PBS-GDPRCONSENT##¯o8=##PBS-GDPRCONSENT##¯o9=##PBS-MACRO-CUSTOMMACR1CUST1##¯o10=##PBS-MACRO-CUSTOMMACR1CUST2##"},
Impressions: []string{"http://impressiontracker.com?macro1=##PBS-BIDID##¯o2=##PBS-APPBUNDLE##¯o3=##PBS-APPBUNDLE##¯o4=##PBS-PUBDOMAIN##¯o5=##PBS-PAGEURL##¯o6=##PBS-ACCOUNTID##¯o6=##PBS-LIMITADTRACKING##¯o7=##PBS-GDPRCONSENT##¯o8=##PBS-GDPRCONSENT##¯o9=##PBS-MACRO-CUSTOMMACR1CUST1##¯o10=##PBS-MACRO-CUSTOMMACR1CUST2##"},
VideoClicks: []string{"http://videoclicktracker.com?macro1=##PBS-BIDID##¯o2=##PBS-APPBUNDLE##¯o3=##PBS-APPBUNDLE##¯o4=##PBS-PUBDOMAIN##¯o5=##PBS-PAGEURL##¯o6=##PBS-ACCOUNTID##¯o6=##PBS-LIMITADTRACKING##¯o7=##PBS-GDPRCONSENT##¯o8=##PBS-GDPRCONSENT##¯o9=##PBS-MACRO-CUSTOMMACR1CUST1##¯o10=##PBS-MACRO-CUSTOMMACR1CUST2##"},
NonLinearClickTracking: []string{"http://nonlinearclicktracker.com?macro1=##PBS-BIDID##¯o2=##PBS-APPBUNDLE##¯o3=##PBS-APPBUNDLE##¯o4=##PBS-PUBDOMAIN##¯o5=##PBS-PAGEURL##¯o6=##PBS-ACCOUNTID##¯o6=##PBS-LIMITADTRACKING##¯o7=##PBS-GDPRCONSENT##¯o8=##PBS-GDPRCONSENT##¯o9=##PBS-MACRO-CUSTOMMACR1CUST1##¯o10=##PBS-MACRO-CUSTOMMACR1CUST2##"},
CompanionClickThrough: []string{"http://companionclicktracker.com?macro1=##PBS-BIDID##¯o2=##PBS-APPBUNDLE##¯o3=##PBS-APPBUNDLE##¯o4=##PBS-PUBDOMAIN##¯o5=##PBS-PAGEURL##¯o6=##PBS-ACCOUNTID##¯o6=##PBS-LIMITADTRACKING##¯o7=##PBS-GDPRCONSENT##¯o8=##PBS-GDPRCONSENT##¯o9=##PBS-MACRO-CUSTOMMACR1CUST1##¯o10=##PBS-MACRO-CUSTOMMACR1CUST2##"},
TrackingEvents: map[string][]string{"firstQuartile": {"http://eventracker1.com?macro1=##PBS-BIDID##¯o2=##PBS-APPBUNDLE##¯o3=##PBS-APPBUNDLE##¯o4=##PBS-PUBDOMAIN##¯o5=##PBS-PAGEURL##¯o6=##PBS-ACCOUNTID##¯o6=##PBS-LIMITADTRACKING##¯o7=##PBS-GDPRCONSENT##¯o8=##PBS-GDPRCONSENT##¯o9=##PBS-MACRO-CUSTOMMACR1CUST1##¯o10=##PBS-MACRO-CUSTOMMACR1CUST2##"}},
},
)
type args struct {
vastXML string
NURL string
}
tests := []struct {
name string
args args
want string
wantError error
}{
{
name: "Empty vastXML and NURL present",
args: args{
vastXML: "",
NURL: "www.nurl.com",
},
want: `prebid.org wrapper`,
wantError: nil,
},
{
name: "Empty vastXML and empty NURL",
args: args{
vastXML: "",
NURL: "",
},
want: "",
wantError: errors.New("invalid Vast XML"),
},
{
name: "No Inline/Wrapper tag present",
args: args{
vastXML: ``,
NURL: "",
},
want: ``,
wantError: errors.New("invalid VastXML, inline/wrapper tag not found"),
},
{
name: "Invalid Vast XML, parsing error",
args: args{
vastXML: `iabtechlabhttp://example.com/errorhttp://example.com/track/impressionInline Simple AdIAB Sample CompanyAD CONTENT description category846500:00:16`,
NURL: "",
},
want: ``,
wantError: errors.New("XML processing error: xml: end tag does not match start tag "),
},
{
name: "Inline Linear vastXML, no existing event tracker",
args: args{
vastXML: `iabtechlabhttp://example.com/errorhttp://example.com/track/impressionInline Simple AdIAB Sample CompanyAD CONTENT description category846500:00:16`,
NURL: "",
},
want: ``,
},
{
name: "Non Linear vastXML, no existing event tracker",
args: args{
NURL: "",
vastXML: `iabtechlab8465`,
},
want: ``,
},
{
name: "Wrapper Liner vastXML",
args: args{
NURL: "",
vastXML: `iabtechlabhttp://example.com/errorhttp://example.com/track/impression`,
},
want: ``,
},
{
name: "Wapper companion vastXML",
args: args{
NURL: "",
vastXML: `iabtechlab`,
},
want: ``,
},
{
name: "Wapper no companion vastXML",
args: args{
NURL: "",
vastXML: `iabtechlab`,
},
want: ``,
},
{
name: "Inline Non Linear empty",
args: args{
NURL: "",
vastXML: `iabtechlaba532d16d-4d7f-4440-bd29-2ec0e693fc80iabtechlab video ad`,
},
want: ``,
},
{
name: "Wrapper linear and non linear",
args: args{
NURL: "",
vastXML: `Test Ad Server`,
},
want: ``,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := ti.InjectTracker(tt.args.vastXML, tt.args.NURL)
assert.Equal(t, tt.want, got, tt.name)
if tt.wantError != nil {
assert.EqualError(t, err, tt.wantError.Error())
}
})
}
}
func TestAddClickTrackingEvent(t *testing.T) {
tests := []struct {
name string
addParentTag bool
expected string
}{
{
name: "With Parent Tag",
addParentTag: true,
expected: "",
},
{
name: "Without Parent Tag",
addParentTag: false,
expected: "",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var outputXML strings.Builder
b := macros.NewProvider(reqWrapper)
b.PopulateBidMacros(&entities.PbsOrtbBid{
Bid: &openrtb2.Bid{
ID: "bid123",
},
}, "testSeat")
ti := NewTrackerInjector(
macros.NewStringIndexBasedReplacer(),
b,
VASTEvents{
VideoClicks: []string{"http://videoclicktracker.com?macro1=##PBS-BIDID##¯o2=##PBS-APPBUNDLE##¯o3=##PBS-APPBUNDLE##¯o4=##PBS-PUBDOMAIN##¯o5=##PBS-PAGEURL##¯o6=##PBS-ACCOUNTID##¯o6=##PBS-LIMITADTRACKING##¯o7=##PBS-GDPRCONSENT##¯o8=##PBS-GDPRCONSENT##¯o9=##PBS-MACRO-CUSTOMMACR1CUST1##¯o10=##PBS-MACRO-CUSTOMMACR1CUST2##"},
},
)
ti.addClickTrackingEvent(&outputXML, "testCreativeId", tt.addParentTag)
assert.Equal(t, tt.expected, outputXML.String(), tt.name)
})
}
}
func TestAddImpressionTrackingEvent(t *testing.T) {
tests := []struct {
name string
addParentTag bool
expected string
}{
{
name: "Add impression tag",
addParentTag: true,
expected: "",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var outputXML strings.Builder
b := macros.NewProvider(reqWrapper)
b.PopulateBidMacros(&entities.PbsOrtbBid{
Bid: &openrtb2.Bid{
ID: "bid123",
},
}, "testSeat")
ti := NewTrackerInjector(
macros.NewStringIndexBasedReplacer(),
b,
VASTEvents{
Impressions: []string{"http://impressiontracker.com?macro1=##PBS-BIDID##¯o2=##PBS-APPBUNDLE##¯o3=##PBS-APPBUNDLE##¯o4=##PBS-PUBDOMAIN##¯o5=##PBS-PAGEURL##¯o6=##PBS-ACCOUNTID##¯o6=##PBS-LIMITADTRACKING##¯o7=##PBS-GDPRCONSENT##¯o8=##PBS-GDPRCONSENT##¯o9=##PBS-MACRO-CUSTOMMACR1CUST1##¯o10=##PBS-MACRO-CUSTOMMACR1CUST2##"},
},
)
ti.addImpressionTrackingEvent(&outputXML)
assert.Equal(t, tt.expected, outputXML.String(), tt.name)
})
}
}
func TestAddErrorTrackingEvent(t *testing.T) {
tests := []struct {
name string
addParentTag bool
expected string
}{
{
name: "Add impression tag",
addParentTag: true,
expected: "",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var outputXML strings.Builder
b := macros.NewProvider(reqWrapper)
b.PopulateBidMacros(&entities.PbsOrtbBid{
Bid: &openrtb2.Bid{
ID: "bid123",
},
}, "testSeat")
ti := NewTrackerInjector(
macros.NewStringIndexBasedReplacer(),
b,
VASTEvents{
Errors: []string{"http://errortracker.com?macro1=##PBS-BIDID##¯o2=##PBS-APPBUNDLE##¯o3=##PBS-APPBUNDLE##¯o4=##PBS-PUBDOMAIN##¯o5=##PBS-PAGEURL##¯o6=##PBS-ACCOUNTID##¯o6=##PBS-LIMITADTRACKING##¯o7=##PBS-GDPRCONSENT##¯o8=##PBS-GDPRCONSENT##¯o9=##PBS-MACRO-CUSTOMMACR1CUST1##¯o10=##PBS-MACRO-CUSTOMMACR1CUST2##"},
},
)
ti.addErrorTrackingEvent(&outputXML)
assert.Equal(t, tt.expected, outputXML.String(), tt.name)
})
}
}
func TestAddNonLinearClickTrackingEvent(t *testing.T) {
tests := []struct {
name string
addParentTag bool
expected string
}{
{
name: "With Parent Tag",
addParentTag: true,
expected: "",
},
{
name: "Without Parent Tag",
addParentTag: false,
expected: "",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var outputXML strings.Builder
b := macros.NewProvider(reqWrapper)
b.PopulateBidMacros(&entities.PbsOrtbBid{
Bid: &openrtb2.Bid{
ID: "bid123",
},
}, "testSeat")
ti := NewTrackerInjector(
macros.NewStringIndexBasedReplacer(),
b,
VASTEvents{
NonLinearClickTracking: []string{"http://nonlinearclicktracker.com?macro1=##PBS-BIDID##¯o2=##PBS-APPBUNDLE##¯o3=##PBS-APPBUNDLE##¯o4=##PBS-PUBDOMAIN##¯o5=##PBS-PAGEURL##¯o6=##PBS-ACCOUNTID##¯o6=##PBS-LIMITADTRACKING##¯o7=##PBS-GDPRCONSENT##¯o8=##PBS-GDPRCONSENT##¯o9=##PBS-MACRO-CUSTOMMACR1CUST1##¯o10=##PBS-MACRO-CUSTOMMACR1CUST2##"},
},
)
ti.addNonLinearClickTrackingEvent(&outputXML, "testCreativeId", tt.addParentTag)
assert.Equal(t, tt.expected, outputXML.String(), tt.name)
})
}
}
func TestAddCompanionClickThroughEvent(t *testing.T) {
tests := []struct {
name string
addParentTag bool
expected string
}{
{
name: "With Parent Tag",
addParentTag: true,
expected: "",
},
{
name: "Without Parent Tag",
addParentTag: false,
expected: "",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var outputXML strings.Builder
b := macros.NewProvider(reqWrapper)
b.PopulateBidMacros(&entities.PbsOrtbBid{
Bid: &openrtb2.Bid{
ID: "bid123",
},
}, "testSeat")
ti := NewTrackerInjector(
macros.NewStringIndexBasedReplacer(),
b,
VASTEvents{
CompanionClickThrough: []string{"http://companionclicktracker.com?macro1=##PBS-BIDID##¯o2=##PBS-APPBUNDLE##¯o3=##PBS-APPBUNDLE##¯o4=##PBS-PUBDOMAIN##¯o5=##PBS-PAGEURL##¯o6=##PBS-ACCOUNTID##¯o6=##PBS-LIMITADTRACKING##¯o7=##PBS-GDPRCONSENT##¯o8=##PBS-GDPRCONSENT##¯o9=##PBS-MACRO-CUSTOMMACR1CUST1##¯o10=##PBS-MACRO-CUSTOMMACR1CUST2##"},
},
)
ti.addCompanionClickThroughEvent(&outputXML, "testCreativeId", tt.addParentTag)
assert.Equal(t, tt.expected, outputXML.String(), tt.name)
})
}
}
func TestAddTrackingEvent(t *testing.T) {
tests := []struct {
name string
addParentTag bool
expected string
}{
{
name: "With Parent Tag",
addParentTag: true,
expected: "",
},
{
name: "Without Parent Tag",
addParentTag: false,
expected: "",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var outputXML strings.Builder
b := macros.NewProvider(reqWrapper)
b.PopulateBidMacros(&entities.PbsOrtbBid{
Bid: &openrtb2.Bid{
ID: "bid123",
},
}, "testSeat")
ti := NewTrackerInjector(
macros.NewStringIndexBasedReplacer(),
b,
VASTEvents{
TrackingEvents: map[string][]string{"firstQuartile": {"http://eventracker1.com?macro1=##PBS-BIDID##¯o2=##PBS-APPBUNDLE##¯o3=##PBS-APPBUNDLE##¯o4=##PBS-PUBDOMAIN##¯o5=##PBS-PAGEURL##¯o6=##PBS-ACCOUNTID##¯o6=##PBS-LIMITADTRACKING##¯o7=##PBS-GDPRCONSENT##¯o8=##PBS-GDPRCONSENT##¯o9=##PBS-MACRO-CUSTOMMACR1CUST1##¯o10=##PBS-MACRO-CUSTOMMACR1CUST2##"}},
},
)
ti.addTrackingEvent(&outputXML, "testCreativeId", tt.addParentTag)
assert.Equal(t, tt.expected, outputXML.String(), tt.name)
})
}
}
func TestWriteTrackingEvent(t *testing.T) {
tests := []struct {
name string
urls []string
startTag string
endTag string
creativeId string
eventType string
vastEvent string
expectedXML string
}{
{
name: "Single URL",
urls: []string{"http://tracker.com"},
startTag: "",
endTag: "",
creativeId: "123",
eventType: "start",
vastEvent: "tracking",
expectedXML: "http://tracker.com",
},
{
name: "Multiple URL",
urls: []string{"http://tracker1.com", "http://tracker2.com"},
startTag: "",
endTag: "",
creativeId: "123",
eventType: "start",
vastEvent: "tracking",
expectedXML: "http://tracker1.comhttp://tracker2.com",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var outputXML strings.Builder
b := macros.NewProvider(reqWrapper)
b.PopulateBidMacros(&entities.PbsOrtbBid{
Bid: &openrtb2.Bid{
ID: "bid123",
},
}, "testSeat")
ti := NewTrackerInjector(
macros.NewStringIndexBasedReplacer(),
b,
VASTEvents{
TrackingEvents: map[string][]string{"firstQuartile": {"http://eventracker1.com?macro1=##PBS-BIDID##¯o2=##PBS-APPBUNDLE##¯o3=##PBS-APPBUNDLE##¯o4=##PBS-PUBDOMAIN##¯o5=##PBS-PAGEURL##¯o6=##PBS-ACCOUNTID##¯o6=##PBS-LIMITADTRACKING##¯o7=##PBS-GDPRCONSENT##¯o8=##PBS-GDPRCONSENT##¯o9=##PBS-MACRO-CUSTOMMACR1CUST1##¯o10=##PBS-MACRO-CUSTOMMACR1CUST2##"}},
},
)
ti.writeTrackingEvent(tt.urls, &outputXML, tt.startTag, tt.endTag, tt.creativeId, tt.eventType, tt.vastEvent)
assert.Equal(t, tt.expectedXML, outputXML.String(), tt.name)
})
}
}