As a developer, I want a wiki for Test-Driven Development / TestCafe / Testing Repo (Share with the whole team)

[nevantan]

@mmafe commented on Mon Jun 05 2017

Detailed documentation on development and usage of the test suite.

The test suite is comprised of three components: internal utilities, writing tests, and using the suite. This task covers the first two components; the third will be documented as a separate task.

• [ ] Extending the test suite
• [ ] Feature files
• [ ] Ava tests
• [ ] Reorganize existing content
• [ ] Notes on Testcafe API
• [ ] Scenario prefix keywords
• [ ] include workflow for developers getting started
• [ ] Add a Troubleshooting page with common errors
  • Error: Cannot find module '<insert module name here>': Re-run npm install and npm install --only=dev prior to running tests. You will need to do this when new modules have been installed which are not tracked by version control.
• [ ] Must enable UG Testing API feature on Drupal site
• [ ] Release workflow, two branches to match hjckrrh releases
• [ ] Instructions + naming consistency for running tests using different roles (e.g. author, editor, sitemanager, etc.)

[nevantan]

Wiki Outline: Running Tests

• Installation
  • Installing Node
  • The Testing Repo
    • Description of branches
  • Installing Modules
    • npm install and npm install --only=dev
    • Why?
    • Investigate using commands (e.g. Ben's issue)
  • Testcafe global install: npm install -g testcafe, may need sudo
    • Why?
• Environment File
  • Rename file from environment.js to .env
  • implement node env to auto-load the .env file
  • update .gitignore with new file name
• Running a Test
  • testcafe command details
  • test file locations
• Setting up a test site
  • Must be a fresh clone of hjckrrh
  • Must be installed through either the web UI or drush
  • Must have ug_testing_api uninstalled
• Test Running Troubleshooting
  • Large wall of red HTML content
    • The markup is our theme's 404 page
    • FIX: Install/enable ug_testing_api feature on test site
  • [404 invalid node type]
    • Check Actions.CreateNode args and ensure it matches new method signature
    • Check spelling of node name, case-sensitive
      • Must match machine name of content type
    • Ensure the content type exists, book nodes are a good example of needing the book module enabled else this error will be thrown

[nevantan]

[WIP] Wiki Outline: Extending the Test Suite

• Introduction
  • Why/When would you use this section
  • Project directory overview
• Ava
  • When/why to use
  • How to use
  • API reference
• Local Modules
  • Why local modules
  • Creating/Modifying modules
  • Detail individual modules
    • UG Utils
    • UG Actions
      • Drupal Services
    • UG Pages
      • Most common modifications
• Adding npm Modules

[nevantan]

Wiki Outline: Writing Tests

• Introduction
  • What is TestCafe?
  • When to write a test
  • Process overview
    • Feature Files
    • Writing Tests
• Feature Files
  • Why use feature files
  • Gherkin overview/link
• Writing Tests
  • Test structure
    • Converter
      • What it does
      • Usage
    • Before/after (all) hooks
    • Main body of the test
  • DRY code: UG Action vs local async function
  • Adding selectors to page files
  • Troubleshooting
    • Visibility checks, animations, and waits
  • Javascript Mechanics
    • When to use 'await' keyword
    • Importing modules, const vs. import keywords
    • Arrow functions

[mmafe]

@nevantan How about a section on tapping into the Drupal Services API? (Note: if you already have this covered, never mind. :))

[mmafe]

Update: We are going to:

• Add a Table of Contents
• Remove the scary Warning text
• Quick-start Read Me