forgejo/tests/integration
Chongyi Zheng de484e86bc
Support scoped access tokens (#20908)
This PR adds the support for scopes of access tokens, mimicking the
design of GitHub OAuth scopes.

The changes of the core logic are in `models/auth` that `AccessToken`
struct will have a `Scope` field. The normalized (no duplication of
scope), comma-separated scope string will be stored in `access_token`
table in the database.
In `services/auth`, the scope will be stored in context, which will be
used by `reqToken` middleware in API calls. Only OAuth2 tokens will have
granular token scopes, while others like BasicAuth will default to scope
`all`.
A large amount of work happens in `routers/api/v1/api.go` and the
corresponding `tests/integration` tests, that is adding necessary scopes
to each of the API calls as they fit.


- [x] Add `Scope` field to `AccessToken`
- [x] Add access control to all API endpoints
- [x] Update frontend & backend for when creating tokens
- [x] Add a database migration for `scope` column (enable 'all' access
to past tokens)

I'm aiming to complete it before Gitea 1.19 release.

Fixes #4300
2023-01-17 15:46:03 -06:00
..
migration-test
schemas
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 Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06: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_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 Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06: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 Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06: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
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_composer_test.go
api_packages_conan_test.go
api_packages_container_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_packages_generic_test.go
api_packages_helm_test.go
api_packages_maven_test.go
api_packages_npm_test.go
api_packages_nuget_test.go
api_packages_pub_test.go
api_packages_pypi_test.go
api_packages_rubygems_test.go
api_packages_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_packages_vagrant_test.go
api_private_serv_test.go
api_pull_commits_test.go
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 Support scoped access tokens (#20908) 2023-01-17 15:46:03 -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
api_repo_get_contents_test.go
api_repo_git_blobs_test.go
api_repo_git_commits_test.go
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
api_repo_git_ref_test.go
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
api_repo_hook_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_repo_languages_test.go
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 Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_team_user_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06: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 Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
api_user_search_test.go
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
benchmarks_test.go
branches_test.go
change_default_branch_test.go
cmd_keys_test.go
compare_test.go
cors_test.go
create_no_session_test.go
csrf_test.go
delete_user_test.go
download_test.go
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
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
git_smart_http_test.go
git_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06: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 Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
issue_test.go
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
links_test.go
markup_external_test.go
migrate_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
mirror_pull_test.go
mirror_push_test.go
nonascii_branches_test.go
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 Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
pull_review_test.go
pull_status_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
pull_update_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
README.md
README_ZH.md
release_test.go
rename_branch_test.go
repo_activity_test.go
repo_branch_test.go
repo_commits_search_test.go
repo_commits_test.go Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
repo_fork_test.go
repo_generate_test.go
repo_migrate_test.go
repo_search_test.go
repo_tag_test.go Use context parameter in models/git (#22367) 2023-01-09 11:50:54 +08:00
repo_test.go
repo_topic_test.go
repo_watch_test.go
repofiles_delete_test.go
repofiles_update_test.go
setting_test.go
signin_test.go
signout_test.go
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
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