| // Copyright 2016 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| var childProcess = require('child_process'); |
| var fs = require('fs'); |
| var path = require('path'); |
| var shell = require('child_process').execSync; |
| |
| var utils = require('./utils'); |
| |
| var Flags = { |
| DEBUG_DEVTOOLS: '--debug-devtools', |
| DEBUG_DEVTOOLS_SHORTHAND: '-d', |
| FETCH_CONTENT_SHELL: '--fetch-content-shell', |
| COMPAT_PROTOCOL: '--compat-protocol', // backwards compatibility testing |
| CHROMIUM_PATH: '--chromium-path', // useful for bisecting |
| TARGET: '--target', // build sub-directory (e.g. Release, Default) |
| }; |
| |
| var COMPAT_URL_MAPPING = { |
| '1.2': 'https://storage.googleapis.com/content-shell-devtools-compat/content_shell_417361.zip', |
| }; |
| |
| var IS_DEBUG_ENABLED = |
| utils.includes(process.argv, Flags.DEBUG_DEVTOOLS) || utils.includes(process.argv, Flags.DEBUG_DEVTOOLS_SHORTHAND); |
| var COMPAT_PROTOCOL = utils.parseArgs(process.argv)[Flags.COMPAT_PROTOCOL]; |
| var CUSTOM_CHROMIUM_PATH = utils.parseArgs(process.argv)[Flags.CHROMIUM_PATH]; |
| var IS_FETCH_CONTENT_SHELL = utils.includes(process.argv, Flags.FETCH_CONTENT_SHELL); |
| var TARGET = utils.parseArgs(process.argv)[Flags.TARGET] || 'Release'; |
| |
| var CONTENT_SHELL_ZIP = 'content-shell.zip'; |
| var MAX_CONTENT_SHELLS = 10; |
| var PLATFORM = getPlatform(); |
| var PYTHON = process.platform === 'win32' ? 'python.bat' : 'python'; |
| |
| var CHROMIUM_SRC_PATH = CUSTOM_CHROMIUM_PATH || path.resolve(__dirname, '..', '..', '..', '..', '..'); |
| var RELEASE_PATH = path.resolve(CHROMIUM_SRC_PATH, 'out', TARGET); |
| var BLINK_TEST_PATH = path.resolve(CHROMIUM_SRC_PATH, 'blink', 'tools', 'run_layout_tests.py'); |
| var DEVTOOLS_PATH = path.resolve(CHROMIUM_SRC_PATH, 'third_party', 'WebKit', 'Source', 'devtools'); |
| var CACHE_PATH = path.resolve(DEVTOOLS_PATH, '.test_cache'); |
| var SOURCE_PATH = path.resolve(DEVTOOLS_PATH, 'front_end'); |
| |
| function main() { |
| if (!utils.isDir(CACHE_PATH)) |
| fs.mkdirSync(CACHE_PATH); |
| deleteOldContentShells(); |
| |
| if (COMPAT_PROTOCOL) { |
| runCompatibilityTests(); |
| return; |
| } |
| var hasUserCompiledContentShell = utils.isFile(getContentShellBinaryPath(RELEASE_PATH)); |
| if (!IS_FETCH_CONTENT_SHELL && hasUserCompiledContentShell) { |
| var outDir = path.resolve(RELEASE_PATH, '..'); |
| if (!IS_DEBUG_ENABLED) |
| compileFrontend(); |
| |
| runTests(outDir, IS_DEBUG_ENABLED); |
| return; |
| } |
| |
| findPreviousUploadedPosition(findMostRecentChromiumCommit()).then(onUploadedCommitPosition).catch(onError); |
| |
| function onError(error) { |
| console.log('Unable to run tests because of error:', error); |
| console.log(`Try removing the .test_cache folder [${CACHE_PATH}] and retrying`); |
| } |
| } |
| main(); |
| |
| function runCompatibilityTests() { |
| const folder = `compat-protocol-${COMPAT_PROTOCOL}`; |
| utils.removeRecursive(path.resolve(RELEASE_PATH, 'resources', 'inspector')); |
| compileFrontend(); |
| var outPath = path.resolve(CACHE_PATH, folder, 'out'); |
| var contentShellDirPath = path.resolve(outPath, TARGET); |
| var hasCachedContentShell = utils.isFile(getContentShellBinaryPath(contentShellDirPath)); |
| if (hasCachedContentShell) { |
| console.log(`Using cached content shell at: ${outPath}`); |
| copyFrontendToCompatBuildPath(contentShellDirPath, RELEASE_PATH); |
| runTests(outPath, IS_DEBUG_ENABLED); |
| return; |
| } |
| prepareContentShellDirectory(folder) |
| .then(() => downloadContentShell(COMPAT_URL_MAPPING[COMPAT_PROTOCOL], folder)) |
| .then(extractContentShell) |
| .then(() => copyFrontendToCompatBuildPath(contentShellDirPath, RELEASE_PATH)) |
| .then(() => runTests(outPath, IS_DEBUG_ENABLED)); |
| } |
| |
| function compileFrontend() { |
| console.log('Compiling devtools frontend'); |
| try { |
| shell(`ninja -C ${RELEASE_PATH} devtools_frontend_resources`, {cwd: CHROMIUM_SRC_PATH}); |
| } catch (err) { |
| console.log(err.stdout.toString()); |
| console.log('ERROR: Cannot compile frontend\n' + err); |
| process.exit(1); |
| } |
| } |
| |
| function onUploadedCommitPosition(commitPosition) { |
| var contentShellDirPath = path.resolve(CACHE_PATH, commitPosition, 'out', TARGET); |
| var contentShellResourcesPath = path.resolve(contentShellDirPath, 'resources'); |
| var contentShellPath = path.resolve(CACHE_PATH, commitPosition, 'out'); |
| |
| var hasCachedContentShell = utils.isFile(getContentShellBinaryPath(contentShellDirPath)); |
| if (hasCachedContentShell) { |
| console.log(`Using cached content shell at: ${contentShellPath}`); |
| copyFrontend(contentShellResourcesPath); |
| return runTests(contentShellPath, true); |
| } |
| var url = `http://commondatastorage.googleapis.com/chromium-browser-snapshots/${PLATFORM}/${commitPosition |
| }/${CONTENT_SHELL_ZIP}`; |
| return prepareContentShellDirectory(commitPosition) |
| .then(() => downloadContentShell(url, commitPosition)) |
| .then(extractContentShell) |
| .then(() => copyFrontend(contentShellResourcesPath)) |
| .then(() => runTests(contentShellPath, true)); |
| } |
| |
| function copyFrontendToCompatBuildPath(compatBuildPath, latestBuildPath) { |
| var customDevtoolsResourcesPath = path.resolve(compatBuildPath, 'resources'); |
| var latestDevtoolsInspectorPath = path.resolve(latestBuildPath, 'resources', 'inspector'); |
| var copiedFrontendPath = path.resolve(customDevtoolsResourcesPath, 'inspector'); |
| if (utils.isDir(copiedFrontendPath)) |
| utils.removeRecursive(copiedFrontendPath); |
| utils.copyRecursive(latestDevtoolsInspectorPath, customDevtoolsResourcesPath); |
| } |
| |
| function copyFrontend(contentShellResourcesPath) { |
| var devtoolsResourcesPath = path.resolve(contentShellResourcesPath, 'inspector'); |
| var copiedFrontendPath = path.resolve(devtoolsResourcesPath, 'front_end'); |
| var debugFrontendPath = path.resolve(devtoolsResourcesPath, 'debug'); |
| var inspectorBackendCommandsPath = path.resolve(devtoolsResourcesPath, 'InspectorBackendCommands.js'); |
| var supportedCSSPropertiesPath = path.resolve(devtoolsResourcesPath, 'SupportedCSSProperties.js'); |
| utils.removeRecursive(copiedFrontendPath); |
| utils.removeRecursive(debugFrontendPath); |
| utils.copyRecursive(SOURCE_PATH, devtoolsResourcesPath); |
| fs.renameSync(copiedFrontendPath, debugFrontendPath); |
| utils.copy(inspectorBackendCommandsPath, debugFrontendPath); |
| utils.copy(supportedCSSPropertiesPath, debugFrontendPath); |
| } |
| |
| function getPlatform() { |
| if (process.platform === 'linux') { |
| return 'Linux_x64'; |
| } |
| if (process.platform === 'win32') { |
| return 'Win_x64'; |
| } |
| if (process.platform === 'darwin') |
| return 'Mac'; |
| |
| throw new Error(`Unrecognized platform detected: ${process.platform}`); |
| } |
| |
| function findMostRecentChromiumCommit() { |
| var commitMessage = shell(`git log --max-count=1 --grep="Cr-Commit-Position"`).toString().trim(); |
| var commitPosition = commitMessage.match(/Cr-Commit-Position: refs\/heads\/master@\{#([0-9]+)\}/)[1]; |
| return commitPosition; |
| } |
| |
| function deleteOldContentShells() { |
| var files = fs.readdirSync(CACHE_PATH); |
| if (files.length < MAX_CONTENT_SHELLS) |
| return; |
| files.sort((a, b) => parseInt(b, 10) - parseInt(a, 10)); |
| var remainingNumberOfContentShells = MAX_CONTENT_SHELLS / 2; |
| var oldContentShellDirs = files.slice(remainingNumberOfContentShells); |
| for (var i = 0; i < oldContentShellDirs.length; i++) |
| utils.removeRecursive(path.resolve(CACHE_PATH, oldContentShellDirs[i])); |
| console.log(`Removed old content shells: ${oldContentShellDirs}`); |
| } |
| |
| function findPreviousUploadedPosition(commitPosition) { |
| var previousPosition = commitPosition - 100; |
| var positionsListURL = |
| `http://commondatastorage.googleapis.com/chromium-browser-snapshots/?delimiter=/&prefix=${PLATFORM |
| }/&marker=${PLATFORM}/${previousPosition}/`; |
| return utils.fetch(positionsListURL).then(onPositionsList).catch(onError); |
| |
| function onPositionsList(buffer) { |
| var positions = buffer.toString('binary') |
| .match(/([^<>]+)(?=<\/Prefix><\/CommonPrefixes>)/g) |
| .map(prefixedPosition => prefixedPosition.split('/')[1]) |
| .map(positionString => parseInt(positionString, 10)); |
| var positionSet = new Set(positions); |
| var previousUploadedPosition = commitPosition; |
| while (commitPosition - previousUploadedPosition < 100) { |
| if (positionSet.has(previousUploadedPosition)) |
| return previousUploadedPosition.toString(); |
| previousUploadedPosition--; |
| } |
| onError(); |
| } |
| |
| function onError(error) { |
| if (error) |
| console.log(`Received error: ${error} trying to fetch positions list from url: ${positionsListURL}`); |
| throw new Error(`Unable to find a previous upload position for commit position: ${commitPosition}`); |
| } |
| } |
| |
| function prepareContentShellDirectory(folder) { |
| var contentShellPath = path.join(CACHE_PATH, folder); |
| if (utils.isDir(contentShellPath)) |
| utils.removeRecursive(contentShellPath); |
| fs.mkdirSync(contentShellPath); |
| return Promise.resolve(folder); |
| } |
| |
| function downloadContentShell(url, folder) { |
| console.log('Downloading content shell from:', url); |
| console.log('NOTE: Download is ~35-65 MB depending on OS'); |
| return utils.fetch(url).then(writeZip).catch(onError); |
| |
| function writeZip(buffer) { |
| console.log('Completed download of content shell'); |
| var contentShellZipPath = path.join(CACHE_PATH, folder, CONTENT_SHELL_ZIP); |
| fs.writeFileSync(contentShellZipPath, buffer); |
| return contentShellZipPath; |
| } |
| |
| function onError(error) { |
| console.log(`Received error: ${error} trying to download content shell from url: ${url}`); |
| throw new Error('Unable to download content shell'); |
| } |
| } |
| |
| function extractContentShell(contentShellZipPath) { |
| console.log(`Extracting content shell zip: ${contentShellZipPath}`); |
| var unzipScriptPath = path.resolve(__dirname, 'unzip.py'); |
| var src = contentShellZipPath; |
| var dest = path.resolve(path.dirname(src), 'out'); |
| shell(`${PYTHON} ${unzipScriptPath} ${src} ${dest}`); |
| fs.unlinkSync(src); |
| var originalDirPath = path.resolve(dest, 'content-shell'); |
| var newDirPath = path.resolve(dest, TARGET); |
| fs.renameSync(originalDirPath, newDirPath); |
| fs.chmodSync(getContentShellBinaryPath(newDirPath), '755'); |
| if (process.platform === 'darwin') { |
| var helperPath = path.resolve( |
| newDirPath, 'Content Shell.app', 'Contents', 'Frameworks', 'Content Shell Helper.app', 'Contents', 'MacOS', |
| 'Content Shell Helper'); |
| fs.chmodSync(helperPath, '755'); |
| } |
| return dest; |
| } |
| |
| function getContentShellBinaryPath(dirPath) { |
| if (process.platform === 'linux') |
| return path.resolve(dirPath, 'content_shell'); |
| |
| if (process.platform === 'win32') |
| return path.resolve(dirPath, 'content_shell.exe'); |
| |
| if (process.platform === 'darwin') |
| return path.resolve(dirPath, 'Content Shell.app', 'Contents', 'MacOS', 'Content Shell'); |
| } |
| |
| function runTests(buildDirectoryPath, useDebugDevtools) { |
| var testArgs = getInspectorTests().concat([ |
| '--no-pixel-tests', |
| '--build-directory', |
| buildDirectoryPath, |
| '--target', |
| TARGET, |
| ]); |
| if (useDebugDevtools) |
| testArgs.push('--additional-driver-flag=--debug-devtools'); |
| else |
| console.log('TIP: You can debug a test using: npm run debug-test inspector/test-name.html'); |
| |
| if (COMPAT_PROTOCOL) { |
| const platform = `protocol-${COMPAT_PROTOCOL}`; |
| const testsPath = path.resolve(DEVTOOLS_PATH, 'tests'); |
| const compatBaselinePath = path.resolve(testsPath, 'baseline', platform); |
| testArgs.push(`--additional-platform-directory=${compatBaselinePath}`); |
| const expectationsPath = path.resolve(testsPath, 'TestExpectations'); |
| testArgs.push(`--additional-expectations=${expectationsPath}`); |
| } |
| if (IS_DEBUG_ENABLED) { |
| testArgs.push('--additional-driver-flag=--remote-debugging-port=9222'); |
| testArgs.push('--time-out-ms=6000000'); |
| console.log('\n============================================='); |
| console.log('Go to: http://localhost:9222/'); |
| console.log('Click on link and in console execute: test()'); |
| console.log('=============================================\n'); |
| } |
| var args = [BLINK_TEST_PATH].concat(testArgs).concat(getTestFlags()); |
| console.log(`Running layout tests with args: ${args}`); |
| childProcess.spawn(PYTHON, args, {stdio: 'inherit'}); |
| } |
| |
| function getTestFlags() { |
| var flagValues = Object.keys(Flags).map(key => Flags[key]); |
| return process.argv.slice(2).filter(arg => { |
| var flagName = utils.includes(arg, '=') ? arg.slice(0, arg.indexOf('=')) : arg; |
| return !utils.includes(flagValues, flagName) && !utils.includes(arg, 'inspector'); |
| }); |
| } |
| |
| function getInspectorTests() { |
| var specificTests = process.argv.filter(arg => utils.includes(arg, 'inspector')); |
| if (specificTests.length) |
| return specificTests; |
| return [ |
| 'inspector*', |
| 'http/tests/inspector*', |
| ]; |
| } |