Test: Rule Engine

src/test/groovy/org/prebid/server/functional/model/ModuleName.groovy

@@ -8,6 +8,7 @@ enum ModuleName {
     PB_RESPONSE_CORRECTION ("pb-response-correction"),
     ORTB2_BLOCKING("ortb2-blocking"),
     PB_REQUEST_CORRECTION('pb-request-correction'),
+    PB_RULE_ENGINE('pb-rule-engine')
 
     @JsonValue
     final String code

src/test/groovy/org/prebid/server/functional/model/config/ModuleHookImplementation.groovy

@@ -11,6 +11,7 @@ enum ModuleHookImplementation {
     ORTB2_BLOCKING_BIDDER_REQUEST("ortb2-blocking-bidder-request"),
     ORTB2_BLOCKING_RAW_BIDDER_RESPONSE("ortb2-blocking-raw-bidder-response"),
     PB_REQUEST_CORRECTION_PROCESSED_AUCTION_REQUEST("pb-request-correction-processed-auction-request"),
+    PB_RULES_ENGINE_PROCESSED_AUCTION_REQUEST("pb-rule-engine-processed-auction-request")
 
     @JsonValue
     final String code

src/test/groovy/org/prebid/server/functional/model/config/PbRulesEngine.groovy

@@ -0,0 +1,19 @@
+package org.prebid.server.functional.model.config
+
+import java.time.ZonedDateTime
+
+class PbRulesEngine {
+
+    Boolean enabled
+    Boolean generateRulesFromBidderConfig
+    ZonedDateTime timestamp
+    List<RuleSet> ruleSets
+
+    static PbRulesEngine createRulesEngineWithRule(Boolean enabled = true) {
+        new PbRulesEngine().tap {
+            it.enabled = enabled
+            it.generateRulesFromBidderConfig = false
+            it.ruleSets = [RuleSet.createRuleSets()]
+        }
+    }
+}

src/test/groovy/org/prebid/server/functional/model/config/PbsModulesConfig.groovy

@@ -13,4 +13,5 @@ class PbsModulesConfig {
     Ortb2BlockingConfig ortb2Blocking
     PbResponseCorrection pbResponseCorrection
     PbRequestCorrectionConfig pbRequestCorrection
+    PbRulesEngine pbRuleEngine
 }

src/test/groovy/org/prebid/server/functional/model/config/ResultFunction.groovy

@@ -0,0 +1,22 @@
+package org.prebid.server.functional.model.config
+
+import com.fasterxml.jackson.annotation.JsonValue
+
+enum ResultFunction {
+
+    INCLUDE_BIDDERS("includeBidders"),
+    EXCLUDE_BIDDER("excludeBidders"),
+    LOG_A_TAG("logAtag")
+
+    String value
+
+    ResultFunction(String value) {
+        this.value = value
+    }
+
+    @Override
+    @JsonValue
+    String toString() {
+        return value
+    }
+}

src/test/groovy/org/prebid/server/functional/model/config/RuleEngineArguments.groovy

@@ -0,0 +1,11 @@
+package org.prebid.server.functional.model.config
+
+import org.prebid.server.functional.model.bidder.BidderName
+
+class RuleEngineArguments {
+
+    List<BidderName> bidders
+    Integer seatNonBid
+    Boolean ifSyncedId
+    String analyticsValue
+}

src/test/groovy/org/prebid/server/functional/model/config/RuleEngineFunction.groovy

@@ -0,0 +1,44 @@
+package org.prebid.server.functional.model.config
+
+import com.fasterxml.jackson.annotation.JsonValue
+
+enum RuleEngineFunction {
+
+    DEVICE_COUNTRY("deviceCountry", null),
+    DEVICE_COUNTRY_IN("deviceCountryIn", "countries"),
+    DATA_CENTER("dataCenter", null),
+    DATA_CENTER_IN("dataCenterIn", "datacenters"),
+    CHANNEL("channel", null),
+    EID_AVAILABLE("eidAvailable", null),
+    EID_IN("eidIn", "sources"),
+    USER_FPD_AVAILABLE("userFpdAvailable", null),
+    FPD_AVAILABLE("fpdAvailable", null),
+    GPP_SID_AVAILABLE("gppSidAvailable", null),
+    GPP_SID_IN("gppSidIn", "sids"),
+    TCF_IN_SCOPE("tcfInScope", null),
+    PERCENT("percent", "pct"),
+    PREBID_KEY("prebidKey", "key"),
+    DOMAIN("domain", null),
+    DOMAIN_IN("domainIn", "domains"),
+    BUNDLE("bundle", null),
+    BUNDLE_IN("bundleIn", "bundles"),
+    MEDIA_TYPE_IN("mediaTypeIn", "types"),
+    AD_UNIT_CODE("adUnitCode", null),
+    AD_UNIT_CODE_IN("adUnitCodeIn", "codes"),
+    DEVICE_TYPE("deviceType", null),
+    DEVICE_TYPE_IN("deviceTypeIn", "types")
+
+    private String value
+    private String fieldName
+
+    RuleEngineFunction(String value, String fieldName) {
+        this.value = value
+        this.fieldName = fieldName
+    }
+
+    @JsonValue
+    @Override
+    String toString() {
+        return value
+    }
+}

src/test/groovy/org/prebid/server/functional/model/config/RuleEngineFunctionArgs.groovy

@@ -0,0 +1,37 @@
+package org.prebid.server.functional.model.config
+
+import com.fasterxml.jackson.annotation.JsonProperty
+import org.prebid.server.functional.util.PBSUtils
+
+class RuleEngineFunctionArgs {
+
+    List<Object> countries
+    List<Object> datacenters
+    List<Object> sources
+    List<Object> sids
+    @JsonProperty("pct")
+    Object percent
+    Object key
+    List<Object> domains
+    List<Object> bundles
+    List<Object> codes
+    List<Object> types
+    String operator
+    BigDecimal value
+    Currency currency
+
+    static RuleEngineFunctionArgs getDefaultFunctionArgs() {
+        new RuleEngineFunctionArgs().tap {
+            countries = [PBSUtils.randomString]
+            datacenters = [PBSUtils.randomString]
+            sources = [PBSUtils.randomString]
+            sids = [PBSUtils.randomNumber]
+            percent = PBSUtils.getRandomNumber(1, 100)
+            key = PBSUtils.randomString
+            domains = [PBSUtils.randomString]
+            bundles = [PBSUtils.randomString]
+            codes = [PBSUtils.randomString]
+            types = [PBSUtils.randomString]
+        }
+    }
+}

src/test/groovy/org/prebid/server/functional/model/config/RuleEngineModelDefault.groovy

@@ -0,0 +1,7 @@
+package org.prebid.server.functional.model.config
+
+class RuleEngineModelDefault {
+
+    ResultFunction function
+    RuleEngineModelDefaultArgs args
+}

src/test/groovy/org/prebid/server/functional/model/config/RuleEngineModelDefaultArgs.groovy

@@ -0,0 +1,6 @@
+package org.prebid.server.functional.model.config
+
+class RuleEngineModelDefaultArgs {
+
+    String analyticsValue
+}

src/test/groovy/org/prebid/server/functional/model/config/RuleEngineModelRule.groovy

@@ -0,0 +1,17 @@
+package org.prebid.server.functional.model.config
+
+import static java.lang.Boolean.TRUE
+import static org.prebid.server.functional.model.config.RuleEngineModelRuleResult.createRuleEngineModelRuleWithExcludeResult
+
+class RuleEngineModelRule {
+
+    List<String> conditions
+    List<RuleEngineModelRuleResult> results
+
+    static RuleEngineModelRule createRuleEngineModelRule() {
+        new RuleEngineModelRule().tap {
+            it.conditions = [TRUE as String]
+            it.results = [createRuleEngineModelRuleWithExcludeResult()]
+        }
+    }
+}

src/test/groovy/org/prebid/server/functional/model/config/RuleEngineModelRuleResult.groovy

@@ -0,0 +1,38 @@
+package org.prebid.server.functional.model.config
+
+import org.prebid.server.functional.model.bidder.BidderName
+
+import static org.prebid.server.functional.model.bidder.BidderName.ACEEX
+import static org.prebid.server.functional.model.bidder.BidderName.OPENX
+import static org.prebid.server.functional.model.config.ResultFunction.EXCLUDE_BIDDER
+import static org.prebid.server.functional.model.config.ResultFunction.INCLUDE_BIDDERS
+import static org.prebid.server.functional.model.config.ResultFunction.LOG_A_TAG
+
+class RuleEngineModelRuleResult {
+
+    ResultFunction function
+    RuleEngineModelRuleResultsArgs args
+
+    static RuleEngineModelRuleResult createRuleEngineModelRuleWithIncludeResult(BidderName bidderName = ACEEX,
+                                                                                Boolean ifSyncedId = false) {
+        new RuleEngineModelRuleResult().tap {
+            it.function = INCLUDE_BIDDERS
+            it.args = RuleEngineModelRuleResultsArgs.createRuleEngineModelRuleResultsArgs(bidderName, ifSyncedId)
+        }
+    }
+
+    static RuleEngineModelRuleResult createRuleEngineModelRuleWithExcludeResult(BidderName bidderName = OPENX,
+                                                                                Boolean ifSyncedId = false) {
+        new RuleEngineModelRuleResult().tap {
+            it.function = EXCLUDE_BIDDER
+            it.args = RuleEngineModelRuleResultsArgs.createRuleEngineModelRuleResultsArgs(bidderName, ifSyncedId)
+        }
+    }
+
+    static RuleEngineModelRuleResult createRuleEngineModelRuleWithLogATagResult() {
+        new RuleEngineModelRuleResult().tap {
+            it.function = LOG_A_TAG
+            it.args = RuleEngineModelRuleResultsArgs.createRuleEngineModelRuleResultsArgsOnlyATag()
+        }
+    }
+}

src/test/groovy/org/prebid/server/functional/model/config/RuleEngineModelRuleResultsArgs.groovy

@@ -0,0 +1,31 @@
+package org.prebid.server.functional.model.config
+
+import com.fasterxml.jackson.annotation.JsonProperty
+import org.prebid.server.functional.model.bidder.BidderName
+import org.prebid.server.functional.model.response.auction.BidRejectionReason
+import org.prebid.server.functional.util.PBSUtils
+
+class RuleEngineModelRuleResultsArgs {
+
+    List<BidderName> bidders
+    @JsonProperty("seatnonbid")
+    BidRejectionReason seatNonBid
+    @JsonProperty("analyticsValue")
+    String analyticsValue
+    @JsonProperty("ifSyncedId")
+    Boolean ifSyncedId
+
+    static RuleEngineModelRuleResultsArgs createRuleEngineModelRuleResultsArgs(BidderName bidderName, Boolean ifSyncedId) {
+        new RuleEngineModelRuleResultsArgs().tap {
+            it.bidders = [bidderName]
+            it.analyticsValue = PBSUtils.randomString
+            it.ifSyncedId = ifSyncedId
+        }
+    }
+
+    static RuleEngineModelRuleResultsArgs createRuleEngineModelRuleResultsArgsOnlyATag() {
+        new RuleEngineModelRuleResultsArgs().tap {
+            it.analyticsValue = PBSUtils.randomString
+        }
+    }
+}

src/test/groovy/org/prebid/server/functional/model/config/RuleEngineModelSchema.groovy

@@ -0,0 +1,20 @@
+package org.prebid.server.functional.model.config
+
+import groovy.transform.ToString
+
+import static org.prebid.server.functional.model.config.RuleEngineFunction.DEVICE_COUNTRY_IN
+import static org.prebid.server.functional.model.pricefloors.Country.USA
+
+@ToString(includeNames = true, ignoreNulls = true)
+class RuleEngineModelSchema {
+
+    RuleEngineFunction function
+    RuleEngineFunctionArgs args
+
+    static RuleEngineModelSchema createDeviceCountryInSchema(List<Object> argsCountries = [USA]) {
+        new RuleEngineModelSchema().tap {
+            it.function = DEVICE_COUNTRY_IN
+            it.args = new RuleEngineFunctionArgs(countries: argsCountries)
+        }
+    }
+}

src/test/groovy/org/prebid/server/functional/model/config/RuleSet.groovy

@@ -0,0 +1,23 @@
+package org.prebid.server.functional.model.config
+
+import static org.prebid.server.functional.model.config.Stage.PROCESSED_AUCTION_REQUEST
+import static org.prebid.server.functional.util.PBSUtils.randomString
+
+class RuleSet {
+
+    Boolean enabled
+    Stage stage
+    String name
+    String version
+    List<RulesEngineModelGroup> modelGroups
+
+    static RuleSet createRuleSets() {
+        new RuleSet().tap {
+            it.enabled = true
+            it.stage = PROCESSED_AUCTION_REQUEST
+            it.name = randomString
+            it.version = randomString
+            it.modelGroups = [RulesEngineModelGroup.createRulesModuleGroup()]
+        }
+    }
+}

src/test/groovy/org/prebid/server/functional/model/config/RulesEngineModelGroup.groovy

@@ -0,0 +1,29 @@
+package org.prebid.server.functional.model.config
+
+import com.fasterxml.jackson.annotation.JsonProperty
+import org.prebid.server.functional.util.PBSUtils
+
+import static org.prebid.server.functional.model.config.RuleEngineModelRule.createRuleEngineModelRule
+import static org.prebid.server.functional.model.config.RuleEngineModelSchema.createDeviceCountryInSchema
+
+class RulesEngineModelGroup {
+
+    Integer weight
+    String version
+    String analyticsKey
+    List<RuleEngineModelSchema> schema
+    @JsonProperty("default")
+    List<RuleEngineModelDefault> modelDefault
+    List<RuleEngineModelRule> rules
+
+    static RulesEngineModelGroup createRulesModuleGroup() {
+        new RulesEngineModelGroup().tap {
+            it.weight = PBSUtils.getRandomNumber(1, 100)
+            it.version = PBSUtils.randomString
+            it.analyticsKey = PBSUtils.randomString
+            it.schema = [createDeviceCountryInSchema()]
+            it.modelDefault = []
+            it.rules = [createRuleEngineModelRule()]
+        }
+    }
+}

src/test/groovy/org/prebid/server/functional/model/request/auction/Device.groovy

@@ -13,7 +13,7 @@ class Device {
     UserAgent sua
     String ip
     String ipv6
-    Integer devicetype
+    DeviceType devicetype
     String make
     String model
     String os

src/test/groovy/org/prebid/server/functional/model/request/auction/DeviceType.groovy

@@ -0,0 +1,22 @@
+package org.prebid.server.functional.model.request.auction
+
+import com.fasterxml.jackson.annotation.JsonValue
+
+enum DeviceType {
+
+    MOBILE_TABLET_GENERAL(1),
+    PERSONAL_COMPUTER(2),
+    CONNECTED_TV(3),
+    PHONE(4),
+    TABLET(5),
+    CONNECTED_DEVICE(6),
+    SET_TOP_BOX(7),
+    OOH_DEVICE(8)
+
+    @JsonValue
+    final Integer value
+
+    DeviceType(Integer value) {
+        this.value = value
+    }
+}

src/test/groovy/org/prebid/server/functional/model/request/auction/ImpUnitCode.groovy

@@ -0,0 +1,10 @@
+package org.prebid.server.functional.model.request.auction
+
+enum ImpUnitCode {
+
+    TAG_ID,
+    GPID,
+    PB_AD_SLOT,
+    STORED_REQUEST
+}
+

src/test/groovy/org/prebid/server/functional/model/request/auction/Prebid.groovy

@@ -47,6 +47,8 @@ class Prebid {
     AlternateBidderCodes alternateBidderCodes
     @JsonProperty("profiles")
     List<String> profileNames
+    @JsonProperty("kvps")
+    Map<String, String> keyValuePairs
 
     static class Channel {