bem-bench

Инструмент позволяет выполнять регрессионное тестирование производительности BEMHTML и BH шаблонов, сравнивая скорость выполнения шаблонов между указанными ревизиями проекта и текущей рабочей копией.

Инструмент позволяет выполнять регрессионное тестирование производительности BEMHTML и BH шаблонов, сравнивая скорость выполнения шаблонов между указанными ревизиями проекта и текущей рабочей копией.

Результатом выполнения команды bem bench с ревизиями репозитория в качестве агрументов (bem bench HEAD~1 HEAD) будет таблица, где:

  • benchmark — имя теста;
  • столбцы с результатами тестируемых ревизий: количество выполнений шаблонов в секунду и RME — относительная погрешность, выраженная процентно от среднего арифметического. По RME можно судить, насколько истинны результаты тестирования;
  • RME-stat — показывает, был ли сильный скачек в погрешностях. Как определяется стабильность состояния? Находится максимальная и минимальная RME по одному тесту, если их разность превышает допустимую погрешность 5% (величина была получена в ходе экспериментов и она изменима), то такое состояние считается нестабильным (unstable), в ином случае — стабильным (stable).

Следствием значительного разброса RME является загруженность CPU в момент тестирования. По возможности необходимо выгружать фоновые процессы и ПО, активно использующее CPU. Не стоит доверять результатам тестов при значительном разбросе RME.

Рис. 1 — Результаты тестирования

ОпцияАлиасОписание
--no-wc-wПозволяет запустить тесты не используя рабочую копию.
--benchmark-bПозволяет запускать конкретные тесты, не собирая весь проект. Принимает 1 параметр (строка — имя теста). Возможно указать одновременно несколько тестов (-b b-logo -b b-link).
--rme-rПозволяет изменить допустимое значение погрешности для RME-stat. Значение по умолчанию — 5%.
--rerunПозволяет запустить тесты пропуская этап сборки, используя тесты собранные в предыдущий запуск.
--techs-tПозволяет указать конкретный шаблонизатор. Аргументы - bh, bemhtml.
--delay-d"Активное ожидание" — задержка в секундах между запусками пакетов тестов для сглаживания RME. Значение по умолчанию 20 сек. Это значение напрямую влияет на RME. Эксперементы показали, что при использовании режима NO MAKE параметр --delay можно устанавливать в 0.

При запуске bem bench без аргументов, будет протестирована рабочая копия проекта.

Для запуска bem bench необходимо внести следующие изменения в конфигурационные файлы проекта:

  1. В файлe .bem/make.js в методы getTechs() и getLevels() класса BundleNode, которые указывают, какие технологии собирать для тестов и какие уровни использовать, напишите следующий код:

    MAKE.decl('BundleNode', {
     
        getTechsfunction() {
            
            if (PATH.basename(this.level.dir) === 'benchmark.bundles')  {
                return [
                    'bemjson.js',
                    'bemdecl.js',
                    'deps.js',
                    'bemhtml',
                    'bh' // опционально 
                ];
            }
     
            return this.__base(tech);
     
        },
     
        getLevelsfunction(tech) {
     
            if (PATH.basename(this.level.dir) === 'benchmark.bundles') {
                return ['../bem-bl/blocks-common',
                        '../bem-bl/blocks-desktop',
                        '../common.blocks',
                        '../bem-bl-bh/blocks-common',  // опционально 
                        '../bem-bl-bh/blocks-desktop', // опционально 
                        '../desktop.blocks']
                    .map(PATH.resolve.bind(PATH, __dirname));
            }
     
            return this.__base(tech);
     
        }
    });
  2. Создайте конфигурационный файл уровня переопределения .bem/levels/benchmarks.js, добавьте в него:

    var PATH = require('path');
     
    exports.baseLevelPath = require.resolve('./bundles.js');
     
    exports.getTechs = function() {
     
        return {
            'bemjson.js'    : PATH.resolve(__dirname, '../techs/bemjson.js'),
            'bemdecl.js'    : 'bemdecl.js',
            'deps.js'       : 'deps.js',
            'bemhtml'       : PATH.resolve(__dirname, '../../bem-bl/blocks-common/i-bem/bem/techs/bemhtml.js'),
            'bh'            : PATH.resolve(__dirname,'../techs/bh.js') // опционально 
        };
     
    };
     
    // Create bundles in bemjson.js tech 
    exports.defaultTechs = ['bemjson.js'];
  3. Создайте уровень переопределения для тестов

    bem create level -l .bem/levels/benchmarks.js benchmark.bundles

    Модуль bh технологи находится в pull request - https://github.com/bem/project-stub/pull/14. В этом pull request проект уже сконфигурирован для сборки и тестирования BH шаблонов.

    Тесты должны находится в директории benchmark.bundles/ в корне проекта.

    Пример расположения файлов:

    benchmark.bundles/
        logo/
            logo.bemjson.js
        link/
            link.bemjson.js
        mix-input-button/
            mix-input-button.bemjson.js