The manifest's format is specifiable by {@link ManifestType}, in accordance with the needs of * the calling functionality. * *
Note that this action carefully avoids building the manifest content in memory.
*/
@AutoCodec
@Immutable // if all ManifestWriter implementations are immutable
public final class SourceManifestAction extends AbstractFileWriteAction {
private static final String GUID = "07459553-a3d0-4d37-9d78-18ed942470f4";
/**
* Interface for defining manifest formatting and reporting specifics. Implementations must be
* immutable.
*/
@VisibleForTesting
interface ManifestWriter {
/**
* Writes a single line of manifest output.
*
* @param manifestWriter the output stream
* @param rootRelativePath path of an entry relative to the manifest's root
* @param symlink (optional) symlink that resolves the above path
*/
void writeEntry(Writer manifestWriter, PathFragment rootRelativePath,
@Nullable Artifact symlink) throws IOException;
/**
* Fulfills {@link com.google.devtools.build.lib.actions.AbstractAction#getMnemonic()}
*/
String getMnemonic();
/**
* Fulfills {@link com.google.devtools.build.lib.actions.AbstractAction#getRawProgressMessage()}
*/
String getRawProgressMessage();
/**
* Fulfills {@link AbstractFileWriteAction#isRemotable()}.
* @return
*/
boolean isRemotable();
}
/**
* The strategy we use to write manifest entries.
*/
private final ManifestWriter manifestWriter;
/**
* The runfiles for which to create the symlink tree.
*/
private final Runfiles runfiles;
/**
* Creates a new AbstractSourceManifestAction instance using latin1 encoding to write the manifest
* file and with a specified root path for manifest entries.
*
* @param manifestWriter the strategy to use to write manifest entries
* @param owner the action owner
* @param primaryOutput the file to which to write the manifest
* @param runfiles runfiles
*/
@VisibleForSerialization
SourceManifestAction(
ManifestWriter manifestWriter, ActionOwner owner, Artifact primaryOutput, Runfiles runfiles) {
super(owner, getDependencies(runfiles), primaryOutput, false);
this.manifestWriter = manifestWriter;
this.runfiles = runfiles;
}
/** The {@link Runfiles} for which this action creates the symlink tree. */
public Runfiles getGeneratedRunfiles() {
return runfiles;
}
@VisibleForTesting
public void writeOutputFile(OutputStream out, EventHandler eventHandler)
throws IOException {
writeFile(out, runfiles.getRunfilesInputs(eventHandler, getOwner().getLocation()));
}
@Override
public DeterministicWriter newDeterministicWriter(ActionExecutionContext ctx)
throws IOException {
final Map This strategy is suitable for creating an input manifest to a source view tree. Its
* output is a valid input to
* {@link com.google.devtools.build.lib.analysis.actions.SymlinkTreeAction}.
*/
SOURCE_SYMLINKS {
@Override
public void writeEntry(Writer manifestWriter, PathFragment rootRelativePath, Artifact symlink)
throws IOException {
manifestWriter.append(rootRelativePath.getPathString());
// This trailing whitespace is REQUIRED to process the single entry line correctly.
manifestWriter.append(' ');
if (symlink != null) {
manifestWriter.append(symlink.getPath().getPathString());
}
manifestWriter.append('\n');
}
@Override
public String getMnemonic() {
return "SourceSymlinkManifest";
}
@Override
public String getRawProgressMessage() {
return "Creating source manifest";
}
@Override
public boolean isRemotable() {
// There is little gain to remoting these, since they include absolute path names inline.
return false;
}
},
/**
* Writes each line as:
*
* [rootRelativePath]
*
* This strategy is suitable for an input into a packaging system (notably .par) that
* consumes a list of all source files but needs that list to be constant with respect to
* how the user has their client laid out on local disk.
*/
SOURCES_ONLY {
@Override
public void writeEntry(Writer manifestWriter, PathFragment rootRelativePath, Artifact symlink)
throws IOException {
manifestWriter.append(rootRelativePath.getPathString());
manifestWriter.append('\n');
manifestWriter.flush();
}
@Override
public String getMnemonic() {
return "PackagingSourcesManifest";
}
@Override
public String getRawProgressMessage() {
return "Creating file sources list";
}
@Override
public boolean isRemotable() {
// Source-only symlink manifest has root-relative paths and does not include absolute paths.
return true;
}
}
}
/** Creates an action for the given runfiles. */
public static SourceManifestAction forRunfiles(ManifestType manifestType, ActionOwner owner,
Artifact output, Runfiles runfiles) {
return new SourceManifestAction(manifestType, owner, output, runfiles);
}
/**
* Builder class to construct {@link SourceManifestAction} instances.
*/
public static final class Builder {
private final ManifestWriter manifestWriter;
private final ActionOwner owner;
private final Artifact output;
private final Runfiles.Builder runfilesBuilder;
public Builder(String prefix, ManifestType manifestType, ActionOwner owner, Artifact output,
boolean legacyExternalRunfiles) {
this(manifestType, owner, output, new Runfiles.Builder(prefix, legacyExternalRunfiles));
}
public Builder(
ManifestType manifestType,
ActionOwner owner,
Artifact output,
Runfiles.Builder runfilesBuilder) {
this.manifestWriter = manifestType;
this.owner = owner;
this.output = output;
this.runfilesBuilder = runfilesBuilder;
}
@VisibleForTesting // Only used for testing.
Builder(String prefix, ManifestWriter manifestWriter, ActionOwner owner, Artifact output) {
this.runfilesBuilder = new Runfiles.Builder(prefix, false);
this.manifestWriter = manifestWriter;
this.owner = owner;
this.output = output;
}
public SourceManifestAction build() {
return new SourceManifestAction(manifestWriter, owner, output, runfilesBuilder.build());
}
/**
* Adds a set of symlinks from the artifacts' root-relative paths to the
* artifacts themselves.
*/
public Builder addSymlinks(Iterable Adds a mapping of Artifacts to the directory above the normal symlink
* forest base.
*/
public Builder addRootSymlinks(Map