build_defs/build_defs.bzl - intellij - Git at Google

 """Custom build macros for IntelliJ plugin handling.
 """

 load(":intellij_plugin.bzl", "intellij_plugin", "optional_plugin_xml")

 def merged_plugin_xml(name, srcs, **kwargs):
   """Merges N plugin.xml files together."""
   merge_tool = "//build_defs:merge_xml"
   native.genrule(
       name = name,
       srcs = srcs,
       outs = [name + ".xml"],
       cmd = "./$(location {merge_tool}) $(SRCS) > $@".format(
           merge_tool=merge_tool,
       ),
       tools = [merge_tool],
       **kwargs)

 def _optstr(name, value):
   return ("--" + name) if value else ""

 def stamped_plugin_xml(name,
                        plugin_xml,
                        plugin_id = None,
                        plugin_name = None,
                        stamp_since_build=False,
                        stamp_until_build=False,
                        include_product_code_in_stamp=False,
                        version=None,
                        version_file=None,
                        changelog_file=None,
                        description_file=None,
                        vendor_file=None,
                        **kwargs):
   """Stamps a plugin xml file with the IJ build number.

   Args:
     name: name of this target
     plugin_xml: target plugin_xml to stamp
     plugin_id: the plugin ID to stamp
     plugin_name: the plugin name to stamp
     stamp_since_build: Add build number to idea-version since-build.
     stamp_until_build: Add build number to idea-version until-build.
     include_product_code_in_stamp: Whether the product code (eg. "IC")
         is included in since-build and until-build.
     version: A version number to stamp.
     version_file: A file with the version number to be included.
     changelog_file: A file with the changelog to be included.
     description_file: A file containing a plugin description to be included.
     vendor_file: A file containing the vendor info to be included.
     **kwargs: Any additional arguments to pass to the final target.
   """
   stamp_tool = "//build_defs:stamp_plugin_xml"

   api_version_txt_name = name + "_api_version"
   api_version_txt(
       name = api_version_txt_name,
   )

   args = [
       "./$(location {stamp_tool})",
       "--plugin_xml=$(location {plugin_xml})",
       "--api_version_txt=$(location {api_version_txt_name})",
       "{stamp_since_build}",
       "{stamp_until_build}",
       "{include_product_code_in_stamp}",
   ]
   srcs = [plugin_xml, api_version_txt_name]

   if version and version_file:
     fail("Cannot supply both version and version_file")

   if plugin_id:
     args.append("--plugin_id=%s" % plugin_id)

   if plugin_name:
     args.append("--plugin_name='%s'" % plugin_name)

   if version:
     args.append("--version='%s'" % version)

   if version_file:
     args.append("--version_file=$(location {version_file})")
     srcs.append(version_file)

   if changelog_file:
     args.append("--changelog_file=$(location {changelog_file})")
     srcs.append(changelog_file)

   if description_file:
     args.append("--description_file=$(location {description_file})")
     srcs.append(description_file)

   if vendor_file:
     args.append("--vendor_file=$(location {vendor_file})")
     srcs.append(vendor_file)

   cmd = " ".join(args).format(
       plugin_xml=plugin_xml,
       api_version_txt_name=api_version_txt_name,
       stamp_tool=stamp_tool,
       stamp_since_build=_optstr("stamp_since_build",
                                 stamp_since_build),
       stamp_until_build=_optstr("stamp_until_build",
                                 stamp_until_build),
       include_product_code_in_stamp=_optstr(
           "include_product_code_in_stamp",
           include_product_code_in_stamp),
       version_file=version_file,
       changelog_file=changelog_file,
       description_file=description_file,
       vendor_file=vendor_file,
   ) + "> $@"

   native.genrule(
       name = name,
       srcs = srcs,
       outs = [name + ".xml"],
       cmd = cmd,
       tools = [stamp_tool],
       **kwargs)

 def product_build_txt(name, **kwargs):
   """Produces a product-build.txt file with the build number.

   Args:
     name: name of this target
     **kwargs: Any additional arguments to pass to the final target.
   """
   application_info_jar = "//intellij_platform_sdk:application_info_jar"
   application_info_name = "//intellij_platform_sdk:application_info_name"
   product_build_txt_tool = "//build_defs:product_build_txt"

   args = [
       "./$(location {product_build_txt_tool})",
       "--application_info_jar=$(location {application_info_jar})",
       "--application_info_name=$(location {application_info_name})",
   ]
   cmd = " ".join(args).format(
       application_info_jar=application_info_jar,
       application_info_name=application_info_name,
       product_build_txt_tool=product_build_txt_tool,
   ) + "> $@"
   native.genrule(
       name = name,
       srcs = [application_info_jar, application_info_name],
       outs = ["product-build.txt"],
       cmd = cmd,
       tools = [product_build_txt_tool],
       **kwargs)

 def api_version_txt(name, **kwargs):
   """Produces an api_version.txt file with the api version, including the product code.

   Args:
     name: name of this target
     **kwargs: Any additional arguments to pass to the final target.
   """
   application_info_jar = "//intellij_platform_sdk:application_info_jar"
   application_info_name = "//intellij_platform_sdk:application_info_name"
   api_version_txt_tool = "//build_defs:api_version_txt"

   args = [
       "./$(location {api_version_txt_tool})",
       "--application_info_jar=$(location {application_info_jar})",
       "--application_info_name=$(location {application_info_name})",
   ]
   cmd = " ".join(args).format(
       application_info_jar=application_info_jar,
       application_info_name=application_info_name,
       api_version_txt_tool=api_version_txt_tool,
   ) + "> $@"
   native.genrule(
       name = name,
       srcs = [application_info_jar, application_info_name],
       outs = [name + ".txt"],
       cmd = cmd,
       tools = [api_version_txt_tool],
       **kwargs)

 def beta_gensignature(name, srcs, stable, stable_version, beta_version):
   if stable_version == beta_version:
     native.alias(name = name, actual = stable)
   else:
     native.gensignature(name = name, srcs = srcs)

 repackaged_files_data = provider()

 def _repackaged_files_impl(ctx):
   prefix = ctx.attr.prefix
   if prefix.startswith("/"):
     fail("'prefix' must be a relative path")
   input_files = depset()
   for target in ctx.attr.srcs:
     input_files = input_files | target.files

   return [
       # TODO(brendandouglas): Only valid for Bazel 0.5 onwards. Uncomment when
       # 0.5 used more widely.
       # DefaultInfo(files = input_files),
       repackaged_files_data(
           files = input_files,
           prefix = prefix,
       )
   ]

 _repackaged_files = rule(
     implementation = _repackaged_files_impl,
     attrs = {
         "srcs": attr.label_list(mandatory = True, allow_files = True),
         "prefix": attr.string(mandatory = True),
     },
 )

 def repackaged_files(name, srcs, prefix, **kwargs):
   """Assembles files together so that they can be packaged as an IntelliJ plugin.

   A cut-down version of the internal 'pkgfilegroup' rule.

   Args:
     name: The name of this target
     srcs: A list of targets which are dependencies of this rule. All output files of each of these
         targets will be repackaged.
     prefix: Where the package should install these files, relative to the 'plugins' directory. The
         input file path is stripped prior to applying this prefix.
     **kwargs: Any further arguments to be passed to the target
   """
   _repackaged_files(name = name, srcs = srcs, prefix = prefix, **kwargs)

 def _plugin_deploy_zip_impl(ctx):
   zip_name = ctx.attr.zip_filename
   zip_file = ctx.new_file(zip_name)

   input_files = depset()
   exec_path_to_zip_path = {}
   for target in ctx.attr.srcs:
     data = target[repackaged_files_data]
     input_files = input_files | data.files
     for f in data.files:
       exec_path_to_zip_path[f.path] = data.prefix + "/" + f.basename

   args = []
   args.extend(["--output", zip_file.path])
   for exec_path, zip_path in exec_path_to_zip_path.items():
     args.extend([exec_path, zip_path])
   ctx.action(
       executable = ctx.executable._zip_plugin_files,
       arguments = args,
       inputs = list(input_files),
       outputs = [zip_file],
       mnemonic = "ZipPluginFiles",
       progress_message = "Creating final plugin zip archive",
   )
   files = depset([zip_file])
   return struct(
       files = files,
   )

 _plugin_deploy_zip = rule(
     implementation = _plugin_deploy_zip_impl,
     attrs = {
         "srcs": attr.label_list(mandatory = True, providers = []),
         "zip_filename": attr.string(mandatory = True),
         "_zip_plugin_files": attr.label(
             default = Label("//build_defs:zip_plugin_files"),
             executable = True,
             cfg = "host",
         ),
     }
 )

 def plugin_deploy_zip(name, srcs, zip_filename):
   """Packages up plugin files into a zip archive.

   Args:
     name: The name of this target
     srcs: A list of targets of type 'repackaged_files', specifying the input files and relative
         paths to include in the output zip archive.
     zip_filename: The output zip filename.
   """
   _plugin_deploy_zip(name = name, zip_filename = zip_filename, srcs = srcs)

 def unescape_filenames(name, srcs):
   """Macro to generate files with spaces in their names instead of underscores.

   For each file in the srcs, a file will be generated with the same name but with all underscores
   replaced with spaces.

   Args:
     name: The name of the generator rule
     srcs: A list of source files to process
   """
   outs = [s.replace("_", " ") for s in srcs]
   cmd = "&&".join(["cp \"{}\" $(@D)/\"{}\"".format(s, d) for (s,d) in zip(srcs, outs)])
   native.genrule(
       name = name,
       srcs = srcs,
       outs = outs,
       cmd = cmd,
   )
	"""Custom build macros for IntelliJ plugin handling.
	"""

	load(":intellij_plugin.bzl", "intellij_plugin", "optional_plugin_xml")

	def merged_plugin_xml(name, srcs, **kwargs):
	"""Merges N plugin.xml files together."""
	merge_tool = "//build_defs:merge_xml"
	native.genrule(
	name = name,
	srcs = srcs,
	outs = [name + ".xml"],
	cmd = "./$(location {merge_tool}) $(SRCS) > $@".format(
	merge_tool=merge_tool,
	),
	tools = [merge_tool],
	**kwargs)

	def _optstr(name, value):
	return ("--" + name) if value else ""

	def stamped_plugin_xml(name,
	plugin_xml,
	plugin_id = None,
	plugin_name = None,
	stamp_since_build=False,
	stamp_until_build=False,
	include_product_code_in_stamp=False,
	version=None,
	version_file=None,
	changelog_file=None,
	description_file=None,
	vendor_file=None,
	**kwargs):
	"""Stamps a plugin xml file with the IJ build number.

	Args:
	name: name of this target
	plugin_xml: target plugin_xml to stamp
	plugin_id: the plugin ID to stamp
	plugin_name: the plugin name to stamp
	stamp_since_build: Add build number to idea-version since-build.
	stamp_until_build: Add build number to idea-version until-build.
	include_product_code_in_stamp: Whether the product code (eg. "IC")
	is included in since-build and until-build.
	version: A version number to stamp.
	version_file: A file with the version number to be included.
	changelog_file: A file with the changelog to be included.
	description_file: A file containing a plugin description to be included.
	vendor_file: A file containing the vendor info to be included.
	**kwargs: Any additional arguments to pass to the final target.
	"""
	stamp_tool = "//build_defs:stamp_plugin_xml"

	api_version_txt_name = name + "_api_version"
	api_version_txt(
	name = api_version_txt_name,
	)

	args = [
	"./$(location {stamp_tool})",
	"--plugin_xml=$(location {plugin_xml})",
	"--api_version_txt=$(location {api_version_txt_name})",
	"{stamp_since_build}",
	"{stamp_until_build}",
	"{include_product_code_in_stamp}",
	]
	srcs = [plugin_xml, api_version_txt_name]

	if version and version_file:
	fail("Cannot supply both version and version_file")

	if plugin_id:
	args.append("--plugin_id=%s" % plugin_id)

	if plugin_name:
	args.append("--plugin_name='%s'" % plugin_name)

	if version:
	args.append("--version='%s'" % version)

	if version_file:
	args.append("--version_file=$(location {version_file})")
	srcs.append(version_file)

	if changelog_file:
	args.append("--changelog_file=$(location {changelog_file})")
	srcs.append(changelog_file)

	if description_file:
	args.append("--description_file=$(location {description_file})")
	srcs.append(description_file)

	if vendor_file:
	args.append("--vendor_file=$(location {vendor_file})")
	srcs.append(vendor_file)

	cmd = " ".join(args).format(
	plugin_xml=plugin_xml,
	api_version_txt_name=api_version_txt_name,
	stamp_tool=stamp_tool,
	stamp_since_build=_optstr("stamp_since_build",
	stamp_since_build),
	stamp_until_build=_optstr("stamp_until_build",
	stamp_until_build),
	include_product_code_in_stamp=_optstr(
	"include_product_code_in_stamp",
	include_product_code_in_stamp),
	version_file=version_file,
	changelog_file=changelog_file,
	description_file=description_file,
	vendor_file=vendor_file,
	) + "> $@"

	native.genrule(
	name = name,
	srcs = srcs,
	outs = [name + ".xml"],
	cmd = cmd,
	tools = [stamp_tool],
	**kwargs)

	def product_build_txt(name, **kwargs):
	"""Produces a product-build.txt file with the build number.

	Args:
	name: name of this target
	**kwargs: Any additional arguments to pass to the final target.
	"""
	application_info_jar = "//intellij_platform_sdk:application_info_jar"
	application_info_name = "//intellij_platform_sdk:application_info_name"
	product_build_txt_tool = "//build_defs:product_build_txt"

	args = [
	"./$(location {product_build_txt_tool})",
	"--application_info_jar=$(location {application_info_jar})",
	"--application_info_name=$(location {application_info_name})",
	]
	cmd = " ".join(args).format(
	application_info_jar=application_info_jar,
	application_info_name=application_info_name,
	product_build_txt_tool=product_build_txt_tool,
	) + "> $@"
	native.genrule(
	name = name,
	srcs = [application_info_jar, application_info_name],
	outs = ["product-build.txt"],
	cmd = cmd,
	tools = [product_build_txt_tool],
	**kwargs)

	def api_version_txt(name, **kwargs):
	"""Produces an api_version.txt file with the api version, including the product code.

	Args:
	name: name of this target
	**kwargs: Any additional arguments to pass to the final target.
	"""
	application_info_jar = "//intellij_platform_sdk:application_info_jar"
	application_info_name = "//intellij_platform_sdk:application_info_name"
	api_version_txt_tool = "//build_defs:api_version_txt"

	args = [
	"./$(location {api_version_txt_tool})",
	"--application_info_jar=$(location {application_info_jar})",
	"--application_info_name=$(location {application_info_name})",
	]
	cmd = " ".join(args).format(
	application_info_jar=application_info_jar,
	application_info_name=application_info_name,
	api_version_txt_tool=api_version_txt_tool,
	) + "> $@"
	native.genrule(
	name = name,
	srcs = [application_info_jar, application_info_name],
	outs = [name + ".txt"],
	cmd = cmd,
	tools = [api_version_txt_tool],
	**kwargs)

	def beta_gensignature(name, srcs, stable, stable_version, beta_version):
	if stable_version == beta_version:
	native.alias(name = name, actual = stable)
	else:
	native.gensignature(name = name, srcs = srcs)

	repackaged_files_data = provider()

	def _repackaged_files_impl(ctx):
	prefix = ctx.attr.prefix
	if prefix.startswith("/"):
	fail("'prefix' must be a relative path")
	input_files = depset()
	for target in ctx.attr.srcs:
	input_files = input_files \| target.files

	return [
	# TODO(brendandouglas): Only valid for Bazel 0.5 onwards. Uncomment when
	# 0.5 used more widely.
	# DefaultInfo(files = input_files),
	repackaged_files_data(
	files = input_files,
	prefix = prefix,
	)
	]

	_repackaged_files = rule(
	implementation = _repackaged_files_impl,
	attrs = {
	"srcs": attr.label_list(mandatory = True, allow_files = True),
	"prefix": attr.string(mandatory = True),
	},
	)

	def repackaged_files(name, srcs, prefix, **kwargs):
	"""Assembles files together so that they can be packaged as an IntelliJ plugin.

	A cut-down version of the internal 'pkgfilegroup' rule.

	Args:
	name: The name of this target
	srcs: A list of targets which are dependencies of this rule. All output files of each of these
	targets will be repackaged.
	prefix: Where the package should install these files, relative to the 'plugins' directory. The
	input file path is stripped prior to applying this prefix.
	**kwargs: Any further arguments to be passed to the target
	"""
	_repackaged_files(name = name, srcs = srcs, prefix = prefix, **kwargs)

	def _plugin_deploy_zip_impl(ctx):
	zip_name = ctx.attr.zip_filename
	zip_file = ctx.new_file(zip_name)

	input_files = depset()
	exec_path_to_zip_path = {}
	for target in ctx.attr.srcs:
	data = target[repackaged_files_data]
	input_files = input_files \| data.files
	for f in data.files:
	exec_path_to_zip_path[f.path] = data.prefix + "/" + f.basename

	args = []
	args.extend(["--output", zip_file.path])
	for exec_path, zip_path in exec_path_to_zip_path.items():
	args.extend([exec_path, zip_path])
	ctx.action(
	executable = ctx.executable._zip_plugin_files,
	arguments = args,
	inputs = list(input_files),
	outputs = [zip_file],
	mnemonic = "ZipPluginFiles",
	progress_message = "Creating final plugin zip archive",
	)
	files = depset([zip_file])
	return struct(
	files = files,
	)

	_plugin_deploy_zip = rule(
	implementation = _plugin_deploy_zip_impl,
	attrs = {
	"srcs": attr.label_list(mandatory = True, providers = []),
	"zip_filename": attr.string(mandatory = True),
	"_zip_plugin_files": attr.label(
	default = Label("//build_defs:zip_plugin_files"),
	executable = True,
	cfg = "host",
	),
	}
	)

	def plugin_deploy_zip(name, srcs, zip_filename):
	"""Packages up plugin files into a zip archive.

	Args:
	name: The name of this target
	srcs: A list of targets of type 'repackaged_files', specifying the input files and relative
	paths to include in the output zip archive.
	zip_filename: The output zip filename.
	"""
	_plugin_deploy_zip(name = name, zip_filename = zip_filename, srcs = srcs)

	def unescape_filenames(name, srcs):
	"""Macro to generate files with spaces in their names instead of underscores.

	For each file in the srcs, a file will be generated with the same name but with all underscores
	replaced with spaces.

	Args:
	name: The name of the generator rule
	srcs: A list of source files to process
	"""
	outs = [s.replace("_", " ") for s in srcs]
	cmd = "&&".join(["cp \"{}\" $(@D)/\"{}\"".format(s, d) for (s,d) in zip(srcs, outs)])
	native.genrule(
	name = name,
	srcs = srcs,
	outs = outs,
	cmd = cmd,
	)