angular-cli/packages/schematics/angular/migrations/update-9/update-workspace-config_spec.ts

480 lines
21 KiB
TypeScript

/**
* @license
* Copyright Google Inc. 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 { EmptyTree } from '@angular-devkit/schematics';
import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
import { latestVersions } from '../../utility/latest-versions';
import { WorkspaceTargets } from '../../utility/workspace-models';
import { ANY_COMPONENT_STYLE_BUDGET } from './update-workspace-config';
// tslint:disable-next-line: no-any
function getWorkspaceTargets(tree: UnitTestTree): any {
return JSON.parse(tree.readContent(workspacePath))
.projects['migration-test'].architect;
}
function updateWorkspaceTargets(tree: UnitTestTree, workspaceTargets: WorkspaceTargets) {
const config = JSON.parse(tree.readContent(workspacePath));
config.projects['migration-test'].architect = workspaceTargets;
tree.overwrite(workspacePath, JSON.stringify(config, undefined, 2));
}
const scriptsWithLazy = [
{ bundleName: 'one', input: 'one.js', lazy: false },
{ bundleName: 'two', input: 'two.js', lazy: true },
{ bundleName: 'tree', input: 'tree.js' },
'four.js',
];
const scriptsExpectWithLazy = [
{ bundleName: 'one', input: 'one.js' },
{ bundleName: 'two', inject: false, input: 'two.js' },
{ bundleName: 'tree', input: 'tree.js' },
'four.js',
];
const stylesWithLazy = [
{ bundleName: 'one', input: 'one.css', lazy: false },
{ bundleName: 'two', input: 'two.css', lazy: true },
{ bundleName: 'tree', input: 'tree.css' },
'four.css',
];
const stylesExpectWithLazy = [
{ bundleName: 'one', input: 'one.css' },
{ bundleName: 'two', inject: false, input: 'two.css' },
{ bundleName: 'tree', input: 'tree.css' },
'four.css',
];
const workspacePath = '/angular.json';
// tslint:disable:no-big-function
describe('Migration to version 9', () => {
describe('Migrate workspace config', () => {
const schematicRunner = new SchematicTestRunner(
'migrations',
require.resolve('../migration-collection.json'),
);
let tree: UnitTestTree;
beforeEach(async () => {
tree = new UnitTestTree(new EmptyTree());
tree = await schematicRunner
.runExternalSchematicAsync(
require.resolve('../../collection.json'),
'ng-new',
{
name: 'migration-test',
version: '1.2.3',
directory: '.',
},
tree,
)
.toPromise();
});
describe('scripts and style options', () => {
it('should update scripts in build target', async () => {
let config = getWorkspaceTargets(tree);
config.build.options.scripts = scriptsWithLazy;
config.build.configurations.production.scripts = scriptsWithLazy;
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.options.scripts).toEqual(scriptsExpectWithLazy);
expect(config.configurations.production.scripts).toEqual(scriptsExpectWithLazy);
});
it('should update styles in build target', async () => {
let config = getWorkspaceTargets(tree);
config.build.options.styles = stylesWithLazy;
config.build.configurations.production.styles = stylesWithLazy;
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.options.styles).toEqual(stylesExpectWithLazy);
expect(config.configurations.production.styles).toEqual(stylesExpectWithLazy);
});
it('should update scripts in test target', async () => {
let config = getWorkspaceTargets(tree);
config.test.options.scripts = scriptsWithLazy;
config.test.configurations = { production: { scripts: scriptsWithLazy } };
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).test;
expect(config.options.scripts).toEqual(scriptsExpectWithLazy);
expect(config.configurations.production.scripts).toEqual(scriptsExpectWithLazy);
});
it('should update styles in test target', async () => {
let config = getWorkspaceTargets(tree);
config.test.options.styles = stylesWithLazy;
config.test.configurations = { production: { styles: stylesWithLazy } };
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).test;
expect(config.options.styles).toEqual(stylesExpectWithLazy);
expect(config.configurations.production.styles).toEqual(stylesExpectWithLazy);
});
});
describe('anyComponentStyle bundle budget', () => {
it('should not append budget when already exists', async () => {
const defaultBudget = [
{ type: 'initial', maximumWarning: '2mb', maximumError: '5mb' },
{ type: 'anyComponentStyle', maximumWarning: '10kb', maximumError: '50kb' },
];
let config = getWorkspaceTargets(tree);
config.build.configurations.production.budgets = defaultBudget;
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.configurations.production.budgets).toEqual(defaultBudget);
});
it('should append budget in build target', async () => {
const defaultBudget = [{ type: 'initial', maximumWarning: '2mb', maximumError: '5mb' }];
let config = getWorkspaceTargets(tree);
config.build.configurations.production.budgets = defaultBudget;
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.configurations.production.budgets).toEqual([
...defaultBudget,
ANY_COMPONENT_STYLE_BUDGET,
]);
});
it('should add budget in build target', async () => {
let config = getWorkspaceTargets(tree);
config.build.configurations.production.budgets = undefined;
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.configurations.production.budgets).toEqual([ANY_COMPONENT_STYLE_BUDGET]);
});
});
describe('aot option', () => {
it('should update aot option when false', async () => {
let config = getWorkspaceTargets(tree);
config.build.options.aot = false;
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.options.aot).toBe(true);
});
it('should add aot option when not defined', async () => {
let config = getWorkspaceTargets(tree);
config.build.options.aot = undefined;
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.options.aot).toBe(true);
});
it('should not aot option when opted-out of Ivy', async () => {
const tsConfig = JSON.stringify(
{
extends: './tsconfig.json',
angularCompilerOptions: {
enableIvy: false,
},
},
null,
2,
);
tree.overwrite('/tsconfig.app.json', tsConfig);
let config = getWorkspaceTargets(tree);
config.build.options.aot = false;
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.options.aot).toBe(false);
});
it('should not aot option when opted-out of Ivy in workspace', async () => {
const tsConfig = JSON.stringify(
{
angularCompilerOptions: {
enableIvy: false,
},
},
null,
2,
);
tree.overwrite('/tsconfig.json', tsConfig);
let config = getWorkspaceTargets(tree);
config.build.options.aot = false;
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.options.aot).toBe(false);
});
it('should remove aot option from production configuration', async () => {
let config = getWorkspaceTargets(tree);
config.build.options.aot = false;
config.build.configurations.production.aot = true;
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.options.aot).toBe(true);
expect(config.configurations.production.aot).toBeUndefined();
});
});
describe('server optimization option', () => {
beforeEach(async () => {
tree = await schematicRunner
.runExternalSchematicAsync(
require.resolve('../../collection.json'),
'universal',
{
clientProject: 'migration-test',
},
tree,
)
.toPromise();
});
it('should add optimization option when not defined', async () => {
let config = getWorkspaceTargets(tree);
config.server.configurations.production.optimization = undefined;
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).server.configurations;
expect(config.production.optimization).toBe(true);
});
it('should set optimization to true when false', async () => {
let config = getWorkspaceTargets(tree);
config.server.configurations.production.optimization = false;
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).server.configurations;
expect(config.production.optimization).toBe(true);
});
it('should set optimization to true when optimization is fine grained', async () => {
let config = getWorkspaceTargets(tree);
config.server.configurations.production.optimization = {
scripts: false,
styles: true,
};
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).server.configurations;
expect(config.production.optimization).toBe(true);
});
});
describe('i18n configuration', () => {
function getI18NConfig(localId: string): object {
return {
outputPath: `dist/my-project-${localId}/`,
i18nFile: `src/locale/messages.${localId}.xlf`,
i18nFormat: 'xlf',
i18nLocale: localId,
};
}
describe('when i18n builder options are set', () => {
it(`should add '@angular/localize' as a dependency`, async () => {
const config = getWorkspaceTargets(tree);
config.build.options = getI18NConfig('fr');
config.build.configurations.de = getI18NConfig('de');
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
const { dependencies } = JSON.parse(tree2.readContent('/package.json'));
expect(dependencies['@angular/localize']).toBe(latestVersions.Angular);
});
it(`should add 'localize' option in configuration`, async () => {
let config = getWorkspaceTargets(tree);
config.build.options.aot = false;
config.build.options = getI18NConfig('fr');
config.build.configurations.de = getI18NConfig('de');
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.options.localize).toEqual(['fr']);
expect(config.configurations.de.localize).toEqual(['de']);
});
it('should remove deprecated i18n options', async () => {
let config = getWorkspaceTargets(tree);
config.build.options.aot = false;
config.build.options = getI18NConfig('fr');
config.build.configurations.de = getI18NConfig('de');
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.options.i18nFormat).toBeUndefined();
expect(config.options.i18nFile).toBeUndefined();
expect(config.options.i18nLocale).toBeUndefined();
expect(config.configurations.de.i18nFormat).toBeUndefined();
expect(config.configurations.de.i18nFile).toBeUndefined();
expect(config.configurations.de.i18nLocale).toBeUndefined();
});
it('should remove baseHref option when used with i18n options and no main base href', async () => {
let config = getWorkspaceTargets(tree);
config.build.configurations.fr = { ...getI18NConfig('fr'), baseHref: '/fr/' };
config.build.configurations.de = { ...getI18NConfig('de'), baseHref: '/abc/' };
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.configurations.fr.baseHref).toBeUndefined();
expect(config.configurations.de.baseHref).toBeUndefined();
});
it('should keep baseHref option when not used with i18n options', async () => {
let config = getWorkspaceTargets(tree);
config.build.options = getI18NConfig('fr');
config.build.configurations.de = getI18NConfig('de');
config.build.configurations.staging = { baseHref: '/de/' };
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.configurations.staging.baseHref).toBe('/de/');
});
it('should keep baseHref options when used with i18n options and main baseHref option', async () => {
let config = getWorkspaceTargets(tree);
config.build.options = { baseHref: '/my-app/' };
config.build.configurations.de = { ...getI18NConfig('de'), baseHref: '/de/' };
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.options.baseHref).toBe('/my-app/');
expect(config.configurations.de.baseHref).toBe('/de/');
});
it('should remove deprecated extract-i18n options', async () => {
let config = getWorkspaceTargets(tree);
config['extract-i18n'].options.i18nFormat = 'xmb';
config['extract-i18n'].options.i18nLocale = 'en-GB';
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2)['extract-i18n'];
expect(config.options.i18nFormat).toBeUndefined();
expect(config.options.i18nLocale).toBeUndefined();
expect(config.options.format).toBe('xmb');
});
it(`should add i18n 'sourceLocale' project config when 'extract-i18n' 'i18nLocale' is defined`, async () => {
const config = getWorkspaceTargets(tree);
config.build.options.aot = false;
config.build.options = getI18NConfig('fr');
config['extract-i18n'].options.i18nLocale = 'en-GB';
config.build.configurations.de = getI18NConfig('de');
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
const projectConfig = JSON.parse(tree2.readContent(workspacePath)).projects['migration-test'];
expect(projectConfig.i18n.sourceLocale).toBe('en-GB');
expect(projectConfig.i18n.locales).toBeDefined();
});
it(`should add i18n 'locales' project config`, async () => {
const config = getWorkspaceTargets(tree);
config.build.configurations.fr = getI18NConfig('fr');
config.build.configurations.de = getI18NConfig('de');
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
const projectConfig = JSON.parse(tree2.readContent(workspacePath)).projects['migration-test'];
expect(projectConfig.i18n.sourceLocale).toBeUndefined();
expect(projectConfig.i18n.locales).toEqual({
de: { translation: 'src/locale/messages.de.xlf', baseHref: '' },
fr: { translation: 'src/locale/messages.fr.xlf', baseHref: '' },
});
});
it(`should add i18n 'locales' project config when using baseHref options`, async () => {
const config = getWorkspaceTargets(tree);
config.build.configurations.fr = { ...getI18NConfig('fr'), baseHref: '/fr/' };
config.build.configurations.de = { ...getI18NConfig('de'), baseHref: '/abc/' };
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
const projectConfig = JSON.parse(tree2.readContent(workspacePath)).projects['migration-test'];
expect(projectConfig.i18n.sourceLocale).toBeUndefined();
expect(projectConfig.i18n.locales).toEqual({
de: { translation: 'src/locale/messages.de.xlf', baseHref: '/abc/' },
fr: 'src/locale/messages.fr.xlf',
});
});
it(`should add i18n 'locales' project config when using baseHref options and main base href`, async () => {
const config = getWorkspaceTargets(tree);
config.build.options = { baseHref: '/my-app/' };
config.build.configurations.fr = { ...getI18NConfig('fr'), baseHref: '/fr/' };
config.build.configurations.de = { ...getI18NConfig('de'), baseHref: '/abc/' };
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
const projectConfig = JSON.parse(tree2.readContent(workspacePath)).projects['migration-test'];
expect(projectConfig.i18n.sourceLocale).toBeUndefined();
expect(projectConfig.i18n.locales).toEqual({
de: { translation: 'src/locale/messages.de.xlf', baseHref: '' },
fr: { translation: 'src/locale/messages.fr.xlf', baseHref: '' },
});
});
});
describe('when i18n builder options are not set', () => {
it(`should not add 'localize' option`, async () => {
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
const config = getWorkspaceTargets(tree2).build;
expect(config.options.localize).toBeUndefined();
expect(config.configurations.production.localize).toBeUndefined();
});
it('should not add i18n project config', async () => {
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
const projectConfig = JSON.parse(tree2.readContent(workspacePath)).projects['migration-test'];
expect(projectConfig.i18n).toBeUndefined();
});
});
});
});
});