apigeek-affirm/docs/cron.md

Executable English for Software Testing and more

Scheduling Regular Tests
------------------------

Running a "cron job" is familar to DevOps teams who want to schedule regular activities. 

Apigeek-Affirm has a built-in cron-like scheduler to provide continuous assurance.

Time Ranges
------------

A schedule is broken into units of time that can be repeated.

When specifying your schedule you need to make sure that your values fall within the ranges. 

	Column		Units			Range
	1			Seconds 		0-59
	2			Minutes 		0-59
	3			Hours 			0-23
	4			Day of Month 	1-31
	5			Months 			0-11
	6			Day of Week 	0-6


Configuration
------------
The cron capability is configured in your affirm.json config file. 

The cron config maps .feature files to their schedule (time range). 

For example, to run every 15 seconds during the week:

	{
		"cron": {
			"my-feature": "0,15,30,45 * * * * 1-5"
		}
	}

More than one schedule can be attached using the array syntax.

For example, let's extend the above example to also run every minute on weekends:

	{
		"cron": {
			"my-feature": ["0,15,30,45 * * * * 1-5", "0 * * * * 0,6"]
		}
	}