open-source-labs / spearmint

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

🍃 ✨ Spearmint v14 ✨ 🍃

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.

   

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.

   

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

   

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.

   

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

2. 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.

3. 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

4. Add functionality for exporting test files as Typescript

• Currently the only export option is vanilla Javascript

5. 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

6. 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.

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

---

spearmint's Issues

Unable to launch the application on mac

What I have tried

1. Download spearmint 0.14.0-arm64 from the download page
2. Installation into applications
3. When tried to open spearmint, it returns the following message,
   “spearmint” is damaged and can’t be opened. You should eject the disk image.

Environment

1. OS: macos monterey
2. Processor: Apple M1 Pro

Download error

Download error on linux

Distribution Info

DISTRIB_ID=Deepin
DISTRIB_RELEASE="15.9.3"
DISTRIB_DESCRIPTION="Deepin 15.9.3 "
DISTRIB_CODENAME=unstable
PRETTY_NAME="Deepin 15"
NAME="Deepin"
VERSION_ID="15.9.3"
VERSION="15.9.3"
ID=deepin

Error

Terminal Contains Repeating Character Inputs

When switching between test frameworks using the Home button, the test terminal will input repeated characters, affecting the test running. Current workaround solution is to exit app between framework selections.

Navigation is impossible when opening a folder on Ubuntu 20.4

Clicking on "Open folder" under "Select your application" opens the dialog but navigating to a folder is disabled as only Javascript, Style or HTML files are selectable

Website doesn't have a favicon

Easy to add and makes it look better, especially when lined up next to other tabs.

This has worked for me:
https://www.favicon-generator.org

0.11.0 release ..

now, linux deb is ARM64, does it should be amd64 ???

BugFix when deleting describe statements

When deleting the only describe statement in a testcase, going to another test, and going back to the same test, the testcase crashes the application

Creating Docker image on Mac seems to have issues

Is this feature only compatible with Windows??
Cannot seem to create Docker images, currently running Mac OS Big Sur 11.1

Website does not connect

Description

Following the link from the readme leads to a dead link.

Reproduction

https://www.spearmintjs.com/

System information

chrome, windows

Additional information

No response

👨‍👧‍👦 Contributing

• 🙋‍♂️ Yes, I'd love to make a PR to fix this bug!

Axe-core trademark use

Thanks for using axe-core! Could you please ensure that you are adhering to the trademark policy? Axe-core is a trademark of Deque Systems. Here are some common tips that should help:
Ensure that the language surrounding your reference to axe-core does not imply in any way that you own it or have any formal partnership with Deque without prior written permission.
Include the following attribution notice: “Axe-core® is a trademark of Deque Systems, Inc. in the US and other countries.” Adding this to your readme is a common approach.
Axe-core® is capitalized at the beginning of a sentence. When used within a sentence, axe-core® is lowercase. Don’t stress attempting to include the ® symbol everywhere you say axe-core. If you include it in a prominent place, in addition to the attribution notice above, you should be good.
Do not mistake the broader axe® brand name for the axe-core® open source project.
Don’t stress renaming your entire project. If you adhere to the above tips, you should be covered in most cases.
Please comply with this request in 30 days time and let us know when to expect to see the changes live.

Regards,
The team at Deque

Xterm terminal resize

The xterm terminal does not fit to the parent container on load because of the hidden prop used in the tab component for the terminal which initializes the parent component with a width and height of 0, therefore fitaddon does not initialize according to the bounds and only works when switching back and forth to the terminal.

Interested but needs more docs

Hi all,

Really interested in the premise but it is difficult to know where to start.

Some additional documentation and guides would go a long ways towards helping me make a case for adopting this.

I would love to be able to delegate developing tests to our QA team, but as it stands I don't know that I could effectively train anyone to use this while I am not sure how to use it myself.

Best of luck and I will stay tuned for further development.

Can't run on Mac OS Sonoma

Description

Trying to open app but receives this error:
"You can’t open the application “spearmint” because this application is not supported on this Mac."
Mac OS: Sonoma

Reproduction

Download pkg and install onto mac. Try to open.

System information

Mac Os Sonoma

MACBOOK PRO 2019

Additional information

No response

👨‍👧‍👦 Contributing

• 🙋‍♂️ Yes, I'd love to make a PR to fix this bug!

Build from source - errors

• Is node-sass needed? Building it makes installation problematic. sass should be enough
• There is no docs about building
• Build is failing with:

0 verbose cli [ '/usr/bin/node', '/usr/bin/npm', 'run', 'build' ]
1 info using [email protected]
2 info using [email protected]
3 timing config:load:defaults Completed in 3ms
4 timing config:load:file:/usr/lib/node_modules/npm/npmrc Completed in 0ms
5 timing config:load:builtin Completed in 0ms
6 timing config:load:cli Completed in 2ms
7 timing config:load:env Completed in 1ms
8 timing config:load:file:/srv/spearmint/.npmrc Completed in 2ms
9 timing config:load:project Completed in 2ms
10 timing config:load:file:/home/tczech/.npmrc Completed in 0ms
11 timing config:load:user Completed in 0ms
12 timing config:load:file:/usr/etc/npmrc Completed in 1ms
13 timing config:load:global Completed in 1ms
14 timing config:load:cafile Completed in 0ms
15 timing config:load:validate Completed in 0ms
16 timing config:load:setUserAgent Completed in 1ms
17 timing config:load:setEnvs Completed in 1ms
18 timing config:load Completed in 11ms
19 verbose npm-session ae0c8209f7a9e7df
20 timing npm:load Completed in 19ms
21 timing command:run Completed in 418698ms
22 verbose stack Error: command failed
22 verbose stack     at ChildProcess.<anonymous> (/usr/lib/node_modules/npm/node_modules/@npmcli/promise-spawn/index.js:64:27)
22 verbose stack     at ChildProcess.emit (node:events:378:20)
22 verbose stack     at maybeClose (node:internal/child_process:1067:16)
22 verbose stack     at Process.ChildProcess._handle.onexit (node:internal/child_process:301:5)
23 verbose pkgid [email protected]
24 verbose cwd /srv/spearmint
25 verbose Linux 5.9.16-1-MANJARO
26 verbose argv "/usr/bin/node" "/usr/bin/npm" "run" "build"
27 verbose node v15.11.0
28 verbose npm  v7.6.3
29 error code 1
30 error path /srv/spearmint
31 error command failed
32 error command sh -c NODE_ENV=production npm run react-build && npm run electron-build
33 verbose exit 1