docs/versions/8.2.0/rules/lib/providers/InstrumentedFilesInfo.mdx - bazel - Git at Google

 <html devsite>
 <head>
   <meta name="project_path" value="/_project.yaml">
   <meta name="book_path" value="/versions/8.2.0/_book.yaml">
 </head>
 <body>

 <h1 class="page-title" id="modules.InstrumentedFilesInfo">InstrumentedFilesInfo</h1>

 {% dynamic setvar source_file "src/main/java/com/google/devtools/build/lib/starlarkbuildapi/test/InstrumentedFilesInfoApi.java" %}
 {% dynamic setvar version "8.2.0" %}
 {% dynamic setvar original_path "/rules/lib/providers/InstrumentedFilesInfo" %}
 {% include "_buttons.html" %}
 <!-- {% raw %} -->

 Contains information about source files and instrumentation metadata files for rule targets matched by <a href="https://bazel.build/versions/8.2.0/reference/command-line-reference#flag--instrumentation_filter"><code>--instrumentation_filter</code></a> for purposes of <a href="https://bazel.build/versions/8.2.0/extending/rules#code_coverage">code coverage data collection</a>. When coverage data collection is enabled, a manifest containing the combined paths in <a href="#instrumented_files"><code>instrumented_files</code></a> and <a href="#metadata_files"><code>metadata_files</code></a> are passed to the test action as inputs, with the manifest's path noted in the environment variable <code>COVERAGE_MANIFEST</code>. The metadata files, but not the source files, are also passed to the test action as inputs. When <code>InstrumentedFilesInfo</code> is returned by an <a href="https://bazel.build/versions/8.2.0/rules/aspects">aspect</a>'s implementation function, any <code>InstrumentedFilesInfo</code> from the base rule target is ignored.

 <h2>Members</h2>
 <ul>
     <li>
     <a href="#instrumented_files">instrumented_files</a>
   </li>
       <li>
     <a href="#metadata_files">metadata_files</a>
   </li>
   </ul>

       <h2 id="instrumented_files">instrumented_files</h2>
         <p><pre class="rule-signature"><a class="anchor" href="../builtins/depset.html">depset</a> InstrumentedFilesInfo.instrumented_files</pre></p>

     <a href="../builtins/depset.html"><code>depset</code></a> of <a href="../builtins/File.html"><code>File</code></a> objects representing instrumented source files for this target and its dependencies.


         <h2 id="metadata_files">metadata_files</h2>
         <p><pre class="rule-signature"><a class="anchor" href="../builtins/depset.html">depset</a> InstrumentedFilesInfo.metadata_files</pre></p>

     <a href="../builtins/depset.html"><code>depset</code></a> of <a href="../builtins/File.html"><code>File</code></a> objects representing coverage metadata files for this target and its dependencies. These files contain additional information required to generate LCOV-format coverage output after the code is executed, e.g. the <code>.gcno</code> files generated when <code>gcc</code> is run with <code>-ftest-coverage</code>.


 </body>
 </html>

 <!-- {% endraw %} -->
	<html devsite>
	<head>
	<meta name="project_path" value="/_project.yaml">
	<meta name="book_path" value="/versions/8.2.0/_book.yaml">
	</head>
	<body>

	<h1 class="page-title" id="modules.InstrumentedFilesInfo">InstrumentedFilesInfo</h1>

	{% dynamic setvar source_file "src/main/java/com/google/devtools/build/lib/starlarkbuildapi/test/InstrumentedFilesInfoApi.java" %}
	{% dynamic setvar version "8.2.0" %}
	{% dynamic setvar original_path "/rules/lib/providers/InstrumentedFilesInfo" %}
	{% include "_buttons.html" %}
	<!-- {% raw %} -->

	Contains information about source files and instrumentation metadata files for rule targets matched by <a href="https://bazel.build/versions/8.2.0/reference/command-line-reference#flag--instrumentation_filter"><code>--instrumentation_filter</code></a> for purposes of <a href="https://bazel.build/versions/8.2.0/extending/rules#code_coverage">code coverage data collection</a>. When coverage data collection is enabled, a manifest containing the combined paths in <a href="#instrumented_files"><code>instrumented_files</code></a> and <a href="#metadata_files"><code>metadata_files</code></a> are passed to the test action as inputs, with the manifest's path noted in the environment variable <code>COVERAGE_MANIFEST</code>. The metadata files, but not the source files, are also passed to the test action as inputs. When <code>InstrumentedFilesInfo</code> is returned by an <a href="https://bazel.build/versions/8.2.0/rules/aspects">aspect</a>'s implementation function, any <code>InstrumentedFilesInfo</code> from the base rule target is ignored.

	<h2>Members</h2>
	<ul>
	<li>
	<a href="#instrumented_files">instrumented_files</a>
	</li>
	<li>
	<a href="#metadata_files">metadata_files</a>
	</li>
	</ul>

	<h2 id="instrumented_files">instrumented_files</h2>
	<p><pre class="rule-signature"><a class="anchor" href="../builtins/depset.html">depset</a> InstrumentedFilesInfo.instrumented_files</pre></p>

	<a href="../builtins/depset.html"><code>depset</code></a> of <a href="../builtins/File.html"><code>File</code></a> objects representing instrumented source files for this target and its dependencies.


	<h2 id="metadata_files">metadata_files</h2>
	<p><pre class="rule-signature"><a class="anchor" href="../builtins/depset.html">depset</a> InstrumentedFilesInfo.metadata_files</pre></p>

	<a href="../builtins/depset.html"><code>depset</code></a> of <a href="../builtins/File.html"><code>File</code></a> objects representing coverage metadata files for this target and its dependencies. These files contain additional information required to generate LCOV-format coverage output after the code is executed, e.g. the <code>.gcno</code> files generated when <code>gcc</code> is run with <code>-ftest-coverage</code>.



	</body>
	</html>

	<!-- {% endraw %} -->