karimsa/cybuddy

Create Cypress tests visually.

CyBuddy

Create Cypress tests visually.

License

Licensed under MIT license.

Logo created by Sarah JOY from the Noun Project.

cybuddy's Issues

Support for custom actions

Right now, only the fixed actions that already exist in CyBuddy are the only ones you can use. I was dealing with this in HireFast by just adding actions I needed manually. However, it would be nice to pass an array of new actions and for CyBuddy to just support those actions.

Add readme

Add auto-saving and simpler opens

Now that we have a CLI, saving files can be done automatically into the cypress folder.

Opening files should also be made easier, similar to how the functionality of templates works.

Need a URL bar above the iframe

Should be able to change the URL from the UI

Always errors on start

On initial start, the hooks kick in and try to attempt the last step of the test. Instead, it should probably run the whole test or do nothing. Preferably nothing in the event of refreshes.

Add tests for builtin action types

One test that tries all the actions should be good enough

Stop button doesn't work

It flashes to 'run', but then the next step continues anyways.

Needs tests

I'm just testing it manually using either the example project in this repo or using a special branch of HireFast.

Test methodology:

• Spin up a page with CyBuddy
• Simulate mouse clicks on the page (this might require puppeteer since CyBuddy relies on an overlay to catch clicks)
• Save the generated test file from CyBuddy
• Pass generated file to Cypress and expect it to succeed

Figure out how to implement env resets

For HireFast, I make a POST request to the backend to trigger a env reset and let cypress reset the storage + cookies on the frontend.

Some setups might directly modify the DB or possibly run commands to perform resets.

How do we make it simple to override that behaviour? Perhaps with forcing the reset action to always be a custom action rather than builtin?

Add cybuddy CLI

We should add a CLI to run CyBuddy. Starting it should be as simple as: cybuddy https://localhost:1234.

This enables us to support different things:

• Auto-saving files
• Storing things local to cybuddy, without affecting the app's storage
• No changes to the app to start using cybuddy
• Test templating

Add create-react-app fixture

Add tests with create-react-app

Doesn't take into account scroll position

If you scroll down in your app, the clicks matching and element overlays don't work as expected.

(What CyBuddy is trying to show)

(What is actually showing)

Actions should only need an implementation, not generation

If we make it mandatory that action implementations cannot access variables outside their function scope, we can simplify action implementations so that they only need to provide an implementation instead of a generation + implementation. For example:

const resetAction = {
  type: 'reset',
  run() {
    cy.clearLocalStorage()
    cy.clearCookies()
    cy.reload()
  },
}

This can then be executed in a "VM" in the browser:

const resetVM = new Function('cy', getFunctionBody(resetAction.run))
resetVM(polyfills.cy)

The function body passed to the VM is also the generated form that can be added to the cypress file.

This might be confusing because it looks like the function pointer will be called on execution, but it actually moves into a VM that runs in a different scope. However, at least errors caused by this mistake will be visible in CyBuddy and not just cypress.

Add tests for custom actions

Click actions don't work on anchors

Only works with chrome security disabled

When used with cypress open and the Chrome browser, the web security seems to prevent things from working. For now, it's been disabled by cybuddy when you start it. There's a doc page on how Cypress deals with this issue:

https://docs.cypress.io/guides/guides/web-security.html#Set-chromeWebSecurity-to-false

We already do proxying, but probably need to look at the other strategies too.

Error checks after every step is boostrap-specific

Possible solutions:

• Add a config for the error element selector
• Replace feature with allowing cybuddy configs to wrap test step code however they want