mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2025-04-07 11:20:28 -07:00
185 lines
No EOL
10 KiB
HTML
185 lines
No EOL
10 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" data-content_root="./">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Testing — Keycloak Ansible Collection documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
|
||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
|
||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/ansible-basic-sphinx-ext.css" />
|
||
|
||
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||
<script src="_static/doctools.js?v=9a2dae69"></script>
|
||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="Contributor’s Guidelines" href="developing.html" />
|
||
<link rel="prev" title="keycloak_realm" href="roles/keycloak_realm.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home">
|
||
Keycloak Ansible Collection
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Testing</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#continuous-integration">Continuous integration</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#integration-testing">Integration testing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#test-playbooks">Test playbooks</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="developing.html">Contributor’s Guidelines</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasing.html">Collection Versioning Strategy</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">General</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Middleware collections</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/infinispan/main/">Infinispan / Red Hat Data Grid</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/keycloak/main/">Keycloak / Red Hat Single Sign-On</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/wildfly/main/">Wildfly / Red Hat JBoss EAP</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/jws/main/">Tomcat / Red Hat JWS</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq/main/">ActiveMQ / Red Hat AMQ Broker</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq_streams/main/">Kafka / Red Hat AMQ Streams</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/common/main/">Ansible Middleware utilities</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/redhat-csp-download/main/">Red Hat CSP Download</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/ansible_collections_jcliff/main/">JCliff</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">Keycloak Ansible Collection</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item active">Testing</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/testing.md.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="testing">
|
||
<h1>Testing<a class="headerlink" href="#testing" title="Link to this heading"></a></h1>
|
||
<section id="continuous-integration">
|
||
<h2>Continuous integration<a class="headerlink" href="#continuous-integration" title="Link to this heading"></a></h2>
|
||
<p>The collection is tested with a <a class="reference external" href="https://github.com/ansible-community/molecule">molecule</a> setup covering the included roles and verifying correct installation and idempotency.
|
||
In order to run the molecule tests locally with python 3.9 available, after cloning the repository:</p>
|
||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">pip install yamllint 'molecule[docker]~=3.5.2' ansible-core flake8 ansible-lint voluptuous</span>
|
||
<span class="l l-Scalar l-Scalar-Plain">molecule test --all</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="integration-testing">
|
||
<h2>Integration testing<a class="headerlink" href="#integration-testing" title="Link to this heading"></a></h2>
|
||
<p>Demo repositories which depend on the collection, and aggregate functionality with other middleware_automation collections, are automatically rebuilt
|
||
at every collection release to ensure non-breaking changes and consistent behaviour.</p>
|
||
<p>The repository are:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://github.com/ansible-middleware/flange-demo">Flange demo</a>
|
||
A deployment of Wildfly cluster integrated with keycloak and infinispan.</p></li>
|
||
<li><p><a class="reference external" href="https://github.com/ansible-middleware/cross-dc-rhsso-demo">CrossDC keycloak demo</a>
|
||
A clustered multi-regional installation of keycloak with infinispan remote caches.</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="test-playbooks">
|
||
<h2>Test playbooks<a class="headerlink" href="#test-playbooks" title="Link to this heading"></a></h2>
|
||
<p>Sample playbooks are provided in the <code class="docutils literal notranslate"><span class="pre">playbooks/</span></code> directory; to run the playbooks locally (requires a rhel system with python 3.9+, ansible, and systemd) the steps are as follows:</p>
|
||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="c1"># setup environment</span>
|
||
<span class="l l-Scalar l-Scalar-Plain">pip install ansible-core</span>
|
||
<span class="l l-Scalar l-Scalar-Plain"># clone the repository</span>
|
||
<span class="l l-Scalar l-Scalar-Plain">git clone https://github.com/ansible-middleware/keycloak</span>
|
||
<span class="l l-Scalar l-Scalar-Plain">cd keycloak</span>
|
||
<span class="l l-Scalar l-Scalar-Plain"># install collection dependencies</span>
|
||
<span class="l l-Scalar l-Scalar-Plain">ansible-galaxy collection install -r requirements.yml</span>
|
||
<span class="l l-Scalar l-Scalar-Plain"># install collection python deps</span>
|
||
<span class="l l-Scalar l-Scalar-Plain">pip install -r requirements.txt</span>
|
||
<span class="l l-Scalar l-Scalar-Plain"># create inventory for localhost</span>
|
||
<span class="l l-Scalar l-Scalar-Plain">cat << EOF > inventory</span>
|
||
<span class="l l-Scalar l-Scalar-Plain">[keycloak]</span>
|
||
<span class="l l-Scalar l-Scalar-Plain">localhost ansible_connection=local</span>
|
||
<span class="l l-Scalar l-Scalar-Plain">EOF</span>
|
||
<span class="l l-Scalar l-Scalar-Plain"># run the playbook</span>
|
||
<span class="l l-Scalar l-Scalar-Plain">ansible-playbook -i inventory playbooks/keycloak.yml</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="roles/keycloak_realm.html" class="btn btn-neutral float-left" title="keycloak_realm" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="developing.html" class="btn btn-neutral float-right" title="Contributor’s Guidelines" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2024, Red Hat, Inc..</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |