angular-cli/packages/angular_devkit/schematics/tasks/tslint-fix/executor_spec.ts

/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.io/license
 */

/* eslint-disable import/no-extraneous-dependencies */
import { getSystemPath, normalize, virtualFs } from '@angular-devkit/core';
import { TempScopedNodeJsSyncHost } from '@angular-devkit/core/node/testing';
import { HostTree } from '@angular-devkit/schematics';
import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
import * as path from 'path';
import { Observable, concat } from 'rxjs';
import { catchError } from 'rxjs/operators';

const isWindowsBazel =
  process.env.RUNFILES_MANIFEST_ONLY === '1' && process.env.RUNFILES_MANIFEST_FILE;

describe('TsLintTaskExecutor', () => {
  it('works with config object', (done) => {
    const testRunner = new SchematicTestRunner(
      '@_/test',
      require.resolve('./test/collection.json'),
    );

    const host = new TempScopedNodeJsSyncHost();
    host
      .write(
        normalize('/file.ts'),
        virtualFs.stringToFileBuffer(`
      export function() { console.log(1); }
    `),
      )
      .subscribe();
    const tree = new UnitTestTree(new HostTree(host));

    testRunner.runSchematicAsync('run-task', null, tree).toPromise().then(done, done.fail);
  });

  it('shows errors with config object', (done) => {
    const testRunner = new SchematicTestRunner(
      '@_/test',
      require.resolve('./test/collection.json'),
    );

    const host = new TempScopedNodeJsSyncHost();
    host
      .write(
        normalize('/file.ts'),
        virtualFs.stringToFileBuffer(`
      // ${'...MORE_THAN_100'.repeat(10)}
      export function() { console.log(1); }
    `),
      )
      .subscribe();
    const tree = new UnitTestTree(new HostTree(host));

    const messages: string[] = [];
    let error = false;

    concat(
      testRunner.runSchematicAsync('run-task', null, tree),
      new Observable<void>((obs) => {
        process.chdir(getSystemPath(host.root));
        testRunner.logger.subscribe((x) => messages.push(x.message));
        testRunner.engine.executePostTasks().subscribe(obs);
      }).pipe(
        catchError(() => {
          error = true;

          return [];
        }),
      ),
      new Observable<void>((obs) => {
        expect(messages.find((msg) => /\b80\b/.test(msg))).not.toBeUndefined();
        expect(error).toBe(true);

        obs.complete();
      }),
    )
      .toPromise()
      .then(done, done.fail);
  });

  it('supports custom rules in the project (pass)', (done) => {
    // This test is disabled on Windows Bazel runs because it relies on TSLint custom rule
    // loading behavior, which doesn't work with runfile resolution.
    if (isWindowsBazel) {
      done();

      return;
    }

    const testRunner = new SchematicTestRunner(
      '@_/test',
      require.resolve('./test/collection.json'),
    );

    const host = new TempScopedNodeJsSyncHost();
    host
      .write(
        normalize('/file.ts'),
        virtualFs.stringToFileBuffer(`
      console.log('hello world');
    `),
      )
      .subscribe();
    const tree = new UnitTestTree(new HostTree(host));

    const messages: string[] = [];

    concat(
      testRunner.runSchematicAsync('custom-rule', { shouldPass: true }, tree),
      new Observable<void>((obs) => {
        process.chdir(getSystemPath(host.root));
        testRunner.logger.subscribe((x) => messages.push(x.message));
        testRunner.engine.executePostTasks().subscribe(obs);
      }),
    )
      .toPromise()
      .then(done, done.fail);
  });

  it('supports custom rules in the project (fail)', (done) => {
    // This test is disabled on Windows Bazel runs because it relies on TSLint custom rule
    // loading behavior, which doesn't work with runfile resolution.
    if (isWindowsBazel) {
      done();

      return;
    }

    const testRunner = new SchematicTestRunner(
      '@_/test',
      path.join(__dirname, 'test/collection.json'),
    );

    const host = new TempScopedNodeJsSyncHost();
    host
      .write(
        normalize('/file.ts'),
        virtualFs.stringToFileBuffer(`
      console.log('hello world');
    `),
      )
      .subscribe();
    const tree = new UnitTestTree(new HostTree(host));

    const messages: string[] = [];
    let error = false;

    concat(
      testRunner.runSchematicAsync('custom-rule', { shouldPass: false }, tree),
      new Observable<void>((obs) => {
        process.chdir(getSystemPath(host.root));
        testRunner.logger.subscribe((x) => messages.push(x.message));
        testRunner.engine.executePostTasks().subscribe(obs);
      }).pipe(
        catchError(() => {
          error = true;

          return [];
        }),
      ),
      new Observable<void>((obs) => {
        expect(messages.find((msg) => /\bcustom-rule fail\b/.test(msg))).not.toBeUndefined();
        expect(error).toBe(true);

        obs.complete();
      }),
    )
      .toPromise()
      .then(done, done.fail);
  });
});