Skip to content

Commit

Permalink
Adds links to Recipes page to match cypress-example-recipes repo (cyp…
Browse files Browse the repository at this point in the history
…ress-io#2645)

* adds links to custom browsers and Chrome Remote Interface recipes to Fundamentals section

* adds links to new recipes in Testing the DOM section

* adds recipe links to Preprocessors and Blogs sections

* adds recipe links to Stubbing and spying and Server Communication sections.

* adds Other Cyprese Recipes section and links. Resolves issue-2642

* Fix some of the title to make capitalization /spacing consistent

Co-authored-by: Jennifer Shehane <[email protected]>
  • Loading branch information
CypressCecelia and jennifer-shehane authored Mar 23, 2020
1 parent 70c3dcd commit ba986eb
Showing 1 changed file with 46 additions and 9 deletions.
55 changes: 46 additions & 9 deletions source/examples/examples/recipes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,37 @@ Recipes show you how to test common scenarios in Cypress.

{% fa fa-github %} {% url https://github.com/cypress-io/cypress-example-recipes %}

## Fundamentals
## Fundamentals

Recipe | Description
--- | ---
--- | ---
{% url 'Node Modules' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/fundamentals__node-modules %} | Import your own Node modules
{% url 'Environment variables' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/server-communication__env-variables %} | Passing environment variables to tests
{% url 'Dynamic tests' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/fundamentals__dynamic-tests %} | Create tests dynamically from data
{% url 'Fixtures' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/fundamentals__fixtures %} | Loading single or multiple fixtures
{% url 'Adding Chai Assertions' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/extending-cypress__chai-assertions %} | Add new or custom chai assertions
{% url 'Cypress module API' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/fundamentals__module-api %} | Run Cypress via its module API
{% url 'Custom browsers' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/fundamentals__custom-browsers %} | Control which browsers the project can use, or even add a custom browser into the list
{% url 'Use Chrome Remote Interface' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/fundamentals__chrome-remote-debugging %} | Use Chrome debugger protocol to trigger hover state and print media style

## Testing the DOM

Recipe | Description
--- | ---
--- | ---
{% url 'Tab Handling and Links' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/testing-dom__tab-handling-links %} | Links that open in a new tab
{% url 'Hover and Hidden Elements' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/testing-dom__hover-hidden-elements %} | Test hidden elements requiring hover
{% url 'Form Interactions' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/testing-dom__form-interactions %} | Test form elements like input type `range`
{% url 'Drag and Drop' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/testing-dom__drag-drop %} | Use `.trigger()` to test drag and drop
{% url 'Shadow DOM' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/testing-dom__shadow-dom %} | You need to use any of available custom commands
{% url 'Website monitoring' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/testing-dom__performance-metrics %} | Utilize `cypress` to monitor your website
{% url 'Waiting for static resource' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/testing-dom__wait-for-resource %} | Shows how to wait for CSS, image, or any other static resource to load
{% url 'CSV load and table test' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/testing-dom__csv-table %} | Loads CSV file and compares objects against cells in a table
{% url 'Evaluate performance metrics' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/testing-dom__performance-metrics %} | Utilize Cypress to monitor a website
{% url 'Root style' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/testing-dom__root-style %} | Trigger input color change that modifies CSS variable
{% url 'Select widgets' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/testing-dom__select2 %} | Working with `<select>` elements and [Select2](https://select2.org/) widgets

## Logging In

## Logging In
Recipe | Description
--- | ---
{% url 'Single Sign On' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/logging-in__single-sign-on %} | Log in across multiple servers or providers
Expand All @@ -40,17 +50,20 @@ Recipe | Description
Also see {% url 'Authentication plugins' plugins#authentication and watch {% url 'Organizing Tests, Logging In, Controlling State' https://www.youtube.com/watch?v=5XQOK0v_YRE %}

## Preprocessors

Recipe | Description
--- | ---
{% url 'grep' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/preprocessors__grep %} | Filter tests by name using Mocha-like `grep` syntax
{% url 'Grep tests' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/preprocessors__grep %} | Filter tests by name using Mocha-like `grep` syntax
{% url 'TypeScript with Browserify' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/preprocessors__typescript-browserify %} | Add TypeScript support with Browserify
{% url 'TypeScript with webpack' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/preprocessors__typescript-webpack %} | Add TypeScript support with webpack
{% url 'Flow with Browserify' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/preprocessors__flow-browserify %} | Add flow support with Browserify

## Blogs

Demo recipes from the blog posts at {% url 'Cypress blog' https://www.cypress.io/blog %}.

Recipe | Description
--- | ---
--- | ---
{% url 'Application Actions' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/blogs__application-actions %} | Application actions are a replacement for Page Objects
{% url 'Direct Control of AngularJS' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/blogs__direct-control-angular %} | Bypass the DOM and control AngularJS
{% url 'E2E API Testing' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/blogs__e2e-api-testing %} | Run your API Tests with a GUI
Expand All @@ -61,30 +74,54 @@ Recipe | Description
{% url 'Vue + Vuex + REST Testing' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/blogs__vue-vuex-rest %} | Test an application that uses central Vuex data store
{% url 'A11y Testing' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/blogs__a11y %} | Accessibility testing with {% url 'cypress-axe' https://github.com/avanslaars/cypress-axe %}
{% url 'Automate Angular Testing' https://www.cypress.io/blog/2019/08/02/guest-post-angular-adding-cypress-ui-tests-to-your-devops-pipeline %} | Automate Angular Testing
{% url 'React DevTools' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/blogs__use-react-devtools %} | Loads React DevTools Chrome extension automatically
{% url 'Expect N assertions' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/blogs__assertion-counting %} | How to expect a certain number of assertions in a test
{% url 'Browser notifications' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/blogs__notification %} | How to test application that uses {% url '`Notification`' https://developer.mozilla.org/en-US/docs/Web/API/notification %}
{% url 'Testing iframes' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/blogs__iframes %} | Accessing elements in 3rd party iframe, spy and stub network calls from iframe

## Stubbing and spying
Recipe | Description
--- | ---
--- | ---
{% url 'Stubbing Functions' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/stubbing-spying__functions %} | Use `cy.stub()` to test function calls
{% url 'Stubbing `window.fetch`' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/stubbing-spying__window-fetch %} | Use `cy.stub()` to control fetch requests
{% url 'Stub methods called on `window`' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/stubbing-spying__window %} | Use `cy.stub()` for methods called on `window`
{% url 'Stubbing Google Analytics' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/stubbing-spying__google-analytics %} | Use `cy.stub()` to test Google Analytics calls
{% url 'Stub methods called on `console`' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/stubbing-spying__console %} | Use `cy.stub()` to test and control methods called on `console`
{% url 'Stub resource loading' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/stubbing__resources %} | Use `MutationObserver` to stub resource loading like `img` tags

## Unit Testing
Recipe | Description
--- | ---
--- | ---
{% url 'Application Code' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/unit-testing__application-code %} | Import and test your own application code
{% url 'React' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/unit-testing__react %} | Test your react components in isolation
{% url 'File Upload in React' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/file-upload-react %} | Test file upload in React application

## Server Communication
Recipe | Description
--- | ---
--- | ---
{% url 'Bootstrapping your App' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/server-communication__bootstrapping-your-app %} | Seed your application with test data
{% url 'Seeding your Database in Node' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/server-communication__seeding-database-in-node %} | Seed your database with test data
{% url 'XHR assertions' https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/server-communication__xhr-assertions %} | Spy and assert on application's network calls

## Other Cypress Recipes
Recipe | Description
--- | ---
{% url 'Visual Testing' visual-testing %} | Official Cypress guide to visual testing
{% url 'Code Coverage' code-coverage %} | Official Cypress guide to code coverage
{% url 'Detect Page Reload' https://glebbahmutov.com/blog/detect-page-reload/ %} | How to detect from Cypress test when a page reloads using object property assertions
{% url 'Run in Docker' https://www.cypress.io/blog/2019/05/02/run-cypress-with-a-single-docker-command/ %} | Run Cypress with a single Docker command
{% url 'SSR E2E' https://glebbahmutov.com/blog/ssr-e2e/ %} | End-to-end Testing for Server-Side Rendered Pages
{% url 'Using TS aliases' https://glebbahmutov.com/blog/using-ts-aliases-in-cypress-tests/ %} | Using TypeScript aliases in Cypress tests
{% url 'Stub Navigator API' https://glebbahmutov.com/blog/stub-navigator-api/ %} | Stub navigator API in end-to-end tests
{% url 'Readable Cypress.io tests' https://glebbahmutov.com/blog/readable-tests/ %} | How to write readable tests using custom commands and custom Chai assertions
{% url 'Conditional Parallelization' https://glebbahmutov.com/blog/parallel-or-not/ %} | Run Cypress in parallel mode on CircleCI depending on environment variables
{% url 'Use TypeScript With Cypress' https://glebbahmutov.com/blog/use-typescript-with-cypress/ %} | Step by step tutorial on how to set up TypeScript support in Cypress using webpack bundler
{% url '`.should()` Callback' https://glebbahmutov.com/blog/cypress-should-callback/ %} | Examples of `.should(cb)` assertions
{% url 'React component testing' https://glebbahmutov.com/blog/cypress-jump/ %} | Create a React component using JSX and inject it into live application from a Cypress test
{% url 'Unit testing Vuex data store' https://dev.to/bahmutov/unit-testing-vuex-data-store-using-cypress-io-test-runner-3g4n %} | Complete walkthrough for anyone trying to unit test a data store

## Community Recipes

Recipe | Description
--- | ---
{% url 'Visual Regression Testing' https://github.com/mjhea0/cypress-visual-regression %} | Adding visual regression testing to Cypress
Expand Down

0 comments on commit ba986eb

Please sign in to comment.