test: add development runtime tests (#10473)

.circleci/config.yml

@@ -155,7 +155,13 @@ jobs:
       - e2e-test:
           test_path: e2e-tests/gatsby-image
 
-  e2e_tests_runtime:
+  e2e_tests_development_runtime:
+    <<: *e2e-executor
+    steps:
+      - e2e-test:
+          test_path: e2e-tests/development-runtime
+
+  e2e_tests_production_runtime:
     <<: *e2e-executor
     steps:
       - e2e-test:
@@ -200,7 +206,9 @@ workflows:
           <<: *e2e-test-workflow
       - e2e_tests_gatsby-image:
           <<: *e2e-test-workflow
-      - e2e_tests_runtime:
+      - e2e_tests_development_runtime:
+          <<: *e2e-test-workflow
+      - e2e_tests_production_runtime:
           <<: *e2e-test-workflow
       - starters_publish:
           filters:

.eslintrc.json

@@ -24,6 +24,7 @@
     "jest": true
   },
   "globals": {
+    "before": true,
     "spyOn": true,
     "__PATH_PREFIX__": true
   },

e2e-tests/development-runtime/.gitignore

@@ -0,0 +1,76 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variables file
+.env
+
+# gatsby files
+.cache/
+public
+
+# Mac files
+.DS_Store
+
+# Yarn
+yarn-error.log
+.pnp/
+.pnp.js
+# Yarn Integrity file
+.yarn-integrity
+
+# misc files
+cypress/screenshots
+cypress/fixtures
+cypress/videos
+
+__history__.json

e2e-tests/development-runtime/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 gatsbyjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

e2e-tests/development-runtime/README.md

@@ -0,0 +1,97 @@
+<p align="center">
+  <a href="https://www.gatsbyjs.org">
+    <img alt="Gatsby" src="https://www.gatsbyjs.org/monogram.svg" width="60" />
+  </a>
+</p>
+<h1 align="center">
+  Gatsby's default starter
+</h1>
+
+Kick off your project with this default boilerplate ([live demo](https://gatsby-starter-default-demo.netlify.com/)). This barebones starter ships with the main Gatsby configuration files you might need.
+
+_Have another more specific idea? You may want to check out our vibrant collection of [official and community-created starters](https://www.gatsbyjs.org/docs/gatsby-starters/)._
+
+## 🚀 Quick start
+
+1.  **Create a Gatsby site.**
+
+    Use the Gatsby CLI to create a new site, specifying the default starter.
+
+    ```sh
+    # create a new Gatsby site using the default starter
+    npx gatsby new my-default-starter
+    ```
+
+1.  **Start developing.**
+
+    Navigate into your new site’s directory and start it up.
+
+    ```sh
+    cd my-default-starter/
+    gatsby develop
+    ```
+
+1.  **Open the source code and start editing!**
+
+    Your site is now running at `http://localhost:8000`!
+
+    \_Note: You'll also see a second link: `http://localhost:8000/___graphql`. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby tutorial](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql).\_
+
+    Open the `my-default-starter` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time!
+
+## 🧐 What's inside?
+
+A quick look at the top-level files and directories you'll see in a Gatsby project.
+
+    .
+    ├── node_modules
+    ├── src
+    ├── .gitignore
+    ├── .prettierrc
+    ├── gatsby-browser.js
+    ├── gatsby-config.js
+    ├── gatsby-node.js
+    ├── gatsby-ssr.js
+    ├── LICENSE
+    ├── package-lock.json
+    ├── package.json
+    ├── README.md
+    └── yarn.lock
+
+1.  **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
+
+2.  **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for “source code”.
+
+3.  **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
+
+4.  **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent.
+
+5.  **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.
+
+6.  **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail).
+
+7.  **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
+
+8.  **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.
+
+9.  **`LICENSE`**: Gatsby is licensed under the MIT license.
+
+10. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).**
+
+11. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.
+
+12. **`README.md`**: A text file containing useful reference information about your project.
+
+13. **`yarn.lock`**: [Yarn](https://yarnpkg.com/) is a package manager alternative to npm. You can use either yarn or npm, though all of the Gatsby docs reference npm. This file serves essentially the same purpose as `package-lock.json`, just for a different package management system.
+
+## 🎓 Learning Gatsby
+
+Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
+
+- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
+
+- **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
+
+## 💫 Deploy
+
+[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-default)

e2e-tests/development-runtime/content/2018-12-14-hello-world.md

@@ -0,0 +1,8 @@
+---
+title: Hello World
+date: 2018-12-14
+---
+
+This is a truly meaningful blog post
+
+<h2 data-testid="sub-title">%SUB_TITLE%</h2>

e2e-tests/development-runtime/cypress.json

@@ -0,0 +1,4 @@
+{
+  "baseUrl": "http://localhost:8000",
+  "failOnStatusCode": false
+}

e2e-tests/development-runtime/cypress/integration/functionality/data-update.js

@@ -0,0 +1,31 @@
+const FILE_CONTENT = `
+---
+title: A new post
+date: ${new Date().toJSON()}
+---
+
+A brand new post
+
+`.trim()
+
+describe(`on new file`, () => {
+  beforeEach(() => {
+    cy.visit(`/`).waitForAPI(`onRouteUpdate`)
+  })
+
+  /*
+   * TODO: This seems to cause a page re-load
+   */
+  it.skip(`re-runs GraphQL queries with new file contents`, () => {
+    cy.exec(
+      `npm run update -- --file content/sample.md --file-content '${JSON.stringify(
+        FILE_CONTENT
+      )}'`
+    )
+
+    cy.get(`ul`)
+      .find(`li`)
+      .its(`length`)
+      .should(`be.gt`, 1)
+  })
+})

e2e-tests/development-runtime/cypress/integration/functionality/hooks.js

@@ -0,0 +1,27 @@
+const COUNT_ID = `count`
+
+describe(`hooks`, () => {
+  beforeEach(() => {
+    cy.visit(`/hooks`).waitForAPI(`onRouteUpdate`)
+  })
+
+  it(`displays initial state`, () => {
+    cy.getTestElement(COUNT_ID)
+      .invoke(`text`)
+      .should(`eq`, `0`)
+  })
+
+  it(`can update local state`, () => {
+    cy.getTestElement(`increment`).click()
+
+    cy.getTestElement(COUNT_ID)
+      .invoke(`text`)
+      .should(`eq`, `1`)
+
+    cy.getTestElement(`decrement`).click()
+
+    cy.getTestElement(COUNT_ID)
+      .invoke(`text`)
+      .should(`eq`, `0`)
+  })
+})

e2e-tests/development-runtime/cypress/integration/functionality/page-arrow-functions.js

@@ -0,0 +1,21 @@
+describe(`anonymous arrow function pages`, () => {
+  beforeEach(() => {
+    cy.visit(`/anonymous-arrow`).waitForAPI(`onRouteUpdate`)
+  })
+
+  it(`displays arrow function component correctly`, () => {
+    cy.getTestElement(`title`)
+      .invoke(`text`)
+      .should(`contain`, `Anonymous Arrow Function`)
+  })
+
+  it(`updates page on navigation`, () => {
+    cy.getTestElement(`link`)
+      .click()
+      .waitForAPI(`onRouteUpdate`)
+
+    cy.getTestElement(`title`)
+      .invoke(`text`)
+      .should(`contain`, `Two`)
+  })
+})

e2e-tests/development-runtime/cypress/integration/functionality/route-update.js

@@ -0,0 +1,17 @@
+describe(`hooks`, () => {
+  beforeEach(() => {
+    cy.visit(`/`).waitForAPI(`onRouteUpdate`)
+  })
+
+  it(`registers one route update on initial route`, () => {
+    cy.lifecycleCallCount(`onRouteUpdate`).should(`eq`, 1)
+  })
+
+  it(`registers new route update on page navigation`, () => {
+    cy.getTestElement(`page-two`)
+      .click()
+      .waitForAPI(`onRouteUpdate`)
+
+    cy.lifecycleCallCount(`onRouteUpdate`).should(`eq`, 2)
+  })
+})

e2e-tests/development-runtime/cypress/integration/hot-reloading/arrow-functions.js

@@ -0,0 +1,30 @@
+const IDS = {
+  title: `title`,
+  subTitle: `sub-title`,
+}
+
+describe(`hot-reloading anonymous arrow functions`, () => {
+  beforeEach(() => {
+    cy.visit(`/arrows`).waitForAPI(`onRouteUpdate`)
+  })
+  it(`displays placeholders on launch`, () => {
+    cy.getTestElement(IDS.title)
+      .invoke(`text`)
+      .should(`contain`, `%TITLE%`)
+
+    cy.getTestElement(IDS.subTitle)
+      .invoke(`text`)
+      .should(`contain`, `%SUB_TITLE%`)
+  })
+
+  it(`upates on change`, () => {
+    const text = `The title`
+    cy.exec(
+      `npm run update -- --file src/components/title.js --replacements "TITLE:${text}"`
+    )
+
+    cy.getTestElement(IDS.title)
+      .invoke(`text`)
+      .should(`eq`, text)
+  })
+})