code.gitea.io/gitea@v1.22.3/tests/e2e/README.md (about)

     1  # End to end tests
     2  
     3  E2e tests largely follow the same syntax as [integration tests](../integration).
     4  Whereas integration tests are intended to mock and stress the back-end, server-side code, e2e tests the interface between front-end and back-end, as well as visual regressions with both assertions and visual comparisons.
     5  They can be run with make commands for the appropriate backends, namely:
     6  ```shell
     7  make test-sqlite
     8  make test-pgsql
     9  make test-mysql
    10  make test-mssql
    11  ```
    12  
    13  Make sure to perform a clean front-end build before running tests:
    14  ```
    15  make clean frontend
    16  ```
    17  
    18  ## Install playwright system dependencies
    19  ```
    20  npx playwright install-deps
    21  ```
    22  
    23  
    24  ## Run all tests via local act_runner
    25  ```
    26  act_runner exec -W ./.github/workflows/pull-e2e-tests.yml --event=pull_request --default-actions-url="https://github.com" -i catthehacker/ubuntu:runner-latest
    27  ```
    28  
    29  ## Run sqlite e2e tests
    30  Start tests
    31  ```
    32  make test-e2e-sqlite
    33  ```
    34  
    35  ## Run MySQL e2e tests
    36  Setup a MySQL database inside docker
    37  ```
    38  docker run -e "MYSQL_DATABASE=test" -e "MYSQL_ALLOW_EMPTY_PASSWORD=yes" -p 3306:3306 --rm --name mysql mysql:latest #(just ctrl-c to stop db and clean the container)
    39  docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" --rm --name elasticsearch elasticsearch:7.6.0 #(in a second terminal, just ctrl-c to stop db and clean the container)
    40  ```
    41  Start tests based on the database container
    42  ```
    43  TEST_MYSQL_HOST=localhost:3306 TEST_MYSQL_DBNAME=test TEST_MYSQL_USERNAME=root TEST_MYSQL_PASSWORD='' make test-e2e-mysql
    44  ```
    45  
    46  ## Run pgsql e2e tests
    47  Setup a pgsql database inside docker
    48  ```
    49  docker run -e "POSTGRES_DB=test" -p 5432:5432 --rm --name pgsql postgres:latest #(just ctrl-c to stop db and clean the container)
    50  ```
    51  Start tests based on the database container
    52  ```
    53  TEST_PGSQL_HOST=localhost:5432 TEST_PGSQL_DBNAME=test TEST_PGSQL_USERNAME=postgres TEST_PGSQL_PASSWORD=postgres make test-e2e-pgsql
    54  ```
    55  
    56  ## Run mssql e2e tests
    57  Setup a mssql database inside docker
    58  ```
    59  docker run -e "ACCEPT_EULA=Y" -e "MSSQL_PID=Standard" -e "SA_PASSWORD=MwantsaSecurePassword1" -p 1433:1433 --rm --name mssql microsoft/mssql-server-linux:latest #(just ctrl-c to stop db and clean the container)
    60  ```
    61  Start tests based on the database container
    62  ```
    63  TEST_MSSQL_HOST=localhost:1433 TEST_MSSQL_DBNAME=gitea_test TEST_MSSQL_USERNAME=sa TEST_MSSQL_PASSWORD=MwantsaSecurePassword1 make test-e2e-mssql
    64  ```
    65  
    66  ## Running individual tests
    67  
    68  Example command to run `example.test.e2e.js` test file:
    69  
    70  _Note: unlike integration tests, this filtering is at the file level, not function_
    71  
    72  For SQLite:
    73  
    74  ```
    75  make test-e2e-sqlite#example
    76  ```
    77  
    78  For other databases(replace `mssql` to `mysql` or `pgsql`):
    79  
    80  ```
    81  TEST_MSSQL_HOST=localhost:1433 TEST_MSSQL_DBNAME=test TEST_MSSQL_USERNAME=sa TEST_MSSQL_PASSWORD=MwantsaSecurePassword1 make test-e2e-mssql#example
    82  ```
    83  
    84  ## Visual testing
    85  
    86  Although the main goal of e2e is assertion testing, we have added a framework for visual regress testing. If you are working on front-end features, please use the following:
    87   - Check out `main`, `make clean frontend`, and run e2e tests with `VISUAL_TEST=1` to generate outputs. This will initially fail, as no screenshots exist. You can run the e2e tests again to assert it passes.
    88   - Check out your branch, `make clean frontend`, and run e2e tests with `VISUAL_TEST=1`. You should be able to assert you front-end changes don't break any other tests unintentionally. 
    89  
    90  VISUAL_TEST=1 will create screenshots in tests/e2e/test-snapshots. The test will fail the first time this is enabled (until we get visual test image persistence figured out), because it will be testing against an empty screenshot folder. 
    91  
    92  ACCEPT_VISUAL=1 will overwrite the snapshot images with new images.