1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2025-09-30 19:22:08 +00:00
Beyond coding. We forge.
Find a file
Gusted be274b43a6 chore: add SQL fault injector testing (#9314)
TL;DR we can test if transactions are actually working.

Forgejo has many helper functions to test various aspects of the database state, however one aspect it is not able to test is transactions. As this would require that some random SQL query fails to indeed observe that the whole transaction is being rollbacked.

So how do we make a random SQL query fail? Via a fault injector hook, which is always added to xorm (during unittest) and can be enabled on demand to say after how many SQL queries it should start returning a error (fault injecting).

This allows a test to do the following: after two SQL queries lets call it a day and then execute the function that starts a transaction and does a few SQL query. It can then observe that indeed the function was fault injected (`ErrFaultInjected` is returned) and after querying the database it can observe that nothing was changed and thus can conclude the transaction was rollbacked.

---

To demonstrate how the fault injector test helper can be used, lets add a test to a function I really wanted to test but couldn't because the fault injector didn't exist. `NewTwoFactor` was recently made into a transaction (a8c61532d2) and although it would not be catastrophic it would be really bad if records were being inserted if for some reason setting the secret failed.

The test that's added demonstrates that the function uses a transaction and rollbacks correctly.

Weirdly enough the fault injector can be viewed as testing a specification, because it assumes nothing about how the function does it (and you could even design a function that purposely doesn't work but succeeds this test), it merely assumes there's a transaction and within that transaction some SQL queries will be done. However it also needs a certain amount of knowledge about how the function is implemented because the developer needs to tell after how many SQL queries you want to inject a fault and you want to do at a point where there's already a observable change happening in the transaction and not fault inject if the transaction only contains `SELECT` queries.

I'm sure you could design a smart fault injector that can do such guess work (although it sounds like a topic for a PhD thesis) and you could design a helper function that can then guide the fault injector to find every interesting place to do a fault injection and ensure the transaction always falls back; as a first prototype having the programmer tell after how many SQL queries a fault should be injected is sufficient for a lot of the transaction we are going to test in Forgejo.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/9314
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2025-09-18 00:39:06 +02:00
.devcontainer Update ghcr.io/devcontainers/features/git-lfs Docker tag to v1.2.5 (forgejo) (#8369) 2025-07-01 06:31:22 +02:00
.forgejo Update renovate to v41.113.3 (forgejo) (#9299) 2025-09-15 08:01:07 +02:00
assets Update module github.com/mholt/archives to v0.1.4 (forgejo) (#9327) 2025-09-17 16:17:03 +02:00
build chore(i18n): migrate migration descriptions to json (#9041) 2025-08-31 08:19:19 +02:00
cmd feat(log): better parseable and configurable ssh-logs (#9056) 2025-09-11 18:59:24 +02:00
contrib chore: collect coverage using GOCOVERDIR (#9004) 2025-08-26 10:10:46 +02:00
custom/conf chore: document that [i18n].LANGS must contain en-US (#9319) 2025-09-16 18:43:07 +02:00
docker bugfix check for alternate ssh host certificate location (#34146) 2025-04-14 15:53:35 +02:00
models chore: add SQL fault injector testing (#9314) 2025-09-18 00:39:06 +02:00
modules fix: failing backend tests (#9310) 2025-09-15 23:54:56 +02:00
options i18n: update of translations from Codeberg Translate 2025-09-11 04:17:35 +00:00
public Add support for migrating from Pagure (#8513) 2025-08-11 16:56:26 +02:00
release-notes fix!: use run ID instead of run Index in artifacts download web views 2025-08-27 08:53:20 +02:00
release-notes-published chore(release-notes): Forgejo v12.0.3 (#9187) 2025-09-06 08:49:02 +02:00
releases/images [DOCS] RELEASE-NOTES.md 2024-02-05 14:44:32 +01:00
routers feat: avoid expensive SQL for org home (#9309) 2025-09-16 08:54:14 +02:00
services fix: respect UI DEFAULT_SHOW_FULL_NAME setting in email From: headers (#9307) 2025-09-16 15:19:06 +02:00
templates Update Swagger annotations to reflect actual behavior (#9138) 2025-09-15 11:55:49 +02:00
tests merge commit: refactor init & clearing of panel forms without jQuery (#9062) 2025-09-17 14:56:30 +02:00
tools chore: remove gopls in Makefile (#8205) 2025-06-17 08:28:26 +02:00
web_src chore(ui): improve dropdown opener visibility (#9317) 2025-09-17 20:29:52 +02:00
.air.toml Reduce air verbosity (#31417) 2024-06-23 12:30:09 +02:00
.deadcode-out Sent user activities to distant federated server (#8792) 2025-08-06 16:16:13 +02:00
.dockerignore fix: Dockerfile should re-use bindata files when possible 2025-06-13 14:00:57 +02:00
.editorconfig Cover go.mod and go.sum in .editorconfig (#33960) 2025-04-01 02:28:02 +02:00
.envrc.example Make direnv optional to let developers use their own direnv configuration 2024-11-06 20:34:49 +01:00
.gitattributes Add interface{} to any replacement to make fmt, exclude *.pb.go (#30461) 2024-04-15 20:01:36 +02:00
.gitignore feat(build): improve lint-locale-usage further (#8736) 2025-08-27 23:47:34 +02:00
.gitmodules cleanup(tests): remove manual testing submodule 2024-04-21 10:13:51 +02:00
.gitpod.yml Remove sqlite-viewer and using database client (#31223) 2024-06-09 11:13:39 +02:00
.golangci.yml chore: depguard gopkg.in/yaml.v3 (#8980) 2025-08-21 14:17:43 +02:00
.ignore Add /options/license and /options/gitignore to .ignore (#30219) 2024-04-07 15:40:31 +02:00
.mailmap Add .mailmap with aliases for Unknwon (github.com/Unknwon) 2024-08-14 08:26:16 -04:00
.markdownlint.yaml Update JS dependencies (#28537) 2023-12-30 05:29:03 +00:00
.npmrc Upgrade to npm lockfile v3 and explicitely set it (#23561) 2023-03-18 19:38:10 +01:00
.release-notes-assistant.yaml chore(release-notes): no need to specify they are draft 2024-10-22 06:54:27 +02:00
.spectral.yaml Add spectral linter for Swagger (#20321) 2022-07-11 18:07:16 -05:00
.yamllint.yaml fully replace drone with actions (#27556) 2023-10-11 06:39:32 +00:00
BSDmakefile feat: Makefile & BSDmakefile changes (#7455) 2025-04-27 10:04:32 +00:00
CODEOWNERS feat(build): improve lint-locale-usage further (#8736) 2025-08-27 23:47:34 +02:00
CONTRIBUTING.md docs: replace Developer Guide link with the new Contributor Guide one. 2024-08-26 13:22:39 +03:00
DCO Remove address from DCO (#22595) 2023-01-24 18:52:38 +00:00
Dockerfile Update data.forgejo.org/oci/alpine Docker tag to v3.22 (forgejo) (#8218) 2025-06-18 12:47:18 +02:00
Dockerfile.rootless Update data.forgejo.org/oci/alpine Docker tag to v3.22 (forgejo) (#8218) 2025-06-18 12:47:18 +02:00
eslint.config.mjs Update dependency eslint-plugin-unicorn to v61 (forgejo) (#9198) 2025-09-07 14:55:32 +02:00
flake.lock chore: create shell.nix and update flake.* (#8129) 2025-06-10 14:31:59 +02:00
flake.nix chore: create shell.nix and update flake.* (#8129) 2025-06-10 14:31:59 +02:00
go.mod Update module github.com/mholt/archives to v0.1.4 (forgejo) (#9327) 2025-09-17 16:17:03 +02:00
go.sum Update module github.com/mholt/archives to v0.1.4 (forgejo) (#9327) 2025-09-17 16:17:03 +02:00
LICENSE Forgejo v9.0 is GPLv3+ 2024-08-22 09:09:29 +02:00
main.go fix: do not mix urfave v2 with urfave v3 (#8168) 2025-06-12 15:38:03 +02:00
Makefile Update renovate to v41.113.3 (forgejo) (#9299) 2025-09-15 08:01:07 +02:00
manifest.scm Add a GNU Guix manifest (#8038) 2025-06-03 08:08:17 +02:00
package-lock.json Lock file maintenance (forgejo) (#9302) 2025-09-15 08:17:24 +02:00
package.json Update dependency htmx.org to v2.0.7 (forgejo) (#9212) 2025-09-11 18:35:24 +02:00
playwright.config.ts tests(e2e): Prepare for visual regression testing 2024-12-10 18:12:36 +01:00
README.md chore: fix a few typos in the documentation (#9134) 2025-09-04 01:53:40 +02:00
release-notes-assistant.sh chore: improve the wording of the "not worth a release note" category (#8542) 2025-07-18 07:19:15 +02:00
RELEASE-NOTES.md RELEASE-NOTES.md to refer to the release notes directory on master [skip ci] (#8675) 2025-07-25 22:21:37 +02:00
renovate.json chore: fix renovate.json format error (#9148) 2025-09-03 21:42:56 +02:00
shell.nix chore: add missing gotestsum to nix dev shell (#9169) 2025-09-05 01:24:45 +02:00
stylelint.config.js Merge pull request 'Port "Enable declaration-block-no-redundant-longhand-properties (#30950)' (#3769) from beowulf/gitea-port-pull-30950 into forgejo 2024-05-14 22:23:54 +00:00
tailwind.config.js fix: Do not scan all Go files for tailwind classes 2024-08-24 15:45:50 +02:00
tsconfig.json Add typescript 2024-10-29 18:15:09 +01:00
vitest.config.ts Add typescript 2024-10-29 18:15:09 +01:00
webpack.config.js Update dependency htmx.org to v2 (forgejo) (#8342) 2025-06-29 13:52:24 +02:00

Welcome to Forgejo

Hi there! Tired of big platforms playing monopoly? Providing Git hosting for your project, friends, company or community? Forgejo (/for'd͡ʒe.jo/ inspired by forĝejo the Esperanto word for forge) has you covered with its intuitive interface, light and easy hosting and a lot of built-in functionality.

Forgejo was created in 2022 because we think that the project should be owned by an independent community. If you second that, then Forgejo is for you! Our promise: Independent Free/Libre Software forever!

What does Forgejo offer?

If you like any of the following, Forgejo is literally meant for you:

  • Lightweight: Forgejo can easily be hosted on nearly every machine. Running on a Raspberry? Small cloud instance? No problem!
  • Project management: Besides Git hosting, Forgejo offers issues, pull requests, wikis, kanban boards and much more to coordinate with your team.
  • Publishing: Have something to share? Use releases to host your software for download, or use the package registry to publish it for docker, npm and many other package managers.
  • Customizable: Want to change your look? Change some settings? There are many config switches to make Forgejo work exactly like you want.
  • Powerful: Organizations & team permissions, CI integration, Code Search, LDAP, OAuth and much more. If you have advanced needs, Forgejo has you covered.
  • Privacy: From update checker to default settings: Forgejo is built to be privacy first for you and your crew.
  • Federation: (WIP) We are actively working to connect software forges with each other through ActivityPub, and create a collaborative network of personal instances.

Learn more

Dive into the documentation, subscribe to releases and blog post on our website, find us on the Fediverse or hop into our Matrix room if you have any questions or want to get involved.

License

Forgejo is distributed under the terms of the GPL version 3.0 or any later version.

The agreement for this license was documented in June 2023 and implemented during the development of Forgejo v9.0. All Forgejo versions before v9.0 are distributed under the MIT license.

Get involved

If you are interested in making Forgejo better, either by reporting a bug or by changing the governance, please take a look at the contribution guide.