Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add spec violation rules #141

Closed
wants to merge 24 commits into from
Closed

Add spec violation rules #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
92c46af
Custom validations
tdelmas Jul 7, 2023
50dfba6
Better display & error counts
tdelmas Jul 12, 2023
12c640a
Regroup all errors on front
PierrickP Jul 26, 2023
9cc5938
Rename otherValidation to nonSchemaValidation
PierrickP Jul 26, 2023
2170404
Add `duplicate_vehicle_type_id` error
PierrickP Jul 26, 2023
f9dfc5a
Fix typos
tdelmas Aug 3, 2023
deae327
Fix when `errors` is `false` but not `nonSchemaErrors`
tdelmas Aug 3, 2023
bb49a1c
Most review suggestions
tdelmas Sep 6, 2023
1435e7f
Removes the rules that are not in the spec
richfab Oct 24, 2023
bad9010
Collapse errors and warnings
richfab Oct 24, 2023
598e14f
Provide the actual value of last_updated
richfab Nov 1, 2023
352b25b
Fix typo in exhaustive
richfab Nov 1, 2023
00028ff
Improve test message
richfab Nov 1, 2023
a3e498e
Return the result of hasErrors and hasWarnings
richfab Nov 1, 2023
86cd938
Specify from which version the rules apply
richfab Nov 2, 2023
8f4ba14
Use forEach in loops instead of map
richfab Nov 2, 2023
3054d26
Fix line starting with semicolon
richfab Nov 2, 2023
7013a67
Use Array#some
richfab Nov 2, 2023
1e0569d
Take metadata out of error message for consistency
richfab Nov 2, 2023
e747ccb
Typo in multipolygon
richfab Nov 2, 2023
1844e72
Variable name for coordinates of a multipolygon
richfab Nov 2, 2023
cf2bfae
Variable name polygonCoordinates
richfab Nov 2, 2023
b4a2832
Rename variable o to rules
richfab Nov 2, 2023
d271ba8
Undo Use Array#some because the tests failed
richfab Nov 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion gbfs-validator/__test__/fixtures/conditionnal_no_vehicle_type_id.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
const fastify = require('fastify')

const last_updated_fresh = Math.floor(Date.now() / 1000) - 30
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is good practice to not use real clocks in tests. It makes tests more reliable and readable. Jest has as of v27 the ability to do this neatly: https://jestjs.io/docs/jest-object#jestsetsystemtimenow-number--date

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great idea, but this is beyond my knowledge unfortunately (even after reading the docs). Anyone, feel free to suggest an implementation. Thanks!


function build(opts = {}) {
const app = fastify(opts)

Expand Down Expand Up @@ -49,7 +51,7 @@ function build(opts = {}) {

app.get('/free_bike_status.json', async function(request, reply) {
return {
last_updated: 1566224400,
last_updated: last_updated_fresh,
ttl: 0,
version: '2.2',
data: {
Expand Down
14 changes: 5 additions & 9 deletions gbfs-validator/__test__/fixtures/conditionnal_vehicle_type_id.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
const fastify = require('fastify')

const last_updated_fresh = Math.floor(Date.now() / 1000) - 30

function build(opts = {}) {
const app = fastify(opts)

Expand Down Expand Up @@ -64,15 +66,12 @@ function build(opts = {}) {
propulsion_type: 'human',
name: 'Example Basic Bike',
default_reserve_time: 30,
return_type: ['any_station', 'free_floating'],
vehicle_assets: {
icon_url: 'https://www.example.com/assets/icon_bicycle.svg',
icon_url_dark:
'https://www.example.com/assets/icon_bicycle_dark.svg',
icon_last_modified: '2021-06-15'
},
default_pricing_plan_id: 'bike_plan_1',
pricing_plan_ids: ['bike_plan_1', 'bike_plan_2', 'bike_plan_3']
}
},
{
vehicle_type_id: 'efg456',
Expand All @@ -81,14 +80,11 @@ function build(opts = {}) {
name: 'Example Electric Car',
default_reserve_time: 30,
max_range_meters: 100,
return_type: ['any_station', 'free_floating'],
vehicle_assets: {
icon_url: 'https://www.example.com/assets/icon_car.svg',
icon_url_dark: 'https://www.example.com/assets/icon_car_dark.svg',
icon_last_modified: '2021-06-15'
},
default_pricing_plan_id: 'car_plan_1',
pricing_plan_ids: ['car_plan_1', 'car_plan_2', 'car_plan_3']
}
}
]
}
Expand All @@ -97,7 +93,7 @@ function build(opts = {}) {

app.get('/free_bike_status.json', async function(request, reply) {
return {
last_updated: 1566224400,
last_updated: last_updated_fresh,
ttl: 0,
version: '2.2',
data: {
Expand Down
6 changes: 3 additions & 3 deletions gbfs-validator/__test__/fixtures/conditionnal_vehicle_types_available.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
const fastify = require('fastify')

const last_updated_fresh = Math.floor(Date.now() / 1000) - 30

function build(opts = {}) {
const app = fastify(opts)

Expand Down Expand Up @@ -60,7 +62,6 @@ function build(opts = {}) {
propulsion_type: 'human',
name: 'Example Basic Bike',
default_reserve_time: 30,
return_type: ['any_station', 'free_floating'],
vehicle_assets: {
icon_url: 'https://www.example.com/assets/icon_bicycle.svg',
icon_url_dark:
Expand All @@ -77,7 +78,6 @@ function build(opts = {}) {
name: 'Example Electric Car',
default_reserve_time: 30,
max_range_meters: 100,
return_type: ['any_station', 'free_floating'],
vehicle_assets: {
icon_url: 'https://www.example.com/assets/icon_car.svg',
icon_url_dark: 'https://www.example.com/assets/icon_car_dark.svg',
Expand All @@ -93,7 +93,7 @@ function build(opts = {}) {

app.get('/station_status.json', async function(request, reply) {
return {
last_updated: 1566224400,
last_updated: last_updated_fresh,
ttl: 0,
version: '2.2',
data: {
Expand Down
4 changes: 3 additions & 1 deletion gbfs-validator/__test__/fixtures/missing_vehicle_types.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
const fastify = require('fastify')

const last_updated_fresh = Math.floor(Date.now() / 1000) - 30

function build(opts = {}) {
const app = fastify(opts)

Expand Down Expand Up @@ -49,7 +51,7 @@ function build(opts = {}) {

app.get('/free_bike_status.json', async function(request, reply) {
return {
last_updated: 1566224400,
last_updated: last_updated_fresh,
ttl: 0,
version: '2.2',
data: {
Expand Down
10 changes: 6 additions & 4 deletions gbfs-validator/__test__/fixtures/plan_id.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
const fastify = require('fastify')

const last_updated_fresh = Math.floor(Date.now() / 1000) - 30

function build(opts = {}) {
const app = fastify(opts)

app.get('/gbfs.json', async function(request, reply) {
app.get('/gbfs.json', async function (request, reply) {
return {
last_updated: 1566224400,
ttl: 0,
Expand Down Expand Up @@ -57,7 +59,7 @@ function build(opts = {}) {

app.get('/free_bike_status.json', async function(request, reply) {
return {
last_updated: 1566224400,
last_updated: last_updated_fresh,
ttl: 0,
version: '2.3',
data: {
Expand Down Expand Up @@ -109,7 +111,7 @@ function build(opts = {}) {
propulsion_type: 'human',
name: 'Example Basic Bike',
default_reserve_time: 30,
return_type: ['any_station', 'free_floating'],
return_constraint: 'any_station',
vehicle_assets: {
icon_url: 'https://www.example.com/assets/icon_bicycle.svg',
icon_url_dark:
Expand All @@ -126,7 +128,7 @@ function build(opts = {}) {
name: 'Example Electric Car',
default_reserve_time: 30,
max_range_meters: 100,
return_type: ['any_station', 'free_floating'],
return_constraint: 'free_floating',
vehicle_assets: {
icon_url: 'https://www.example.com/assets/icon_car.svg',
icon_url_dark: 'https://www.example.com/assets/icon_car_dark.svg',
Expand Down
12 changes: 4 additions & 8 deletions gbfs-validator/__test__/fixtures/v3.0-RC/default.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,15 +116,13 @@ class MockRequests {
}
],
default_reserve_time: 30,
return_type: ['any_station', 'free_floating'],
return_constraint: 'hybrid',
vehicle_assets: {
icon_url: 'https://www.example.com/assets/icon_bicycle.svg',
icon_url_dark:
'https://www.example.com/assets/icon_bicycle_dark.svg',
icon_last_modified: '2021-06-15'
},
default_pricing_plan_id: 'bike_plan_1',
pricing_plan_ids: ['bike_plan_1', 'bike_plan_2', 'bike_plan_3']
}
},
{
vehicle_type_id: 'cartype1',
Expand All @@ -138,14 +136,12 @@ class MockRequests {
],
default_reserve_time: 30,
max_range_meters: 100,
return_type: ['any_station', 'free_floating'],
return_constraint: 'any_station',
vehicle_assets: {
icon_url: 'https://www.example.com/assets/icon_car.svg',
icon_url_dark: 'https://www.example.com/assets/icon_car_dark.svg',
icon_last_modified: '2021-06-15'
},
default_pricing_plan_id: 'car_plan_1',
pricing_plan_ids: ['car_plan_1', 'car_plan_2', 'car_plan_3']
}
}
]
}
Expand Down
26 changes: 18 additions & 8 deletions ...or/__test__/fixtures/v3.0-RC/exaustive.js → ...r/__test__/fixtures/v3.0-RC/exhaustive.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ class MockRequests {
}
],
default_reserve_time: 30,
return_type: ['any_station', 'free_floating'],
return_constraint: 'free_floating',
vehicle_assets: {
icon_url: 'https://www.example.com/assets/icon_bicycle.svg',
icon_url_dark:
Expand Down Expand Up @@ -243,7 +243,6 @@ class MockRequests {
vehicle_accessories: ['automatic', 'air_conditioning'],
g_CO2_km: 0,
default_reserve_time: 30,
return_type: ['any_station', 'free_floating'],
vehicle_image: 'https://www.example.com/assets/car.jpg',
make: [
{
Expand All @@ -267,7 +266,6 @@ class MockRequests {
wheel_count: 4,
max_permitted_speed: 200,
rated_power: 100,
default_reserve_time: 30,
return_constraint: 'hybrid',
vehicle_assets: {
icon_url: 'https://www.example.com/assets/icon_car.svg',
Expand All @@ -290,7 +288,20 @@ class MockRequests {
data: {
stations: [
{
station_id: 'pga',
station_id: 'station1',
name: [
{
text: 'Station 1',
language: 'en'
}
],
lat: 12.345578,
lon: 45.678801,
is_virtual_station: false,
capacity: 5
},
{
station_id: 'station2',
name: [
{
text: 'Parking garage A',
Expand Down Expand Up @@ -329,7 +340,7 @@ class MockRequests {
parking_type: 'underground_parking',
parking_hoop: false,
contact_phone: '+33109874321',
capacity: 10,
capacity: 20,
vehicle_type_area_capacity: [
{
vehicle_type_id: 'abc123',
Expand Down Expand Up @@ -454,8 +465,7 @@ class MockRequests {
rental_uris: {
android:
'https://www.example.com/app?vehicle_id=973a5c94-c288-4a2b-afa6-de8aeb6ae2e5&platform=android&',
ios:
'https://www.example.com/app?vehicle_id=973a5c94-c288-4a2b-afa6-de8aeb6ae2e5&platform=ios',
ios: 'https://www.example.com/app?vehicle_id=973a5c94-c288-4a2b-afa6-de8aeb6ae2e5&platform=ios',
web: 'https://www.example.com/app?sid=1234567890'
},
vehicle_type_id: 'biketype1',
Expand Down Expand Up @@ -584,7 +594,7 @@ class MockRequests {
language: 'en'
}
],
currency: 'CAD',
currency: 'EUR',
price: 3.0,
reservation_price_flat_rate: 3.0,
is_taxable: true,
Expand Down
Loading
Loading