Skip to content

Latest commit

 

History

History
174 lines (141 loc) · 5.9 KB

README.md

File metadata and controls

174 lines (141 loc) · 5.9 KB
Raw

Testing Strategy

Unit Tests

These tests are performed on components/functions at the lowest level of abstraction. They are used to test the functionality of a single component. They are also used to test the functionality of a component in isolation from other components. Unit tests are written using the Jest framework.

Tests that fall in this category are:

Components testing guide:

  • Inputs / Outputs (I/O) - assert that the component renders the correct output given a set of props
  • User Interactions - assert that the component responds to user interactions correctly
  • Event Handlers - assert that the component calls prop functions correctly (e.g. onClick, onSubmit, etc.)

Functions testing guide:

  • Inputs / Outputs (I/O) - assert that the function returns the correct output given a set of inputs
  • Edge cases - assert that the function handles edge cases correctly (e.g. null, undefined, etc.)

Integration Tests

These tests are performed on components/functions at the highest level of abstraction. They are used to test the functionality of a component in conjunction with other components. Integration tests are performed by testing Screens, which are the highest level of abstraction in the app.

Tests that fall in this category are:

Screens testing guide (WIP)

  • navigation - assert that the screen navigates to the correct screen when a user clicks on a button
  • inputs / outputs (I/O) - assert that the screen renders the correct output given a set of props (e.g. navigation/route params)
  • side effects - for example, assert that the screen calls the correct firebase function when a user clicks on a button

Reference

Error Handling

We have a special function to help us type check and DRY our error handling logic. It is called handleError and it is located in src/helpers/errors.js. It takes in an error: unknown and a message: string that describes the error. It then logs the error to the console and returns the typed error for further bubbling if needed.

Please use this function whenever you need to handle an error.

User flows

Discovery

graph TD;
subgraph DiscoveryStack
  B(DiscoveryScreen)
  B-->|taps Cog Wheel|D(HighlightsScreen);
  B-->|taps EventCard|E(UserEventScreen);

  D(HighlightsScreen)
  D-->|back|B(DiscoveryScreen);

  E(UserEventScreen)
  E-->|back|B(DiscoveryScreen);
  E-->|taps Reserve button|F(TicketPurchaseScreen);

  F(TicketPurchaseScreen)
  F-->|back|E(UserEventScreen);
  F-->|selects ticket amounts|G(Confirm button);
  G-->|taps Confirm button|H(TicketsConfirmationScreen);

  H(TicketsConfirmationScreen)
  H-->|taps 'View My Tickets' button|I(UserEventTicketsScreen);
end
Loading

Search

graph TD;
subgraph SearchScreen
  J(SearchScreen)
  J-->|taps Cog Wheel|K(SearchFilterScreen)
  K-->|slides distance filter|L(db gets updated)
  K-->|switches event categories|L(db gets updated)
  K-->|back|J(SearchScreen)
end
Loading

User Tickets

graph TD;
subgraph UserTicketsStack
  M(UserTicketsScreen)
  M-->|taps UserEventCard|N(UserEventTicketsScreen)

  N(UserEventTicketsScreen)
  N-->|back|M(UserTicketsScreen)
  N-->|sees|O(Tickets for the particular event)
end
Loading

Profile

graph TD;
subgraph ProfileScreen
  P(ProfileScreen)
  P-->|fills user details|Q(db gets updated)
  P-->R{has company}
  R-->|no|T(Add company button)
end
T-->|taps Add company button|U(CompanyDetailsScreen)
Loading

Company

graph TD;
    subgraph CompanyStack
V(CompanyDashboardScreen)
V-->|taps Cog Wheel|U(CompanyDetailsScreen)
V-->|taps Event|Y(CompanyEventDetailsView)
V-->|'Create an Event'|Z(EventEditDetailsView)


U(CompanyDetailsScreen)
U-->|fills company details|X(db gets updated)
X-->|back|V(CompanyDashboardScreen)


subgraph CompanyEventScreen
Y(CompanyEventDetailsView)
Y-->|taps Cog Wheel|Z(EventEditDetailsView)

Z(EventEditDetailsView)
Z-->|fills event details|AA{Cancel or Save and go back}
AA-->|taps Save and go back|AB(db gets updated)
end
AB-->V(CompanyDashboardScreen)
AA-->|Cancel|V(CompanyDashboardScreen)

Y-->|back|V(CompanyDashboardScreen)
Y-->|taps EventTicketsButton|AC(EventTicketTypesScreen)
Y-->|taps Redemptions button|AG(TicketTypesScreen)


AC(EventTicketTypesScreen)
AC-->|taps 'Create new ticket type'|AD(CreateEditTicketTypeScreen)
AC-->|taps TicketTypeCard|AD(CreateEditTicketTypeScreen)
AC-->|back|Y(CompanyEventDetailsView)

AD(CreateEditTicketTypeScreen)
AD-->|back|AC(EventTicketTypesScreen)
AD-->|fills ticketType details|AE(Save and go back)
AE-->|taps 'Save and go back'|AF(db gets updated)
AF-->AC(EventTicketTypesScreen)


AG(TicketTypesScreen)
AG-->|back|Y(CompanyEventDetailsView)
AG-->|taps TicketTypeCard|AH(RedemptionsScreen)

subgraph RedemptionsScreen
AH(RedemptionsScreen)
AH-->|reserved tab|AI(sees reserved TicketCards)
AI-->|taps TicketCard|AK(sees RedeemTicketDialog)
AK-->AL{Cancel or Redeem}
AL-->|Cancel|AM(Dialog dismisses)
AL-->|Redeem|AN(db gets updated)
AN-->AM(Dialog dismisses)
AH-->|redeemed tab|AJ(sees redeemed TicketCards)
end
AH-->|back|AG(TicketTypesScreen)
AH-->|+ fab|AO(RedeemTicketScreen)

AO(RedeemTicketScreen)
AO-->|back|AH(RedemptionsScreen)
AO-->|fills ticketId|AP(Confirm button)
AP-->AQ(db gets updated)
AQ-->AH(RedemptionsScreen)
end
Loading