Back to Repositories

Testing GitIgnore Resource Implementation in GatsbyJS

This test suite validates the GitIgnore resource functionality in Gatsby Recipes, focusing on proper handling of .gitignore file entries. The tests ensure correct creation and management of ignore patterns while preventing duplicate entries.

Test Coverage Overview

The test suite provides comprehensive coverage of GitIgnore resource operations.

End-to-end testing of basic GitIgnore operations
Duplicate entry prevention validation
Resource creation and management verification
Integration with fixture-based test environment

Implementation Analysis

The testing approach utilizes Jest’s describe/test structure with async/await patterns for resource operations. The implementation leverages a resourceTestHelper utility for standardized testing of resource behaviors, ensuring consistent validation across different GitIgnore operations.

Async test execution for resource operations
Snapshot testing for output validation
Modular test helper implementation

Technical Details

Jest testing framework
Custom resourceTestHelper utility
Path module for file system operations
Fixture-based test data
Snapshot testing for output verification
Async/await pattern implementation

Best Practices Demonstrated

The test suite exemplifies strong testing practices through modular test organization and comprehensive validation approaches.

Isolated test cases with clear scope
Reusable test helper utilities
Proper async operation handling
Effective use of Jest matchers and snapshots
Clear test case documentation

gatsbyjs/gatsby

deprecated-packages/gatsby-recipes/src/providers/git/ignore.test.js

            
const path = require(`path`)
const ignore = require(`./ignore`)
const resourceTestHelper = require(`../resource-test-helper`)

const root = path.join(__dirname, `fixtures`)

describe(`git ignore resource`, () => {
  test(`e2e test`, async () => {
    await resourceTestHelper({
      resourceModule: ignore,
      resourceName: `GitIgnore`,
      context: { root },
      initialObject: { name: `.cache` },
      partialUpdate: { id: `.cache`, name: `.cache` },
    })
  })

  test(`does not add duplicate entries`, async () => {
    const name = `node_modules`

    await ignore.create({ root }, { name })

    const result = await ignore.all({ root })

    expect(result).toMatchInlineSnapshot(`
      Array [
        Object {
          "id": "node_modules",
          "name": "node_modules",
        },
      ]
    `)
  })
})