Validate GitHub API info

conbench · Jul 14, 2021 · 4217eee · 4217eee
1 parent c76dd61
commit 4217eee
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/conbench/entities/summary.py b/conbench/entities/summary.py
@@ -219,6 +219,11 @@ class SummarySerializer:
     many = _Serializer(many=True)
 
 
+class GitHubCreate(marshmallow.Schema):
+    commit = marshmallow.fields.String(required=True)
+    repository = marshmallow.fields.String(required=True)
+
+
 class _BenchmarkFacadeSchemaCreate(marshmallow.Schema):
     run_id = marshmallow.fields.String(required=True)
     run_name = marshmallow.fields.String(required=False)
@@ -228,7 +233,7 @@ class _BenchmarkFacadeSchemaCreate(marshmallow.Schema):
     stats = marshmallow.fields.Nested(SummarySchema().create, required=True)
     tags = marshmallow.fields.Dict(required=True)
     context = marshmallow.fields.Dict(required=True)
-    github = marshmallow.fields.Dict(required=True)
+    github = marshmallow.fields.Nested(GitHubCreate(), required=True)
 
 
 class BenchmarkFacadeSchema:

diff --git a/conbench/tests/api/_expected_docs.py b/conbench/tests/api/_expected_docs.py
@@ -700,7 +700,7 @@
                 "properties": {
                     "batch_id": {"type": "string"},
                     "context": {"type": "object"},
-                    "github": {"type": "object"},
+                    "github": {"$ref": "#/components/schemas/GitHubCreate"},
                     "machine_info": {"$ref": "#/components/schemas/MachineCreate"},
                     "run_id": {"type": "string"},
                     "run_name": {"type": "string"},
@@ -755,6 +755,14 @@
                 },
                 "type": "object",
             },
+            "GitHubCreate": {
+                "properties": {
+                    "commit": {"type": "string"},
+                    "repository": {"type": "string"},
+                },
+                "required": ["commit", "repository"],
+                "type": "object",
+            },
             "Login": {
                 "properties": {
                     "email": {"format": "email", "type": "string"},

diff --git a/conbench/tests/api/test_benchmarks.py b/conbench/tests/api/test_benchmarks.py
@@ -354,12 +354,18 @@ def test_nested_schema_validation(self, client):
         self.authenticate(client)
         data = copy.deepcopy(self.valid_payload)
         del data["stats"]["iterations"]
+        del data["github"]["commit"]
         del data["machine_info"]["os_name"]
         data["machine_info"]["os_version"] = None
         data["stats"]["extra"] = "field"
+        data["github"]["extra"] = "field"
         data["machine_info"]["extra"] = "field"
         response = client.post("/api/benchmarks/", json=data)
         message = {
+            "github": {
+                "extra": ["Unknown field."],
+                "commit": ["Missing data for required field."],
+            },
             "machine_info": {
                 "extra": ["Unknown field."],
                 "os_name": ["Missing data for required field."],