pkg/private/build_info.py

# Copyright 2021 The Bazel Authors. All rights reserved.
#
# 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.
"""Get BUILD_TIMESTAMP."""


def get_timestamp(volatile_status_file):
  """Get BUILD_TIMESTAMP as an integer.

  Reads a file of "name<space>value" pairs and returns the value
  of the BUILD_TIMESTAMP. The file should be in the workspace status
  format: https://docs.bazel.build/versions/master/user-manual.html#workspace_status
  
  Args:
    volatile_status_file: path to input file. Typically ctx.version_file.path.
  Returns:
    int: value of BUILD_TIMESTAMP
  Exceptions:
    Exception: Raised if there is no BUILD_TIMESTAMP or if it is not a number.
  """
  with open(volatile_status_file, 'r') as status_f:
    for line in status_f:
      parts = line.strip().split(' ')
      if len(parts) > 1 and parts[0] == 'BUILD_TIMESTAMP':
        return int(parts[1])
  raise Exception(
      "Invalid status file <%s>. Expected to find BUILD_TIMESTAMP" % volatile_status_file)