Escape dollar sign for saving content into crontab

[Erfans]

The crontab contents can contain dollar sign (e.g. $(date)).
The current code does not escape it which transform it to actual values.
In this commit a replacement to escape dollar sign is added to the previous replacements.

an example in crontab could be
mysqldump db > db-$(date +%F).sql

Description (*)

Class lib/internal/Magento/Framework/Crontab/CrontabManager.php function save already replace couple of special characters '%' and '"'. I added a new entry into the replacement to escape dollar sign as well. i.e. convert $ to \$.

Manual testing scenarios (*)

1. Add a new entry to crontab with dollar sign, e.g: mysqldump -uroot DB >/home/backups/$(date +%F)_db.sql
2. Run the cron install command in the magento root directory: bin\magento cron:install
3. check the content of the crontab. The $(date +%F) is transformed to actual date string. bin\magento cron:remove has the same effect as well.

This pull request should fix the conversion, i.e. after bin\magento cron:install the content of the other parts with dollar sign should stay intact.

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds are green)

[m2-assistant]

Hi @Erfans. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.4-develop instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Guide documentation.

[ihor-sviziev]

Hi @Erfans,
Unfortunately steps to reproduce isn't clear how to test it. Could you explain 1st step more detailed?

In general your changes looks good.
Could you cover your changes with unit or integration test, so we'll not brake this functionality in future?

[Erfans]

Hi @ihor-sviziev

for reproducing step 1:

1. Login to the machine that M2 is installed on it.
2. Manually modify the crontab (with the user of web server)
   e.g.
   crontab -e -uwww-data
3. insert a new line with a content that contains dollar sign ($)
   e.g.
   0 0 * * * mysqldump db > db-$(date +%F).sql
4. save the crontab
5. install the magento cron job bin\magento cron:install
6. check the crontab
   crontab -l -uwww-data

the $(date +%F) will be transformed to actual date string

for unit test perhaps I can add it in the next week.

[ihor-sviziev]

@Erfans ok, so we’ll wait for test coverage

[engcom-Echo]

I will take care of test coverage.

[magento-engcom-team]

Hi @ihor-sviziev, thank you for the review.
ENGCOM-6753 has been created to process this Pull Request

[magento-engcom-team]

@Erfans thank you for contributing. Please accept Community Contributors team invitation here to gain extended permissions for this repository.

[engcom-Alfa]

✔️ QA Passed

[m2-assistant]

Hi @Erfans, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.