appcenter-cli/src/commands/test/lib/test-manifest-reader.ts

Command line tool for Visual Studio App Center

import { TestRunFile, TestFrameworkData, TestManifest } from "./test-manifest";
import { PathResolver } from "./path-resolver";
import * as fs from "fs";
import * as path from "path";
import * as _ from "lodash";

export interface IFileDescriptionJson {
  sourcePath: string;
  targetPath: string;
}

export interface ITestFrameworkJson {
  name: string;
  data: any;
}

export interface ITestCloudManifestJson {
  schemaVersion: string;

  cliVersion: string;

  files: (string | IFileDescriptionJson)[];

  applicationFile?: string;

  testFramework: ITestFrameworkJson;
}

export class TestManifestReader {
  private pathResolver: PathResolver;

  static async readFromFile(filePath: string): Promise<TestManifest> {
    const workspace = path.dirname(filePath);
    const resolver = new PathResolver(workspace);
    const readerInstance = new TestManifestReader(resolver);
    const json = TestManifestReader.readJsonFromFile(filePath);

    return await readerInstance.readManifest(json);
  }

  private static readJsonFromFile(filePath: string): any {
    const json = fs.readFileSync(filePath, "utf8");
    return JSON.parse(json);
  }

  private constructor(pathResolver: PathResolver) {
    if (!pathResolver) {
      throw new Error("Argument pathResolver is required");
    }

    this.pathResolver = pathResolver;
  }

  public async readManifest(json: ITestCloudManifestJson): Promise<TestManifest> {
    const files = await this.readTestFiles(json.files);
    const applicationFile = json.applicationFile ? await this.readApplicationFile(json.applicationFile) : null;

    return new TestManifest(
      json.schemaVersion,
      json.cliVersion,
      applicationFile,
      files,
      new TestFrameworkData(
        json.testFramework.name,
        json.testFramework.data
      )
    );
  }

  private async readTestFiles(json: (string | IFileDescriptionJson)[]): Promise<TestRunFile[]> {
    const filePatterns = json.filter((f) => typeof f === "string");
    const fileDescriptions = json.filter((f) => typeof f !== "string");

    return _.concat<TestRunFile>(
      await this.readFilePatterns(filePatterns as string[]),
      await this.readFileDescriptions(fileDescriptions as IFileDescriptionJson[])
    );
  }

  private async readApplicationFile(pattern: string): Promise<TestRunFile> {
    const inputFile = await this.resolveSinglePathPattern(pattern);

    return await TestRunFile.create(
      path.join(this.pathResolver.workspace, inputFile),
      path.basename(inputFile),
      "app-file"
    );
  }

  private async readFilePatterns(patterns: string[]): Promise<TestRunFile[]> {
    const filePaths = await this.pathResolver.resolve(patterns);

    return await Promise.all(filePaths.map((relativePath) => {
      const fullPath = path.join(this.pathResolver.workspace, relativePath);
      return TestRunFile.create(fullPath, relativePath, "test-file");
    }));
  }

  private async readFileDescriptions(descriptions: IFileDescriptionJson[]): Promise<TestRunFile[]> {
    return await Promise.all(descriptions.map((d) => this.readFileDescription(d)));
  }

  private async readFileDescription(description: IFileDescriptionJson): Promise<TestRunFile> {
    const inputFile = await this.resolveSinglePathPattern(description.sourcePath);

    return await TestRunFile.create(
      path.join(this.pathResolver.workspace, inputFile),
      description.targetPath,
      "test-file");
  }

  private async resolveSinglePathPattern(pattern: string): Promise<string> {
    const filePaths = await this.pathResolver.resolve(pattern);

    if (filePaths.length > 1) {
      throw new Error(`Pattern ${pattern} resolved to more than one file`);
    } else if (filePaths.length === 0) {
      throw new Error(`Pattern ${pattern} did not resolve to any existing file`);
    }

    return filePaths[0];
  }
}