1117866 - Add a script to validate the iCal files for holidays

Status: RESOLVED FIXED

(www.mozilla.org :: Bedrock, defect)

Description

[Paul [:pmac] McLanahan]

We get pull-requests to update these files and have to manually validate them, so we should automate it and have it run in CI.

Comment 1

[Jennifer Bertsch [:jbertsch]]

Pmac: Is this a roadmap candidate?  What is the level of priority?

Comment 2

[Paul [:pmac] McLanahan]

I feel like it's more of a "nice to have" than a priority. Maybe it's a good mentored bug even.

Comment 3

[Srivats]

Hi, I'm willing to take this up - I don't see any iCal files on repo (except tests). 
Let me know what needs to be done to tackle this.

Comment 4

[Srivats]

Hi again, I just noticed that it's in `media/caldata/*.ics` -- so what _exactly_ needs to be validated? format, specification, dates and the like?

Comment 5

[Paul [:pmac] McLanahan]

Hi Srivats,

Basically we'd like to have an automated way to say "these files validate and won't break things". We don't process them on the site, but we do get pull-requests to update them from time to time and it's difficult to verify their correctness looking at a diff. So we'd at least like CI (like Travis or Jenkins) to tell us whether or not the formatting is right.

Thanks for taking this, and let me know how I can help.

Comment 6

[Srivats]

Created PR here:

https://github.com/mozilla/bedrock/pull/2890

Please review

Comment 7

[[github robot]]

Commit pushed to master at https://github.com/mozilla/bedrock

https://github.com/mozilla/bedrock/commit/7d13ad85ed18bb6204f0218bfa36037dbcf3423e
Add a script to fix bug 1117866

This script checks every icalendar file present in <bedrock>/media/caldata
and validates it. Currently, it would run every time a commit is done on master,
but that can be changed to just run on commits to .ics files.

There's also a failure in MexicanHolidays.ics, that I have left as-is for the author
to fix - this would be a good test to check/verify that all folks use the same file encoding.

Moved back check_calendars.py to scripts dir

Fix Mexican calendar

Ideally, this should be done by caldata maintainers. We are fixing this
now that we go live and avoid build failures preventing merge into
master.