feat(gatsby-source-wordpress): Add missing tests (#29406)

Co-authored-by: gatsbybot <[email protected]>

Author: TylerBarnes

.circleci/config.yml

@@ -221,6 +221,12 @@ jobs:
       image: "14"
     <<: *test_template
 
+  integration_tests_gatsby_source_wordpress:
+    executor: node
+    steps:
+      - e2e-test:
+          test_path: integration-tests/gatsby-source-wordpress
+
   integration_tests_long_term_caching:
     executor: node
     steps:
@@ -579,6 +585,8 @@ workflows:
             - lint
             - typecheck
             - bootstrap
+      - integration_tests_gatsby_source_wordpress:
+          <<: *e2e-test-workflow
       - integration_tests_long_term_caching:
           <<: *e2e-test-workflow
       - integration_tests_cache_resilience:

integration-tests/gatsby-source-wordpress/.env.test

@@ -0,0 +1 @@
+WPGRAPHQL_URL="https://gatsbyinttests.wpengine.com/graphql"

integration-tests/gatsby-source-wordpress/.gitignore

@@ -0,0 +1 @@
+WordPress

integration-tests/gatsby-source-wordpress/.wordpress-cache/wp-content/uploads/2020/03/84-1000x1000-1.jpg

@@ -0,0 +1,64 @@
+require(`dotenv`).config({
+  path: `.env.test`,
+})
+
+const on = require(`wait-on`)
+const {
+  spawnGatsbyProcess,
+  gatsbyCleanBeforeAll,
+} = require(`../test-fns/test-utils/get-gatsby-process`)
+
+jest.setTimeout(100000)
+
+// we run these tests twice in a row
+// to make sure everything passes on a warm cache build
+// we don't need to re-run some tests the second time,
+// so the following allows us to do that:
+const isWarmCache = process.env.WARM_CACHE
+const testOnColdCacheOnly = isWarmCache ? test.skip : test
+
+describe(`[gatsby-source-wordpress] Build default options`, () => {
+  beforeAll(done => {
+    if (isWarmCache) {
+      done()
+    } else {
+      gatsbyCleanBeforeAll(done)
+    }
+  })
+
+  testOnColdCacheOnly(`Default options build succeeded`, async () => {
+    const gatsbyProcess = spawnGatsbyProcess(`build`, {
+      DEFAULT_PLUGIN_OPTIONS: `1`,
+    })
+
+    const exitCode = await new Promise(resolve =>
+      gatsbyProcess.on(`exit`, resolve)
+    )
+
+    expect(exitCode).toEqual(0)
+
+    gatsbyProcess.kill()
+  })
+})
+
+describe(`[gatsby-source-wordpress] Run tests on develop build`, () => {
+  let gatsbyDevelopProcess
+
+  beforeAll(async done => {
+    if (!isWarmCache) {
+      await gatsbyCleanBeforeAll()
+    }
+
+    gatsbyDevelopProcess = spawnGatsbyProcess(`develop`)
+
+    await on({ resources: [`http://localhost:8000`] })
+    done()
+  })
+
+  require(`../test-fns/index`)
+
+  afterAll(done => {
+    gatsbyDevelopProcess.kill()
+    done()
+  })
+})

integration-tests/gatsby-source-wordpress/.wordpress-cache/wp-content/uploads/2020/08/1001-5616x3744-1-scaled.jpg

@@ -0,0 +1,95 @@
+require(`dotenv`).config({
+  path: `.env.test`,
+})
+
+console.log(`Sourcing data from ` + process.env.WPGRAPHQL_URL)
+
+const requestConcurrency = 1
+
+const mediaItemTypeSettings = {
+  localFile: {
+    requestConcurrency,
+    maxFileSizeBytes: 10485760,
+  },
+}
+
+// this is it's own conditional object so we can run
+// an int test with all default plugin options
+const wpPluginOptions = !process.env.DEFAULT_PLUGIN_OPTIONS
+  ? {
+      excludeFieldNames: [`commentCount`],
+      debug: {
+        graphql: {
+          writeQueriesToDisk: true,
+        },
+      },
+      type: {
+        MediaItem: mediaItemTypeSettings,
+        TypeLimitTest: {
+          limit: 1,
+        },
+        TypeLimit0Test: {
+          limit: 0,
+        },
+        Comment: {
+          excludeFieldNames: [`databaseId`],
+        },
+        Page: {
+          excludeFieldNames: [`enclosure`],
+        },
+        DatabaseIdentifier: {
+          exclude: true,
+        },
+        User: {
+          excludeFieldNames: [
+            `extraCapabilities`,
+            `capKey`,
+            `email`,
+            `registeredDate`,
+          ],
+        },
+        Post: {
+          limit:
+            process.env.NODE_ENV === `development`
+              ? // Lets just pull 50 posts in development to make it easy on ourselves.
+                50
+              : // and we don't actually need more than 1000 in production
+                1000,
+        },
+      },
+    }
+  : {
+      type: {
+        MediaItem: mediaItemTypeSettings,
+      },
+    }
+
+module.exports = {
+  plugins: [
+    `gatsby-plugin-sharp`,
+    `gatsby-transformer-sharp`,
+    {
+      resolve: `gatsby-source-filesystem`,
+      options: {
+        name: `images`,
+        path: `${__dirname}/src/assets/images`,
+      },
+    },
+    {
+      resolve: `gatsby-source-wordpress`,
+      options: {
+        url: process.env.WPGRAPHQL_URL,
+        schema: {
+          requestConcurrency: 10,
+        },
+        production: {
+          hardCacheMediaFiles: true,
+        },
+        develop: {
+          hardCacheMediaFiles: true,
+        },
+        ...wpPluginOptions,
+      },
+    },
+  ],
+}

integration-tests/gatsby-source-wordpress/.wordpress-cache/wp-content/uploads/2020/08/1002-4312x2868-1-scaled.jpg

@@ -0,0 +1,3 @@
+module.exports = {
+  testPathIgnorePatterns: [`/node_modules/`, `__tests__/fixtures`, `.cache`],
+}

integration-tests/gatsby-source-wordpress/.wordpress-cache/wp-content/uploads/2020/08/1003-1181x1772-1.jpg

@@ -0,0 +1,25 @@
+{
+  "name": "gatsby-source-wordpress-integration-tests",
+  "version": "0.1.0",
+  "private": true,
+  "description": "A simple Gatsby WP site for running integrations tests",
+  "scripts": {
+    "run-jest": "jest --config=jest.config.js --runInBand",
+    "test": "npm run run-jest && WARM_CACHE=true npm run run-jest"
+  },
+  "author": "Tyler Barnes <[email protected]>",
+  "license": "MIT",
+  "dependencies": {
+    "gatsby": "next",
+    "gatsby-plugin-sharp": "next",
+    "gatsby-source-filesystem": "next",
+    "gatsby-source-wordpress": "next",
+    "gatsby-transformer-sharp": "next"
+  },
+  "devDependencies": {
+    "dotenv": "^8.2.0",
+    "jest": "^26.6.3",
+    "rimraf": "^3.0.2",
+    "wait-on": "^5.2.1"
+  }
+}

integration-tests/gatsby-source-wordpress/.wordpress-cache/wp-content/uploads/2020/08/file-sample_1MB.doc

@@ -0,0 +1,157 @@
+/**
+ * @jest-environment node
+ */
+
+const {
+  default: fetchGraphql,
+} = require("gatsby-source-wordpress/dist/utils/fetch-graphql")
+
+const { testResolvedData } = require("./test-utils/test-resolved-data")
+const { queries } = require("./test-utils/queries")
+
+jest.setTimeout(100000)
+
+const url = `http://localhost:8000/___graphql`
+
+describe(`data resolution`, () => {
+  it(`resolves correct number of nodes`, async () => {
+    const { data } = await fetchGraphql({
+      url,
+      query: queries.nodeCounts,
+    })
+
+    expect(data[`allWpMediaItem`].nodes).toBeTruthy()
+    expect(data[`allWpMediaItem`].nodes).toMatchSnapshot()
+    expect(data[`allWpMediaItem`].totalCount).toBe(7)
+
+    expect(data[`allWpTag`].totalCount).toBe(5)
+    expect(data[`allWpUser`].totalCount).toBe(1)
+    expect(data[`allWpPage`].totalCount).toBe(1)
+    expect(data[`allWpPost`].totalCount).toBe(1)
+    expect(data[`allWpComment`].totalCount).toBe(1)
+    // expect(data[`allWpProject`].totalCount).toBe(1)
+    expect(data[`allWpTaxonomy`].totalCount).toBe(3)
+    expect(data[`allWpCategory`].totalCount).toBe(9)
+    expect(data[`allWpMenu`].totalCount).toBe(1)
+    expect(data[`allWpMenuItem`].totalCount).toBe(4)
+    // expect(data[`allWpTeamMember`].totalCount).toBe(1)
+    expect(data[`allWpPostFormat`].totalCount).toBe(0)
+    expect(data[`allWpContentType`].totalCount).toBe(6)
+  })
+
+  testResolvedData({
+    url,
+    title: `resolves wp-graphql-acf data`,
+    gatsbyQuery: queries.acfData,
+    queryReplace: {
+      from: `wpPage(title: { eq: "ACF Field Test" }) {`,
+      to: `page(id: "cG9zdDo3NjQ2") {`,
+    },
+    fields: {
+      gatsby: `wpPage`,
+      wpgql: `page`,
+    },
+  })
+
+  it(`resolves hierarchichal categories`, async () => {
+    const gatsbyResult = await fetchGraphql({
+      url,
+      query: /* GraphQL */ `
+        fragment NestedCats on WpCategory {
+          name
+          wpChildren {
+            nodes {
+              name
+              wpChildren {
+                nodes {
+                  name
+                  wpChildren {
+                    nodes {
+                      name
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+
+        {
+          allWpCategory {
+            nodes {
+              name
+            }
+          }
+          wpPost(id: { eq: "cG9zdDo5MzYx" }) {
+            id
+            title
+            categories {
+              nodes {
+                ...NestedCats
+              }
+            }
+          }
+        }
+      `,
+    })
+
+    const categoryNodes = gatsbyResult.data.allWpCategory.nodes
+    const categoryNames = categoryNodes.map(({ name }) => name)
+
+    expect(categoryNames.includes(`h1`)).toBeTruthy()
+    expect(categoryNames.includes(`h2`)).toBeTruthy()
+    expect(categoryNames.includes(`h3`)).toBeTruthy()
+    expect(categoryNames.includes(`h4`)).toBeTruthy()
+  })
+
+  it(`resolves menus`, async () => {
+    const result = await fetchGraphql({
+      url,
+      query: queries.menus,
+    })
+
+    expect(result).toMatchSnapshot()
+  })
+
+  it(`resolves pages`, async () => {
+    const result = await fetchGraphql({
+      url,
+      query: queries.pages,
+    })
+
+    expect(result).toMatchSnapshot()
+
+    // expect(result.data.testPage.title).toEqual(`Sample Page`)
+  })
+
+  it(`resolves posts`, async () => {
+    const result = await fetchGraphql({
+      url,
+      query: queries.posts,
+    })
+
+    expect(result).toMatchSnapshot()
+
+    expect(result.data.testPost.title).toEqual(`Hello world!`)
+  })
+
+  it(`resolves users`, async () => {
+    const result = await fetchGraphql({
+      url,
+      query: queries.users,
+    })
+
+    expect(result).toMatchSnapshot()
+
+    expect(result.data.testUser.firstName).toEqual(`Tyler`)
+  })
+
+  it(`resolves root fields`, async () => {
+    const result = await fetchGraphql({
+      url,
+      query: queries.rootFields,
+    })
+
+    expect(result).toMatchSnapshot()
+  })
+})