Extensions Docs Server: KILL BUILD.PY

chrome/common/extensions/docs/build/build.py

 #!/usr/bin/python
 # Copyright (c) 2012 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.
 
-"""Docbuilder for extension docs."""
-
-import glob
-import os
-import os.path
-import shutil
-import sys
-import time
-import urllib
-
-from subprocess import Popen, PIPE
-from optparse import OptionParser
-
-_script_path = os.path.realpath(__file__)
-_build_dir = os.path.dirname(_script_path)
-_base_dir = os.path.normpath(_build_dir + "/..")
-_static_dir = _base_dir + "/static"
-_js_dir = _base_dir + "/js"
-_template_dir = _base_dir + "/template"
-_samples_dir = _base_dir + "/examples"
-_extension_api_dir = os.path.normpath(_base_dir + "/../api")
-
-_extension_api_json_schemas = glob.glob(_extension_api_dir +
-                                        '/[a-zA-Z0-9]*.json')
-_extension_api_json_schemas += glob.glob(_extension_api_dir +
-                                         '/*/[a-zA-Z0-9]*.json')
-_extension_api_idl_schemas = glob.glob(_extension_api_dir +
-                                       '/[a-zA-Z0-9]*.idl')
-_extension_api_idl_schemas += glob.glob(_extension_api_dir +
-                                        '/*/[a-zA-Z0-9]*.idl')
-_api_template_html = _template_dir + "/api_template.html"
-_page_shell_html = _template_dir + "/page_shell.html"
-_generator_html = _build_dir + "/generator.html"
-_samples_json = _base_dir + "/samples.json"
-
-_expected_output_preamble = "#BEGIN"
-_expected_output_postamble = "#END"
-
-# HACK! This is required because we can only depend on python 2.4 and
-# the calling environment may not be setup to set the PYTHONPATH
-# Insert at the front so that we pick up our simplejson even if there's a
-# system simplejson installed, for predictable escaping.
-sys.path.insert(0, os.path.normpath(_base_dir +
-                   "/../../../../third_party"))
-import simplejson as json
-from directory import Sample
-from directory import ApiManifest
-from directory import SamplesManifest
-
-def RenderPages(family, dump_render_tree, single_page_name):
-  output_dir = os.path.join(_base_dir, family)
-  names = set(os.path.splitext(name)[0] for name in os.listdir(output_dir)
-              if not name.startswith(".") and name.endswith(".html"))
-
-  # Allow the user to render a single page if they want
-  if single_page_name:
-    if single_page_name in names:
-      names = [single_page_name]
-    else:
-      return []
-
-  generator_url = "file:" + urllib.pathname2url(_generator_html)
-  generator_url += "?" + family + "|" + ",".join(names)
-
-  # Start with a fresh copy of page shell for each file.
-  # Save the current contents so that we can look for changes later.
-  originals = {}
-  for name in names:
-    input_file = os.path.join(output_dir, name + ".html")
-
-    if (os.path.isfile(input_file)):
-      originals[name] = open(input_file, 'rb').read()
-      os.remove(input_file)
-    else:
-      originals[name] = ""
-
-    shutil.copy(_page_shell_html, input_file)
-
-  print generator_url
-
-  # Run DumpRenderTree and capture result
-  p = Popen([dump_render_tree, "--no-timeout", generator_url], stdout=PIPE)
-
-  # The remaining output will be the content of the generated pages.
-  output = p.stdout.read()
-
-  # Parse out just the JSON part.
-  begin = output.find(_expected_output_preamble)
-  end = output.rfind(_expected_output_postamble)
-
-  if (begin < 0 or end < 0):
-    raise Exception("%s returned invalid output:\n\n%s" %
-        (dump_render_tree, output))
-
-  begin += len(_expected_output_preamble)
-
-  try:
-    output_parsed = json.loads(output[begin:end])
-  except ValueError, msg:
-   raise Exception("Could not parse DumpRenderTree output as JSON. Error: " +
-                   msg + "\n\nOutput was:\n" + output)
-
-  changed_files = []
-  for name in names:
-    result = output_parsed[name].encode("utf8") + '\n'
-
-    # Remove CRs that are appearing from captured DumpRenderTree output.
-    result = result.replace('\r', '')
-
-    # Remove empty style attributes.
-    result = result.replace(' style=""', '')
-
-    # Remove page_shell
-    input_file = os.path.join(output_dir, name + ".html")
-    os.remove(input_file)
-
-    # Write output
-    open(input_file, 'wb').write(result)
-    if (originals[name] and result != originals[name]):
-      changed_files.append(input_file)
-
-  return changed_files
-
-
-def FindDumpRenderTree():
-  # This is hacky. It is used to guess the location of the DumpRenderTree
-  chrome_dir = os.path.normpath(_base_dir + "/../../../")
-  src_dir = os.path.normpath(chrome_dir + "/../")
-
-  search_locations = []
-
-  if (sys.platform in ('cygwin', 'win32')):
-    home_dir = os.path.normpath(os.getenv("HOMEDRIVE") + os.getenv("HOMEPATH"))
-    search_locations.append(src_dir + "/build/Release/DumpRenderTree.exe")
-    search_locations.append(src_dir + "/build/Debug/DumpRenderTree.exe")
-    search_locations.append(home_dir + "/bin/DumpRenderTree/"
-                            "DumpRenderTree.exe")
-
-  if (sys.platform.startswith('linux')):
-    search_locations.append(src_dir + "/sconsbuild/Release/DumpRenderTree")
-    search_locations.append(src_dir + "/out/Release/DumpRenderTree")
-    search_locations.append(src_dir + "/sconsbuild/Debug/DumpRenderTree")
-    search_locations.append(src_dir + "/out/Debug/DumpRenderTree")
-    search_locations.append(os.getenv("HOME") + "/bin/DumpRenderTree/"
-                            "DumpRenderTree")
-
-  if (sys.platform == 'darwin'):
-    search_locations.append(src_dir +
-        "/xcodebuild/Release/DumpRenderTree.app/Contents/MacOS/DumpRenderTree")
-    search_locations.append(src_dir +
-        "/xcodebuild/Debug/DumpRenderTree.app/Contents/MacOS/DumpRenderTree")
-    search_locations.append(src_dir +
-        "/out/Release/DumpRenderTree.app/Contents/MacOS/DumpRenderTree")
-    search_locations.append(src_dir +
-        "/out/Debug/DumpRenderTree.app/Contents/MacOS/DumpRenderTree")
-    search_locations.append(os.getenv("HOME") + "/bin/DumpRenderTree/" +
-                            "DumpRenderTree.app/Contents/MacOS/DumpRenderTree")
-
-  for loc in search_locations:
-    if os.path.isfile(loc):
-      return loc
-
-  raise Exception("Could not find DumpRenderTree executable\n"
-                  "**DumpRenderTree may need to be built**\n"
-                  "Searched: \n" + "\n".join(search_locations) + "\n"
-                  "To specify a path to DumpRenderTree use "
-                  "--dump-render-tree-path")
-
 def main():
-  # Prevent windows from using cygwin python.
-  if (sys.platform == "cygwin"):
-    sys.exit("Building docs not supported for cygwin python. Please run the "
-             "build.sh script instead, which uses depot_tools python.")
-
-  parser = OptionParser()
-  parser.add_option("--dump-render-tree-path", dest="dump_render_tree_path",
-                    metavar="PATH",
-                    help="path to DumpRenderTree executable")
-  parser.add_option("--page-name", dest="page_name", metavar="PAGE",
-                    help="only generate docs for PAGE.html")
-  parser.add_option("--nozip", dest="zips", action="store_false",
-                    help="do not generate zip files for samples",
-                    default=True)
-  options, args = parser.parse_args()
-
-  # This is a script that converts the documentation from the old style (using
-  # build.py, etc.) to the new style. The new docs and docs server can be found
-  # in the ../server2 directory.
-  Popen(['python',
-         os.path.join(_base_dir, 'server2', 'converter.py'),
-         os.path.join(_base_dir, 'static'),
-         os.path.join(_base_dir, os.pardir, 'api'),
-         os.path.join(_base_dir, 'server2', 'templates', 'articles'),
-         os.path.join(_base_dir, 'server2', 'templates', 'intros'),
-         os.path.join(_base_dir, 'server2', 'templates', 'public'),
-         os.path.join(_base_dir, 'server2', 'static', 'images'),
-         '-r'])
-
-  if (options.dump_render_tree_path and
-      os.path.isfile(options.dump_render_tree_path)):
-    dump_render_tree = options.dump_render_tree_path
-  else:
-    dump_render_tree = FindDumpRenderTree()
-
-  # Load the manifest of existing API Methods
-  api_manifest = ApiManifest(_extension_api_json_schemas,
-                             _extension_api_idl_schemas)
-
-  # Write temporary JSON files based on the IDL inputs
-  api_manifest.generateJSONFromIDL()
-
-  # Render a manifest file containing metadata about all the extension samples
-  samples_manifest = SamplesManifest(_samples_dir, _base_dir, api_manifest)
-  samples_manifest.writeToFile(_samples_json)
-
-  # Write zipped versions of the samples listed in the manifest to the
-  # filesystem, unless the user has disabled it
-  modified_files = []
-  if options.zips:
-    modified_files.extend(samples_manifest.writeZippedSamples())
-
-  doc_families = ["extensions", "apps"]
-  for family in doc_families:
-    modified_files.extend(
-        RenderPages(family, dump_render_tree, options.page_name))
-
-  if len(modified_files) == 0:
-    print "Output files match existing files. No changes made."
-  else:
-    print ("ATTENTION: EXTENSION DOCS HAVE CHANGED\n" +
-           "The following files have been modified and should be checked\n" +
-           "into source control (ideally in the same changelist as the\n" +
-           "underlying files that resulting in their changing).")
-    for f in modified_files:
-      print " * %s" % f
-
-  # Hack. Sleep here, otherwise windows doesn't properly close the debug.log
-  # and the os.remove will fail with a "Permission denied".
-  time.sleep(1)
-  debug_log = os.path.normpath(_build_dir + "/" + "debug.log")
-  if (os.path.isfile(debug_log)):
-    os.remove(debug_log)
-
-  # Cleanup our temporary IDL->JSON files
-  api_manifest.cleanupGeneratedFiles()
-
-  if 'EX_OK' in dir(os):
-    return os.EX_OK
-  else:
-    return 0
+  print("build.py is now DEAD. Don't torture yourself with it any more.")
+  print("")
+  print("Please see server2/README for the new way to update docs.")
 
 if __name__ == '__main__':
-  sys.exit(main())
+  main()