Create a tag_release rule

bazel_to_cmake: The correct name is BuildSettingInfo, not BuildSettingProvider

PiperOrigin-RevId: 805183129
Change-Id: I4207843a8042fd83c03a9782c7b2f639514cb460

Author: laramiel

bazel/tag_release.bzl

@@ -0,0 +1,49 @@
+# Copyright 2021 The TensorStore Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+load("@bazel_skylib//rules:common_settings.bzl", "BuildSettingInfo")
+
+# TODO: Consider using the bazel --stamp flag:
+#
+# https://bazel.build/docs/user-manual#workspace-status-command
+#  --workspace_status_command program would generate key value pairs,
+#  which are stored in https://bazel.build/rules/lib/builtins/ctx#version_file
+#
+# Also consider exposing the version as a python __version__.py file.
+
+_TEMPLATE = """
+// version is auto-generated by tensorstore build.
+
+#ifndef TENSORSTORE_VERSION
+#define TENSORSTORE_VERSION "{version}"
+#endif  // TENSORSTORE_VERSION
+
+"""
+
+def _tag_release_impl(ctx):
+    ctx.actions.write(
+        output = ctx.outputs.out,
+        content = _TEMPLATE.format(version = ctx.attr.label[BuildSettingInfo].value),
+        is_executable = False,
+    )
+    return [DefaultInfo(files = depset([ctx.outputs.out]))]
+
+tag_release = rule(
+    implementation = _tag_release_impl,
+    output_to_genfiles = True,
+    attrs = {
+        "out": attr.output(mandatory = True, doc = "The output file to write the version to."),
+        "label": attr.label(mandatory = True, doc = "The label to tag the release with."),
+    },
+)

setup.py

@@ -240,6 +240,12 @@ def run(self):
           else:
             build_flags.append('--copt=-O3')
 
+        version_stamp = self.distribution.get_version()
+        if version_stamp:
+          build_flags.append(
+              '--//tensorstore/internal/version=%s' % version_stamp
+          )
+
         build_command = (
             [sys.executable, '-u', bazelisk]
             + startup_options

tensorstore/internal/curl/BUILD

@@ -99,6 +99,7 @@ tensorstore_cc_library(
     hdrs = ["curl_wrappers.h"],
     deps = [
         "//tensorstore/internal:source_location",
+        "//tensorstore/internal/version:version_h",
         "//tensorstore/util:status",
         "//tensorstore/util:str_cat",
         "@abseil-cpp//absl/base",

tensorstore/internal/curl/curl_wrappers.cc

@@ -26,6 +26,7 @@
 #include "absl/strings/cord.h"
 #include <curl/curl.h>
 #include "tensorstore/internal/source_location.h"
+#include "tensorstore/internal/version/version.h"
 #include "tensorstore/util/status.h"
 #include "tensorstore/util/str_cat.h"
 
@@ -69,8 +70,8 @@ void CurlSlistCleanup::operator()(curl_slist* s) { curl_slist_free_all(s); }
 
 /// Returns the default CurlUserAgent.
 std::string GetCurlUserAgentSuffix() {
-  static std::string agent =
-      tensorstore::StrCat("tensorstore/0.1 ", curl_version());
+  static std::string agent = tensorstore::StrCat(
+      "tensorstore/", TENSORSTORE_VERSION, " ", curl_version());
   return agent;
 }
 

tensorstore/internal/version/BUILD

@@ -0,0 +1,23 @@
+load("@bazel_skylib//rules:common_settings.bzl", "string_flag")
+load("//bazel:tag_release.bzl", "tag_release")
+load("//bazel:tensorstore.bzl", "tensorstore_cc_library")
+
+package(default_visibility = ["//tensorstore:internal_packages"])
+
+licenses(["notice"])
+
+string_flag(
+    name = "version",
+    build_setting_default = "0.1.dev",
+)
+
+tag_release(
+    name = "generate_version_h",
+    out = "version.h",
+    label = ":version",
+)
+
+tensorstore_cc_library(
+    name = "version_h",
+    hdrs = ["version.h"],
+)

tools/cmake/bazel_to_cmake/bzl_library/bazel_skylib.py

@@ -28,7 +28,7 @@
 from ..cmake_target import CMakeTarget
 from ..evaluation import EvaluationState
 from ..starlark.bazel_target import TargetId
-from ..starlark.common_providers import BuildSettingProvider
+from ..starlark.common_providers import BuildSettingInfo
 from ..starlark.common_providers import ConditionProvider
 from ..starlark.common_providers import FilesProvider
 from ..starlark.invocation_context import InvocationContext
@@ -344,20 +344,9 @@ def _write_file_impl(
 @register_bzl_library("@bazel_skylib//rules:common_settings.bzl")
 class BazelSkylibCommonSettingsLibrary(ScopeCommon):
 
-  BuildSettingInfo = provider(
-      doc="A singleton provider that contains the raw value of a build setting",
-      fields={
-          "value": (
-              "The value of the build setting in the current configuration. "
-              "This value may come from the command line or an upstream "
-              "transition, or else it will be the build setting's default."
-          ),
-      },
-  )
-
   @property
   def bazel_BuildSettingInfo(self):
-    return self.BuildSettingInfo
+    return BuildSettingInfo
 
   def bazel_bool_flag(
       self,
@@ -409,7 +398,7 @@ def _bool_flag_impl(
   _context.access(CMakeBuilder).addtext(
       f"""option({cmake_name} "" {"ON" if default_value else "OFF"})\n"""
   )
-  _context.add_analyzed_target(_target, TargetInfo(BuildSettingProvider(value)))
+  _context.add_analyzed_target(_target, TargetInfo(BuildSettingInfo(value)))
 
 
 def _string_flag_impl(
@@ -433,4 +422,4 @@ def _string_flag_impl(
   _context.access(CMakeBuilder).addtext(
       f"""option({cmake_name} "" {quote_string(value)})\n"""
   )
-  _context.add_analyzed_target(_target, TargetInfo(BuildSettingProvider(value)))
+  _context.add_analyzed_target(_target, TargetInfo(BuildSettingInfo(value)))

tools/cmake/bazel_to_cmake/evaluation.py

@@ -93,7 +93,7 @@
 from .starlark.bazel_target import PackageId
 from .starlark.bazel_target import RepositoryId
 from .starlark.bazel_target import TargetId
-from .starlark.common_providers import BuildSettingProvider
+from .starlark.common_providers import BuildSettingInfo
 from .starlark.common_providers import ConditionProvider
 from .starlark.common_providers import FilesProvider
 from .starlark.exec import compile_and_exec
@@ -403,8 +403,8 @@ def evaluate_condition(self, target_id: TargetId) -> Any:
     target_info = self.get_target_info(target_id)
     if target_info.get(ConditionProvider) is not None:
       return target_info[ConditionProvider].value
-    if target_info.get(BuildSettingProvider) is not None:
-      return target_info[BuildSettingProvider].value
+    if target_info.get(BuildSettingInfo) is not None:
+      return target_info[BuildSettingInfo].value
 
     print(f"Using {target_id.as_label()} as false condition.")
     return False

tools/cmake/bazel_to_cmake/main.py

@@ -34,7 +34,7 @@
 from .platforms import add_platform_constraints
 from .starlark.bazel_target import RepositoryId
 from .starlark.bazel_target import TargetId
-from .starlark.common_providers import BuildSettingProvider
+from .starlark.common_providers import BuildSettingInfo
 from .starlark.common_providers import ConditionProvider
 from .starlark.provider import TargetInfo
 from .util import get_matching_build_files
@@ -312,7 +312,7 @@ def run_main(args: argparse.Namespace):
     # * Build and configuration settings.
     def _persist_targetinfo(target: TargetId, info: TargetInfo):
       if (
-          info.get(BuildSettingProvider) is not None
+          info.get(BuildSettingInfo) is not None
           or info.get(ConditionProvider) is not None
       ):
         workspace.set_persistent_target_info(target, info)

tools/cmake/bazel_to_cmake/native_rules_alias.py

@@ -26,7 +26,7 @@
 from .cmake_target import CMakeTargetPair
 from .evaluation import EvaluationState
 from .starlark.bazel_target import TargetId
-from .starlark.common_providers import BuildSettingProvider
+from .starlark.common_providers import BuildSettingInfo
 from .starlark.common_providers import ConditionProvider
 from .starlark.invocation_context import InvocationContext
 from .starlark.label import RelativeLabel
@@ -67,7 +67,7 @@ def _alias_impl(
 
   # Special case any target info with conditions or build settings.
   if target_info.get(ConditionProvider) or target_info.get(
-      BuildSettingProvider
+      BuildSettingInfo
   ):
     _context.add_analyzed_target(_target, target_info)
     return

tools/cmake/bazel_to_cmake/native_rules_config.py

@@ -27,7 +27,7 @@
 from .evaluation import EvaluationState
 from .starlark import rule  # pylint: disable=unused-import
 from .starlark.bazel_target import TargetId
-from .starlark.common_providers import BuildSettingProvider
+from .starlark.common_providers import BuildSettingInfo
 from .starlark.common_providers import ConditionProvider
 from .starlark.invocation_context import InvocationContext
 from .starlark.label import RelativeLabel
@@ -80,9 +80,9 @@ def evaluate() -> bool:
       for flag, value in flag_values.items():
         flag_target = _context.resolve_target_or_label(flag)
         flag_info = _context.get_target_info(flag_target)
-        if not flag_info.get(BuildSettingProvider):
+        if not flag_info.get(BuildSettingInfo):
           return False
-        if str(flag_info[BuildSettingProvider].value) != value:
+        if str(flag_info[BuildSettingInfo].value) != value:
           return False
     if constraint_values:
       for constraint in _context.resolve_target_or_label_list(