Add task for downloading membrane demos #1067
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| defmodule Mix.Tasks.Membrane.Demo do | ||
| @shortdoc "Download Membrane demos and examples" | ||
| @moduledoc """ | ||
| Download Membrane demos and examples. Requires `git` installed. | ||
|
|
||
| $ mix membrane.demo [-a] [-l] [-d <repo_dir>] [<demos> ...] | ||
|
|
||
| ## Options | ||
| * `-l, --list` - List all demos available and their brief descriptions. | ||
| * `-a, --all` - Pull the repository with all demos. | ||
| * `-d, --directory` - Specify a directory where the demos should be placed in. By default they're placed in the current working directory | ||
| """ | ||
| use Mix.Task | ||
|
|
||
| @switches [ | ||
| list: :boolean, | ||
| all: :boolean, | ||
| directory: :string | ||
| ] | ||
|
|
||
| @aliases [ | ||
| l: :list, | ||
| a: :all, | ||
| d: :directory | ||
| ] | ||
|
|
||
| @demos_search_list [".", "livebooks"] | ||
|
|
||
| @demos_readme_url "https://raw.githubusercontent.com/membraneframework/membrane_demo/refs/heads/master/README.md" | ||
| @demos_clone_url "https://github.com/membraneframework/membrane_demo.git" | ||
|
|
||
| @impl true | ||
| def run([]) do | ||
| Mix.Tasks.Help.run(["membrane.demo"]) | ||
| end | ||
|
|
||
| def run(argv) do | ||
| {opts, demos_names} = OptionParser.parse!(argv, aliases: @aliases, switches: @switches) | ||
|
|
||
| if opts[:list] do | ||
| list_available_demos() | ||
| end | ||
|
|
||
| target_dir = Path.expand(opts[:directory] || ".") | ||
|
|
||
| cond do | ||
| opts[:all] -> copy_all_demos(target_dir) | ||
| demos_names != [] -> copy_specific_demos(target_dir, demos_names) | ||
| true -> :ok | ||
| end | ||
| end | ||
|
|
||
| defp list_available_demos() do | ||
| {:ok, _apps} = Application.ensure_all_started(:req) | ||
| response = Req.get!(@demos_readme_url) | ||
|
|
||
| demos_info = | ||
| response.body | ||
| |> String.split("\n") | ||
| |> Enum.map(&Regex.named_captures(~r/^- \[(?<name>.*?)\]\(.*?\) - (?<description>.*)/, &1)) | ||
| |> Enum.filter(&(&1 != nil)) | ||
| |> Enum.map( | ||
| &Map.update!( | ||
| &1, | ||
| "description", | ||
| fn description -> Regex.replace(~r/\[(.*?)\]\(.*?\)/, description, "\\1") end | ||
| ) | ||
| ) | ||
|
|
||
| max_name_length = | ||
| demos_info | ||
| |> Enum.map(&String.length(&1["name"])) | ||
| |> Enum.max() | ||
|
|
||
| demos_table = | ||
| demos_info | ||
| |> Enum.map_join("\n", fn %{"name" => name, "description" => description} -> | ||
| dots_line = String.duplicate(".", max_name_length - String.length(name) + 3) | ||
| " | #{name} #{dots_line} | #{description}" | ||
| end) | ||
|
|
||
| Mix.shell().info(demos_table) | ||
| end | ||
|
|
||
| defp copy_all_demos(target_dir) do | ||
| repo_dir = Path.join(target_dir, "membrane_demo") | ||
| execute_git_command(["clone", "-q", "--depth", "1", @demos_clone_url, repo_dir]) | ||
| end | ||
|
|
||
| defp copy_specific_demos(target_dir, demos_names) do | ||
| repo_dir = Path.join(target_dir, "membrane_demo") | ||
| execute_git_command(["clone", "-q", "--depth", "1", "-n", @demos_clone_url, repo_dir]) | ||
|
|
||
| Enum.each(demos_names, fn demo_name -> | ||
| case copy_demo(target_dir, demo_name) do | ||
| :error -> | ||
| Mix.shell().error( | ||
| "No demo named #{demo_name}, run this task with -l to list all available demos" | ||
| ) | ||
|
|
||
| :ok -> | ||
| Mix.shell().info("`#{demo_name}` demo created at #{Path.join(target_dir, demo_name)}") | ||
| end | ||
| end) | ||
|
|
||
| File.rm_rf!(repo_dir) | ||
| end | ||
|
|
||
| defp copy_demo(target_dir, demo_name) do | ||
| repo_dir = Path.join(target_dir, "membrane_demo") | ||
|
|
||
| Enum.reduce_while(@demos_search_list, :error, fn demo_dir, _status -> | ||
| demo_path = Path.join([repo_dir, demo_dir, demo_name]) | ||
|
|
||
| execute_git_command(["sparse-checkout", "set", Path.join(demo_dir, demo_name)], repo_dir) | ||
| execute_git_command(["checkout"], repo_dir) | ||
|
|
||
| case File.cp_r(demo_path, Path.join(target_dir, Path.basename(demo_path))) do | ||
| {:ok, _files} -> {:halt, :ok} | ||
| {:error, :enoent, _dir} -> {:cont, :error} | ||
| end | ||
| end) | ||
| end | ||
|
|
||
| defp execute_git_command(argv, dir \\ ".") do | ||
| case System.cmd("git", argv, stderr_to_stdout: true, cd: dir) do | ||
| {_output, 0} -> | ||
| :ok | ||
|
|
||
| {output, exit_code} -> | ||
| Mix.shell().error(""" | ||
| Git command `git #{Enum.join(argv, " ")} exited with code #{exit_code}. Output: | ||
| #{output} | ||
| """) | ||
| end | ||
| end | ||
| end |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| defmodule Mix.Tasks.Membrane.DemoTest do | ||
| use ExUnit.Case | ||
| alias Mix.Tasks.Membrane.Demo | ||
|
|
||
| setup do | ||
| Mix.shell(Mix.Shell.Process) | ||
| end | ||
|
|
||
| describe "All listed demos are pulled" do | ||
| @tag :tmp_dir | ||
| test "individually", %{tmp_dir: tmp} do | ||
| Demo.run(["-l"]) | ||
|
|
||
| get_available_demos_list() | ||
| |> Enum.each(fn demo -> | ||
| Demo.run(["-d", tmp, demo]) | ||
|
|
||
| receive do | ||
| msg -> | ||
| assert {:mix_shell, :info, _message} = msg | ||
| assert File.exists?(Path.join(tmp, demo)) | ||
| end | ||
| end) | ||
| end | ||
|
|
||
| @tag :tmp_dir | ||
| test "all at once", %{tmp_dir: tmp} do | ||
| demos_list = get_available_demos_list() | ||
| Demo.run(["-d", tmp] ++ demos_list) | ||
|
|
||
| Enum.each(demos_list, fn demo -> | ||
| receive do | ||
| msg -> | ||
| assert {:mix_shell, :info, _message} = msg | ||
| assert File.exists?(Path.join(tmp, demo)) | ||
| end | ||
| end) | ||
|
Comment on lines
+18
to
+37
Member
There was a problem hiding this comment. Let's check at least if pulled demo contains
Contributor
Author
There was a problem hiding this comment. Not every demo contains |
||
| end | ||
| end | ||
|
|
||
| defp get_available_demos_list() do | ||
| Demo.run(["-l"]) | ||
|
|
||
| receive do | ||
| {:mix_shell, :info, [table]} -> | ||
| table | ||
| |> String.split("\n") | ||
| |> Enum.map(&Regex.named_captures(~r/\| (?<name>\w+)/, &1)["name"]) | ||
| end | ||
| end | ||
| end | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.