Reorganize test files & directories

test/unit/es6.mjs

@@ -0,0 +1,26 @@
+import { UAParser } from '../../src/main/ua-parser.mjs';
+import { CPU, Device, Engine } from '../../src/enums/ua-parser-enums.mjs';
+import * as assert from 'assert';
+
+describe('Returns', () => {
+    it('getResult() should returns object', () => {
+        assert.deepEqual(new UAParser('').getResult(), 
+            {
+                ua : '',
+                browser: { name: undefined, version: undefined, major: undefined, type: undefined },
+                cpu: { architecture: undefined },
+                device: { vendor: undefined, model: undefined, type: undefined },
+                engine: { name: undefined, version: undefined},
+                os: { name: undefined, version: undefined }
+        });
+    });
+});
+
+describe('Enums', () => {    
+    it('Can use enum', () => {
+        const { cpu, device, engine } = UAParser('Mozilla/5.0 (X11; U; Linux armv7l; en-GB; rv:1.9.2a1pre) Gecko/20090928 Firefox/3.5 Maemo Browser 1.4.1.22 RX-51 N900');
+        assert.strictEqual(cpu.is(CPU.ARM), true);
+        assert.strictEqual(device.is(Device.MOBILE), true);
+        assert.strictEqual(engine.is(Engine.GECKO), true);
+    });
+});

test/unit/extensions.js

@@ -0,0 +1,95 @@
+const fs = require('fs');
+const assert = require('assert');
+const parseJS = require('@babel/parser').parse;
+const traverse = require('@babel/traverse').default;
+const safe = require('safe-regex');
+const { UAParser } = require('../../src/main/ua-parser');
+const clis = require('../data/ua/extension/cli.json');
+const crawlers = require('../data/ua/extension/crawler.json');
+const emails = require('../data/ua/extension/email.json');
+const fetchers = require('../data/ua/extension/fetcher.json');
+const libraries = require('../data/ua/extension/library.json');
+const { Bots, CLIs, Crawlers, Emails, Fetchers, Libraries } = require('../../src/extensions/ua-parser-extensions');
+
+describe('Extensions', () => {
+    [   
+        ['CLIs', clis, CLIs], 
+        ['Crawlers', crawlers, Crawlers], 
+        ['Emails', emails, Emails], 
+        ['Fetchers', fetchers, Fetchers],
+        ['Libraries', libraries, Libraries]
+    ]
+    .forEach((list) => {
+        describe(list[0], () => {
+            list[1].forEach((agent) => {
+                it(`Can detect ${agent.desc}: "${agent.ua}"`, () => {
+                    let browser = UAParser(agent.ua, list[2]).browser;
+                    assert.strictEqual(String(browser.name), agent.expect.name);
+                    assert.strictEqual(String(browser.version), agent.expect.version);
+                    assert.strictEqual(String(browser.type), agent.expect.type);
+                });
+            });
+        });
+    });
+
+    const outlook = 'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 10.0; WOW64; Trident/7.0; .NET4.0C; .NET4.0E; .NET CLR 2.0.50727; .NET CLR 3.0.30729; .NET CLR 3.5.30729; Microsoft Outlook 16.0.9126; Microsoft Outlook 16.0.9126; ms-office; MSOffice 16)';
+    const thunderbird = 'Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.13.0';
+    const axios = 'axios/1.3.5';
+    const jsdom = 'Mozilla/5.0 (darwin) AppleWebKit/537.36 (KHTML, like Gecko) jsdom/20.0.3';
+    const scrapy = 'Scrapy/1.5.0 (+https://scrapy.org)';
+
+    assert.equal(UAParser(scrapy, Bots).browser.name, 'Scrapy');
+
+    const emailParser = new UAParser(Emails);
+    assert.deepEqual(emailParser.setUA(outlook).getBrowser(), {name: "Microsoft Outlook", version: "16.0.9126", major: "16", type: "email"});
+    assert.deepEqual(emailParser.setUA(thunderbird).getBrowser(), {name: "Thunderbird", version: "78.13.0", major: "78", type: "email"});
+
+    const libraryParser = new UAParser(Libraries);
+    assert.deepEqual(libraryParser.setUA(axios).getBrowser(), {name: "axios", version: "1.3.5", major: "1", type: "library"});
+    assert.deepEqual(libraryParser.setUA(jsdom).getBrowser(), {name: "jsdom", version: "20.0.3", major: "20", type: "library"});
+    assert.deepEqual(libraryParser.setUA(scrapy).getBrowser(), {name: "Scrapy", version: "1.5.0", major: "1", type: "library"});
+});
+
+describe('Merge', () => {
+    it('Can merge multiple extensions', () => {
+        const wget = 'Wget/1.21.1';
+        const facebookBot = 'Mozilla/5.0 (compatible; FacebookBot/1.0; +https://developers.facebook.com/docs/sharing/webmasters/facebookbot/)';
+
+        // try merging crawlers & CLIs
+        const crawlersAndCLIs = { browser : [...Crawlers.browser, ...CLIs.browser]};
+        const crawlersAndCLIsParser = new UAParser(crawlersAndCLIs);
+        assert.deepEqual(crawlersAndCLIsParser.setUA(wget).getBrowser(), {name: "Wget", version: "1.21.1", major: "1", type:"cli"});
+        assert.deepEqual(crawlersAndCLIsParser.setUA(facebookBot).getBrowser(), {name: "FacebookBot", version: "1.0", major: "1", type:"crawler"});
+
+        // alternative merge options
+        const crawlersAndCLIsParser2 = new UAParser([Crawlers, CLIs]);
+        const crawlersAndCLIsParser3 = new UAParser(facebookBot, [Crawlers, CLIs]);
+        assert.deepEqual(crawlersAndCLIsParser2.setUA(wget).getBrowser(), {name: "Wget", version: "1.21.1", major: "1", type:"cli"});
+        assert.deepEqual(crawlersAndCLIsParser3.getBrowser(), {name: "FacebookBot", version: "1.0", major: "1", type:"crawler"});
+    });
+});
+
+describe('Testing the safety of regexes', () => {
+
+    let regexes;
+    let code = fs.readFileSync('src/extensions/ua-parser-extensions.js', 'utf8').toString();
+    let ast = parseJS(code, { sourceType: 'script' });
+    regexes = [];
+    traverse(ast, {
+        RegExpLiteral: (path) => {
+            regexes.push(path.node.pattern);
+        }
+    });
+
+    if (regexes.length === 0) {
+        throw new Error('Regexes cannot be empty!');
+    }
+
+    describe('Checking for potentially vulnerable regex', () => {
+        for (let regex of regexes) {
+            it('Test against `safe-regex` : ' + regex, () => {
+                assert.strictEqual(safe(regex), true);
+            });
+        }
+    });
+});

test/unit/helpers.js

@@ -0,0 +1,84 @@
+const assert = require('assert');
+const { UAParser } = require('../../src/main/ua-parser');
+const { getDeviceVendor, isAppleSilicon, isAIBot, isBot, isChromeFamily } = require('../../src/helpers/ua-parser-helpers');
+const { Bots, Emails } = require('../../src/extensions/ua-parser-extensions');
+
+describe('getDeviceVendor', () => {
+    it('Can guess the device vendor from a model name', () => {
+        
+        const modelSM = 'SM-A605G';
+        const modelRedmi = 'Redmi Note 8';
+        const modelNexus = 'Nexus 6P';
+        const modelQuest = 'Quest 3';
+        const modelAquos = 'AQUOS-TVX19B';
+
+        assert.equal(getDeviceVendor(modelSM), 'Samsung');
+        assert.equal(getDeviceVendor(modelRedmi), 'Xiaomi');
+        assert.equal(getDeviceVendor(modelNexus), 'Huawei');
+        assert.equal(getDeviceVendor(modelQuest), 'Facebook');
+        assert.equal(getDeviceVendor(modelAquos), 'Sharp');
+    });
+});
+
+describe('isAppleSilicon', () => {
+    it('Can detect Apple Silicon device', () => {
+        
+        // non-real ua
+        const macARM = 'Mozilla/5.0 (Macintosh; ARM; Mac OS X 10.15; rv:97.0) Gecko/20100101 Firefox/97.0';
+        const macIntel = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:97.0) Gecko/20100101 Firefox/97.0';
+
+        assert.equal(isAppleSilicon(UAParser(macIntel)), false);
+        assert.equal(isAppleSilicon(macIntel), false);
+        assert.equal(isAppleSilicon(UAParser(macARM)), true);
+        assert.equal(isAppleSilicon(macARM), true);
+    });
+});
+
+describe('isAIBot', () => {
+    it('Can detect AI Bots', () => {
+        
+        const claudeBot = 'Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)';
+        const firefox = 'Mozilla/5.0 (X11; Linux x86_64; rv:109.0) Gecko/20100101 Firefox/111.0';
+        const searchGPT = 'Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko); compatible; OAI-SearchBot/1.0; +https://openai.com/searchbot';
+
+        assert.equal(isAIBot(UAParser(claudeBot, Bots)), true);
+        assert.equal(isAIBot(claudeBot), true);
+        assert.equal(isAIBot(firefox), false);
+        assert.equal(isAIBot(searchGPT), true);
+    });
+});
+
+describe('isBot', () => {
+    it('Can detect Bots', () => {
+        
+        // non-real ua
+        const ahrefsBot = 'Mozilla/5.0 (compatible; AhrefsBot/7.0; +http://ahrefs.com/robot/)';
+        const firefox = 'Mozilla/5.0 (X11; Linux x86_64; rv:109.0) Gecko/20100101 Firefox/111.0';
+        const scrapy = 'Scrapy/1.5.0 (+https://scrapy.org)';
+        const thunderbird = 'Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.13.0';
+
+        const botParser = new UAParser(firefox, { Bots, Emails });
+        assert.equal(isBot(botParser.getResult()), false);
+        assert.equal(isBot(botParser.setUA(ahrefsBot).getResult()), true);
+        assert.equal(isBot(botParser.setUA(scrapy).getResult()), true);
+        assert.equal(isBot(botParser.setUA(thunderbird).getResult()), false);
+
+        assert.equal(isBot(ahrefsBot), true);
+        assert.equal(isBot(firefox), false);
+        assert.equal(isBot(scrapy), true);
+        assert.equal(isBot(thunderbird), false);
+    });
+});
+
+describe('isChromeFamily', () => {
+    it('Can detect Chromium-based browser', () => {
+        
+        const edge = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36 Edg/119.0.2151.58';
+        const firefox = 'Mozilla/5.0 (X11; Linux x86_64; rv:109.0) Gecko/20100101 Firefox/111.0';
+
+        assert.equal(isChromeFamily(UAParser(edge)), true);
+        assert.equal(isChromeFamily(UAParser(firefox)), false);
+        assert.equal(isChromeFamily(edge), true);
+        assert.equal(isChromeFamily(firefox), false);
+    });
+});