build(schematics): test schematics properly #12410
Conversation
googlebot
added
the
cla: yes
* Previously, the spec files that have been pushed to the repository, didn't run at all, or were outdated. This PR updates the tests and also enables most of them (as much as possible). * Sets up the Bazel test rules (with a few needed workarounds) in order to test the schematics * Removed devkit utils that can be used from `@schematics/angular` which is **always present** (we can assume that) * Moved data `.json` files into TypeScript files (in order to workaround a bazel typescript issue; and to allow separation for v6 and v7 data at some point) * Updates and fixes schematics to properly work within the latest Angular CLI version
devversion
force-pushed
the
build/schematic-tests
branch
from
1ad1075 to
e86f53f
Compare
src/lib/schematics/BUILD.bazel
Outdated
| srcs = glob(["**/*.ts"], exclude=["**/*.spec.ts", "**/files/**/*"]), | ||
| tsconfig = ":tsconfig.json", | ||
| ) | ||
|
|
||
| ts_library( |
There was a problem hiding this comment.
Move this under # Testing rules?
src/lib/schematics/BUILD.bazel
Outdated
|
|
||
| ts_library( | ||
| name = "schematics", | ||
| module_name = "@angular/material/schematics", |
There was a problem hiding this comment.
I remember needing to add this for something... can you confirm that //src/lib:npm_package still outputs the right thing without this?
There was a problem hiding this comment.
Can confirm that this seems to be necessary in order to have more reasonable AMD module names .
Also found an issue with the TS rules within Windows: bazelbuild/rules_typescript#239
| name = "schematics_test_sources", | ||
| srcs = glob(["**/*.spec.ts"], exclude=["**/files/**/*"]), | ||
| deps = [":schematics"], | ||
| tsconfig = ":tsconfig.json", |
There was a problem hiding this comment.
This should also have testonly = True
| srcs = ["collection.json"], | ||
| outs = ["test-collection.json"], | ||
| cmd = "cp $< $@", | ||
| output_to_bindir = True, |
| srcs = ["migration.json"], | ||
| outs = ["test-migration.json"], | ||
| cmd = "cp $< $@", | ||
| output_to_bindir = True, |
src/lib/schematics/collection.json
Outdated
| "aliases": ["material-table"] | ||
| }, | ||
| // Creates toolbar and navigation components | ||
| "nav": { | ||
| "description": "Create a component with a responsive sidenav for navigation", | ||
| "factory": "./nav/index", | ||
| "schema": "./nav/schema.json", | ||
| "aliases": [ "material-nav", "materialNav" ] | ||
| // TODO(paul): re-add `materialNav` alias if we have the latest schematics version that |
There was a problem hiding this comment.
Could you use devversion in TODOs instead of paul?
There was a problem hiding this comment.
Sure. Wasn't really sure if devversion is more ambiguous than paul.
| }; | ||
|
|
||
| beforeEach(() => { | ||
| runner = new SchematicTestRunner('schematics', collectionPath); | ||
| }); | ||
|
|
||
| it('should create dashboard files and add them to module', () => { | ||
| // Temporarily disabled because @angular-devkit/schematics does not properly resolve | ||
| // the files that should be copied to the project. |
There was a problem hiding this comment.
Not that I know of. And I'm not sure whether this is actually something the CLI project needs to resolve just in favor of Bazel testing. It might just also depend on bazelbuild/rules_typescript#154
| import {getWorkspace} from './config'; | ||
| import {parseName} from './parse-name'; | ||
| import {validateName} from './validation'; | ||
| import {Schema as ComponentOptions} from '@schematics/angular/component/schema'; |
There was a problem hiding this comment.
Is everything under devkit-utils still copied exactly from the devkit source?
There was a problem hiding this comment.
Our devkit-utils have been removed in favor of the same devkit utils that can be just imported. This also makes upgrades to more recent Angular CLI versions way more maintainable.
There was a problem hiding this comment.
What I mean, though, is that formerly everything under devkit-utils was copied verbatim. If we're not copying anything any more, I'd like to drop that directory in favor of one or more directories that are more specifically named.
There was a problem hiding this comment.
I see. I'd prefer having another cleanup-run in a follow-up. This PR is mostly about the testing, and switching to the latest devkit utils was just a necessary step in order to work with 6.0.0
Some things were outdated; so I just did the switch
|
@jelbourn Done. Made the requested changes. |
jelbourn
added
pr: lgtm
action: merge
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
@schematics/angularwhich is always present (we can assume that).jsonfiles into TypeScript files (in order to workaround a bazel typescript issue; and to allow separation for v6 and v7 data at some point)@jelbourn Unfortunately this PR turned out bigger than I expected.. but most of the changes are just moving the
.jsonfiles to.ts(no actual data change).Moving the
.jsonfiles to.tsis something I don't feel too strong about.. but I consider running the tests as very important for now (because that would be the best way for me to verify the update schematics)(Rel: bazelbuild/rules_typescript#154)