37f02f7e6b
<!-- Please make sure you have read the submission guidelines before posting an PR --> <!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr --> <!-- Please make sure that your commit message follows our format --> <!-- Example: `fix(nx): must begin with lowercase` --> ## Current Behavior <!-- This is the behavior we have today --> ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #25284
484 lines
15 KiB
TypeScript
484 lines
15 KiB
TypeScript
import {
|
|
checkFilesDoNotExist,
|
|
checkFilesExist,
|
|
cleanupProject,
|
|
getSelectedPackageManager,
|
|
packageInstall,
|
|
readJson,
|
|
runCLI,
|
|
runCommand,
|
|
runNgAdd,
|
|
runNgNew,
|
|
uniq,
|
|
updateFile,
|
|
} from '@nx/e2e/utils';
|
|
import { PackageManager } from 'nx/src/utils/package-manager';
|
|
|
|
describe('convert Angular CLI workspace to an Nx workspace', () => {
|
|
let project: string;
|
|
let packageManager: PackageManager;
|
|
|
|
// utility to manually add protractor since it's not generated
|
|
// in the latest Angular CLI versions, but older projects updated
|
|
// to latest versions might still have it
|
|
function addProtractor() {
|
|
updateFile('e2e/protractor.conf.js', 'exports.config = {};');
|
|
updateFile(
|
|
'e2e/tsconfig.json',
|
|
JSON.stringify({ extends: '../tsconfig.json' }, null, 2)
|
|
);
|
|
updateFile(
|
|
'e2e/src/app.e2e-spec.ts',
|
|
`describe('app', () => {
|
|
it('should pass', () => {
|
|
expect(true).toBe(true);
|
|
});
|
|
});`
|
|
);
|
|
|
|
const angularJson = readJson('angular.json');
|
|
angularJson.projects[project].architect.e2e = {
|
|
builder: '@angular-devkit/build-angular:protractor',
|
|
options: {
|
|
protractorConfig: 'e2e/protractor.conf.js',
|
|
devServerTarget: `${project}:serve`,
|
|
},
|
|
configurations: {
|
|
production: { devServerTarget: `${project}:serve:production` },
|
|
},
|
|
};
|
|
updateFile('angular.json', JSON.stringify(angularJson, null, 2));
|
|
}
|
|
|
|
function addCypress9() {
|
|
runNgAdd('@cypress/schematic', '--e2e-update', '1.7.0');
|
|
packageInstall('cypress', null, '^9.0.0');
|
|
}
|
|
|
|
function addCypress10() {
|
|
runNgAdd('@cypress/schematic', '--e2e', 'latest');
|
|
}
|
|
|
|
function addEsLint() {
|
|
runNgAdd('@angular-eslint/schematics', undefined, 'latest');
|
|
}
|
|
|
|
beforeEach(() => {
|
|
packageManager = getSelectedPackageManager();
|
|
// TODO: solve issues with pnpm and remove this fallback
|
|
packageManager = packageManager === 'pnpm' ? 'yarn' : packageManager;
|
|
project = runNgNew(packageManager);
|
|
packageInstall('nx', null, 'latest');
|
|
packageInstall('@nx/angular', null, 'latest');
|
|
});
|
|
|
|
afterEach(() => {
|
|
cleanupProject();
|
|
});
|
|
|
|
it('should generate a workspace', () => {
|
|
addProtractor();
|
|
|
|
// update package.json
|
|
const packageJson = readJson('package.json');
|
|
packageJson.description = 'some description';
|
|
updateFile('package.json', JSON.stringify(packageJson, null, 2));
|
|
|
|
// update tsconfig.json
|
|
const tsConfig = readJson('tsconfig.json');
|
|
tsConfig.compilerOptions.paths = { a: ['b'] };
|
|
updateFile('tsconfig.json', JSON.stringify(tsConfig, null, 2));
|
|
|
|
// add an extra script file
|
|
updateFile('src/scripts.js', 'const x = 1;');
|
|
|
|
// update angular.json
|
|
const angularJson = readJson('angular.json');
|
|
angularJson.projects[project].architect.build.options.scripts =
|
|
angularJson.projects[project].architect.test.options.scripts = [
|
|
'src/scripts.js',
|
|
];
|
|
angularJson.projects[project].architect.test.options.styles = [
|
|
'src/styles.css',
|
|
];
|
|
updateFile('angular.json', JSON.stringify(angularJson, null, 2));
|
|
|
|
// confirm that @nx dependencies do not exist yet
|
|
expect(packageJson.devDependencies['@nx/workspace']).not.toBeDefined();
|
|
|
|
// run ng add
|
|
runCLI('g @nx/angular:ng-add --default-base main');
|
|
|
|
// check that prettier config exits and that files have been moved
|
|
checkFilesExist(
|
|
'.vscode/extensions.json',
|
|
'.prettierrc',
|
|
`apps/${project}/src/main.ts`,
|
|
`apps/${project}/src/app/app.config.ts`,
|
|
`apps/${project}/src/app/app.component.ts`,
|
|
`apps/${project}/src/app/app.routes.ts`
|
|
);
|
|
|
|
// check the right VSCode extensions are recommended
|
|
expect(readJson('.vscode/extensions.json').recommendations).toEqual([
|
|
'angular.ng-template',
|
|
'nrwl.angular-console',
|
|
'dbaeumer.vscode-eslint',
|
|
'esbenp.prettier-vscode',
|
|
]);
|
|
|
|
// check package.json
|
|
const updatedPackageJson = readJson('package.json');
|
|
expect(updatedPackageJson.description).toEqual('some description');
|
|
expect(updatedPackageJson.scripts).toEqual({
|
|
ng: 'ng',
|
|
start: 'nx serve',
|
|
build: 'nx build',
|
|
watch: 'nx build --watch --configuration development',
|
|
test: 'nx test',
|
|
});
|
|
expect(updatedPackageJson.devDependencies['@nx/workspace']).toBeDefined();
|
|
expect(updatedPackageJson.devDependencies['@angular/cli']).toBeDefined();
|
|
|
|
// check nx.json
|
|
const nxJson = readJson('nx.json');
|
|
expect(nxJson).toEqual({
|
|
defaultBase: 'main',
|
|
namedInputs: {
|
|
default: ['{projectRoot}/**/*', 'sharedGlobals'],
|
|
production: [
|
|
'default',
|
|
'!{projectRoot}/tsconfig.spec.json',
|
|
'!{projectRoot}/**/*.spec.[jt]s',
|
|
'!{projectRoot}/karma.conf.js',
|
|
],
|
|
sharedGlobals: [],
|
|
},
|
|
targetDefaults: {
|
|
build: {
|
|
dependsOn: ['^build'],
|
|
inputs: ['production', '^production'],
|
|
cache: true,
|
|
},
|
|
e2e: {
|
|
inputs: ['default', '^production'],
|
|
cache: true,
|
|
},
|
|
test: {
|
|
inputs: ['default', '^production', '{workspaceRoot}/karma.conf.js'],
|
|
cache: true,
|
|
},
|
|
},
|
|
});
|
|
|
|
// check angular.json does not exist
|
|
checkFilesDoNotExist('angular.json');
|
|
|
|
// check project configuration
|
|
const projectConfig = readJson(`apps/${project}/project.json`);
|
|
expect(projectConfig.sourceRoot).toEqual(`apps/${project}/src`);
|
|
expect(projectConfig.targets.build).toStrictEqual({
|
|
executor: '@angular-devkit/build-angular:application',
|
|
options: {
|
|
outputPath: `dist/apps/${project}`,
|
|
index: `apps/${project}/src/index.html`,
|
|
browser: `apps/${project}/src/main.ts`,
|
|
polyfills: [`zone.js`],
|
|
tsConfig: `apps/${project}/tsconfig.app.json`,
|
|
assets: [{ glob: '**/*', input: `apps/${project}/public` }],
|
|
styles: [`apps/${project}/src/styles.css`],
|
|
scripts: [`apps/${project}/src/scripts.js`],
|
|
},
|
|
configurations: {
|
|
production: {
|
|
budgets: [
|
|
{
|
|
type: 'initial',
|
|
maximumWarning: '500kB',
|
|
maximumError: '1MB',
|
|
},
|
|
{
|
|
type: 'anyComponentStyle',
|
|
maximumWarning: '2kB',
|
|
maximumError: '4kB',
|
|
},
|
|
],
|
|
outputHashing: 'all',
|
|
},
|
|
development: {
|
|
optimization: false,
|
|
extractLicenses: false,
|
|
sourceMap: true,
|
|
},
|
|
},
|
|
defaultConfiguration: 'production',
|
|
});
|
|
expect(projectConfig.targets.serve).toEqual({
|
|
executor: '@angular-devkit/build-angular:dev-server',
|
|
configurations: {
|
|
production: { buildTarget: `${project}:build:production` },
|
|
development: { buildTarget: `${project}:build:development` },
|
|
},
|
|
defaultConfiguration: 'development',
|
|
});
|
|
expect(projectConfig.targets.test).toStrictEqual({
|
|
executor: '@angular-devkit/build-angular:karma',
|
|
options: {
|
|
polyfills: [`zone.js`, `zone.js/testing`],
|
|
tsConfig: `apps/${project}/tsconfig.spec.json`,
|
|
assets: [{ glob: '**/*', input: `apps/${project}/public` }],
|
|
styles: [`apps/${project}/src/styles.css`],
|
|
scripts: [`apps/${project}/src/scripts.js`],
|
|
},
|
|
});
|
|
expect(projectConfig.targets.e2e).toBeUndefined();
|
|
|
|
// check e2e project config
|
|
const e2eProjectConfig = readJson(`apps/${project}-e2e/project.json`);
|
|
expect(e2eProjectConfig.targets.e2e).toEqual({
|
|
executor: '@angular-devkit/build-angular:protractor',
|
|
options: {
|
|
protractorConfig: `apps/${project}-e2e/protractor.conf.js`,
|
|
devServerTarget: `${project}:serve`,
|
|
},
|
|
configurations: {
|
|
production: {
|
|
devServerTarget: `${project}:serve:production`,
|
|
},
|
|
},
|
|
});
|
|
|
|
runCLI(`build ${project} --configuration production --outputHashing none`);
|
|
checkFilesExist(`dist/apps/${project}/browser/main.js`);
|
|
});
|
|
|
|
it('should handle a workspace with cypress v9', () => {
|
|
addCypress9();
|
|
|
|
runCLI('g @nx/angular:ng-add --skip-install');
|
|
|
|
const e2eProject = `${project}-e2e`;
|
|
//check e2e project files
|
|
checkFilesDoNotExist(
|
|
'cypress.json',
|
|
'cypress/tsconfig.json',
|
|
'cypress/integration/spec.ts',
|
|
'cypress/plugins/index.ts',
|
|
'cypress/support/commands.ts',
|
|
'cypress/support/index.ts'
|
|
);
|
|
checkFilesExist(
|
|
`apps/${e2eProject}/cypress.json`,
|
|
`apps/${e2eProject}/tsconfig.json`,
|
|
`apps/${e2eProject}/src/integration/spec.ts`,
|
|
`apps/${e2eProject}/src/plugins/index.ts`,
|
|
`apps/${e2eProject}/src/support/commands.ts`,
|
|
`apps/${e2eProject}/src/support/index.ts`
|
|
);
|
|
|
|
const projectConfig = readJson(`apps/${project}/project.json`);
|
|
expect(projectConfig.targets['cypress-run']).toBeUndefined();
|
|
expect(projectConfig.targets['cypress-open']).toBeUndefined();
|
|
expect(projectConfig.targets.e2e).toBeUndefined();
|
|
|
|
// check e2e project config
|
|
const e2eProjectConfig = readJson(`apps/${project}-e2e/project.json`);
|
|
expect(e2eProjectConfig.targets['cypress-run']).toEqual({
|
|
executor: '@nx/cypress:cypress',
|
|
options: {
|
|
devServerTarget: `${project}:serve`,
|
|
cypressConfig: `apps/${e2eProject}/cypress.json`,
|
|
},
|
|
configurations: {
|
|
production: {
|
|
devServerTarget: `${project}:serve:production`,
|
|
},
|
|
},
|
|
});
|
|
expect(e2eProjectConfig.targets['cypress-open']).toEqual({
|
|
executor: '@nx/cypress:cypress',
|
|
options: {
|
|
watch: true,
|
|
headless: false,
|
|
cypressConfig: `apps/${e2eProject}/cypress.json`,
|
|
},
|
|
});
|
|
expect(e2eProjectConfig.targets.e2e).toEqual({
|
|
executor: '@nx/cypress:cypress',
|
|
options: {
|
|
devServerTarget: `${project}:serve`,
|
|
watch: true,
|
|
headless: false,
|
|
cypressConfig: `apps/${e2eProject}/cypress.json`,
|
|
},
|
|
configurations: {
|
|
production: {
|
|
devServerTarget: `${project}:serve:production`,
|
|
},
|
|
},
|
|
});
|
|
});
|
|
|
|
it('should handle a workspace with cypress v10', () => {
|
|
addCypress10();
|
|
|
|
runCLI('g @nx/angular:ng-add --skip-install');
|
|
|
|
const e2eProject = `${project}-e2e`;
|
|
//check e2e project files
|
|
checkFilesDoNotExist(
|
|
'cypress.config.ts',
|
|
'cypress/tsconfig.json',
|
|
'cypress/e2e/spec.cy.ts',
|
|
'cypress/fixtures/example.json',
|
|
'cypress/support/commands.ts',
|
|
'cypress/support/e2e.ts'
|
|
);
|
|
checkFilesExist(
|
|
`apps/${e2eProject}/cypress.config.ts`,
|
|
`apps/${e2eProject}/tsconfig.json`,
|
|
`apps/${e2eProject}/src/e2e/spec.cy.ts`,
|
|
`apps/${e2eProject}/src/fixtures/example.json`,
|
|
`apps/${e2eProject}/src/support/commands.ts`,
|
|
`apps/${e2eProject}/src/support/e2e.ts`
|
|
);
|
|
|
|
const projectConfig = readJson(`apps/${project}/project.json`);
|
|
expect(projectConfig.targets['cypress-run']).toBeUndefined();
|
|
expect(projectConfig.targets['cypress-open']).toBeUndefined();
|
|
expect(projectConfig.targets.e2e).toBeUndefined();
|
|
|
|
// check e2e project config
|
|
const e2eProjectConfig = readJson(`apps/${project}-e2e/project.json`);
|
|
expect(e2eProjectConfig.targets['cypress-run']).toEqual({
|
|
executor: '@nx/cypress:cypress',
|
|
options: {
|
|
devServerTarget: `${project}:serve`,
|
|
cypressConfig: `apps/${e2eProject}/cypress.config.ts`,
|
|
},
|
|
configurations: {
|
|
production: {
|
|
devServerTarget: `${project}:serve:production`,
|
|
},
|
|
},
|
|
});
|
|
expect(e2eProjectConfig.targets['cypress-open']).toEqual({
|
|
executor: '@nx/cypress:cypress',
|
|
options: {
|
|
watch: true,
|
|
headless: false,
|
|
cypressConfig: `apps/${e2eProject}/cypress.config.ts`,
|
|
},
|
|
});
|
|
expect(e2eProjectConfig.targets.e2e).toEqual({
|
|
executor: '@nx/cypress:cypress',
|
|
options: {
|
|
devServerTarget: `${project}:serve`,
|
|
watch: true,
|
|
headless: false,
|
|
cypressConfig: `apps/${e2eProject}/cypress.config.ts`,
|
|
},
|
|
configurations: {
|
|
production: {
|
|
devServerTarget: `${project}:serve:production`,
|
|
},
|
|
},
|
|
});
|
|
});
|
|
|
|
// TODO(leo): The current Verdaccio setup fails to resolve older versions
|
|
// of @nx/* packages, the @angular-eslint/builder package depends on an
|
|
// older version of @nx/devkit so we skip this test for now.
|
|
it.skip('should handle a workspace with ESLint', () => {
|
|
addEsLint();
|
|
|
|
runCLI('g @nx/angular:ng-add');
|
|
|
|
checkFilesExist(`apps/${project}/.eslintrc.json`, `.eslintrc.json`);
|
|
|
|
const projectConfig = readJson(`apps/${project}/project.json`);
|
|
expect(projectConfig.targets.lint).toStrictEqual({
|
|
executor: '@nx/eslint:lint',
|
|
});
|
|
|
|
let output = runCLI(`lint ${project}`);
|
|
expect(output).toContain(`> nx run ${project}:lint`);
|
|
expect(output).toContain('All files pass linting');
|
|
expect(output).toContain(
|
|
`Successfully ran target lint for project ${project}`
|
|
);
|
|
|
|
output = runCLI(`lint ${project}`);
|
|
expect(output).toContain(`> nx run ${project}:lint [local cache]`);
|
|
expect(output).toContain('All files pass linting');
|
|
expect(output).toContain(
|
|
`Successfully ran target lint for project ${project}`
|
|
);
|
|
});
|
|
|
|
it('should support a workspace with multiple projects', () => {
|
|
// add other projects
|
|
const app1 = uniq('app1');
|
|
const lib1 = uniq('lib1');
|
|
runCommand(`ng g @schematics/angular:application ${app1} --no-interactive`);
|
|
runCommand(`ng g @schematics/angular:library ${lib1} --no-interactive`);
|
|
|
|
runCLI('g @nx/angular:ng-add');
|
|
|
|
// check angular.json does not exist
|
|
checkFilesDoNotExist('angular.json');
|
|
|
|
// check building project
|
|
let output = runCLI(`build ${project} --outputHashing none`);
|
|
expect(output).toContain(
|
|
`> nx run ${project}:build:production --outputHashing none`
|
|
);
|
|
expect(output).toContain(
|
|
`Successfully ran target build for project ${project}`
|
|
);
|
|
checkFilesExist(`dist/apps/${project}/browser/main.js`);
|
|
|
|
output = runCLI(`build ${project} --outputHashing none`);
|
|
expect(output).toContain(
|
|
`> nx run ${project}:build:production --outputHashing none [local cache]`
|
|
);
|
|
expect(output).toContain(
|
|
`Successfully ran target build for project ${project}`
|
|
);
|
|
|
|
// check building app1
|
|
output = runCLI(`build ${app1} --outputHashing none`);
|
|
expect(output).toContain(
|
|
`> nx run ${app1}:build:production --outputHashing none`
|
|
);
|
|
expect(output).toContain(
|
|
`Successfully ran target build for project ${app1}`
|
|
);
|
|
checkFilesExist(`dist/apps/${app1}/browser/main.js`);
|
|
|
|
output = runCLI(`build ${app1} --outputHashing none`);
|
|
expect(output).toContain(
|
|
`> nx run ${app1}:build:production --outputHashing none [local cache]`
|
|
);
|
|
expect(output).toContain(
|
|
`Successfully ran target build for project ${app1}`
|
|
);
|
|
|
|
// check building lib1
|
|
output = runCLI(`build ${lib1}`);
|
|
expect(output).toContain(`> nx run ${lib1}:build:production`);
|
|
expect(output).toContain(
|
|
`Successfully ran target build for project ${lib1}`
|
|
);
|
|
checkFilesExist(`dist/${lib1}/package.json`);
|
|
|
|
output = runCLI(`build ${lib1}`);
|
|
expect(output).toContain(
|
|
`> nx run ${lib1}:build:production [local cache]`
|
|
);
|
|
expect(output).toContain(
|
|
`Successfully ran target build for project ${lib1}`
|
|
);
|
|
});
|
|
});
|