Revision control
Copy as Markdown
Other Tools
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
var { CalendarTestUtils } = ChromeUtils.importESModule(
);
ChromeUtils.defineESModuleGetters(this, {
});
function run_test() {
do_calendar_startup(really_run_test);
}
function really_run_test() {
test_aclmanager();
test_calendar();
test_immutable();
test_attendee();
test_attachment();
test_lastack();
test_categories();
test_alarm();
test_isEvent();
test_isTodo();
test_recurring_event_properties();
test_recurring_todo_properties();
test_recurring_event_exception_properties();
test_recurring_todo_exception_properties();
}
function test_aclmanager() {
const mockCalendar = {
QueryInterface: ChromeUtils.generateQI(["calICalendar"]),
get superCalendar() {
return this;
},
get aclManager() {
return this;
},
getItemEntry(item) {
if (item.id == "withentry") {
return itemEntry;
}
return null;
},
};
const itemEntry = {
QueryInterface: ChromeUtils.generateQI(["calIItemACLEntry"]),
userCanModify: true,
userCanRespond: false,
userCanViewAll: true,
userCanViewDateAndTime: false,
};
let event = new CalEvent();
event.id = "withentry";
event.calendar = mockCalendar;
equal(event.aclEntry.userCanModify, itemEntry.userCanModify);
equal(event.aclEntry.userCanRespond, itemEntry.userCanRespond);
equal(event.aclEntry.userCanViewAll, itemEntry.userCanViewAll);
equal(event.aclEntry.userCanViewDateAndTime, itemEntry.userCanViewDateAndTime);
const parentEntry = new CalEvent();
parentEntry.id = "parententry";
parentEntry.calendar = mockCalendar;
parentEntry.parentItem = event;
equal(parentEntry.aclEntry.userCanModify, itemEntry.userCanModify);
equal(parentEntry.aclEntry.userCanRespond, itemEntry.userCanRespond);
equal(parentEntry.aclEntry.userCanViewAll, itemEntry.userCanViewAll);
equal(parentEntry.aclEntry.userCanViewDateAndTime, itemEntry.userCanViewDateAndTime);
event = new CalEvent();
event.id = "noentry";
event.calendar = mockCalendar;
equal(event.aclEntry, null);
}
function test_calendar() {
const event = new CalEvent();
const parentEntry = new CalEvent();
const mockCalendar = {
QueryInterface: ChromeUtils.generateQI(["calICalendar"]),
id: "one",
};
parentEntry.calendar = mockCalendar;
event.parentItem = parentEntry;
notEqual(event.calendar, null);
equal(event.calendar.id, "one");
}
function test_attachment() {
const e = new CalEvent();
const a = new CalAttachment();
a.rawData = "horst";
const b = new CalAttachment();
b.rawData = "bruno";
e.addAttachment(a);
equal(e.getAttachments().length, 1);
e.addAttachment(b);
equal(e.getAttachments().length, 2);
e.removeAttachment(a);
equal(e.getAttachments().length, 1);
e.removeAllAttachments();
equal(e.getAttachments().length, 0);
}
function test_attendee() {
const e = new CalEvent();
equal(e.getAttendeeById("unknown"), null);
equal(e.getAttendees().length, 0);
const a = new CalAttendee();
a.id = "mailto:horst";
const b = new CalAttendee();
b.id = "mailto:bruno";
e.addAttendee(a);
equal(e.getAttendees().length, 1);
equal(e.getAttendeeById("mailto:horst"), a);
e.addAttendee(b);
equal(e.getAttendees().length, 2);
const comp = e.icalComponent;
let aprop = comp.getFirstProperty("ATTENDEE");
equal(aprop.value, "mailto:horst");
aprop = comp.getNextProperty("ATTENDEE");
equal(aprop.value, "mailto:bruno");
equal(comp.getNextProperty("ATTENDEE"), null);
e.removeAttendee(a);
equal(e.getAttendees().length, 1);
equal(e.getAttendeeById("mailto:horst"), null);
e.removeAllAttendees();
equal(e.getAttendees().length, 0);
}
function test_categories() {
const e = new CalEvent();
equal(e.getCategories().length, 0);
const cat = ["a", "b", "c"];
e.setCategories(cat);
cat[0] = "err";
equal(e.getCategories().join(","), "a,b,c");
const comp = e.icalComponent;
let getter = comp.getFirstProperty.bind(comp);
cat[0] = "a";
while (cat.length) {
equal(cat.shift(), getter("CATEGORIES").value);
getter = comp.getNextProperty.bind(comp);
}
}
function test_alarm() {
const e = new CalEvent();
const alarm = new CalAlarm();
alarm.action = "DISPLAY";
alarm.related = Ci.calIAlarm.ALARM_RELATED_ABSOLUTE;
alarm.alarmDate = cal.createDateTime();
e.addAlarm(alarm);
const ecomp = e.icalComponent;
const vcomp = ecomp.getFirstSubcomponent("VALARM");
equal(vcomp.serializeToICS(), alarm.icalString);
const alarm2 = alarm.clone();
e.addAlarm(alarm2);
equal(e.getAlarms().length, 2);
e.deleteAlarm(alarm);
equal(e.getAlarms().length, 1);
equal(e.getAlarms()[0], alarm2);
e.clearAlarms();
equal(e.getAlarms().length, 0);
}
function test_immutable() {
const event = new CalEvent();
const date = cal.createDateTime();
date.timezone = cal.timezoneService.getTimezone("Europe/Berlin");
event.alarmLastAck = date;
const org = new CalAttendee();
org.id = "one";
event.organizer = org;
const alarm = new CalAlarm();
alarm.action = "DISPLAY";
alarm.description = "foo";
alarm.related = Ci.calIAlarm.ALARM_RELATED_START;
alarm.offset = cal.createDuration("PT1S");
event.addAlarm(alarm);
event.setProperty("X-NAME", "X-VALUE");
event.setPropertyParameter("X-NAME", "X-PARAM", "X-PARAMVAL");
event.setCategories(["a", "b", "c"]);
equal(event.alarmLastAck.timezone.tzid, cal.dtz.UTC.tzid);
event.makeImmutable();
// call again, should not throw
event.makeImmutable();
ok(!event.alarmLastAck.isMutable);
ok(!org.isMutable);
ok(!alarm.isMutable);
throws(() => {
event.alarmLastAck = cal.createDateTime();
}, /Can not modify immutable data container/);
throws(() => {
event.calendar = null;
}, /Can not modify immutable data container/);
throws(() => {
event.parentItem = null;
}, /Can not modify immutable data container/);
throws(() => {
event.setCategories(["d", "e", "f"]);
}, /Can not modify immutable data container/);
const event2 = event.clone();
event2.organizer.id = "two";
equal(org.id, "one");
equal(event2.organizer.id, "two");
equal(event2.getProperty("X-NAME"), "X-VALUE");
equal(event2.getPropertyParameter("X-NAME", "X-PARAM"), "X-PARAMVAL");
event2.setPropertyParameter("X-NAME", "X-PARAM", null);
equal(event2.getPropertyParameter("X-NAME", "X-PARAM"), null);
// TODO more clone checks
}
function test_lastack() {
const e = new CalEvent();
e.alarmLastAck = cal.createDateTime("20120101T010101");
// Our items don't support this yet
// equal(e.getProperty("X-MOZ-LASTACK"), "20120101T010101");
const comp = e.icalComponent;
const prop = comp.getFirstProperty("X-MOZ-LASTACK");
equal(prop.value, "20120101T010101Z");
prop.value = "20120101T010102Z";
e.icalComponent = comp;
equal(e.alarmLastAck.icalString, "20120101T010102Z");
}
/**
* Test isEvent() returns the correct value for events and todos.
*/
function test_isEvent() {
const event = new CalEvent();
const todo = new CalTodo();
Assert.ok(event.isEvent(), "isEvent() returns true for events");
Assert.ok(!todo.isEvent(), "isEvent() returns false for todos");
}
/**
* Test isTodo() returns the correct value for events and todos.
*/
function test_isTodo() {
const todo = new CalTodo();
const event = new CalEvent();
Assert.ok(todo.isTodo(), "isTodo() returns true for todos");
Assert.ok(!event.isTodo(), "isTodo() returns false for events");
}
/**
* Function for testing that the "properties" property of each supplied
* calItemBase occurrence includes those inherited from the parent.
*
* @param {calItemBase[]} items - A list of item occurrences to test.
* @param {calItemBase} parent - The item to use as the parent.
* @param {object} [overrides] - A set of key value pairs than can be passed
* to indicate what to expect for some properties.
*/
function doPropertiesTest(items, parent, overrides = {}) {
const skippedProps = ["DTSTART", "DTEND"];
const toString = value =>
value && value instanceof Ci.calIDateTime ? value.icalString : value && value.toString();
for (const item of items) {
info(`Testing occurrence with recurrenceId="${item.recurrenceId.icalString}...`);
const parentProperties = new Map(parent.properties);
const itemProperties = new Map(item.properties);
for (const [name, value] of parentProperties.entries()) {
if (!skippedProps.includes(name)) {
if (overrides[name]) {
Assert.equal(
toString(itemProperties.get(name)),
toString(overrides[name]),
`"${name}" value is value expected by overrides`
);
} else {
Assert.equal(
toString(itemProperties.get(name)),
toString(value),
`"${name}" value is same as parent`
);
}
}
}
}
}
/**
* Test the "properties" property of a recurring CalEvent inherits parent
* properties properly.
*/
function test_recurring_event_properties() {
const event = new CalEvent(CalendarTestUtils.dedent`
BEGIN:VEVENT
DTSTAMP:20210716T000000Z
UID:c1a6cfe7-7fbb-4bfb-a00d-861e07c649a5
SUMMARY:Parent Event
CATEGORIES:Business
LOCATION: Mochitest
DTSTART:20210716T000000Z
DTEND:20210716T110000Z
RRULE:FREQ=DAILY;UNTIL=20210719T110000Z
DESCRIPTION:This is the main event.
END:VEVENT
`);
const occurrences = event.recurrenceInfo.getOccurrences(
cal.createDateTime("20210701"),
cal.createDateTime("20210731"),
Infinity
);
doPropertiesTest(occurrences, event.parentItem);
}
/**
* Test the "properties" property of a recurring CalEvent exception inherits
* parent properties properly.
*/
function test_recurring_event_exception_properties() {
const event = new CalEvent(CalendarTestUtils.dedent`
BEGIN:VEVENT
DTSTAMP:20210716T000000Z
UID:c1a6cfe7-7fbb-4bfb-a00d-861e07c649a5
SUMMARY:Parent Event
CATEGORIES:Business
LOCATION: Mochitest
DTSTART:20210716T000000Z
DTEND:20210716T110000Z
RRULE:FREQ=DAILY;UNTIL=20210719T110000Z
DESCRIPTION:This is the main event.
END:VEVENT
`);
const occurrences = event.recurrenceInfo.getOccurrences(
cal.createDateTime("20210701"),
cal.createDateTime("20210731"),
Infinity
);
let target = occurrences[0].clone();
const newDescription = "This is an exception.";
target.setProperty("DESCRIPTION", newDescription);
event.parentItem.recurrenceInfo.modifyException(target);
target = event.parentItem.recurrenceInfo.getExceptionFor(target.recurrenceId);
Assert.ok(target);
doPropertiesTest([target], event.parentItem, { DESCRIPTION: newDescription });
}
/**
* Test the "properties" property of a recurring CalTodo inherits parent
* properties properly.
*/
function test_recurring_todo_properties() {
const task = new CalTodo(CalendarTestUtils.dedent`
BEGIN:VTODO
DTSTAMP:20210716T225440Z
UID:673e125d-fe6b-465d-8a38-9c9373ca9705
SUMMARY:Main Task
RRULE:FREQ=DAILY;UNTIL=20210719T230000Z
DTSTART;TZID=America/Port_of_Spain:20210716T190000
PERCENT-COMPLETE:0
LOCATION:Mochitest
DESCRIPTION:This is the main task.
END:VTODO
`);
const occurrences = task.recurrenceInfo.getOccurrences(
cal.createDateTime("20210701"),
cal.createDateTime("20210731"),
Infinity
);
doPropertiesTest(occurrences, task.parentItem);
}
/**
* Test the "properties" property of a recurring CalTodo exception inherits
* parent properties properly.
*/
function test_recurring_todo_exception_properties() {
const task = new CalTodo(CalendarTestUtils.dedent`
BEGIN:VTODO
DTSTAMP:20210716T225440Z
UID:673e125d-fe6b-465d-8a38-9c9373ca9705
SUMMARY:Main Task
RRULE:FREQ=DAILY;UNTIL=20210719T230000Z
DTSTART;TZID=America/Port_of_Spain:20210716T190000
PERCENT-COMPLETE:0
LOCATION:Mochitest
DESCRIPTION:This is the main task.
END:VTODO
`);
const occurrences = task.recurrenceInfo.getOccurrences(
cal.createDateTime("20210701"),
cal.createDateTime("20210731"),
Infinity
);
let target = occurrences[0].clone();
const newDescription = "This is an exception.";
target.setProperty("DESCRIPTION", newDescription);
task.parentItem.recurrenceInfo.modifyException(target);
target = task.parentItem.recurrenceInfo.getExceptionFor(target.recurrenceId);
Assert.ok(target);
doPropertiesTest([target], task.parentItem, { DESCRIPTION: newDescription });
}