| |
| |
| <!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.testing.pipeline_verifiers module — 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.testing.synthetic_pipeline module" href="apache_beam.testing.synthetic_pipeline.html" /> |
| <link rel="prev" title="apache_beam.testing.metric_result_matchers module" href="apache_beam.testing.metric_result_matchers.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"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.testing.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.testing.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.datatype_inference.html">apache_beam.testing.datatype_inference module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.extra_assertions.html">apache_beam.testing.extra_assertions module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.metric_result_matchers.html">apache_beam.testing.metric_result_matchers module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.testing.pipeline_verifiers module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.synthetic_pipeline.html">apache_beam.testing.synthetic_pipeline module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.test_pipeline.html">apache_beam.testing.test_pipeline module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.test_stream.html">apache_beam.testing.test_stream module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.test_stream_service.html">apache_beam.testing.test_stream_service module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.test_utils.html">apache_beam.testing.test_utils module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.util.html">apache_beam.testing.util module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </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> »</li> |
| |
| <li><a href="apache_beam.testing.html">apache_beam.testing package</a> »</li> |
| |
| <li>apache_beam.testing.pipeline_verifiers module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.testing.pipeline_verifiers.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.testing.pipeline_verifiers"> |
| <span id="apache-beam-testing-pipeline-verifiers-module"></span><h1>apache_beam.testing.pipeline_verifiers module<a class="headerlink" href="#module-apache_beam.testing.pipeline_verifiers" title="Permalink to this headline">¶</a></h1> |
| <p>End-to-end test result verifiers</p> |
| <p>A set of verifiers that are used in end-to-end tests to verify state/output |
| of test pipeline job. Customized verifier should extend |
| <cite>hamcrest.core.base_matcher.BaseMatcher</cite> and override _matches.</p> |
| <dl class="class"> |
| <dt id="apache_beam.testing.pipeline_verifiers.PipelineStateMatcher"> |
| <em class="property">class </em><code class="descclassname">apache_beam.testing.pipeline_verifiers.</code><code class="descname">PipelineStateMatcher</code><span class="sig-paren">(</span><em>expected_state='DONE'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/pipeline_verifiers.html#PipelineStateMatcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.testing.pipeline_verifiers.PipelineStateMatcher" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://pyhamcrest.readthedocs.io/en/stable/core/#hamcrest.core.base_matcher.BaseMatcher" title="(in PyHamcrest v2.0.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">hamcrest.core.base_matcher.BaseMatcher</span></code></a></p> |
| <p>Matcher that verify pipeline job terminated in expected state</p> |
| <p>Matcher compares the actual pipeline terminate state with expected. |
| By default, <cite>PipelineState.DONE</cite> is used as expected state.</p> |
| <dl class="method"> |
| <dt id="apache_beam.testing.pipeline_verifiers.PipelineStateMatcher.describe_to"> |
| <code class="descname">describe_to</code><span class="sig-paren">(</span><em>description</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/pipeline_verifiers.html#PipelineStateMatcher.describe_to"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.testing.pipeline_verifiers.PipelineStateMatcher.describe_to" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.testing.pipeline_verifiers.PipelineStateMatcher.describe_mismatch"> |
| <code class="descname">describe_mismatch</code><span class="sig-paren">(</span><em>pipeline_result</em>, <em>mismatch_description</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/pipeline_verifiers.html#PipelineStateMatcher.describe_mismatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.testing.pipeline_verifiers.PipelineStateMatcher.describe_mismatch" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.testing.pipeline_verifiers.retry_on_io_error_and_server_error"> |
| <code class="descclassname">apache_beam.testing.pipeline_verifiers.</code><code class="descname">retry_on_io_error_and_server_error</code><span class="sig-paren">(</span><em>exception</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/pipeline_verifiers.html#retry_on_io_error_and_server_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.testing.pipeline_verifiers.retry_on_io_error_and_server_error" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Filter allowing retries on file I/O errors and service error.</p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.testing.pipeline_verifiers.FileChecksumMatcher"> |
| <em class="property">class </em><code class="descclassname">apache_beam.testing.pipeline_verifiers.</code><code class="descname">FileChecksumMatcher</code><span class="sig-paren">(</span><em>file_path</em>, <em>expected_checksum</em>, <em>sleep_secs=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/pipeline_verifiers.html#FileChecksumMatcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.testing.pipeline_verifiers.FileChecksumMatcher" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://pyhamcrest.readthedocs.io/en/stable/core/#hamcrest.core.base_matcher.BaseMatcher" title="(in PyHamcrest v2.0.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">hamcrest.core.base_matcher.BaseMatcher</span></code></a></p> |
| <p>Matcher that verifies file(s) content by comparing file checksum.</p> |
| <p>Use apache_beam.io.filebasedsink to fetch file(s) from given path. |
| File checksum is a hash string computed from content of file(s).</p> |
| <p>Initialize a FileChecksumMatcher object</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>file_path</strong> – A string that is the full path of output file. This path |
| can contain globs.</li> |
| <li><strong>expected_checksum</strong> – A hash string that is computed from expected |
| result.</li> |
| <li><strong>sleep_secs</strong> – Number of seconds to wait before verification start. |
| Extra time are given to make sure output files are ready on FS.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="apache_beam.testing.pipeline_verifiers.FileChecksumMatcher.describe_to"> |
| <code class="descname">describe_to</code><span class="sig-paren">(</span><em>description</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/pipeline_verifiers.html#FileChecksumMatcher.describe_to"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.testing.pipeline_verifiers.FileChecksumMatcher.describe_to" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.testing.pipeline_verifiers.FileChecksumMatcher.describe_mismatch"> |
| <code class="descname">describe_mismatch</code><span class="sig-paren">(</span><em>pipeline_result</em>, <em>mismatch_description</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/pipeline_verifiers.html#FileChecksumMatcher.describe_mismatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.testing.pipeline_verifiers.FileChecksumMatcher.describe_mismatch" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.testing.synthetic_pipeline.html" class="btn btn-neutral float-right" title="apache_beam.testing.synthetic_pipeline module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.testing.metric_result_matchers.html" class="btn btn-neutral float-left" title="apache_beam.testing.metric_result_matchers module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © 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> |