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.

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

Check schedule flags validity also when creating a schedule from scratch #865

Merged
merged 3 commits into from
Nov 6, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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: 4 additions & 0 deletions dispatcher/backend/src/routes/schedules/schedule.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,10 @@ def post(self, session: so.Session, token: AccessToken.Payload):

try:
document = ScheduleSchema().load(request.get_json())
flags_schema = ScheduleConfigSchema.get_offliner_schema(
document["config"]["task_name"]
)
flags_schema().load(document["config"]["flags"])
except ValidationError as e:
raise InvalidRequestJSON(e.messages)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
class TestFreeCodeCamp:
def test_create_freecodecamp_schedule(
def test_create_freecodecamp_schedule_ok(
self, client, access_token, garbage_collector
):
schedule = {
"name": "fcc_javascript_test",
"name": "fcc_javascript_test_ok",
"category": "freecodecamp",
"enabled": False,
"tags": [],
Expand All @@ -14,7 +14,13 @@ def test_create_freecodecamp_schedule(
"image": {"name": "openzim/freecodecamp", "tag": "1.0.0"},
"monitor": False,
"platform": None,
"flags": {},
"flags": {
"course": ("somecourse"),
"language": "eng",
"name": "acourse",
"title": "a title",
"description": "a description",
},
"resources": {"cpu": 3, "memory": 1024, "disk": 0},
},
"periodicity": "quarterly",
Expand All @@ -24,9 +30,11 @@ def test_create_freecodecamp_schedule(
response = client.post(
url, json=schedule, headers={"Authorization": access_token}
)
assert response.status_code == 201
response_data = response.get_json()
garbage_collector.add_schedule_id(response_data["_id"])
print(response_data)
rgaudin marked this conversation as resolved.
Show resolved Hide resolved
if "_id" in response_data:
garbage_collector.add_schedule_id(response_data["_id"])
assert response.status_code == 201

patch_data = {
"enabled": True,
Expand All @@ -50,3 +58,49 @@ def test_create_freecodecamp_schedule(
url, json=patch_data, headers={"Authorization": access_token}
)
assert response.status_code == 204

def test_create_freecodecamp_schedule_ko(
self, client, access_token, garbage_collector
):
schedule = {
"name": "fcc_javascript_test_ko",
"category": "freecodecamp",
"enabled": False,
"tags": [],
"language": {"code": "fr", "name_en": "French", "name_native": "Français"},
"config": {
"task_name": "freecodecamp",
"warehouse_path": "/freecodecamp",
"image": {"name": "openzim/freecodecamp", "tag": "1.0.0"},
"monitor": False,
"platform": None,
"flags": {
"course": ("somecourse"),
"language": "eng",
"name": "acourse",
"title": "a title",
"description": (
"a description which is way way way way way way way way way "
"way way way way way way way way way too long"
),
},
"resources": {"cpu": 3, "memory": 1024, "disk": 0},
},
"periodicity": "quarterly",
}

url = "/schedules/"
response = client.post(
url, json=schedule, headers={"Authorization": access_token}
)
response_data = response.get_json()
print(response_data)
rgaudin marked this conversation as resolved.
Show resolved Hide resolved
if "_id" in response_data:
garbage_collector.add_schedule_id(response_data["_id"])
assert response.status_code == 400
assert "error_description" in response_data
assert "description" in response_data["error_description"]
assert (
"Longer than maximum length 80."
in response_data["error_description"]["description"]
)
Original file line number Diff line number Diff line change
Expand Up @@ -265,15 +265,26 @@ def test_create_schedule_missing_keys(self, client, access_token, key):
"flags": {},
"image": {"name": "openzim/phet", "tag": "latest"},
"monitor": False,
"platform": None,
"resources": {"cpu": 3, "memory": 1024, "disk": 0},
},
"periodicity": "quarterly",
}

del schedule[key]
url = "/schedules/"
response = client.post(
url, json=schedule, headers={"Authorization": access_token}
)
response_data = response.get_json()
print(response_data)
rgaudin marked this conversation as resolved.
Show resolved Hide resolved
assert response.status_code == 400
assert "error_description" in response_data
assert key in response_data["error_description"]
assert (
"Missing data for required field."
in response_data["error_description"][key]
)

@pytest.mark.parametrize("key", ["warehouse_path", "flags", "image"])
def test_create_schedule_missing_config_keys(self, client, access_token, key):
Expand All @@ -293,15 +304,64 @@ def test_create_schedule_missing_config_keys(self, client, access_token, key):
"flags": {},
"image": {"name": "openzim/phet", "tag": "latest"},
"monitor": False,
"platform": None,
"resources": {"cpu": 3, "memory": 1024, "disk": 0},
},
"periodicity": "quarterly",
}

del schedule["config"][key]
url = "/schedules/"
response = client.post(
url, json=schedule, headers={"Authorization": access_token}
)
response_data = response.get_json()
print(response_data)
rgaudin marked this conversation as resolved.
Show resolved Hide resolved
assert response.status_code == 400
assert "error_description" in response_data
assert "config" in response_data["error_description"]
assert key in response_data["error_description"]["config"]
assert (
"Missing data for required field."
in response_data["error_description"]["config"][key]
)

def test_create_schedule_flags_ko(self, client, access_token):
schedule = {
"name": "ifixit flags ko",
"category": "ifixit",
"enabled": False,
"tags": [],
"language": {
"code": "en",
"name_en": "English",
"name_native": "English",
},
"config": {
"task_name": "ifixit",
"warehouse_path": "/ifixit",
"flags": {},
"image": {"name": "openzim/ifixit", "tag": "latest"},
"monitor": False,
"platform": "ifixit",
"resources": {"cpu": 3, "memory": 1024, "disk": 0},
},
"periodicity": "quarterly",
}

url = "/schedules/"
response = client.post(
url, json=schedule, headers={"Authorization": access_token}
)
response_data = response.get_json()
print(response_data)
rgaudin marked this conversation as resolved.
Show resolved Hide resolved
assert response.status_code == 400
assert "error_description" in response_data
assert "language" in response_data["error_description"]
assert (
"Missing data for required field."
in response_data["error_description"]["language"]
)

def test_image_names(self, client, schedule, access_token):
url = "/schedules/{}/image-names".format(schedule["name"])
Expand Down