Address feedback

Author: devversion

src/lib/schematics/BUILD.bazel

@@ -11,7 +11,7 @@ filegroup(
 ts_library(
   name = "schematics",
   module_name = "@angular/material/schematics",
-  srcs = glob(["**/*.ts"], exclude=["**/*.spec.ts", "**/*.fixture.ts", "**/files/**/*"]),
+  srcs = glob(["**/*.ts"], exclude=["**/*.spec.ts", "update/tests/**/*.ts", "**/files/**/*"]),
   tsconfig = ":tsconfig.json",
 )
 
@@ -27,7 +27,7 @@ npm_package(
 jasmine_node_test(
   name = "unit_tests",
   srcs = [":schematics_test_sources"],
-  data = [":schematics_assets", ":schematics_test_fixtures"],
+  data = [":schematics_assets", ":schematics_test_cases"],
   deps = [":copy-collection-file", ":copy-migration-file"],
 )
 
@@ -40,8 +40,8 @@ ts_library(
 )
 
 filegroup(
-  name = "schematics_test_fixtures",
-  srcs = glob(["update/tests/**/*.fixture"]),
+  name = "schematics_test_cases",
+  srcs = glob(["update/tests/**/input.ts", "update/tests/**/expected_output.ts"]),
   testonly = True,
 )
 

src/lib/schematics/tsconfig.json

@@ -15,7 +15,10 @@
     ]
   },
   "exclude": [
+    "**/*.spec.ts",
+    // Exclude template files that will be copied by the schematics. Those are not valid TS.
     "*/files/**/*",
-    "**/*spec*"
+    // Exclude test-case files inside of the update tests directory.
+    "update/tests/**/*"
   ]
 }

src/lib/schematics/update/tests/class-names/expected.fixture renamed to src/lib/schematics/update/tests/class-names/expected_output.ts

@@ -2,41 +2,41 @@ import {getSystemPath, normalize, virtualFs} from '@angular-devkit/core';
 import {TempScopedNodeJsSyncHost} from '@angular-devkit/core/node/testing';
 import {SchematicTestRunner} from '@angular-devkit/schematics/testing';
 import {readFileSync} from 'fs';
-import {join} from 'path';
+import {join, dirname} from 'path';
 import {createTestApp, migrationCollection, runPostScheduledTasks} from '../../utils/testing';
 
-describe('update fixtures', () => {
+describe('test cases', () => {
 
   /**
-   * Path to directories that contain a testing fixture and result fixture. These fixtures
-   * will be used to verify the update schematic.
+   * Path to directories that contain a test case for the update schematics. These test cases
+   * will be used to verify that update schematics properly update developer's applications.
    */
-  const fixturesDirectories = [
+  const testCaseDirs = [
     'angular_material/src/lib/schematics/update/tests/class-names',
   ];
 
-  // Iterates through every fixture directory and generates a jasmine test block that will verify
-  // that the update schematics properly update the test fixture to the expected fixture.
-  fixturesDirectories.forEach(fixtureDirPath => {
+  // Iterates through every test case directory and generates a jasmine test block that will
+  // verify that the update schematics properly update the test input to the expected output.
+  testCaseDirs.forEach(testCaseDir => {
 
-    // Adding the fixture files to the data of the `jasmine_node_test` Bazel rule does not mean
-    // that the fixtures are being copied over to the bin output. Bazel just patches the NodeJS
-    // resolve function in order to map the module paths to the original file location. Since we
-    // need to load the content of those fixtures, we need to resolve the original file path.
-    const testFixturePath = require.resolve(join(fixtureDirPath, 'test.fixture'));
-    const expectedFixturePath = require.resolve(join(fixtureDirPath, 'expected.fixture'));
+    // Adding the test case files to the data of the `jasmine_node_test` Bazel rule does not mean
+    // that the files are being copied over to the Bazel bin output. Bazel just patches the NodeJS
+    // resolve function and maps the module paths to the original file location. Since we
+    // need to load the content of those test cases, we need to resolve the original file path.
+    const inputPath = require.resolve(join(testCaseDir, 'input.ts'));
+    const expectedOutputPath = require.resolve(join(testCaseDir, 'expected_output.ts'));
 
-    it(`should properly update fixture "${fixtureDirPath}" with the update schematic`, () => {
+    it(`should apply update schematics to test case: ${dirname(testCaseDir)}`, () => {
       const runner = new SchematicTestRunner('schematics', migrationCollection);
 
-      runner.runSchematic('migration-01', {}, createTestAppWithFixture(testFixturePath));
+      runner.runSchematic('migration-01', {}, createTestAppWithTestCase(inputPath));
 
       // Run the scheduled TSLint fix task from the update schematic. This task is responsible for
       // identifying outdated code parts and performs the fixes. Since tasks won't run automatically
       // within a `SchematicTestRunner`, we manually need to run the scheduled task.
       return runPostScheduledTasks(runner, 'tslint-fix').toPromise().then(() => {
         expect(readFileContent('projects/material/src/main.ts'))
-          .toBe(readFileContent(expectedFixturePath));
+          .toBe(readFileContent(expectedOutputPath));
       });
     });
   });
@@ -47,14 +47,15 @@ describe('update fixtures', () => {
   }
 
   /**
-   * Creates a test app schematic tree that includes the specified fixture as TypeScript
-   * entry point file.
+   * Creates a test app schematic tree that includes the specified test case as TypeScript
+   * entry point file. Also writes the app tree to a real file system location in order to be
+   * able to test the tslint fix rules.
    */
-  function createTestAppWithFixture(fixturePath: string) {
+  function createTestAppWithTestCase(testCaseInputPath: string) {
     const tempFileSystemHost = new TempScopedNodeJsSyncHost();
     const appTree = createTestApp();
 
-    appTree.overwrite('/projects/material/src/main.ts', readFileContent(fixturePath));
+    appTree.overwrite('/projects/material/src/main.ts', readFileContent(testCaseInputPath));
 
     // Since the TSLint fix task expects all files to be present on the real file system, we
     // map every file in the app tree to a temporary location on the file system.

src/lib/schematics/update/tests/class-names/test.fixture renamed to src/lib/schematics/update/tests/class-names/input.ts

@@ -74,7 +74,10 @@ export function postUpdate(): Rule {
       ' be automatically fixed.');
 }
 
-/** Gets the first tsconfig path from possible locations based on the history of the CLI. */
+/**
+ * Gets all tsconfig paths from a CLI project by reading the workspace configuration
+ * and looking for common tsconfig locations.
+ */
 function getTsConfigPaths(tree: Tree): string[] {
   // Start with some tsconfig paths that are generally used.
   const tsconfigPaths = [

src/lib/schematics/update/tests/run-fixtures.spec.ts renamed to src/lib/schematics/update/tests/test-cases.spec.ts

@@ -49,6 +49,8 @@ export function createTestApp(): UnitTestTree {
 export function runPostScheduledTasks(runner: SchematicTestRunner, taskName: string)
     : Observable<void> {
 
+  // Workaround until there is a public API to run scheduled tasks in the @angular-devkit.
+  // See: https://github.com/angular/angular-cli/issues/11739
   const host = runner.engine['_host'] as EngineHost<{}, {}>;
   const tasks = runner.engine['_taskSchedulers'] as TaskScheduler[];