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/integrations
Kyle Evans e461f0854f
[RFC] Make archival asynchronous (#11296)
* Make archival asynchronous

The prime benefit being sought here is for large archives to not
clog up the rendering process and cause unsightly proxy timeouts.
As a secondary benefit, archive-in-progress is moved out of the
way into a /tmp file so that new archival requests for the same
commit will not get fulfilled based on an archive that isn't yet
finished.

This asynchronous system is fairly primitive; request comes in, we'll
spawn off a new goroutine to handle it, then we'll mark it as done.
Status requests will see if the file exists in the final location,
and report the archival as done when it exists.

Fixes #11265

* Archive links: drop initial delay to three-quarters of a second

Some, or perhaps even most, archives will not take all that long to archive.
The archive process starts as soon as the download button is initially
clicked, so in theory they could be done quite quickly.  Drop the initial
delay down to three-quarters of a second to make it more responsive in the
common case of the archive being quickly created.

* archiver: restructure a little bit to facilitate testing

This introduces two sync.Cond pointers to the archiver package. If they're
non-nil when we go to process a request, we'll wait until signalled (at all)
to proceed. The tests will then create the sync.Cond so that it can signal
at-will and sanity-check the state of the queue at different phases.

The author believes that nil-checking these two sync.Cond pointers on every
archive processing will introduce minimal overhead with no impact on
maintainability.

* gofmt nit: no space around binary + operator

* services: archiver: appease golangci-lint, lock queueMutex

Locking/unlocking the queueMutex is allowed, but not required, for
Cond.Signal() and Cond.Broadcast().  The magic at play here is just a little
too much for golangci-lint, as we take the address of queueMutex and this is
mostly used in archiver.go; the variable still gets flagged as unused.

* archiver: tests: fix several timing nits

Once we've signaled a cond var, it may take some small amount of time for
the goroutines released to hit the spot we're wanting them to be at. Give
them an appropriate amount of time.

* archiver: tests: no underscore in var name, ungh

* archiver: tests: Test* is run in a separate context than TestMain

We must setup the mutex/cond variables at the beginning of any test that's
going to use it, or else these will be nil when the test is actually ran.

* archiver: tests: hopefully final tweak

Things got shuffled around such that we carefully build up and release
requests from the queue, so we can validate the state of the queue at each
step. Fix some assertions that no longer hold true as fallout.

* repo: Download: restore some semblance of previous behavior

When archival was made async, the GET endpoint was only useful if a previous
POST had initiated the download. This commit restores the previous behavior,
to an extent; we'll now submit the archive request there and return a
"202 Accepted" to indicate that it's processing if we didn't manage to
complete the request within ~2 seconds of submission.

This lets a client directly GET the archive, and gives them some indication
that they may attempt to GET it again at a later time.

* archiver: tests: simplify a bit further

We don't need to risk failure and use time.ParseDuration to get 2 *
time.Second.

else if isn't really necessary if the conditions are simple enough and lead
to the same result.

* archiver: tests: resolve potential source of flakiness

Increase all timeouts to 10 seconds; these aren't hard-coded sleeps, so
there's no guarantee we'll actually take that long. If we need longer to
not have a false-positive, then so be it.

While here, various assert.{Not,}Equal arguments are flipped around so that
the wording in error output reflects reality, where the expected argument is
second and actual third.

* archiver: setup infrastructure for notifying consumers of completion

This API will *not* allow consumers to subscribe to specific requests being
completed, just *any* request being completed. The caller is responsible for
determining if their request is satisfied and waiting again if needed.

* repo: archive: make GET endpoint synchronous again

If the request isn't complete, this endpoint will now submit the request and
wait for completion using the new API. This may still be susceptible to
timeouts for larger repos, but other endpoints now exist that the web
interface will use to negotiate its way through larger archive processes.

* archiver: tests: amend test to include WaitForCompletion()

This is a trivial one, so go ahead and include it.

* archiver: tests: fix test by calling NewContext()

The mutex is otherwise uninitialized, so we need to ensure that we're
actually initializing it if we plan to test it.

* archiver: tests: integrate new WaitForCompletion a little better

We can use this to wait for archives to come in, rather than spinning and
hoping with a timeout.

* archiver: tests: combine numQueued declaration with next-instruction assignment

* routers: repo: reap unused archiving flag from DownloadStatus()

This had some planned usage before, indicating whether this request
initiated the archival process or not. After several rounds of refactoring,
this use was deemed not necessary for much of anything and got boiled down
to !complete in all cases.

* services: archiver: restructure to use a channel

We now offer two forms of waiting for a request:
- WaitForCompletion: wait for completion with no timeout
- TimedWaitForCompletion: wait for completion with timeout

In both cases, we wait for the given request's cchan to close; in the latter
case, we do so with the caller-provided timeout. This completely removes the
need for busy-wait loops in Download/InitiateDownload, as it's fairly clean
to wait on a channel with timeout.

* services: archiver: use defer to unlock now that we can

This previously carried the lock into the goroutine, but an intermediate
step just added the request to archiveInProgress outside of the new
goroutine and removed the need for the goroutine to start out with it.

* Revert "archiver: tests: combine numQueued declaration with next-instruction assignment"

This reverts commit bcc52140238e16680f2e05e448e9be51372afdf5.

Revert "archiver: tests: integrate new WaitForCompletion a little better"

This reverts commit 9fc8bedb5667d24d3a3c7843dc28a229efffb1e6.

Revert "archiver: tests: fix test by calling NewContext()"

This reverts commit 709c35685eaaf261ebbb7d3420e3376a4ee8e7f2.

Revert "archiver: tests: amend test to include WaitForCompletion()"

This reverts commit 75261f56bc05d1fa8ff7e81dcbc0ccd93fdc9d50.

* archiver: tests: first attempt at WaitForCompletion() tests

* archiver: tests: slight improvement, less busy-loop

Just wait for the requests to complete in order, instead of busy-waiting
with a timeout.  This is slightly less fragile.

While here, reverse the arguments of a nearby assert.Equal() so that
expected/actual are correct in any test output.

* archiver: address lint nits

* services: archiver: only close the channel once

* services: archiver: use a struct{} for the wait channel

This makes it obvious that the channel is only being used as a signal,
rather than anything useful being piped through it.

* archiver: tests: fix expectations

Move the close of the channel into doArchive() itself; notably, before these
goroutines move on to waiting on the Release cond.

The tests are adjusted to reflect that we can't WaitForCompletion() after
they've already completed, as WaitForCompletion() doesn't indicate that
they've been released from the queue yet.

* archiver: tests: set cchan to nil for comparison

* archiver: move ctx.Error's back into the route handlers

We shouldn't be setting this in a service, we should just be validating the
request that we were handed.

* services: archiver: use regex to match a hash

This makes sure we don't try and use refName as a hash when it's clearly not
one, e.g. heads/pull/foo.

* routers: repo: remove the weird /archive/status endpoint

We don't need to do this anymore, we can just continue POSTing to the
archive/* endpoint until we're told the download's complete. This avoids a
potential naming conflict, where a ref could start with "status/"

* archiver: tests: bump reasonable timeout to 15s

* archiver: tests: actually release timedReq

* archiver: tests: run through inFlight instead of manually checking

While we're here, add a test for manually re-processing an archive that's
already been complete. Re-open the channel and mark it incomplete, so that
doArchive can just mark it complete again.

* initArchiveLinks: prevent default behavior from clicking

* archiver: alias gitea's context, golang context import pending

* archiver: simplify logic, just reconstruct slices

While the previous logic was perhaps slightly more efficient, the
new variant's readability is much improved.

* archiver: don't block shutdown on waiting for archive

The technique established launches a goroutine to do the wait,
which will close a wait channel upon termination. For the timeout
case, we also send back a value indicating whether the timeout was
hit or not.

The timeouts are expected to be relatively small, but still a multi-
second delay to shutdown due to this could be unfortunate.

* archiver: simplify shutdown logic

We can just grab the shutdown channel from the graceful manager instead of
constructing a channel to halt the caller and/or pass a result back.

* Style issues

* Fix mis-merge

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: Lauris BH <lauris@nix.lv>
4 years ago
..
gitea-repositories-meta [RFC] Make archival asynchronous (#11296) 4 years ago
migration-test Fix pgsql migration test (#12844) 4 years ago
README.md log slow tests (#11487) 4 years ago
README_ZH.md Improve integration tests (#8276) 5 years ago
api_admin_org_test.go Fix "data race" in testlogger (#9159) 5 years ago
api_admin_test.go Disable DSA ssh keys by default (#13056) 4 years ago
api_branch_test.go Add API Endpoint for Branch Creation (#11607) 4 years ago
api_comment_test.go [Refactor] Move APIFormat functions into convert package (#12856) 4 years ago
api_fork_test.go Fix "data race" in testlogger (#9159) 5 years ago
api_gpg_keys_test.go Handle expected errors in AddGPGkey API (#11644) 4 years ago
api_helper_for_declarative_test.go Attempt to handle unready PR in tests (#13305) 4 years ago
api_issue_label_test.go Add Organization Wide Labels (#10814) 4 years ago
api_issue_milestone_test.go [API] Milestone endpoints accept names too (#12649) 4 years ago
api_issue_reaction_test.go [Refactor] Move APIFormat functions into convert package (#12856) 4 years ago
api_issue_stopwatch_test.go Refactor: move Commit To APIFormat Code & Lot of StopWatch related things (#12729) 4 years ago
api_issue_subscription_test.go Return issue subscription status from API subscribe (#10966) 4 years ago
api_issue_test.go Add review request api (#11355) 4 years ago
api_issue_tracked_time_test.go Fix tracked time issues (#11349) 4 years ago
api_keys_test.go Disable DSA ssh keys by default (#13056) 4 years ago
api_notification_test.go Extend Notifications API and return pinned notifications by default (#12164) 4 years ago
api_oauth2_apps_test.go Add Get/Update for api/v1/user/applications/oauth2 (#11008) 4 years ago
api_org_test.go [API] add GET /orgs endpoint (#9560) 5 years ago
api_pull_review_test.go Add review request api (#11355) 4 years ago
api_pull_test.go Add option to API to update PullRequest base branch (#11666) 4 years ago
api_releases_test.go Delete tag API (#13358) 4 years ago
api_repo_edit_test.go Api: advanced settings for repository (external wiki, issue tracker etc.) (#7756) 5 years ago
api_repo_file_create_test.go Handle expected errors in FileCreate & FileUpdate API (#11643) 4 years ago
api_repo_file_delete_test.go Contents API should return 404 on not exist (#10323) 4 years ago
api_repo_file_helpers.go Move sdk structs to modules/structs (#6905) 5 years ago
api_repo_file_update_test.go Handle expected errors in FileCreate & FileUpdate API (#11643) 4 years ago
api_repo_get_contents_list_test.go Contents API should return 404 on not exist (#10323) 4 years ago
api_repo_get_contents_test.go Contents API should return 404 on not exist (#10323) 4 years ago
api_repo_git_blobs_test.go Fix "data race" in testlogger (#9159) 5 years ago
api_repo_git_commits_test.go Consolidate API for getting single commit (#11368) 4 years ago
api_repo_git_hook_test.go Fix "data race" in testlogger (#9159) 5 years ago
api_repo_git_ref_test.go Fix "data race" in testlogger (#9159) 5 years ago
api_repo_git_tags_test.go Fix "data race" in testlogger (#9159) 5 years ago
api_repo_git_trees_test.go Fix "data race" in testlogger (#9159) 5 years ago
api_repo_languages_test.go give gitea time to calculate language stats (#11812) 4 years ago
api_repo_lfs_locks_test.go Fix "data race" in testlogger (#9159) 5 years ago
api_repo_raw_test.go Fix "data race" in testlogger (#9159) 5 years ago
api_repo_tags_test.go Fix "data race" in testlogger (#9159) 5 years ago
api_repo_test.go [RFC] Make archival asynchronous (#11296) 4 years ago
api_repo_topic_test.go Fix "data race" in testlogger (#9159) 5 years ago
api_settings_test.go Expose Attachemnt Settings by API (#12514) 4 years ago
api_team_test.go [API] orgEditTeam make Fields optional (#9556) 5 years ago
api_team_user_test.go Fix "data race" in testlogger (#9159) 5 years ago
api_token_test.go [API] Delete Token accept names too (#12366) 4 years ago
api_user_heatmap_test.go Update heatmap fixtures to restore tests (#13224) 4 years ago
api_user_orgs_test.go Fix "data race" in testlogger (#9159) 5 years ago
api_user_search_test.go Convert User expose ID each time (#12855) 4 years ago
attachment_test.go Attachments: Add extension support, allow all types for releases (#12465) 4 years ago
auth_ldap_test.go Remove obsolete change of email on profile page (#13341) 4 years ago
benchmarks_test.go Missed defer prepareTestEnv (#9285) 5 years ago
branches_test.go Handle more pathological branch and tag names (#11843) 4 years ago
change_default_branch_test.go Fix "data race" in testlogger (#9159) 5 years ago
cmd_keys_test.go Completely quote AppPath and CustomConf paths (#12955) 4 years ago
cors_test.go Fix "data race" in testlogger (#9159) 5 years ago
create_no_session_test.go Re-attempt to delete temporary upload if the file is locked by another process (#12447) 4 years ago
delete_user_test.go Fix "data race" in testlogger (#9159) 5 years ago
download_test.go Fix "data race" in testlogger (#9159) 5 years ago
editor_test.go Add golangci (#6418) 5 years ago
empty_repo_test.go Fix "data race" in testlogger (#9159) 5 years ago
eventsource_test.go Extend Notifications API and return pinned notifications by default (#12164) 4 years ago
explore_repos_test.go Fix "data race" in testlogger (#9159) 5 years ago
git_helper_for_declarative_test.go Re-attempt to delete temporary upload if the file is locked by another process (#12447) 4 years ago
git_test.go Re-attempt to delete temporary upload if the file is locked by another process (#12447) 4 years ago
gpg_git_test.go Re-attempt to delete temporary upload if the file is locked by another process (#12447) 4 years ago
html_helper.go Remove obsolete change of email on profile page (#13341) 4 years ago
integration_test.go Storage configuration support `[storage]` (#13314) 4 years ago
issue_test.go Prettify Timeline (#10972) 4 years ago
lfs_getobject_test.go Storage configuration support `[storage]` (#13314) 4 years ago
links_test.go Kanban board (#8346) 4 years ago
mssql.ini.tmpl Disable Git Hooks by default (#13064) 4 years ago
mysql.ini.tmpl Storage configuration support `[storage]` (#13314) 4 years ago
mysql8.ini.tmpl Disable Git Hooks by default (#13064) 4 years ago
nonascii_branches_test.go Fix "data race" in testlogger (#9159) 5 years ago
oauth_test.go Fix "data race" in testlogger (#9159) 5 years ago
org_count_test.go Correctly set the organization num repos (#11339) 4 years ago
org_test.go Fix "data race" in testlogger (#9159) 5 years ago
pgsql.ini.tmpl Disable Git Hooks by default (#13064) 4 years ago
private-testing.key Fix verification of subkeys of default gpg key (#11713) 4 years ago
privateactivity_test.go Add hide activity option (#11353) 4 years ago
pull_compare_test.go Fix "data race" in testlogger (#9159) 5 years ago
pull_create_test.go Prettify Timeline (#10972) 4 years ago
pull_merge_test.go Fix styling for PR merge section when no checks (#11609) 4 years ago
pull_review_test.go Fix "data race" in testlogger (#9159) 5 years ago
pull_status_test.go Fix wrong hint when status checking is running on pull request view (#9886) 5 years ago
pull_update_test.go Add API to update pr headBranch (#12419) 4 years ago
release_test.go Add the tag list page to the release page (#12096) 4 years ago
repo_activity_test.go Fix activity count in TestRepoActivity (#9959) 4 years ago
repo_branch_test.go Fix "data race" in testlogger (#9159) 5 years ago
repo_commits_search_test.go Fix "data race" in testlogger (#9159) 5 years ago
repo_commits_test.go Fix "data race" in testlogger (#9159) 5 years ago
repo_fork_test.go Fix "data race" in testlogger (#9159) 5 years ago
repo_generate_test.go Fix "data race" in testlogger (#9159) 5 years ago
repo_migrate_test.go Add a migrate service type switch page (#12697) 4 years ago
repo_search_test.go Add queue for code indexer (#10332) 4 years ago
repo_test.go Fix file table overflows (#12603) 4 years ago
repo_watch_test.go Auto-subscribe user to repository when they commit/tag to it (#7657) 5 years ago
repofiles_delete_test.go prefer NoError/Error over Nil/NotNil (#12271) 4 years ago
repofiles_update_test.go prefer NoError/Error over Nil/NotNil (#12271) 4 years ago
setting_test.go Add a /user/login landing page option (#9622) 5 years ago
signin_test.go Fix "data race" in testlogger (#9159) 5 years ago
signout_test.go Logout POST action (#10582) 4 years ago
signup_test.go Fix "data race" in testlogger (#9159) 5 years ago
sqlite.ini.tmpl Disable Git Hooks by default (#13064) 4 years ago
ssh_key_test.go Re-attempt to delete temporary upload if the file is locked by another process (#12447) 4 years ago
testlogger.go Pause, Resume, Release&Reopen, Add and Remove Logging from command line (#11777) 4 years ago
timetracking_test.go Fix "data race" in testlogger (#9159) 5 years ago
user_test.go Fix "data race" in testlogger (#9159) 5 years ago
version_test.go Fix "data race" in testlogger (#9159) 5 years ago
xss_test.go Fix "data race" in testlogger (#9159) 5 years ago

README.md

Integrations tests

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

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

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 integrations tests

Start tests

make test-sqlite

Run mysql integrations 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 secound 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 integrations 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 integrations 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, 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