missing_control_flow_directive_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
 */

import {DiagnosticCategoryLabel} from '@angular/compiler-cli/src/ngtsc/core/api';
import ts from 'typescript';

import {ErrorCode, ExtendedTemplateDiagnosticName, ngErrorCode} from '../../../../../diagnostics';
import {absoluteFrom, getSourceFileOrError} from '../../../../../file_system';
import {runInEachFileSystem} from '../../../../../file_system/testing';
import {getSourceCodeForDiagnostic} from '../../../../../testing';
import {getClass, setup} from '../../../../testing';
import {factory as missingControlFlowDirectiveCheck} from '../../../checks/missing_control_flow_directive';
import {ExtendedTemplateCheckerImpl} from '../../../src/extended_template_checker';

const KNOWN_CONTROL_FLOW_DIRECTIVES = ['ngIf', 'ngFor', 'ngSwitchCase', 'ngSwitchDefault'];

runInEachFileSystem(() => {
  describe('MissingControlFlowDirectiveCheck', () => {
    KNOWN_CONTROL_FLOW_DIRECTIVES.forEach(directive => {
      ['div', 'ng-template', 'ng-container', 'ng-content'].forEach(element => {
        it(`should produce a warning when the '${directive}' directive is not imported ` +
               `(when used on the '${element}' element)`,
           () => {
             const fileName = absoluteFrom('/main.ts');
             const {program, templateTypeChecker} = setup([{
               fileName,
               templates: {
                 'TestCmp': `<${element} *${directive}="exp"></${element}>`,
               },
             }]);
             const sf = getSourceFileOrError(program, fileName);
             const component = getClass(sf, 'TestCmp');
             const extendedTemplateChecker = new ExtendedTemplateCheckerImpl(
                 templateTypeChecker, program.getTypeChecker(), [missingControlFlowDirectiveCheck],
                 {} /* options */);
             const diags = extendedTemplateChecker.getDiagnosticsForComponent(component);
             expect(diags.length).toBe(1);
             expect(diags[0].category).toBe(ts.DiagnosticCategory.Warning);
             expect(diags[0].code).toBe(ngErrorCode(ErrorCode.MISSING_CONTROL_FLOW_DIRECTIVE));
             expect(getSourceCodeForDiagnostic(diags[0])).toBe(directive);
           });

        it(`should *not* produce a warning when the '${directive}' directive is imported ` +
               `(when used on the '${element}' element)`,
           () => {
             const className = directive.charAt(0).toUpperCase() + directive.substr(1);
             const fileName = absoluteFrom('/main.ts');
             const {program, templateTypeChecker} = setup([{
               fileName,
               templates: {
                 'TestCmp': `<${element} *${directive}="exp"></${element}>`,
               },
               source: `
                export class TestCmp {}
                export class ${className} {}
              `,
               declarations: [{
                 type: 'directive',
                 name: className,
                 selector: `[${directive}]`,
               }],
             }]);
             const sf = getSourceFileOrError(program, fileName);
             const component = getClass(sf, 'TestCmp');
             const extendedTemplateChecker = new ExtendedTemplateCheckerImpl(
                 templateTypeChecker, program.getTypeChecker(), [missingControlFlowDirectiveCheck],
                 {strictNullChecks: true} /* options */);
             const diags = extendedTemplateChecker.getDiagnosticsForComponent(component);
             // No diagnostic messages are expected.
             expect(diags.length).toBe(0);
           });

        it(`should *not* produce a warning when the '${directive}' directive selector attribute ` +
               `is present on the '${element}' element, but the directive is not imported`,
           () => {
             const className = directive.charAt(0).toUpperCase() + directive.substr(1);
             const fileName = absoluteFrom('/main.ts');
             const {program, templateTypeChecker} = setup([{
               fileName,
               templates: {
                 'TestCmp': `<${element} *${directive}="exp"></${element}>`,
               },
               source: `
                export class TestCmp {}
                export class ${className} {}
              `,
               declarations: [{
                 type: 'directive',
                 name: className,
                 selector: `[${directive}]`,
               }],
             }]);
             const sf = getSourceFileOrError(program, fileName);
             const component = getClass(sf, 'TestCmp');
             const extendedTemplateChecker = new ExtendedTemplateCheckerImpl(
                 templateTypeChecker, program.getTypeChecker(), [missingControlFlowDirectiveCheck],
                 {strictNullChecks: true} /* options */);
             const diags = extendedTemplateChecker.getDiagnosticsForComponent(component);
             // No diagnostic messages are expected.
             expect(diags.length).toBe(0);
           });
      });
    });

    it(`should *not* produce a warning for other missing structural directives`, () => {
      const fileName = absoluteFrom('/main.ts');
      const {program, templateTypeChecker} = setup([{
        fileName,
        templates: {
          'TestCmp': `<div *foo="exp"></div>`,
        },
      }]);
      const sf = getSourceFileOrError(program, fileName);
      const component = getClass(sf, 'TestCmp');
      const extendedTemplateChecker = new ExtendedTemplateCheckerImpl(
          templateTypeChecker, program.getTypeChecker(), [missingControlFlowDirectiveCheck],
          {strictNullChecks: true} /* options */);
      const diags = extendedTemplateChecker.getDiagnosticsForComponent(component);
      // No diagnostic messages are expected.
      expect(diags.length).toBe(0);
    });
  });
});