plausible/analytics
1
1
Fork 0
mirror of https://github.com/plausible/analytics.git synced 2024-11-23 11:12:15 +03:00
Code Issues Packages Projects Releases Wiki Activity
53c63372f5
analytics/Plausible.TestUtils.html
RobertJoonas 53c63372f5 deploy: 57188a402a
2023-11-30 11:51:25 +00:00

819 lines
23 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.30.3">
<meta name="project" content="Plausible v0.0.1">
<title>Plausible.TestUtils — Plausible v0.0.1</title>
<link rel="stylesheet" href="dist/html-elixir-P5GXSCHE.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-NBND3S2D.js"></script>
<script src="dist/sidebar_items-CA39C431.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-CGDDOCMI.js"></script>
</head>
<body data-type="modules" class="page-module">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
</button>
<label class="search-label">
<p class="sr-only">Search</p>
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<a href="readme.html">
<img src="assets/logo.png" alt="Plausible" class="sidebar-projectImage">
</a>
<div class="sidebar-projectDetails">
<a href="readme.html" class="sidebar-projectName" translate="no">
Plausible
</a>
<div class="sidebar-projectVersion" translate="no">
v0.0.1
</div>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">Pages</a></li>
<li><a id="modules-list-link" href="#full-list">Modules</a></li>
<li><a id="tasks-list-link" href="#full-list"><span translate="no">Mix</span> Tasks</a></li>
</ul>
</div>
<div class="gradient"></div>
<ul id="full-list"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="icon-action display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span translate="no">Plausible.TestUtils</span>
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
</h1>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
Summary
</a>
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#add_imported_data/1" translate="no">add_imported_data(map)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#await_clickhouse_count/2" translate="no">await_clickhouse_count(query, expected)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_api_key/1" translate="no">create_api_key(map)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_events/1" translate="no">create_events(events)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_new_site/1" translate="no">create_new_site(map)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_pageviews/1" translate="no">create_pageviews(pageviews)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_sessions/1" translate="no">create_sessions(sessions)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_site/1" translate="no">create_site(map)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_user/1" translate="no">create_user(_)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#eventually/3" translate="no">eventually(expectation, wait_time_ms \\ 50, retries \\ 10)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#generate_usage_for/3" translate="no">generate_usage_for(site, i, timestamp \\ NaiveDateTime.utc_now())</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#init_session/1" translate="no">init_session(conn)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#log_in/1" translate="no">log_in(map)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#patch_env/2" translate="no">patch_env(env_key, value)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#populate_stats/1" translate="no">populate_stats(events)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#populate_stats/2" translate="no">populate_stats(site, events)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#random_ip/0" translate="no">random_ip()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#relative_time/1" translate="no">relative_time(shifts)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#setup_patch_env/2" translate="no">setup_patch_env(env_key, value)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#to_naive_truncate/1" translate="no">to_naive_truncate(dt)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#use_api_key/1" translate="no">use_api_key(map)</a>
</div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
Functions
</a>
</h1>
<div class="functions-list">
<section class="detail" id="add_imported_data/1">
<div class="detail-header">
<a href="#add_imported_data/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">add_imported_data(map)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L50" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="await_clickhouse_count/2">
<div class="detail-header">
<a href="#await_clickhouse_count/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">await_clickhouse_count(query, expected)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L229" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="create_api_key/1">
<div class="detail-header">
<a href="#create_api_key/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">create_api_key(map)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L64" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="create_events/1">
<div class="detail-header">
<a href="#create_events/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">create_events(events)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L93" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="create_new_site/1">
<div class="detail-header">
<a href="#create_new_site/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">create_new_site(map)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L59" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="create_pageviews/1">
<div class="detail-header">
<a href="#create_pageviews/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">create_pageviews(pageviews)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L76" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="create_sessions/1">
<div class="detail-header">
<a href="#create_sessions/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">create_sessions(sessions)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L105" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="create_site/1">
<div class="detail-header">
<a href="#create_site/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">create_site(map)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L41" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="create_user/1">
<div class="detail-header">
<a href="#create_user/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">create_user(_)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L37" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="eventually/3">
<span id="eventually/1"></span>
<span id="eventually/2"></span>
<div class="detail-header">
<a href="#eventually/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">eventually(expectation, wait_time_ms \\ 50, retries \\ 10)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L216" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="generate_usage_for/3">
<span id="generate_usage_for/2"></span>
<div class="detail-header">
<a href="#generate_usage_for/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">generate_usage_for(site, i, timestamp \\ NaiveDateTime.utc_now())</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L142" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="init_session/1">
<div class="detail-header">
<a href="#init_session/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">init_session(conn)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L126" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="log_in/1">
<div class="detail-header">
<a href="#log_in/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">log_in(map)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L118" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="patch_env/2">
<div class="detail-header">
<a href="#patch_env/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">patch_env(env_key, value)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L12" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="populate_stats/1">
<div class="detail-header">
<a href="#populate_stats/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">populate_stats(events)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L155" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="populate_stats/2">
<div class="detail-header">
<a href="#populate_stats/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">populate_stats(site, events)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L148" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="random_ip/0">
<div class="detail-header">
<a href="#random_ip/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">random_ip()</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L241" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="relative_time/1">
<div class="detail-header">
<a href="#relative_time/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">relative_time(shifts)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L202" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="setup_patch_env/2">
<div class="detail-header">
<a href="#setup_patch_env/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">setup_patch_env(env_key, value)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L29" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="to_naive_truncate/1">
<div class="detail-header">
<a href="#to_naive_truncate/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">to_naive_truncate(dt)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L208" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="use_api_key/1">
<div class="detail-header">
<a href="#use_api_key/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">use_api_key(map)</h1>
<a href="https://github.com/plausible/analytics/blob/main/test/support/test_utils.ex#L70" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="Plausible.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.30.3) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad: true})</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink