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.
forgejo/tests/integration
wxiaoguang f4538791f5
Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687)
# Why this PR comes

At first, I'd like to help users like #23636 (there are a lot)

The unclear "Internal Server Error" is quite anonying, scare users,
frustrate contributors, nobody knows what happens.

So, it's always good to provide meaningful messages to end users (of
course, do not leak sensitive information).

When I started working on the "response message to end users", I found
that the related code has a lot of technical debt. A lot of copy&paste
code, unclear fields and usages.

So I think it's good to make everything clear.

# Tech Backgrounds

Gitea has many sub-commands, some are used by admins, some are used by
SSH servers or Git Hooks. Many sub-commands use "internal API" to
communicate with Gitea web server.

Before, Gitea server always use `StatusCode + Json "err" field` to
return messages.

* The CLI sub-commands: they expect to show all error related messages
to site admin
* The Serv/Hook sub-commands (for git clients): they could only show
safe messages to end users, the error log could only be recorded by
"SSHLog" to Gitea web server.

In the old design, it assumes that:

* If the StatusCode is 500 (in some functions), then the "err" field is
error log, shouldn't be exposed to git client.
* If the StatusCode is 40x, then the "err" field could be exposed. And
some functions always read the "err" no matter what the StatusCode is.

The old code is not strict, and it's difficult to distinguish the
messages clearly and then output them correctly.

# This PR

To help to remove duplicate code and make everything clear, this PR
introduces `ResponseExtra` and `requestJSONResp`.

* `ResponseExtra` is a struct which contains "extra" information of a
internal API response, including StatusCode, UserMsg, Error
* `requestJSONResp` is a generic function which can be used for all
cases to help to simplify the calls.
* Remove all `map["err"]`, always use `private.Response{Err}` to
construct error messages.
* User messages and error messages are separated clearly, the `fail` and
`handleCliResponseExtra` will output correct messages.
* Replace all `Internal Server Error` messages with meaningful (still
safe) messages.

This PR saves more than 300 lines, while makes the git client messages
more clear.

Many gitea-serv/git-hook related essential functions are covered by
tests.

---------

Co-authored-by: delvh <dev.lh@web.de>
1 year ago
..
migration-test Refactor `setting.Database.UseXXX` to methods (#23354) 1 year ago
schemas verify nodeinfo response by schema (#22137) 2 years ago
README.md Kd/ci playwright go test (#20123) 2 years ago
README_ZH.md Kd/ci playwright go test (#20123) 2 years ago
admin_user_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
api_activitypub_person_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
api_admin_org_test.go Support scoped access tokens (#20908) 2 years ago
api_admin_test.go Support scoped access tokens (#20908) 2 years ago
api_branch_test.go Support scoped access tokens (#20908) 2 years ago
api_comment_attachment_test.go Support scoped access tokens (#20908) 2 years ago
api_comment_test.go Add context cache as a request level cache (#22294) 1 year 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_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 Implement Issue Config (#20956) 1 year 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) 1 year 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) 1 year 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_nodeinfo_test.go Scoped labels (#22585) 1 year 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 Support scoped access tokens (#20908) 2 years ago
api_packages_cargo_test.go Add Cargo package registry (#21888) 1 year ago
api_packages_chef_test.go Use minio/sha256-simd for accelerated SHA256 (#23052) 1 year ago
api_packages_composer_test.go Remove all package data after tests (#22984) 1 year ago
api_packages_conan_test.go Remove all package data after tests (#22984) 1 year ago
api_packages_conda_test.go Add Conda package registry (#22262) 1 year ago
api_packages_container_test.go Remove all package data after tests (#22984) 1 year ago
api_packages_generic_test.go Remove all package data after tests (#22984) 1 year ago
api_packages_helm_test.go Remove all package data after tests (#22984) 1 year ago
api_packages_maven_test.go Remove all package data after tests (#22984) 1 year ago
api_packages_npm_test.go Return `repository` in npm package metadata endpoint (#23539) 1 year ago
api_packages_nuget_test.go Add `/$count` endpoints for NuGet v2 (#22855) 1 year ago
api_packages_pub_test.go Remove all package data after tests (#22984) 1 year ago
api_packages_pypi_test.go Remove all package data after tests (#22984) 1 year ago
api_packages_rubygems_test.go Remove all package data after tests (#22984) 1 year ago
api_packages_swift_test.go Add Swift package registry (#22404) 1 year ago
api_packages_test.go Remove all package data after tests (#22984) 1 year ago
api_packages_vagrant_test.go Remove deprecated packages & staticcheck fixes (#22012) 2 years ago
api_private_serv_test.go Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687) 1 year ago
api_pull_commits_test.go Remove session in api tests (#21984) 2 years ago
api_pull_review_test.go Support scoped access tokens (#20908) 2 years ago
api_pull_test.go Support scoped access tokens (#20908) 2 years ago
api_releases_test.go Add API endpoint to get latest release (#21267) 2 years ago
api_repo_archive_test.go Support scoped access tokens (#20908) 2 years ago
api_repo_collaborator_test.go Support scoped access tokens (#20908) 2 years ago
api_repo_edit_test.go Support scoped access tokens (#20908) 2 years ago
api_repo_file_create_test.go Support scoped access tokens (#20908) 2 years ago
api_repo_file_delete_test.go Support scoped access tokens (#20908) 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 Support scoped access tokens (#20908) 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 Remove session in api tests (#21984) 2 years ago
api_repo_git_blobs_test.go Remove session in api tests (#21984) 2 years ago
api_repo_git_commits_test.go Remove session in api tests (#21984) 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 Support scoped access tokens (#20908) 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 Rename `GetUnits` to `LoadUnits` (#22970) 1 year ago
api_team_user_test.go Add context cache as a request level cache (#22294) 1 year 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) 1 year 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 Map OIDC groups to Orgs/Teams (#21441) 1 year 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) 1 year ago
cors_test.go Implement FSFE REUSE for golang files (#21840) 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 Supports wildcard protected branch (#20825) 2 years ago
empty_repo_test.go Improve testing for pgsql empty repository (#22223) 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) 1 year ago
git_smart_http_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
git_test.go Fix hidden commit status on multiple checks (#22889) 1 year ago
goget_test.go Implement FSFE REUSE for golang files (#21840) 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 Refactor the setting to make unit test easier (#22405) 1 year ago
issue_test.go Scoped labels (#22585) 1 year ago
lfs_getobject_test.go Use context parameter in models/git (#22367) 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 Refactor `setting.Database.UseXXX` to methods (#23354) 1 year 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 Implement FSFE REUSE for golang files (#21840) 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 Implement FSFE REUSE for golang files (#21840) 2 years ago
pull_create_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
pull_merge_test.go Use context parameter in services/repository (#23186) 1 year 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) 1 year ago
pull_update_test.go Use context parameter in services/repository (#23186) 1 year ago
release_test.go Move helpers to be prefixed with `gt-` (#22879) 1 year 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 Fix hidden commit status on multiple checks (#22889) 1 year 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 Use data-tooltip-content for tippy tooltip (#23649) 1 year 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 Fix profile page email display, respect settings (#23747) 1 year 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 Add context cache as a request level cache (#22294) 1 year ago
user_test.go Support scoped access tokens (#20908) 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 Implement FSFE REUSE for golang files (#21840) 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 all tests via local drone

drone exec --local --build-event "pull_request"

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