Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-30 04:27:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/3.x/api/evennia.contrib.utils.auditing.tests.html

180 lines
10 KiB
HTML
Raw Normal View History

Add 3.x legacy documentation
2023-12-20 23:10:55 +01:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
Fix 3.x legacy doc versioning
2023-12-21 00:12:31 +01:00
<title>evennia.contrib.utils.auditing.tests &#8212; Evennia 3.x documentation</title>
Add 3.x legacy documentation
2023-12-20 23:10:55 +01:00
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.contrib.utils.fieldfill" href="evennia.contrib.utils.fieldfill.html" />
<link rel="prev" title="evennia.contrib.utils.auditing.server" href="evennia.contrib.utils.auditing.server.html" />
</head><body>
<div class="admonition important">
<p class="first admonition-title">Note</p>
<p class="last">You are reading an old version of the Evennia documentation. <a href="https://www.evennia.com/docs/latest/index.html">The latest version is here</a></p>.
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.contrib.utils.fieldfill.html" title="evennia.contrib.utils.fieldfill"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.utils.auditing.server.html" title="evennia.contrib.utils.auditing.server"
accesskey="P">previous</a> |</li>
Fix 3.x legacy doc versioning
2023-12-21 00:12:31 +01:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 3.x</a> &#187;</li>
Add 3.x legacy documentation
2023-12-20 23:10:55 +01:00
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.utils.html" >evennia.contrib.utils</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.utils.auditing.html" accesskey="U">evennia.contrib.utils.auditing</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.utils.auditing.tests</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.utils.auditing.server.html"
title="previous chapter">evennia.contrib.utils.auditing.server</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.utils.fieldfill.html"
title="next chapter">evennia.contrib.utils.fieldfill</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.contrib.utils.auditing.tests.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.utils.auditing.tests">
<span id="evennia-contrib-utils-auditing-tests"></span><h1>evennia.contrib.utils.auditing.tests<a class="headerlink" href="#module-evennia.contrib.utils.auditing.tests" title="Permalink to this headline"></a></h1>
<p>Module containing the test cases for the Audit system.</p>
<dl class="py class">
<dt id="evennia.contrib.utils.auditing.tests.AuditingTest">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.utils.auditing.tests.</code><code class="sig-name descname">AuditingTest</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/auditing/tests.html#AuditingTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.auditing.tests.AuditingTest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
<dl class="py method">
<dt id="evennia.contrib.utils.auditing.tests.AuditingTest.setup_session">
<code class="sig-name descname">setup_session</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/auditing/tests.html#AuditingTest.setup_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.auditing.tests.AuditingTest.setup_session" title="Permalink to this definition"></a></dt>
<dd><p>Overrides default one in EvenniaTest</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.utils.auditing.tests.AuditingTest.test_mask">
<code class="sig-name descname">test_mask</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/auditing/tests.html#AuditingTest.test_mask"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.auditing.tests.AuditingTest.test_mask" title="Permalink to this definition"></a></dt>
<dd><p>Make sure the ‘mask’ function is properly masking potentially sensitive
information from strings.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.utils.auditing.tests.AuditingTest.test_audit">
<code class="sig-name descname">test_audit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/auditing/tests.html#AuditingTest.test_audit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.auditing.tests.AuditingTest.test_audit" title="Permalink to this definition"></a></dt>
<dd><p>Make sure the ‘audit’ function is returning a dictionary based on values
parsed from the Session object.</p>
</dd></dl>
</dd></dl>
</section>
</div>
</div>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.contrib.utils.fieldfill.html" title="evennia.contrib.utils.fieldfill"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.utils.auditing.server.html" title="evennia.contrib.utils.auditing.server"
>previous</a> |</li>
Fix 3.x legacy doc versioning
2023-12-21 00:12:31 +01:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 3.x</a> &#187;</li>
Add 3.x legacy documentation
2023-12-20 23:10:55 +01:00
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.utils.html" >evennia.contrib.utils</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.utils.auditing.html" >evennia.contrib.utils.auditing</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.utils.auditing.tests</a></li>
</ul>
</div>
<div class="admonition important">
<p class="first admonition-title">Note</p>
<p class="last">You are reading an old version of the Evennia documentation. <a href="https://www.evennia.com/docs/latest/index.html">The latest version is here</a></p>.
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue Copy permalink