Source: eval/driver/MergeEvaluation.js

  1. import {EvalConfig} from '../../config/EvalConfig.js';
  2. import * as fs from 'fs';
  3. import {AggregateMergeResult} from '../result/AggregateMergeResult.js';
  4. import {_3dmAdapter} from '../merge_adapters/_3dmAdapter.js';
  5. import {CpeeMergeAdapter} from '../merge_adapters/CpeeMergeAdapter.js';
  6. import {XccPatchAdapter} from '../merge_adapters/XccPatchAdapter.js';
  7. import {Logger} from '../../util/Logger.js';
  8. import {DirectoryScraper} from '../case/DirectoryScraper.js';
  9. import {MergeTestCase} from '../case/MergeTestCase.js';
  10. import {AbstractEvaluation} from './AbstractEvaluation.js';
  11. import {markdownTable} from 'markdown-table';
  13. /**
  14.  * An evaluation of three-way merging algorithms using predefined test cases.
  15.  */
  16. export class MergeEvaluation extends AbstractEvaluation {
  17.   /**
  18.    * Create a new MergeEvaluation instance.
  19.    * @param {Array<MergeAdapter>} adapters The adapters of the algorithms to be
  20.    *     used for the evaluation.
  21.    */
  22.   constructor(adapters = []) {
  23.     super(adapters);
  24.   }
  26.   /**
  27.    * Create a new MergeEvaluation instance with all available merge algorithms.
  28.    * @return {MergeEvaluation}
  29.    */
  30.   static all() {
  31.     /** @type {Array<MergeAdapter>} */
  32.     let adapters = [
  33.       new _3dmAdapter(),
  34.       new XccPatchAdapter(),
  35.     ];
  36.     adapters = adapters.filter((adapter) =>
  37.         fs.existsSync(adapter.path + '/' + EvalConfig.FILENAMES.RUN_SCRIPT));
  38.     adapters.unshift(new CpeeMergeAdapter());
  39.     return new MergeEvaluation(adapters);
  40.   }
  42.   /**
  43.    * @inheritDoc
  44.    * @param {String} rootDir The path to the directory containing the
  45.    *     predefined merge test case directories. A merge test case directory
  46.    *     includes a base  process tree and two branch process trees.
  47.    * @override
  48.    */
  49.   evalAll(rootDir) {
  50.     Logger.section('Merge Evaluation with Cases from ' + rootDir, this);
  52.     const resultsPerAdapter = new Map();
  53.     for (const adapter of this._adapters) {
  54.       resultsPerAdapter.set(adapter, []);
  55.     }
  57.     // Collect all test case directories
  58.     const caseDirs = DirectoryScraper.scrape(rootDir);
  59.     for (const testCaseDir of caseDirs) {
  60.       const testCase = MergeTestCase.from(testCaseDir);
  62.       if (testCase == null) {
  63.         Logger.warn('Skipping empty merge case directory' + testCaseDir, this);
  64.         continue;
  65.       }
  67.       for (const adapter of this._adapters) {
  68.         Logger.info(
  69.             'Running merge case ' + testCase.name +
  70.             ' for ' + adapter.displayName + '...',
  71.             this,
  72.         );
  74.         const result = adapter.evalCase(testCase);
  75.         resultsPerAdapter.get(adapter).push(result);
  76.       }
  77.     }
  79.     const aggregateResults = [];
  80.     for (const [, resultsList] of resultsPerAdapter) {
  81.       aggregateResults.push(AggregateMergeResult.of(resultsList));
  82.     }
  83.     const table = [
  84.       AggregateMergeResult.header(),
  85.       ...aggregateResults.map((result) => result.values()),
  86.     ];
  87.     Logger.result('Results of the merge evaluation:\n' +
  88.         markdownTable(table), this);
  89.   }
  90. }