puppeteer/integrations/ng-schematics/index.html

22 lines
80 KiB
HTML
Raw Normal View History

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-21.1.1 plugin-docs plugin-id-default docs-doc-id-integrations/ng-schematics">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.4.1">
<title data-rh="true">Puppeteer Angular Schematic | Puppeteer</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pptr.dev/integrations/ng-schematics"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:counter" content="2"><meta data-rh="true" property="og:title" content="Puppeteer Angular Schematic | Puppeteer"><meta data-rh="true" name="description" content="Adds Puppeteer-based e2e tests to your Angular project."><meta data-rh="true" property="og:description" content="Adds Puppeteer-based e2e tests to your Angular project."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pptr.dev/integrations/ng-schematics"><link data-rh="true" rel="alternate" href="https://pptr.dev/integrations/ng-schematics" hreflang="en"><link data-rh="true" rel="alternate" href="https://pptr.dev/integrations/ng-schematics" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://DVKY664LG7-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Puppeteer" href="/opensearch.xml">
<script src="/fix-location.js"></script><link rel="stylesheet" href="/assets/css/styles.bc90d5c1.css">
<link rel="preload" href="/assets/js/runtime~main.bfba9704.js" as="script">
<link rel="preload" href="/assets/js/main.5e38d844.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png" alt="Puppeteer Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png" alt="Puppeteer Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Puppeteer</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/">Docs</a><a class="navbar__item navbar__link" href="/api/puppeteer.puppeteernode">Puppeteer API</a><a class="navbar__item navbar__link" href="/browsers-api/">@puppeteer/browsers API</a></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/">21.1.1</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/next/integrations/ng-schematics">Next</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/integrations/ng-schematics">21.1.1</a></li><li><hr class="dropdown-separator"></li><li class="dropdown-archived-versions"><b>Archived versions</b></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.1.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">21.1.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.0.3/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">21.0.3<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.0.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">21.0.2<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.0.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">21.0.1<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.0.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">21.0.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/pup
To avoid this you can specify the port the an the <code>angular.json</code>
Update either <code>e2e</code> or <code>puppeteer</code> (depending on the initial setup) to:</p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">&quot;e2e&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">&quot;builder&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;@puppeteer/ng-schematics:puppeteer&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">&quot;options&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">&quot;commands&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">...</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">&quot;devServerTarget&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;sandbox:serve&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">&quot;testRunner&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;&lt;TestRunner&gt;&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">&quot;port&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8080</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> ...</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" ti
The following table shows Puppeteer&#x27;s equivalents to <a href="https://www.protractortest.org/#/api?view=ProtractorBy" target="_blank" rel="noopener noreferrer">Protractor By</a>.</p><blockquote><p>For improved reliability and reduced flakiness try our
<strong>Experimental</strong> <a href="https://pptr.dev/guides/locators" target="_blank" rel="noopener noreferrer">Locators API</a></p></blockquote><table><thead><tr><th>By</th><th>Protractor code</th><th>Puppeteer querySelector</th></tr></thead><tbody><tr><td>CSS (Single)</td><td><code>$(by.css(&#x27;&lt;CSS&gt;&#x27;))</code></td><td><code>page.$(&#x27;&lt;CSS&gt;&#x27;)</code></td></tr><tr><td>CSS (Multiple)</td><td><code>$$(by.css(&#x27;&lt;CSS&gt;&#x27;))</code></td><td><code>page.$$(&#x27;&lt;CSS&gt;&#x27;)</code></td></tr><tr><td>Id</td><td><code>$(by.id(&#x27;&lt;ID&gt;&#x27;))</code></td><td><code>page.$(&#x27;#&lt;ID&gt;&#x27;)</code></td></tr><tr><td>CssContainingText</td><td><code>$(by.cssContainingText(&#x27;&lt;CSS&gt;&#x27;, &#x27;&lt;TEXT&gt;&#x27;))</code></td><td><code>page.$(&#x27;&lt;CSS&gt; ::-p-text(&lt;TEXT&gt;)&#x27;)</code> `</td></tr><tr><td>DeepCss</td><td><code>$(by.deepCss(&#x27;&lt;CSS&gt;&#x27;))</code></td><td><code>page.$(&#x27;:scope &gt;&gt;&gt; &lt;CSS&gt;&#x27;)</code></td></tr><tr><td>XPath</td><td><code>$(by.xpath(&#x27;&lt;XPATH&gt;&#x27;))</code></td><td><code>page.$(&#x27;::-p-xpath(&lt;XPATH&gt;)&#x27;)</code></td></tr><tr><td>JS</td><td><code>$(by.js(&#x27;document.querySelector(&quot;&lt;CSS&gt;&quot;)&#x27;))</code></td><td><code>page.evaluateHandle(() =&gt; document.querySelector(&#x27;&lt;CSS&gt;&#x27;))</code></td></tr></tbody></table><blockquote><p>For advanced use cases such as Protractor&#x27;s <code>by.addLocator</code> you can check Puppeteer&#x27;s <a href="https://pptr.dev/guides/query-selectors#custom-selectors" target="_blank" rel="noopener noreferrer">Custom selectors</a>.</p></blockquote></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/category/integrations"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Integrations</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/chromium-support"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Chromium Support</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#getting-started" class="table-of-contents__link toc-highlight">Getting started</a><ul><li><a href="#options" class="table-of-contents__link toc-highlight">Options</a></li></ul></li><li><a href="#creating-a-single-test-file" class="table-of-contents__link toc-highlight">Creating a single test file</a><ul><li><a href="#running-test-server-and-dev-server-at-the-same-time" class="table-of-contents__link toc-highlight">Running test server and dev server at the same time</a></li></ul></li><li><a href="#contributing" class="table-of-contents__link toc-highlight">Contributing</a><ul><li><a href="#sandbox" class="table-of-contents__link toc-highlight">Sandbox</a></li><li><a href="#unit-testing" class="table-of-contents__link toc-highlight">Unit Testing</a></li></ul></li><li><a href="#migrating-from-protractor" class="table-of-contents__link toc-highlight">Migrating from Protractor</a><ul><li><a href="#browser" class="table-of-contents__link toc-highlight">Browser</a></li><li><a href="#query-selectors" class="table-of-contents__link toc-highlight">Query Selectors</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/puppeteer" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v
<script src="/assets/js/runtime~main.bfba9704.js"></script>
<script src="/assets/js/main.5e38d844.js"></script>
</body>
</html>