feat!: default importdemocourse to the new course & lib

changelog.d/20240110_101228_kyle_importnewdemocourse.md

@@ -0,0 +1,2 @@
+- 💥 [Feature] `tutor local do importdemocourse` will now import the new [Open edX Demo Course](https://github.com/openedx/openedx-demo-course), which has been rebuilt from scratch. If you wish to import the old demo course instead (which no longer receives updates), you can run: `tutor local do importdemocourse --repo-dir . --version open-release/palm.4`.
+- [Feature] The new command `tutor local do importdemolibrary` will import a Demo Content Library, which is an optional but helpful extension to the Open edX Demo Course.

tests/commands/test_jobs.py

@@ -38,7 +38,34 @@ def test_import_demo_course(self) -> None:
         self.assertEqual(0, result.exit_code)
         self.assertIn("cms-job", dc_args)
         self.assertIn(
-            "git clone https://github.com/openedx/edx-demo-course", dc_args[-1]
+            "git clone https://github.com/openedx/openedx-demo-course", dc_args[-1]
+        )
+
+    def test_import_demo_library(self) -> None:
+        with temporary_root() as root:
+            self.invoke_in_root(root, ["config", "save"])
+            with patch("tutor.utils.docker_compose") as mock_docker_compose:
+                result = self.invoke_in_root(
+                    root,
+                    [
+                        "local",
+                        "do",
+                        "importdemolibrary",
+                        "-t",
+                        "fake/path.tar.gz",
+                        "admin",
+                    ],
+                )
+                dc_args, _dc_kwargs = mock_docker_compose.call_args
+        self.assertIsNone(result.exception)
+        self.assertEqual(0, result.exit_code)
+        self.assertIn("cms-job", dc_args)
+        self.assertIn(
+            "git clone https://github.com/openedx/openedx-demo-course", dc_args[-1]
+        )
+        self.assertIn(
+            "./manage.py cms import_content_library /tmp/course/fake/path.tar.gz admin",
+            dc_args[-1],
         )
 
     def test_set_theme(self) -> None:

tutor/commands/jobs.py

@@ -124,14 +124,14 @@ def create_user_template(
 @click.option(
     "-r",
     "--repo",
-    default="https://github.com/openedx/edx-demo-course",
+    default="https://github.com/openedx/openedx-demo-course",
     show_default=True,
     help="Git repository that contains the course to be imported",
 )
 @click.option(
     "-d",
     "--repo-dir",
-    default="",
+    default="demo-course/course",
     show_default=True,
     help="Git relative subdirectory to import data from",
 )
@@ -154,6 +154,37 @@ def importdemocourse(
     yield ("cms", template)
 
 
+@click.command(help="Import the demo content library")
+@click.argument("owner_username")
+@click.option(
+    "-r",
+    "--repo",
+    default="https://github.com/openedx/openedx-demo-course",
+    show_default=True,
+    help="Git repository that contains the library to be imported",
+)
+@click.option(
+    "-t",
+    "--repo-tar-path",
+    default="dist/demo-content-library.tar.gz",
+    show_default=True,
+    help="Git relative .tar.gz path to import content library from",
+)
+@click.option(
+    "-v",
+    "--version",
+    help="Git branch, tag or sha1 identifier. If unspecified, will default to the value of the OPENEDX_COMMON_VERSION setting.",
+)
+def importdemolibrary(
+    owner_username: str, repo: str, repo_tar_path: str, version: t.Optional[str]
+) -> t.Iterable[tuple[str, str]]:
+    version = version or "{{ OPENEDX_COMMON_VERSION }}"
+    template = f"""
+git clone {repo} --branch {version} --depth 1 /tmp/course
+yes | ./manage.py cms import_content_library /tmp/course/{repo_tar_path} {owner_username}"""
+    yield ("cms", template)
+
+
 @click.command(
     name="print-edx-platform-setting",
     help="Print the value of an edx-platform Django setting.",
@@ -324,6 +355,7 @@ def do_callback(service_commands: t.Iterable[tuple[str, str]]) -> None:
     [
         createuser,
         importdemocourse,
+        importdemolibrary,
         initialise,
         print_edx_platform_setting,
         settheme,