kallithea Files · docs/usage/locking.rst

Files @ 07844f0bc410

Branch filter:

Location: kallithea/docs/usage/locking.rst

07844f0bc410 1.1 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Thomas De Schampheleire

tests: get rid of yield-based tests

yield-based tests (tests that are actually generating tests) are a nose
feature which were also supported in pytest. However, since pytest-3.0 this
type of tests is deprecated, they will be removed in pytest-4.0.

The only yield tests present in the kallithea test suite are simply yielding
a method that does a single assert. The benefit of having each of these
asserts in a separate test is not very high.

Replace the yield by a direct call to the previously-yielded method. This
means the total test count reduces but the actual amount of test code is the
same.

.. _locking:

==================
Repository locking
==================

Kallithea has a *repository locking* feature, disabled by default. When
enabled, every initial clone and every pull gives users (with write permission)
the exclusive right to do a push.

When repository locking is enabled, repositories get a ``locked`` flag.
The hg/git commands ``hg/git clone``, ``hg/git pull``,
and ``hg/git push`` influence this state:

- A ``clone`` or ``pull`` action locks the target repository
  if the user has write/admin permissions on this repository.

- Kallithea will remember the user who locked the repository so only this
  specific user can unlock the repo by performing a ``push``
  command.

- Every other command on a locked repository from this user and every command
  from any other user will result in an HTTP return code 423 (Locked).
  Additionally, the HTTP error will mention the user that locked the repository
  (e.g., “repository <repo> locked by user <user>”).

Each repository can be manually unlocked by an administrator from the
repository settings menu.