mirror of
https://github.com/pgadmin-org/pgadmin4.git
synced 2024-11-24 09:40:21 -06:00
115 lines
3.9 KiB
Plaintext
115 lines
3.9 KiB
Plaintext
pgAdmin 4 Test Framework
|
||
========================
|
||
|
||
This regression framework is designed to execute unit tests for all modules to
|
||
help catch regressions in the code.
|
||
|
||
Assumptions
|
||
-----------
|
||
|
||
- pgAdmin must be configured to run in Server mode, with SMTP configured.
|
||
- There should be a single server group present in the browser.
|
||
- Currently each module will have testcases related to ONLY GET, POST, PUT,
|
||
and DELETE api’s.
|
||
|
||
General Information
|
||
-------------------
|
||
|
||
1) The required test cases should be placed under the /tests directory of the
|
||
respective module.
|
||
|
||
- 'pgadmin/browser/tests' directory contains test-cases for following
|
||
modules:
|
||
|
||
1. Login Page
|
||
2. Reset Password Page
|
||
3. Change Password Page
|
||
4. Logout Page
|
||
|
||
- 'pgAdmin4/web/pgadmin/browser/server_groups/tests/' shows an example of
|
||
tree traversal of the pgAdmin modules and how the test folder is required
|
||
for each individual module.
|
||
|
||
- 'pgadmin/browser/server_groups/servers/tests/' directory will have separate
|
||
file for each test-case:
|
||
|
||
1. test_server_add.py
|
||
2. test_server_delete.py
|
||
3. test_server_get.py
|
||
4. test_server_update.py
|
||
|
||
2) The pgAdmin4 source tree includes 2 different configuration file templates.
|
||
One file template for the server configuration
|
||
named ‘test_config.json.in' and another for test configuration named
|
||
'test_advanced_config.json.in' in the ‘pgAdmin4/web/regression’ directory.
|
||
After completing the pgAdmin4 configuration, you must make a working copy of
|
||
the templates called test_config.json and test_advance_config.json
|
||
before modifying the file contents.
|
||
|
||
2a) The following command copies the test_config.json.in file, creating a
|
||
configuration file named test_config.json (same way user can copy
|
||
test_advance_config.json.in file into test_advance_config.json)
|
||
|
||
$ cp pgadmin4/web/regression/test_config.json.in \
|
||
pgadmin4/web/regression/test_config.json
|
||
|
||
2b) After creating the server and test configuration file, add (or modify)
|
||
parameter values as per requirements. The pgAdmin4 regression framework expects
|
||
to find the files in the directory '/<installation dir>/web/regression/'.
|
||
If you move the file to another location, you must create a symbolic
|
||
link that specifies the new location.
|
||
|
||
2c) Specifying Server Configuration file:
|
||
|
||
Server details and connection properties as per their local setup. The
|
||
test_config file is in JSON format and property values are
|
||
case-sensitive.
|
||
|
||
2d) Specifying the Test Configuration file:
|
||
|
||
The user can add/change test data as per their need. The
|
||
test_advanced_config file is in JSON format and property values are
|
||
case-sensitive.
|
||
|
||
|
||
Test Data Details
|
||
-----------------
|
||
|
||
"pgAdmin4 Login Credentials":
|
||
|
||
test_login_username = login id
|
||
test_login_password = login password
|
||
test_new_password = new login password
|
||
|
||
"test_server_credentials":
|
||
|
||
test_name = Server/database Name
|
||
test_db_username = Database Username
|
||
test_host = IP Address of Server
|
||
test_db_password = Database Password
|
||
test_db_port = Database Port
|
||
test_maintenance_db = Maintenance Database
|
||
test_sslmode = SSL Mode
|
||
test_comment = Any Comments to add
|
||
|
||
|
||
Execution:
|
||
-----------
|
||
|
||
- The test framework is modular and pluggable and dynamically locates tests
|
||
for modules which are discovered at runtime. All test cases are found
|
||
and registered automatically by its module name in
|
||
'pgadmin4/web/pgadmin/utils/test.py' file.
|
||
|
||
- Execute the test framework for all nodes
|
||
run 'regression/runtests.py --pkg all' or just:
|
||
'regression/runtests.py'
|
||
|
||
- Execute test framework for single node at a time
|
||
|
||
Example 1) Run test framework for 'browser' node
|
||
run 'regression/runtests.py --pkg browser'
|
||
|
||
Example 2) Run test framework for 'database' node
|
||
run 'regression/runtests.py --pkg browser.server_groups.servers.databases'
|