keystonejs/keystone-classic

Admin interface unit testing

Open

#3108 opened on Jul 1, 2016

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

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

Tech stack
javascriptreact
Domain
frontendtesting
Issue type
test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
React basicsJest testing frameworkKeystone admin overview
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Look at the existing test example in the issue (Brand.test.jsx) to understand the testing setup and structure. Focus on a non bolded component such as AlertMessages or Footer to start. Ensure that tests cover all states and interactions. If stuck, ask for clarification on bolded items like Navigation components that use window.innerWidth.