com.facebook.buck.support.fix

Class BuckFixSpecParser

java.lang.Object

com.facebook.buck.support.fix.BuckFixSpecParser

public class BuckFixSpecParser
extends Object

Creates a BuckFixSpec to pass to helper scripts from matching BuildLogEntry

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuckFixSpecParser.FixSpecFailure The various ways that trying to parse a FixSpec can fail

Constructor Summary

Constructors

Constructor and Description
BuckFixSpecParser()

Method Summary

Modifier and Type	Method and Description
static Either<BuckFixSpec,BuckFixSpecParser.FixSpecFailure>	parseFromBuildId(BuildLogHelper helper, FixBuckConfig fixConfig, BuildId buildId, boolean manuallyInvoked) Tries to construct a BuckFixSpec from a specific invocation of buck
static Either<BuckFixSpec,BuckFixSpecParser.FixSpecFailure>	parseFromBuildIdWithExitCode(BuildLogHelper helper, FixBuckConfig fixConfig, BuildId buildId, ExitCode exitCode, boolean manuallyInvoked, Optional<Exception> runException) Tries to construct a BuckFixSpec from a specific invocation of buck
static Either<BuckFixSpec,BuckFixSpecParser.FixSpecFailure>	parseFromFixSpecFile(Path fixSpecPath) Tries to parse a BuckFixSpec from a file already with the information of a fix spec.
static Either<BuckFixSpec,BuckFixSpecParser.FixSpecFailure>	parseLastCommand(BuildLogHelper helper, FixBuckConfig fixConfig, boolean manuallyInvoked) Tries to construct a BuckFixSpec from the newest invocation of buck

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BuckFixSpecParser

public BuckFixSpecParser()

Method Detail

parseLastCommand

public static Either<BuckFixSpec,BuckFixSpecParser.FixSpecFailure> parseLastCommand(BuildLogHelper helper,
                                                                                    FixBuckConfig fixConfig,
                                                                                    boolean manuallyInvoked)
                                                                             throws IOException

Tries to construct a BuckFixSpec from the newest invocation of buck

This excludes commands like fix, server, doctor, etc (see BuildLogHelper), and will not return a spec if required fields were not able to be found in the logs (e.g. if exitCode is missing, a useful spec will not be able to be constructed)

Parameters:

helper - The helper used to find all build logs

fixConfig - The configuration for this invocation of fix

manuallyInvoked - Whether or not this spec will be used in a command that was manually invoked

Returns:

A BuckFixSpec constructed from the build logs or an error if one could not be found or constructed

Throws:

IOException - There was a problem reading the logs on disk

parseFromBuildId

public static Either<BuckFixSpec,BuckFixSpecParser.FixSpecFailure> parseFromBuildId(BuildLogHelper helper,
                                                                                    FixBuckConfig fixConfig,
                                                                                    BuildId buildId,
                                                                                    boolean manuallyInvoked)
                                                                             throws IOException

Tries to construct a BuckFixSpec from a specific invocation of buck

A spec will not be returned if the log could not be found, or if required fields were not able to be found in the logs (e.g. if exitCode is missing, a useful spec will not be able to be constructed)

Parameters:

helper - The helper used to find all build logs

fixConfig - The configuration for this invocation of fix

buildId - The build id to look for

manuallyInvoked - Whether or not this spec will be used in a command that was manually invoked

Returns:

A BuckFixSpec constructed from the build logs or an error if one could not be found or constructed

Throws:

IOException - There was a problem reading the logs on disk

parseFromBuildIdWithExitCode

public static Either<BuckFixSpec,BuckFixSpecParser.FixSpecFailure> parseFromBuildIdWithExitCode(BuildLogHelper helper,
                                                                                                FixBuckConfig fixConfig,
                                                                                                BuildId buildId,
                                                                                                ExitCode exitCode,
                                                                                                boolean manuallyInvoked,
                                                                                                Optional<Exception> runException)
                                                                                         throws IOException

Tries to construct a BuckFixSpec from a specific invocation of buck

A spec will not be returned if the log could not be found, or if required fields were not able to be found in the logs (e.g. if command args are missing, a useful spec will not be able to be constructed)

Exit code is passed in, as there may not be enough information in the log yet (if this is called before the command has terminated) to otherwise construct a valid spec

Parameters:

helper - The helper used to find all build logs

fixConfig - The configuration for this invocation of fix

buildId - The build id to look for

exitCode - The exit code for the command

manuallyInvoked - Whether or not this spec will be used in a command that was manually invoked

Returns:

A BuckFixSpec constructed from the build logs

Throws:

IOException - There was a problem reading the logs on disk

parseFromFixSpecFile

public static Either<BuckFixSpec,BuckFixSpecParser.FixSpecFailure> parseFromFixSpecFile(Path fixSpecPath)
                                                                                 throws IOException

Tries to parse a BuckFixSpec from a file already with the information of a fix spec. This differs from other parse... methods in that it doesn't try to construct a fix spec from various different log files, only from a single spec file.

Parameters:

fixSpecPath - the absolute path to the fix spec file

Returns:

Either a BuckFixSpec or a Failure if the spec file is missing in the given path

Throws:

IOException - for any other error in the process of reading the file