Skip to content

TEST.md

Latest commit

 

History

History
145 lines (109 loc) · 7.61 KB

TEST.md

File metadata and controls

145 lines (109 loc) · 7.61 KB

Tests

Event issue helpers

File: .github/scripts/event-issue-helpers.test.mjs Run: node --test .github/scripts/event-issue-helpers.test.mjs Requires: Node built-ins only — no install needed.

These tests cover the shared pure functions extracted into event-issue-helpers.mjs, which are used by both the new-event and edit-event intake scripts.

Function Cases
parseIssueSections Normal sections, _No response_ cleaning, empty body, \r\n normalization
isValidDate Valid date, missing leading zero, non-ISO format, out-of-range month/day, empty string
isValidTime Valid time, midnight, hour 25, missing colon, minute 60
isValidEmail Valid email, missing @, missing TLD, empty string
isValidHttpUrl http/https valid, ftp rejected, non-URL string, empty string
slugify Accent removal, lowercase+space→dash, leading/trailing dash strip, multiple dash collapse, special char removal
parseActivities Checked boxes, all unchecked, unknown activity filtered, case-insensitive [X]
parseOrganizers Plain names, name <email> suffix stripped, blank lines ignored, empty input
generateUniqueUid Length 7, hex chars only, not in existing set, added to set, multiple unique in sequence

New event intake script

File: .github/scripts/process-new-event-issue.test.mjs Run: node --test .github/scripts/process-new-event-issue.test.mjs Requires: Node built-ins + open-location-code at pcd-website/node_modules/. Runs the script as a child process against a real temp filesystem.

Case Expected
Valid new-event issue body valid=true, writes metadata.json with all fields including uid (7 hex chars)
Event page URL field present Value appears in metadata.json as event_page_url (regression for the Event website field-name bug)
Duplicate event directory valid=false, validation comment mentions the generated id
Issue body contains ### Event canonical ID heading valid=skip (guard against running on edit-event template)
Edit-event issue body (contains ### Event canonical ID and ### Plus Code (for map placement)) valid=skip (regression: edit-event body must not be processed as new event)
Issue body missing ### Plus Code (for map placement) and no ### Event canonical ID valid=skip (unrecognized template)

Edit event intake script

File: .github/scripts/process-edit-event-issue.test.mjs Run: node --test .github/scripts/process-edit-event-issue.test.mjs Requires: Node built-ins + open-location-code at pcd-website/node_modules/. Runs the script as a child process; sets up a real test event directory in the repo's events folder with beforeEach/afterEach cleanup.

Case Expected
Valid edit issue, event exists valid=true, pr_label=edit event, action_verb=updated on, metadata updated, uid and intake preserved
Blank full_description Existing content.md unchanged
All activities unchecked Existing event_activities preserved (checkbox prefill limitation)
Some activities checked event_activities overwritten with checked values
Event directory does not exist valid=false, validation comment mentions the missing event id
Missing ### Event canonical ID heading valid=skip (guard against running on new-event template)

data.json build output

File: .github/scripts/data-json.test.mjs Run: node --test .github/scripts/data-json.test.mjs Requires: npm run build must be run from pcd-website/ first — this test reads pcd-website/dist/data.json.

Case Expected
File exists and is valid JSON Passes without error
Top-level keys schema_version, generated_at, event_count, events all present
event_count vs events.length Equal
No primary_contact in any event Omitted (privacy)
No placeholder in any event Omitted (all feed entries are confirmed)
canonical_url shape Exactly https://day.processing.org/event/${id}-${uid}/
lat and lng Finite numbers on every event

Plus Code functions

File: .github/scripts/plus-code.test.mjs Run: node --test .github/scripts/plus-code.test.mjs Requires: open-location-code — available locally at pcd-website/node_modules/open-location-code/ (no install needed). In CI it is installed to /tmp/script-deps/.

These tests cover isValidPlusCode and resolvePlusCode from .github/scripts/plus-code.mjs, which are used by the new-event intake script to validate and recover Plus Codes submitted via GitHub Issues.

isValidPlusCode

Pure function — no mocking needed.

Input Expected Reason
'8FW4V9H4+MC' true Valid full global code
'8FW4V9H4+MC7' true Valid 3-char suffix variant
'8FW4V9H4+MC ' true Trailing spaces are normalized
'8fw4v9h4+mc' true Lowercase is normalized
'V9H4+MC' false Short code — not a full global code
'NOTACODE' false No Plus Code structure
'' false Empty string

resolvePlusCode — fast path

Input is already a valid full code; no Nominatim call is made.

Input Expected
('8FW4V9H4+MC', '', '') { code: '8FW4V9H4+MC', note: null }
('8FW4V9H4+MC ', '', '') { code: '8FW4V9H4+MC', note: null } — spaces stripped
('8fw4v9h4+mc', '', '') { code: '8FW4V9H4+MC', note: null } — uppercased

resolvePlusCode — short code recovery

Nominatim is mocked to return Paris coordinates (~48.879188, 2.356063). The reference full code is 8FW4V9H4+MC (short form V9H4+MC, near 145 rue La Fayette, Paris).

Recovery tests assert:

  1. result.code === '8FW4V9H4+MC'
  2. result.note is non-null
  3. The decoded center lat/lon is within 0.001° of the Paris reference
Input Expected
('V9H4+MC', 'Paris', 'France') Recovers — city/country form fields used as location ref
('V9H4+MC,PARIS', '', '') Recovers — comma-separated city extracted from value
('V9H4+MC,PARIS,FRANCE', '', '') Recovers — comma-separated city and country extracted
('V9H4+MC, Paris, France', '', '') Recovers — spaces around commas stripped before extraction
('My code: V9H4+MC,PARIS', '', '') Recovers — arbitrary prefix text is ignored
('V9H4+MC', '', '') { code: null, note: null } — short code with no location reference

resolvePlusCode — ambiguous input

When a city name starts with OLC-valid characters (e.g. P in PARIS), the extraction regex cannot cleanly separate the short code from the city. This is a documented limitation.

Input Behavior
('V9H4+MCPARIS', '', '') V9H4+MCP is extracted (P absorbed into suffix). No location hint follows, so the result is not the correct Paris code.
('V9H4+MCPARIS,FRANCE', '', '') V9H4+MCP is extracted, FRANCE used as hint. Recovery may succeed but produces a code at the wrong location — not 8FW4V9H4+MC.

Supported formats to avoid this: use a comma separator (V9H4+MC,Paris) or provide city/country in the form fields.

resolvePlusCode — failure cases

Input Nominatim mock Expected
('NOTACODE', 'Paris', 'France') Returns Paris coords { code: null, note: null } — no extractable code
('V9H4+MC', 'Paris', 'France') Returns [] { code: null, note: null } — no geocoding result
('V9H4+MC', 'Paris', 'France') Throws { code: null, note: null } — fetch error caught
('', '', '') Returns Paris coords { code: null, note: null } — empty input