tests: s/GITEA_UNIT_TESTS_VERBOSE/GITEA_UNIT_TESTS_LOG_SQL/ (#18142)

The GITEA_UNIT_TESTS_VERBOSE variable is an undocumented variable
introduced in 2017 (see 1028ef2def)
whose sole purpose has been to log SQL statements when running unit
tests.

It is renamed for clarity and a warning is displayed for backward
compatibility for people and scripts that know about it.

The documentation is updated to reflect this change.
This commit is contained in:
singuliere 2022-01-01 04:31:24 +01:00 committed by GitHub
parent fb2dc95623
commit 1a4e2bfcd1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 2 deletions

View file

@ -277,7 +277,7 @@ There are two types of test run by Gitea: Unit tests and Integration Tests.
### Unit Tests ### Unit Tests
Unit tests are covered by `*_test.go` in `go test` system. Unit tests are covered by `*_test.go` in `go test` system.
You can set environment variable `GITEA_UNIT_TESTS_VERBOSE=1` to see detail logs during the test. You can set the environment variable `GITEA_UNIT_TESTS_LOG_SQL=1` to display all SQL statements when running the tests in verbose mode (i.e. when `GOTESTFLAGS=-v` is set).
```bash ```bash
TAGS="bindata sqlite sqlite_unlock_notify" make test # Runs the unit tests TAGS="bindata sqlite sqlite_unlock_notify" make test # Runs the unit tests

View file

@ -152,7 +152,7 @@ func CreateTestEngine(opts FixturesOptions) error {
if err = db.SyncAllTables(); err != nil { if err = db.SyncAllTables(); err != nil {
return err return err
} }
switch os.Getenv("GITEA_UNIT_TESTS_VERBOSE") { switch os.Getenv("GITEA_UNIT_TESTS_LOG_SQL") {
case "true", "1": case "true", "1":
x.ShowSQL(true) x.ShowSQL(true)
} }