forgejo/integrations
zeripath 5d2e11eedb
Refactor: Move login out of models (#16199)
`models` does far too much. In particular it handles all `UserSignin`.

It shouldn't be responsible for calling LDAP, SMTP or PAM for signing in.

Therefore we should move this code out of `models`.

This code has to depend on `models` - therefore it belongs in `services`.

There is a package in `services` called `auth` and clearly this functionality belongs in there.

Plan:

- [x] Change `auth.Auth` to `auth.Method` - as they represent methods of authentication.
- [x] Move `models.UserSignIn` into `auth`
- [x] Move `models.ExternalUserLogin`
- [x] Move most of the `LoginVia*` methods to `auth` or subpackages
- [x] Move Resynchronize functionality to `auth`
  - Involved some restructuring of `models/ssh_key.go` to reduce the size of this massive file and simplify its files.
- [x] Move the rest of the LDAP functionality in to the ldap subpackage
- [x] Re-factor the login sources to express an interfaces `auth.Source`?
  - I've done this through some smaller interfaces Authenticator and Synchronizable - which would allow us to extend things in future
- [x] Now LDAP is out of models - need to think about modules/auth/ldap and I think all of that functionality might just be moveable
- [x] Similarly a lot Oauth2 functionality need not be in models too and should be moved to services/auth/source/oauth2
  - [x] modules/auth/oauth2/oauth2.go uses xorm... This is naughty - probably need to move this into models.
  - [x] models/oauth2.go - mostly should be in modules/auth/oauth2 or services/auth/source/oauth2 
- [x] More simplifications of login_source.go may need to be done
- Allow wiring in of notify registration -  *this can now easily be done - but I think we should do it in another PR*  - see #16178 
- More refactors...?
  - OpenID should probably become an auth Method but I think that can be left for another PR
  - Methods should also probably be cleaned up  - again another PR I think.
  - SSPI still needs more refactors.* Rename auth.Auth auth.Method
* Restructure ssh_key.go

- move functions from models/user.go that relate to ssh_key to ssh_key
- split ssh_key.go to try create clearer function domains for allow for
future refactors here.

Signed-off-by: Andrew Thornton <art27@cantab.net>
2021-07-24 11:16:34 +01:00
..
gitea-repositories-meta Add TestPrepareWikiFileName (#16487) 2021-07-20 15:16:20 +02:00
migration-test Let package git depend on setting but not opposite (#15241) 2021-06-26 13:28:55 +02:00
admin_user_test.go Add option to change username to the admin panel (#14229) 2021-01-10 14:14:02 +02:00
api_admin_org_test.go
api_admin_test.go Fixed assert statements. (#16089) 2021-06-07 07:27:09 +02:00
api_branch_test.go Fix Benchmark tests, remove a broken one & add two new (#15250) 2021-04-16 20:30:16 +02:00
api_comment_test.go
api_fork_test.go
api_gpg_keys_test.go Add option to provide signature for a token to verify key ownership (#14054) 2021-07-13 15:28:07 +02:00
api_helper_for_declarative_test.go Always set the merge base used to merge the commit (#15352) 2021-04-10 09:27:29 +01:00
api_issue_label_test.go Never add labels not from this repository or organisation and remove org labels on transfer (#14928) 2021-03-12 18:45:49 +01:00
api_issue_milestone_test.go
api_issue_reaction_test.go [refactor] Unify the export of user data via API (#15144) 2021-03-27 17:45:26 +01:00
api_issue_stopwatch_test.go Display current stopwatch in navbar (#14122) 2021-01-21 15:51:52 +01:00
api_issue_subscription_test.go
api_issue_test.go [API] Issue Search Add filter for MilestoneNames (#16173) 2021-06-17 08:40:59 +02:00
api_issue_tracked_time_test.go
api_keys_test.go
api_notification_test.go Fixed assert statements. (#16089) 2021-06-07 07:27:09 +02:00
api_oauth2_apps_test.go Fixed assert statements. (#16089) 2021-06-07 07:27:09 +02:00
api_org_test.go Fixed assert statements. (#16089) 2021-06-07 07:27:09 +02:00
api_pull_commits_test.go Add API to get commits of PR (#16300) 2021-07-02 14:19:57 +02:00
api_pull_review_test.go API: Allow COMMENT reviews to not specify a body (#16229) 2021-06-25 00:05:51 +02:00
api_pull_test.go Move modules/forms to services/forms (#15305) 2021-04-06 20:44:05 +01:00
api_releases_test.go [API] ListReleases add filter for draft and pre-releases (#16175) 2021-06-17 10:58:10 +02:00
api_repo_edit_test.go [API] make change repo settings work on empty repos (#15778) 2021-05-08 14:11:36 +02:00
api_repo_file_create_test.go Fix Benchmark tests, remove a broken one & add two new (#15250) 2021-04-16 20:30:16 +02:00
api_repo_file_delete_test.go
api_repo_file_helpers.go Fix Benchmark tests, remove a broken one & add two new (#15250) 2021-04-16 20:30:16 +02:00
api_repo_file_update_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] Add affected files of commits to commit struct (#14579) 2021-02-07 15:43:40 +01:00
api_repo_git_hook_test.go
api_repo_git_ref_test.go
api_repo_git_tags_test.go [API] Add delete release by tag & fix unreleased inconsistency (#14563) 2021-02-07 19:32:18 +01:00
api_repo_git_trees_test.go
api_repo_languages_test.go
api_repo_lfs_locks_test.go Rewrite of the LFS server (#15523) 2021-06-06 02:59:27 +03:00
api_repo_lfs_migrate_test.go Add LFS Migration and Mirror (#14726) 2021-04-08 18:25:57 -04:00
api_repo_lfs_test.go Fix source typos (#16374) 2021-07-08 14:55:09 +02:00
api_repo_raw_test.go
api_repo_tags_test.go [API] Add repoGetTag (#16166) 2021-06-23 17:08:47 -04:00
api_repo_teams_test.go Fixed assert statements. (#16089) 2021-06-07 07:27:09 +02:00
api_repo_test.go Creating a repo from a template repo via API (#15958) 2021-07-05 17:29:08 +02:00
api_repo_topic_test.go Fixed assert statements. (#16089) 2021-06-07 07:27:09 +02:00
api_settings_test.go Export LFS & TimeTracking function status (#14753) 2021-02-20 11:17:51 +01:00
api_team_test.go reqOrgMembership calls need to be preceded by reqToken (#16198) 2021-06-21 14:01:44 +01:00
api_team_user_test.go [refactor] Unify the export of user data via API (#15144) 2021-03-27 17:45:26 +01:00
api_token_test.go
api_user_email_test.go Always store primary email address into email_address table and also the state (#15956) 2021-06-08 11:52:51 +08:00
api_user_heatmap_test.go Fix heatmap activity (#15252) 2021-06-25 12:59:25 -04:00
api_user_orgs_test.go Extend TestUserOrgs to cover permission cases (#14495) 2021-01-28 22:40:41 +01:00
api_user_search_test.go Add Visible modes function from Organisation to Users too (#16069) 2021-06-26 20:53:14 +01:00
attachment_test.go Add size to Save function (#15264) 2021-04-03 18:19:59 +02:00
auth_ldap_test.go Refactor: Move login out of models (#16199) 2021-07-24 11:16:34 +01:00
benchmarks_test.go Fix Benchmark tests, remove a broken one & add two new (#15250) 2021-04-16 20:30:16 +02:00
branches_test.go [API] Add pagination to ListBranches (#14524) 2021-02-03 20:06:13 +01:00
change_default_branch_test.go
cmd_keys_test.go
compare_test.go Add selecting tags on the compare page (#15723) 2021-05-07 23:10:05 +02:00
cors_test.go
create_no_session_test.go Refactor routers directory (#15800) 2021-06-09 01:33:54 +02:00
delete_user_test.go Add option to change username to the admin panel (#14229) 2021-01-10 14:14:02 +02:00
download_test.go Support custom mime type mapping for text files (#16304) 2021-06-30 17:31:54 -04:00
editor_test.go
empty_repo_test.go
eventsource_test.go
explore_repos_test.go
git_clone_wiki_test.go Add tests for clone from wiki (#15513) 2021-04-16 17:39:21 -04:00
git_helper_for_declarative_test.go Fix Benchmark tests, remove a broken one & add two new (#15250) 2021-04-16 20:30:16 +02:00
git_smart_http_test.go Fix http path bug (#16117) 2021-06-09 14:53:12 +02:00
git_test.go Let package git depend on setting but not opposite (#15241) 2021-06-26 13:28:55 +02:00
goget_test.go Return go-get info on subdirs (#15642) 2021-05-09 22:50:06 +01:00
gpg_git_test.go
html_helper.go
integration_test.go Let package git depend on setting but not opposite (#15241) 2021-06-26 13:28:55 +02:00
issue_test.go
lfs_getobject_test.go Let package git depend on setting but not opposite (#15241) 2021-06-26 13:28:55 +02:00
lfs_local_endpoint_test.go Add LFS Migration and Mirror (#14726) 2021-04-08 18:25:57 -04:00
links_test.go Improve assets handler middleware (#15961) 2021-05-30 18:25:11 +08:00
migrate_test.go Do not convert file path to lowercase (#15023) 2021-03-18 13:58:47 +00:00
mirror_pull_test.go Add tag protection (#15629) 2021-06-25 16:28:55 +02:00
mirror_push_test.go Add push to remote mirror repository (#15157) 2021-06-14 19:20:43 +02:00
mssql.ini.tmpl Second attempt at preventing zombies (#16326) 2021-07-14 10:43:13 -04:00
mysql.ini.tmpl Second attempt at preventing zombies (#16326) 2021-07-14 10:43:13 -04:00
mysql8.ini.tmpl Second attempt at preventing zombies (#16326) 2021-07-14 10:43:13 -04:00
nonascii_branches_test.go
oauth_test.go Migrate to use jsoniter instead of encoding/json (#14841) 2021-03-01 22:08:10 +01:00
org_count_test.go Remove User.GetOrganizations() (#14032) 2021-06-18 19:00:53 +02:00
org_test.go Fixed assert statements. (#16089) 2021-06-07 07:27:09 +02:00
pgsql.ini.tmpl Second attempt at preventing zombies (#16326) 2021-07-14 10:43:13 -04:00
private-testing.key
privateactivity_test.go Show private heatmap on profile to self & admins (#14881) 2021-03-04 23:59:13 +01:00
pull_compare_test.go
pull_create_test.go
pull_merge_test.go Add links to toggle WIP status (#14677) 2021-05-27 22:02:04 +02:00
pull_review_test.go
pull_status_test.go Make manual merge autodetection optional and add manual merge as merge method (#12543) 2021-03-03 22:41:23 -05:00
pull_update_test.go
README.md Fix various documentation, user-facing, and source comment typos (#16367) 2021-07-08 13:38:13 +02:00
README_ZH.md Bump postgres and mysql versions (#15710) 2021-05-21 18:11:48 -04:00
release_test.go Fix various documentation, user-facing, and source comment typos (#16367) 2021-07-08 13:38:13 +02:00
repo_activity_test.go
repo_branch_test.go Redirect on bad CSRF instead of presenting bad page (#14937) 2021-07-08 15:57:24 +02:00
repo_commits_search_test.go
repo_commits_test.go Let branch/tag name be a valid ref to get CI status (#16400) 2021-07-13 08:14:14 +01:00
repo_fork_test.go
repo_generate_test.go
repo_migrate_test.go
repo_search_test.go
repo_tag_test.go Add tag protection (#15629) 2021-06-25 16:28:55 +02:00
repo_test.go Fixed assert statements. (#16089) 2021-06-07 07:27:09 +02:00
repo_watch_test.go
repofiles_delete_test.go
repofiles_update_test.go
setting_test.go
signin_test.go
signout_test.go
signup_test.go add configuration option to restrict users by default (#16256) 2021-07-15 15:19:48 -04:00
sqlite.ini.tmpl Second attempt at preventing zombies (#16326) 2021-07-14 10:43:13 -04:00
ssh_key_test.go
testlogger.go Migrate to use jsoniter instead of encoding/json (#14841) 2021-03-01 22:08:10 +01:00
timetracking_test.go
user_avatar_test.go Fix broken avatars since #15301 (#15731) 2021-05-05 14:06:39 +01:00
user_test.go
version_test.go
view_test.go Display SVG files as images instead of text (#14101) 2021-01-12 22:45:19 -05:00
xss_test.go

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