Split off 'Google' category into separate ADMX/ADML files

components/policy/tools/create_google_admx.py

+#!/usr/bin/env python
+# Copyright (c) 2011 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.
+
+"""Creates google.admx and google.adml base files in all output folders.
+"""
+
+import grd_helper
+import optparse
+import os
+import sys
+
+
+def CreateGoogleAdmx(path):
+  '''Creates an ADMX template at |path| that defines a Google namespace and a
+  Google category.
+
+  Args:
+    path: File path to create the template at.
+  '''
+  f = open(path, 'w')
+  f.write("<?xml version=\"1.0\" ?>\n\
+<policyDefinitions revision=\"1.0\" schemaVersion=\"1.0\">\n\
+  <policyNamespaces>\n\
+    <target namespace=\"Google.Policies\" prefix=\"Google\"/>\n\
+  </policyNamespaces>\n\
+  <resources minRequiredRevision=\"1.0\" />\n\
+  <categories>\n\
+    <category displayName=\"$(string.google)\" name=\"Cat_Google\"/>\n\
+  </categories>\n\
+</policyDefinitions>\n")
+  f.close()
+
+
+def CreateGoogleAdml(path):
+  '''Creates an ADML template at |path| that defines a single string 'Google'.
+
+  Args:
+    path: File path to create the template at.
+  '''
+  f = open(path, 'w')
+  f.write("<?xml version=\"1.0\" ?>\n\
+<policyDefinitionResources revision=\"1.0\" schemaVersion=\"1.0\">\n\
+  <displayName/>\n\
+  <description/>\n\
+  <resources>\n\
+    <stringTable>\n\
+      <string id=\"google\">Google</string>\n\
+    </stringTable>\n\
+  </resources>\n\
+</policyDefinitionResources>\n")
+  f.close()
+
+
+def main(argv):
+  """Creates google.admx and google.adml files for every admx resp. adml files
+  in the grit outputs.
+  Usage: create_google_admx
+            --basedir <dir>                  Base file path of output files.
+            <grid options as defined in grd_helper>
+  """
+  parser = optparse.OptionParser()
+  parser.add_option("--basedir", dest="basedir")
+  grd_helper.add_options(parser)
+  options, args = parser.parse_args(argv[1:])
+
+  file_list = grd_helper.get_grd_outputs(options)

[Nico, 2016/11/18 17:27:16]

since all those are inputs too they too need to go in the depfile

[ljusten (tachyonic), 2016/11/19 17:12:35]

This should be fine. The files are defined in the grd file, which I'll list as
input file. Thus, file_list cannot change unless the grd file changes, which
will retrigger this script.

But I just noticed that pack_policy_templates also lists them as input, so I'll
do the same.

[Nico, 2016/11/19 17:50:57]

A grd change will trigger a rebuild, but if the grd file doesn't change but the
grd file gets reprocessed (due to its inputs changing) and hence the grd outputs
change, you want the build to run your script afterwards. I think this part is
still Missing from the build graph atm (?)

[ljusten (tachyonic), 2016/11/19 23:41:23]

What kind of inputs could change the output of the grd file? To my
understanding, the outputs are all listed in the grd file and there are no
inputs that could change the outputs (except maybe for grit defines, but those
shouldn't cause issues).

Also note that I added 'policy_templates_windows_outputs' to the inputs. These
*are* the outputs of the grd file. They're defined in the gni file (not the
grd), but there's some magic in the policy_templates grit target that makes sure
that the outputs defined in the gni file actually match the grd outputs. That
should be enough to guarantee that we don't miss any inputs.

[Nico, 2016/11/21 16:00:38]

So only the list of output filenames is important, not the contents of those
files? I meant something could write an output file with the same name again.

+  for path in file_list:
+    directory, filename = os.path.split(path)
+    filename, extension = os.path.splitext(filename)
+    google_path = os.path.join(options.basedir, directory, "google" + extension)
+    if extension == ".admx":
+      CreateGoogleAdmx(google_path)
+    elif extension == ".adml":
+      CreateGoogleAdml(google_path)
+
+if '__main__' == __name__:
+  sys.exit(main(sys.argv))