SNCB/NMBS: document profile as broken 📝, skip E2E/integration tests ✅

related: #284
public-transport · Feb 10, 2023 · 2639448 · 2639448
1 parent c2a71b0
commit 2639448
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/p/readme.md b/p/readme.md
@@ -10,7 +10,7 @@ HAFAS endpoint | wrapper library | docs | example code | profile name
 -|-|-|-|-
 [Deutsche Bahn (DB)](https://en.wikipedia.org/wiki/Deutsche_Bahn) | [`db-hafas`](https://github.com/public-transport/db-hafas) | [docs](db/readme.md) | [example](db/example.js) | [`db`](db)
 [Polskie Koleje Państwowe (PKP)](https://en.wikipedia.org/wiki/Polish_State_Railways) | [`pkp-hafas`](https://github.com/juliuste/pkp-hafas) | [docs](pkp/readme.md) | [example](pkp/example.js) | [`pkp`](pkp)
-[Belgian National Railways (SNCB/NMBS)](https://en.wikipedia.org/wiki/National_Railway_Company_of_Belgium) | - | [docs](sncb/readme.md) | [example](sncb/example.js) | [`sncb`](sncb)
+[Belgian National Railways (SNCB/NMBS)](https://en.wikipedia.org/wiki/National_Railway_Company_of_Belgium) | - | [docs](sncb/readme.md) | [example](sncb/example.js) | [`sncb`](sncb) (currently broken)
 [*Iarnród Éireann* (Irish Rail)](https://en.wikipedia.org/wiki/Iarnród_Éireann) | - | [docs](irish-rail/readme.md) | [example](irish-rail/example.js) | [`irish-rail`](irish-rail)
 [Berlin & Brandenburg public transport (VBB)](https://en.wikipedia.org/wiki/Verkehrsverbund_Berlin-Brandenburg) | [`vbb-hafas`](https://github.com/public-transport/vbb-hafas) | [docs](vbb/readme.md) | [example](vbb/example.js) | [`vbb`](vbb)
 [Berlin public transport (BVG)](https://en.wikipedia.org/wiki/Berliner_Verkehrsbetriebe) | [`bvg-hafas`](https://github.com/public-transport/bvg-hafas) | [docs](bvg/readme.md) | [example](bvg/example.js) | [`bvg`](bvg)

diff --git a/p/sncb/readme.md b/p/sncb/readme.md
@@ -1,5 +1,7 @@
 # SNCB profile for `hafas-client`
 
+*Note:* **This profile is currently broken** because [SNCB has switched the HAFAS API style](https://github.com/public-transport/hafas-client/issues/284) and we haven't migrated to the new API.
+
 [*Société nationale des chemins de fer belges (SNCB)*/*Nationale Maatschappij der Belgische Spoorwegen (NMBS)*](https://en.wikipedia.org/wiki/National_Railway_Company_of_Belgium) is the major public transport provider of [Belgium](https://en.wikipedia.org/wiki/Belgium). This profile adds *SNCB*-specific customizations to `hafas-client`.
 
 ## Usage

diff --git a/test/e2e/sncb.js b/test/e2e/sncb.js
@@ -33,7 +33,7 @@ const gentPaddenhoek = {
 	latitude: 51.051691, longitude: 3.724914,
 }
 
-tap.test('journeys – Gent Sant Pieters to Bruxelles Midi', async (t) => {
+tap.skip('journeys – Gent Sant Pieters to Bruxelles Midi', async (t) => {
 	const res = await client.journeys(gentStPieters, bruxellesMidi, {
 		results: 4,
 		departure: when,
@@ -53,7 +53,7 @@ tap.test('journeys – Gent Sant Pieters to Bruxelles Midi', async (t) => {
 // todo: via works – with detour
 // todo: without detour
 
-tap.test('trip details', async (t) => {
+tap.skip('trip details', async (t) => {
 	const res = await client.journeys(gentStPieters, bruxellesMidi, {
 		results: 1, departure: when
 	})
@@ -68,7 +68,7 @@ tap.test('trip details', async (t) => {
 	t.end()
 })
 
-tap.test('arrivals at Bruxelles Midi', async (t) => {
+tap.skip('arrivals at Bruxelles Midi', async (t) => {
 	const res = await client.arrivals(bruxellesMidi, {
 		duration: 10, when
 	})
@@ -84,7 +84,7 @@ tap.test('arrivals at Bruxelles Midi', async (t) => {
 
 // todo: nearby
 
-tap.test('radar', async (t) => {
+tap.skip('radar', async (t) => {
 	const res = await client.radar({
 		north: 51.065,
 		west: 3.688,
@@ -98,7 +98,7 @@ tap.test('radar', async (t) => {
 	t.end()
 })
 
-tap.test('reachableFrom', async (t) => {
+tap.skip('reachableFrom', async (t) => {
 	await testReachableFrom({
 		test: t,
 		reachableFrom: client.reachableFrom,