diff --git a/docs/decisions/0030-tutor-implementation-authz-schema-discovery.rst b/docs/decisions/0030-tutor-implementation-authz-schema-discovery.rst index 2319e6dc..e9ab2fcf 100644 --- a/docs/decisions/0030-tutor-implementation-authz-schema-discovery.rst +++ b/docs/decisions/0030-tutor-implementation-authz-schema-discovery.rst @@ -102,7 +102,7 @@ Example rendered file with two plugin contributions: Schemas discovered through ``OPENEDX_AUTHZ_SCHEMA_FILES`` have no Python package or module. To satisfy the source-tracking requirements of `ADR 0025`_, their source record uses: * ``distribution`` = ```` — a sentinel value that is an invalid Python package name, guaranteeing no collision with any installed distribution. -* ``module`` = ``null`` — filesystem sources have no owning Python module, and using the absolute path would be inconsistent with the field's semantics elsewhere in the model. +* ``module`` = the absolute filesystem path of the schema file (e.g. ``/openedx/config/authz-schema.yml``). Filesystem sources have no owning Python module, but reusing the path here keeps the ``(distribution, module)`` unique constraint enforceable and avoids the ``NULL``-handling complications that a ``null`` value would introduce across the ORM, migrations, and source-identity logic. * ``resource_path`` = the absolute filesystem path of the schema file (e.g. ``/openedx/config/authz-schema.yml``). * ``distribution_version`` = ``0.0.0`` — a sentinel value, since filesystem sources carry no package version. diff --git a/src/openedx_authz/engine/schema/discovery.py b/src/openedx_authz/engine/schema/discovery.py index 830bd817..f68e41ff 100644 --- a/src/openedx_authz/engine/schema/discovery.py +++ b/src/openedx_authz/engine/schema/discovery.py @@ -1,7 +1,7 @@ """Discover static authz schema resources (the ``discover`` step, ADR 0019). -Providers register **directories** (not individual files); the loader reads -every ``.yaml`` file inside them. Two contribution sources are merged: +Providers register **directories** of ``.yaml`` files, or individual absolute +filesystem paths. Three contribution sources are merged: 1. The ``authz.schema`` entry-point group. Each registered callable returns directory paths in the package-anchored format below (e.g. @@ -9,6 +9,10 @@ 2. The ``OPENEDX_AUTHZ_SCHEMA_DIRECTORIES`` Django setting, a list of directory path strings in the same format. This lets operators and CI contribute directories without shipping a package entry point. +3. The ``OPENEDX_AUTHZ_SCHEMA_FILES`` Django setting, a list of absolute + filesystem paths each naming one schema file (ADR 0030). This is the route + used by the Tutor ``openedx-authz-schema`` patch to feed a rendered file + into discovery without anchoring it on a Python package. Directory format: these are **not** filesystem paths (neither relative nor absolute). Each is a package-anchored ``importlib.resources`` path: the first @@ -36,12 +40,15 @@ from dataclasses import dataclass from enum import StrEnum from importlib import metadata, resources +from pathlib import Path from django.conf import settings from django.core.exceptions import ImproperlyConfigured ENTRY_POINT_GROUP = "authz.schema" SETTINGS_DIRECTORIES_NAME = "OPENEDX_AUTHZ_SCHEMA_DIRECTORIES" +SETTINGS_FILE_SENTINEL = "" +SETTINGS_FILE_VERSION = "0.0.0" SCHEMA_FILE_SUFFIXES = (".yaml", ".yml") logger = logging.getLogger(__name__) @@ -101,6 +108,45 @@ def read_bytes(self) -> bytes: ) from exc +@dataclass(frozen=True) +class DiscoveredFileResource(DiscoveredResource): + """A schema file discovered via an absolute filesystem path (ADR 0030). + + Unlike :class:`DiscoveredResource`, which resolves through + ``importlib.resources``, this variant reads directly from the filesystem. + Fields are populated with sentinel values: ``package`` is + :data:`SETTINGS_FILE_SENTINEL` and both ``module`` and ``resource_path`` + hold the absolute path. + """ + + @classmethod + def from_path(cls, file_path: str) -> DiscoveredFileResource: + """Build a resource from an absolute filesystem path. + + Sentinel values are used for ``package`` and ``module`` because the + file is not anchored on any Python package. + """ + return cls( + package=SETTINGS_FILE_SENTINEL, + resource_path=file_path, + module=file_path, + origin=Origin.SETTINGS, + ) + + def read_bytes(self) -> bytes: + """Read the file directly from the filesystem via :class:`pathlib.Path`. + + Raises: + SchemaDiscoveryError: If the file cannot be read. + """ + try: + return Path(self.resource_path).read_bytes() + except OSError as exc: + raise SchemaDiscoveryError( + f"Could not read schema file {self.resource_path!r}: {exc}" + ) from exc + + class SchemaDiscoveryError(Exception): """Raised when a provider fails or a declared directory cannot be read.""" @@ -139,6 +185,7 @@ def discover(self) -> list[DiscoveredResource]: found: list[DiscoveredResource] = [] found.extend(self._discover_entry_points()) found.extend(self._discover_settings_directories()) + found.extend(self._discover_settings_files()) for directory in self._passed_in_directories: found.extend(self._iter_directory(directory, origin=Origin.PASSED_IN)) @@ -184,6 +231,48 @@ def _discover_settings_directories(self) -> list[DiscoveredResource]: discovered.extend(self._iter_directory(directory, origin=Origin.SETTINGS)) return discovered + def _discover_settings_files(self) -> list[DiscoveredResource]: + """Read ``OPENEDX_AUTHZ_SCHEMA_FILES`` from Django settings (ADR 0030). + + Each item is an absolute filesystem path to a single schema file. + Unlike ``_discover_settings_directories``, every listed path must exist + and have a supported extension; a missing or misnamed file is treated + as a misconfiguration and raises ``SchemaDiscoveryError``. + + Absent, empty, or unconfigured settings yield nothing. As with + ``_discover_settings_directories``, ``ImproperlyConfigured`` degrades + to no contribution so CI can run outside a Django process. + """ + try: + file_paths = getattr(settings, "OPENEDX_AUTHZ_SCHEMA_FILES", None) or [] + except ImproperlyConfigured: + return [] + if not isinstance(file_paths, list): + raise SchemaDiscoveryError( + "OPENEDX_AUTHZ_SCHEMA_FILES must be a list of filesystem paths, " + f"got {type(file_paths).__name__!r}." + ) + discovered: list[DiscoveredResource] = [] + for file_path in file_paths: + if not file_path.endswith(SCHEMA_FILE_SUFFIXES): + raise SchemaDiscoveryError( + f"Schema file {file_path!r} contributed through " + "OPENEDX_AUTHZ_SCHEMA_FILES has an unsupported file extension, " + f"accepted extensions: {SCHEMA_FILE_SUFFIXES}" + ) + + path = Path(file_path) + if not path.is_file(): + raise SchemaDiscoveryError( + f"Schema file {file_path!r} contributed through " + "OPENEDX_AUTHZ_SCHEMA_FILES is not an actual file" + ) + + discovered.append( + DiscoveredFileResource.from_path(file_path) + ) + return discovered + def _iter_directory(self, directory: str, *, origin: Origin) -> list[DiscoveredResource]: """Resolve a directory path and return one resource per ``.yaml`` file. diff --git a/src/openedx_authz/engine/schema/parsing.py b/src/openedx_authz/engine/schema/parsing.py index e8703b8c..0c6b8066 100644 --- a/src/openedx_authz/engine/schema/parsing.py +++ b/src/openedx_authz/engine/schema/parsing.py @@ -17,9 +17,13 @@ import yaml -from openedx_authz.engine.schema.discovery import DiscoveredResource +from openedx_authz.engine.schema.discovery import ( + SETTINGS_FILE_VERSION, + DiscoveredFileResource, + DiscoveredResource, +) from openedx_authz.engine.schema.exceptions import SchemaLoadError -from openedx_authz.engine.schema.types import ParsedSchemaDocument, SourceRecord +from openedx_authz.engine.schema.types import ParsedSchemaDocument, SourceFileRecord, SourceRecord logger = logging.getLogger(__name__) @@ -42,17 +46,19 @@ def parse(self, resources: list[DiscoveredResource]) -> list[ParsedSchemaDocumen documents = [] for resource in resources: contents = resource.read_bytes() - data = self.parse_yaml(contents, resource) - schema_version = str(data.get("schema_version", "")) if isinstance(data, dict) else "" - source = self.build_source_record(resource, contents, schema_version) - documents.append(ParsedSchemaDocument(source=source, data=data)) + for data in self.parse_yamls(contents, resource): + schema_version = str(data.get("schema_version", "")) if isinstance(data, dict) else "" + source = self.build_source_record(resource, contents, schema_version) + documents.append(ParsedSchemaDocument(source=source, data=data)) return documents @staticmethod - def parse_yaml(contents: bytes, resource: DiscoveredResource) -> object: - """Parse YAML bytes and preserve the resulting root value.""" + def parse_yamls(contents: bytes, resource: DiscoveredResource) -> list[object]: + """Parse YAML bytes as a multi-document stream, skipping empty + documents, and preserve the resulting root value. + """ try: - return yaml.safe_load(contents) + return [doc for doc in yaml.safe_load_all(contents) if doc is not None] except yaml.YAMLError as exc: raise SchemaLoadError(f"Invalid YAML in {resource.package}:{resource.resource_path}: {exc}") from exc @@ -66,14 +72,17 @@ def build_source_record(self, resource: DiscoveredResource, contents: bytes, sch """ distribution, version = self.resolve_distribution(resource) content_digest = hashlib.sha256(contents).hexdigest() - return SourceRecord( - distribution=distribution, - distribution_version=version, - module=resource.module, - resource_path=resource.resource_path, - schema_version=schema_version, - content_digest=content_digest, - ) + source_record = { + 'distribution': distribution, + 'distribution_version': version, + 'module': resource.module, + 'resource_path': resource.resource_path, + 'schema_version': schema_version, + 'content_digest': content_digest, + } + if isinstance(resource, DiscoveredFileResource): + return SourceFileRecord(**source_record) + return SourceRecord(**source_record) @classmethod def resolve_distribution(cls, resource: DiscoveredResource) -> tuple[str, str]: @@ -88,6 +97,8 @@ def resolve_distribution(cls, resource: DiscoveredResource) -> tuple[str, str]: the one that actually ships this resource's file, and only fall back to a deterministic (sorted) choice when no single owner can be identified. """ + if isinstance(resource, DiscoveredFileResource): + return resource.package, SETTINGS_FILE_VERSION top_level = resource.package.split(".", 1)[0] try: mapping = metadata.packages_distributions() diff --git a/src/openedx_authz/engine/schema/types/__init__.py b/src/openedx_authz/engine/schema/types/__init__.py index 6990ec49..62c832a8 100644 --- a/src/openedx_authz/engine/schema/types/__init__.py +++ b/src/openedx_authz/engine/schema/types/__init__.py @@ -37,6 +37,7 @@ from openedx_authz.engine.schema.types.loading import ( ParsedSchemaDocument, SchemaDocument, + SourceFileRecord, SourceRecord, ) @@ -49,6 +50,7 @@ # loading "SourceRecord", "ParsedSchemaDocument", + "SourceFileRecord", "SchemaDocument", # compilation "RelationshipSource", diff --git a/src/openedx_authz/engine/schema/types/loading.py b/src/openedx_authz/engine/schema/types/loading.py index 92c495fc..23ed7271 100644 --- a/src/openedx_authz/engine/schema/types/loading.py +++ b/src/openedx_authz/engine/schema/types/loading.py @@ -60,6 +60,22 @@ def source_id(self) -> str: return f"{self.distribution}:{module_path}/{filename}" +@dataclass(frozen=True) +class SourceFileRecord(SourceRecord): + """Source record for a filesystem-path schema resource (ADR 0030). + + Overrides :attr:`source_id` to use the absolute path directly, since the + parent's ``module.replace(".", "/")`` convention assumes dotted Python + module paths and would corrupt a filesystem path containing a file + extension. + """ + + @property + def source_id(self) -> str: + """Return ``":"``.""" + return f"{self.distribution}:{self.resource_path}" + + @dataclass(frozen=True) class ParsedSchemaDocument: """One parsed YAML value and the provenance of the resource that supplied it.""" diff --git a/src/openedx_authz/tests/schema/test_discovery.py b/src/openedx_authz/tests/schema/test_discovery.py index 9cafdb60..88038f7f 100644 --- a/src/openedx_authz/tests/schema/test_discovery.py +++ b/src/openedx_authz/tests/schema/test_discovery.py @@ -5,6 +5,7 @@ * ``TestDirectoryExpansion`` — a contributed directory expands to its YAML files. * ``TestSettingsDirectories`` — the operator/Tutor settings contribution route. +* ``TestSettingsFiles`` — the filesystem-path contribution route (ADR 0030). * ``TestDiscoverySourcePrecedence`` — how sources merge and de-duplicate. * ``TestDiscoveryErrors`` — every failure surfaces as ``SchemaDiscoveryError``. * ``TestSchemaFileSelection`` — only YAML *files* are picked up. @@ -15,6 +16,8 @@ from django.test import override_settings from openedx_authz.engine.schema.discovery import ( + SETTINGS_FILE_SENTINEL, + DiscoveredFileResource, DiscoveredResource, Origin, SchemaDiscovery, @@ -159,6 +162,136 @@ def _unconfigured(_self, name): assert not SchemaDiscovery()._discover_settings_directories() +class TestSettingsFiles: + """The filesystem-path contribution route (ADR 0030). + + Tutor renders patch content into a YAML file and lists its absolute path + in ``OPENEDX_AUTHZ_SCHEMA_FILES``. These tests exercise + ``_discover_settings_files`` and ``DiscoveredFileResource`` in isolation. + """ + + @override_settings(OPENEDX_AUTHZ_SCHEMA_FILES=["/tmp/nonexistent/authz-schema.yaml"]) + def test_nonexistent_file_raises(self): + """An explicitly listed file that does not exist is a misconfiguration.""" + with pytest.raises(SchemaDiscoveryError, match="is not an actual file"): + SchemaDiscovery().discover() + + @override_settings(OPENEDX_AUTHZ_SCHEMA_FILES=["/tmp/authz-schema.txt"]) + def test_unsupported_extension_raises(self): + """A file with an unsupported extension is rejected even if it exists.""" + with pytest.raises(SchemaDiscoveryError, match="unsupported file extension"): + SchemaDiscovery().discover() + + def test_settings_file_is_discovered(self, tmp_path): + """A valid YAML file listed in the setting is discovered and readable.""" + schema_file = tmp_path / "authz-schema.yaml" + schema_file.write_text("schema_version: '1.0'\npriority: 100\n", encoding="utf-8") + + with self._override_files([str(schema_file)]): + resources = SchemaDiscovery().discover() + + file_resources = [r for r in resources if isinstance(r, DiscoveredFileResource)] + assert len(file_resources) == 1 + assert file_resources[0].resource_path == str(schema_file) + assert file_resources[0].package == SETTINGS_FILE_SENTINEL + assert file_resources[0].origin == Origin.SETTINGS + + def test_contents_are_readable(self, tmp_path): + """A discovered file resource returns the file's bytes.""" + schema_file = tmp_path / "roles.yml" + schema_file.write_text("schema_version: '1.0'\n", encoding="utf-8") + + with self._override_files([str(schema_file)]): + resources = SchemaDiscovery().discover() + + file_resources = [r for r in resources if isinstance(r, DiscoveredFileResource)] + assert b"schema_version" in file_resources[0].read_bytes() + + def test_multiple_files_are_discovered(self, tmp_path): + """Multiple listed files are all discovered.""" + file_a = tmp_path / "a.yaml" + file_b = tmp_path / "b.yml" + file_a.write_text("schema_version: '1.0'\n", encoding="utf-8") + file_b.write_text("schema_version: '1.0'\n", encoding="utf-8") + + with self._override_files([str(file_a), str(file_b)]): + resources = SchemaDiscovery().discover() + + file_resources = [r for r in resources if isinstance(r, DiscoveredFileResource)] + assert len(file_resources) == 2 + + def test_yml_and_yaml_extensions_are_accepted(self, tmp_path): + """Both ``.yml`` and ``.yaml`` suffixes are valid.""" + for name in ("a.yml", "b.yaml"): + (tmp_path / name).write_text("schema_version: '1.0'\n", encoding="utf-8") + + with self._override_files([str(tmp_path / "a.yml"), str(tmp_path / "b.yaml")]): + resources = SchemaDiscovery().discover() + + file_resources = [r for r in resources if isinstance(r, DiscoveredFileResource)] + assert len(file_resources) == 2 + + def test_absent_setting_contributes_nothing(self): + """The default state: no deployment has declared the setting at all.""" + # pylint: disable=protected-access + assert not SchemaDiscovery()._discover_settings_files() + + @override_settings(OPENEDX_AUTHZ_SCHEMA_FILES=[]) + def test_empty_setting_contributes_nothing(self): + """An empty list is a no-op, not an error.""" + # pylint: disable=protected-access + assert not SchemaDiscovery()._discover_settings_files() + + @override_settings(OPENEDX_AUTHZ_SCHEMA_FILES=None) + def test_none_setting_contributes_nothing(self): + """An explicit ``None`` degrades to no contribution.""" + # pylint: disable=protected-access + assert not SchemaDiscovery()._discover_settings_files() + + @override_settings(OPENEDX_AUTHZ_SCHEMA_FILES="/etc/authz/schema.yaml") + def test_non_list_setting_raises(self): + """A bare string instead of a list is rejected as a misconfiguration.""" + with pytest.raises(SchemaDiscoveryError, match="must be a list"): + SchemaDiscovery().discover() + + def test_unconfigured_django_contributes_nothing(self, monkeypatch): + """``ImproperlyConfigured`` degrades to no contribution.""" + # pylint: disable=import-outside-toplevel + from django.conf import LazySettings + from django.core.exceptions import ImproperlyConfigured + + def _unconfigured(_self, name): + raise ImproperlyConfigured(f"Requested setting {name}, but settings are not configured") + + monkeypatch.setattr(LazySettings, "__getattr__", _unconfigured) + + # pylint: disable=protected-access + assert not SchemaDiscovery()._discover_settings_files() + + def test_file_resource_is_marked_with_settings_origin(self, tmp_path): + """``origin`` identifies the settings route.""" + schema_file = tmp_path / "authz.yaml" + schema_file.write_text("schema_version: '1.0'\n", encoding="utf-8") + + with self._override_files([str(schema_file)]): + # pylint: disable=protected-access + resources = SchemaDiscovery()._discover_settings_files() + + assert {r.origin for r in resources} == {Origin.SETTINGS} + + def test_unreadable_file_resource_raises(self, tmp_path): + """Reading a file that was removed after discovery raises ``SchemaDiscoveryError``.""" + resource = DiscoveredFileResource.from_path(str(tmp_path / "gone.yaml")) + + with pytest.raises(SchemaDiscoveryError, match="Could not read schema file"): + resource.read_bytes() + + @staticmethod + def _override_files(paths): + """Convenience wrapper for ``override_settings(OPENEDX_AUTHZ_SCHEMA_FILES=...)``.""" + return override_settings(OPENEDX_AUTHZ_SCHEMA_FILES=paths) + + class TestDiscoverySourcePrecedence: """Discovery merges sources in a fixed order and de-duplicates first-wins.""" diff --git a/src/openedx_authz/tests/schema/test_loading.py b/src/openedx_authz/tests/schema/test_loading.py index f31b4417..ae9953fe 100644 --- a/src/openedx_authz/tests/schema/test_loading.py +++ b/src/openedx_authz/tests/schema/test_loading.py @@ -5,10 +5,18 @@ import pytest -from openedx_authz.engine.schema.discovery import DiscoveredResource, Origin, SchemaDiscovery +from openedx_authz.engine.schema.discovery import ( + SETTINGS_FILE_SENTINEL, + SETTINGS_FILE_VERSION, + DiscoveredFileResource, + DiscoveredResource, + Origin, + SchemaDiscovery, +) from openedx_authz.engine.schema.exceptions import SchemaLoadError from openedx_authz.engine.schema.loading import SchemaLoader from openedx_authz.engine.schema.parsing import UNKNOWN_DISTRIBUTION, SchemaParser +from openedx_authz.engine.schema.types import SourceFileRecord from .factories import InMemoryResource @@ -106,10 +114,15 @@ def test_empty_document_yields_empty_blocks(self): assert docs[0].categories == [] assert docs[0].roles == [] - def test_completely_empty_file_cannot_be_loaded_as_a_typed_document(self): - """An empty root must pass structural validation before typed loading.""" - with pytest.raises(SchemaLoadError, match="must be a mapping"): - _load(b"") + def test_completely_empty_file_yields_no_documents(self): + """An empty file parses to no YAML documents and yields an empty list. + + With ``safe_load_all``, an empty stream produces no documents (ADR 0030: + empty documents are skipped silently). Validation is not reached. + """ + docs = _load(b"") + + assert not docs def test_invalid_yaml_raises_load_error(self): """Malformed YAML surfaces as ``SchemaLoadError``.""" @@ -619,3 +632,152 @@ def test_dedupe_key_includes_selected_distribution( assert result1 == result2 == "dist1" # Only one log record because the warn_key is identical assert len(caplog.records) == 1 + + +class TestMultiDocumentStreams: + """Multi-document YAML loading (ADR 0030). + + A single schema file may contain multiple ``---``-separated YAML documents, + each a complete, independent contribution with its own ``schema_version`` + and ``priority``. This is how Tutor concatenates several plugin + contributions into one rendered file. + """ + + MULTI_DOC = b""" +schema_version: '1.0' +priority: 200 + +role_extensions: + - role_id: course_editor + add_permissions: [courses.export_course] +--- +schema_version: '1.0' +priority: 100 + +role_extensions: + - role_id: course_editor + remove_permissions: [courses.manage_tags] +""" + + def test_multi_document_stream_yields_multiple_documents(self): + """Two ``---``-separated documents yield two :class:`SchemaDocument` objects.""" + docs = _load(self.MULTI_DOC) + + assert len(docs) == 2 + assert docs[0].priority == 200 + assert docs[1].priority == 100 + + def test_each_document_has_its_own_schema_version(self): + """Each document carries its own ``schema_version``.""" + docs = _load(self.MULTI_DOC) + + assert docs[0].source.schema_version == "1.0" + assert docs[1].source.schema_version == "1.0" + + def test_each_document_has_independent_extensions(self): + """Extensions from separate documents stay separate.""" + docs = _load(self.MULTI_DOC) + + assert docs[0].role_extensions[0].add_permissions == ("courses.export_course",) + assert docs[1].role_extensions[0].remove_permissions == ("courses.manage_tags",) + + def test_trailing_separator_is_ignored(self): + """A trailing ``---`` produces a ``None`` document that is skipped.""" + contents = b"schema_version: '1.0'\npriority: 1\n---\n" + + docs = _load(contents) + + assert len(docs) == 1 + assert docs[0].priority == 1 + + def test_empty_document_between_separators_is_skipped(self): + """An empty ``---`` block between contributions is silently dropped.""" + contents = ( + b"schema_version: '1.0'\npriority: 1\n" + b"---\n" + b"---\n" + b"schema_version: '1.0'\npriority: 2\n" + ) + + docs = _load(contents) + + assert len(docs) == 2 + assert docs[0].priority == 1 + assert docs[1].priority == 2 + + def test_comment_only_document_is_skipped(self): + """A document consisting solely of comments parses as ``None`` and is skipped.""" + contents = b"# Just a comment\n---\nschema_version: '1.0'\npriority: 1\n" + + docs = _load(contents) + + assert len(docs) == 1 + assert docs[0].priority == 1 + + def test_non_mapping_document_in_stream_raises(self): + """A non-mapping document embedded in a stream raises ``SchemaLoadError``.""" + contents = b"schema_version: '1.0'\npriority: 1\n---\n- just\n- a\n- list\n" + + with pytest.raises(SchemaLoadError, match="schema document must be a mapping"): + _load(contents) + + def test_all_documents_share_the_same_content_digest(self): + """The content digest is per-resource (file), not per-document. + + Multiple documents from the same file share the same digest since it is + computed from the raw file bytes. + """ + docs = _load(self.MULTI_DOC) + + assert docs[0].source.content_digest == docs[1].source.content_digest + + +class TestFileSourceIdentity: + """Source identity for filesystem-path resources (ADR 0030). + + Filesystem resources use sentinel values for distribution and version, + and ``SourceFileRecord`` overrides ``source_id`` to avoid garbling the + absolute path. + """ + + @staticmethod + def _load_file(tmp_path, contents: bytes = b"schema_version: '1.0'\npriority: 1\n"): + """Write a temp schema file, discover it, and load it.""" + schema_file = tmp_path / "authz-schema.yaml" + schema_file.write_bytes(contents) + resource = DiscoveredFileResource.from_path(str(schema_file)) + parsed_documents = SchemaParser().parse([resource]) + return SchemaLoader().load(parsed_documents) + + def test_distribution_is_the_sentinel(self, tmp_path): + """Filesystem resources use the ```` sentinel as distribution.""" + docs = self._load_file(tmp_path) + + assert docs[0].source.distribution == SETTINGS_FILE_SENTINEL + + def test_distribution_version_is_the_sentinel(self, tmp_path): + """Filesystem resources use ``0.0.0`` as their version sentinel.""" + docs = self._load_file(tmp_path) + + assert docs[0].source.distribution_version == SETTINGS_FILE_VERSION + + def test_source_id_uses_the_absolute_path(self, tmp_path): + """``source_id`` is ``":"`` — no dot corruption.""" + docs = self._load_file(tmp_path) + expected_path = str(tmp_path / "authz-schema.yaml") + + assert docs[0].source.source_id == f"{SETTINGS_FILE_SENTINEL}:{expected_path}" + + def test_source_record_is_a_source_file_record(self, tmp_path): + """The loader produces a ``SourceFileRecord`` for filesystem resources.""" + docs = self._load_file(tmp_path) + + assert isinstance(docs[0].source, SourceFileRecord) + + def test_module_and_resource_path_are_the_absolute_path(self, tmp_path): + """Both ``module`` and ``resource_path`` record the absolute filesystem path.""" + docs = self._load_file(tmp_path) + expected_path = str(tmp_path / "authz-schema.yaml") + + assert docs[0].source.module == expected_path + assert docs[0].source.resource_path == expected_path diff --git a/src/openedx_authz/tests/schema/test_parsing.py b/src/openedx_authz/tests/schema/test_parsing.py index 62f44d52..abeff8e3 100644 --- a/src/openedx_authz/tests/schema/test_parsing.py +++ b/src/openedx_authz/tests/schema/test_parsing.py @@ -15,7 +15,6 @@ ("contents", "expected"), [ (b"schema_version: '1.0'\npriority: 10\n", {"schema_version": "1.0", "priority": 10}), - (b"", None), (b"value", "value"), (b"- first\n- second\n", ["first", "second"]), ], diff --git a/tutor/tutor-contrib-authz/.gitignore b/tutor/tutor-contrib-authz/.gitignore new file mode 100644 index 00000000..f6a874f2 --- /dev/null +++ b/tutor/tutor-contrib-authz/.gitignore @@ -0,0 +1,7 @@ +.*.swp +!.gitignore +TODO +__pycache__ +*.egg-info/ +/build/ +/dist/ diff --git a/tutor/tutor-contrib-authz/LICENSE.txt b/tutor/tutor-contrib-authz/LICENSE.txt new file mode 100644 index 00000000..aec27c83 --- /dev/null +++ b/tutor/tutor-contrib-authz/LICENSE.txt @@ -0,0 +1,662 @@ + + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. \ No newline at end of file diff --git a/tutor/tutor-contrib-authz/MANIFEST.in b/tutor/tutor-contrib-authz/MANIFEST.in new file mode 100644 index 00000000..1cc4203d --- /dev/null +++ b/tutor/tutor-contrib-authz/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include tutor_authz/patches * +recursive-include tutor_authz/templates * diff --git a/tutor/tutor-contrib-authz/Makefile b/tutor/tutor-contrib-authz/Makefile new file mode 100644 index 00000000..b4f74003 --- /dev/null +++ b/tutor/tutor-contrib-authz/Makefile @@ -0,0 +1,30 @@ +.DEFAULT_GOAL := help +.PHONY: docs +SRC_DIRS = ./tutor_authz + +# Warning: These checks are not necessarily run on every PR. +test: test-lint test-types test-format # Run some static checks. + +test-format: ## Run code formatting tests + ruff format --check --diff ${SRC_DIRS} + +test-lint: ## Run code linting tests + ruff check ${SRC_DIRS} + +test-types: ## Run type checks. + mypy --exclude=templates --ignore-missing-imports --implicit-reexport --strict ${SRC_DIRS} + +format: ## Format code + ruff format ${SRC_DIRS} + +fix-lint: ## Fix lint errors automatically + ruff check --fix ${SRC_DIRS} + +version: ## Print the current tutor-contrib-authz version + @python -c 'import io, os; about = {}; exec(io.open(os.path.join("tutor_authz", "__about__.py"), "rt", encoding="utf-8").read(), about); print(about["__version__"])' + +ESCAPE =  +help: ## Print this help + @grep -E '^([a-zA-Z_-]+:.*?## .*|######* .+)$$' Makefile \ + | sed 's/######* \(.*\)/@ $(ESCAPE)[1;31m\1$(ESCAPE)[0m/g' | tr '@' '\n' \ + | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}' diff --git a/tutor/tutor-contrib-authz/README.rst b/tutor/tutor-contrib-authz/README.rst new file mode 100644 index 00000000..4d2b1eb8 --- /dev/null +++ b/tutor/tutor-contrib-authz/README.rst @@ -0,0 +1,80 @@ +authz plugin for `Tutor `__ +####################################################### + +Introduction +============ + +This plugin creates a new Tutor patch point (``openedx-authz-schema``) that lets other plugins contribute authorization schema YAML fragments. All contributions are combined into a single multi-document YAML file and mounted into the LMS/CMS containers at ``/openedx/config/authz-schema.yml``. + +A Django setting ``OPENEDX_AUTHZ_SCHEMA_FILES`` is added to ``openedx-common-settings`` so that the ``load_authz_schema`` management command knows where to find the schema files at initialisation time. + +Installation +************ + +.. code-block:: bash + + git clone https://github.com/openedx/openedx-tutor-plugins.git + cd openedx-tutor-plugins/plugins/tutor-contrib-authz + pip install -e . + +Usage +***** + +.. code-block:: bash + + tutor plugins enable authz + + +Contribute an Authorization Schema +*********************************** + +1. Create a tutor plugin: + +.. code-block:: bash + + touch $(tutor config printroot)-plugins/my_authz_schema.py + +2. Use the patch ``openedx-authz-schema`` to contribute your authz schema: + +.. code-block:: python + + from tutor import hooks + + hooks.Filters.ENV_PATCHES.add_item( + ( + "openedx-authz-schema", + """ + schema_version: "1.0" + priority: 100 + + role_extensions: + - role: course_editor + add_permissions: + - courses.export_course + remove_permissions: + - courses.manage_tags + display_name: Course author + description: Creates and exports course content for this site. + + - role: course_auditor + hidden: true + """, + ) + ) + +3. Run do init commands: + +.. code-block:: bash + + tutor {dev|local|k8s} do init + +4. Alternatively, instead of running the do init commands, you can run the following management command for your schemas to be loaded: + +.. code-block:: bash + + tutor {dev|local|k8s} exec {cms|lms} ./manage.py load_authz_schema + +License +******* + +This software is licensed under the terms of the AGPLv3. diff --git a/tutor/tutor-contrib-authz/pyproject.toml b/tutor/tutor-contrib-authz/pyproject.toml new file mode 100644 index 00000000..30fcfbc4 --- /dev/null +++ b/tutor/tutor-contrib-authz/pyproject.toml @@ -0,0 +1,65 @@ +# https://packaging.python.org/en/latest/tutorials/packaging-projects/ +# https://hatch.pypa.io/latest/config/build/ + +[project] +name = "tutor-contrib-authz" +description = "authz plugin for Tutor" +authors = [ + { name = "Carlos Marquez"}, + { email = "carlos.marquez@wgu.edu" }, +] +license = { text = "AGPL-3.0-only" } + +readme = {file = "README.rst", content-type = "text/x-rst"} +requires-python = ">= 3.9" +classifiers = [ + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "License :: OSI Approved :: GNU Affero General Public License v3", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: Implementation :: CPython", + "Programming Language :: Python :: Implementation :: PyPy", + +] +dependencies = [ + "tutor>=23.0.0,<24.0.0", +] + +# These fields will be set by hatch_build.py +dynamic = ["version"] + +[project.optional-dependencies] +dev = [ + "tutor[dev]>=23.0.0,<24.0.0", + "ruff", +] + +[tool.hatch.version] +path = "tutor_authz/__about__.py" + +# https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels +[project.urls] +Documentation = "https://github.com/openedx/openedx-tutor-plugins#readme" +Issues = "https://github.com/openedx/openedx-tutor-plugins/issues" +Source = "https://github.com/openedx/openedx-tutor-plugins" + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[tool.hatch.build.targets.wheel] +packages = ["tutor_authz"] + +[tool.hatch.build.targets.sdist] +# Disable strict naming, otherwise twine is not able to detect name/version +strict-naming = false +include = [ "/tutor_authz"] +exclude = ["tests*"] + +[project.entry-points."tutor.plugin.v1"] +authz = "tutor_authz.plugin" diff --git a/tutor/tutor-contrib-authz/tutor_authz/__about__.py b/tutor/tutor-contrib-authz/tutor_authz/__about__.py new file mode 100644 index 00000000..795a28ed --- /dev/null +++ b/tutor/tutor-contrib-authz/tutor_authz/__about__.py @@ -0,0 +1 @@ +__version__ = "23.0.0" diff --git a/tutor/tutor-contrib-authz/tutor_authz/__init__.py b/tutor/tutor-contrib-authz/tutor_authz/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/tutor/tutor-contrib-authz/tutor_authz/patches/openedx-common-settings b/tutor/tutor-contrib-authz/tutor_authz/patches/openedx-common-settings new file mode 100644 index 00000000..e510fdb6 --- /dev/null +++ b/tutor/tutor-contrib-authz/tutor_authz/patches/openedx-common-settings @@ -0,0 +1,2 @@ +# Allows authorization schema discovery for filesystem files +OPENEDX_AUTHZ_SCHEMA_FILES = ["/openedx/config/authz-schema.yml"] \ No newline at end of file diff --git a/tutor/tutor-contrib-authz/tutor_authz/plugin.py b/tutor/tutor-contrib-authz/tutor_authz/plugin.py new file mode 100644 index 00000000..ef146596 --- /dev/null +++ b/tutor/tutor-contrib-authz/tutor_authz/plugin.py @@ -0,0 +1,222 @@ +import os +from glob import glob + +import importlib_resources +from tutor import hooks + +from .__about__ import __version__ + +######################################## +# CONFIGURATION +######################################## + +hooks.Filters.CONFIG_DEFAULTS.add_items( + [ + # Add your new settings that have default values here. + # Each new setting is a pair: (setting_name, default_value). + # Prefix your setting names with 'AUTHZ_'. + ("AUTHZ_VERSION", __version__), + ] +) + +hooks.Filters.CONFIG_UNIQUE.add_items( + [ + # Add settings that don't have a reasonable default for all users here. + # For instance: passwords, secret keys, etc. + # Each new setting is a pair: (setting_name, unique_generated_value). + # Prefix your setting names with 'AUTHZ_'. + # For example: + ### ("AUTHZ_SECRET_KEY", "{{ 24|random_string }}"), + ] +) + +hooks.Filters.CONFIG_OVERRIDES.add_items( + [ + # Danger zone! + # Add values to override settings from Tutor core or other plugins here. + # Each override is a pair: (setting_name, new_value). For example: + ### ("PLATFORM_NAME", "My platform"), + ] +) + + +######################################## +# INITIALIZATION TASKS +######################################## + +# To add a custom initialization task, create a bash script template under: +# tutor_authz/templates/authz/tasks/ +# and then add it to the MY_INIT_TASKS list. Each task is in the format: +# ("", ("", "", "