You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gitea/tests/integration
wxiaoguang 4647660776
Rewrite logger system (#24726)
## ⚠️ Breaking

The `log.<mode>.<logger>` style config has been dropped. If you used it,
please check the new config manual & app.example.ini to make your
instance output logs as expected.

Although many legacy options still work, it's encouraged to upgrade to
the new options.

The SMTP logger is deleted because SMTP is not suitable to collect logs.

If you have manually configured Gitea log options, please confirm the
logger system works as expected after upgrading.

## Description

Close #12082 and maybe more log-related issues, resolve some related
FIXMEs in old code (which seems unfixable before)

Just like rewriting queue #24505 : make code maintainable, clear legacy
bugs, and add the ability to support more writers (eg: JSON, structured
log)

There is a new document (with examples): `logging-config.en-us.md`

This PR is safer than the queue rewriting, because it's just for
logging, it won't break other logic.

## The old problems

The logging system is quite old and difficult to maintain:
* Unclear concepts: Logger, NamedLogger, MultiChannelledLogger,
SubLogger, EventLogger, WriterLogger etc
* Some code is diffuclt to konw whether it is right:
`log.DelNamedLogger("console")` vs `log.DelNamedLogger(log.DEFAULT)` vs
`log.DelLogger("console")`
* The old system heavily depends on ini config system, it's difficult to
create new logger for different purpose, and it's very fragile.
* The "color" trick is difficult to use and read, many colors are
unnecessary, and in the future structured log could help
* It's difficult to add other log formats, eg: JSON format
* The log outputer doesn't have full control of its goroutine, it's
difficult to make outputer have advanced behaviors
* The logs could be lost in some cases: eg: no Fatal error when using
CLI.
* Config options are passed by JSON, which is quite fragile.
* INI package makes the KEY in `[log]` section visible in `[log.sub1]`
and `[log.sub1.subA]`, this behavior is quite fragile and would cause
more unclear problems, and there is no strong requirement to support
`log.<mode>.<logger>` syntax.


## The new design

See `logger.go` for documents.


## Screenshot

<details>


![image](https://github.com/go-gitea/gitea/assets/2114189/4462d713-ba39-41f5-bb08-de912e67e1ff)


![image](https://github.com/go-gitea/gitea/assets/2114189/b188035e-f691-428b-8b2d-ff7b2199b2f9)


![image](https://github.com/go-gitea/gitea/assets/2114189/132e9745-1c3b-4e00-9e0d-15eaea495dee)

</details>

## TODO

* [x] add some new tests
* [x] fix some tests
* [x] test some sub-commands (manually ....)

---------

Co-authored-by: Jason Song <i@wolfogre.com>
Co-authored-by: delvh <dev.lh@web.de>
Co-authored-by: Giteabot <teabot@gitea.io>
2 years ago
..
migration-test Rewrite logger system (#24726) 2 years ago
schemas verify nodeinfo response by schema (#22137) 2 years ago
README.md replace `drone exec` to `act_runner exec` in test README.md (#24791) 2 years ago
README_ZH.md replace `drone exec` to `act_runner exec` in test README.md (#24791) 2 years ago
admin_user_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
api_actions_artifact_test.go Implement actions artifacts (#22738) 2 years ago
api_activitypub_person_test.go Use User.ID instead of User.Name in ActivityPub API for Person IRI (#23823) 2 years ago
api_admin_org_test.go Support scoped access tokens (#20908) 2 years ago
api_admin_test.go Refactor rename user and rename organization (#24052) 2 years ago
api_branch_test.go Rewrite queue (#24505) 2 years ago
api_comment_attachment_test.go Use more specific test methods (#24265) 2 years ago
api_comment_test.go Use more specific test methods (#24265) 2 years ago
api_feed_user_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
api_fork_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
api_gitignore_templates_test.go Add API for gitignore templates (#22783) 2 years ago
api_gpg_keys_test.go Support scoped access tokens (#20908) 2 years ago
api_helper_for_declarative_test.go Support scoped access tokens (#20908) 2 years ago
api_httpsig_test.go Support scoped access tokens (#20908) 2 years ago
api_issue_attachment_test.go Support scoped access tokens (#20908) 2 years ago
api_issue_config_test.go Use more specific test methods (#24265) 2 years ago
api_issue_label_test.go Support scoped access tokens (#20908) 2 years ago
api_issue_milestone_test.go Support scoped access tokens (#20908) 2 years ago
api_issue_reaction_test.go Add context cache as a request level cache (#22294) 2 years ago
api_issue_stopwatch_test.go Support scoped access tokens (#20908) 2 years ago
api_issue_subscription_test.go Support scoped access tokens (#20908) 2 years ago
api_issue_test.go Scoped labels (#22585) 2 years ago
api_issue_tracked_time_test.go Support scoped access tokens (#20908) 2 years ago
api_keys_test.go Support scoped access tokens (#20908) 2 years ago
api_license_templates_test.go Add API for License templates (#23009) 2 years ago
api_nodeinfo_test.go Support "." char as user name for User/Orgs in RSS/ATOM/GPG/KEYS path ... (#23874) 2 years ago
api_notification_test.go Support scoped access tokens (#20908) 2 years ago
api_oauth2_apps_test.go Support scoped access tokens (#20908) 2 years ago
api_org_test.go Fix access token issue on some public endpoints (#24194) 2 years ago
api_packages_alpine_test.go Add Alpine package registry (#23714) 2 years ago
api_packages_cargo_test.go Implement Cargo HTTP index (#24452) 2 years ago
api_packages_chef_test.go Use minio/sha256-simd for accelerated SHA256 (#23052) 2 years ago
api_packages_composer_test.go Remove all package data after tests (#22984) 2 years ago
api_packages_conan_test.go Remove all package data after tests (#22984) 2 years ago
api_packages_conda_test.go Add Conda package registry (#22262) 2 years ago
api_packages_container_test.go Display image size for multiarch container images (#23821) 2 years ago
api_packages_debian_test.go Add Debian package registry (#24426) 2 years ago
api_packages_generic_test.go Remove all package data after tests (#22984) 2 years ago
api_packages_goproxy_test.go Add Go package registry (#24687) 2 years ago
api_packages_helm_test.go Remove all package data after tests (#22984) 2 years ago
api_packages_maven_test.go Remove all package data after tests (#22984) 2 years ago
api_packages_npm_test.go Require repo scope for PATs for private repos and basic authentication (#24362) 2 years ago
api_packages_nuget_test.go Require repo scope for PATs for private repos and basic authentication (#24362) 2 years ago
api_packages_pub_test.go Require repo scope for PATs for private repos and basic authentication (#24362) 2 years ago
api_packages_pypi_test.go Remove all package data after tests (#22984) 2 years ago
api_packages_rpm_test.go Add RPM registry (#23380) 2 years ago
api_packages_rubygems_test.go Remove all package data after tests (#22984) 2 years ago
api_packages_swift_test.go Add Swift package registry (#22404) 2 years ago
api_packages_test.go Improve permission check of packages (#23879) 2 years ago
api_packages_vagrant_test.go Require repo scope for PATs for private repos and basic authentication (#24362) 2 years ago
api_private_serv_test.go Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687) 2 years ago
api_pull_commits_test.go Remove session in api tests (#21984) 2 years ago
api_pull_review_test.go Use more specific test methods (#24265) 2 years ago
api_pull_test.go Use more specific test methods (#24265) 2 years ago
api_releases_test.go Add API endpoint to get latest release (#21267) 2 years ago
api_repo_archive_test.go Use more specific test methods (#24265) 2 years ago
api_repo_collaborator_test.go Support scoped access tokens (#20908) 2 years ago
api_repo_edit_test.go Use more specific test methods (#24265) 2 years ago
api_repo_file_create_test.go Use double quotes consistently in en-US (#24141) 2 years ago
api_repo_file_delete_test.go Use double quotes consistently in en-US (#24141) 2 years ago
api_repo_file_get_test.go Support scoped access tokens (#20908) 2 years ago
api_repo_file_helpers.go Implement FSFE REUSE for golang files (#21840) 2 years ago
api_repo_file_update_test.go Use double quotes consistently in en-US (#24141) 2 years ago
api_repo_get_contents_list_test.go Remove session in api tests (#21984) 2 years ago
api_repo_get_contents_test.go Add integration test for API raw content reference formats (#24388) 2 years ago
api_repo_git_blobs_test.go Remove session in api tests (#21984) 2 years ago
api_repo_git_commits_test.go Filters for GetAllCommits (#24568) 2 years ago
api_repo_git_hook_test.go Support scoped access tokens (#20908) 2 years ago
api_repo_git_notes_test.go Remove session in api tests (#21984) 2 years ago
api_repo_git_ref_test.go Remove session in api tests (#21984) 2 years ago
api_repo_git_tags_test.go Support scoped access tokens (#20908) 2 years ago
api_repo_git_trees_test.go Remove session in api tests (#21984) 2 years ago
api_repo_hook_test.go Support scoped access tokens (#20908) 2 years ago
api_repo_languages_test.go Remove session in api tests (#21984) 2 years ago
api_repo_lfs_locks_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
api_repo_lfs_migrate_test.go Support scoped access tokens (#20908) 2 years ago
api_repo_lfs_test.go Support scoped access tokens (#20908) 2 years ago
api_repo_raw_test.go Support scoped access tokens (#20908) 2 years ago
api_repo_tags_test.go Support scoped access tokens (#20908) 2 years ago
api_repo_teams_test.go Support scoped access tokens (#20908) 2 years ago
api_repo_test.go Use more specific test methods (#24265) 2 years ago
api_repo_topic_test.go Support scoped access tokens (#20908) 2 years ago
api_settings_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
api_team_test.go Add test for api team orgnization (#24699) 2 years ago
api_team_user_test.go Add context cache as a request level cache (#22294) 2 years ago
api_token_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
api_user_email_test.go Support scoped access tokens (#20908) 2 years ago
api_user_follow_test.go Support scoped access tokens (#20908) 2 years ago
api_user_heatmap_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
api_user_info_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
api_user_org_perm_test.go Support scoped access tokens (#20908) 2 years ago
api_user_orgs_test.go Add context cache as a request level cache (#22294) 2 years ago
api_user_search_test.go Remove session in api tests (#21984) 2 years ago
api_user_star_test.go Support scoped access tokens (#20908) 2 years ago
api_user_watch_test.go Support scoped access tokens (#20908) 2 years ago
api_wiki_test.go Support scoped access tokens (#20908) 2 years ago
attachment_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
auth_ldap_test.go Use more specific test methods (#24265) 2 years ago
benchmarks_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
branches_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
change_default_branch_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
cmd_keys_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
compare_test.go Use beforeCommit instead of baseCommit (#22949) 2 years ago
cors_test.go Use more specific test methods (#24265) 2 years ago
create_no_session_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
csrf_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
delete_user_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
download_test.go Remove deprecated packages & staticcheck fixes (#22012) 2 years ago
dump_restore_test.go Support scoped access tokens (#20908) 2 years ago
editor_test.go Use double quotes consistently in en-US (#24141) 2 years ago
empty_repo_test.go Support uploading file to empty repo by API (#24357) 2 years ago
eventsource_test.go Support scoped access tokens (#20908) 2 years ago
explore_repos_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
git_clone_wiki_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
git_helper_for_declarative_test.go Refactor git command package to improve security and maintainability (#22678) 2 years ago
git_smart_http_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
git_test.go Use more specific test methods (#24265) 2 years ago
goget_test.go Support SSH for go get (#24664) 2 years ago
gpg_git_test.go Support scoped access tokens (#20908) 2 years ago
html_helper.go Implement FSFE REUSE for golang files (#21840) 2 years ago
incoming_email_test.go Add support for incoming emails (#22056) 2 years ago
integration_test.go Rewrite logger system (#24726) 2 years ago
issue_test.go Make Issue/PR/projects more compact, misc CSS tweaks (#24459) 2 years ago
lfs_getobject_test.go Fix auth check bug (#24382) 2 years ago
lfs_local_endpoint_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
lfs_view_test.go Test views of LFS files (#22196) 2 years ago
links_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
markup_external_test.go Drop "unrolled/render" package (#23965) 2 years ago
migrate_test.go Support scoped access tokens (#20908) 2 years ago
mirror_pull_test.go Rename almost all Ctx functions (#22071) 2 years ago
mirror_push_test.go Refactor cookie (#24107) 2 years ago
nonascii_branches_test.go Remove deprecated packages & staticcheck fixes (#22012) 2 years ago
oauth_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
org_count_test.go Support scoped access tokens (#20908) 2 years ago
org_team_invite_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
org_test.go Support scoped access tokens (#20908) 2 years ago
private-testing.key Kd/ci playwright go test (#20123) 2 years ago
privateactivity_test.go Support scoped access tokens (#20908) 2 years ago
pull_compare_test.go Rework header bar on issue, pull requests and milestone (#24420) 2 years ago
pull_create_test.go Improve RSS (#24335) 2 years ago
pull_merge_test.go Use more specific test methods (#24265) 2 years ago
pull_review_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
pull_status_test.go Fix hidden commit status on multiple checks (#22889) 2 years ago
pull_update_test.go Use context parameter in services/repository (#23186) 2 years ago
release_test.go fix: release page for empty or non-existing target (#24470) 2 years ago
rename_branch_test.go Remove deprecated packages & staticcheck fixes (#22012) 2 years ago
repo_activity_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
repo_branch_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
repo_commits_search_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
repo_commits_test.go Skip TestRepoCommitsStatusParallel on CI (#24741) 2 years ago
repo_fork_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
repo_generate_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
repo_migrate_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
repo_search_test.go refactor some functions to support ctx as first parameter (#21878) 2 years ago
repo_tag_test.go Use context parameter in models/git (#22367) 2 years ago
repo_test.go In TestViewRepo2, convert computed timezones to local time (#24579) 2 years ago
repo_topic_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
repo_watch_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
repofiles_delete_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
repofiles_update_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
setting_test.go Sort users and orgs on explore by recency by default (#24279) 2 years ago
signin_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
signout_test.go Remove test session cache to reduce possible concurrent problem (#22199) 2 years ago
signup_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
ssh_key_test.go Support scoped access tokens (#20908) 2 years ago
timetracking_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
user_avatar_test.go Reserve ".png" suffix for user/org names (#23992) 2 years ago
user_test.go Add RTL rendering support to Markdown (#24816) 2 years ago
version_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
view_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
webfinger_test.go Use User.ID instead of User.Name in ActivityPub API for Person IRI (#23823) 2 years ago
xss_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago

README.md

Integration tests

Integration tests can be run with make commands for the appropriate backends, namely:

make test-sqlite
make test-pgsql
make test-mysql
make test-mysql8
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

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:

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, mysql8 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:
[integration-tests]
SLOW_TEST = 10s ; 10s is the default value
SLOW_FLUSH = 5S ; 5s is the default value
  • Set the following environment variables:
GITEA_SLOW_TEST_TIME="10s" GITEA_SLOW_FLUSH_TIME="5s" make test-sqlite