Makes GetBuildTime behave identically on all build types.

build/write_build_date_header.py

+#!/usr/bin/env python
+# Copyright (c) 2016 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+"""Writes a file that contains a define that approximates the build date.
+
+For unofficial builds, the build date is set to the most recent first Sunday
+of a month, in UTC time.
+
+For official builds, the build date is set to the current date (in UTC).
+
+It is also possible to explicitly set a build date to be used.
+
+The reason for using the first Sunday of a month for unofficial builds is that
+it is a time where invalidating the build cache shouldn't have major
+reprecussions (due to lower load).
+"""
+
+import argparse
+import calendar
+import datetime
+import os
+import sys
+
+
+def GetFirstSundayOfMonth(month, year):

[Nico, 2016/02/09 22:53:49]

nit: year, month order seems more natural

[Zachary Forman, 2016/02/09 23:26:23]

Fair - I think that's probably true in general. I was thinking d/m/y, but y/m/d
is what is used in general.

+  """Returns the first sunday of the given month of the given year."""
+  weeks = calendar.Calendar().monthdays2calendar(year, month)
+  # Return the first day in the first week that is a Sunday.
+  return [date_day[0] for date_day in weeks[0] if date_day[1] == 6][0]
+
+
+def GetBuildDate(build_type):
+  """Gets the approximate build date given the specific build type."""
+  gmt_now = datetime.datetime.utcnow()

[Nico, 2016/02/09 22:53:49]

i'd make gmt_now a parameter, then you could have an assert-like test like
mentioned for this too (this function has quite a bit of logic...)

[Zachary Forman, 2016/02/09 23:26:23]

I like this idea, will implement.

+  day = gmt_now.day
+  month = gmt_now.month
+  year = gmt_now.year
+  if build_type != 'official':
+    first_sunday = GetFirstSundayOfMonth(month, year)
+    # If our build is after the first Sunday, we've already refreshed our build
+    # cache on a quiet day, so just use that day.
+    # Otherwise, take the first Sunday of the previous month.
+    if day >= first_sunday:
+      day = first_sunday
+    else:
+      month -= 1
+      if month == 0:
+        month = 12
+        year -= 1
+      day = GetFirstSundayOfMonth(month, year)
+  return '{:%b %d %Y}'.format(datetime.date(year, month, day))
+

[Nico, 2016/02/09 22:53:49]

nit: For small scripts like this were having a dedicated _unittest.py file
doesn't seem worth it, I like to put in a few tests inline like

  assert GetFirstSundayOfMonth(13, 2014) == 4  # or whatever the expected value
is

That way, the tests run every time the script runs and there's at least some
testing (and they won't noticeable slow down the script)

[Zachary Forman, 2016/02/09 23:26:23]

I like this idea. Will implement.

+
+def main():
+  argument_parser = argparse.ArgumentParser()
+  argument_parser.add_argument('output_file', help='The file to write to')
+  argument_parser.add_argument('build_type', help='The type of build',
+                               choices=('official', 'default'))
+  argument_parser.add_argument('build_date_override', nargs='?',
+                               help='Optional override for the build date')
+  args = argument_parser.parse_args()
+
+  if args.build_date_override:
+    build_date = args.build_date_override
+  else:
+    build_date = GetBuildDate(args.build_type)
+
+  output = ('// Generated by //build/write_build_date_header.py\n'
+           '#ifndef BUILD_DATE\n'
+           '#define BUILD_DATE "{}"\n'
+           '#endif // BUILD_DATE\n'.format(build_date))
+
+  current_contents = ''
+  if os.path.isfile(args.output_file):
+    with open(args.output_file, 'r') as current_file:
+      current_contents = current_file.read()
+
+  if current_contents != output:
+    with open(args.output_file, 'w') as output_file:
+      output_file.write(output)
+  return 0
+
+
+if __name__ == '__main__':
+  sys.exit(main())