[GR-69079] Deprecate ignore_suite_commit_info flag/option in favor of capture_suite_commit_info

PullRequest: mx/1972

Author: Hamza Ech-chadli

ci.jsonnet

@@ -86,7 +86,7 @@ local with(platform, java_release, timelimit="15:00") = {
 
     bench_test:: self.with_name("bench-test") + {
         run: [
-            [mx, "benchmark", "--results-file", "bench-results.json", "--ignore-suite-commit-info=mx", "test"],
+            [mx, "benchmark", "--results-file", "bench-results.json", "test"],
         ],
         teardown: [
             ["bench-uploader.py", "bench-results.json"],
@@ -98,7 +98,7 @@ local with(platform, java_release, timelimit="15:00") = {
             [mx, "build"],
         ],
         run: [
-            [mx, "benchmark", "--ignore-suite-commit-info=mx", "jmh-dist:*"],
+            [mx, "benchmark", "jmh-dist:*"],
             ['set-export', 'PYTHONPATH', '${PWD}/src:${PYTHONPATH}'],
             ["python3", path("tests/jmh_filtering_tests.py")],
         ]
@@ -255,7 +255,6 @@ local with(platform, java_release, timelimit="15:00") = {
         with(common.windows_amd64, self.primary_jdk_version).fetchjdk_test,
         with(common.linux_amd64, self.primary_jdk_version).bisect_test,
         with(common.windows_amd64, self.primary_jdk_version).gate,
-        with(common.darwin_amd64, self.primary_jdk_version, timelimit="25:00").gate,
         with(common.darwin_aarch64, self.primary_jdk_version).gate,
         with(common.linux_amd64, self.primary_jdk_version).bench_test,
         with(common.linux_amd64, self.primary_jdk_version).jmh_test,
@@ -268,7 +267,6 @@ local with(platform, java_release, timelimit="15:00") = {
 
         with(common.linux_amd64, self.secondary_jdk_version).gate,
         with(common.windows_amd64, self.secondary_jdk_version).gate,
-        with(common.darwin_amd64, self.secondary_jdk_version, timelimit="25:00").gate,
         with(common.darwin_aarch64, self.secondary_jdk_version).gate,
     ],
     builds: [remove_mx_from_packages(b) for b in builds],

ci/common.jsonnet

@@ -363,9 +363,7 @@ local common_json = import "../common.json";
           pcre2: '==10.37',
           gnur: '==4.0.3-gcc4.8.5-pcre2',
         } + if (std.objectHasAll(self, 'os_distro') && self['os_distro'] == 'ol' && std.objectHasAll(self, 'os_distro_version') && self['os_distro_version'] == '9') then {curl: '==7.78.0'} else {curl: '==7.50.1'}
-        else if (self.os == "darwin" && self.arch == "amd64") then {
-          'pcre2': '==10.37',
-        } else {},
+        else {},
       environment+:
         if (self.os == "linux" && self.arch == "amd64") then {
           TZDIR: '/usr/share/zoneinfo',
@@ -376,25 +374,14 @@ local common_json = import "../common.json";
           GNUR_HOME_BINARY: '/cm/shared/apps/gnur/4.0.3_gcc4.8.5_pcre2-10.37/R-4.0.3',
           FASTR_RELEASE: 'true',
         }
-        else if (self.os == "darwin" && self.arch == "amd64") then {
-          FASTR_FC: '/cm/shared/apps/gcc/8.3.0/bin/gfortran',
-          FASTR_CC: '/cm/shared/apps/gcc/8.3.0/bin/gcc',
-          TZDIR: '/usr/share/zoneinfo',
-          PKG_INCLUDE_FLAGS_OVERRIDE : '-I/cm/shared/apps/pcre2/pcre2-10.37/include -I/cm/shared/apps/bzip2/1.0.6/include -I/cm/shared/apps/xz/5.2.2/include -I/cm/shared/apps/curl/7.50.1/include',
-          PKG_LDFLAGS_OVERRIDE : '-L/cm/shared/apps/bzip2/1.0.6/lib -L/cm/shared/apps/xz/5.2.2/lib -L/cm/shared/apps/pcre2/pcre2-10.37/lib -L/cm/shared/apps/curl/7.50.1/lib -L/cm/shared/apps/gcc/10.2.0/lib -L/usr/lib',
-          FASTR_RELEASE: 'true',
-        } else {},
+        else {},
       downloads+:
         if (self.os == "linux" && self.arch == "amd64") then {
           BLAS_LAPACK_DIR: { name: 'fastr-403-blas-lapack-gcc', version: '4.8.5', platformspecific: true },
           F2C_BINARY: { name: 'f2c-binary', version: '7', platformspecific: true },
           FASTR_RECOMMENDED_BINARY: { name: 'fastr-recommended-pkgs', version: '16', platformspecific: true },
         }
-        else if (self.os == "darwin" && self.arch == "amd64") then {
-          BLAS_LAPACK_DIR: { name: "fastr-403-blas-lapack-gcc", version: "8.3.0", platformspecific: true },
-          F2C_BINARY: { name: 'f2c-binary', version: '7', platformspecific: true },
-          FASTR_RECOMMENDED_BINARY: { name: 'fastr-recommended-pkgs', version: '16', platformspecific: true },
-        } else {},
+        else {},
       catch_files+: if (self.os != "windows" && self.arch == "amd64") then [
         'GNUR_CONFIG_LOG = (?P<filename>.+\\.log)',
         'GNUR_MAKE_LOG = (?P<filename>.+\\.log)',
@@ -550,7 +537,6 @@ local common_json = import "../common.json";
 
     linux_amd64_ubuntu: linux + amd64 + ubuntu22 + { os_distro:: "ubuntu", os_distro_version:: "22" },
 
-    darwin_amd64: darwin + amd64,
     darwin_aarch64: darwin + aarch64,
 
     windows_amd64: windows + amd64,
@@ -581,7 +567,6 @@ local common_json = import "../common.json";
 
   linux_amd64_ubuntu: self.bare.linux_amd64_ubuntu + common,
 
-  darwin_amd64: self.bare.darwin_amd64 + common,
   darwin_aarch64: self.bare.darwin_aarch64 + common,
 
   windows_amd64: self.bare.windows_amd64 + common,

common.json

@@ -4,7 +4,7 @@
     "Jsonnet files should not include this file directly but use ci/common.jsonnet instead."
   ],
 
-  "mx_version": "7.64.0",
+  "mx_version": "7.64.2",
 
   "COMMENT.jdks": "When adding or removing JDKs keep in sync with JDKs in ci/common.jsonnet",
   "jdks": {
@@ -45,16 +45,16 @@
 
     "oraclejdk24":       {"name": "jpg-jdk",   "version": "24", "build_id": "jdk-24.0.1+9", "platformspecific": true, "extrabundles": ["static-libs"]},
 
-    "oraclejdk25":        {"name": "jpg-jdk",   "version": "25",      "build_id": "jdk-25+37", "platformspecific": true, "extrabundles": ["static-libs"]},
+    "oraclejdk25":        {"name": "jpg-jdk",   "version": "25",      "build_id": "jdk-25.0.1+8", "platformspecific": true, "extrabundles": ["static-libs"]},
     "graalvm-ee-25-ea":   {"name": "graalvm-jdk", "version": "25.0.0", "ea": "36", "platformspecific": true },
 
-    "oraclejdk-latest":       {"name": "jpg-jdk",   "version": "25",      "build_id": "jdk-25+37", "platformspecific": true, "extrabundles": ["static-libs"]},
-    "labsjdk-ce-latest":      {"name": "labsjdk",   "version": "ce-25+37-jvmci-25.1-b07", "platformspecific": true },
-    "labsjdk-ce-latestDebug": {"name": "labsjdk",   "version": "ce-25+37-jvmci-25.1-b07-debug", "platformspecific": true },
-    "labsjdk-ce-latest-llvm": {"name": "labsjdk",   "version": "ce-25+37-jvmci-25.1-b07-sulong", "platformspecific": true },
-    "labsjdk-ee-latest":      {"name": "labsjdk",   "version": "ee-25+37-jvmci-25.1-b07", "platformspecific": true },
-    "labsjdk-ee-latestDebug": {"name": "labsjdk",   "version": "ee-25+37-jvmci-25.1-b07-debug", "platformspecific": true },
-    "labsjdk-ee-latest-llvm": {"name": "labsjdk",   "version": "ee-25+37-jvmci-25.1-b07-sulong", "platformspecific": true }
+    "oraclejdk-latest":       {"name": "jpg-jdk",   "version": "25",      "build_id": "jdk-25.0.1+8", "platformspecific": true, "extrabundles": ["static-libs"]},
+    "labsjdk-ce-latest":      {"name": "labsjdk",   "version": "ce-25.0.1+8-jvmci-25.1-b08", "platformspecific": true },
+    "labsjdk-ce-latestDebug": {"name": "labsjdk",   "version": "ce-25.0.1+8-jvmci-25.1-b08-debug", "platformspecific": true },
+    "labsjdk-ce-latest-llvm": {"name": "labsjdk",   "version": "ce-25.0.1+8-jvmci-25.1-b08-sulong", "platformspecific": true },
+    "labsjdk-ee-latest":      {"name": "labsjdk",   "version": "ee-25.0.1+8-jvmci-25.1-b08", "platformspecific": true },
+    "labsjdk-ee-latestDebug": {"name": "labsjdk",   "version": "ee-25.0.1+8-jvmci-25.1-b08-debug", "platformspecific": true },
+    "labsjdk-ee-latest-llvm": {"name": "labsjdk",   "version": "ee-25.0.1+8-jvmci-25.1-b08-sulong", "platformspecific": true }
   },
 
   "eclipse": {

src/mx/_impl/mx.py

@@ -1615,6 +1615,7 @@ def __init__(self, mxDir, primary, internal, importing_suite, load, vc, vc_dir,
         self.vc = vc
         self.vc_dir = vc_dir
         self.ignore_suite_commit_info = False
+        self.capture_suite_commit_info = False
         self._preload_suite_dict()
         self._init_imports()
         self.removed_dists = []
@@ -1926,7 +1927,8 @@ def _load_suite_dict(self):
             'externalProjects',
             'groupId',
             'release',
-            'ignore_suite_commit_info'
+            'ignore_suite_commit_info',
+            'capture_suite_commit_info'
         ]
         if self._preloaded_suite_dict is None:
             self._preload_suite_dict()
@@ -2045,7 +2047,8 @@ def _load_metadata(self):
         scmDict = self._check_suiteDict('scm')
         self.developer = self._check_suiteDict('developer')
         self.url = suiteDict.get('url')
-        self.ignore_suite_commit_info = suiteDict.get('ignore_suite_commit_info', False)
+        self.ignore_suite_commit_info = suiteDict.get('ignore_suite_commit_info')
+        self.capture_suite_commit_info = suiteDict.get('capture_suite_commit_info', False)
         if not _validate_absolute_url(self.url, acceptNone=True):
             abort(f'Invalid url in {self.suite_py()}')
         self.defaultLicense = suiteDict.get(self.getMxCompatibility().defaultLicenseAttribute())

src/mx/_impl/mx_benchmark.py

@@ -3934,10 +3934,24 @@ def commit_info(prefix, mxsuite):
 
         standard.update(commit_info("", mx.primary_suite()))
         for mxsuite in mx.suites():
-            ignored = mxBenchmarkArgs.ignore_suite_commit_info
-            if (ignored and mxsuite.name in ignored) or mxsuite.ignore_suite_commit_info or mxsuite.foreign:
+            captured = mxBenchmarkArgs.capture_suite_commit_info
+
+            if mxsuite.ignore_suite_commit_info is not None:
+                if mxsuite.ignore_suite_commit_info != mxsuite.capture_suite_commit_info:
+                    log_deprecation(
+                        f"Suite '{mxsuite.name}' uses the deprecated 'ignore_suite_commit_info' (value: {mxsuite.ignore_suite_commit_info}) configuration entry in its suite.py.\n"
+                        f"Please keep using only 'capture_suite_commit_info' (value: {mxsuite.capture_suite_commit_info})."
+                    )
+                else:
+                    mx.abort(
+                        f"Suite '{mxsuite.name}' sets both 'ignore_suite_commit_info' (deprecated, value: {mxsuite.ignore_suite_commit_info}) and 'capture_suite_commit_info' (value: {mxsuite.capture_suite_commit_info}) in its suite.py.\n"
+                        f"This is a configuration conflict. Please remove 'ignore_suite_commit_info' and keep only 'capture_suite_commit_info'."
+                    )
+
+            if mxsuite.foreign:
                 continue
-            standard.update(commit_info(mxsuite.name + ".", mxsuite))
+            if (captured and mxsuite.name in captured) or mxsuite.capture_suite_commit_info:
+                standard.update(commit_info(mxsuite.name + ".", mxsuite))
         triggering_suite = self.triggeringSuite(mxBenchmarkArgs)
         if triggering_suite:
             mxsuite = mx.suite(triggering_suite)
@@ -4054,8 +4068,8 @@ def benchpoints(self, args):
             "results_file", nargs="?", default=None,
             help="path to benchmark results json file to modify")
         parser.add_argument(
-            "--ignore-suite-commit-info", default=None, type=lambda s: s.split(","),
-            help="A comma-separated list of suite dependencies whose commit info must not be included.")
+            "--capture-suite-commit-info", default=None, type=lambda s: s.split(","),
+            help="A comma-separated list of suite dependencies whose commit info must be included.")
         parser.add_argument(
             "--extras", default=None, help="One or more comma separated key:value pairs to add to the results file. Takes precedence over the keys defined in MX_BENCHMARK_EXTRAS in case of duplicates.")
         parser.add_argument(
@@ -4125,8 +4139,8 @@ def benchmark(self, mxBenchmarkArgs, bmSuiteArgs, returnSuiteAndResults=False):
             "--triggering-suite", default=None,
             help="Name of the suite that triggered this benchmark, used to extract commit info.")
         parser.add_argument(
-            "--ignore-suite-commit-info", default=None, type=lambda s: s.split(","),
-            help="A comma-separated list of suite dependencies whose commit info must not be included.")
+            "--capture-suite-commit-info", default=None, type=lambda s: s.split(","),
+            help="A comma-separated list of suite dependencies whose commit info must be included.")
         parser.add_argument(
             "--extras", default=None, help="One or more comma separated key:value pairs to add to the results file. Takes precedence over the keys defined in MX_BENCHMARK_EXTRAS in case of duplicates.")
         parser.add_argument(

src/mx/_impl/ps_poller.py

@@ -56,7 +56,6 @@ def _parse_args(args):
 
 
 def _start_target_process(target_cmd):
-    print(f"Starting and attaching to command: \"{' '.join(target_cmd)}\"")
     return subprocess.Popen(target_cmd, start_new_session=True)
 
 

src/mx/mx_version.py

@@ -1,2 +1,2 @@
 # The version must be updated for every PR (checked in CI) and the comment should reflect the PR's issue
-version = "7.64.2"  # GR-71010 MX_BENCHMARK_EXTRAS support
+version = "7.65.0"  # GR-69079: opt-in instead of opt-out for commit info in mx benchmark data

tests/code_owners_tests.py

@@ -788,7 +788,7 @@ def test_codeowners_json_output():
         ".mx_vcs_root": "",
         "unittest": {
             "mx.unittest": {
-                "suite.py": """suite = { "mxversion": "7.4.0", "name": "unittest", "ignore_suite_commit_info": True}""",
+                "suite.py": """suite = { "mxversion": "7.4.0", "name": "unittest" }""",
             },
         },
     }