This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.CodeQL.Cli.

Summary

Base class for all CodeQL Scanning tools.

Assembly

Cake.CodeQL.Cli.dll

Namespace

Cake.CodeQL.Cli

Base Types

Tool<TSettings>

Derived Types

graph BT Type-->Base0["Tool<TSettings>"] Type["CodeQLTool<TSettings>"] class Type type-node Derived0["CodeQLAnalyzeDatabaseTool"]-->Type click Derived0 "/api/Cake.CodeQL.Cli.Database/CodeQLAnalyzeDatabaseTool" Derived1["CodeQLCreateDatabaseTool"]-->Type click Derived1 "/api/Cake.CodeQL.Cli.Database/CodeQLCreateDatabaseTool" Derived2["CodeQLUploadResultsTool"]-->Type click Derived2 "/api/Cake.CodeQL.Cli.Upload/CodeQLUploadResultsTool"

Syntax

public abstract class CodeQLTool<TSettings> : Tool<TSettings> where TSettings : CodeQLToolSettings

Type Parameters

Name	Description
TSettings	The settings type.

Constructors

Name	Summary
CodeQLTool(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator, ICakeLog)	Initializes a new instance of the `CodeQLTool<TSettings>` class.

Properties

Name	Value	Summary
CakeLog	ICakeLog	Cake log instance.

Methods

Name	Value	Summary
GetAlternativeToolPaths(TSettings)	IEnumerable<FilePath>	CodeQL Installs into a subdirectory. This checks the subdirectories as well
GetArguments(TSettings)	ProcessArgumentBuilder	Builds the arguments for codeQL.
GetToolExecutableNames()	IEnumerable<string>	Gets the possible names of the tool executable.
GetToolName()	string	Gets the name of the tool.
RunCore(TSettings, ProcessSettings, Action<IProcess>)	void	Runs CodeQL.
RunCore(TSettings)	void	Runss CodeQL

Extension Methods

Name	Value	Summary
Dump<CodeQLTool<TSettings>>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<CodeQLTool<TSettings>>(CodeQLTool<TSettings>[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<CodeQLTool<TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<CodeQLTool<TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<CodeQLTool<TSettings>>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<CodeQLTool<TSettings>>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin