Implement e2e tests for export functionality

test/build_defs/test.build_defs

@@ -3,6 +3,7 @@ def please_repo_e2e_test(
         name: str,
         plz_command: str,
         repo: str,
+        defer_cmd: list = [],
         data: dict={},
         deps: list=[],
         tools: dict={},
@@ -12,7 +13,6 @@ def please_repo_e2e_test(
         expect_output_doesnt_contain: dict = {},
         labels: list = [],
 ):
-    plz_command = plz_command.replace("plz ", "$TOOLS_PLEASE ")
     if expected_failure:
         plz_command += "; [ ! $? -eq 0 ]"
 
@@ -31,7 +31,11 @@ def please_repo_e2e_test(
     if expect_output_doesnt_contain:
         test_cmd += [f'_STR="$(cat {o})" _SUBSTR="{c}" && if [ -z "${_STR##*$_SUBSTR*}" ]; then echo "$_STR"; exit 1; fi' for o, c in expect_output_doesnt_contain.items()]
 
+    # defer commands should be added last
+    test_cmd += defer_cmd
+
     test_cmd = ' && '.join(test_cmd)
+    test_cmd = test_cmd.replace("plz ", "$TOOLS_PLEASE ")
 
     data["REPO"] = [repo]
     data["BASE_CONFIG"] = ["//test/build_defs:base_config"]

test/export/BUILD

@@ -1,5 +1,12 @@
-subinclude("//test/build_defs")
+subinclude("//test/build_defs:build_defs")
 
+filegroup(
+    name = "export_e2e_test_build_def",
+    srcs = ["please_export_e2e_test.build_defs"],
+    visibility = ["//test/export/..."],
+)
+
+# Generic catch-all test on internal repo.
 plz_e2e_test(
     name = "export_src_please_test",
     cmd = "plz export --output plz-out/plzexport //src/core && plz --repo_root=$(plz query reporoot)/plz-out/plzexport build //src/core",

test/export/please_export_e2e_test.build_defs

@@ -0,0 +1,72 @@
+subinclude("//test/build_defs:build_defs")
+
+def please_export_e2e_test(
+        name:str,
+        export_targets:list,
+        cmd_on_export:list=[],
+        source_repo:str="source_repo",
+        expected_repo:str="expected_repo",
+        flags:str="",
+        enforce_different_repos:bool=True):
+    """
+    Runs an export e2e test. To use it, create a directory with both a `source_repo` with the targets
+    to be exported and an `expected_repo` with the expected resulting files.
+    The validation steps for the e2e test are:
+        * It performs a repo-wide diff between the exported files and the `expected_repo`
+        * Builds the exported target to ensure the exported repo, and consequently the
+        `expected_repo`, include valid sources and dependencies to build the target.
+        * Optionally you can specify additional commands to run on the exported directory by
+        passing them to `cmd_on_export`.
+
+    Args:
+        name (str): Name of the test.
+        export_targets (list): Targets to export as part of the test.
+        cmd_on_export (list): Optional. Additional commands to run on the exported directory.
+        source_repo (str): Optional. Repository to export targets from. Defaults to "source_repo".
+        expected_repo (str): Optional. Repository containing the expected results for golden-master
+            validation. Defaults to "expected_repo".
+        flags (str): Optional. Additional flags for the export command.
+        enforce_different_repos (bool): Optional. Ensures we test the trimming capabilities of the
+            export by enforcing that the source and expected repos differ in content. Default to True.
+    """
+    EXPORT_DIR = "plz-out/plzexport"
+    exported_repo = f"$DATA_SOURCE_REPO/{EXPORT_DIR}"
+    data = {}
+    tools = {}
+
+    targets = " ".join(export_targets)
+
+    test_cmd = []
+    if enforce_different_repos:
+        test_cmd += [
+            # Enforce source_repo and expected_repo differences
+            f'(diff -rq "$DATA_SOURCE_REPO" "$DATA_EXPECTED_REPO" && \
+                echo "Source and Expected repos must differ" && exit 1 || true)',
+        ]
+
+    test_cmd += [
+        # Export
+        f'plz --repo_root="$DATA_SOURCE_REPO" export --output "{EXPORT_DIR}" {flags} {targets}',
+        # Golden-Master validation with expected repo. Done before any building to avoid plz-out
+        f'diff -ru "{exported_repo}" "$DATA_EXPECTED_REPO"',
+        # Tests building the exported repo which in turn ensures the sources are included
+        f'plz --repo_root="{exported_repo}" build //...',
+    ] + [f'plz --repo_root="{exported_repo}" {cmd}' for cmd in cmd_on_export]
+
+    test_cmd = [cmd.replace("plz ", "$TOOLS_PLEASE ") for cmd in test_cmd]
+    test_cmd = " && ".join(test_cmd)
+
+    data["SOURCE_REPO"] = [source_repo]
+    data["EXPECTED_REPO"] = [expected_repo]
+
+    tools["PLEASE"] = ["//package:installed_files|please"]
+
+    return gentest(
+        name = name,
+        data = data,
+        labels = ["plz_e2e_test", "e2e"],
+        no_test_output = True,
+        sandbox = False,
+        test_cmd = test_cmd,
+        test_tools = tools,
+    )

test/export/test_builtins/BUILD

@@ -0,0 +1,8 @@
+subinclude("//test/export:export_e2e_test_build_def")
+
+# Export a target generated by a native genrule target and trim unused
+# build statements.
+please_export_e2e_test(
+    name = "export_native_genrule",
+    export_targets = ["//:native_genrule"],
+)

test/export/test_builtins/expected_repo/.plzconfig

@@ -0,0 +1,3 @@
+[Parse]
+
+BuildFileName = BUILD_FILE

test/export/test_builtins/expected_repo/BUILD_FILE

@@ -0,0 +1,6 @@
+genrule(
+    name = "native_genrule",
+    srcs = ["file.txt"],
+    outs = ["file.wordcount"],
+    cmd = "wc $SRCS > $OUT",
+)

test/export/test_builtins/expected_repo/file.txt

@@ -0,0 +1 @@
+Test source file

test/export/test_builtins/source_repo/.plzconfig

@@ -0,0 +1,3 @@
+[Parse]
+
+BuildFileName = BUILD_FILE

test/export/test_builtins/source_repo/BUILD_FILE

@@ -0,0 +1,13 @@
+genrule(
+    name = "native_genrule",
+    srcs = ["file.txt"],
+    outs = ["file.wordcount"],
+    cmd = "wc $SRCS > $OUT",
+)
+
+genrule(
+    name = "dummy_target_to_be_trimmed",
+    srcs = ["dummy.txt"],
+    outs = ["dummy"],
+    cmd = "cat $SRCS > $OUT",
+)

test/export/test_builtins/source_repo/file.txt

@@ -0,0 +1 @@
+Test source file

test/export/test_custom_def/BUILD

@@ -0,0 +1,7 @@
+subinclude("//test/export:export_e2e_test_build_def")
+
+# Export a target generated by a custom build def.
+please_export_e2e_test(
+    name = "export_simple_custom_target",
+    export_targets = ["//:simple_custom_target"],
+)

test/export/test_custom_def/expected_repo/.plzconfig

@@ -0,0 +1,3 @@
+[Parse]
+
+BuildFileName = BUILD_FILE

test/export/test_custom_def/expected_repo/BUILD_FILE

@@ -0,0 +1,7 @@
+subinclude("//build_defs:simple_build_def")
+
+simple_custom_target(
+    name = "simple_custom_target",
+    srcs = ["file.txt"],
+    outs = ["file_simple.out"],
+)

test/export/test_custom_def/expected_repo/build_defs/BUILD_FILE

@@ -0,0 +1,5 @@
+filegroup(
+    name = "simple_build_def",
+    srcs = ["simple.build_defs"],
+    visibility = ["PUBLIC"],
+)

test/export/test_custom_def/expected_repo/build_defs/simple.build_defs

@@ -0,0 +1,10 @@
+def simple_custom_target(
+        name:str,
+        srcs:list=[],
+        outs:list=[]):
+    return genrule(
+        name = name,
+        srcs = srcs,
+        outs = outs,
+        cmd = "cat $SRCS > $OUT",
+    )

test/export/test_custom_def/expected_repo/file.txt

@@ -0,0 +1 @@
+Test source file

test/export/test_custom_def/source_repo/.plzconfig

@@ -0,0 +1,3 @@
+[Parse]
+
+BuildFileName = BUILD_FILE

test/export/test_custom_def/source_repo/BUILD_FILE

@@ -0,0 +1,13 @@
+subinclude("//build_defs:simple_build_def")
+
+simple_custom_target(
+    name = "simple_custom_target",
+    srcs = ["file.txt"],
+    outs = ["file_simple.out"],
+)
+
+simple_custom_target(
+    name = "dummy",
+    srcs = ["file.txt"],
+    outs = ["dummy.out"],
+)

test/export/test_custom_def/source_repo/build_defs/BUILD_FILE

@@ -0,0 +1,11 @@
+filegroup(
+    name = "simple_build_def",
+    srcs = ["simple.build_defs"],
+    visibility = ["PUBLIC"],
+)
+
+filegroup(
+    name = "dummy_build_def",
+    srcs = ["dummy.build_defs"],
+    visibility = ["PUBLIC"],
+)

test/export/test_custom_def/source_repo/build_defs/dummy.build_defs

@@ -0,0 +1,8 @@
+def dummy_target(
+        name:str,
+        outs:list=[]):
+    return genrule(
+        name = name,
+        outs = outs,
+        cmd = "echo dummy > $OUT",
+    )

test/export/test_custom_def/source_repo/build_defs/simple.build_defs

@@ -0,0 +1,10 @@
+def simple_custom_target(
+        name:str,
+        srcs:list=[],
+        outs:list=[]):
+    return genrule(
+        name = name,
+        srcs = srcs,
+        outs = outs,
+        cmd = "cat $SRCS > $OUT",
+    )

test/export/test_custom_def/source_repo/file.txt

@@ -0,0 +1 @@
+Test source file

test/export/test_custom_def_children/BUILD

@@ -0,0 +1,11 @@
+subinclude("//test/export:export_e2e_test_build_def")
+
+# Export a target generated by a custom build def.
+please_export_e2e_test(
+    name = "export_custom_with_adjacent_target",
+    cmd_on_export = [
+        # Adjacent target of build def
+        "build //:custom_target#adjacent",
+    ],
+    export_targets = ["//:custom_target"],
+)

test/export/test_custom_def_children/expected_repo/.plzconfig

@@ -0,0 +1,3 @@
+[Parse]
+
+BuildFileName = BUILD_FILE

test/export/test_custom_def_children/expected_repo/BUILD_FILE

@@ -0,0 +1,8 @@
+subinclude("//build_defs:custom_build_def")
+
+custom_target(
+    name = "custom_target",
+    srcs = ["file.txt"],
+    outs = ["file.out"],
+    outs_adjacent = ["file_adjacent.out"],
+)

test/export/test_custom_def_children/expected_repo/build_defs/BUILD_FILE

@@ -0,0 +1,5 @@
+filegroup(
+    name = "custom_build_def",
+    srcs = ["custom.build_defs"],
+    visibility = ["PUBLIC"],
+)

test/export/test_custom_def_children/expected_repo/build_defs/custom.build_defs

@@ -0,0 +1,17 @@
+def custom_target(
+        name:str,
+        srcs:list=[],
+        outs:list=[],
+        outs_adjacent:list=[]):
+    genrule(
+        name = f"{name}#adjacent",
+        srcs = srcs,
+        outs = outs_adjacent,
+        cmd = "echo 'adjacent' > $OUT && cat $SRCS >> $OUT ",
+    )
+    return genrule(
+        name = name,
+        srcs = srcs,
+        outs = outs,
+        cmd = "echo 'main' > $OUT && cat $SRCS >> $OUT ",
+    )

test/export/test_custom_def_children/expected_repo/file.txt

@@ -0,0 +1 @@
+Test source file

test/export/test_custom_def_children/source_repo/.plzconfig

@@ -0,0 +1,3 @@
+[Parse]
+
+BuildFileName = BUILD_FILE

test/export/test_custom_def_children/source_repo/BUILD_FILE

@@ -0,0 +1,15 @@
+subinclude("//build_defs:custom_build_def")
+
+custom_target(
+    name = "custom_target",
+    srcs = ["file.txt"],
+    outs = ["file.out"],
+    outs_adjacent = ["file_adjacent.out"],
+)
+
+custom_target(
+    name = "dummy",
+    srcs = ["file.txt"],
+    outs = ["dummy.out"],
+    outs_adjacent = ["dummy_adjacent.out"],
+)

test/export/test_custom_def_children/source_repo/build_defs/BUILD_FILE

@@ -0,0 +1,5 @@
+filegroup(
+    name = "custom_build_def",
+    srcs = ["custom.build_defs"],
+    visibility = ["PUBLIC"],
+)

test/export/test_custom_def_children/source_repo/build_defs/custom.build_defs

@@ -0,0 +1,17 @@
+def custom_target(
+        name:str,
+        srcs:list=[],
+        outs:list=[],
+        outs_adjacent:list=[]):
+    genrule(
+        name = f"{name}#adjacent",
+        srcs = srcs,
+        outs = outs_adjacent,
+        cmd = "echo 'adjacent' > $OUT && cat $SRCS >> $OUT ",
+    )
+    return genrule(
+        name = name,
+        srcs = srcs,
+        outs = outs,
+        cmd = "echo 'main' > $OUT && cat $SRCS >> $OUT ",
+    )

test/export/test_custom_def_children/source_repo/file.txt

@@ -0,0 +1 @@
+Test source file

test/export/test_custom_in_file_def/BUILD

@@ -0,0 +1,8 @@
+subinclude("//test/export:export_e2e_test_build_def")
+
+# Export a target generated by a custom build def defined in the same
+# BUILD file.
+please_export_e2e_test(
+    name = "export_custom_target_in_file",
+    export_targets = ["//:simple_custom_target"],
+)

test/export/test_custom_in_file_def/expected_repo/.plzconfig

@@ -0,0 +1,3 @@
+[Parse]
+
+BuildFileName = BUILD_FILE

test/export/test_custom_in_file_def/expected_repo/BUILD_FILE

@@ -0,0 +1,13 @@
+filegroup(
+    name = "simple_build_def",
+    srcs = ["simple.build_defs"],
+    visibility = ["//test_custom_defs/..."],
+)
+
+subinclude(":simple_build_def")
+
+simple_custom_target(
+    name = "simple_custom_target",
+    srcs = ["file.txt"],
+    outs = ["file_simple.out"],
+)

test/export/test_custom_in_file_def/expected_repo/file.txt

@@ -0,0 +1 @@
+Test source file

test/export/test_custom_in_file_def/expected_repo/simple.build_defs

@@ -0,0 +1,10 @@
+def simple_custom_target(
+        name:str,
+        srcs:list=[],
+        outs:list=[]):
+    return genrule(
+        name = name,
+        srcs = srcs,
+        outs = outs,
+        cmd = "cat $SRCS > $OUT",
+    )

test/export/test_custom_in_file_def/source_repo/.plzconfig

@@ -0,0 +1,3 @@
+[Parse]
+
+BuildFileName = BUILD_FILE