blob: dc74e6f817dacbc4fe1bc204fbd59fb3506dddad [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>apache_beam.runners.interactive.testing.pipeline_assertion module &mdash; Apache Beam documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="apache_beam.runners.interactive.testing.test_cache_manager module" href="apache_beam.runners.interactive.testing.test_cache_manager.html" />
<link rel="prev" title="apache_beam.runners.interactive.testing.mock_ipython module" href="apache_beam.runners.interactive.testing.mock_ipython.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"> Apache Beam
</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" />
<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="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.internal.html">apache_beam.internal package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.runners.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.html">apache_beam.runners.direct package</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="apache_beam.runners.interactive.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.interactive.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.internal.html">apache_beam.runners.internal package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.job.html">apache_beam.runners.job package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.tools.html">apache_beam.tools package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Apache Beam</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="apache_beam.runners.html">apache_beam.runners package</a> &raquo;</li>
<li><a href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a> &raquo;</li>
<li><a href="apache_beam.runners.interactive.testing.html">apache_beam.runners.interactive.testing package</a> &raquo;</li>
<li>apache_beam.runners.interactive.testing.pipeline_assertion module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.runners.interactive.testing.pipeline_assertion.rst.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">
<div class="section" id="module-apache_beam.runners.interactive.testing.pipeline_assertion">
<span id="apache-beam-runners-interactive-testing-pipeline-assertion-module"></span><h1>apache_beam.runners.interactive.testing.pipeline_assertion module<a class="headerlink" href="#module-apache_beam.runners.interactive.testing.pipeline_assertion" title="Permalink to this headline"></a></h1>
<p>Module to verify implicit cache transforms applied by Interactive Beam.</p>
<p>For internal use only; no backwards-compatibility guarantees.
This utility should only be used by Interactive Beam tests. For example, it can
be used to verify if the implicit cache transforms are applied as expected when
running a pipeline with the InteractiveRunner. It can also be used to verify if
a pipeline fragment has pruned unnecessary transforms. It shouldn’t be used to
verify equivalence between pipelines if the code to be tested depends on or
mutates user code within transforms in pipelines.</p>
<dl class="function">
<dt id="apache_beam.runners.interactive.testing.pipeline_assertion.assert_pipeline_equal">
<code class="descclassname">apache_beam.runners.interactive.testing.pipeline_assertion.</code><code class="descname">assert_pipeline_equal</code><span class="sig-paren">(</span><em>test_case</em>, <em>expected_pipeline</em>, <em>actual_pipeline</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/testing/pipeline_assertion.html#assert_pipeline_equal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.testing.pipeline_assertion.assert_pipeline_equal" title="Permalink to this definition"></a></dt>
<dd><p>Asserts the equivalence between two given apache_beam.Pipeline instances.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>test_case</strong> – (unittest.TestCase) the unittest testcase where it asserts.</li>
<li><strong>expected_pipeline</strong> – (Pipeline) the pipeline instance expected.</li>
<li><strong>actual_pipeline</strong> – (Pipeline) the actual pipeline instance to be asserted.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="apache_beam.runners.interactive.testing.pipeline_assertion.assert_pipeline_proto_equal">
<code class="descclassname">apache_beam.runners.interactive.testing.pipeline_assertion.</code><code class="descname">assert_pipeline_proto_equal</code><span class="sig-paren">(</span><em>test_case</em>, <em>expected_pipeline_proto</em>, <em>actual_pipeline_proto</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/testing/pipeline_assertion.html#assert_pipeline_proto_equal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.testing.pipeline_assertion.assert_pipeline_proto_equal" title="Permalink to this definition"></a></dt>
<dd><p>Asserts the equivalence between two pipeline proto representations.</p>
</dd></dl>
<dl class="function">
<dt id="apache_beam.runners.interactive.testing.pipeline_assertion.assert_pipeline_proto_contain_top_level_transform">
<code class="descclassname">apache_beam.runners.interactive.testing.pipeline_assertion.</code><code class="descname">assert_pipeline_proto_contain_top_level_transform</code><span class="sig-paren">(</span><em>test_case</em>, <em>pipeline_proto</em>, <em>transform_label</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/testing/pipeline_assertion.html#assert_pipeline_proto_contain_top_level_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.testing.pipeline_assertion.assert_pipeline_proto_contain_top_level_transform" title="Permalink to this definition"></a></dt>
<dd><p>Asserts the top level transforms contain a transform with the given
transform label.</p>
</dd></dl>
<dl class="function">
<dt id="apache_beam.runners.interactive.testing.pipeline_assertion.assert_pipeline_proto_not_contain_top_level_transform">
<code class="descclassname">apache_beam.runners.interactive.testing.pipeline_assertion.</code><code class="descname">assert_pipeline_proto_not_contain_top_level_transform</code><span class="sig-paren">(</span><em>test_case</em>, <em>pipeline_proto</em>, <em>transform_label</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/testing/pipeline_assertion.html#assert_pipeline_proto_not_contain_top_level_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.testing.pipeline_assertion.assert_pipeline_proto_not_contain_top_level_transform" title="Permalink to this definition"></a></dt>
<dd><p>Asserts the top level transforms do not contain a transform with the given
transform label.</p>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.runners.interactive.testing.test_cache_manager.html" class="btn btn-neutral float-right" title="apache_beam.runners.interactive.testing.test_cache_manager module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.runners.interactive.testing.mock_ipython.html" class="btn btn-neutral float-left" title="apache_beam.runners.interactive.testing.mock_ipython module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>