js.GalenApi.js Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of galen-core Show documentation
Show all versions of galen-core Show documentation
A library for layout testing of websites
/*******************************************************************************
* Copyright 2014 Ivan Shubin http://galenframework.com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ******************************************************************************/
/*global GalenJsApi, GalenPageDump, GalenUtils, TestSession, System, Galen, GalenCore, MutationOptions, logged*/
/*jslint nomen: true*/
(function (exports) {
"use strict";
function createDriver(url, size, browserType) {
if (url === undefined) {
url = null;
}
if (size === undefined) {
size = null;
}
if (browserType === undefined) {
browserType = null;
}
var driver = GalenUtils.createDriver(browserType, url, size);
return driver;
}
function __galen_getAttr(attrs, name) {
if (attrs[name] !== undefined && attrs[name] !== null) {
return attrs[name];
}
return null;
}
function createGridDriver(url, attrs) {
var browser = __galen_getAttr(attrs, "browser"),
browserVersion = __galen_getAttr(attrs, "browserVersion"),
platform = __galen_getAttr(attrs, "platform"),
size = __galen_getAttr(attrs, "size"),
dc = __galen_getAttr(attrs, "desiredCapabilities");
return GalenUtils.createGridDriver(url, browser, browserVersion, platform, dc, size);
}
function varsToArray(vars) {
var array = [],
name;
for (name in vars) {
if (vars.hasOwnProperty(name)) {
array.push(new GalenJsApi.JsVariable(name, vars[name]));
}
}
return array;
}
function objectsToJsPageObjects(objects) {
var name, jsPageObjects, locatorText;
if (objects !== null) {
jsPageObjects = [];
for (name in objects) {
if (objects.hasOwnProperty(name)) {
locatorText = objects[name];
jsPageObjects.push(new GalenJsApi.JsPageObject(name, locatorText));
}
}
return jsPageObjects;
}
return null;
}
function checkLayout(driver, pageSpecFile, includedTags, excludedTags) {
var settings,
screenshotFile = null,
properties = null,
jsVariables = [],
jsPageObjects = null,
sectionNameFilter = null;
if (arguments.length === 1) {
settings = driver;
driver = settings.driver;
pageSpecFile = settings.spec;
includedTags = settings.tags;
excludedTags = settings.excludedTags;
screenshotFile = settings.screenshot;
sectionNameFilter = settings.sectionFilter;
properties = settings.properties;
if (settings.vars !== undefined) {
jsVariables = varsToArray(settings.vars);
}
if (settings.objects !== undefined) {
jsPageObjects = objectsToJsPageObjects(settings.objects);
}
}
if (includedTags === undefined) {
includedTags = null;
}
if (excludedTags === undefined) {
excludedTags = null;
}
if (properties === undefined) {
properties = null;
}
if (screenshotFile === undefined) {
screenshotFile = null;
}
if (sectionNameFilter === undefined) {
sectionNameFilter = null;
}
if (!Array.isArray(includedTags) && includedTags !== null) {
includedTags = [includedTags];
}
if (!Array.isArray(excludedTags) && excludedTags !== null) {
excludedTags = [excludedTags];
}
return GalenJsApi.checkLayout(driver, pageSpecFile, includedTags, excludedTags, sectionNameFilter, properties, screenshotFile, jsVariables, jsPageObjects);
}
function checkPageSpecLayout(driver, pageSpec, includedTags, excludedTags) {
var settings,
screenshotFile = null;
if (arguments.length === 1) {
settings = driver;
driver = settings.driver;
pageSpec = settings.pageSpec;
includedTags = settings.tags;
excludedTags = settings.excludedTags;
screenshotFile = settings.screenshot;
}
if (includedTags === undefined) {
includedTags = null;
}
if (excludedTags === undefined) {
excludedTags = null;
}
if (screenshotFile === undefined) {
screenshotFile = null;
}
if (!Array.isArray(includedTags) && includedTags !== null) {
includedTags = [includedTags];
}
if (!Array.isArray(excludedTags) && excludedTags !== null) {
excludedTags = [excludedTags];
}
return GalenJsApi.checkPageSpecLayout(driver, pageSpec, includedTags, excludedTags, screenshotFile);
}
function testMutation(driver, pageSpecFile, includedTags, excludedTags, positionOffset) {
var settings,
options = new MutationOptions();
if (arguments.length === 1) {
settings = driver;
driver = settings.driver;
pageSpecFile = settings.spec;
includedTags = settings.tags;
excludedTags = settings.excludedTags;
if (settings.options !== undefined && settings.options.hasOwnProperty('offset')) {
positionOffset = settings.options.offset;
}
}
if (includedTags === undefined) {
includedTags = null;
}
if (excludedTags === undefined) {
excludedTags = null;
}
if (!Array.isArray(includedTags) && includedTags !== null) {
includedTags = [includedTags];
}
if (!Array.isArray(excludedTags) && excludedTags !== null) {
excludedTags = [excludedTags];
}
if (positionOffset === undefined || positionOffset === null) {
positionOffset = 5;
}
options.setPositionOffset(positionOffset);
return GalenJsApi.testMutation(driver, pageSpecFile, includedTags, excludedTags, options);
}
function takeScreenshot(driver) {
return GalenUtils.takeScreenshot(driver);
}
function loadProperties(fileName) {
return GalenUtils.loadProperties(fileName);
}
function cookie(driver, cookieText) {
logged("Setting cookie: " + cookieText, function () {
GalenUtils.cookie(driver, cookieText);
});
}
function inject(driver, script) {
return GalenUtils.injectJavascript(driver, script);
}
function readFile(fileName) {
return GalenJsApi.readFile(fileName);
}
function listDirectory(dirPath) {
return GalenJsApi.listDirectory(dirPath);
}
function fileExists(path) {
return GalenJsApi.fileExists(path);
}
function isDirectory(path) {
return GalenJsApi.isDirectory(path);
}
function makeDirectory(dirPath) {
return GalenJsApi.makeDirectory(dirPath);
}
function createFile(filePath) {
return GalenJsApi.createFile(filePath);
}
function deleteFile(filePath) {
return GalenJsApi.deleteFile(filePath);
}
function writeFile(filePath, text) {
GalenJsApi.writeFile(filePath, text);
}
function appendFile(filePath, text) {
return GalenJsApi.appendFile(filePath, text);
}
function resize(driver, size) {
GalenJsApi.resizeDriver(driver, size);
}
var session = {
put: function (name, value) {
TestSession.current().put(name, value);
},
get: function (name) {
return TestSession.current().get(name);
},
test: function () {
return TestSession.current().getTest();
},
report: function () {
return TestSession.current().getReport();
},
testInfo: function () {
return TestSession.current().getTestInfo();
}
}, galenConsole = {
log: function (object) {
if (typeof object === "string") {
System.out.println(object);
} else {
if (object.toJSON !== undefined) {
System.out.println(JSON.stringify(object));
} else {
System.out.println(object);
}
}
}
};
function dumpPage(settings) {
var driver = settings.driver,
name = settings.name,
spec = settings.spec,
exportPath = settings.exportPath,
maxWidth = settings.maxWidth,
maxHeight = settings.maxHeight,
onlyImages = settings.onlyImages,
excludedObjects = settings.excludedObjects,
dump;
if (driver === undefined || driver === null) {
throw new Error("Driver is not defined");
}
if (name === undefined || name === null) {
name = "undefined";
}
if (spec === undefined || spec === null) {
throw new Error("spec is not defined");
}
if (exportPath === undefined || exportPath === null) {
throw new Error("exportPath is not defined");
}
if (maxWidth === undefined) {
maxWidth = null;
}
if (maxHeight === undefined) {
maxHeight = null;
}
if (onlyImages === undefined) {
onlyImages = false;
}
if (excludedObjects === undefined) {
excludedObjects = null;
}
if (excludedObjects !== null) {
excludedObjects = GalenJsApi.toList(excludedObjects);
}
dump = new GalenPageDump(name);
dump.setMaxWidth(maxWidth);
dump.setMaxHeight(maxHeight);
dump.setOnlyImages(onlyImages);
dump.setExcludedObjects(excludedObjects);
dump.dumpPage(driver, spec, exportPath);
}
function parsePageSpec(settings) {
var driver = settings.driver,
pageSpecFile = settings.spec,
includedTags = settings.tags,
excludedTags = settings.excludedTags,
properties = settings.properties,
jsVariables = null,
jsPageObjects = null;
if (settings.vars !== undefined) {
jsVariables = varsToArray(settings.vars);
}
if (settings.objects !== undefined) {
jsPageObjects = objectsToJsPageObjects(settings.objects);
}
if (includedTags === undefined) {
includedTags = null;
}
if (excludedTags === undefined) {
excludedTags = null;
}
if (properties === undefined) {
properties = null;
}
if (!Array.isArray(includedTags) && includedTags !== null) {
includedTags = [includedTags];
}
if (!Array.isArray(excludedTags) && excludedTags !== null) {
excludedTags = [excludedTags];
}
return GalenJsApi.parsePageSpec(driver, pageSpecFile, includedTags, excludedTags, properties, jsVariables, jsPageObjects);
}
exports.createDriver = createDriver;
exports.createGridDriver = createGridDriver;
exports.checkLayout = checkLayout;
exports.checkPageSpecLayout = checkPageSpecLayout;
exports.testMutation = testMutation;
exports.session = session;
exports.takeScreenshot = takeScreenshot;
exports.loadProperties = loadProperties;
exports.cookie = cookie;
exports.inject = inject;
exports.readFile = readFile;
exports.listDirectory = listDirectory;
exports.makeDirectory = makeDirectory;
exports.fileExists = fileExists;
exports.isDirectory = isDirectory;
exports.parsePageSpec = parsePageSpec;
exports.createFile = createFile;
exports.writeFile = writeFile;
exports.appendFile = appendFile;
exports.deleteFile = deleteFile;
exports.console = galenConsole;
exports.dumpPage = dumpPage;
exports.resize = resize;
}(this));
© 2015 - 2025 Weber Informatics LLC | Privacy Policy