appcenter-cli/src/commands/test/run/uitest.ts

Command line tool for Visual Studio App Center

import * as pfs from "../../../util/misc/promisfied-fs";
import { generateAbsolutePath } from "../../../util/misc/fs-helper";
import * as path from "path";
import { NUnitXmlUtil } from "../lib/nunit-xml-util";
import { CommandArgs, help, longName, hasArg } from "../../../util/commandline";
import { UITestPreparer } from "../lib/uitest-preparer";
import { Messages } from "../lib/help-messages";
import { out } from "../../../util/interaction";
import { RunTestsDownloadResultCommand } from "../lib/run-tests-download-result-command";

@help(Messages.TestCloud.Commands.RunUITests)
export default class RunUITestsCommand extends RunTestsDownloadResultCommand {

  @help(Messages.TestCloud.Arguments.UITestsBuildDir)
  @longName("build-dir")
  @hasArg
  buildDir: string;

  @help("Obsolete. Please use --build-dir instead")
  @longName("assembly-dir")
  @hasArg
  assemblyDir: string;

  @help(Messages.TestCloud.Arguments.UITestsStoreFilePath)
  @longName("store-path")
  @hasArg
  storePath: string;

  @help(Messages.TestCloud.Arguments.UITestsStorePassword)
  @longName("store-password")
  @hasArg
  storePassword: string;

  @help(Messages.TestCloud.Arguments.UITestsKeyAlias)
  @longName("key-alias")
  @hasArg
  keyAlias: string;

  @help(Messages.TestCloud.Arguments.UITestsKeyPassword)
  @longName("key-password")
  @hasArg
  keyPassword: string;

  @help(Messages.TestCloud.Arguments.UITestsSignInfo)
  @longName("sign-info")
  @hasArg
  signInfo: string;

  @help(Messages.TestCloud.Arguments.UITestsToolsDir)
  @longName("uitest-tools-dir")
  @hasArg
  uiTestToolsDir: string;

  @help(Messages.TestCloud.Arguments.Fixture)
  @longName("fixture")
  @hasArg
  fixture: string[];

  @help(Messages.TestCloud.Arguments.IncludeCategory)
  @longName("include-category")
  @hasArg
  includeCategory: string[];

  @help(Messages.TestCloud.Arguments.ExcludeCategory)
  @longName("exclude-category")
  @hasArg
  excludeCategory: string[];

  @help(Messages.TestCloud.Arguments.MergeNUnitXml)
  @longName("merge-nunit-xml")
  @hasArg
  mergeNUnitXml: string;

  @help(Messages.TestCloud.Arguments.TestChunk)
  @longName("test-chunk")
  testChunk: boolean;

  @help(Messages.TestCloud.Arguments.FixtureChunk)
  @longName("fixture-chunk")
  fixtureChunk: boolean;

  constructor(args: CommandArgs) {
    super(args);

    this.fixture = this.fixArrayParameter(this.fixture);
    this.includeCategory = this.fixArrayParameter(this.includeCategory);
    this.excludeCategory = this.fixArrayParameter(this.excludeCategory);
  }

  protected async validateOptions(): Promise<void> {
    if (this.assemblyDir && !this.buildDir) {
      out.text("Argument --assembly-dir is obsolete. Please use --build-dir instead.");
      this.buildDir = this.assemblyDir;
    }

    if (!this.buildDir) {
      throw new Error("Argument --build-dir is required.");
    }

    if (this.testChunk && this.fixtureChunk) {
      throw new Error("Arguments --fixture-chunk and test-chunk cannot be combined.");
    }

    if (!this.testOutputDir && this.mergeNUnitXml) {
      throw new Error("Argument --test-output-dir is required for argument --merge-nunit-xml");
    }
  }

  protected prepareManifest(artifactsDir: string): Promise<string> {
    const preparer = new UITestPreparer(artifactsDir, this.buildDir, this.appPath);

    preparer.storeFile = this.storePath;
    preparer.storePassword = this.storePassword;
    preparer.keyAlias = this.keyAlias;
    preparer.keyPassword = this.keyPassword;
    preparer.signInfo = this.signInfo;
    preparer.uiTestToolsDir = this.uiTestToolsDir;
    preparer.fixture = this.fixture;
    preparer.includeCategory = this.includeCategory;
    preparer.excludeCategory = this.excludeCategory;
    preparer.testChunk = this.testChunk;
    preparer.fixtureChunk = this.fixtureChunk;

    return preparer.prepare();
  }

  protected getParametersFromOptions() : {} {
    if (this.fixtureChunk) {
        return {chunker : "fixture"};
    } else if (this.testChunk) {
      return {chunker : "method"};
    }
    return {};
  }

  protected getSourceRootDir() {
    return this.buildDir;
  }

  protected async mergeTestArtifacts(): Promise<void> {
    if (!this.mergeNUnitXml) {
      return;
    }

    const reportPath: string = generateAbsolutePath(this.testOutputDir);
    if (!reportPath) {
      return;
    }

    const xmlUtil: NUnitXmlUtil = new NUnitXmlUtil();
    const pathToArchive: string = path.join(reportPath, xmlUtil.getArchiveName());

    const xml: Document = await xmlUtil.mergeXmlResults(pathToArchive);

    if (!xml) {
      throw new Error(`Couldn't merge xml test results to ${this.mergeNUnitXml}`);
    }

    return pfs.writeFile(path.join(reportPath, this.mergeNUnitXml), xml);
  }
}