0
0
Fork 0
mirror of https://github.com/go-gitea/gitea synced 2024-12-25 18:24:39 +01:00
gitea/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>
2023-03-29 14:32:26 +08:00
..
migration-test Refactor setting.Database.UseXXX to methods (#23354) 2023-03-07 18:51:06 +08:00
schemas verify nodeinfo response by schema (#22137) 2022-12-17 01:22:34 -05:00
admin_user_test.go
api_activitypub_person_test.go
api_admin_org_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_admin_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_branch_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_comment_attachment_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_comment_test.go Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
api_feed_user_test.go
api_fork_test.go
api_gpg_keys_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_helper_for_declarative_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_httpsig_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_issue_attachment_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_issue_config_test.go Implement Issue Config (#20956) 2023-03-28 14:22:07 -04:00
api_issue_label_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_issue_milestone_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_issue_reaction_test.go Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
api_issue_stopwatch_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_issue_subscription_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_issue_test.go Scoped labels (#22585) 2023-02-18 21:17:39 +02:00
api_issue_tracked_time_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_keys_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_nodeinfo_test.go Scoped labels (#22585) 2023-02-18 21:17:39 +02:00
api_notification_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_oauth2_apps_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_org_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_packages_cargo_test.go Add Cargo package registry (#21888) 2023-02-05 18:12:31 +08:00
api_packages_chef_test.go Use minio/sha256-simd for accelerated SHA256 (#23052) 2023-02-22 14:21:46 -05:00
api_packages_composer_test.go Remove all package data after tests (#22984) 2023-02-23 22:11:56 +08:00
api_packages_conan_test.go Remove all package data after tests (#22984) 2023-02-23 22:11:56 +08:00
api_packages_conda_test.go Add Conda package registry (#22262) 2023-02-01 12:30:39 -06:00
api_packages_container_test.go Remove all package data after tests (#22984) 2023-02-23 22:11:56 +08:00
api_packages_generic_test.go Remove all package data after tests (#22984) 2023-02-23 22:11:56 +08:00
api_packages_helm_test.go Remove all package data after tests (#22984) 2023-02-23 22:11:56 +08:00
api_packages_maven_test.go Remove all package data after tests (#22984) 2023-02-23 22:11:56 +08:00
api_packages_npm_test.go Return repository in npm package metadata endpoint (#23539) 2023-03-17 14:39:19 -04:00
api_packages_nuget_test.go Add /$count endpoints for NuGet v2 (#22855) 2023-02-11 19:30:44 +08:00
api_packages_pub_test.go Remove all package data after tests (#22984) 2023-02-23 22:11:56 +08:00
api_packages_pypi_test.go Remove all package data after tests (#22984) 2023-02-23 22:11:56 +08:00
api_packages_rubygems_test.go Remove all package data after tests (#22984) 2023-02-23 22:11:56 +08:00
api_packages_swift_test.go Add Swift package registry (#22404) 2023-03-13 15:28:39 -05:00
api_packages_test.go Remove all package data after tests (#22984) 2023-02-23 22:11:56 +08:00
api_packages_vagrant_test.go Remove deprecated packages & staticcheck fixes (#22012) 2022-12-02 17:06:23 -05:00
api_private_serv_test.go Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687) 2023-03-29 14:32:26 +08:00
api_pull_commits_test.go Remove session in api tests (#21984) 2022-12-01 22:39:42 -05:00
api_pull_review_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_pull_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_releases_test.go Add API endpoint to get latest release (#21267) 2023-01-26 10:33:47 -06:00
api_repo_archive_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_collaborator_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_edit_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_file_create_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_file_delete_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_file_get_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_file_helpers.go
api_repo_file_update_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_get_contents_list_test.go Remove session in api tests (#21984) 2022-12-01 22:39:42 -05:00
api_repo_get_contents_test.go Remove session in api tests (#21984) 2022-12-01 22:39:42 -05:00
api_repo_git_blobs_test.go Remove session in api tests (#21984) 2022-12-01 22:39:42 -05:00
api_repo_git_commits_test.go Remove session in api tests (#21984) 2022-12-01 22:39:42 -05:00
api_repo_git_hook_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_git_notes_test.go Remove session in api tests (#21984) 2022-12-01 22:39:42 -05:00
api_repo_git_ref_test.go Remove session in api tests (#21984) 2022-12-01 22:39:42 -05:00
api_repo_git_tags_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_git_trees_test.go Remove session in api tests (#21984) 2022-12-01 22:39:42 -05:00
api_repo_hook_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_languages_test.go Remove session in api tests (#21984) 2022-12-01 22:39:42 -05:00
api_repo_lfs_locks_test.go
api_repo_lfs_migrate_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_lfs_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_raw_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_tags_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_teams_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_topic_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_settings_test.go
api_team_test.go Rename GetUnits to LoadUnits (#22970) 2023-02-19 16:31:39 +08:00
api_team_user_test.go Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
api_token_test.go
api_user_email_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_user_follow_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_user_heatmap_test.go
api_user_info_test.go
api_user_org_perm_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_user_orgs_test.go Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
api_user_search_test.go Remove session in api tests (#21984) 2022-12-01 22:39:42 -05:00
api_user_star_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_user_watch_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_wiki_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
attachment_test.go
auth_ldap_test.go Map OIDC groups to Orgs/Teams (#21441) 2023-02-08 14:44:42 +08:00
benchmarks_test.go
branches_test.go
change_default_branch_test.go
cmd_keys_test.go
compare_test.go Use beforeCommit instead of baseCommit (#22949) 2023-02-20 11:56:07 +08:00
cors_test.go
create_no_session_test.go
csrf_test.go
delete_user_test.go
download_test.go Remove deprecated packages & staticcheck fixes (#22012) 2022-12-02 17:06:23 -05:00
dump_restore_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
editor_test.go Supports wildcard protected branch (#20825) 2023-01-16 16:00:22 +08:00
empty_repo_test.go Improve testing for pgsql empty repository (#22223) 2022-12-23 12:34:51 -06:00
eventsource_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
explore_repos_test.go
git_clone_wiki_test.go
git_helper_for_declarative_test.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
git_smart_http_test.go
git_test.go Fix hidden commit status on multiple checks (#22889) 2023-02-20 16:43:04 +08:00
goget_test.go
gpg_git_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
html_helper.go
incoming_email_test.go Add support for incoming emails (#22056) 2023-01-14 23:57:10 +08:00
integration_test.go Refactor the setting to make unit test easier (#22405) 2023-02-20 00:12:01 +08:00
issue_test.go Scoped labels (#22585) 2023-02-18 21:17:39 +02:00
lfs_getobject_test.go Use context parameter in models/git (#22367) 2023-01-09 11:50:54 +08:00
lfs_local_endpoint_test.go
lfs_view_test.go Test views of LFS files (#22196) 2022-12-23 07:41:56 +08:00
links_test.go
markup_external_test.go Refactor setting.Database.UseXXX to methods (#23354) 2023-03-07 18:51:06 +08:00
migrate_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
mirror_pull_test.go Rename almost all Ctx functions (#22071) 2022-12-10 10:46:31 +08:00
mirror_push_test.go
nonascii_branches_test.go Remove deprecated packages & staticcheck fixes (#22012) 2022-12-02 17:06:23 -05:00
oauth_test.go
org_count_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
org_team_invite_test.go
org_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
private-testing.key
privateactivity_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
pull_compare_test.go
pull_create_test.go
pull_merge_test.go Use context parameter in services/repository (#23186) 2023-02-28 16:17:51 -06:00
pull_review_test.go
pull_status_test.go Fix hidden commit status on multiple checks (#22889) 2023-02-20 16:43:04 +08:00
pull_update_test.go Use context parameter in services/repository (#23186) 2023-02-28 16:17:51 -06:00
README.md
README_ZH.md
release_test.go Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
rename_branch_test.go Remove deprecated packages & staticcheck fixes (#22012) 2022-12-02 17:06:23 -05:00
repo_activity_test.go
repo_branch_test.go
repo_commits_search_test.go
repo_commits_test.go Fix hidden commit status on multiple checks (#22889) 2023-02-20 16:43:04 +08:00
repo_fork_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_generate_test.go
repo_migrate_test.go
repo_search_test.go refactor some functions to support ctx as first parameter (#21878) 2022-12-03 10:48:26 +08:00
repo_tag_test.go Use context parameter in models/git (#22367) 2023-01-09 11:50:54 +08:00
repo_test.go Use data-tooltip-content for tippy tooltip (#23649) 2023-03-24 18:35:38 +08:00
repo_topic_test.go
repo_watch_test.go
repofiles_delete_test.go
repofiles_update_test.go
setting_test.go Fix profile page email display, respect settings (#23747) 2023-03-27 17:27:32 -04:00
signin_test.go
signout_test.go Remove test session cache to reduce possible concurrent problem (#22199) 2022-12-22 21:09:35 +08:00
signup_test.go
ssh_key_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
timetracking_test.go
user_avatar_test.go Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
user_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
version_test.go
view_test.go
webfinger_test.go
xss_test.go

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