/spearmint

Testing, simplified. || An inclusive, accessibility-first GUI for generating clean, semantic Javascript tests in only a few clicks of a button.

Primary LanguageTypeScriptMIT LicenseMIT

🍃 ✨ Spearmint v14 ✨ 🍃

JavaScript NodeJS Express.js React HTML5 CSS3 SASS TypeScript Webpack Electron Jest MUI

Spearmint helps developers easily create functional Accessibility, Endpoint, GraphQL, Puppeteer, React, Hooks, Redux, Svelte, Vue, Security, and Solid.js tests without writing any code. It dynamically converts user inputs into executable Jest test code by using DOM query selectors provided by @testing-library.

Installation

Please download Spearmint from our website

How to use in development mode

Please refer to README-dev.md


How it works

  1. Open the folder of the repo you'd like to create tests for, then choose the framework/type of test you'd like to create.

    spearmint gif
  2. Utilize our auto-complete, drop-down options, and tooltips features to easily create arrangement, action, and assertion test statements for React, Vue, Svelte, and Solid; reducer, action creator, asynchronous action creator, and middleware test statements for Redux; and hooks, context, endpoint, and GraphQL test statements.

  3. Spearmint will then convert user input to dynamically generate a test file in the Code Editor.

    spearmint gif
  4. Follow the instructions in the recently added User Guide tab on the right to export and run your tests.

    spearmint gif
  5. Don't forget to select your test file from the left panel in order to manually edit the test in the Test Editor; otherwise the changes won't be reflected in the test file.

    spearmint gif

For developers: README-dev.md. This containes more information specific to developers such as data systems, outlines of the application, turning on dev tools, etc.

New features with version 0.14.0

  • Increased Typescript coverage – Spearmint is now majority Typescript!

  • Greatly bolstered internal testing on the program and instituted testing coverage reports for completeness visibility

  • Updated to latest version of electron

  • Updated a variety of dependencies and libraries

  • Added documentation for future developers


Iteration Roadmap

  1. Continuing TypeScript Conversion:
  • This will help with the maintainability and readability of Spearmint’s code, and move closer to 100% coverage
  1. Persistent data:
  • There is a framework for login, including GitHub and Google, however it is not implemented
  • Adding more features to make login and user data more valuable, such as favorited or saved tests, saved templates, etc.
  1. Adding more testing:
  • Deeper testing of existing frameworks should probably be the main priority here as many frameworks are implemented already, but could use more fleshed-out features
  • Adding additional frameworks is a possibility if there is a strong case for them, but adding more robustness to the current test suites is probably more important
  1. Add functionality for exporting test files as Typescript
  • Currently the only export option is vanilla Javascript
  1. Continue to extend internal testing coverage
  • A far greater amount of the application is tested now than it was previously, but there is more work to do on this
  1. Update some dependencies and tools
  • Consider removing MUI and switching to another component library or redoing styling in CSS in order to update the program to React v18+ as MUI is incompatible and seems not to be actively updating.
  • Consider implementing React Dev Tools or react-dnd to restore the drag-drop functionality
  • Monitor for other opportunities to update dependencies or otherwise improve the program with different libraries or tools.
  1. Revamp UI for certain test cases:
  • Some of test cases needs improvement on UI as they do not have any styling or optimal user experience

Known Bugs

  1. Screen reader for Accessibilty can turn on and off but does not read.
  2. Text to speech not functioning properly under Accessibility
  3. Some elements of draggable remaining in Redux test case components

The Spearmint Team

Developed By
Alan Richardson Github LinkedIn
Alex Park Github LinkedIn
Alfred Sta. Iglesia Github LinkedIn
Anjanie McCoy Github LinkedIn
Annie Shin Github LinkedIn
Ben Kwak Github LinkedIn
Brandon Tran Github LinkedIn
Carter Long Github LinkedIn
Chacta Brice Github LinkedIn
Charlie Maloney Github LinkedIn
Chen 'Chloe' Lu Github LinkedIn
Chloe Aribo Github LinkedIn
Chris Cheng Github LinkedIn
Cornelius Phanthanh Github LinkedIn
Danny Wallace Github LinkedIn
Dave Franz Github LinkedIn
David Kim Github LinkedIn
DeriAnte Sinclair Github LinkedIn
Dieu 'Dieunity' Hyunh Github LinkedIn
Dylan Hawkins Github LinkedIn
Erik Komatsu Github LinkedIn
Erik Park Github LinkedIn
Erika Collins Github LinkedIn
Evan Berghoff Github LinkedIn
Evan Decker Github LinkedIn
Gabriel Christo Github LinkedIn
Gary Balogh Github LinkedIn
Huy Bui Github LinkedIn
Jasmine Gonzalez Github LinkedIn
Joseph Nagy Github LinkedIn
Johnny Lim Github LinkedIn
Judy Song Github LinkedIn
Julie Beak Github LinkedIn
Justin Baik Github LinkedIn
Justin Dilts Github LinkedIn
Karen Pinilla Github LinkedIn
Li Cheng Github LinkedIn
Linda Wishingrad Github LinkedIn
Luis Lo Github LinkedIn
Luke Lauther Github LinkedIn
Mahmoud 'Mo' Hmaidi Github LinkedIn
Max Bromet Github LinkedIn
Max Weisenberger Github LinkedIn
Mike Coker Github LinkedIn
Mina Koo Github LinkedIn
Myles Tsutsui Github LinkedIn
Natlyn Phomsvanh Github LinkedIn
Nicolas Pita Github LinkedIn
Owen Eldridge Github LinkedIn
Rachel Yoo Github LinkedIn
Rawan Bairouti Github LinkedIn
Ruzeb Chowdhury Github LinkedIn
Sean Haverstock Github LinkedIn
Sean Yoo Github LinkedIn
Sharon Zhu Github LinkedIn
Sieun Jang Github LinkedIn
Terence Petersen Github LinkedIn
Tolan Thornton Github LinkedIn
Tristen Wastell Github LinkedIn
Troy Witonsky Github LinkedIn
Tyler Martinez Github LinkedIn
William Lee Github LinkedIn
Wilson Tran Github LinkedIn
Yeunha Kim Github LinkedIn