Notebook: refactor blueprint business logic to core (#429)

The move of business logic out of the blueprint allows the code to
be reusable without having to go through the web API. It also allows
for tests to be added without the web complexity.

Tests have been refactored so that test clusters will be created only
when testing endpoints that actually require a cluster. This has the
advantage of speeding up test time. This is especially useful when
doing development.

Finally, a new test option has been added so one can use a local
cluster in place of re-creating one each time tests are run.

Author: sgaist

.gitignore

@@ -80,4 +80,10 @@ docker-compose.override.yml
 result
 *.qcow2
 
+# tests
 .k3d-config.yaml
+
+# Misc
+*.pem
+*.gz
+*.tgz

CONTRIBUTING.md

@@ -22,8 +22,7 @@ When reporting a bug, please include the following information:
 If you do not already have a development environment set up, you will probably find the [developer documentation](DEVELOPING.md) helpful.
 
 * Before submitting a pull request, please make sure you agree to the license and have submitted a signed [contributor license agreement](https://github.com/SwissDataScienceCenter/renku/wiki/Legal)
-* PRs should include a short, descriptive title. The titles will be used to compile changelogs for releases, so think about the title in that context. The title should be formatted using the [Conventional Commits](https://www.conventionalcommits.org/) style 
+* PRs should include a short, descriptive title. The titles will be used to compile changelogs for releases, so think about the title in that context. The title should be formatted using the [Conventional Commits](https://www.conventionalcommits.org/) style
 * Small improvements need not reference an issue, but PRs that introduce larger changes or add new functionality should refer to an issue
 * Structure your commits in meaningful units, each with an understandable purpose and coherent commit message. For example, if your proposed changes contain a refactoring and a new feature, make two PRs
 * Format commit messages using the [Conventional Commits](https://www.conventionalcommits.org/) style
-

components/renku_data_services/base_api/auth.py

@@ -71,6 +71,30 @@ async def decorated_function(request: Request, *args: _P.args, **kwargs: _P.kwar
     return decorator
 
 
+def validate_path_project_id(
+    f: Callable[Concatenate[Request, _P], Coroutine[Any, Any, _T]],
+) -> Callable[Concatenate[Request, _P], Coroutine[Any, Any, _T]]:
+    """Decorator for a Sanic handler that validates the project_id path parameter."""
+    _path_project_id_regex = re.compile(r"^[A-Za-z0-9]{26}$")
+
+    @wraps(f)
+    async def decorated_function(request: Request, *args: _P.args, **kwargs: _P.kwargs) -> _T:
+        project_id = cast(str | None, kwargs.get("project_id"))
+        if not project_id:
+            raise errors.ProgrammingError(
+                message="Could not find 'project_id' in the keyword arguments for the handler in order to validate it."
+            )
+        if not _path_project_id_regex.match(project_id):
+            raise errors.ValidationError(
+                message=f"The 'project_id' path parameter {project_id} does not match the required "
+                f"regex {_path_project_id_regex}"
+            )
+
+        return await f(request, *args, **kwargs)
+
+    return decorated_function
+
+
 def validate_path_user_id(
     f: Callable[Concatenate[Request, _P], Coroutine[Any, Any, _T]],
 ) -> Callable[Concatenate[Request, _P], Coroutine[Any, Any, _T]]:

components/renku_data_services/notebooks/api/classes/k8s_client.py

@@ -448,8 +448,8 @@ async def get_server_logs(
         # NOTE: this get_server ensures the user has access to the server without it you could read someone elses logs
         server = await self.get_server(server_name, safe_username)
         if not server:
-            raise MissingResourceError(
-                f"Cannot find server {server_name} for user " f"{safe_username} to retrieve logs."
+            raise errors.MissingResourceError(
+                message=f"Cannot find server {server_name} for user " f"{safe_username} to retrieve logs."
             )
         pod_name = f"{server_name}-0"
         return await self.renku_ns_client.get_pod_logs(pod_name, max_log_lines)
@@ -490,9 +490,10 @@ async def delete_server(self, server_name: str, safe_username: str) -> None:
         """Delete the server."""
         server = await self.get_server(server_name, safe_username)
         if not server:
-            return None
-        await self.renku_ns_client.delete_server(server_name)
-        return None
+            raise errors.MissingResourceError(
+                message=f"Cannot find server {server_name} for user " f"{safe_username} in order to delete it."
+            )
+        return await self.renku_ns_client.delete_server(server_name)
 
     async def patch_tokens(self, server_name: str, renku_tokens: RenkuTokens, gitlab_token: GitlabToken) -> None:
         """Patch the Renku and Gitlab access tokens used in a session."""