jelhan/ember-addon-tests

Integration test helpers for Ember addons

ember-addon-tests's Issues

Clean-up temporary folders created on shutdown

Ember Addon Tests creates a temporary folder for the yarn workspaces. It needs to clean up these folder when the script execution ends. We may provide a flag to disable the clean up to ease debugging. E.g. as an environment variable EMBER_ADDON_TESTS_DISABLE_CLEANUP.

Provide API docs

API docs should be either provided as part of the README or as a website deployed on GitHub Pages. In both cases it would be great if they could be generated automatically based on available TypeScript types. Additional information may be provided using TSDoc.

Setup GitHub Actions to run CI

Add method to install own package

TestProject provides addOwnPackageAsDependency and addOwnPackageAsDevDependency but it misses a method to install own package as an ember addon (ember install <own-package>). Such a method should be preferred as it would match installation instructions of most ember addons.

Support multiple Ember CLI versions

TestProject.createEmberApp() and TestProject.createEmberAddon() should take an Ember CLI version to use as an optional argument.

Implementation is a little bit tricky cause npx does not work reliable if current working directory is a yarn workspaces (ember-cli/ember-cli#9331). As a work-a-round the npx could be executed with a working directory outside of the yarn workspace. But in general the performance of npx is very bad compared to using the Ember CLI installed globally or in yarn workspace.

I considered installing the chosen Ember CLI in the workspace as a work-a-round. Many dependencies could be reused when down- or upgrading an Ember CLI version. Therefore the overhead should be way slower than using npx all the time. But Ember CLI has an issue which prevents installing it as a workspace dependency (ember-cli/ember-cli#9328).

None of them should be show stoppers but both make it more complex than it seems at the first go.

Ignore all folders and files listed in .npmignore when copying files of packages under test

Currently the project is using a hard-coded list of folders to be ignored when copying required files of a package under test:

ember-addon-tests/src/lib/initialize.ts

Lines 33 to 48 in dab2d8a

	// TODO: Use `.npmignore`, `.gitignore` and `files` property in package.json
	// to only copy files those files, which will end up in NPM package.
	const ignoreFolders = ['.git', 'node_modules'];
	fs.copySync(
	packageLocation,
	`${workspaceDir}/packages-under-test/${path.basename(packageName)}`,
	{
	filter(src) {
	return !ignoreFolders.some((ignoreFolder) => {
	const fileName = src.replace(`${packageLocation}/`, '');
	return fileName.startsWith(ignoreFolder);
	});
	},
	}
	);

This may not only slow down build time but also cause bugs. I just run into an issue with a stale .node_modules.ember-try folder causing the tests to fail. For some reason some of the files in that folder could not be copied, which causes the tests to fail very early.