zap-extensions icon indicating copy to clipboard operation
zap-extensions copied to clipboard

automation: add a flag to enable/disable jobs

Open dossantospat opened this issue 1 year ago • 7 comments

Jobs with the enabled: false flag in the automation plan are not run. The flag can be toggled in the UI, either directly in the Automation Panel or through each job's individual dialog.

Overview

Briefly describe the purpose, goals, and changes or improvements made in this pull request.

Related Issues

Fix zaproxy/zaproxy#8626.

Checklist

  • [ ] Update help
  • [ ] Update changelog
  • [ ] Run ./gradlew spotlessApply for code formatting
  • [ ] Write tests
  • [ ] Check code coverage
  • [ ] Sign-off commits
  • [ ] Squash commits
  • [ ] Use a descriptive title

For more details, please refer to the developer rules and guidelines.

dossantospat avatar Oct 16 '24 12:10 dossantospat


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


Posted by the CLA Assistant Lite bot.

github-actions[bot] avatar Oct 16 '24 12:10 github-actions[bot]

through each job's individual dialog.

I don't think we should do that.

thc202 avatar Oct 16 '24 12:10 thc202

This PR is linked to the issue on the zapproxy repository : https://github.com/zaproxy/zaproxy/issues/8626

dossantospat avatar Oct 16 '24 12:10 dossantospat

through each job's individual dialog.

I don't think we should do that.

Your call, i can remove the checkbox in the jobs' dialogs. But it feels weird to me to edit part of the job in the dialog, and other parts in the panel's list. I feel like I would want to be able to edit everything in the job's dialog if I have it opened.

dossantospat avatar Oct 16 '24 13:10 dossantospat

I'm in 2 minds about the Enabled checkbox in the dialogs - I dont think we really need it, but I also think its a bit strange not being able to change everything via the dialog. If theres a consensus to keep it then the default sizes of many of the dialogs should be changed so that they display all of the fields correctly. I think the Enabled checkboxes in the list work really well and are definitely very useful .. but I'd like them in the second column from the left 😁 The min/max yaml files should be changed as well as the help, which will then cause more of the existing tests to fail. But all in all a very useful change - thank you!

psiinon avatar Oct 16 '24 15:10 psiinon

Hello,

What's the next step ? Do you want me to amend something ?

dossantospat avatar Oct 22 '24 07:10 dossantospat

@dossantospat thanks for the nudge 😁 We've had a chat and decided that we'd prefer not to include the enable/disable checkbox in the dialogs for now. Its worth noting that the dialogs do not allow you to change everything, for example you cannot change the job ordering, or add / remove job tests using them either. It would probably be a good idea for us to have a base class for all of the AF job dialogs - in theory that could have an enable/disable checkbox built in, for example on the left hand side of the buttons. But that's a bigger change, and I'd really like to get this PR merged sooner as it's very useful as is, without the dialog changes. So could you remove the dialog checkboxes and address the other comments? Many thanks!

psiinon avatar Oct 22 '24 10:10 psiinon

@dossantospat hopefully you didnt mean to close this?

psiinon avatar Oct 23 '24 09:10 psiinon