pydoc/2.47.0/_modules/apache_beam/runners/interactive/testing/integration/screen_diff.html - beam-site - Git at Google



 <!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.integration.screen_diff &mdash; Apache Beam 2.47.0 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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></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" />
 </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 class="version">
                 2.47.0
               </div>


 <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>
 <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.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"><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.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>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.yaml.html">apache_beam.yaml 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>
 </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="../../../../../index.html">Module code</a> &raquo;</li>

       <li>apache_beam.runners.interactive.testing.integration.screen_diff</li>


       <li class="wy-breadcrumbs-aside">

       </li>

   </ul>


   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <h1>Source code for apache_beam.runners.interactive.testing.integration.screen_diff</h1><div class="highlight"><pre>
 <span></span><span class="c1">#</span>
 <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
 <span class="c1"># contributor license agreements.  See the NOTICE file distributed with</span>
 <span class="c1"># this work for additional information regarding copyright ownership.</span>
 <span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
 <span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
 <span class="c1"># the License.  You may obtain a copy of the License at</span>
 <span class="c1">#</span>
 <span class="c1">#    http://www.apache.org/licenses/LICENSE-2.0</span>
 <span class="c1">#</span>
 <span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
 <span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
 <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
 <span class="c1"># See the License for the specific language governing permissions and</span>
 <span class="c1"># limitations under the License.</span>
 <span class="c1">#</span>

 <span class="sd">&quot;&quot;&quot;Module to conduct screen diff based notebook integration tests.&quot;&quot;&quot;</span>

 <span class="c1"># pytype: skip-file</span>

 <span class="kn">import</span> <span class="nn">os</span>
 <span class="kn">import</span> <span class="nn">platform</span>
 <span class="kn">import</span> <span class="nn">threading</span>
 <span class="kn">import</span> <span class="nn">unittest</span>
 <span class="kn">from</span> <span class="nn">http.server</span> <span class="kn">import</span> <span class="n">HTTPServer</span>
 <span class="kn">from</span> <span class="nn">http.server</span> <span class="kn">import</span> <span class="n">SimpleHTTPRequestHandler</span>

 <span class="kn">import</span> <span class="nn">pytest</span>

 <span class="kn">from</span> <span class="nn">apache_beam.runners.interactive</span> <span class="kn">import</span> <span class="n">interactive_environment</span> <span class="k">as</span> <span class="n">ie</span>
 <span class="kn">from</span> <span class="nn">apache_beam.runners.interactive.testing.integration</span> <span class="kn">import</span> <span class="n">notebook_executor</span>

 <span class="k">try</span><span class="p">:</span>
   <span class="kn">import</span> <span class="nn">chromedriver_binary</span>  <span class="c1"># pylint: disable=unused-import</span>
   <span class="kn">from</span> <span class="nn">needle.cases</span> <span class="kn">import</span> <span class="n">NeedleTestCase</span>
   <span class="kn">from</span> <span class="nn">needle.driver</span> <span class="kn">import</span> <span class="n">NeedleChrome</span>
   <span class="kn">from</span> <span class="nn">selenium.webdriver.chrome.options</span> <span class="kn">import</span> <span class="n">Options</span>
   <span class="kn">from</span> <span class="nn">selenium.webdriver.common.by</span> <span class="kn">import</span> <span class="n">By</span>
   <span class="kn">from</span> <span class="nn">selenium.webdriver.support</span> <span class="kn">import</span> <span class="n">expected_conditions</span>
   <span class="kn">from</span> <span class="nn">selenium.webdriver.support.ui</span> <span class="kn">import</span> <span class="n">WebDriverWait</span>
   <span class="n">_interactive_integration_ready</span> <span class="o">=</span> <span class="p">(</span>
       <span class="n">notebook_executor</span><span class="o">.</span><span class="n">_interactive_integration_ready</span><span class="p">)</span>
 <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
   <span class="n">_interactive_integration_ready</span> <span class="o">=</span> <span class="kc">False</span>

 <span class="c1"># Web elements will be rendered differently on different platforms. List all</span>
 <span class="c1"># supported platforms with goldens here.</span>
 <span class="n">_SUPPORTED_PLATFORMS</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;Darwin&#39;</span><span class="p">,</span> <span class="s1">&#39;Linux&#39;</span><span class="p">]</span>


 <div class="viewcode-block" id="ScreenDiffIntegrationTestEnvironment"><a class="viewcode-back" href="../../../../../../apache_beam.runners.interactive.testing.integration.screen_diff.html#apache_beam.runners.interactive.testing.integration.screen_diff.ScreenDiffIntegrationTestEnvironment">[docs]</a><span class="k">class</span> <span class="nc">ScreenDiffIntegrationTestEnvironment</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;A test environment to conduct screen diff integration tests for notebooks.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">test_notebook_path</span><span class="p">,</span> <span class="n">golden_dir</span><span class="p">,</span> <span class="n">cleanup</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
     <span class="c1"># type: (str, str, bool) -&gt; None</span>

     <span class="k">assert</span> <span class="n">_interactive_integration_ready</span><span class="p">,</span> <span class="p">(</span>
         <span class="s1">&#39;[interactive_test] dependency is not installed.&#39;</span><span class="p">)</span>
     <span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">golden_dir</span><span class="p">),</span> <span class="s1">&#39;</span><span class="si">{}</span><span class="s1"> does not exist.&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">golden_dir</span><span class="p">)</span>
     <span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">golden_dir</span><span class="p">),</span> <span class="s1">&#39;</span><span class="si">{}</span><span class="s1"> is not a directory.&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
       <span class="n">golden_dir</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_golden_dir</span> <span class="o">=</span> <span class="n">golden_dir</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_notebook_executor</span> <span class="o">=</span> <span class="n">notebook_executor</span><span class="o">.</span><span class="n">NotebookExecutor</span><span class="p">(</span>
         <span class="n">test_notebook_path</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_cleanup</span> <span class="o">=</span> <span class="n">cleanup</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_test_urls</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_server</span> <span class="o">=</span> <span class="kc">None</span>

   <span class="k">def</span> <span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_notebook_executor</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_server</span> <span class="o">=</span> <span class="n">HTTPServer</span><span class="p">((</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">SimpleHTTPRequestHandler</span><span class="p">)</span>

     <span class="k">def</span> <span class="nf">start_serving</span><span class="p">(</span><span class="n">server</span><span class="p">):</span>
       <span class="n">server</span><span class="o">.</span><span class="n">serve_forever</span><span class="p">()</span>

     <span class="n">threading</span><span class="o">.</span><span class="n">Thread</span><span class="p">(</span>
         <span class="n">target</span><span class="o">=</span><span class="n">start_serving</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_server</span><span class="p">],</span> <span class="n">daemon</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>

     <span class="k">for</span> <span class="n">test_id</span><span class="p">,</span> <span class="n">output_path</span> <span class="ow">in</span>\
       <span class="bp">self</span><span class="o">.</span><span class="n">_notebook_executor</span><span class="o">.</span><span class="n">output_html_paths</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">_test_urls</span><span class="p">[</span><span class="n">test_id</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">base_url</span> <span class="o">+</span> <span class="n">output_path</span>

     <span class="k">return</span> <span class="bp">self</span>

   <span class="k">def</span> <span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="n">traceback</span><span class="p">):</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_notebook_executor</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cleanup</span><span class="p">:</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">_notebook_executor</span><span class="o">.</span><span class="n">cleanup</span><span class="p">()</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_server</span><span class="p">:</span>

       <span class="k">def</span> <span class="nf">stop_serving</span><span class="p">(</span><span class="n">server</span><span class="p">):</span>
         <span class="n">server</span><span class="o">.</span><span class="n">shutdown</span><span class="p">()</span>

       <span class="n">threading</span><span class="o">.</span><span class="n">Thread</span><span class="p">(</span>
           <span class="n">target</span><span class="o">=</span><span class="n">stop_serving</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_server</span><span class="p">],</span> <span class="n">daemon</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>

   <span class="nd">@property</span>
   <span class="k">def</span> <span class="nf">base_url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;The base url where the locally started server serving HTMLs generated by</span>
 <span class="sd">    notebook executions.&quot;&quot;&quot;</span>
     <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">_server</span><span class="p">,</span> <span class="s1">&#39;Server has not started.&#39;</span>
     <span class="n">host_n_port</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_server</span><span class="o">.</span><span class="n">server_address</span>
     <span class="k">return</span> <span class="s1">&#39;http://</span><span class="si">{}</span><span class="s1">:</span><span class="si">{}</span><span class="s1">/&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">host_n_port</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">host_n_port</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>

   <span class="nd">@property</span>
   <span class="k">def</span> <span class="nf">test_urls</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Mapping from test_id/execution_id to urls serving the output HTML pages</span>
 <span class="sd">    generated by the corresponding notebook executions.&quot;&quot;&quot;</span>
     <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_test_urls</span>

   <span class="nd">@property</span>
   <span class="k">def</span> <span class="nf">notebook_path_to_test_id</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Mapping from input notebook paths to their obfuscated execution/test ids.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_notebook_executor</span><span class="o">.</span><span class="n">notebook_path_to_execution_id</span></div>


 <div class="viewcode-block" id="should_skip"><a class="viewcode-back" href="../../../../../../apache_beam.runners.interactive.testing.integration.screen_diff.html#apache_beam.runners.interactive.testing.integration.screen_diff.should_skip">[docs]</a><span class="k">def</span> <span class="nf">should_skip</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Whether a screen diff test should be skipped.&quot;&quot;&quot;</span>
   <span class="k">return</span> <span class="ow">not</span> <span class="p">(</span>
       <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span> <span class="ow">in</span> <span class="n">_SUPPORTED_PLATFORMS</span> <span class="ow">and</span>
       <span class="n">ie</span><span class="o">.</span><span class="n">current_env</span><span class="p">()</span><span class="o">.</span><span class="n">is_interactive_ready</span> <span class="ow">and</span> <span class="n">_interactive_integration_ready</span><span class="p">)</span></div>


 <span class="k">if</span> <span class="n">should_skip</span><span class="p">():</span>

   <span class="nd">@unittest</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span>
       <span class="n">reason</span><span class="o">=</span><span class="s1">&#39;[interactive] and [interactive_test] deps are both required.&#39;</span><span class="p">)</span>
   <span class="nd">@pytest</span><span class="o">.</span><span class="n">mark</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span>
       <span class="n">reason</span><span class="o">=</span><span class="s1">&#39;[interactive] and [interactive_test] deps are both required.&#39;</span><span class="p">)</span>
   <span class="k">class</span> <span class="nc">BaseTestCase</span><span class="p">(</span><span class="n">unittest</span><span class="o">.</span><span class="n">TestCase</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;A skipped base test case if interactive_test dependency is not installed.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">pass</span>

 <span class="k">else</span><span class="p">:</span>

 <div class="viewcode-block" id="BaseTestCase"><a class="viewcode-back" href="../../../../../../apache_beam.runners.interactive.testing.integration.screen_diff.html#apache_beam.runners.interactive.testing.integration.screen_diff.BaseTestCase">[docs]</a>  <span class="k">class</span> <span class="nc">BaseTestCase</span><span class="p">(</span><span class="n">NeedleTestCase</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;A base test case to execute screen diff integration tests.&quot;&quot;&quot;</span>
     <span class="c1"># Whether the browser should be headless.</span>
     <span class="n">_headless</span> <span class="o">=</span> <span class="kc">True</span>

     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 <span class="w">      </span><span class="sd">&quot;&quot;&quot;Initializes a test.</span>

 <span class="sd">      Some kwargs that could be configured:</span>

 <span class="sd">        #. golden_dir=&lt;path&gt;. A directory path pointing to all the golden</span>
 <span class="sd">           screenshots as baselines for comparison.</span>
 <span class="sd">        #. test_notebook_dir=&lt;path&gt;. A path pointing to a directory of</span>
 <span class="sd">           notebook files in ipynb format.</span>
 <span class="sd">        #. headless=&lt;True/False&gt;. Whether the browser should be headless when</span>
 <span class="sd">           executing the tests.</span>
 <span class="sd">        #. golden_size=&lt;(int, int)&gt;. The size of the screenshot to take and</span>
 <span class="sd">           compare.</span>
 <span class="sd">        #. cleanup=&lt;True/False&gt;. Whether to clean up the output directory.</span>
 <span class="sd">           Should always be True in automated test environment. When debugging,</span>
 <span class="sd">           turn it False to manually check the output for difference.</span>
 <span class="sd">        #. threshold=&lt;float&gt;. An image difference threshold, when the image</span>
 <span class="sd">           pixel distance is bigger than the value, the test will fail.</span>
 <span class="sd">      &quot;&quot;&quot;</span>
       <span class="n">golden_root</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span>
           <span class="s1">&#39;golden_dir&#39;</span><span class="p">,</span>
           <span class="s1">&#39;apache_beam/runners/interactive/testing/integration/goldens&#39;</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">_golden_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">golden_root</span><span class="p">,</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">())</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">_test_notebook_dir</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span>
           <span class="s1">&#39;test_notebook_dir&#39;</span><span class="p">,</span>
           <span class="s1">&#39;apache_beam/runners/interactive/testing/integration/test_notebooks&#39;</span><span class="p">)</span>
       <span class="n">BaseTestCase</span><span class="o">.</span><span class="n">_headless</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">&#39;headless&#39;</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">_test_env</span> <span class="o">=</span> <span class="kc">None</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">_viewport_width</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_viewport_height</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span>
         <span class="s1">&#39;golden_size&#39;</span><span class="p">,</span> <span class="p">(</span><span class="mi">1024</span><span class="p">,</span> <span class="mi">10000</span><span class="p">))</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">_cleanup</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">&#39;cleanup&#39;</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">_threshold</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">&#39;threshold&#39;</span><span class="p">,</span> <span class="mi">5000</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">baseline_directory</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_golden_dir</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">output_directory</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
           <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_test_notebook_dir</span><span class="p">,</span> <span class="s1">&#39;output&#39;</span><span class="p">)</span>
       <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>

     <span class="nd">@classmethod</span>
     <span class="k">def</span> <span class="nf">get_web_driver</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
       <span class="n">chrome_options</span> <span class="o">=</span> <span class="n">Options</span><span class="p">()</span>
       <span class="k">if</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_headless</span><span class="p">:</span>
         <span class="n">chrome_options</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;--headless&#39;</span><span class="p">)</span>
       <span class="n">chrome_options</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;--no-sandbox&#39;</span><span class="p">)</span>
       <span class="n">chrome_options</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;--disable-dev-shm-usage&#39;</span><span class="p">)</span>
       <span class="n">chrome_options</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;--force-color-profile=srgb&#39;</span><span class="p">)</span>
       <span class="k">return</span> <span class="n">NeedleChrome</span><span class="p">(</span><span class="n">options</span><span class="o">=</span><span class="n">chrome_options</span><span class="p">)</span>

     <span class="k">def</span> <span class="nf">setUp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">set_viewport_size</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_viewport_width</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_viewport_height</span><span class="p">)</span>

     <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
       <span class="k">with</span> <span class="n">ScreenDiffIntegrationTestEnvironment</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_test_notebook_dir</span><span class="p">,</span>
                                                 <span class="bp">self</span><span class="o">.</span><span class="n">_golden_dir</span><span class="p">,</span>
                                                 <span class="bp">self</span><span class="o">.</span><span class="n">_cleanup</span><span class="p">)</span> <span class="k">as</span> <span class="n">test_env</span><span class="p">:</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_test_env</span> <span class="o">=</span> <span class="n">test_env</span>
         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>

     <span class="k">def</span> <span class="nf">explicit_wait</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">      </span><span class="sd">&quot;&quot;&quot;Wait for common elements to be visible.&quot;&quot;&quot;</span>
       <span class="n">WebDriverWait</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">driver</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span><span class="o">.</span><span class="n">until</span><span class="p">(</span>
           <span class="n">expected_conditions</span><span class="o">.</span><span class="n">visibility_of_element_located</span><span class="p">(</span>
               <span class="p">(</span><span class="n">By</span><span class="o">.</span><span class="n">TAG_NAME</span><span class="p">,</span> <span class="s1">&#39;facets-overview&#39;</span><span class="p">)))</span>
       <span class="n">WebDriverWait</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">driver</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span><span class="o">.</span><span class="n">until</span><span class="p">(</span>
           <span class="n">expected_conditions</span><span class="o">.</span><span class="n">visibility_of_element_located</span><span class="p">(</span>
               <span class="p">(</span><span class="n">By</span><span class="o">.</span><span class="n">TAG_NAME</span><span class="p">,</span> <span class="s1">&#39;facets-dive&#39;</span><span class="p">)))</span>

     <span class="k">def</span> <span class="nf">assert_all</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">      </span><span class="sd">&quot;&quot;&quot;Asserts screenshots for all notebooks in the test_notebook_path.&quot;&quot;&quot;</span>
       <span class="k">for</span> <span class="n">test_id</span><span class="p">,</span> <span class="n">test_url</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_test_env</span><span class="o">.</span><span class="n">test_urls</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">driver</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">test_url</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">explicit_wait</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">assertScreenshot</span><span class="p">(</span><span class="s1">&#39;body&#39;</span><span class="p">,</span> <span class="n">test_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_threshold</span><span class="p">)</span>

     <span class="k">def</span> <span class="nf">assert_single</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">test_id</span><span class="p">):</span>
 <span class="w">      </span><span class="sd">&quot;&quot;&quot;Asserts the screenshot for a single test. The given test id will be the</span>
 <span class="sd">      name of the golden screenshot.&quot;&quot;&quot;</span>
       <span class="n">test_url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_test_env</span><span class="o">.</span><span class="n">test_urls</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">test_id</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
       <span class="k">assert</span> <span class="n">test_url</span><span class="p">,</span> <span class="s1">&#39;</span><span class="si">{}</span><span class="s1"> is not a valid test id.&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">test_id</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">driver</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">test_url</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">explicit_wait</span><span class="p">()</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">assertScreenshot</span><span class="p">(</span><span class="s1">&#39;body&#39;</span><span class="p">,</span> <span class="n">test_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_threshold</span><span class="p">)</span>

     <span class="k">def</span> <span class="nf">assert_notebook</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">notebook_name</span><span class="p">):</span>
 <span class="w">      </span><span class="sd">&quot;&quot;&quot;Asserts the screenshot for a single notebook. The notebook with the</span>
 <span class="sd">      given notebook_name under test_notebook_dir will be executed and asserted.</span>
 <span class="sd">      &quot;&quot;&quot;</span>
       <span class="k">if</span> <span class="ow">not</span> <span class="n">notebook_name</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">&#39;.ipynb&#39;</span><span class="p">):</span>
         <span class="n">notebook_name</span> <span class="o">+=</span> <span class="s1">&#39;.ipynb&#39;</span>
       <span class="n">notebook_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_test_notebook_dir</span><span class="p">,</span> <span class="n">notebook_name</span><span class="p">)</span>
       <span class="n">test_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_test_env</span><span class="o">.</span><span class="n">notebook_path_to_test_id</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">notebook_path</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
       <span class="k">assert</span> <span class="n">test_id</span><span class="p">,</span> <span class="s1">&#39;Cannot find notebook with name </span><span class="si">{}</span><span class="s1">.&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">notebook_name</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">assert_single</span><span class="p">(</span><span class="n">test_id</span><span class="p">)</span></div>


 <span class="c1"># This file contains no tests. Below lines are purely for passing lint.</span>
 <span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">&#39;__main__&#39;</span><span class="p">:</span>
   <span class="n">unittest</span><span class="o">.</span><span class="n">main</span><span class="p">()</span>
 </pre></div>

            </div>

           </div>
           <footer>


   <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>