Skip to content

feat: add unit tests around schema evolution #225

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

Merged
rgraber merged 8 commits into from
Jun 8, 2023
Merged

feat: add unit tests around schema evolution #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
283918f
feat: unit test schema evolution
May 24, 2023
e78bc3f
fixup!: fix test_backward to write a dict rather than an attrs class
May 25, 2023
b2301b3
fixup!: comment
May 25, 2023
d099f73
fixup!: review comments
Jun 6, 2023
09e53f0
fixup!: latest schemas
Jun 6, 2023
8bde11d
fixup!: comment if file not found
Jun 8, 2023
3da739f
fixup!: isort
Jun 8, 2023
0bfefce
fixup!: pragma
Jun 8, 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
6 changes: 6 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ Change Log
Unreleased
----------

[8.1.0] - 2023-06-06
--------------------
Added
~~~~~
* Store current versions of Avro schemas and add test to ensure valid evolution

[8.0.1] - 2023-05-16
--------------------
Changed
Expand Down
2 changes: 1 addition & 1 deletion openedx_events/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
more information about the project.
"""

__version__ = "8.0.1"
__version__ = "8.1.0"
74 changes: 74 additions & 0 deletions ...ro/tests/schemas/org+openedx+content_authoring+course+catalog_info+changed+v1_schema.avsc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
{
"name": "CloudEvent",
"type": "record",
"doc": "Avro Event Format for CloudEvents created with openedx_events/schema",
"fields": [
{
"name": "catalog_info",
"type": {
"name": "CourseCatalogData",
"type": "record",
"fields": [
{
"name": "course_key",
"type": "string"
},
{
"name": "name",
"type": "string"
},
{
"name": "schedule_data",
"type": {
"name": "CourseScheduleData",
"type": "record",
"fields": [
{
"name": "start",
"type": "string"
},
{
"name": "pacing",
"type": "string"
},
{
"name": "end",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "enrollment_start",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "enrollment_end",
"type": [
"null",
"string"
],
"default": null
}
]
}
},
{
"name": "hidden",
"type": "boolean"
},
{
"name": "invitation_only",
"type": "boolean"
}
]
}
}
],
"namespace": "org.openedx.content_authoring.course.catalog_info.changed.v1"
}
25 changes: 25 additions & 0 deletions .../event_bus/avro/tests/schemas/org+openedx+content_authoring+xblock+deleted+v1_schema.avsc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"name": "CloudEvent",
"type": "record",
"doc": "Avro Event Format for CloudEvents created with openedx_events/schema",
"fields": [
{
"name": "xblock_info",
"type": {
"name": "XBlockData",
"type": "record",
"fields": [
{
"name": "usage_key",
"type": "string"
},
{
"name": "block_type",
"type": "string"
}
]
}
}
],
"namespace": "org.openedx.content_authoring.xblock.deleted.v1"
}
29 changes: 29 additions & 0 deletions ...ent_bus/avro/tests/schemas/org+openedx+content_authoring+xblock+duplicated+v1_schema.avsc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"name": "CloudEvent",
"type": "record",
"doc": "Avro Event Format for CloudEvents created with openedx_events/schema",
"fields": [
{
"name": "xblock_info",
"type": {
"name": "DuplicatedXBlockData",
"type": "record",
"fields": [
{
"name": "usage_key",
"type": "string"
},
{
"name": "block_type",
"type": "string"
},
{
"name": "source_usage_key",
"type": "string"
}
]
}
}
],
"namespace": "org.openedx.content_authoring.xblock.duplicated.v1"
}
25 changes: 25 additions & 0 deletions ...vent_bus/avro/tests/schemas/org+openedx+content_authoring+xblock+published+v1_schema.avsc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"name": "CloudEvent",
"type": "record",
"doc": "Avro Event Format for CloudEvents created with openedx_events/schema",
"fields": [
{
"name": "xblock_info",
"type": {
"name": "XBlockData",
"type": "record",
"fields": [
{
"name": "usage_key",
"type": "string"
},
{
"name": "block_type",
"type": "string"
}
]
}
}
],
"namespace": "org.openedx.content_authoring.xblock.published.v1"
}
46 changes: 46 additions & 0 deletions ...t_bus/avro/tests/schemas/org+openedx+learning+auth+session+login+completed+v1_schema.avsc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"name": "CloudEvent",
"type": "record",
"doc": "Avro Event Format for CloudEvents created with openedx_events/schema",
"fields": [
{
"name": "user",
"type": {
"name": "UserData",
"type": "record",
"fields": [
{
"name": "id",
"type": "long"
},
{
"name": "is_active",
"type": "boolean"
},
{
"name": "pii",
"type": {
"name": "UserPersonalData",
"type": "record",
"fields": [
{
"name": "username",
"type": "string"
},
{
"name": "email",
"type": "string"
},
{
"name": "name",
"type": "string"
}
]
}
}
]
}
}
],
"namespace": "org.openedx.learning.auth.session.login.completed.v1"
}
112 changes: 112 additions & 0 deletions ...ents/event_bus/avro/tests/schemas/org+openedx+learning+certificate+changed+v1_schema.avsc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
{
"name": "CloudEvent",
"type": "record",
"doc": "Avro Event Format for CloudEvents created with openedx_events/schema",
"fields": [
{
"name": "certificate",
"type": {
"name": "CertificateData",
"type": "record",
"fields": [
{
"name": "user",
"type": {
"name": "UserData",
"type": "record",
"fields": [
{
"name": "id",
"type": "long"
},
{
"name": "is_active",
"type": "boolean"
},
{
"name": "pii",
"type": {
"name": "UserPersonalData",
"type": "record",
"fields": [
{
"name": "username",
"type": "string"
},
{
"name": "email",
"type": "string"
},
{
"name": "name",
"type": "string"
}
]
}
}
]
}
},
{
"name": "course",
"type": {
"name": "CourseData",
"type": "record",
"fields": [
{
"name": "course_key",
"type": "string"
},
{
"name": "display_name",
"type": "string"
},
{
"name": "start",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "end",
"type": [
"null",
"string"
],
"default": null
}
]
}
},
{
"name": "mode",
"type": "string"
},
{
"name": "grade",
"type": "string"
},
{
"name": "download_url",
"type": "string"
},
{
"name": "name",
"type": "string"
},
{
"name": "current_status",
"type": "string"
},
{
"name": "previous_status",
"type": "string"
}
]
}
}
],
"namespace": "org.openedx.learning.certificate.changed.v1"
}
Loading