kallithea Files · docs/usage/debugging.rst

Files @ ffdcf0dfe0e4

Branch filter:

Location: kallithea/docs/usage/debugging.rst

ffdcf0dfe0e4 1.2 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Mads Kiilerich

tests: make test_admin_users user_and_repo_group_fail() fixture more stable

When adding authentication_token() to log_user(), database session lifetime
will in some cases change:

test_admin_users test_delete_repo_group_err() use the
user_and_repo_group_fail() fixture.

Before, it got ObjectDeletedError when trying to delete a deleted RepoGroup and
moved on.

After changing log_user(), py.test would emit a warning:

kallithea/tests/functional/test_admin_users.py::TestAdminUsersController::()::test_delete_repo_group_err
.../site-packages/sqlalchemy/orm/persistence.py:1340: SAWarning: DELETE statement on table 'groups' expected to delete 1 row(s); 0 were matched. Please set confirm_deleted_rows=False within the mapper configuration to prevent this warning.
% (table.description, expected, rows_matched)

Instead, use RepoGroup.get_by_group_name to verify the group exists before
trying to delete it.

.. _debugging:

===================
Debugging Kallithea
===================

If you encounter problems with Kallithea, here are some instructions
on how to debug them.

.. note:: First make sure you're using the latest version available.


Enable detailed debug
---------------------

Kallithea uses the standard Python ``logging`` module to log its output.
By default only loggers with ``INFO`` level are displayed. To enable full output
change ``level = DEBUG`` for all logging handlers in the currently used .ini file.
This change will allow you to see much more detailed output in the log file or
console. This generally helps a lot to track issues.


Enable interactive debug mode
-----------------------------

To enable interactive debug mode simply comment out ``set debug = false`` in
the .ini file. This will trigger an interactive debugger each time
there is an error in the browser, or send a http link if an error occurred in the backend. This
is a great tool for fast debugging as you get a handy Python console right
in the web view.

.. warning:: NEVER ENABLE THIS ON PRODUCTION! The interactive console
             can be a serious security threat to your system.