From 7c2aaa20e3bd5032633635df9ae0b344be32998a Mon Sep 17 00:00:00 2001
From: Simon Toens <stoens@salesforce.com>
Date: Sat, 23 Mar 2024 10:59:21 +0900
Subject: [PATCH] Only write the libraries hint file when using //maven (#177)

The scripts under //maven use the special libraries hint file, so
enable the writing of that file explicitly when those scripts are used.
The hint file is not needed when running pomgen standalone.
---
 maven/maven.sh | 14 ++++++++++----
 pomgen.py      | 15 ++++++++++-----
 2 files changed, 20 insertions(+), 9 deletions(-)

diff --git a/maven/maven.sh b/maven/maven.sh
index 654e18b..ee75b61 100755
--- a/maven/maven.sh
+++ b/maven/maven.sh
@@ -10,7 +10,7 @@ set -e
 print_usage() {
 cat << EOF
 
-Usage: maven.sh -a action(s) [-l path/to/library]
+Usage: bazel run @pomgen//maven.sh -a action(s) -l path/to/library/root/dir
 
   Required arguments:
 
@@ -179,6 +179,10 @@ _for_each_library() {
     echo ""
     while read library_path;
     do
+        if [[ "$library_path" == \#* ]]; then
+            # the line starts with the comment character
+            continue
+        fi
         echo "[INFO] Processing library: $library_path"
         if [ "$action" == "install" ]; then
           _for_each_pom "install_main_artifact" $repo_root_path $pom_base_filename $jar_artifact_classifier "/$library_path"
@@ -224,7 +228,7 @@ fi
 
 if [ -z "$actions" ] ; then
     echo "[ERROR] The action(s) to run must be specified using -a, for example:"
-    echo "        $ bazel run @pomgen//maven -- -a install"
+    echo "        $ bazel run @pomgen//maven -- -a pomgen,install"
     echo "        bazel run @pomgen//maven for usage information."
     exit 1
 fi
@@ -313,9 +317,11 @@ do
         _for_each_pom "clean_source_tree" $repo_root_path $pom_base_filename $jar_artifact_classifier $library_path
 
     elif [ "$action" == "pomgen" ]; then
-        extra_args=""
+        # this script uses the special libraries hint file, which contains
+        # the path to the upstream libraries
+        extra_args="--write_libraries_hint_file"
         if [ "$debug" = true ]; then
-            extra_args="--verbose"
+            extra_args="${extra_args} --verbose"
         fi
         if [ "$force_pomgen" = true ]; then
             extra_args="${extra_args} --force"
diff --git a/pomgen.py b/pomgen.py
index 5a44639..b370b41 100755
--- a/pomgen.py
+++ b/pomgen.py
@@ -60,14 +60,16 @@ def main(args):
         output_dir = _get_output_dir(args)
 
         lib_paths = bazel.query_all_libraries(repo_root, packages)
-        if len(lib_paths) == 1:
-            # a single lib as a starting point is the common case,
-            # so we do not bother with the other cases for now
+        if args.write_libraries_hint_file:
             if not args.ignore_references:
                 # the libraries hint file contains the list of all upstream
                 # libs (including the current lib) - this only works when
                 # crawling is enabled (ignore_references disables crawling)
-                _write_all_libraries_hint_files(result, output_dir, lib_paths[0])
+                if len(lib_paths) == 1:
+                    # a single lib as a starting point is the common case,
+                    # so we do not bother with the other cases for now
+                    path = lib_paths[0]
+                    _write_all_libraries_hint_files(result, output_dir, path)
 
         for pomgen in result.pomgens:
             pom_dest_dir = os.path.join(output_dir, pomgen.bazel_package)
@@ -123,6 +125,8 @@ def _parse_arguments(args):
         help="Verbose output")
     parser.add_argument("--pom.description", type=str, required=False,
         dest="pom_description", help="Written as the pom's <description/>")
+    parser.add_argument("--write_libraries_hint_file", required=False, action="store_true",
+        help="The libraries hint file is used by the wrapper script in //maven, it is not needed when running pomgen directly")
 
     return parser.parse_args(args)
 
@@ -150,7 +154,8 @@ def _write_all_libraries_hint_files(crawler_result, output_dir, start_lib_path):
         if not os.path.exists(hint_file_dir):
             os.makedirs(hint_file_dir)
         hint_file_path = os.path.join(hint_file_dir, "libraries.txt")
-        _write_file(hint_file_path, "\n".join(lib_paths))
+        _write_file(hint_file_path, "\n".join(
+            ["# the root lib path, followed by the paths to its upstream dependencies"] + lib_paths))
         logger.info("Wrote libraries hint file to [%s]" % hint_file_path)