BinaryDockerToolOutputParser
Related Doc:
package parser
Parses output from tool docker from a String delimited by separator
Parses output from tool docker from a String delimited by separator
whether if the failure of parsing a line should be logged as debug or error
implicit play-json Reads that is capable of deserializing a tool result
Parses output from tool docker from a Seq[String]
Parses output from tool docker from a Seq[String]
whether if the failure of parsing a line should be logged as debug or error
implicit play-json Reads that is capable of deserializing a tool result
Parses output from tool docker from a Sequence of Strings
If resultSeparator does not match the default separator for tool output lines, commandResult will be
concatenated into a single string using the default separator (for compatibility with CommandRunners parsing of output)
before splitting it by the resultSeparator delimiter
Example:
if a tool that uses '\0' for separator of results outputs:
{ a: "foo", \n c: "bar" }\0
the com.codacy.plugins.utils.CommandRunner will return it as a List( """{ a: "foo", """ , " c: "bar" }\0" ).
Parses output from tool docker from a Sequence of Strings
If resultSeparator does not match the default separator for tool output lines, commandResult will be
concatenated into a single string using the default separator (for compatibility with CommandRunners parsing of output)
before splitting it by the resultSeparator delimiter
Example:
if a tool that uses '\0' for separator of results outputs:
{ a: "foo", \n c: "bar" }\0
the com.codacy.plugins.utils.CommandRunner will return it as a List( """{ a: "foo", """ , " c: "bar" }\0" ).
This list does not map directly to one result per String in the collection. This method should then be applied
as following:
parseOutput( List( """{ a: "foo", """ , " c: "bar" }\0" ) , Some('\0') ) to properly parse the results
the results of executing a tool (split by '\n')
an optional value for the custom separator of this output
implicit play-json Reads that is capable of deserializing a tool result of type T
This class is an implementation of a parser from String to a specific JSON structure definition The BinaryDockerToolOutputParser is a specific implementation that allows parsing for output that isn't necessarily separated by the default separator for the output of tool dockers (This specific implementation is necessary because com.codacy.plugins.runners.BinaryDockerRunner uses com.codacy.plugins.utils.CommandRunner to execute and get output from tool dockers. This output is automatically split by '\n' char although this might not be the correct delimiter for each result that is outputed, but it still may be used as content of results)
the format to which the json should deserialize to