Making changes backwards compatible

Author: MaciejKaszynski

examples/demo_verification/BUILD

@@ -43,7 +43,7 @@ pkg_files(
         "logging.json",
         ":examples_test_config",
     ],
-    prefix = "tests/examples/etc",
+    prefix = "tests/examples",
 )
 
 pkg_tar(

scripts/config_mapping/config.bzl

@@ -2,6 +2,9 @@ load("@rules_pkg//pkg:mappings.bzl", "pkg_files")
 load("@score_baselibs//score/flatbuffers/bazel:tools.bzl", "serialize_buffer")
 
 def _lm_config_splitter_impl(ctx):
+    """Run a script to convert from the new config structure to the old, this 
+    creates 3 seperate configs.
+    """
     script = ctx.executable.script
     config = ctx.file.config
     schema = ctx.file.schema
@@ -24,6 +27,7 @@ def _lm_config_splitter_impl(ctx):
 
 lm_config_splitter = rule(
     implementation = _lm_config_splitter_impl,
+    doc = "Splits the new configuration format int othe old 3 formats.",
     attrs = {
         "config": attr.label(
             allow_single_file = [".json"],
@@ -49,6 +53,53 @@ lm_config_splitter = rule(
     },
 )
 
+def _lm_config_combiner_impl(ctx):
+    """Declare a single directory that all three serialized buffers get copied
+    into. Consumers receive this one directory instead of three individual
+    files.
+    """
+    etc_dir = ctx.actions.declare_directory(ctx.attr.dir_name)
+
+    srcs = [ctx.file.lm_config, ctx.file.hm_config, ctx.file.hm_core_config]
+
+    args = ctx.actions.args()
+    args.add(etc_dir.path)
+    args.add_all([f.path for f in srcs])
+
+    ctx.actions.run_shell(
+        inputs = srcs,
+        outputs = [etc_dir],
+        arguments = [args],
+        command = 'dest="$1"; shift; mkdir -p "$dest"; for f in "$@"; do cp "$f" "$dest/"; done',
+        mnemonic = "LmConfigCombine",
+        progress_message = "Combining launch manager configs into {}".format(etc_dir.short_path),
+    )
+
+    return [DefaultInfo(files = depset([etc_dir]))]
+
+lm_config_combiner = rule(
+    implementation = _lm_config_combiner_impl,
+    doc="Combines the generated .bin files into a single etc directory.",
+    attrs = {
+        "lm_config": attr.label(
+            allow_single_file = [".bin"],
+            mandatory = True,
+        ),
+        "hm_config": attr.label(
+            allow_single_file = [".bin"],
+            mandatory = True,
+        ),
+        "hm_core_config": attr.label(
+            allow_single_file = [".bin"],
+            mandatory = True,
+        ),
+        "dir_name": attr.string(
+            default = "etc",
+            doc = "Name of the directory to place the combined config files into.",
+        ),
+    },
+)
+
 def launch_manager_config(
         name,
         config,
@@ -61,6 +112,8 @@ def launch_manager_config(
         **kwargs):
     split_name = name + "_split"
 
+    # note that the splitting and combining is a workaround as we have to return
+    # the etc directory where all the .bin files are for backwards compatibility.
     lm_config_splitter(
         name = split_name,
         config = config,
@@ -81,25 +134,15 @@ def launch_manager_config(
             name = name + suffix,
             data = json_prefix + stem + ".json",
             schema = schema_file,
-            output = flatbuffer_out_dir + "/" + stem + ".bin",
+            output = name + "_serialized/" + stem + ".bin",
             **kwargs
         )
 
-    # native.filegroup(
-    #     name = name,
-    #     srcs = [
-    #         ":" + name + "_lm_bin",
-    #         ":" + name + "_hm_bin",
-    #         ":" + name + "_hmcore_bin",
-    #     ],
-
-    pkg_files(
+    lm_config_combiner(
         name = name,
-        srcs = [
-            ":" + name + "_lm_bin",
-            ":" + name + "_hm_bin",
-            ":" + name + "_hmcore_bin",
-        ],
-        prefix = "/etc",
+        lm_config = ":" + name + "_lm_bin",
+        hm_config = ":" + name + "_hm_bin",
+        hm_core_config = ":" + name + "_hmcore_bin",
+        dir_name = flatbuffer_out_dir,
+        **kwargs
     )
-    # **kwargs

tests/integration/complex_monitoring/BUILD

@@ -69,7 +69,7 @@ pkg_files(
 pkg_files(
     name = "complex_monitoring_etc_files",
     srcs = [":lm_complex_monitoring_config"],
-    prefix = "tests/complex_monitoring/etc",
+    prefix = "tests/complex_monitoring",
 )
 
 pkg_tar(

tests/integration/crash_on_startup/BUILD

@@ -63,7 +63,7 @@ pkg_files(
 pkg_files(
     name = "crash_on_startup_etc_files",
     srcs = [":lm_crash_on_startup_config"],
-    prefix = "tests/crash_on_startup/etc",
+    prefix = "tests/crash_on_startup",
 )
 
 pkg_tar(

tests/integration/incorrect_config_non_reporting/BUILD

@@ -50,7 +50,7 @@ pkg_files(
 pkg_files(
     name = "non_reporting_etc_files",
     srcs = [":lm_non_reporting_config"],
-    prefix = "tests/incorrect_config_non_reporting/etc",
+    prefix = "tests/incorrect_config_non_reporting",
 )
 
 pkg_tar(

tests/integration/process_crash_monitoring/BUILD

@@ -57,7 +57,7 @@ pkg_files(
 pkg_files(
     name = "process_crash_monitoring_etc_files",
     srcs = [":lm_process_crash_monitoring_config"],
-    prefix = "tests/process_crash_monitoring/etc",
+    prefix = "tests/process_crash_monitoring",
 )
 
 pkg_tar(

tests/integration/process_launch_args/BUILD

@@ -21,8 +21,6 @@ launch_manager_config(
     flatbuffer_out_dir = "etc",
 )
 
-print(":lm_process_launch_args_config")
-
 cc_binary(
     name = "process_initial",
     srcs = ["process_initial.cpp"],

tests/integration/smoke/BUILD

@@ -67,7 +67,7 @@ pkg_files(
 pkg_files(
     name = "smoke_etc_files",
     srcs = [":lm_smoketest_config"],
-    prefix = "tests/smoke/etc",
+    prefix = "tests/smoke",
 )
 
 pkg_tar(

tests/integration/switch_run_target/BUILD

@@ -83,7 +83,7 @@ pkg_files(
 pkg_files(
     name = "switch_run_target_etc_files",
     srcs = [":lm_switch_run_target_config"],
-    prefix = "tests/switch_run_target/etc",
+    prefix = "tests/switch_run_target",
 )
 
 pkg_tar(