codeql-action/src/setup-codeql.test.ts at main · github/codeql-action · GitHub

History

919 lines (823 loc) · 29 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

import * as path from "path";

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

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

import test, { ExecutionContext } from "ava";

import * as sinon from "sinon";

import * as actionsUtil from "./actions-util";

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

import { EnvVar } from "./environment";

import { Feature } from "./feature-flags";

import { getRunnerLogger } from "./logging";

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

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

import * as tar from "./tar";

import {

LINKED_CLI_VERSION,

LoggedMessage,

SAMPLE_DEFAULT_CLI_VERSION,

SAMPLE_DOTCOM_API_DETAILS,

checkExpectedLogMessages,

createFeatures,

createTestConfig,

getRecordingLogger,

makeMacro,

mockBundleDownloadApi,

setupActionsVars,

setupTests,

} from "./testing-utils";

import {

getErrorMessage,

GitHubVariant,

initializeEnvironment,

withTmpDir,

} from "./util";

setupTests(test);

test.beforeEach(() => {

initializeEnvironment("1.2.3");

});

test.serial("parse codeql bundle url version", (t) => {

t.deepEqual(

setupCodeql.getCodeQLURLVersion(

"https://github.com/.../codeql-bundle-20200601/...",

"20200601",

);

});

test.serial("convert to semver", (t) => {

const tests = {

"20200601": "0.0.0-20200601",

"20200601.0": "0.0.0-20200601.0",

"20200601.0.0": "20200601.0.0",

"1.2.3": "1.2.3",

"1.2.3-alpha": "1.2.3-alpha",

"1.2.3-beta.1": "1.2.3-beta.1",

};

for (const [version, expectedVersion] of Object.entries(tests)) {

try {

const parsedVersion = setupCodeql.convertToSemVer(

version,

getRunnerLogger(true),

);

t.deepEqual(parsedVersion, expectedVersion);

} catch (e) {

t.fail(getErrorMessage(e));

}

});

test.serial("getCodeQLActionRepository", (t) => {

const logger = getRunnerLogger(true);

initializeEnvironment("1.2.3");

// isRunningLocalAction() === true

delete process.env["GITHUB_ACTION_REPOSITORY"];

process.env["RUNNER_TEMP"] = path.dirname(__dirname);

const repoLocalRunner = setupCodeql.getCodeQLActionRepository(logger);

t.deepEqual(repoLocalRunner, "github/codeql-action");

// isRunningLocalAction() === false

sinon.stub(actionsUtil, "isRunningLocalAction").returns(false);

process.env["GITHUB_ACTION_REPOSITORY"] = "xxx/yyy";

const repoEnv = setupCodeql.getCodeQLActionRepository(logger);

t.deepEqual(repoEnv, "xxx/yyy");

});

test.serial(

"getCodeQLSource sets CLI version for a semver tagged bundle",

async (t) => {

const features = createFeatures([]);

await withTmpDir(async (tmpDir) => {

setupActionsVars(tmpDir, tmpDir);

const tagName = "codeql-bundle-v1.2.3";

mockBundleDownloadApi({ tagName });

const source = await setupCodeql.getCodeQLSource(

`https://github.com/github/codeql-action/releases/download/${tagName}/codeql-bundle-linux64.tar.gz`,

SAMPLE_DEFAULT_CLI_VERSION,

undefined, // rawLanguages

false, // useOverlayAwareDefaultCliVersion

SAMPLE_DOTCOM_API_DETAILS,

GitHubVariant.DOTCOM,

false,

features,

getRunnerLogger(true),

);

t.is(source.sourceType, "download");

t.is(source["cliVersion"], "1.2.3");

});

);

const LINKED_BUNDLE_TEST_CASES = [

{

platform: "linux",

tarSupportsZstd: true,

expectedBundleName: "codeql-bundle-linux64.tar.zst",

expectedCompressionMethod: "zstd",

{

platform: "darwin",

tarSupportsZstd: true,

expectedBundleName: "codeql-bundle-osx64.tar.zst",

expectedCompressionMethod: "zstd",

{

platform: "win32",

tarSupportsZstd: true,

expectedBundleName: "codeql-bundle-win64.tar.gz",

expectedCompressionMethod: "gzip",

{

platform: "linux",

tarSupportsZstd: false,

expectedBundleName: "codeql-bundle-linux64.tar.gz",

expectedCompressionMethod: "gzip",

] as const;

for (const {

platform,

tarSupportsZstd,

expectedBundleName,

expectedCompressionMethod,

} of LINKED_BUNDLE_TEST_CASES) {

test.serial(

`getCodeQLSource selects ${expectedBundleName} for linked tools`,

async (t) => {

const features = createFeatures([]);

sinon.stub(process, "platform").value(platform);

await withTmpDir(async (tmpDir) => {

setupActionsVars(tmpDir, tmpDir);

const source = await setupCodeql.getCodeQLSource(

"linked",

SAMPLE_DEFAULT_CLI_VERSION,

undefined, // rawLanguages

false, // useOverlayAwareDefaultCliVersion

SAMPLE_DOTCOM_API_DETAILS,

GitHubVariant.DOTCOM,

tarSupportsZstd,

features,

getRunnerLogger(true),

);

t.is(source.toolsVersion, LINKED_CLI_VERSION.cliVersion);

t.is(source.sourceType, "download");

if (source.sourceType === "download") {

t.is(source.compressionMethod, expectedCompressionMethod);

t.true(source.codeqlURL.endsWith(`/${expectedBundleName}`));

}

});

);

}

test.serial(

"getCodeQLSource correctly returns bundled CLI version when tools == latest",

async (t) => {

const loggedMessages: LoggedMessage[] = [];

const logger = getRecordingLogger(loggedMessages);

const features = createFeatures([]);

await withTmpDir(async (tmpDir) => {

setupActionsVars(tmpDir, tmpDir);

const source = await setupCodeql.getCodeQLSource(

"latest",

SAMPLE_DEFAULT_CLI_VERSION,

undefined, // rawLanguages

false, // useOverlayAwareDefaultCliVersion

SAMPLE_DOTCOM_API_DETAILS,

GitHubVariant.DOTCOM,

false,

features,

logger,

);

// First, ensure that the CLI version is the linked version, so that backwards

// compatibility is maintained.

t.is(source.toolsVersion, LINKED_CLI_VERSION.cliVersion);

t.is(source.sourceType, "download");

// Afterwards, ensure that we see the deprecation message in the log.

const expected_message: string =

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

t.assert(

loggedMessages.some(

(msg) =>

typeof msg.message === "string" &&

msg.message.includes(expected_message),

);

});

);

test.serial(

"setupCodeQLBundle logs the CodeQL CLI version being used when asked to use linked tools",

async (t) => {

const loggedMessages: LoggedMessage[] = [];

const logger = getRecordingLogger(loggedMessages);

const features = createFeatures([]);

// Stub the downloadCodeQL function to prevent downloading artefacts

// during testing from being called.

sinon.stub(setupCodeql, "downloadCodeQL").resolves({

codeqlFolder: "codeql",

statusReport: {

downloadDurationMs: 200,

toolsVersion: LINKED_CLI_VERSION.cliVersion,

});

await withTmpDir(async (tmpDir) => {

setupActionsVars(tmpDir, tmpDir);

const result = await setupCodeql.setupCodeQLBundle(

"linked",

SAMPLE_DOTCOM_API_DETAILS,

"tmp/codeql_action_test/",

GitHubVariant.DOTCOM,

SAMPLE_DEFAULT_CLI_VERSION,

undefined, // rawLanguages

false, // useOverlayAwareDefaultCliVersion

features,

logger,

);

// Basic sanity check that the version we got back is indeed

// the linked (default) CLI version.

t.is(result.toolsVersion, LINKED_CLI_VERSION.cliVersion);

// Ensure message logging CodeQL CLI version was present in user logs.

const expected_message: string = `Using CodeQL CLI version ${LINKED_CLI_VERSION.cliVersion}`;

t.assert(

loggedMessages.some(

(msg) =>

typeof msg.message === "string" &&

msg.message.includes(expected_message),

);

});

);

test.serial(

"setupCodeQLBundle logs the CodeQL CLI version being used when asked to download a non-default bundle",

async (t) => {

const loggedMessages: LoggedMessage[] = [];

const logger = getRecordingLogger(loggedMessages);

const features = createFeatures([]);

const bundleUrl =

"https://github.com/github/codeql-action/releases/download/codeql-bundle-v2.16.0/codeql-bundle-linux64.tar.gz";

const expectedVersion = "2.16.0";

// Stub the downloadCodeQL function to prevent downloading artefacts

// during testing from being called.

sinon.stub(setupCodeql, "downloadCodeQL").resolves({

codeqlFolder: "codeql",

statusReport: {

downloadDurationMs: 200,

toolsVersion: expectedVersion,

});

await withTmpDir(async (tmpDir) => {

setupActionsVars(tmpDir, tmpDir);

const result = await setupCodeql.setupCodeQLBundle(

bundleUrl,

SAMPLE_DOTCOM_API_DETAILS,

"tmp/codeql_action_test/",

GitHubVariant.DOTCOM,

SAMPLE_DEFAULT_CLI_VERSION,

undefined, // rawLanguages

false, // useOverlayAwareDefaultCliVersion

features,

logger,

);

// Basic sanity check that the version we got back is indeed the version that the

// bundle contains..

t.is(result.toolsVersion, expectedVersion);

// Ensure message logging CodeQL CLI version was present in user logs.

const expected_message: string = `Using CodeQL CLI version 2.16.0 sourced from ${bundleUrl} .`;

t.assert(

loggedMessages.some(

(msg) =>

typeof msg.message === "string" &&

msg.message.includes(expected_message),

);

});

);

test.serial(

"getCodeQLSource correctly returns nightly CLI version when tools == nightly",

async (t) => {

const loggedMessages: LoggedMessage[] = [];

const logger = getRecordingLogger(loggedMessages);

const features = createFeatures([]);

const expectedDate = "30260213";

const expectedTag = `codeql-bundle-${expectedDate}`;

// Ensure that we consistently select "zstd" for the test.

sinon.stub(process, "platform").value("linux");

sinon.stub(tar, "isZstdAvailable").resolves({

available: true,

foundZstdBinary: true,

});

const client = github.getOctokit("123");

const listReleases = sinon.stub(client.rest.repos, "listReleases");

// eslint-disable-next-line @typescript-eslint/no-unsafe-argument

listReleases.resolves({

data: [{ tag_name: expectedTag }],

} as any);

sinon.stub(api, "getApiClient").value(() => client);

await withTmpDir(async (tmpDir) => {

setupActionsVars(tmpDir, tmpDir);

const source = await setupCodeql.getCodeQLSource(

"nightly",

SAMPLE_DEFAULT_CLI_VERSION,

undefined, // rawLanguages

false, // useOverlayAwareDefaultCliVersion

SAMPLE_DOTCOM_API_DETAILS,

GitHubVariant.DOTCOM,

false,

features,

logger,

);

// Check that the `CodeQLToolsSource` object matches our expectations.

const expectedVersion = `0.0.0-${expectedDate}`;

const expectedURL = `https://github.com/dsp-testing/codeql-cli-nightlies/releases/download/${expectedTag}/${setupCodeql.getCodeQLBundleName("zstd")}`;

t.deepEqual(source, {

bundleVersion: expectedDate,

cliVersion: undefined,

codeqlURL: expectedURL,

compressionMethod: "zstd",

sourceType: "download",

toolsVersion: expectedVersion,

} satisfies setupCodeql.CodeQLToolsSource);

// Afterwards, ensure that we see the expected messages in the log.

checkExpectedLogMessages(t, loggedMessages, [

"Using the latest CodeQL CLI nightly, as requested by 'tools: nightly'.",

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

`Attempting to obtain CodeQL tools. CLI version: unknown, bundle tag name: ${expectedTag}`,

`Using CodeQL CLI sourced from ${expectedURL}`,

]);

});

);

test.serial(

"getCodeQLSource correctly returns nightly CLI version when forced by FF",

async (t) => {

const loggedMessages: LoggedMessage[] = [];

const logger = getRecordingLogger(loggedMessages);

const features = createFeatures([Feature.ForceNightly]);

const expectedDate = "30260213";

const expectedTag = `codeql-bundle-${expectedDate}`;

// Ensure that we consistently select "zstd" for the test.

sinon.stub(process, "platform").value("linux");

sinon.stub(tar, "isZstdAvailable").resolves({

available: true,

foundZstdBinary: true,

});

const client = github.getOctokit("123");

const listReleases = sinon.stub(client.rest.repos, "listReleases");

// eslint-disable-next-line @typescript-eslint/no-unsafe-argument

listReleases.resolves({

data: [{ tag_name: expectedTag }],

} as any);

sinon.stub(api, "getApiClient").value(() => client);

await withTmpDir(async (tmpDir) => {

setupActionsVars(tmpDir, tmpDir, { GITHUB_EVENT_NAME: "dynamic" });

const source = await setupCodeql.getCodeQLSource(

undefined,

SAMPLE_DEFAULT_CLI_VERSION,

undefined, // rawLanguages

false, // useOverlayAwareDefaultCliVersion

SAMPLE_DOTCOM_API_DETAILS,

GitHubVariant.DOTCOM,

false,

features,

logger,

);

// Check that the `CodeQLToolsSource` object matches our expectations.

const expectedVersion = `0.0.0-${expectedDate}`;

const expectedURL = `https://github.com/dsp-testing/codeql-cli-nightlies/releases/download/${expectedTag}/${setupCodeql.getCodeQLBundleName("zstd")}`;

t.deepEqual(source, {

bundleVersion: expectedDate,

cliVersion: undefined,

codeqlURL: expectedURL,

compressionMethod: "zstd",

sourceType: "download",

toolsVersion: expectedVersion,

} satisfies setupCodeql.CodeQLToolsSource);

// Afterwards, ensure that we see the expected messages in the log.

checkExpectedLogMessages(t, loggedMessages, [

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

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

`Attempting to obtain CodeQL tools. CLI version: unknown, bundle tag name: ${expectedTag}`,

`Using CodeQL CLI sourced from ${expectedURL}`,

]);

});

);

test.serial(

"getCodeQLSource correctly returns latest version from toolcache when tools == toolcache",

async (t) => {

const loggedMessages: LoggedMessage[] = [];

const logger = getRecordingLogger(loggedMessages);

const features = createFeatures([]);

const latestToolcacheVersion = "3.2.1";

const latestVersionPath = "/path/to/latest";

const testVersions = ["2.3.1", latestToolcacheVersion, "1.2.3"];

const findAllVersionsStub = sinon

.stub(toolcache, "findAllVersions")

.returns(testVersions);

const findStub = sinon.stub(toolcache, "find");

findStub

.withArgs("CodeQL", latestToolcacheVersion)

.returns(latestVersionPath);

await withTmpDir(async (tmpDir) => {

setupActionsVars(tmpDir, tmpDir, { GITHUB_EVENT_NAME: "dynamic" });

const source = await setupCodeql.getCodeQLSource(

"toolcache",

SAMPLE_DEFAULT_CLI_VERSION,

undefined, // rawLanguages

false, // useOverlayAwareDefaultCliVersion

SAMPLE_DOTCOM_API_DETAILS,

GitHubVariant.DOTCOM,

false,

features,

logger,

);

// Check that the toolcache functions were called with the expected arguments

t.assert(

findAllVersionsStub.calledOnceWith("CodeQL"),

`toolcache.findAllVersions("CodeQL") wasn't called`,

);

t.assert(

findStub.calledOnceWith("CodeQL", latestToolcacheVersion),

`toolcache.find("CodeQL", ${latestToolcacheVersion}) wasn't called`,

);

// Check that `sourceType` and `toolsVersion` match expectations.

t.is(source.sourceType, "toolcache");

t.is(source.toolsVersion, latestToolcacheVersion);

// Check that key messages we would expect to find in the log are present.

const expectedMessages: string[] = [

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

`CLI version ${latestToolcacheVersion} is the latest version in the toolcache.`,

`Using CodeQL CLI version ${latestToolcacheVersion} from toolcache at ${latestVersionPath}`,

];

for (const expectedMessage of expectedMessages) {

t.assert(

loggedMessages.some(

(msg) =>

typeof msg.message === "string" &&

msg.message.includes(expectedMessage),

`Expected '${expectedMessage}' in the logger output, but didn't find it in:\n ${loggedMessages.map((m) => ` - '${m.message}'`).join("\n")}`,

);

}

});

);

const toolcacheInputFallbackMacro = makeMacro({

exec: async (

t: ExecutionContext<unknown>,

featureList: Feature[],

environment: Record<string, string>,

testVersions: string[],

expectedMessages: string[],

) => {

const loggedMessages: LoggedMessage[] = [];

const logger = getRecordingLogger(loggedMessages);

const features = createFeatures(featureList);

const findAllVersionsStub = sinon

.stub(toolcache, "findAllVersions")

.returns(testVersions);

await withTmpDir(async (tmpDir) => {

setupActionsVars(tmpDir, tmpDir);

for (const [k, v] of Object.entries(environment)) {

process.env[k] = v;

}

const source = await setupCodeql.getCodeQLSource(

"toolcache",

SAMPLE_DEFAULT_CLI_VERSION,

undefined, // rawLanguages

false, // useOverlayAwareDefaultCliVersion

SAMPLE_DOTCOM_API_DETAILS,

GitHubVariant.DOTCOM,

false,

features,

logger,

);

// Check that the toolcache functions were called with the expected arguments

t.assert(

findAllVersionsStub.calledWith("CodeQL"),

`toolcache.findAllVersions("CodeQL") wasn't called`,

);

// Check that `sourceType` and `toolsVersion` match expectations.

t.is(source.sourceType, "download");

t.is(

source.toolsVersion,

SAMPLE_DEFAULT_CLI_VERSION.enabledVersions[0].cliVersion,

);

// Check that key messages we would expect to find in the log are present.

for (const expectedMessage of expectedMessages) {

t.assert(

loggedMessages.some(

(msg) =>

typeof msg.message === "string" &&

msg.message.includes(expectedMessage),

`Expected '${expectedMessage}' in the logger output, but didn't find it in:\n ${loggedMessages.map((m) => ` - '${m.message}'`).join("\n")}`,

);

}

});

title: (providedTitle = "") =>

`getCodeQLSource falls back to downloading the CLI if ${providedTitle}`,

});

toolcacheInputFallbackMacro.serial(

"the toolcache doesn't have a CodeQL CLI when tools == toolcache",

[],

{ GITHUB_EVENT_NAME: "dynamic" },

[],

[

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

`Found no CodeQL CLI in the toolcache, ignoring 'tools: toolcache'...`,

);

toolcacheInputFallbackMacro.serial(

"the workflow trigger is not `dynamic`",

[],

{ GITHUB_EVENT_NAME: "pull_request" },

[],

[

`Ignoring 'tools: toolcache' because the workflow was not triggered dynamically.`,

);

test.serial(

'tryGetTagNameFromUrl extracts the right tag name for a repo name containing "codeql-bundle"',

(t) => {

t.is(

setupCodeql.tryGetTagNameFromUrl(

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

getRunnerLogger(true),

"codeql-bundle-v2.19.0",

);

test.serial(

"getLatestToolcacheVersion returns undefined if there are no CodeQL CLIs in the toolcache",

(t) => {

sinon.stub(toolcache, "findAllVersions").returns([]);

t.is(

setupCodeql.getLatestToolcacheVersion(getRunnerLogger(true)),

undefined,

);

test.serial(

"getLatestToolcacheVersion returns latest version in the toolcache",

(t) => {

const testVersions = ["2.3.1", "3.2.1", "1.2.3"];

sinon.stub(toolcache, "findAllVersions").returns(testVersions);

t.is(setupCodeql.getLatestToolcacheVersion(getRunnerLogger(true)), "3.2.1");

);

const overlayMatchEnabledVersions = {

enabledVersions: [

{ cliVersion: "2.20.2", tagName: "codeql-bundle-v2.20.2" },

{ cliVersion: "2.20.1", tagName: "codeql-bundle-v2.20.1" },

{ cliVersion: "2.20.0", tagName: "codeql-bundle-v2.20.0" },

toolsFeatureFlagsValid: true,

};

async function fakeOverlayBaseCacheKey(

language: string,

cliVersion: string,

suffix: string,

): Promise<string> {

const prefix = await getCacheRestoreKeyPrefix(

createTestConfig({ languages: [language] }),

cliVersion,

);

return `${prefix}${suffix}`;

}

test.serial(

"getCodeQLSource uses overlay-aware default version when requested for a PR",

async (t) => {

await withTmpDir(async (tmpDir) => {

setupActionsVars(tmpDir, tmpDir);

process.env[EnvVar.CODE_SCANNING_REF] = "refs/heads/feature-branch";

process.env[EnvVar.CODE_SCANNING_BASE_BRANCH] = "main";

sinon.stub(api, "getAutomationID").resolves("test/");

const listStub = sinon.stub(api, "listActionsCaches").resolves([

{

key: await fakeOverlayBaseCacheKey("javascript", "2.20.1", "abc-1-1"),

]);

sinon

.stub(toolcache, "find")

.withArgs("CodeQL", "2.20.1")

.returns("/path/to/codeql-2.20.1");

const source = await setupCodeql.getCodeQLSource(

undefined,

overlayMatchEnabledVersions,

["javascript"],

true,

SAMPLE_DOTCOM_API_DETAILS,

GitHubVariant.DOTCOM,

false,

createFeatures([Feature.OverlayAnalysisMatchCodeqlVersion]),

getRunnerLogger(true),

);

t.assert(listStub.calledOnce);

t.is(source.sourceType, "toolcache");

t.is(source.toolsVersion, "2.20.1");

});

);

test.serial(

"getCodeQLSource skips overlay-aware default version when not requested",

async (t) => {

await withTmpDir(async (tmpDir) => {

setupActionsVars(tmpDir, tmpDir);

process.env["CODE_SCANNING_REF"] = "refs/heads/feature-branch";

process.env["CODE_SCANNING_BASE_BRANCH"] = "main";

sinon.stub(api, "getAutomationID").resolves("test/");

const listStub = sinon.stub(api, "listActionsCaches").resolves([

{

key: await fakeOverlayBaseCacheKey("javascript", "2.20.1", "abc-1-1"),

]);

sinon

.stub(toolcache, "find")

.withArgs("CodeQL", "2.20.2")

.returns("/path/to/codeql-2.20.2");

const source = await setupCodeql.getCodeQLSource(

undefined,

overlayMatchEnabledVersions,

["javascript"],

false,

SAMPLE_DOTCOM_API_DETAILS,

GitHubVariant.DOTCOM,

false,

createFeatures([Feature.OverlayAnalysisMatchCodeqlVersion]),

getRunnerLogger(true),

);

t.assert(listStub.notCalled);

t.is(source.sourceType, "toolcache");

t.is(source.toolsVersion, "2.20.2");

});

);

test.serial(

"getEnabledVersionsWithOverlayBaseDatabases returns flag-enabled versions present in cache, sorted desc",

async (t) => {

sinon.stub(api, "getAutomationID").resolves("test/");

sinon.stub(api, "listActionsCaches").resolves([

// Flag-enabled versions present in the cache, listed in non-descending

// order so the test exercises the sort.

{

key: await fakeOverlayBaseCacheKey("javascript", "2.20.0", "ghi-3-1"),

{

key: await fakeOverlayBaseCacheKey("javascript", "2.20.1", "def-2-1"),

// Newer than any flag-enabled version: should be filtered out.

{

key: await fakeOverlayBaseCacheKey("javascript", "2.21.0", "abc-1-1"),

]);

const result = await setupCodeql.getEnabledVersionsWithOverlayBaseDatabases(

overlayMatchEnabledVersions,

["javascript"],

createFeatures([Feature.OverlayAnalysisMatchCodeqlVersion]),

getRunnerLogger(true),

);

t.deepEqual(result, [

{ cliVersion: "2.20.1", tagName: "codeql-bundle-v2.20.1" },

{ cliVersion: "2.20.0", tagName: "codeql-bundle-v2.20.0" },

]);

);

test.serial(

"getEnabledVersionsWithOverlayBaseDatabases returns empty when no cached version is flag-enabled",

async (t) => {

sinon.stub(api, "getAutomationID").resolves("test/");

sinon.stub(api, "listActionsCaches").resolves([

{

key: await fakeOverlayBaseCacheKey("javascript", "2.19.0", "abc-1-1"),

]);

const result = await setupCodeql.getEnabledVersionsWithOverlayBaseDatabases(

overlayMatchEnabledVersions,

["javascript"],

createFeatures([Feature.OverlayAnalysisMatchCodeqlVersion]),

getRunnerLogger(true),

);

t.deepEqual(result, []);

);

const noLanguagesMacro = makeMacro({

exec: async (

t: ExecutionContext<unknown>,

rawLanguages: string[] | undefined,

) => {

const listStub = sinon.stub(api, "listActionsCaches").resolves([]);

const result = await setupCodeql.getEnabledVersionsWithOverlayBaseDatabases(

overlayMatchEnabledVersions,

rawLanguages,

createFeatures([Feature.OverlayAnalysisMatchCodeqlVersion]),

getRunnerLogger(true),

);

t.deepEqual(result, []);

t.assert(

listStub.notCalled,

"Should not list Actions caches without any rawLanguages.",

);

title: (providedTitle = "") =>

`getEnabledVersionsWithOverlayBaseDatabases does not list caches when rawLanguages is ${providedTitle}`,

});

noLanguagesMacro.serial("undefined", undefined);

noLanguagesMacro.serial("an empty array", []);

test.serial(

"getEnabledVersionsWithOverlayBaseDatabases returns empty when listing caches throws",

async (t) => {

sinon.stub(api, "getAutomationID").resolves("test/");

sinon.stub(api, "listActionsCaches").rejects(new Error("listing failed"));

const result = await setupCodeql.getEnabledVersionsWithOverlayBaseDatabases(

overlayMatchEnabledVersions,

["javascript"],

createFeatures([Feature.OverlayAnalysisMatchCodeqlVersion]),

getRunnerLogger(true),

);

t.deepEqual(result, []);

);

test.serial(

"getEnabledVersionsWithOverlayBaseDatabases returns versions present in the cache",

async (t) => {

sinon.stub(api, "getAutomationID").resolves("test/");

sinon.stub(api, "listActionsCaches").resolves([

{

key: await fakeOverlayBaseCacheKey("javascript", "2.20.2", "abc-1-1"),

]);

const result = await setupCodeql.getEnabledVersionsWithOverlayBaseDatabases(

overlayMatchEnabledVersions,

["javascript"],

createFeatures([Feature.OverlayAnalysisMatchCodeqlVersion]),

getRunnerLogger(true),

);

t.deepEqual(result, [

{ cliVersion: "2.20.2", tagName: "codeql-bundle-v2.20.2" },

]);

);

test.serial(

"getEnabledVersionsWithOverlayBaseDatabases does not list caches when both gates are off",

async (t) => {

const listStub = sinon.stub(api, "listActionsCaches").resolves([]);

const result = await setupCodeql.getEnabledVersionsWithOverlayBaseDatabases(

overlayMatchEnabledVersions,

["javascript"],

createFeatures([]),

getRunnerLogger(true),

);

t.deepEqual(result, []);

t.assert(

listStub.notCalled,

"Should not list Actions caches when both gating feature flags are off.",

);

test.serial(

"getEnabledVersionsWithOverlayBaseDatabases dry-run returns empty but lists caches",

async (t) => {

sinon.stub(api, "getAutomationID").resolves("test/");

const listStub = sinon.stub(api, "listActionsCaches").resolves([

{

key: await fakeOverlayBaseCacheKey("javascript", "2.20.1", "abc-1-1"),

]);

const result = await setupCodeql.getEnabledVersionsWithOverlayBaseDatabases(

overlayMatchEnabledVersions,

["javascript"],

createFeatures([Feature.OverlayAnalysisMatchCodeqlVersionDryRun]),

getRunnerLogger(true),

);

t.deepEqual(

result,

[],

"Dry-run should return an empty list so the caller falls back.",

);

t.assert(

listStub.calledOnce,

"Dry-run should still list Actions caches to populate the diagnostic.",

);

test.serial(

"getEnabledVersionsWithOverlayBaseDatabases match flag wins over dry-run",

async (t) => {

sinon.stub(api, "getAutomationID").resolves("test/");

sinon.stub(api, "listActionsCaches").resolves([

{

key: await fakeOverlayBaseCacheKey("javascript", "2.20.1", "abc-1-1"),

]);

const result = await setupCodeql.getEnabledVersionsWithOverlayBaseDatabases(

overlayMatchEnabledVersions,

["javascript"],

createFeatures([

Feature.OverlayAnalysisMatchCodeqlVersion,

Feature.OverlayAnalysisMatchCodeqlVersionDryRun,

]),

getRunnerLogger(true),

);

t.deepEqual(result, [

{ cliVersion: "2.20.1", tagName: "codeql-bundle-v2.20.1" },

]);

);

codeql-action/src/setup-codeql.test.ts at main · github/codeql-action · GitHub

Uh oh!

Expand file tree

Breadcrumbs

setup-codeql.test.ts

Latest commit

History

Breadcrumbs

setup-codeql.test.ts

File metadata and controls