forgejo/tests/integration
wxiaoguang 3c4153b195
[PORT] Refactor tests to prevent from unnecessary preparations (gitea#32398)
Some preparations are only used by a few tests, so to make the tests fast, they should only be prepared when they are used.

By the way, this PR splits PrepareTestEnv into small functions to make it simple.

---

Conflict resolution: Mostly magical and just re-pasting the code into
the right places.
Done differently: use `require.NoError` instead of `assert.NoError`.

(cherry picked from commit ec2d1593c269e06655525deb96f74b8094221b6f)
2024-11-07 23:02:10 +01:00
..
fixtures feat: combine review requests comments 2024-10-25 22:57:32 +02:00
migration-test
schemas
actions_commit_status_test.go Add branch auto deletion for scheduled PRs 2024-10-31 03:49:15 +01:00
actions_route_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
actions_trigger_test.go fix: labels are missing in the pull request payload removing a label 2024-11-06 16:43:14 +01:00
admin_config_test.go
admin_user_test.go
api_actions_artifact_test.go [PORT] Refactor tests to prevent from unnecessary preparations (gitea#32398) 2024-11-07 23:02:10 +01:00
api_actions_artifact_v4_test.go [PORT] Refactor tests to prevent from unnecessary preparations (gitea#32398) 2024-11-07 23:02:10 +01:00
api_activitypub_actor_test.go tests: improve actvititypub integration test code 2024-11-01 22:39:49 +01:00
api_activitypub_person_test.go tests: improve actvititypub integration test code 2024-11-01 22:39:49 +01:00
api_activitypub_repository_test.go tests: improve actvititypub integration test code 2024-11-01 22:39:49 +01:00
api_admin_org_test.go
api_admin_test.go
api_block_test.go
api_branch_test.go
api_comment_attachment_test.go
api_comment_test.go
api_feed_plain_text_titles_test.go
api_feed_user_test.go fix: don't show truncated comments in RSS/Atom feeds 2024-10-22 15:15:09 +02:00
api_forgejo_root_test.go
api_forgejo_version_test.go
api_fork_test.go
api_gitignore_templates_test.go
api_gpg_keys_test.go
api_health_test.go
api_helper_for_declarative_test.go
api_httpsig_test.go
api_issue_attachment_test.go
api_issue_config_test.go
api_issue_label_test.go
api_issue_milestone_test.go
api_issue_pin_test.go
api_issue_reaction_test.go
api_issue_stopwatch_test.go
api_issue_subscription_test.go
api_issue_templates_test.go
api_issue_test.go Fix bug when a token is given public only 2024-10-10 10:41:42 +03:00
api_issue_tracked_time_test.go
api_keys_test.go
api_label_templates_test.go
api_license_templates_test.go
api_nodeinfo_test.go
api_notification_test.go
api_oauth2_apps_test.go
api_org_avatar_test.go
api_org_test.go
api_packages_alpine_test.go
api_packages_arch_test.go fix arch pkg 2024-10-21 10:08:57 +08:00
api_packages_cargo_test.go
api_packages_chef_test.go
api_packages_composer_test.go Add bin to Composer Metadata (#32099) 2024-09-27 08:42:48 +02:00
api_packages_conan_test.go [SEC] Ensure propagation of API scopes for Conan and Container authentication 2024-08-28 10:33:32 +02:00
api_packages_conda_test.go
api_packages_container_cleanup_sha256_test.go cron task to cleanup dangling container images with version sha256:* 2024-08-22 09:10:15 +02:00
api_packages_container_test.go [SEC] Ensure propagation of API scopes for Conan and Container authentication 2024-08-28 10:33:32 +02:00
api_packages_cran_test.go
api_packages_debian_test.go
api_packages_generic_test.go
api_packages_goproxy_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_rpm_test.go
api_packages_rubygems_test.go
api_packages_swift_test.go
api_packages_test.go
api_packages_vagrant_test.go
api_private_serv_test.go
api_pull_commits_test.go
api_pull_review_test.go Fix the logic of finding the latest pull review commit ID (#32139) (followup) 2024-10-06 10:00:09 +02:00
api_pull_test.go security: add permission check to 'delete branch after merge' 2024-10-28 05:48:10 +01:00
api_push_mirror_test.go [FIX] Don't allow SSH authentication without ssh executable 2024-08-26 08:58:35 +02:00
api_quota_management_test.go
api_quota_use_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
api_releases_test.go feat: Add Search to Releases Page 2024-11-02 10:24:35 +01:00
api_repo_activities_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
api_repo_archive_test.go
api_repo_avatar_test.go
api_repo_branch_test.go Fix bug when a token is given public only 2024-10-10 10:41:42 +03:00
api_repo_collaborator_test.go
api_repo_compare_test.go
api_repo_edit_test.go
api_repo_file_create_test.go
api_repo_file_delete_test.go
api_repo_file_get_test.go
api_repo_file_helpers.go
api_repo_file_update_test.go
api_repo_files_change_test.go
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
api_repo_git_notes_test.go
api_repo_git_ref_test.go
api_repo_git_tags_test.go
api_repo_git_trees_test.go
api_repo_hook_test.go
api_repo_languages_test.go
api_repo_lfs_locks_test.go
api_repo_lfs_migrate_test.go
api_repo_lfs_test.go
api_repo_raw_test.go
api_repo_secrets_test.go
api_repo_tags_test.go
api_repo_teams_test.go
api_repo_test.go
api_repo_topic_test.go
api_repo_variables_test.go
api_settings_test.go
api_team_test.go
api_team_user_test.go
api_token_test.go Fix incorrect /tokens api (#32085) 2024-09-27 08:42:48 +02:00
api_twofa_test.go
api_user_avatar_test.go
api_user_email_test.go
api_user_follow_test.go
api_user_heatmap_test.go
api_user_info_test.go
api_user_org_perm_test.go
api_user_orgs_test.go
api_user_search_test.go chore(lint): Fix bug when a token is given public only 2024-10-10 16:00:16 +03:00
api_user_secrets_test.go
api_user_star_test.go
api_user_variables_test.go
api_user_watch_test.go
api_wiki_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
archived_labels_display_test.go
attachment_test.go Ensure GetCSRF doesn't return an empty token (#32130) 2024-10-06 07:29:45 +02:00
auth_ldap_test.go
auth_token_test.go
avatar.png
benchmarks_test.go
block_test.go
branches_test.go
change_default_branch_test.go
cmd_admin_test.go
cmd_forgejo_actions_test.go
cmd_forgejo_f3_test.go
cmd_keys_test.go
codeowner_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
compare_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
cors_test.go
create_no_session_test.go [CHORE] Move to new sessioner library 2024-08-25 03:47:08 +02:00
csrf_test.go Refactor CSRF protector (#32057) 2024-09-27 08:42:48 +02:00
db_collation_test.go
delete_user_test.go
doctor_packages_nuget_test.go
download_test.go
dummy_lang_test.go i18n: Add dummy language for checking translation keys (#5785) 2024-11-05 09:59:04 +00:00
dump_restore_test.go
easymde_test.go feat: use combo markdown editor for milestone description 2024-10-22 19:58:44 +02:00
editor_test.go chore(cleanup): remove unused TestCreateFile 2024-11-03 10:00:58 +01:00
empty_repo_test.go
eventsource_test.go
explore_code_test.go
explore_repos_test.go
explore_user_test.go
forgejo_confirmation_repo_test.go
forgejo_git_test.go
git_clone_wiki_test.go
git_helper_for_declarative_test.go
git_push_test.go
git_smart_http_test.go
git_test.go fix: make branch protection work for new branches 2024-10-24 18:44:58 +02:00
goget_test.go
gpg_git_test.go
html_helper.go
incoming_email_test.go
integration_test.go Ensure GetCSRF doesn't return an empty token (#32130) 2024-10-06 07:29:45 +02:00
issue_subscribe_test.go
issue_test.go feat(ui): set your_repositories as the default filter for org dashboards (#5593) 2024-10-17 13:24:41 +00:00
issues_comment_labels_test.go
last_updated_time_test.go fix: Add recentupdated as recognized sort option 2024-10-19 23:53:29 +02:00
lfs_getobject_test.go
lfs_local_endpoint_test.go
lfs_view_test.go
linguist_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
links_test.go Refactor CSRF protector (#32057) (fix forgejo tests) 2024-09-27 08:42:48 +02:00
markup_external_test.go
markup_test.go
migrate_test.go
milestone_test.go Fix test 2024-10-28 17:37:24 +01:00
mirror_pull_test.go
mirror_push_test.go [FIX] Don't allow SSH authentication without ssh executable 2024-08-26 08:58:35 +02:00
new_org_test.go
nonascii_branches_test.go
oauth_test.go Refactor CSRF protector (#32057) (fix forgejo tests) 2024-09-27 08:42:48 +02:00
opengraph_test.go
org_count_test.go
org_nav_test.go
org_project_test.go
org_team_invite_test.go
org_test.go fix: Add recentupdated as recognized sort option 2024-10-19 23:53:29 +02:00
private-testing.key
privateactivity_test.go
proctected_branch_test.go
project_test.go
pull_commit_test.go Fix the logic of finding the latest pull review commit ID (#32139) 2024-10-06 07:44:28 +02:00
pull_compare_test.go
pull_create_test.go Fix PR creation on forked repositories (#31863) 2024-10-06 08:08:40 +02:00
pull_diff_test.go
pull_icon_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
pull_merge_test.go tests/integration: add integration tests for automerge pull requests 2024-10-31 03:49:15 +01:00
pull_reopen_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
pull_request_task_test.go
pull_review_test.go
pull_status_test.go
pull_summary_test.go
pull_test.go feat: combine review requests comments 2024-10-25 22:57:32 +02:00
pull_update_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
pull_wip_convert_test.go
quota_use_test.go feat: Trivial default quota configuration 2024-08-26 13:25:34 +02:00
README.md Update integration test README 2024-09-09 14:06:10 +02:00
release_test.go feat: Add Search to Releases Page 2024-11-02 10:24:35 +01:00
remote_test.go
rename_branch_test.go
repo_activity_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
repo_archive_test.go
repo_archive_text_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
repo_badges_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
repo_branch_test.go Refactor CSRF protector (#32057) 2024-09-27 08:42:48 +02:00
repo_citation_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
repo_collaborator_test.go
repo_commits_search_test.go
repo_commits_test.go
repo_delete_test.go
repo_flags_test.go
repo_fork_test.go
repo_generate_test.go [FEAT] Trim spaces from repository name 2024-11-05 23:13:17 +01:00
repo_issue_title_test.go feat: Add partial quoting 2024-10-26 19:15:43 +02:00
repo_mergecommit_revert_test.go
repo_migrate_test.go
repo_migration_ui_test.go
repo_pagination_test.go
repo_search_test.go test(code-search): fix oops 2024-09-16 16:20:55 +02:00
repo_settings_hook_test.go
repo_settings_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
repo_signed_tag_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
repo_starwatch_test.go
repo_tag_test.go fix: make syncronize tags to database handle annoted tags 2024-10-21 16:21:07 +02:00
repo_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
repo_topic_test.go
repo_view_test.go [TESTS] Fix usage of LoadRepoCommit 2024-08-26 08:03:48 +02:00
repo_watch_test.go
repo_webhook_test.go fix: improve discord webhook api conformance 2024-10-08 22:43:28 +02:00
repo_wiki_test.go
repofiles_change_test.go [TESTS] Fix usage of LoadRepoCommit 2024-08-26 08:03:48 +02:00
session_test.go
setting_test.go
signin_test.go
signout_test.go
signup_test.go [CHORE] Move captcha library 2024-08-27 21:28:16 +02:00
size_translations_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
ssh_key_test.go
timetracking_test.go
user_avatar_test.go
user_count_test.go
user_dashboard_test.go
user_profile_activity_test.go feat(ui): better activity messages for cases of private profiles (#5638) 2024-10-21 14:39:29 +00:00
user_profile_follows_test.go
user_profile_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
user_test.go Merge pull request 'fix: Add recentupdated as recognized sort option' (#5613) from gusted/forgejo-add-recentupdated-case into forgejo 2024-10-20 10:57:20 +00:00
version_test.go
view_test.go [TESTS] Move CreateDeclarativeRepo to more accessible location 2024-08-25 02:54:43 +02:00
webfinger_test.go
webhook_test.go
xss_test.go

Integration tests

Thank you for your effort to provide good software tests for Forgejo. Please also read the general testing instructions in the Forgejo contributor documentation.

This file is meant to provide specific information for the integration tests as well as some tips and tricks you should know.

Feel free to extend this file with more instructions if you feel like you have something to share!

How to run the tests?

Before running any tests, please ensure you perform a clean build:

make clean build

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

make test-sqlite
make test-pgsql
make test-mysql

Run tests via local forgejo runner

If you have a forgejo runner, you can use it to run the test jobs:

Run all jobs

forgejo-runner exec -W .forgejo/workflows/testing.yml --event=pull_request

Warning: This file defines many jobs, so it will be resource-intensive and therefore not recommended.

Run single job

forgejo-runner exec -W .forgejo/workflows/testing.yml --event=pull_request -j <job_name>

You can list all job names via:

forgejo-runner exec -W .forgejo/workflows/testing.yml --event=pull_request -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

Running individual tests

Example command to run GPG test:

For SQLite:

make test-sqlite#GPG

For other databases (replace mysql to pgsql):

TEST_MYSQL_HOST=localhost:1433 TEST_MYSQL_DBNAME=test TEST_MYSQL_USERNAME=sa TEST_MYSQL_PASSWORD=MwantsaSecurePassword1 make test-mysql#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

Tips and tricks

If you know noteworthy tests that can act as an inspiration for new tests, please add some details here.