mirror of
https://github.com/go-gitea/gitea.git
synced 2024-12-04 14:46:57 -05:00
5bb8d1924d
Closes https://github.com/go-gitea/gitea/issues/5512 This PR adds basic SAML support - Adds SAML 2.0 as an auth source - Adds SAML configuration documentation - Adds integration test: - Use bare-bones SAML IdP to test protocol flow and test account is linked successfully (only runs on Postgres by default) - Adds documentation for configuring and running SAML integration test locally Future PRs: - Support group mapping - Support auto-registration (account linking) Co-Authored-By: @jackHay22 --------- Co-authored-by: jackHay22 <jack@allspice.io> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: KN4CK3R <admin@oldschoolhack.me> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: Jason Song <i@wolfogre.com> Co-authored-by: morphelinho <morphelinho@users.noreply.github.com> Co-authored-by: Zettat123 <zettat123@gmail.com> Co-authored-by: Yarden Shoham <git@yardenshoham.com> Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: silverwind <me@silverwind.io>
130 lines
3.8 KiB
Markdown
130 lines
3.8 KiB
Markdown
# Integration tests
|
|
|
|
Integration tests can be run with make commands for the
|
|
appropriate backends, namely:
|
|
```shell
|
|
make test-sqlite
|
|
make test-pgsql
|
|
make test-mysql
|
|
make test-mssql
|
|
```
|
|
|
|
Make sure to perform a clean build before running tests:
|
|
```
|
|
make clean build
|
|
```
|
|
|
|
## Run tests via local act_runner
|
|
|
|
### Run all jobs
|
|
|
|
```
|
|
act_runner exec -W ./.github/workflows/pull-db-tests.yml --event=pull_request --default-actions-url="https://github.com" -i catthehacker/ubuntu:runner-latest
|
|
```
|
|
|
|
Warning: This file defines many jobs, so it will be resource-intensive and therefor not recommended.
|
|
|
|
### Run single job
|
|
|
|
```SHELL
|
|
act_runner exec -W ./.github/workflows/pull-db-tests.yml --event=pull_request --default-actions-url="https://github.com" -i catthehacker/ubuntu:runner-latest -j <job_name>
|
|
```
|
|
|
|
You can list all job names via:
|
|
|
|
```SHELL
|
|
act_runner exec -W ./.github/workflows/pull-db-tests.yml --event=pull_request --default-actions-url="https://github.com" -i catthehacker/ubuntu:runner-latest -l
|
|
```
|
|
|
|
## Run sqlite integration tests
|
|
Start tests
|
|
```
|
|
make test-sqlite
|
|
```
|
|
|
|
## Run MySQL integration tests
|
|
Setup a MySQL database inside docker
|
|
```
|
|
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)
|
|
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)
|
|
```
|
|
Start tests based on the database container
|
|
```
|
|
TEST_MYSQL_HOST=localhost:3306 TEST_MYSQL_DBNAME=test TEST_MYSQL_USERNAME=root TEST_MYSQL_PASSWORD='' make test-mysql
|
|
```
|
|
|
|
## Run pgsql integration tests
|
|
Setup a pgsql database inside docker
|
|
```
|
|
docker run -e "POSTGRES_DB=test" -p 5432:5432 --rm --name pgsql postgres:latest #(just ctrl-c to stop db and clean the container)
|
|
```
|
|
Start tests based on the database container
|
|
```
|
|
TEST_PGSQL_HOST=localhost:5432 TEST_PGSQL_DBNAME=test TEST_PGSQL_USERNAME=postgres TEST_PGSQL_PASSWORD=postgres make test-pgsql
|
|
```
|
|
|
|
## Run mssql integration tests
|
|
Setup a mssql database inside docker
|
|
```
|
|
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)
|
|
```
|
|
Start tests based on the database container
|
|
```
|
|
TEST_MSSQL_HOST=localhost:1433 TEST_MSSQL_DBNAME=gitea_test TEST_MSSQL_USERNAME=sa TEST_MSSQL_PASSWORD=MwantsaSecurePassword1 make test-mssql
|
|
```
|
|
|
|
## Running individual tests
|
|
|
|
Example command to run GPG test:
|
|
|
|
For SQLite:
|
|
|
|
```
|
|
make test-sqlite#GPG
|
|
```
|
|
|
|
For other databases(replace `mssql` to `mysql`, or `pgsql`):
|
|
|
|
```
|
|
TEST_MSSQL_HOST=localhost:1433 TEST_MSSQL_DBNAME=test TEST_MSSQL_USERNAME=sa TEST_MSSQL_PASSWORD=MwantsaSecurePassword1 make test-mssql#GPG
|
|
```
|
|
|
|
## Setting timeouts for declaring long-tests and long-flushes
|
|
|
|
We appreciate that some testing machines may not be very powerful and
|
|
the default timeouts for declaring a slow test or a slow clean-up flush
|
|
may not be appropriate.
|
|
|
|
You can either:
|
|
|
|
* Within the test ini file set the following section:
|
|
|
|
```ini
|
|
[integration-tests]
|
|
SLOW_TEST = 10s ; 10s is the default value
|
|
SLOW_FLUSH = 5S ; 5s is the default value
|
|
```
|
|
|
|
* Set the following environment variables:
|
|
|
|
```bash
|
|
GITEA_SLOW_TEST_TIME="10s" GITEA_SLOW_FLUSH_TIME="5s" make test-sqlite
|
|
```
|
|
|
|
## Running SimpleSAML for testing SAML locally
|
|
|
|
```shell
|
|
docker run \
|
|
-p 8080:8080 \
|
|
-p 8443:8443 \
|
|
-e SIMPLESAMLPHP_SP_ENTITY_ID=http://localhost:3003/user/saml/test-sp/metadata \
|
|
-e SIMPLESAMLPHP_SP_ASSERTION_CONSUMER_SERVICE=http://localhost:3003/user/saml/test-sp/acs \
|
|
-e SIMPLESAMLPHP_SP_SINGLE_LOGOUT_SERVICE=http://localhost:3003/user/saml/test-sp/acs \
|
|
--add-host=localhost:192.168.65.2 \
|
|
-d allspice/simple-saml
|
|
```
|
|
|
|
```shell
|
|
TEST_SIMPLESAML_URL=localhost:8080 make test-sqlite#TestSAMLRegistration
|
|
```
|