js.share.testdoc-resolver.js Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sahagin Show documentation
Sahagin makes your Selenium script more readable and maintainable.
There is a newer version: 0.10.1
/**
 * @class
 */
sahagin.TestDocResolver = function() {};

/**
 * @type {string}
 */
sahagin.TestDocResolver.MSG_INVALID_PLACEHOLDER
= 'TestDoc of "{0}" contains invalid keyword "{1}"';

/**
 * @type {string}
 */
sahagin.TestDocResolver.MSG_THIS_FOR_FUNCTION
= 'Can not use "this" keyword for function';

/**
 * @private
 * @returns {RegExp}
 */
sahagin.TestDocResolver.generatePlaceHolderRegExp = function() {
  return new RegExp(/{[^{}]+}/g);
};

/**
 * Returns invalid placeholder keyword in the specified TestFunction if exists.
 * Returns null if invalid keyword is not found.
 * @param {sahagin.TestFunction} func
 * @returns {string}
 */
sahagin.TestDocResolver.searchInvalidPlaceholder = function(func) {
  if (func == null || func == undefined) {
    throw new Error(func);
  }
  if (func.getTestDoc() == null) {
    return null; // no TestDoc
  }

  // replace all placeholders by RegExp
  var matched;
  var testDoc = func.getTestDoc();
  var regexp = sahagin.TestDocResolver.generatePlaceHolderRegExp();
  while ((matched = regexp.exec(testDoc)) != null) {
    var variable = matched[0];
    variable = variable.substring(1, variable.length - 1); // trim head and tail braces
    var varIndex = parseInt(variable, 10);
    if (isNaN(varIndex)) {
      // not index pattern
      if (matched == "this") {
        continue;
      } else if (func.getArgVariables().indexOf(variable) == -1) {
        return variable;
      }
    } else {
      // TODO index check
    }
  }
  return null;
};

/**
 * Returns original source code if TestDoc is not found
 * @private
 * @param {sahagin.Code} code
 * @param {Array.} placeholderResolvedParentFuncArgTestDocs
 * @returns {string}
 */
sahagin.TestDocResolver.funcTestDocSub = function(
    code, placeholderResolvedParentFuncArgTestDocs) {
  if (code instanceof sahagin.StringCode) {
    return code.getValue();
  } else if (code instanceof sahagin.FuncArgument) {
    var funcArg = code;
    return placeholderResolvedParentFuncArgTestDocs[funcArg.getArgIndex()];
  } else if (code instanceof sahagin.SubFunctionInvoke) {
    var funcInvoke = code;
    var func = funcInvoke.getSubFunction();
    if (func.getTestDoc() == null) {
      return funcInvoke.getOriginal();
    }

    // replace all placeholders by RegExp
    var matched;
    var buf = '';
    var prevEnd = 0;
    var testDoc = func.getTestDoc();
    var regexp = sahagin.TestDocResolver.generatePlaceHolderRegExp();
    while ((matched = regexp.exec(testDoc)) !== null) {
      var variable = matched[0];
      var matchStart = matched.index;
      var matchEnd = matchStart + variable.length;
      variable = variable.substring(1, variable.length - 1); // trim head and tail braces
      var isIndexPattern = false;
      var varIndex = parseInt(variable, 10);
      if (!isNaN(varIndex)) {
        isIndexPattern = true;
      }

      var variableCode;
      if (!isIndexPattern && variable == "this") {
        if (!(funcInvoke instanceof sahagin.SubMethodInvoke)) {
          throw new Error(sahagin.TestDocResolver.MSG_THIS_FOR_FUNCTION);
        }
        var methodInvoke = funcInvoke;
        variableCode = methodInvoke.getThisInstance();
        if (variableCode == null) {
          // When called inside the class on which this method is defined,
          // set the class name for {this} keyword
          variableCode = new sahagin.UnknownCode();
          variableCode.setOriginal(methodInvoke.getSubMethod().getTestClass().getSimpleName());
        }
      } else {
        if (!isIndexPattern) {
          varIndex = func.getArgVariables().indexOf(variable);
        }
        if (varIndex < 0 || varIndex >= funcInvoke.getArgs().length) {
          throw new Error(sahagin.CommonUtils.strFormat(
              sahagin.TestDocResolver.MSG_INVALID_PLACEHOLDER,
              func.getQualifiedName(), variable));
        }
        variableCode = funcInvoke.getArgs()[varIndex];
      }
      buf = buf + testDoc.substring(prevEnd, matchStart)
      + sahagin.TestDocResolver.funcTestDocSub(
          variableCode, placeholderResolvedParentFuncArgTestDocs);
      prevEnd = matchEnd;
    }
    buf = buf + testDoc.substring(prevEnd, testDoc.length);
    return buf;
  } else {
    return code.getOriginal();
  }
};

/**
 * @param {sahagin.Code} code
 * @param {Array.} placeholderResolvedParentFuncArgTestDocs
 * @returns {Array.}
 */
sahagin.TestDocResolver.placeholderResolvedFuncArgTestDocs = function(
    code, placeholderResolvedParentFuncArgTestDocs) {
  if (!(code instanceof sahagin.SubFunctionInvoke)) {
    return new Array();
  }
  var funcInvoke = code;
  var result = new Array();
  for (var i = 0; i < funcInvoke.getArgs().length; i++) {
    var code = funcInvoke.getArgs()[i];
    var argStr = sahagin.TestDocResolver.funcTestDocSub(
        code, placeholderResolvedParentFuncArgTestDocs);
    result.push(argStr);
  }
  return result;
};

/**
 * @param {sahagin.Code} code
 * @param {Array.} placeholderResolvedParentFuncArgTestDocs
 * @returns {string}
 */
sahagin.TestDocResolver.placeholderResolvedFuncTestDoc = function(
    code, placeholderResolvedParentFuncArgTestDocs) {
  if (code instanceof sahagin.UnknownCode) {
    return null; // TestDoc for UnknownCode is null
  } else {
    return sahagin.TestDocResolver.funcTestDocSub(
        code, placeholderResolvedParentFuncArgTestDocs);
  }
};

/**
 * returns null if Page not found
 * @private
 * @param {sahagin.SubMethodInvoke} methodInvoke
 * @returns {string}
 */
sahagin.TestDocResolver.methodInvokePageTestDocNoRecursive = function(methodInvoke) {
  if (!(methodInvoke.getSubMethod().getTestClass() instanceof sahagin.PageClass)) {
    return null;
  }
  var page = methodInvoke.getSubMethod().getTestClass();
  return page.getTestDoc();
};

/**
 * Returns first found page testDoc.
 * returns null if page testDoc not found
 * @private
 * @param {sahagin.SubMethodInvoke} methodInvoke
 * @returns {string}
 */
sahagin.TestDocResolver.methodInvokePageTestDocRecursive = function(methodInvoke) {
  var pageTestDoc = sahagin.TestDocResolver.methodInvokePageTestDocNoRecursive(methodInvoke);
  if (pageTestDoc != null) {
    return pageTestDoc;
  }
  for (var i = 0; i < methodInvoke.getArgs().length; i++) {
    var code = methodInvoke.getArgs()[i];
    if (code && code instanceof sahagin.SubMethodInvoke) {
      var codeLinePageTestDoc
      = sahagin.TestDocResolver.methodInvokePageTestDocRecursive(code);
      if (codeLinePageTestDoc != null) {
        return codeLinePageTestDoc;
      }
    }
  }
  return null;
};

/**
 * Returns first found page testDoc.
 * returns null if page testDoc not found
 * @param {sahagin.Code} code
 * @returns {string}
 */
sahagin.TestDocResolver.pageTestDoc = function(code) {
  if (!(code instanceof sahagin.SubMethodInvoke)) {
    return null;
  }
  var invoke = code;
  return sahagin.TestDocResolver.methodInvokePageTestDocRecursive(invoke);
};