keystonejs/keystone-classic

Admin interface unit testing

Open

#3,108 opened on Jul 1, 2016

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (2,288 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (14,656 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We need to unit test all of our components, actions, reducers, etc. in the admin interface so we can safely go in and refactor them.

To test a component take a look at one of the existing tests (like the <Brand /> one), copy the basic structure and test every way the code of a component could go!

Status report (possibly not all components listed, bold ones are hard):

  • Signin/
    • Signin
    • components/
      • Alert
      • Brand
      • LoginForm
      • UserInfo
  • App/
    • store.js
    • App
    • shared/
      • AlertMessages
      • ConfirmationDialog
      • CreateForm
      • FlashMessage
      • FlashMessages
      • InvalidFieldType
      • Portal
      • Popout/
        • Popout
        • PopoutBody
        • PopoutFooter
        • PopoutHeader
        • PopoutList
        • PopoutListHeading
        • PopoutListItem
        • PopoutPane
    • components/
      • Footer
      • Navigation/
        • Mobile/
          • MobileNavigation (window.innerWidth?)
          • MobileListItem
          • MobileSectionItem
        • Primary
          • PrimaryNavigation (window.innerWidth?)
          • PrimaryNavItem
        • Secondary
          • SecondaryNavigation (window.innerWidth?)
          • SecondaryNavItem
    • screens/
      • Home/
        • components/
          • ListTile
        • actions.js
        • reducer.js
        • Home
      • Item/
        • components/
          • Toolbar/
            • Toolbar
            • ToolbarSection
          • AltText
          • EditForm (FieldTypes?)
          • EditFormHeader
          • FooterBar
          • FormHeading
          • RelatedItemList
        • actions.js
        • reducer.js
        • Item
      • List/
        • actions/
          • active
          • dragdrop
          • actions
          • item
        • components/
          • Filtering/
          • ItemsTable/
          • ListColumnsForm
          • ListControl
          • ListDownloadForm
          • ListSort
          • UpdateForm
        • reducers/
          • active
          • main #(Keystone.lists?)
        • List

Contributor guide

Research direction
Pick an untested component from the list (e.g., MobileNavigation, PrimaryNavigation, Home, Item, etc.) and write unit tests following the structure of existing tests like Brand.test.jsx. Ensure all states and user interactions are covered.
Tech stack
javascriptreact
Domain
frontend
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ReactJest
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70