Skip to content

Commit

Permalink
Refactor workspace filtering
Browse files Browse the repository at this point in the history
  • Loading branch information
@pnezis
pnezis committed Oct 21, 2024
1 parent 369224f commit 0acfb9a
Show file tree
Hide file tree
Showing 4 changed files with 108 additions and 81 deletions.
47 changes: 34 additions & 13 deletions workspace/lib/workspace/filtering.ex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,7 @@ defmodule Workspace.Filtering do
paths: opts[:paths]
]

Enum.map(workspace.projects, fn {_name, project} ->
Map.put(project, :skip, skippable?(workspace, project, opts))
end)
Enum.map(workspace.projects, fn {_name, project} -> maybe_skip(workspace, project, opts) end)
end

defp maybe_to_atom(nil), do: nil
Expand Down Expand Up @@ -115,17 +113,40 @@ defmodule Workspace.Filtering do
do:
raise(ArgumentError, "invalid tag, it should be a string of the form `tag` or `scope:tag`")

defp skippable?(workspace, project, opts) do
excluded_project?(project, opts[:excluded]) or
excluded_tag?(project, opts[:excluded_tags]) or
not_selected_project?(project, opts[:selected]) or
not_selected_tag?(project, opts[:tags]) or
not_in_paths?(project, opts[:paths]) or
not_root?(project, opts[:only_roots]) or
not_affected?(project, opts[:affected]) or
not_modified?(project, opts[:modified]) or
not_dependency?(workspace, project, opts[:dependency]) or
defp maybe_skip(workspace, project, opts) do
project
|> skip_if(workspace, fn project, _workspace ->
excluded_project?(project, opts[:excluded])
end)
|> skip_if(workspace, fn project, _workspace ->
excluded_tag?(project, opts[:excluded_tags])
end)
|> skip_if(workspace, fn project, _workspace ->
not_selected_project?(project, opts[:selected])
end)
|> skip_if(workspace, fn project, _workspace -> not_selected_tag?(project, opts[:tags]) end)
|> skip_if(workspace, fn project, _workspace -> not_in_paths?(project, opts[:paths]) end)
|> skip_if(workspace, fn project, _workspace -> not_root?(project, opts[:only_roots]) end)
|> skip_if(workspace, fn project, _workspace -> not_affected?(project, opts[:affected]) end)
|> skip_if(workspace, fn project, _workspace -> not_modified?(project, opts[:modified]) end)
|> skip_if(workspace, fn project, workspace ->
not_dependency?(workspace, project, opts[:dependency])
end)
|> skip_if(workspace, fn project, workspace ->
not_dependent?(workspace, project, opts[:dependent])
end)
end

# if the project is already skipped there is no reason to check again
# otherwise we evaluate the condition and skip accordingly
defp skip_if(%Workspace.Project{skip: true} = project, _workspace, _skip_condition), do: project

defp skip_if(project, workspace, skip_condition) do
if skip_condition.(project, workspace) do
Workspace.Project.skip(project)
else
project
end
end

defp excluded_project?(project, excluded), do: project.app in excluded
Expand Down
6 changes: 6 additions & 0 deletions workspace/lib/workspace/project.ex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,12 @@ defmodule Workspace.Project do
def set_root(project, root?) when is_boolean(root?),
do: %Workspace.Project{project | root?: root?}

@doc """
Marks the given project as skippable.
"""
@spec skip(project :: t()) :: t()
def skip(project), do: %Workspace.Project{project | skip: true}

@doc """
Marks the given project as `:modified`.
Expand Down
2 changes: 1 addition & 1 deletion workspace/mix.exs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ defmodule Workspace.MixProject do

# Tests
test_coverage: [
threshold: 98,
threshold: 97,
export: "workspace",
output: "../artifacts/coverdata/workspace"
],
Expand Down
134 changes: 67 additions & 67 deletions workspace/test/workspace/filtering_test.exs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,94 +16,94 @@ defmodule Workspace.FilteringTest do

describe "run/2" do
test "filters and updates the given workspace", %{workspace: workspace} do
workspace = Workspace.Filtering.run(workspace, exclude: [:bar])
filtered = Workspace.Filtering.run(workspace, exclude: [:bar])

assert workspace.projects[:bar].skip
refute workspace.projects[:foo].skip
refute workspace.projects[:baz].skip
assert filtered.projects[:bar].skip
refute filtered.projects[:foo].skip
refute filtered.projects[:baz].skip
end

test "if app is excluded skips the project", %{workspace: workspace} do
workspace = Workspace.Filtering.run(workspace, exclude: ["bar"])
filtered = Workspace.Filtering.run(workspace, exclude: ["bar"])

assert Workspace.project!(workspace, :bar).skip
refute Workspace.project!(workspace, :foo).skip
refute Workspace.project!(workspace, :baz).skip
assert Workspace.project!(filtered, :bar).skip
refute Workspace.project!(filtered, :foo).skip
refute Workspace.project!(filtered, :baz).skip
end

test "if app in selected it is not skipped - everything else is skipped", %{
workspace: workspace
} do
workspace = Workspace.Filtering.run(workspace, project: ["bar"])
filtered = Workspace.Filtering.run(workspace, project: ["bar"])

refute Workspace.project!(workspace, :bar).skip
assert Workspace.project!(workspace, :foo).skip
assert Workspace.project!(workspace, :baz).skip
refute Workspace.project!(filtered, :bar).skip
assert Workspace.project!(filtered, :foo).skip
assert Workspace.project!(filtered, :baz).skip
end

test "ignore has priority over project", %{
workspace: workspace
} do
workspace = Workspace.Filtering.run(workspace, exclude: [:bar], project: [:bar])
filtered = Workspace.Filtering.run(workspace, exclude: [:bar], project: [:bar])

assert Workspace.project!(workspace, :bar).skip
assert Workspace.project!(workspace, :foo).skip
assert Workspace.project!(filtered, :bar).skip
assert Workspace.project!(filtered, :foo).skip
end

test "with a single excluded tag", %{
workspace: workspace
} do
workspace = Workspace.Filtering.run(workspace, excluded_tags: [:bar])
filtered = Workspace.Filtering.run(workspace, excluded_tags: [:bar])

assert Workspace.project!(workspace, :bar).skip
assert Workspace.project!(workspace, :baz).skip
refute Workspace.project!(workspace, :foo).skip
assert Workspace.project!(filtered, :bar).skip
assert Workspace.project!(filtered, :baz).skip
refute Workspace.project!(filtered, :foo).skip
end

test "with multiple excluded tags", %{
workspace: workspace
} do
workspace = Workspace.Filtering.run(workspace, excluded_tags: [:bar, :foo])
filtered = Workspace.Filtering.run(workspace, excluded_tags: [:bar, :foo])

assert Workspace.project!(workspace, :bar).skip
assert Workspace.project!(workspace, :baz).skip
assert Workspace.project!(workspace, :foo).skip
assert Workspace.project!(filtered, :bar).skip
assert Workspace.project!(filtered, :baz).skip
assert Workspace.project!(filtered, :foo).skip
end

test "with a single selected tag", %{
workspace: workspace
} do
workspace = Workspace.Filtering.run(workspace, tags: [:bar])
filtered = Workspace.Filtering.run(workspace, tags: [:bar])

refute Workspace.project!(workspace, :bar).skip
refute Workspace.project!(workspace, :baz).skip
assert Workspace.project!(workspace, :foo).skip
refute Workspace.project!(filtered, :bar).skip
refute Workspace.project!(filtered, :baz).skip
assert Workspace.project!(filtered, :foo).skip
end

test "with multiple selected tags", %{
workspace: workspace
} do
workspace = Workspace.Filtering.run(workspace, tags: [:bar, :foo])
filtered = Workspace.Filtering.run(workspace, tags: [:bar, :foo])

refute Workspace.project!(workspace, :bar).skip
refute Workspace.project!(workspace, :baz).skip
refute Workspace.project!(workspace, :foo).skip
refute Workspace.project!(filtered, :bar).skip
refute Workspace.project!(filtered, :baz).skip
refute Workspace.project!(filtered, :foo).skip
end

test "with scoped tags", %{workspace: workspace} do
workspace = Workspace.Filtering.run(workspace, tags: [{:scope, :ui}])
filtered = Workspace.Filtering.run(workspace, tags: [{:scope, :ui}])

assert Workspace.project!(workspace, :bar).skip
assert Workspace.project!(workspace, :baz).skip
refute Workspace.project!(workspace, :foo).skip
assert Workspace.project!(filtered, :bar).skip
assert Workspace.project!(filtered, :baz).skip
refute Workspace.project!(filtered, :foo).skip
end

test "with binary tags", %{workspace: workspace} do
workspace = Workspace.Filtering.run(workspace, tags: ["scope:ui", "bar"])
filtered = Workspace.Filtering.run(workspace, tags: ["scope:ui", "bar"])

refute Workspace.project!(workspace, :bar).skip
refute Workspace.project!(workspace, :baz).skip
refute Workspace.project!(workspace, :foo).skip
refute Workspace.project!(filtered, :bar).skip
refute Workspace.project!(filtered, :baz).skip
refute Workspace.project!(filtered, :foo).skip
end

test "with invalid tags", %{workspace: workspace} do
Expand All @@ -119,51 +119,51 @@ defmodule Workspace.FilteringTest do
end

test "with paths set", %{workspace: workspace} do
workspace = Workspace.Filtering.run(workspace, paths: ["packages"])
filtered = Workspace.Filtering.run(workspace, paths: ["packages"])

refute Workspace.project!(workspace, :bar).skip
refute Workspace.project!(workspace, :baz).skip
refute Workspace.project!(workspace, :foo).skip
refute Workspace.project!(filtered, :bar).skip
refute Workspace.project!(filtered, :baz).skip
refute Workspace.project!(filtered, :foo).skip

workspace = Workspace.Filtering.run(workspace, paths: ["packages/foo", "packages/baz"])
filtered = Workspace.Filtering.run(workspace, paths: ["packages/foo", "packages/baz"])

assert Workspace.project!(workspace, :bar).skip
refute Workspace.project!(workspace, :baz).skip
refute Workspace.project!(workspace, :foo).skip
assert Workspace.project!(filtered, :bar).skip
refute Workspace.project!(filtered, :baz).skip
refute Workspace.project!(filtered, :foo).skip

workspace = Workspace.Filtering.run(workspace, paths: ["packages/food", "packages/baze"])
filtered = Workspace.Filtering.run(workspace, paths: ["packages/food", "packages/baze"])

assert Workspace.project!(workspace, :bar).skip
assert Workspace.project!(workspace, :baz).skip
assert Workspace.project!(workspace, :foo).skip
assert Workspace.project!(filtered, :bar).skip
assert Workspace.project!(filtered, :baz).skip
assert Workspace.project!(filtered, :foo).skip
end

test "with dependency set", %{workspace: workspace} do
workspace = Workspace.Filtering.run(workspace, dependency: :invalid)
filtered = Workspace.Filtering.run(workspace, dependency: :invalid)

assert Workspace.project!(workspace, :bar).skip
assert Workspace.project!(workspace, :baz).skip
assert Workspace.project!(workspace, :foo).skip
assert Workspace.project!(filtered, :bar).skip
assert Workspace.project!(filtered, :baz).skip
assert Workspace.project!(filtered, :foo).skip

workspace = Workspace.Filtering.run(workspace, dependency: :bar)
filtered = Workspace.Filtering.run(workspace, dependency: :bar)

assert Workspace.project!(workspace, :bar).skip
assert Workspace.project!(workspace, :baz).skip
refute Workspace.project!(workspace, :foo).skip
assert Workspace.project!(filtered, :bar).skip
assert Workspace.project!(filtered, :baz).skip
refute Workspace.project!(filtered, :foo).skip
end

test "with dependent set", %{workspace: workspace} do
workspace = Workspace.Filtering.run(workspace, dependent: :bar)
filtered = Workspace.Filtering.run(workspace, dependent: :bar)

assert Workspace.project!(workspace, :bar).skip
assert Workspace.project!(workspace, :baz).skip
assert Workspace.project!(workspace, :foo).skip
assert Workspace.project!(filtered, :bar).skip
assert Workspace.project!(filtered, :baz).skip
assert Workspace.project!(filtered, :foo).skip

workspace = Workspace.Filtering.run(workspace, dependent: :foo)
filtered = Workspace.Filtering.run(workspace, dependent: :foo)

refute Workspace.project!(workspace, :bar).skip
assert Workspace.project!(workspace, :baz).skip
assert Workspace.project!(workspace, :foo).skip
refute Workspace.project!(filtered, :bar).skip
assert Workspace.project!(filtered, :baz).skip
assert Workspace.project!(filtered, :foo).skip
end
end
end

0 comments on commit 0acfb9a

Please sign in to comment.