codeql-action/src/codeql.ts at v4.30.8 · github/codeql-action · GitHub

History

1270 lines (1208 loc) · 39.7 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

import * as fs from "fs";

import * as path from "path";

import * as core from "@actions/core";

import * as toolrunner from "@actions/exec/lib/toolrunner";

import { RequestError } from "@octokit/request-error";

import * as yaml from "js-yaml";

import {

CommandInvocationError,

getActionVersion,

getOptionalInput,

runTool,

} from "./actions-util";

import * as api from "./api-client";

import { CliError, wrapCliConfigurationError } from "./cli-errors";

import { appendExtraQueryExclusions, type Config } from "./config-utils";

import { DocUrl } from "./doc-url";

import { EnvVar } from "./environment";

import {

CodeQLDefaultVersionInfo,

Feature,

FeatureEnablement,

} from "./feature-flags";

import { isAnalyzingDefaultBranch } from "./git-utils";

import { Language } from "./languages";

import { Logger } from "./logging";

import {

OverlayDatabaseMode,

writeBaseDatabaseOidsFile,

writeOverlayChangesFile,

} from "./overlay-database-utils";

import * as setupCodeql from "./setup-codeql";

import { ZstdAvailability } from "./tar";

import { ToolsDownloadStatusReport } from "./tools-download";

import { ToolsFeature, isSupportedToolsFeature } from "./tools-features";

import { shouldEnableIndirectTracing } from "./tracer-config";

import * as util from "./util";

import { BuildMode, getErrorMessage } from "./util";

type Options = Array<string | number | boolean>;

/**

* Extra command line options for the codeql commands.

interface ExtraOptions {

"*"?: Options;

database?: {

"*"?: Options;

init?: Options;

"trace-command"?: Options;

analyze?: Options;

finalize?: Options;

};

resolve?: {

"*"?: Options;

extractor?: Options;

queries?: Options;

};

github?: {

"*"?: Options;

"merge-results"?: Options;

};

}

export interface CodeQL {

/**

* Get the path of the CodeQL executable.

getPath(): string;

/**

* Get a string containing the semver version of the CodeQL executable.

getVersion(): Promise<VersionInfo>;

/**

* Print version information about CodeQL.

printVersion(): Promise<void>;

/**

* Returns whether the CodeQL executable supports the specified feature.

supportsFeature(feature: ToolsFeature): Promise<boolean>;

/**

* Returns whether the provided language is traced.

isTracedLanguage(language: Language): Promise<boolean>;

/**

* Returns whether the provided language is scanned.

isScannedLanguage(language: Language): Promise<boolean>;

/**

* Run 'codeql database init --db-cluster'.

databaseInitCluster(

config: Config,

sourceRoot: string,

processName: string | undefined,

qlconfigFile: string | undefined,

logger: Logger,

): Promise<void>;

/**

* Runs the autobuilder for the given language.

runAutobuild(config: Config, language: Language): Promise<void>;

/**

* Extract code for a scanned language using 'codeql database trace-command'

* and running the language extractor.

extractScannedLanguage(config: Config, language: Language): Promise<void>;

/**

* Extract code with 'codeql database trace-command --use-build-mode'. This can only be used when

* the database specifies a build mode. This requires the `traceCommandUseBuildMode` tool feature.

extractUsingBuildMode(config: Config, language: Language): Promise<void>;

/**

* Finalize a database using 'codeql database finalize'.

finalizeDatabase(

databasePath: string,

threadsFlag: string,

memoryFlag: string,

enableDebugLogging: boolean,

): Promise<void>;

/**

* Run 'codeql resolve languages'.

resolveLanguages(): Promise<ResolveLanguagesOutput>;

/**

* Run 'codeql resolve languages' with '--format=betterjson'.

betterResolveLanguages(options?: {

filterToLanguagesWithQueries: boolean;

}): Promise<BetterResolveLanguagesOutput>;

/**

* Run 'codeql resolve build-environment'

resolveBuildEnvironment(

workingDir: string | undefined,

language: string,

): Promise<ResolveBuildEnvironmentOutput>;

/**

* Clean up all the databases within a database cluster.

databaseCleanupCluster(config: Config, cleanupLevel: string): Promise<void>;

/**

* Run 'codeql database bundle'.

databaseBundle(

databasePath: string,

outputFilePath: string,

dbName: string,

): Promise<void>;

/**

* Run 'codeql database run-queries'. If no `queries` are specified, then the CLI

* will automatically use the `config-queries.qls` (if it exists) or default queries

* for the language.

databaseRunQueries(

databasePath: string,

flags: string[],

queries?: string[],

): Promise<void>;

/**

* Run 'codeql database interpret-results'.

databaseInterpretResults(

databasePath: string,

querySuitePaths: string[] | undefined,

sarifFile: string,

addSnippetsFlag: string,

threadsFlag: string,

verbosityFlag: string | undefined,

sarifRunPropertyFlag: string | undefined,

automationDetailsId: string | undefined,

config: Config,

features: FeatureEnablement,

): Promise<string>;

/**

* Run 'codeql database print-baseline'.

databasePrintBaseline(databasePath: string): Promise<string>;

/**

* Run 'codeql database export-diagnostics'

* Note that the "--sarif-include-diagnostics" option is always used, as the command should

* only be run if the ExportDiagnosticsEnabled feature flag is on.

databaseExportDiagnostics(

databasePath: string,

sarifFile: string,

automationDetailsId: string | undefined,

): Promise<void>;

/**

* Run 'codeql diagnostics export'.

diagnosticsExport(

sarifFile: string,

automationDetailsId: string | undefined,

config: Config,

): Promise<void>;

/** Get the location of an extractor for the specified language. */

resolveExtractor(language: Language): Promise<string>;

/**

* Run 'codeql resolve queries --format=startingpacks'.

resolveQueriesStartingPacks(queries: string[]): Promise<string[]>;

/**

* Run 'codeql github merge-results'.

mergeResults(

sarifFiles: string[],

outputFile: string,

options: { mergeRunsFromEqualCategory?: boolean },

): Promise<void>;

}

export interface VersionInfo {

version: string;

features?: { [name: string]: boolean };

/**

* The overlay version helps deal with backward incompatible changes for

* overlay analysis. When a precompiled query pack reports the same overlay

* version as the CodeQL CLI, we can use the CodeQL CLI to perform overlay

* analysis with that pack. Otherwise, if the overlay versions are different,

* or if either the pack or the CLI does not report an overlay version,

* we need to revert to non-overlay analysis.

overlayVersion?: number;

}

export interface ResolveLanguagesOutput {

[language: string]: [string];

}

export interface BetterResolveLanguagesOutput {

aliases?: {

[alias: string]: string;

};

extractors: {

[language: string]: [

{

extractor_root: string;

extractor_options?: any;

];

};

}

export interface ResolveBuildEnvironmentOutput {

configuration?: {

[language: string]: {

[key: string]: unknown;

};

}

/**

* Stores the CodeQL object, and is populated by `setupCodeQL` or `getCodeQL`.

let cachedCodeQL: CodeQL | undefined = undefined;

/**

* The oldest version of CodeQL that the Action will run with. This should be

* at least three minor versions behind the current version and must include the

* CLI versions shipped with each supported version of GHES.

* The version flags below can be used to conditionally enable certain features

* on versions newer than this.

const CODEQL_MINIMUM_VERSION = "2.16.6";

/**

* This version will shortly become the oldest version of CodeQL that the Action will run with.

const CODEQL_NEXT_MINIMUM_VERSION = "2.17.6";

/**

* This is the version of GHES that was most recently deprecated.

const GHES_VERSION_MOST_RECENTLY_DEPRECATED = "3.13";

/**

* This is the deprecation date for the version of GHES that was most recently deprecated.

const GHES_MOST_RECENT_DEPRECATION_DATE = "2025-06-19";

/** The CLI verbosity level to use for extraction in debug mode. */

const EXTRACTION_DEBUG_MODE_VERBOSITY = "progress++";

* Deprecated in favor of ToolsFeature.

* Versions of CodeQL that version-flag certain functionality in the Action.

* For convenience, please keep these in descending order. Once a version

* flag is older than the oldest supported version above, it may be removed.

/**

* Versions 2.17.1+ of the CodeQL CLI support the `--cache-cleanup` option.

const CODEQL_VERSION_CACHE_CLEANUP = "2.17.1";

/**

* Set up CodeQL CLI access.

* @param toolsInput

* @param apiDetails

* @param tempDir

* @param variant

* @param defaultCliVersion

* @param features Information about the features that are enabled.

* @param logger

* @param checkVersion Whether to check that CodeQL CLI meets the minimum

* version requirement. Must be set to true outside tests.

* @returns a { CodeQL, toolsVersion } object.

export async function setupCodeQL(

toolsInput: string | undefined,

apiDetails: api.GitHubApiDetails,

tempDir: string,

variant: util.GitHubVariant,

defaultCliVersion: CodeQLDefaultVersionInfo,

features: FeatureEnablement,

logger: Logger,

checkVersion: boolean,

): Promise<{

codeql: CodeQL;

toolsDownloadStatusReport?: ToolsDownloadStatusReport;

toolsSource: setupCodeql.ToolsSource;

toolsVersion: string;

zstdAvailability: ZstdAvailability;

}> {

try {

const {

codeqlFolder,

toolsDownloadStatusReport,

toolsSource,

toolsVersion,

zstdAvailability,

} = await setupCodeql.setupCodeQLBundle(

toolsInput,

apiDetails,

tempDir,

variant,

defaultCliVersion,

features,

logger,

);

logger.debug(

`Bundle download status report: ${JSON.stringify(

toolsDownloadStatusReport,

)}`,

);

let codeqlCmd = path.join(codeqlFolder, "codeql", "codeql");

if (process.platform === "win32") {

codeqlCmd += ".exe";

} else if (process.platform !== "linux" && process.platform !== "darwin") {

throw new util.ConfigurationError(

`Unsupported platform: ${process.platform}`,

);

}

cachedCodeQL = await getCodeQLForCmd(codeqlCmd, checkVersion);

return {

codeql: cachedCodeQL,

toolsDownloadStatusReport,

toolsSource,

toolsVersion,

zstdAvailability,

};

} catch (e) {

const ErrorClass =

e instanceof util.ConfigurationError ||

(e instanceof Error && e.message.includes("ENOSPC")) || // out of disk space

(e instanceof RequestError && e.status === 429) // rate limited

? util.ConfigurationError

: Error;

throw new ErrorClass(

`Unable to download and extract CodeQL CLI: ${getErrorMessage(e)}${

e instanceof Error && e.stack ? `\n\nDetails: ${e.stack}` : ""

}`,

);

}

/**

* Use the CodeQL executable located at the given path.

export async function getCodeQL(cmd: string): Promise<CodeQL> {

if (cachedCodeQL === undefined) {

cachedCodeQL = await getCodeQLForCmd(cmd, true);

}

return cachedCodeQL;

}

/**

* Overrides the CodeQL object. Only for use in tests that cannot override

* CodeQL via dependency injection.

* Accepts a partial object. Any undefined methods will be implemented

* to immediately throw an exception indicating which method is missing.

export function setCodeQL(codeql: Partial<CodeQL>): void {

cachedCodeQL = createStubCodeQL(codeql);

}

function resolveFunction<T>(

partialCodeql: Partial<CodeQL>,

methodName: string,

defaultImplementation?: T,

): T {

if (typeof partialCodeql[methodName] !== "function") {

if (defaultImplementation !== undefined) {

return defaultImplementation;

}

const dummyMethod = () => {

throw new Error(`CodeQL ${methodName} method not correctly defined`);

};

return dummyMethod as T;

}

return partialCodeql[methodName] as T;

}

/**

* Creates a stub CodeQL object. Only for use in tests.

* Accepts a partial object. Any undefined methods will be implemented

* to immediately throw an exception indicating which method is missing.

export function createStubCodeQL(partialCodeql: Partial<CodeQL>): CodeQL {

return {

getPath: resolveFunction(partialCodeql, "getPath", () => "/tmp/dummy-path"),

getVersion: resolveFunction(partialCodeql, "getVersion", async () => ({

version: "1.0.0",

})),

printVersion: resolveFunction(partialCodeql, "printVersion"),

supportsFeature: resolveFunction(

partialCodeql,

"supportsFeature",

async (feature) =>

!!partialCodeql.getVersion &&

isSupportedToolsFeature(await partialCodeql.getVersion(), feature),

isTracedLanguage: resolveFunction(partialCodeql, "isTracedLanguage"),

isScannedLanguage: resolveFunction(partialCodeql, "isScannedLanguage"),

databaseInitCluster: resolveFunction(partialCodeql, "databaseInitCluster"),

runAutobuild: resolveFunction(partialCodeql, "runAutobuild"),

extractScannedLanguage: resolveFunction(

partialCodeql,

"extractScannedLanguage",

extractUsingBuildMode: resolveFunction(

partialCodeql,

"extractUsingBuildMode",

finalizeDatabase: resolveFunction(partialCodeql, "finalizeDatabase"),

resolveLanguages: resolveFunction(partialCodeql, "resolveLanguages"),

betterResolveLanguages: resolveFunction(

partialCodeql,

"betterResolveLanguages",

async () => ({ aliases: {}, extractors: {} }),

resolveBuildEnvironment: resolveFunction(

partialCodeql,

"resolveBuildEnvironment",

databaseCleanupCluster: resolveFunction(

partialCodeql,

"databaseCleanupCluster",

databaseBundle: resolveFunction(partialCodeql, "databaseBundle"),

databaseRunQueries: resolveFunction(partialCodeql, "databaseRunQueries"),

databaseInterpretResults: resolveFunction(

partialCodeql,

"databaseInterpretResults",

databasePrintBaseline: resolveFunction(

partialCodeql,

"databasePrintBaseline",

databaseExportDiagnostics: resolveFunction(

partialCodeql,

"databaseExportDiagnostics",

diagnosticsExport: resolveFunction(partialCodeql, "diagnosticsExport"),

resolveExtractor: resolveFunction(partialCodeql, "resolveExtractor"),

resolveQueriesStartingPacks: resolveFunction(

partialCodeql,

"resolveQueriesStartingPacks",

mergeResults: resolveFunction(partialCodeql, "mergeResults"),

};

}

/**

* Get a real, newly created CodeQL instance for testing. The instance refers to

* a non-existent placeholder codeql command, so tests that use this function

* should also stub the toolrunner.ToolRunner constructor.

export async function getCodeQLForTesting(

cmd = "codeql-for-testing",

): Promise<CodeQL> {

return getCodeQLForCmd(cmd, false);

}

/**

* Return a CodeQL object for CodeQL CLI access.

* @param cmd Path to CodeQL CLI

* @param checkVersion Whether to check that CodeQL CLI meets the minimum

* version requirement. Must be set to true outside tests.

* @returns A new CodeQL object

export async function getCodeQLForCmd(

cmd: string,

checkVersion: boolean,

): Promise<CodeQL> {

const codeql: CodeQL = {

getPath() {

return cmd;

async getVersion() {

let result = util.getCachedCodeQlVersion();

if (result === undefined) {

const output = await runCli(cmd, ["version", "--format=json"], {

noStreamStdout: true,

});

try {

result = JSON.parse(output) as VersionInfo;

} catch {

throw Error(

`Invalid JSON output from \`version --format=json\`: ${output}`,

);

}

util.cacheCodeQlVersion(result);

}

return result;

async printVersion() {

await runCli(cmd, ["version", "--format=json"]);

async supportsFeature(feature: ToolsFeature) {

return isSupportedToolsFeature(await this.getVersion(), feature);

async isTracedLanguage(language: Language) {

const extractorPath = await this.resolveExtractor(language);

const tracingConfigPath = path.join(

extractorPath,

"tools",

"tracing-config.lua",

);

return fs.existsSync(tracingConfigPath);

async isScannedLanguage(language: Language) {

return !(await this.isTracedLanguage(language));

async databaseInitCluster(

config: Config,

sourceRoot: string,

processName: string | undefined,

qlconfigFile: string | undefined,

logger: Logger,

) {

const extraArgs = config.languages.map(

(language) => `--language=${language}`,

);

if (await shouldEnableIndirectTracing(codeql, config)) {

extraArgs.push("--begin-tracing");

extraArgs.push(...(await getTrapCachingExtractorConfigArgs(config)));

extraArgs.push(`--trace-process-name=${processName}`);

}

const codeScanningConfigFile = await writeCodeScanningConfigFile(

config,

logger,

);

const externalRepositoryToken = getOptionalInput(

"external-repository-token",

);

extraArgs.push(`--codescanning-config=${codeScanningConfigFile}`);

if (externalRepositoryToken) {

extraArgs.push("--external-repository-token-stdin");

}

if (config.buildMode !== undefined) {

extraArgs.push(`--build-mode=${config.buildMode}`);

}

if (qlconfigFile !== undefined) {

extraArgs.push(`--qlconfig-file=${qlconfigFile}`);

}

const overwriteFlag = isSupportedToolsFeature(

await this.getVersion(),

ToolsFeature.ForceOverwrite,

)

? "--force-overwrite"

: "--overwrite";

const overlayDatabaseMode = config.overlayDatabaseMode;

if (overlayDatabaseMode === OverlayDatabaseMode.Overlay) {

const overlayChangesFile = await writeOverlayChangesFile(

config,

sourceRoot,

logger,

);

extraArgs.push(`--overlay-changes=${overlayChangesFile}`);

} else if (overlayDatabaseMode === OverlayDatabaseMode.OverlayBase) {

extraArgs.push("--overlay-base");

}

await runCli(

cmd,

[

"database",

"init",

...(overlayDatabaseMode === OverlayDatabaseMode.Overlay

? []

: [overwriteFlag]),

"--db-cluster",

config.dbLocation,

`--source-root=${sourceRoot}`,

"--calculate-language-specific-baseline",

"--extractor-include-aliases",

"--sublanguage-file-coverage",

...extraArgs,

...getExtraOptionsFromEnv(["database", "init"], {

ignoringOptions: ["--overwrite"],

}),

{ stdin: externalRepositoryToken },

);

if (overlayDatabaseMode === OverlayDatabaseMode.OverlayBase) {

await writeBaseDatabaseOidsFile(config, sourceRoot);

}

async runAutobuild(config: Config, language: Language) {

applyAutobuildAzurePipelinesTimeoutFix();

const autobuildCmd = path.join(

await this.resolveExtractor(language),

"tools",

process.platform === "win32" ? "autobuild.cmd" : "autobuild.sh",

);

// Bump the verbosity of the autobuild command if we're in debug mode

if (config.debugMode) {

process.env[EnvVar.CLI_VERBOSITY] =

process.env[EnvVar.CLI_VERBOSITY] || EXTRACTION_DEBUG_MODE_VERBOSITY;

}

// On macOS, System Integrity Protection (SIP) typically interferes with

// CodeQL build tracing of protected binaries.

// The usual workaround is to prefix `$CODEQL_RUNNER` to build commands:

// `$CODEQL_RUNNER` (not to be confused with the deprecated CodeQL Runner tool)

// points to a simple wrapper binary included with the CLI, and the extra layer of

// process indirection helps the tracer bypass SIP.

// The above SIP workaround is *not* needed here.

// At the `autobuild` step in the Actions workflow, we assume the `init` step

// has successfully run, and will have exported `DYLD_INSERT_LIBRARIES`

// into the environment of subsequent steps, to activate the tracer.

// When `DYLD_INSERT_LIBRARIES` is set in the environment for a step,

// the Actions runtime introduces its own workaround for SIP

// (https://github.com/actions/runner/pull/416).

await runCli(autobuildCmd);

async extractScannedLanguage(config: Config, language: Language) {

await runCli(cmd, [

"database",

"trace-command",

"--index-traceless-dbs",

...(await getTrapCachingExtractorConfigArgsForLang(config, language)),

...getExtractionVerbosityArguments(config.debugMode),

...getExtraOptionsFromEnv(["database", "trace-command"]),

util.getCodeQLDatabasePath(config, language),

]);

async extractUsingBuildMode(config: Config, language: Language) {

if (config.buildMode === BuildMode.Autobuild) {

applyAutobuildAzurePipelinesTimeoutFix();

}

try {

await runCli(cmd, [

"database",

"trace-command",

"--use-build-mode",

"--working-dir",

process.cwd(),

...(await getTrapCachingExtractorConfigArgsForLang(config, language)),

...getExtractionVerbosityArguments(config.debugMode),

...getExtraOptionsFromEnv(["database", "trace-command"]),

util.getCodeQLDatabasePath(config, language),

]);

} catch (e) {

if (config.buildMode === BuildMode.Autobuild) {

const prefix =

"We were unable to automatically build your code. " +

"Please change the build mode for this language to manual and specify build steps " +

`for your project. See ${DocUrl.AUTOMATIC_BUILD_FAILED} for more information.`;

throw new util.ConfigurationError(`${prefix} ${getErrorMessage(e)}`);

} else {

throw e;

}

async finalizeDatabase(

databasePath: string,

threadsFlag: string,

memoryFlag: string,

enableDebugLogging: boolean,

) {

const args = [

"database",

"finalize",

"--finalize-dataset",

threadsFlag,

memoryFlag,

...getExtractionVerbosityArguments(enableDebugLogging),

...getExtraOptionsFromEnv(["database", "finalize"]),

databasePath,

];

await runCli(cmd, args);

async resolveLanguages() {

const codeqlArgs = [

"resolve",

"languages",

"--format=json",

...getExtraOptionsFromEnv(["resolve", "languages"]),

];

const output = await runCli(cmd, codeqlArgs);

try {

return JSON.parse(output) as ResolveLanguagesOutput;

} catch (e) {

throw new Error(

`Unexpected output from codeql resolve languages: ${e}`,

);

}

async betterResolveLanguages(

{

filterToLanguagesWithQueries,

}: {

filterToLanguagesWithQueries: boolean;

} = { filterToLanguagesWithQueries: false },

) {

const codeqlArgs = [

"resolve",

"languages",

"--format=betterjson",

"--extractor-options-verbosity=4",

"--extractor-include-aliases",

...(filterToLanguagesWithQueries

? ["--filter-to-languages-with-queries"]

: []),

...getExtraOptionsFromEnv(["resolve", "languages"]),

];

const output = await runCli(cmd, codeqlArgs);

try {

return JSON.parse(output) as BetterResolveLanguagesOutput;

} catch (e) {

throw new Error(

`Unexpected output from codeql resolve languages with --format=betterjson: ${e}`,

);

}

async resolveBuildEnvironment(

workingDir: string | undefined,

language: string,

) {

const codeqlArgs = [

"resolve",

"build-environment",

`--language=${language}`,

"--extractor-include-aliases",

...getExtraOptionsFromEnv(["resolve", "build-environment"]),

];

if (workingDir !== undefined) {

codeqlArgs.push("--working-dir", workingDir);

}

const output = await runCli(cmd, codeqlArgs);

try {

return JSON.parse(output) as ResolveBuildEnvironmentOutput;

} catch (e) {

throw new Error(

`Unexpected output from codeql resolve build-environment: ${e} in\n${output}`,

);

}

async databaseRunQueries(

databasePath: string,

flags: string[],

queries: string[] = [],

): Promise<void> {

const codeqlArgs = [

"database",

"run-queries",

...flags,

databasePath,

"--min-disk-free=1024", // Try to leave at least 1GB free

"-v",

...queries,

...getExtraOptionsFromEnv(["database", "run-queries"], {

ignoringOptions: ["--expect-discarded-cache"],

}),

];

await runCli(cmd, codeqlArgs);

async databaseInterpretResults(

databasePath: string,

querySuitePaths: string[] | undefined,

sarifFile: string,

addSnippetsFlag: string,

threadsFlag: string,

verbosityFlag: string,

sarifRunPropertyFlag: string | undefined,

automationDetailsId: string | undefined,

config: Config,

features: FeatureEnablement,

): Promise<string> {

const shouldExportDiagnostics = await features.getValue(

Feature.ExportDiagnosticsEnabled,

this,

);

const codeqlArgs = [

"database",

"interpret-results",

threadsFlag,

"--format=sarif-latest",

verbosityFlag,

`--output=${sarifFile}`,

addSnippetsFlag,

"--print-diagnostics-summary",

"--print-metrics-summary",

"--sarif-add-baseline-file-info",

`--sarif-codescanning-config=${getGeneratedCodeScanningConfigPath(

config,

)}`,

"--sarif-group-rules-by-pack",

"--sarif-include-query-help=always",

"--sublanguage-file-coverage",

...(await getJobRunUuidSarifOptions(this)),

...getExtraOptionsFromEnv(["database", "interpret-results"]),

];

if (sarifRunPropertyFlag !== undefined) {

codeqlArgs.push(sarifRunPropertyFlag);

}

if (automationDetailsId !== undefined) {

codeqlArgs.push("--sarif-category", automationDetailsId);

}

if (shouldExportDiagnostics) {

codeqlArgs.push("--sarif-include-diagnostics");

} else {

codeqlArgs.push("--no-sarif-include-diagnostics");

}

if (

!isSupportedToolsFeature(

await this.getVersion(),

ToolsFeature.AnalysisSummaryV2IsDefault,

)

) {

codeqlArgs.push("--new-analysis-summary");

}

codeqlArgs.push(databasePath);

if (querySuitePaths) {

codeqlArgs.push(...querySuitePaths);

}

// Capture the stdout, which contains the analysis summary. Don't stream it to the Actions

// logs to avoid printing it twice.

return await runCli(cmd, codeqlArgs, {

noStreamStdout: true,

});

async databasePrintBaseline(databasePath: string): Promise<string> {

const codeqlArgs = [

"database",

"print-baseline",

...getExtraOptionsFromEnv(["database", "print-baseline"]),

databasePath,

];

return await runCli(cmd, codeqlArgs);

async databaseCleanupCluster(

config: Config,

cleanupLevel: string,

): Promise<void> {

const cacheCleanupFlag = (await util.codeQlVersionAtLeast(

this,

CODEQL_VERSION_CACHE_CLEANUP,

))

? "--cache-cleanup"

: "--mode";

for (const language of config.languages) {

const databasePath = util.getCodeQLDatabasePath(config, language);

const codeqlArgs = [

"database",

"cleanup",

databasePath,

`${cacheCleanupFlag}=${cleanupLevel}`,

...getExtraOptionsFromEnv(["database", "cleanup"]),

];

await runCli(cmd, codeqlArgs);

}

async databaseBundle(

databasePath: string,

outputFilePath: string,

databaseName: string,

): Promise<void> {

const args = [

"database",

"bundle",

databasePath,

`--output=${outputFilePath}`,

`--name=${databaseName}`,

...getExtraOptionsFromEnv(["database", "bundle"]),

];

await new toolrunner.ToolRunner(cmd, args).exec();

async databaseExportDiagnostics(

databasePath: string,

sarifFile: string,

automationDetailsId: string | undefined,

): Promise<void> {

const args = [

"database",

"export-diagnostics",

`${databasePath}`,

"--db-cluster", // Database is always a cluster for CodeQL versions that support diagnostics.

"--format=sarif-latest",

`--output=${sarifFile}`,

"--sarif-include-diagnostics", // ExportDiagnosticsEnabled is always true if this command is run.

"-vvv",

...getExtraOptionsFromEnv(["diagnostics", "export"]),

];

if (automationDetailsId !== undefined) {

args.push("--sarif-category", automationDetailsId);

}

await new toolrunner.ToolRunner(cmd, args).exec();

async diagnosticsExport(

sarifFile: string,

automationDetailsId: string | undefined,

config: Config,

): Promise<void> {

const args = [

"diagnostics",

"export",

"--format=sarif-latest",

`--output=${sarifFile}`,

`--sarif-codescanning-config=${getGeneratedCodeScanningConfigPath(

config,

)}`,

...getExtraOptionsFromEnv(["diagnostics", "export"]),

];

if (automationDetailsId !== undefined) {

args.push("--sarif-category", automationDetailsId);

}

await new toolrunner.ToolRunner(cmd, args).exec();

async resolveExtractor(language: Language): Promise<string> {

// Request it using `format=json` so we don't need to strip the trailing new line generated by

// the CLI.

let extractorPath = "";

await new toolrunner.ToolRunner(

cmd,

[

"resolve",

"extractor",

"--format=json",

`--language=${language}`,

"--extractor-include-aliases",

...getExtraOptionsFromEnv(["resolve", "extractor"]),

{

silent: true,

listeners: {

stdout: (data) => {

extractorPath += data.toString();

stderr: (data) => {

process.stderr.write(data);

).exec();

return JSON.parse(extractorPath) as string;

async resolveQueriesStartingPacks(queries: string[]): Promise<string[]> {

const codeqlArgs = [

"resolve",

"queries",

View remainder of file in raw view

codeql-action/src/codeql.ts at v4.30.8 · github/codeql-action · GitHub

Expand file tree

Breadcrumbs

codeql.ts

Latest commit

History

Breadcrumbs

codeql.ts

File metadata and controls