def test_validate_data_false(self):
"""!
Validate whether has_value returns correctly with invalid evidence
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.evidence.add("header.user-agent", "")
fd.process()
properties = fd.pipeline.get_element("device").get_properties()
for engine_property in properties:
data_property = fd.device.get(engine_property)
if properties[engine_property]["category"] == "Device metrics":
self.assertEqual(data_property.has_value(), True)
elif engine_property == "deviceid":
self.assertEqual(fd.device.deviceid.value(), "0-0-0-0")
else:
self.assertEqual(data_property.has_value(), False)
def test_engine_init_performance(self):
"""!
Test how long it takes for the engine to be initialised
by looking at the metadata dictionary created on init
"""
start = time.time()
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.evidence.add("header.user-agent", mobile_ua)
fd.process()
properties = fd.pipeline.get_element("device").get_properties()
for engine_property in properties:
self.assertNotEqual(fd.device.get(engine_property), None)
end = time.time()
total = end - start
self.assertLess(total, 1)
def test_excluded_property(self):
"""!
Test error if accessing property that has been restricted
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file,
licence_keys="",
restricted_properties=["ismobile"]).build()
fd = pipeline.create_flowdata()
fd.evidence.add("header.User-Agent", mobile_ua)
fd.process()
result = ""
try:
fd.device.get("screenpixelsheight")
except Exception as e:
result = str(e)
self.assertEqual(
result, "Property screenpixelsheight was excluded from device")
def test_missing_property_service_not_found_anywhere(self):
"""!
Trigger the missing property service by requesting a property
not available in any datafile
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.evidence.add("header.User-Agent", mobile_ua)
fd.process()
result = ""
try:
fd.device.get("notpresent")
except Exception as e:
result = str(e)
self.assertEqual(
result,
"Property notpresent not found in data for element device. Please check that the element and property names are correct."
)
def test_missing_property_service_not_found_in_current(self):
"""!
Trigger the missing property service by requesting a property
not available in the current datafile
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.evidence.add("header.User-Agent", mobile_ua)
# Add mock property not in datafile
pipeline.get_element("device").properties["mock"] = {
"datafiles": ["Enterprise"]
}
fd.process()
result = ""
try:
fd.device.get("mock")
except Exception as e:
result = str(e)
self.assertEqual(
result,
"Property mock not found in data for element device. This is because your datafile does not contain the property. The property is available in['Enterprise']"
)
def test_engine_reload(self):
"""!
Refresh the engine
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.process()
fd.pipeline.get_element("device").engine.refreshData()
def test_process_with_no_evidence(self):
"""!
Process a FlowData which does not have any evidence. This should not throw an error and all 51Degrees engines should set the default aspect properties
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.process()
self.assertTrue(fd.device.difference.has_value())
def test_device_id(self):
"""!
Test profile overrides with device ids
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.evidence.add("header.User-Agent", mobile_ua)
fd.process()
self.assertEqual(fd.device.deviceid.value(), "12280-81243-82102-0")
def test_profile_overrides_deviceid(self):
"""!
Test profile overrides with device ids
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.evidence.add("query.51D_ProfileIds", "12280-17779-17470-18092")
fd.process()
self.assertEqual(fd.device.deviceid.value(), "12280-17779-17470-18092")
def test_case_insensitive_evidence_keys(self):
"""!
Process a FlowData with case insensitive evidence keys
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.evidence.add("header.User-Agent", mobile_ua)
fd.process()
self.assertTrue(fd.device.ismobile.value())
def test_process_with_no_useful_headers(self):
"""!
Process a FlowData with no useful headers
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.evidence.add("header.irrelevant", "some-evidence")
fd.process()
self.assertFalse(fd.device.ismobile.has_value())
def test_process_with_empty_user_agent(self):
"""!
Process a FlowData with an empty user agent
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.evidence.add("header.user-agent", "")
fd.process()
self.assertFalse(fd.device.ismobile.has_value())
def test_has_value_false(self):
"""!
Test aspect property value returns false for has value
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.evidence.add("header.user-agent", "nothing")
fd.process()
self.assertFalse(fd.device.ismobile.has_value())
def test_basic_get_onpremise(self):
"""!
Check property lookup works
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.evidence.add("header.user-agent", mobile_ua)
fd.process()
self.assertTrue(fd.device.ismobile.value())
def test_matched_user_agents(self):
"""!
Test aspect property value returns false for has value
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.evidence.add("header.user-agent", mobile_ua)
fd.process()
self.assertEqual(fd.device.useragents.value(), 1)
def test_pipeline_builder_shareusage_init(self):
"""!
Tests whether the device detection pipeline builder adds the usage sharing engine when initialised with a datafile
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, licence_keys="").build()
self.assertTrue(pipeline.flow_elements[0].datakey == "shareusage")
def test_available_properties(self):
"""!
Test properties that come back from getProperties actually exist in engine
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.evidence.add("header.user-agent", mobile_ua)
fd.process()
properties = fd.pipeline.get_element("device").get_properties()
for engine_property in properties:
self.assertNotEqual(fd.device.get(engine_property), None)
def test_value_types(self):
"""!
Test type is returned correctly for property
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.evidence.add("header.user-agent", mobile_ua)
fd.process()
ismobile = fd.pipeline.get_element(
"device").get_properties()["ismobile"]
self.assertEqual(ismobile["type"],
type(fd.device.ismobile.value()).__name__)
def test_properties_onpremise(self):
"""!
Tests whether a properties list is created on the on
premise engine
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
properties = pipeline.flow_elements[0].get_properties()
self.assertTrue(len(properties.keys()) > 0)
def test_evidencekey_filter_contains_device_stock_ua(self):
"""!
Test if evidence key filter with header.device-stock-ua
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
evidence_key_filter = pipeline.flow_elements[
0].get_evidence_key_filter()
self.assertTrue(
evidence_key_filter.filter_evidence_key("header.device-stock-ua"))
def test_on_premise_engine_datafile(self):
"""!
Tests whether a datafile (for the update service) is added when auto_update is set
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file,
usage_sharing=False,
licence_keys="test",
auto_update=True).build()
self.assertTrue(
isinstance(pipeline.flow_elements[0].data_file,
DeviceDetectionDataFile))
def test_evidencekey_filter_onpremise(self):
"""!
Tests whether the on premise evidence key filter works
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
evidence_key_filter = pipeline.flow_elements[
0].get_evidence_key_filter()
self.assertFalse(evidence_key_filter.filter_evidence_key("test.test"))
self.assertTrue(
evidence_key_filter.filter_evidence_key("header.user-agent"))
def test_no_element_exists(self):
"""!
Access flow element that doesn't exist in pipeline
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
fd = pipeline.create_flowdata()
fd.process()
message = ""
try:
message = fd.devisce
except Exception as e:
message = str(e)
self.assertEqual(
message,
"There is no element data for devisce against this flow data. Available element data keys are: ['device']"
)
def test_evidencekey_filter_overrides(self):
"""!
Test evidence key filter with overrides in cookies and query string
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
evidence_key_filter = pipeline.flow_elements[
0].get_evidence_key_filter()
self.assertTrue(
evidence_key_filter.filter_evidence_key("query.51d_profileids"))
self.assertTrue(
evidence_key_filter.filter_evidence_key("cookie.51d_profileids"))
def test_mass_user_agent_processing_results(self):
"""!
Test the 20,000 user agent process results are correct
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file,
usage_sharing=False,
licence_keys="",
performance_profile='MaxPerformance',
add_javascript_builder=False,
restricted_properties=["ismobile"]).build()
results = self.process_user_agent_list(pipeline)
self.assertEqual(results["mobile"], 14434)
self.assertEqual(results["not_mobile"], 5529)
self.assertEqual(results["unknown"], 37)
def test_evidencekey_filter_case_insensitive_keys(self):
"""!
Test evidence key filter with case insensitive keys
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file, usage_sharing=False,
licence_keys="").build()
evidence_key_filter = pipeline.flow_elements[
0].get_evidence_key_filter()
self.assertTrue(
evidence_key_filter.filter_evidence_key("header.User-Agent"))
self.assertTrue(
evidence_key_filter.filter_evidence_key("header.user-agent"))
self.assertTrue(
evidence_key_filter.filter_evidence_key("header.USER-AGENT"))
self.assertTrue(
evidence_key_filter.filter_evidence_key("HEADER.USER-AGENT"))
def test_benchmark_balanced(self):
"""!
Benchmark using balanced
"""
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file,
usage_sharing=False,
licence_keys="",
performance_profile='Balanced',
add_javascript_builder=False,
restricted_properties=["ismobile"]).build()
start = time.time()
results = self.process_user_agent_list(pipeline)
end = time.time()
total = end - start
self.assertEqual(results["mobile"], 14434)
self.assertEqual(results["not_mobile"], 5529)
self.assertEqual(results["unknown"], 37)
# true
# Does user agent Mozilla/5.0 (iPhone; CPU iPhone OS 11_2 like Mac OS X) AppleWebKit/604.4.7 (KHTML, like Gecko) Mobile/15C114 support supportswebgl? :
# true
#
# ```
from fiftyone_devicedetection_onpremise.devicedetection_onpremise_pipelinebuilder import DeviceDetectionOnPremisePipelineBuilder
# First create the device detection pipeline with the desired settings.
data_file = "fiftyone_devicedetection_onpremise/device-detection-cxx/device-detection-data/51Degrees-LiteV4.1.hash"
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path = data_file,
licence_keys = "",
performance_profile = 'MaxPerformance',
auto_update=False).build()
# Now we see what properties are available in the pipeline
properties = pipeline.get_properties()
# Now we find out the details of the properties in the device engine
for property_key, property_meta in properties["device"].items():
print(property_key + " of category " + property_meta["category"])
# Now we can take a User-Agent, run it through this pipeline and check
# the supported media properties against it
import time
import multiprocessing as mp
# This example goes through a CSV of 20000 user agents and processes them,
# saving whether each one is a mobile, not, or unknown to a csv file
from fiftyone_devicedetection_onpremise.devicedetection_onpremise_pipelinebuilder import DeviceDetectionOnPremisePipelineBuilder
# First we create the device detection pipeline with the desired settings.
data_file = "fiftyone_devicedetection_onpremise/device-detection-cxx/device-detection-data/51Degrees-LiteV4.1.hash"
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file,
licence_keys="",
performance_profile='MaxPerformance',
add_javascript_builder = False,
restricted_properties = ["ismobile"],
usage_sharing=False,
auto_update=False).build()
# Here we make a function that processes a user agent
# And returns if it is a mobile device
def process_user_agent(user_agent):
# First we create the flowdata using the global pipeline
flowdata = pipeline.create_flowdata()
# Here we add the user agent as evidence
flowdata.evidence.add("header.user-agent", user_agent)
from flask.helpers import make_response
from fiftyone_devicedetection_onpremise.devicedetection_onpremise_pipelinebuilder import DeviceDetectionOnPremisePipelineBuilder
from fiftyone_pipeline_core.web import *
import json
# First create the device detection pipeline with the desired settings.
data_file = "../fiftyone_devicedetection_onpremise/device-detection-cxx/device-detection-data/51Degrees-LiteV4.1.hash"
# Here we add some callback settings for the page to make a request with extra evidence from the client side, in this case the Flask /json route we will make below
javascript_builder_settings = {"endpoint": "/json"}
pipeline = DeviceDetectionOnPremisePipelineBuilder(
data_file_path=data_file,
licence_keys="",
performance_profile='MaxPerformance',
update_on_start=False,
javascript_builder_settings=javascript_builder_settings).build()
from flask import Flask, request
app = Flask(__name__)
# First we make a JSON route that will be called from the client side and will
# return a JSON encoded property database using any additional evidence provided
# by the client
@app.route('/json', methods=['POST'])
def jsonroute():