Repository navigation
Expand file tree
/
Copy pathPythonSetupEnvironmentSetup.test.ts
More file actions
2425 lines (2165 loc) · 90.9 KB
/
Copy pathPythonSetupEnvironmentSetup.test.ts
File metadata and controls
2425 lines (2165 loc) · 90.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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 {expect} from "chai";
import path from "node:path";
import {
PythonSetupEnvironmentSetup,
PythonSetupSetupDeps,
} from "./PythonSetupEnvironmentSetup";
import {
CancellationLike,
PythonSetupCancelledError,
RunOptions,
} from "../gateways/PythonSetupCliClient";
import {PythonSetupResult} from "../models/PythonSetupResult";
import {
SUCCESS_REAL_RUN,
SUCCESS_REAL_RUN_UV_WORKSPACE_MEMBER,
SUCCESS_REAL_RUN_WITH_WARNINGS,
ERROR_NO_TARGET,
ERROR_USAGE,
} from "../models/fixtures/setupLocalResults";
import {PythonSetupErrorAction} from "../utils/errorMessages";
import {SetupLocalInvocation} from "../utils/setupLocalArgs";
import {SetupPreset, SetupPresetFlags} from "../utils/pythonSetupPresetPicker";
import {
PythonSetupAttempt,
PythonSetupOutcomeReport,
} from "../../telemetry/pythonSetupExtensions";
import {
DetectionSignal,
PackageManager,
PrimaryManager,
} from "../../language/packageManagerDetection";
/** A detection result for the `getDetection` seam. */
function detection(
primary: PrimaryManager,
managers: PackageManager[],
signals: DetectionSignal[] = []
) {
return {primary, managers, signals};
}
/**
* Records the attempt/result telemetry the orchestrator emits. Stands in for
* `Telemetry.recordPythonSetupAttempt`, keeping its shape: recording an attempt
* hands back the reporter for that run's outcome.
*/
function makeTelemetryRecorder() {
const attempts: PythonSetupAttempt[] = [];
const results: PythonSetupOutcomeReport[] = [];
return {
attempts,
results,
recordSetupAttempt: (attempt: PythonSetupAttempt) => {
attempts.push(attempt);
return (report: PythonSetupOutcomeReport) => {
results.push(report);
};
},
recordNoCompute: () => {
results.push({outcome: "no_compute"});
},
};
}
/**
* A never-cancelled {@link CancellationLike} that can be flipped via `cancel()`,
* firing its listeners — the shape the real `window.withProgress` token has.
*/
function makeToken(): CancellationLike & {cancel(): void} {
const listeners: Array<() => void> = [];
let cancelled = false;
return {
get isCancellationRequested() {
return cancelled;
},
onCancellationRequested(listener: () => void) {
listeners.push(listener);
return {dispose() {}};
},
cancel() {
cancelled = true;
listeners.forEach((l) => l());
},
};
}
/**
* A recording fake of the one method the orchestrator calls on the CLI client.
* `run` is scripted to resolve with a fixture (or reject, for cancellation),
* and it captures the invocation *and* the {@link RunOptions} it was handed so
* tests can assert the argv the orchestrator built and that `cwd` / `onLog` /
* `token` are threaded through.
*/
function makeCli(
outcome: {resolve: PythonSetupResult} | {reject: Error} = {
resolve: SUCCESS_REAL_RUN,
}
) {
const calls: SetupLocalInvocation[] = [];
const options: RunOptions[] = [];
return {
calls,
options,
run: async (invocation: SetupLocalInvocation, opts: RunOptions) => {
calls.push(invocation);
options.push(opts);
if ("reject" in outcome) {
throw outcome.reject;
}
return outcome.resolve;
},
};
}
function makeDeps(
overrides: Partial<PythonSetupSetupDeps> = {}
): PythonSetupSetupDeps {
return {
cli: makeCli(),
projectRoot: () => "/proj",
// Default seams model a uv-suitable project with a connected serverless
// session.
isVisible: async () => true,
resolveCompute: async () => ({
status: "ok",
compute: {kind: "serverless", version: "5"},
}),
realPath: async (p) => p,
adoptInterpreter: async () => {},
openProjectFile: async () => {},
restoreProjectFile: async () => {},
saveState: () => {},
notify: async () => {},
showReauthPrompt: async () => {},
showError: async () => {},
showSuccess: async () => {},
reportEnvironment: {
extensionVersion: "2.14.1",
cliVersion: "1.13.0",
platform: "darwin",
},
// Mirror the production wrapper: hand the task a log sink and a
// (never-cancelled) progress token.
withProgress: async (_title, task) => task(() => {}, makeToken()),
// Default: the user picks the recommended Full preset, so a run happens
// with no skip flags (matching the pre-picker behaviour these tests were
// written against). Tests that exercise other presets override this.
pickSetupPreset: async () => "full",
// Telemetry defaults to a no-op sink; tests that assert on events pass
// a recorder instead.
recordSetupAttempt: () => () => {},
recordNoCompute: () => {},
getDetection: async () => detection("uv", ["uv"]),
hasPyprojectToml: async () => true,
...overrides,
};
}
describe("PythonSetupEnvironmentSetup.setup", () => {
it("runs the CLI and marks ready on a successful real run", async () => {
const cli = makeCli({resolve: SUCCESS_REAL_RUN});
const adopted: Array<{venvPath: string; root: string}> = [];
const saved: Array<{envKey: string; pythonVersion: string}> = [];
const succeeded: PythonSetupResult[] = [];
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli,
adoptInterpreter: async (venvPath, root) => {
adopted.push({venvPath, root});
},
saveState: (s) => {
saved.push(s);
},
showSuccess: async (r) => {
succeeded.push(r);
},
})
);
await setup.setup();
expect(setup.ready).to.equal(true);
expect(cli.calls).to.have.length(1);
// Serverless version "5" flows into the invocation the client runs.
expect(cli.calls[0].compute).to.deep.equal({
kind: "serverless",
version: "5",
});
// cwd (the project root) and an onLog sink are threaded into the run.
expect(cli.options[0].cwd).to.equal("/proj");
expect(cli.options[0].onLog).to.be.a("function");
expect(adopted).to.deep.equal([
{venvPath: path.resolve("/proj", ".venv"), root: "/proj"},
]);
expect(saved).to.deep.equal([
{
envKey: SUCCESS_REAL_RUN.compute!.envKey,
pythonVersion: SUCCESS_REAL_RUN.resolved!.pythonVersion,
},
]);
// The success is announced, with the parsed result.
expect(succeeded).to.deep.equal([SUCCESS_REAL_RUN]);
});
it("adopts for the project captured at start, not the live one (mid-run switch)", async () => {
// Model the active project switching from A to B while the CLI runs.
let activeRoot = "/projA";
const adopted: Array<{venvPath: string; root: string}> = [];
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
projectRoot: () => activeRoot,
// The user switches the active project mid-run.
withProgress: async (_title, task) => {
const result = await task(() => {}, makeToken());
activeRoot = "/projB";
return result;
},
adoptInterpreter: async (venvPath, root) => {
adopted.push({venvPath, root});
},
})
);
await setup.setup();
// Adoption targets /projA (the run's cwd), never the switched-to /projB:
// otherwise B's interpreter setting would point at A's venv.
expect(adopted).to.deep.equal([
{venvPath: path.resolve("/projA", ".venv"), root: "/projA"},
]);
});
it("adopts the shared venv at the root for a uv workspace member", async () => {
const member = "/mono/bundles/sales";
const shared = path.resolve(member, "../../.venv");
const adopted: Array<{venvPath: string; root: string}> = [];
const venvDirs: string[] = [];
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: SUCCESS_REAL_RUN_UV_WORKSPACE_MEMBER}),
projectRoot: () => member,
adoptInterpreter: async (venvPath, root) => {
adopted.push({venvPath, root});
},
showSuccess: async (_r, _flags, venvDir) => {
venvDirs.push(venvDir);
},
})
);
await setup.setup();
expect(setup.ready).to.equal(true);
expect(adopted).to.deep.equal([{venvPath: shared, root: member}]);
expect(venvDirs).to.deep.equal([shared]);
});
it("counts a climbing venvPath from the real project folder", async () => {
// The CLI counts "../../.venv" from the symlink-resolved project folder,
// so the controller must not join it to the folder by text.
const adopted: string[] = [];
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: SUCCESS_REAL_RUN_UV_WORKSPACE_MEMBER}),
projectRoot: () => "/link/sales",
realPath: async () => "/mono/deep/bundles/sales",
adoptInterpreter: async (venvDir) => {
adopted.push(venvDir);
},
})
);
await setup.setup();
expect(adopted).to.deep.equal([
path.resolve("/mono/deep/bundles/sales", "../../.venv"),
]);
});
it("keeps .venv under the project folder as opened", async () => {
// The same folder either way, but the opened form keeps the interpreter
// inside the workspace folder for the Python extension.
const adopted: string[] = [];
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
projectRoot: () => "/link/proj",
realPath: async () => "/real/proj",
adoptInterpreter: async (venvDir) => {
adopted.push(venvDir);
},
})
);
await setup.setup();
expect(adopted).to.deep.equal([path.resolve("/link/proj", ".venv")]);
});
it("keeps an absolute venvPath as it is", async () => {
const abs = path.resolve("/envs/shared");
const adopted: string[] = [];
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: {...SUCCESS_REAL_RUN, venvPath: abs}}),
realPath: async () => "/real/proj",
adoptInterpreter: async (venvDir) => {
adopted.push(venvDir);
},
})
);
await setup.setup();
expect(adopted).to.deep.equal([abs]);
});
it("reports ready only for the project it was set up for, not another active project", async () => {
// Set up /projA, then model the active project switching to /projB
// (never provisioned). readiness must track the run's project, not leak
// across a project switch — otherwise the config view shows a green
// "ready" line for a project that has no venv.
let activeRoot = "/projA";
const setup = new PythonSetupEnvironmentSetup(
makeDeps({projectRoot: () => activeRoot})
);
await setup.setup();
// Still on /projA (the project just provisioned): ready.
expect(setup.ready).to.equal(true);
// Switch the active project to one that was never set up.
activeRoot = "/projB";
expect(setup.ready).to.equal(false);
// Switch back: /projA's readiness is remembered, not discarded.
activeRoot = "/projA";
expect(setup.ready).to.equal(true);
});
it("does nothing when there is no open project", async () => {
const cli = makeCli();
const setup = new PythonSetupEnvironmentSetup(
makeDeps({cli, projectRoot: () => undefined})
);
await setup.setup();
expect(cli.calls).to.have.length(0);
expect(setup.ready).to.equal(false);
});
it("does not run the CLI when the gate is closed", async () => {
const cli = makeCli();
const setup = new PythonSetupEnvironmentSetup(
makeDeps({cli, isVisible: async () => false})
);
await setup.setup();
expect(cli.calls).to.have.length(0);
expect(setup.ready).to.equal(false);
});
it("guides the user (without running the CLI) when no compute could be resolved", async () => {
const cli = makeCli();
const notified: string[] = [];
const shownErrors: string[] = [];
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli,
resolveCompute: async () => ({status: "none"}),
notify: async (m) => {
notified.push(m);
},
showError: async (m) => {
shownErrors.push(m);
},
})
);
await setup.setup();
// No project mutation, but the visible CTA must not be a dead button:
// tell the user to attach compute rather than silently no-op'ing.
expect(cli.calls).to.have.length(0);
expect(setup.ready).to.equal(false);
// Pre-flight guidance goes through notify (plain toast), not showError
// (which would reveal an empty output channel — no CLI ran).
expect(notified).to.have.length(1);
expect(notified[0]).to.contain(
"Select a cluster or serverless compute"
);
expect(shownErrors).to.have.length(0);
});
it("surfaces a mapped error message on CLI failure and stays not-ready", async () => {
const shownErrors: string[] = [];
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: ERROR_NO_TARGET}),
showError: async (m) => {
shownErrors.push(m);
},
})
);
await setup.setup();
expect(setup.ready).to.equal(false);
expect(shownErrors).to.have.length(1);
// The mapped, user-facing copy for E_NO_TARGET (not the raw CLI text).
expect(shownErrors[0]).to.contain(
"Select a cluster or serverless compute"
);
});
it("passes the CLI's raw failure detail to the log, not just the popup copy", async () => {
const shown: {message: string; detail?: string}[] = [];
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: ERROR_NO_TARGET}),
showError: async (message, detail) => {
shown.push({message, detail});
},
})
);
await setup.setup();
expect(shown).to.have.length(1);
// The popup stays the concise mapped copy (no raw CLI flag noise)...
expect(shown[0].message).to.not.contain("--serverless-version");
// ...while the detail carries the CLI's own explanation plus the
// phase/code, so the "Show Logs" button leads somewhere useful.
expect(shown[0].detail).to.contain("No compute target is selected");
expect(shown[0].detail).to.contain("E_NO_TARGET");
});
it("offers an Install uv action when the CLI reports uv is missing", async () => {
const shown: {
message: string;
actions?: PythonSetupErrorAction[];
}[] = [];
const uvMissing: PythonSetupResult = {
schemaVersion: 1,
command: "environments setup-local",
ok: false,
mode: "default",
dryRun: false,
greenfield: false,
phases: [],
warnings: [],
durationMs: 0,
error: {
code: "E_UV_MISSING",
failurePhase: "preflight",
message: "uv not found on PATH",
diskMutated: false,
},
};
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: uvMissing}),
showError: async (message, _detail, actions) => {
shown.push({message, actions});
},
})
);
await setup.setup();
expect(shown).to.have.length(1);
// Two buttons: the one-click installer command leads, the manual guide
// follows.
expect(shown[0].actions).to.deep.equal([
{label: "Install uv", command: "databricks.environment.installUv"},
{
label: "Installation guide",
url: "https://docs.astral.sh/uv/getting-started/installation/",
},
]);
});
it("offers manual interpreter selection without retrying a failed download", async () => {
const shown: {actions?: PythonSetupErrorAction[]}[] = [];
const telemetry = makeTelemetryRecorder();
const pythonInstallFailure: PythonSetupResult = {
schemaVersion: 1,
command: "environments setup-local",
ok: false,
mode: "default",
dryRun: false,
greenfield: false,
phases: [],
warnings: [],
durationMs: 0,
error: {
code: "E_PYTHON_INSTALL",
failurePhase: "provision",
message: "Python download failed",
diskMutated: false,
},
};
const cli = makeCli({resolve: pythonInstallFailure});
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli,
recordSetupAttempt: telemetry.recordSetupAttempt,
showError: async (_message, _detail, actions) => {
shown.push({actions});
},
})
);
await setup.setup();
expect(cli.calls).to.have.length(1);
expect(telemetry.results[0].pythonSetupFlow).to.equal(
"manual_selection_requested"
);
expect(shown[0].actions).to.deep.equal([
{
label: "Select Python interpreter",
command: "databricks.environment.selectPythonInterpreter",
},
]);
});
it("prioritizes manual selection after installed fallback and keeps report in logs", async () => {
const shown: {
detail?: string;
actions?: PythonSetupErrorAction[];
}[] = [];
const fallbackFailure: PythonSetupResult = {
schemaVersion: 1,
command: "environments setup-local",
ok: false,
mode: "default",
dryRun: false,
pythonResolution: "installed_fallback",
greenfield: false,
phases: [],
warnings: [],
durationMs: 0,
error: {
code: "E_VALIDATE",
failurePhase: "validate",
message: "selected Python could not be validated",
diskMutated: false,
},
};
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: fallbackFailure}),
showError: async (_message, detail, actions) => {
shown.push({detail, actions});
},
})
);
await setup.setup();
expect(shown[0].actions).to.deep.equal([
{
label: "Select Python interpreter",
command: "databricks.environment.selectPythonInterpreter",
},
]);
expect(shown[0].detail).to.contain("Report this problem:");
});
it("offers the mapped documentation action for a doc-linked failure", async () => {
const shown: {actions?: PythonSetupErrorAction[]}[] = [];
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: ERROR_NO_TARGET}),
showError: async (_message, _detail, actions) => {
shown.push({actions});
},
})
);
await setup.setup();
expect(shown).to.have.length(1);
expect(shown[0].actions).to.deep.equal([
{
label: "Configure compute",
url: "https://docs.databricks.com/aws/en/dev-tools/vscode-ext/configure#cluster",
},
]);
});
it("passes no remediation action for a message-only failure", async () => {
// E_USAGE has no doc that reliably helps, so it surfaces the message alone.
const shown: {actions?: PythonSetupErrorAction[]}[] = [];
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: ERROR_USAGE}),
showError: async (_message, _detail, actions) => {
shown.push({actions});
},
})
);
await setup.setup();
expect(shown).to.have.length(1);
expect(shown[0].actions).to.deep.equal([]);
});
it("makes Report this problem the button for a report-worthy CLI failure", async () => {
const shown: {detail?: string; actions?: PythonSetupErrorAction[]}[] =
[];
const telemetry = makeTelemetryRecorder();
const mergeFailure: PythonSetupResult = {
schemaVersion: 1,
command: "environments setup-local",
ok: false,
mode: "default",
dryRun: false,
greenfield: false,
phases: [],
warnings: [],
durationMs: 0,
error: {
code: "E_MERGE",
failurePhase: "merge",
message: "merge blew up",
diskMutated: true,
},
};
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: mergeFailure}),
recordSetupAttempt: telemetry.recordSetupAttempt,
showError: async (_m, detail, actions) => {
shown.push({detail, actions});
},
})
);
await setup.setup();
expect(shown[0].actions).to.have.length(1);
expect(shown[0].actions?.[0].label).to.equal("Report this problem");
expect(shown[0].actions?.[0].url).to.contain(
"databricks/databricks-vscode/issues/new"
);
// The bare new-issue URL is mirrored into the log too.
expect(shown[0].detail).to.contain(
"Report this problem: https://github.com/databricks/databricks-vscode/issues/new"
);
expect(telemetry.results[0].reportOffered).to.equal(true);
});
it("keeps Report as the button while mirroring the doc link into the log", async () => {
// E_ENV_UNSUPPORTED is report-worthy AND has a doc link: report wins the
// button; the doc link still appears in the log.
const shown: {detail?: string; actions?: PythonSetupErrorAction[]}[] =
[];
const envUnsupported: PythonSetupResult = {
schemaVersion: 1,
command: "environments setup-local",
ok: false,
mode: "default",
dryRun: false,
greenfield: false,
phases: [],
warnings: [],
durationMs: 0,
compute: {source: "cluster", envKey: "dbr/15.4.x-scala2.12"},
error: {
code: "E_ENV_UNSUPPORTED",
failurePhase: "resolve",
message: "no published environment",
diskMutated: false,
},
};
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: envUnsupported}),
showError: async (_m, detail, actions) => {
shown.push({detail, actions});
},
})
);
await setup.setup();
expect(shown[0].actions?.[0].label).to.equal("Report this problem");
expect(shown[0].actions?.[0].url).to.contain(
"databricks/environments/issues/new"
);
expect(shown[0].detail).to.contain("Databricks Runtime versions");
expect(shown[0].detail).to.contain(
"Report this problem: https://github.com/databricks/environments/issues/new"
);
});
it("records reportOffered=false for a non-report-worthy CLI failure", async () => {
const telemetry = makeTelemetryRecorder();
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: ERROR_NO_TARGET}),
recordSetupAttempt: telemetry.recordSetupAttempt,
})
);
await setup.setup();
expect(telemetry.results[0].reportOffered).to.equal(false);
});
it("surfaces the raw error message when the CLI run rejects", async () => {
const shownErrors: string[] = [];
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
// A spawn/parse rejection (not a cancellation): no result to map.
cli: makeCli({reject: new Error("spawn databricks ENOENT")}),
showError: async (m) => {
shownErrors.push(m);
},
})
);
await setup.setup();
expect(setup.ready).to.equal(false);
expect(shownErrors).to.deep.equal(["spawn databricks ENOENT"]);
});
it("offers a Report this problem action on a spawn/parse rejection", async () => {
const shown: {actions?: PythonSetupErrorAction[]}[] = [];
const telemetry = makeTelemetryRecorder();
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({reject: new Error("spawn databricks ENOENT")}),
recordSetupAttempt: telemetry.recordSetupAttempt,
showError: async (_m, _detail, actions) => {
shown.push({actions});
},
})
);
await setup.setup();
expect(shown[0].actions?.[0].label).to.equal("Report this problem");
expect(shown[0].actions?.[0].url).to.contain(
"databricks/databricks-vscode/issues/new"
);
expect(telemetry.results[0]).to.include({
outcome: "not_started",
reportOffered: true,
});
});
it("prompts re-login (no report) when the CLI aborts telling the user to re-authenticate", async () => {
const shownErrors: {
message: string;
actions?: PythonSetupErrorAction[];
}[] = [];
let reauthPrompts = 0;
const telemetry = makeTelemetryRecorder();
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
// A no-result abort whose stderr carries the reauth signal.
cli: makeCli({
reject: new Error(
"CLI did not return valid JSON: Unexpected end of JSON input\n" +
"Error: the refresh token is invalid. To reauthenticate, " +
"run: databricks auth login --profile dev"
),
}),
recordSetupAttempt: telemetry.recordSetupAttempt,
showReauthPrompt: async () => {
reauthPrompts++;
},
showError: async (message, _detail, actions) => {
shownErrors.push({message, actions});
},
})
);
await setup.setup();
expect(setup.ready).to.equal(false);
// The re-login prompt replaces the hard error + report action entirely.
expect(reauthPrompts).to.equal(1);
expect(shownErrors).to.have.length(0);
expect(telemetry.results[0]).to.include({
outcome: "not_started",
reportOffered: false,
});
});
it("reports a spawn/parse defect (not re-login) when the abort has no reauth signal", async () => {
const shown: {actions?: PythonSetupErrorAction[]}[] = [];
let reauthPrompts = 0;
const telemetry = makeTelemetryRecorder();
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
// A no-result abort with no auth signal (e.g. offline / crash):
// it must stay on the report path, not be mislabeled as expiry.
cli: makeCli({reject: new Error("spawn databricks ENOENT")}),
recordSetupAttempt: telemetry.recordSetupAttempt,
showReauthPrompt: async () => {
reauthPrompts++;
},
showError: async (_m, _detail, actions) => {
shown.push({actions});
},
})
);
await setup.setup();
expect(reauthPrompts).to.equal(0);
expect(shown[0].actions?.[0].label).to.equal("Report this problem");
expect(telemetry.results[0]).to.include({
outcome: "not_started",
reportOffered: true,
});
});
it("handles a non-Error rejection without throwing on the spawn path", async () => {
const shown: {message: string; actions?: PythonSetupErrorAction[]}[] =
[];
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
// A rejection that is not an Error instance: `.message` would be
// undefined, and the redactor must not throw on it.
cli: {
run: async () => {
throw "spawn failed as a bare string";
},
},
showError: async (message, _detail, actions) => {
shown.push({message, actions});
},
})
);
// Must resolve, not reject — the original failure has to reach the user.
await setup.setup();
expect(shown).to.have.length(1);
expect(shown[0].message).to.contain("spawn failed as a bare string");
expect(shown[0].actions?.[0].label).to.equal("Report this problem");
});
it("offers a Report this problem action when interpreter adoption fails", async () => {
const shown: {actions?: PythonSetupErrorAction[]}[] = [];
const telemetry = makeTelemetryRecorder();
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: SUCCESS_REAL_RUN}),
adoptInterpreter: async () => {
throw new Error("adopt failed");
},
recordSetupAttempt: telemetry.recordSetupAttempt,
showError: async (_m, _detail, actions) => {
shown.push({actions});
},
})
);
await setup.setup();
expect(shown[0].actions?.[0].label).to.equal("Report this problem");
expect(shown[0].actions?.[0].url).to.contain(
"databricks/databricks-vscode/issues/new"
);
expect(telemetry.results[0]).to.include({
outcome: "failed",
failurePhase: "adopt",
reportOffered: true,
});
});
it("treats a success without a venv path as a failure", async () => {
const shownErrors: string[] = [];
const adopted: string[] = [];
const saved: PythonSetupResult[] = [];
const succeeded: PythonSetupResult[] = [];
// An ok:true result that carries no venvPath (e.g. a dry-run shape or
// CLI/schema drift): there is no interpreter to adopt.
const withoutVenv: PythonSetupResult = {
...SUCCESS_REAL_RUN,
venvPath: undefined,
};
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: withoutVenv}),
adoptInterpreter: async (p) => {
adopted.push(p);
},
saveState: () => {
saved.push(withoutVenv);
},
showSuccess: async (r) => {
succeeded.push(r);
},
showError: async (m) => {
shownErrors.push(m);
},
})
);
await setup.setup();
expect(setup.ready).to.equal(false);
expect(adopted).to.have.length(0);
// Neither the drift baseline nor the success announcement fire.
expect(saved).to.have.length(0);
expect(succeeded).to.have.length(0);
// The generic fallback copy (the result's `error` is null on an ok run).
expect(shownErrors).to.deep.equal(["Python environment setup failed."]);
});
it("treats a success missing target/resolved as a failure", async () => {
const shownErrors: string[] = [];
const adopted: string[] = [];
const saved: unknown[] = [];
// ok:true with a venvPath but no compute/resolved: we could adopt an
// interpreter, but drift detection would have no baseline to persist —
// so this is treated as a failure rather than a hollow "ready".
const withoutBaseline: PythonSetupResult = {
...SUCCESS_REAL_RUN,
compute: undefined,
resolved: undefined,
};
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({resolve: withoutBaseline}),
adoptInterpreter: async (p) => {
adopted.push(p);
},
saveState: (s) => {
saved.push(s);
},
showError: async (m) => {
shownErrors.push(m);
},
})
);
await setup.setup();
expect(setup.ready).to.equal(false);
// No interpreter is adopted and no baseline is persisted.
expect(adopted).to.have.length(0);
expect(saved).to.have.length(0);
expect(shownErrors).to.have.length(1);
});
it("stays not-ready and shows no error when the run is cancelled", async () => {
const shownErrors: string[] = [];
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli: makeCli({reject: new PythonSetupCancelledError()}),
showError: async (m) => {
shownErrors.push(m);
},
})
);
await setup.setup();
expect(setup.ready).to.equal(false);
// Cancellation is a user action, not a failure — no error toast.
expect(shownErrors).to.have.length(0);
});
it("threads the progress cancellation token through to cli.run", async () => {
const shownErrors: string[] = [];
const token = makeToken();
// A client that honours the token the way the real one does: reject with
// PythonSetupCancelledError once cancellation has been requested.
const cli = {
calls: [] as SetupLocalInvocation[],
options: [] as RunOptions[],
run: async (invocation: SetupLocalInvocation, opts: RunOptions) => {
cli.calls.push(invocation);
cli.options.push(opts);
if (opts.token?.isCancellationRequested) {
throw new PythonSetupCancelledError();
}
return SUCCESS_REAL_RUN;
},
};
const setup = new PythonSetupEnvironmentSetup(
makeDeps({
cli,
showError: async (m) => {
shownErrors.push(m);
},
// Model a user who clicked "Cancel" on the progress notification
// before the CLI got going.
withProgress: async (_title, task) => {