Differences

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

--- dev:contributing:qa [2015/08/05 16:40] – add test case guidelines per 2015-08-05 dev meeting gmcharlton
+++ dev:contributing:qa [2025/09/09 14:55] (current) – lint section sleary
@@ Line 35: / Line 35: @@
 ===== Types of Tests =====
+==== AngularJS Unit Tests ====
+These test the Web Client apps.
+  * They are stored in ''Open-ILS/web/js/ui/default/staff/test/''
+  * See the [[https://code.angularjs.org/1.6.10/docs/guide/unit-testing#additional-tools-for-testing-angularjs-applications|official instructions]] for details.
+Running the tests:
+  * See the [[https://evergreen-ils.org/documentation/install/README_3_1.html#install_files_for_web_staff_client|Evergreen README]] for up-to-date details.
+  * Steps to run the tests as of Evergreen 3.1:
+  cd $EVERGREEN_ROOT/Open-ILS/web/js/ui/default/staff/
+  # fetch JS dependencies, described in package.json
+  npm install
+  # build, run tests, concat+minify
+  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 ====
+See [[dev:angular_dev_best_practices#unit_tests|Evergreen Angular Development Best Practices]]
+To run on a running Evergreen server:
+<code sh>
+cd Open-ILS/src/eg2
+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 ====
+To run with a GUI:
+<code sh>
+cd Open-ILS/src/eg2
+ng e2e
+</code>
+To run without a GUI:
+<code sh>
+cd Open-ILS/src/eg2
+MOZ_HEADLESS=1 ng e2e
+</code>
+To run in Chrome instead of Firefox:
+<code sh>
+cd Open-ILS/src/eg2
+npm install --save-dev chromedriver
+ng e2e --env chrome # with the GUI
+ng e2e --env chrome-headless # without the GUI
+</code>
+For more tips and documentation, visit the [[https://github.com/evergreen-library-system/Evergreen/blob/main/Open-ILS/src/eg2/CHEAT_SHEET.adoc|Angular client cheat sheet]] and the [[https://nightwatchjs.org/v26/|Nightwatch documentation]].
+==== OPAC Javascript Unit Tests ====
+To run tests for the javascript in the OPAC:
+<code sh>
+cd Open-ILS/web/opac/deps
+npm i && npm run test
+</code>
 ==== Perl Unit Tests ====
@@ Line 95: / Line 202: @@
 The "pgtap" package, which is not part of a standard Evergreen installation, must be installed and the extension must be added to your Evergreen database:
+Install pgtap from source, the versions in Debian/Ubuntu are not well maintained and are from 2011 when they exist at all. Old versions don't contain all the functions used by Evergreen pgtap tests.
+  * Download from - http://pgxn.org/dist/pgtap/
+  * Install Instructions - http://pgtap.org/documentation.html#installation
+  * Install the package for libtap-parser-sourcehandler-pgtap-perl which provides pg_prove.
 <code sh>
-sudo apt-get install pgtap # debian/ubuntu version
+apt-get install libtap-parser-sourcehandler-pgtap-perl #Debian/Ubuntu provides pg_prove
 psql -U evergreen [other DB connection params] -c "CREATE EXTENSION pgtap;"
 </code>
@@ Line 120: / Line 233: @@
 <code sh>
 cd Open-ILS/src/sql/Pg
-pg_prove -U evergreen [other DB connection params] t_live
+pg_prove -U evergreen [other DB connection params] live_t
 </code>
@@ Line 132: / Line 245: @@
 At time of writing, there is no equivalent to "live" tests for C code.
+{{tag>automated-tests}}