codeql-action/src/setup-codeql.ts at default-setup-testing · github/codeql-action · GitHub

Repository navigation

History

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 { OutgoingHttpHeaders } from "http";

import * as path from "path";

import { performance } from "perf_hooks";

import * as toolcache from "@actions/tool-cache";

import * as semver from "semver";

import { v4 as uuidV4 } from "uuid";

import { ActionState } from "./action-common";

import {

isAnalyzingPullRequest,

isDynamicWorkflow,

isGitHubHostedRunner,

} from "./actions-util";

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

import {

CodeQLBundle,

CodeQLDownloadSource,

getCodeQLBundleFromUrl,

getCodeQLBundleName,

} from "./codeql-bundle";

import * as defaults from "./defaults.json";

import {

addNoLanguageDiagnostic,

makeDiagnostic,

makeTelemetryDiagnostic,

} from "./diagnostics";

import { EnvVar, exportEnvVar, getEnv } from "./environment";

import {

CODEQL_VERSION_ZSTD_BUNDLE,

CodeQLDefaultVersionInfo,

CodeQLVersionInfo,

Feature,

FeatureEnablement,

} from "./feature-flags";

import { BuiltInLanguage } from "./languages";

import { Logger } from "./logging";

import { getCodeQlVersionsForOverlayBaseDatabases } from "./overlay/caching";

import {

getPerLanguageBundleLanguage,

logPerLanguageBundleFallback,

} from "./per-language-bundles";

import { getBundlePlatform } from "./platform";

import { getCodeQLAssetDownloadURL } from "./setup/repository";

import * as tar from "./tar";

import {

deleteToolcacheBundles,

downloadAndExtract,

getToolcacheDirectory,

isToolcacheOnWorkspaceFilesystem,

ToolsDownloadStatusReport,

writeToolcacheMarkerFile,

} from "./tools-download";

import * as util from "./util";

import { isGoodVersion } from "./util";

export type { CodeQLDownloadSource } from "./codeql-bundle";

export enum ToolsSource {

Unknown = "UNKNOWN",

Local = "LOCAL",

Toolcache = "TOOLCACHE",

Download = "DOWNLOAD",

}

const CODEQL_NIGHTLIES_REPOSITORY_OWNER = "dsp-testing";

const CODEQL_NIGHTLIES_REPOSITORY_NAME = "codeql-cli-nightlies";

const CODEQL_BUNDLE_VERSION_ALIAS: string[] = ["linked", "latest"];

const CODEQL_NIGHTLY_TOOLS_INPUTS = ["nightly", "nightly-latest"];

const CODEQL_TOOLCACHE_INPUT = "toolcache";

function tryGetBundleVersionFromTagName(

tagName: string,

logger: Logger,

): string | undefined {

const match = tagName.match(/^codeql-bundle-(.+)$/);

if (match === null || match.length < 2) {

logger.debug(`Could not determine bundle version from tag ${tagName}.`);

return undefined;

}

return match[1];

}

export function tryGetTagNameFromUrl(

url: string,

logger: Logger,

): string | undefined {

const matches = [...url.matchAll(/\/(codeql-bundle-[^/]*)\//g)];

if (matches.length === 0) {

logger.debug(`Could not determine tag name for URL ${url}.`);

return undefined;

}

// Example: https://github.com/org/codeql-bundle-testing/releases/download/codeql-bundle-v2.19.0/codeql-bundle-linux64.tar.zst

// We require a trailing forward slash to be part of the match, so the last match gives us the tag

// name. An alternative approach would be to also match against `/releases/`, but this approach

// assumes less about the structure of the URL.

const match = matches[matches.length - 1];

if (match?.length !== 2) {

logger.debug(

`Could not determine tag name for URL ${url}. Matched ${JSON.stringify(

match,

)}.`,

);

return undefined;

}

return match[1];

}

export function convertToSemVer(version: string, logger: Logger): string {

if (!semver.valid(version)) {

logger.debug(

`Bundle version ${version} is not in SemVer format. Will treat it as pre-release 0.0.0-${version}.`,

);

version = `0.0.0-${version}`;

}

const s = semver.clean(version);

if (!s) {

throw new Error(`Bundle version ${version} is not in SemVer format.`);

}

return s;

}

export type CodeQLToolsSource =

| {

codeqlTarPath: string;

compressionMethod: tar.CompressionMethod;

sourceType: "local";

/** Human-readable description of the source of the tools for telemetry purposes. */

toolsVersion: "local";

}

| {

codeqlFolder: string;

sourceType: "toolcache";

/** Human-readable description of the source of the tools for telemetry purposes. */

toolsVersion: string;

}

| CodeQLDownloadSource;

/**

* Look for a version of the CodeQL tools in the cache which could override the requested CLI version.

async function findOverridingToolsInCache(

humanReadableVersion: string,

logger: Logger,

): Promise<CodeQLToolsSource | undefined> {

const candidates = toolcache

.findAllVersions("CodeQL")

.filter(isGoodVersion)

.map((version) => ({

folder: toolcache.find("CodeQL", version),

version,

}))

.filter(({ folder }) => fs.existsSync(path.join(folder, "pinned-version")));

if (candidates.length === 1) {

const candidate = candidates[0];

logger.debug(

`CodeQL tools version ${candidate.version} in toolcache overriding version ${humanReadableVersion}.`,

);

return {

codeqlFolder: candidate.folder,

sourceType: "toolcache",

toolsVersion: candidate.version,

};

} else if (candidates.length === 0) {

logger.debug(

"Did not find any candidate pinned versions of the CodeQL tools in the toolcache.",

);

} else {

logger.debug(

"Could not use CodeQL tools from the toolcache since more than one candidate pinned " +

"version was found in the toolcache.",

);

}

return undefined;

}

/**

* Returns the sorted set of enabled versions that have cached overlay-base databases for the

* given languages.

export async function getEnabledVersionsWithOverlayBaseDatabases(

defaultCliVersion: CodeQLDefaultVersionInfo,

rawLanguages: string[] | undefined,

logger: Logger,

): Promise<CodeQLVersionInfo[]> {

if (rawLanguages === undefined || rawLanguages.length === 0) {

return [];

}

let cachedVersions: string[] | undefined;

try {

cachedVersions = await getCodeQlVersionsForOverlayBaseDatabases(

rawLanguages,

logger,

);

} catch (e) {

logger.warning(

"Could not list overlay-base databases in the Actions cache while choosing a default " +

`CodeQL CLI version, falling back to the highest enabled version. Details: ${util.getErrorMessage(e)}`,

);

return [];

}

if (cachedVersions === undefined || cachedVersions.length === 0) {

return [];

}

const cachedVersionsSet = new Set(cachedVersions);

return defaultCliVersion.enabledVersions.filter((v) =>

cachedVersionsSet.has(v.cliVersion),

);

}

/**

* Resolves the newest enabled default CLI version that has a cached overlay-base database for the

* relevant languages, if this is a Code Scanning analysis of a pull request, multiple default

* versions are enabled, and such a version exists. Otherwise, falls back to the newest enabled

* default CLI version.

async function resolveDefaultCliVersion(

defaultCliVersion: CodeQLDefaultVersionInfo,

rawLanguages: string[] | undefined,

useOverlayAwareDefaultCliVersion: boolean,

logger: Logger,

): Promise<CodeQLVersionInfo> {

if (

!useOverlayAwareDefaultCliVersion ||

// Listing the Actions cache can't change which version we use if only one version is enabled.

defaultCliVersion.enabledVersions.length === 1 ||

!isAnalyzingPullRequest()

) {

return defaultCliVersion.enabledVersions[0];

}

const overlayVersions = await getEnabledVersionsWithOverlayBaseDatabases(

defaultCliVersion,

rawLanguages,

logger,

);

if (overlayVersions.length > 0) {

logger.info(

`Using CodeQL version ${overlayVersions[0].cliVersion} since this is the ` +

`highest enabled version that has a cached overlay-base database.`,

);

return overlayVersions[0];

}

return defaultCliVersion.enabledVersions[0];

}

/**

* Determines where the CodeQL CLI we want to use comes from. This can be from a local file,

* the Actions toolcache, or a download.

* @param toolsInput The argument provided for the `tools` input, if any.

* @param defaultCliVersion The default CLI version that's linked to the CodeQL Action.

* @param rawLanguages Raw set of languages.

* @param otherLanguagePacksReason Why the CodeQL CLI may need packs for languages other than

* `rawLanguages`, or `undefined` if it won't. If defined, the combined bundle is used. See

* `PerLanguageBundleOptions.otherLanguagePacksReason`.

* @param useOverlayAwareDefaultCliVersion Whether to select an overlay-aware default CLI version.

* @param apiDetails Information about the GitHub API.

* @param variant The GitHub variant we are running on.

* @param tarSupportsZstd Whether zstd is supported by `tar`.

* @param features Information about enabled features.

* @param logger The logger to use.

* @returns Information about where the CodeQL CLI we want to use comes from.

export async function getCodeQLSource(

toolsInput: string | undefined,

defaultCliVersion: CodeQLDefaultVersionInfo,

rawLanguages: string[] | undefined,

otherLanguagePacksReason: string | undefined,

useOverlayAwareDefaultCliVersion: boolean,

apiDetails: api.GitHubApiDetails,

variant: util.GitHubVariant,

tarSupportsZstd: boolean,

features: FeatureEnablement,

logger: Logger,

): Promise<CodeQLToolsSource> {

// If there is an explicit `tools` input, it's not one of the reserved values, and it doesn't appear

// to point to a URL, then we assume it is a local path and use the CLI from there.

// TODO: This appears to misclassify filenames that happen to start with `http` as URLs.

if (

toolsInput &&

!isReservedToolsValue(toolsInput) &&

!toolsInput.startsWith("http")

) {

logger.info(`Using CodeQL CLI from local path ${toolsInput}`);

const compressionMethod = tar.inferCompressionMethod(toolsInput);

if (compressionMethod === undefined) {

throw new util.ConfigurationError(

`Could not infer compression method from path ${toolsInput}. Please specify a path ` +

"ending in '.tar.gz' or '.tar.zst'.",

);

}

return {

codeqlTarPath: toolsInput,

compressionMethod,

sourceType: "local",

toolsVersion: "local",

};

}

/** Requested CLI version number, for example 2.12.6. */

let cliVersion: string | undefined;

/** Tag name of the CodeQL bundle, for example `codeql-bundle-20230120`. */

let tagName: string | undefined;

/**

* URL of the CodeQL bundle.

* This does not always include a tag name.

let url: string | undefined;

let bundle: CodeQLBundle | undefined;

// We allow forcing the nightly CLI via the FF for `dynamic` events (or in test mode) where the

// `tools` input cannot be adjusted to explicitly request it.

const canForceNightlyWithFF = isDynamicWorkflow() || util.isInTestMode();

const forceNightlyValueFF = await features.getValue(Feature.ForceNightly);

const forceNightly = forceNightlyValueFF && canForceNightlyWithFF;

// For advanced workflows, a value from `CODEQL_NIGHTLY_TOOLS_INPUTS` can be specified explicitly

// for the `tools` input. This is the computed input, so it may come from the repository property

// rather than the workflow file.

const nightlyRequestedByToolsInput =

toolsInput !== undefined &&

CODEQL_NIGHTLY_TOOLS_INPUTS.includes(toolsInput);

if (forceNightly || nightlyRequestedByToolsInput) {

if (forceNightly) {

logger.info(

`Using the latest CodeQL CLI nightly, as forced by the ${Feature.ForceNightly} feature flag.`,

);

addNoLanguageDiagnostic(

undefined,

makeDiagnostic(

"codeql-action/forced-nightly-cli",

"A nightly release of CodeQL was used",

{

markdownMessage:

"GitHub configured this analysis to use a nightly release of CodeQL to allow you to preview changes from an upcoming release.\n\n" +

"Nightly releases do not undergo the same validation as regular releases and may lead to analysis instability.\n\n" +

"If use of a nightly CodeQL release for this analysis is unexpected, please contact GitHub support.",

visibility: {

cliSummaryTable: true,

statusPage: true,

telemetry: true,

severity: "note",

);

} else {

logger.info(

`Using the latest CodeQL CLI nightly, as requested by 'tools: ${toolsInput}'.`,

);

}

bundle = await getLatestNightlyBundle(

{ env: getEnv(), logger },

rawLanguages,

otherLanguagePacksReason,

variant,

);

toolsInput = bundle.url;

}

/**

* Whether the tools shipped with the Action, i.e. those in `defaults.json`, have been forced.

* We use the special value of 'linked' to prioritize the version in `defaults.json` over the

* version specified by the feature flags on Dotcom and over any pinned cached version on

* Enterprise Server.

* Previously we have been using 'latest' to force the shipped tools, but this was not clear

* enough for the users, so it has been changed to `linked`. We're keeping around `latest` for

* backwards compatibility.

const forceShippedTools =

toolsInput && CODEQL_BUNDLE_VERSION_ALIAS.includes(toolsInput);

if (forceShippedTools) {

cliVersion = defaults.cliVersion;

tagName = defaults.bundleVersion;

logger.info(

`'tools: ${toolsInput}' was requested, so using CodeQL version ${cliVersion}, the version shipped with the Action.`,

);

if (toolsInput === "latest") {

logger.warning(

"`tools: latest` has been renamed to `tools: linked`, but the old name is still supported. No action is required.",

);

}

} else if (

toolsInput !== undefined &&

toolsInput === CODEQL_TOOLCACHE_INPUT

) {

let latestToolcacheVersion: string | undefined;

// We only allow `toolsInput === "toolcache"` for `dynamic` events. In general, using `toolsInput === "toolcache"`

// can lead to alert wobble and so it shouldn't be used for an analysis where results are intended to be uploaded.

// We also allow this in test mode.

const allowToolcacheValue = isDynamicWorkflow() || util.isInTestMode();

if (allowToolcacheValue) {

// If `toolsInput === "toolcache"`, try to find the latest version of the CLI that's available in the toolcache

// and use that. We perform this check here since we can set `cliVersion` directly and don't want to default to

// the linked version.

logger.info(

`Attempting to use the latest CodeQL CLI version in the toolcache, as requested by 'tools: ${toolsInput}'.`,

);

latestToolcacheVersion = getLatestToolcacheVersion(logger);

if (latestToolcacheVersion) {

cliVersion = latestToolcacheVersion;

}

if (latestToolcacheVersion === undefined) {

if (allowToolcacheValue) {

logger.info(

`Found no CodeQL CLI in the toolcache, ignoring 'tools: ${toolsInput}'...`,

);

} else {

logger.warning(

`Ignoring 'tools: ${toolsInput}' because the workflow was not triggered dynamically.`,

);

}

const version = await resolveDefaultCliVersion(

defaultCliVersion,

rawLanguages,

useOverlayAwareDefaultCliVersion,

logger,

);

cliVersion = version.cliVersion;

tagName = version.tagName;

}

} else if (toolsInput !== undefined) {

// If a tools URL was provided, then use that.

tagName = tryGetTagNameFromUrl(toolsInput, logger);

url = toolsInput;

if (tagName) {

const bundleVersion = tryGetBundleVersionFromTagName(tagName, logger);

// If the bundle version is a semantic version, it is a CLI version number.

if (bundleVersion !== undefined && semver.valid(bundleVersion)) {

cliVersion = convertToSemVer(bundleVersion, logger);

}

} else {

const version = await resolveDefaultCliVersion(

defaultCliVersion,

rawLanguages,

useOverlayAwareDefaultCliVersion,

logger,

);

cliVersion = version.cliVersion;

tagName = version.tagName;

}

const bundleVersion =

tagName !== undefined

? tryGetBundleVersionFromTagName(tagName, logger)

: undefined;

const resolvedVersion =

cliVersion ??

(bundleVersion !== undefined

? convertToSemVer(bundleVersion, logger)

: undefined);

const humanReadableVersion = resolvedVersion ?? tagName ?? url ?? "unknown";

logger.debug(

"Attempting to obtain CodeQL tools. " +

`CLI version: ${cliVersion ?? "unknown"}, ` +

`bundle tag name: ${tagName ?? "unknown"}, ` +

`URL: ${url ?? "unspecified"}.`,

);

let codeqlFolder: string | undefined;

if (cliVersion) {

// If we find the specified CLI version, we always use that.

codeqlFolder = toolcache.find("CodeQL", cliVersion);

// Fall back to matching `x.y.z-<tagName>`.

if (!codeqlFolder) {

logger.debug(

"Didn't find a version of the CodeQL tools in the toolcache with a version number " +

`exactly matching ${cliVersion}.`,

);

const allVersions = toolcache.findAllVersions("CodeQL");

logger.debug(

`Found the following versions of the CodeQL tools in the toolcache: ${JSON.stringify(

allVersions,

)}.`,

);

// If there is exactly one version of the CodeQL tools in the toolcache, and that version is

// the form `x.y.z-<tagName>`, then use it.

const candidateVersions = allVersions.filter((version) =>

version.startsWith(`${cliVersion}-`),

);

if (candidateVersions.length === 1) {

logger.debug(

`Exactly one version of the CodeQL tools starting with ${cliVersion} found in the ` +

"toolcache, using that.",

);

codeqlFolder = toolcache.find("CodeQL", candidateVersions[0]);

} else if (candidateVersions.length === 0) {

logger.debug(

`Didn't find any versions of the CodeQL tools starting with ${cliVersion} ` +

`in the toolcache. Trying next fallback method.`,

);

} else {

logger.warning(

`Found ${candidateVersions.length} versions of the CodeQL tools starting with ` +

`${cliVersion} in the toolcache, but at most one was expected.`,

);

logger.debug("Trying next fallback method.");

}

// Fall back to matching `0.0.0-<bundleVersion>`.

if (!codeqlFolder && tagName) {

const fallbackVersion = await tryGetFallbackToolcacheVersion(

cliVersion,

tagName,

logger,

);

if (fallbackVersion) {

codeqlFolder = toolcache.find("CodeQL", fallbackVersion);

} else {

logger.debug(

"Could not determine a fallback toolcache version number for CodeQL tools version " +

`${humanReadableVersion}.`,

);

}

if (codeqlFolder) {

logger.info(

`Found CodeQL tools version ${humanReadableVersion} in the toolcache.`,

);

} else {

logger.info(

`Did not find CodeQL tools version ${humanReadableVersion} in the toolcache.`,

);

}

if (codeqlFolder) {

if (cliVersion) {

logger.info(

`Using CodeQL CLI version ${cliVersion} from toolcache at ${codeqlFolder}`,

);

} else {

logger.info(`Using CodeQL CLI from toolcache at ${codeqlFolder}`);

}

return {

codeqlFolder,

sourceType: "toolcache",

toolsVersion: cliVersion ?? humanReadableVersion,

};

}

// If we don't find the requested version on Enterprise, we may allow a

// different version to save download time if the version hasn't been

// specified explicitly (in which case we always honor it).

if (

variant === util.GitHubVariant.GHES &&

!forceShippedTools &&

!toolsInput

) {

const result = await findOverridingToolsInCache(

humanReadableVersion,

logger,

);

if (result !== undefined) {

return result;

}

let compressionMethod: tar.CompressionMethod;

if (!url) {

const bundleTagName = tagName;

if (bundleTagName === undefined) {

throw new Error(

"Could not determine a release tag for the requested CodeQL bundle.",

);

}

compressionMethod =

cliVersion !== undefined &&

(await useZstdBundle(cliVersion, tarSupportsZstd))

? "zstd"

: "gzip";

const action = { env: getEnv(), logger };

const platform = getBundlePlatform();

const perLanguageBundleLanguage = getPerLanguageBundleLanguage(action, {

rawLanguages,

otherLanguagePacksReason,

cliVersion,

compressionMethod,

platform,

variant,

});

// Resolves the combined or per-language bundle URL for the requested release.

const resolveBundleURL = (language?: BuiltInLanguage) =>

getCodeQLAssetDownloadURL(

action,

apiDetails,

bundleTagName,

getCodeQLBundleName(compressionMethod, platform, language),

);

const combinedBundleURL = await resolveBundleURL();

if (perLanguageBundleLanguage !== undefined) {

logger.info(

`Selected the per-language CodeQL bundle for '${perLanguageBundleLanguage}'.`,

);

url = await resolveBundleURL(perLanguageBundleLanguage);

bundle = {

kind: "per-language",

url,

language: perLanguageBundleLanguage,

combinedBundleURL,

};

} else {

url = combinedBundleURL;

bundle = { kind: "combined", url };

}

} else {

const method = tar.inferCompressionMethod(url);

if (method === undefined) {

throw new util.ConfigurationError(

`Could not infer compression method from URL ${url}. Please specify a URL ` +

"ending in '.tar.gz' or '.tar.zst'.",

);

}

compressionMethod = method;

bundle ??= getCodeQLBundleFromUrl(url);

if (bundle.kind === "per-language") {

logger.info(

`${url} appears to be a CodeQL bundle that contains only ${bundle.language}.`,

);

}

if (cliVersion) {

logger.info(`Using CodeQL CLI version ${cliVersion} sourced from ${url} .`);

} else {

logger.info(`Using CodeQL CLI sourced from ${url} .`);

}

return {

bundle,

bundleVersion,

cliVersion,

compressionMethod,

sourceType: "download",

toolsVersion: resolvedVersion ?? "unknown",

};

}

/**

* Gets a fallback version number to use when looking for CodeQL in the toolcache if we didn't find

* the `x.y.z` version. This is to support old versions of the toolcache.

async function tryGetFallbackToolcacheVersion(

cliVersion: string | undefined,

tagName: string,

logger: Logger,

): Promise<string | undefined> {

const bundleVersion = tryGetBundleVersionFromTagName(tagName, logger);

if (bundleVersion === undefined) {

return undefined;

}

const fallbackVersion = convertToSemVer(bundleVersion, logger);

logger.debug(

`Computed a fallback toolcache version number of ${fallbackVersion} for CodeQL version ` +

`${cliVersion ?? tagName}.`,

);

return fallbackVersion;

}

// Exported using `export const` for testing purposes. Specifically, we want to

// be able to stub this function and have other functions in this file use that stub.

export const downloadCodeQL = async function (

source: CodeQLDownloadSource,

apiDetails: api.GitHubApiDetails,

tarVersion: tar.TarVersion | undefined,

tempDir: string,

logger: Logger,

): Promise<{

codeqlFolder: string;

statusReport: ToolsDownloadStatusReport;

}> {

const { bundle, compressionMethod } = source;

const codeqlURL = bundle.url;

const parsedCodeQLURL = new URL(codeqlURL);

const searchParams = new URLSearchParams(parsedCodeQLURL.search);

const headers: OutgoingHttpHeaders = {

accept: "application/octet-stream",

};

let authorization: string | undefined = undefined;

// We don't want to send an authorization header if there's already a token provided in the URL.

if (searchParams.has("token")) {

logger.debug("CodeQL tools URL contains an authorization token.");

} else {

authorization = api.getAuthorizationHeaderFor(

logger,

apiDetails,

codeqlURL,

);

}

const toolcacheDestination = getToolcacheDestination({ logger }, source);

const extractedBundlePath = toolcacheDestination.orElse(

getTempExtractionDir(tempDir),

);

const statusReport = await downloadAndExtract(

codeqlURL,

compressionMethod,

extractedBundlePath,

authorization,

{ "User-Agent": "CodeQL Action", ...headers },

tarVersion,

logger,

);

if (toolcacheDestination.isSuccess()) {

writeToolcacheMarkerFile(toolcacheDestination.value, logger);

} else {

logger.debug(toolcacheDestination.value);

}

return {

codeqlFolder: extractedBundlePath,

statusReport:

bundle.kind === "per-language"

? {

...statusReport,

perLanguage: { tools_bundle_language: bundle.language },

}

: statusReport,

};

/**

* Returns the canonical toolcache directory, or the reason the bundle cannot be cached.

function getToolcacheDestination(

{ logger }: ActionState<["Logger"]>,

source: CodeQLDownloadSource,

): util.Result<string, string> {

if (source.bundle.kind !== "combined") {

return new util.Failure(

"Not caching the CodeQL tools because they came from a bundle that contains only a " +

"single language.",

);

}

if (!source.bundleVersion) {

return new util.Failure(

"Could not cache CodeQL tools because we could not determine the bundle version from the " +

`URL ${source.bundle.url}.`,

);

}

return new util.Success(

getToolcacheDirectory(

getCanonicalToolcacheVersion(

source.cliVersion,

source.bundleVersion,

logger,

);

}

/**

* Reclaims disk space by deleting the CodeQL tools from the toolcache on GitHub-hosted runners.

* On GitHub-hosted runners the toolcache shares a filesystem with the workspace, so tools left in

* the toolcache take up space that the analysis could use instead. This holds wherever we extract

* the tools we are obtaining, since the toolcache is on that filesystem either way.

async function tryDeleteToolcacheBundles({

env,

logger,

}: ActionState<["Logger", "ReadOnlyEnv"]>): Promise<void> {

// A step that has already set up CodeQL may hand out a path into the toolcache that a later step

// runs, so only the first step to set it up can know that nothing else relies on the toolcache.

if (env.getOptional(EnvVar.HAS_SET_UP_CODEQL) !== undefined) {

logger.debug(

"Not deleting the CodeQL tools from the toolcache since a previous step in this job has " +

"already set up CodeQL.",

);

return;

}

if (!isGitHubHostedRunner(env) || !isToolcacheOnWorkspaceFilesystem(logger)) {

return;

}

const startTime = performance.now();

const result = await deleteToolcacheBundles({ env, logger });

addNoLanguageDiagnostic(

undefined,

makeTelemetryDiagnostic(

"codeql-action/toolcache-bundle-cleanup",

"Toolcache CodeQL bundle cleanup",

{ ...result, durationMs: util.durationMsSince(startTime) },

);

}

export function getCodeQLURLVersion(url: string): string {

const match = url.match(/\/codeql-bundle-(.*)\//);

if (match === null || match.length < 2) {

throw new util.ConfigurationError(

`Malformed tools url: ${url}. Version could not be inferred`,

);

}

return match[1];

}

/**

* Returns the toolcache version number to use to store the bundle with the associated CLI version

* and bundle version.

* This is the canonical version number, since toolcaches populated by different versions of the

* CodeQL Action or different runner image creation scripts may store the bundle using a different

* version number. Functions like `getCodeQLSource` that fetch the bundle from rather than save the

* bundle to the toolcache should handle these different version numbers.

function getCanonicalToolcacheVersion(

cliVersion: string | undefined,

bundleVersion: string,

logger: Logger,

): string {

// If the CLI version is a pre-release or contains build metadata, then cache the

// bundle as `0.0.0-<bundleVersion>` to avoid the bundle being interpreted as containing a stable

// CLI release. In principle, it should be enough to just check that the CLI version isn't a

// pre-release, but the version numbers of CodeQL nightlies have the format `x.y.z+<timestamp>`,

// and we don't want these nightlies to override stable CLI versions in the toolcache.

if (!cliVersion?.match(/^[0-9]+\.[0-9]+\.[0-9]+$/)) {

return convertToSemVer(bundleVersion, logger);

}

// Bundles are now semantically versioned and can be looked up based on just the CLI version

// number, so we can version them in the toolcache using just the CLI version number.

return cliVersion;

}

interface SetupCodeQLResult {

codeqlFolder: string;

toolsDownloadStatusReport?: ToolsDownloadStatusReport;

toolsSource: ToolsSource;

toolsVersion: string;

}

/**

* Obtains the CodeQL bundle, installs it in the toolcache if appropriate, and extracts it.

* @returns the path to the extracted bundle, and the version of the tools

export async function setupCodeQLBundle(

toolsInput: string | undefined,

apiDetails: api.GitHubApiDetails,

tempDir: string,

variant: util.GitHubVariant,

defaultCliVersion: CodeQLDefaultVersionInfo,

rawLanguages: string[] | undefined,

otherLanguagePacksReason: string | undefined,

useOverlayAwareDefaultCliVersion: boolean,

features: FeatureEnablement,

logger: Logger,

): Promise<SetupCodeQLResult> {

if (!(await util.isBinaryAccessible("tar", logger))) {

throw new util.ConfigurationError(

"Could not find tar in PATH, so unable to extract CodeQL bundle.",

);

}

const zstdAvailability = await tar.isZstdAvailable(logger);

const source = await getCodeQLSource(

toolsInput,

defaultCliVersion,

rawLanguages,

otherLanguagePacksReason,

useOverlayAwareDefaultCliVersion,

apiDetails,

variant,

zstdAvailability.available,

features,

logger,

);

let codeqlFolder: string;

let toolsDownloadStatusReport: ToolsDownloadStatusReport | undefined;

let toolsSource: ToolsSource;

switch (source.sourceType) {

case "local": {

codeqlFolder = await tar.extract(

source.codeqlTarPath,

getTempExtractionDir(tempDir),

source.compressionMethod,

zstdAvailability.version,

logger,

);

toolsSource = ToolsSource.Local;

break;

}

case "toolcache":

codeqlFolder = source.codeqlFolder;

logger.debug(`CodeQL found in cache ${codeqlFolder}`);

toolsSource = ToolsSource.Toolcache;

break;

case "download": {

const result = await downloadCodeQLBundle(

{ env: getEnv(), logger },

source,

apiDetails,

zstdAvailability.version,

tempDir,

);

codeqlFolder = result.codeqlFolder;

toolsDownloadStatusReport = result.statusReport;

toolsSource = ToolsSource.Download;

break;

}

default:

util.assertNever(source);

}

// Record that this job now has a copy of the CodeQL tools, so that a later step doesn't delete

// the toolcache out from under the path we are about to return.

exportEnvVar(EnvVar.HAS_SET_UP_CODEQL, "true");

return {

codeqlFolder,

toolsDownloadStatusReport,

toolsSource,

toolsVersion: source.toolsVersion,

};

}

/**

* Performs eligible toolcache cleanup once, then downloads and extracts the resolved bundle.

* If an automatically selected per-language bundle is missing, downloads the combined bundle

* from the same release instead. Explicit bundle URLs are not substituted.

* @returns The extraction directory and download timings.

export async function downloadCodeQLBundle(

action: ActionState<["Logger", "ReadOnlyEnv"]>,

source: CodeQLDownloadSource,

apiDetails: api.GitHubApiDetails,

tarVersion: tar.TarVersion | undefined,

tempDir: string,

): Promise<{

codeqlFolder: string;

statusReport: ToolsDownloadStatusReport;

}> {

const { bundle } = source;

const { logger } = action;

await tryDeleteToolcacheBundles(action);

const startTime = performance.now();

try {

return await downloadCodeQL(

source,

apiDetails,

tarVersion,

tempDir,

logger,

);

} catch (e) {

if (

bundle.kind !== "per-language" ||

bundle.combinedBundleURL === undefined ||

util.asHTTPError(e)?.status !== 404

) {

throw e;

}

logPerLanguageBundleFallback(action, bundle.language, bundle.url);

View remainder of file in raw view

codeql-action/src/setup-codeql.ts at default-setup-testing · github/codeql-action · GitHub

Repository navigation

Expand file tree

Breadcrumbs

setup-codeql.ts

Latest commit

History

Breadcrumbs

setup-codeql.ts

File metadata and controls