Differences

This shows you the differences between two versions of the page.

--- dev:contributing:qa [2023/11/10 18:14] – add OPAC tests sandbergja
+++ dev:contributing:qa [2025/09/09 14:55] (current) – lint section sleary
@@ Line 53: / Line 53: @@
   npm run build-prod   # may not be necessary for running tests
   npm run test
+==== Angular Lint ====
+See ''Open-ILS/src/eg2/eslint.config.mjs'' for the current lint rules.
+To run on a running Evergreen server:
+<code sh>
+cd Open-ILS/src/eg2
+ng lint
+</code>
+To fix syntax errors automatically:
+<code sh>
+cd Open-ILS/src/eg2
+ng lint --fix
+</code>
+We also have several [[https://github.com/angular-eslint/angular-eslint/blob/main/docs/WRITING_CUSTOM_RULES.md|custom lint rules]].
+You can check out [[https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/sleary/WIPs/lint-template|this template branch]] and follow the instructions in index.js to create a new custom lint rule.
 ==== Angular Unit Tests ====
@@ Line 64: / Line 86: @@
 npm run test
 </code>
+=== Common things that break Angular unit tests ===
+== Changing DOM selectors ==
+If the test is expecting a certain DOM element, but you change the structure within an Angular template, the test might start failing.
+Note that you can use text of a button as a selector.  If the button text changes, you'll need to update the selector.
+To fix it: update the selector in the test.  Or perhaps the test can be made more general.
+== Adding a new service ==
+Adding a new service
+To fix it: add a mock for the new service in the test.  Or even better, consider if you can simplify or refactor the component so that it does not need many different services.
+== Lifecycle/timing issues ==
+Interacting with anything asynchronous (especially grid and combobox) requires some care!
+To fix it: You may be able to add a setTimeout.  Or use Angular's fakeAsync and tick.
 ==== Angular e2e (end-to-end) Tests ====
@@ Line 201: / Line 245: @@
 At time of writing, there is no equivalent to "live" tests for C code.
+{{tag>automated-tests}}