6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2025-01-09 08:30:18 +00:00

feat: add patches show ... command

I found myself in a situation where I wasn't sure if a patch was
correctly added by the Indigo plugin. To troubleshoot that issue, I
wanted to print that rendered patch. I thought it would make a nice
addition to the CLI.
This commit is contained in:
Régis Behmo 2024-08-16 14:18:48 +02:00 committed by Régis Behmo
parent 46b401690c
commit 2959e6eec2
4 changed files with 19 additions and 3 deletions

View File

@ -0,0 +1 @@
- [Feature] Add a `patches show my-patch-name`. This is a convenient command for the troubleshooting of plugins. (by @regisb)

View File

@ -111,3 +111,8 @@ class PatchesTests(unittest.TestCase, TestCommandMixin):
result = self.invoke_in_root(root, ["config", "patches", "list"])
self.assertFalse(result.exception)
self.assertEqual(0, result.exit_code)
def test_config_patches_show(self) -> None:
result = self.invoke(["config", "patches", "show", "mypatch"])
self.assertEqual(0, result.exit_code)
self.assertEqual("", result.stdout)

View File

@ -230,8 +230,20 @@ def patches_list(context: Context) -> None:
renderer.print_patches_locations()
@click.command(name="show", help="Print the rendered contents of a template patch")
@click.argument("name")
@click.pass_obj
def patches_show(context: Context, name: str) -> None:
config = tutor_config.load_full(context.root)
renderer = env.Renderer(config)
rendered = renderer.patch(name)
if rendered:
print(rendered)
config_command.add_command(save)
config_command.add_command(printroot)
config_command.add_command(printvalue)
patches_command.add_command(patches_list)
patches_command.add_command(patches_show)
config_command.add_command(patches_command)

View File

@ -4,12 +4,10 @@ Provide API for plugin features.
from __future__ import annotations
import functools
import typing as t
from copy import deepcopy
from tutor import exceptions, fmt, hooks
from tutor.types import Config, get_typed
from tutor.types import Config
# Import modules to trigger hook creation
from . import openedx, v0, v1