• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

devonfw / IDEasy / 30625562134

31 Jul 2026 11:01AM UTC coverage: 72.613% (-0.03%) from 72.641%
30625562134

Pull #2212

github

web-flow
Merge 36165b9ca into 468118d46
Pull Request #2212: #2190: IDEasy destroys python installation

5023 of 7653 branches covered (65.63%)

Branch coverage included in aggregate %.

13086 of 17286 relevant lines covered (75.7%)

3.21 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

80.3
cli/src/main/java/com/devonfw/tools/ide/tool/LocalToolCommandlet.java
1
package com.devonfw.tools.ide.tool;
2

3
import java.nio.file.Files;
4
import java.nio.file.LinkOption;
5
import java.nio.file.Path;
6
import java.util.Collection;
7
import java.util.Set;
8

9
import org.slf4j.Logger;
10
import org.slf4j.LoggerFactory;
11

12
import com.devonfw.tools.ide.cli.CliOfflineException;
13
import com.devonfw.tools.ide.common.Tag;
14
import com.devonfw.tools.ide.context.IdeContext;
15
import com.devonfw.tools.ide.io.FileAccess;
16
import com.devonfw.tools.ide.log.IdeLogLevel;
17
import com.devonfw.tools.ide.process.ProcessContext;
18
import com.devonfw.tools.ide.step.Step;
19
import com.devonfw.tools.ide.tool.repository.ToolRepository;
20
import com.devonfw.tools.ide.url.model.file.json.ToolDependency;
21
import com.devonfw.tools.ide.version.GenericVersionRange;
22
import com.devonfw.tools.ide.version.VersionIdentifier;
23
import com.devonfw.tools.ide.version.VersionRange;
24

25
/**
26
 * {@link ToolCommandlet} that is installed locally into the IDEasy.
27
 */
28
public abstract class LocalToolCommandlet extends ToolCommandlet {
29

30
  private static final Logger LOG = LoggerFactory.getLogger(LocalToolCommandlet.class);
4✔
31

32
  /**
33
   * The constructor.
34
   *
35
   * @param context the {@link IdeContext}.
36
   * @param tool the {@link #getName() tool name}.
37
   * @param tags the {@link #getTags() tags} classifying the tool. Should be created via {@link Set#of(Object) Set.of} method.
38
   */
39
  public LocalToolCommandlet(IdeContext context, String tool, Set<Tag> tags) {
40

41
    super(context, tool, tags);
5✔
42
  }
1✔
43

44
  /**
45
   * @return the {@link Path} where the tool is located (installed).
46
   */
47
  @Override
48
  public Path getToolPath() {
49
    if (this.context.getSoftwarePath() == null) {
4✔
50
      return null;
2✔
51
    }
52
    return this.context.getSoftwarePath().resolve(getName());
7✔
53
  }
54

55
  /**
56
   * @return the {@link Path} where the executables of the tool can be found. Typically, a "bin" folder inside {@link #getToolPath() tool path}.
57
   */
58
  public Path getToolBinPath() {
59

60
    Path toolPath = getToolPath();
3✔
61
    if (toolPath == null) {
2!
62
      return null;
×
63
    }
64
    Path binPath = toolPath.resolve(IdeContext.FOLDER_BIN);
4✔
65
    if (Files.isDirectory(binPath)) {
5✔
66
      return binPath;
2✔
67
    }
68
    return toolPath;
2✔
69
  }
70

71
  /**
72
   * @return {@code true} to ignore a missing {@link IdeContext#FILE_SOFTWARE_VERSION software version file} in an installation, {@code false} delete the broken
73
   *     installation (default).
74
   */
75
  protected boolean isIgnoreMissingSoftwareVersionFile() {
76

77
    return false;
×
78
  }
79

80

81
  @Override
82
  protected ToolInstallation doInstall(ToolInstallRequest request) {
83

84
    Step step = request.getStep();
3✔
85
    if (step == null) {
2!
86
      return doInstallStep(request);
4✔
87
    } else {
88
      return step.call(() -> doInstallStep(request),
×
89
          () -> createExistingToolInstallation(request));
×
90
    }
91
  }
92

93
  private ToolInstallation doInstallStep(ToolInstallRequest request) {
94

95
    // install configured version of our tool in the software repository if not already installed
96
    ToolInstallation installation = installTool(request);
4✔
97

98
    // check if we already have this version installed (linked) locally in IDE_HOME/software
99
    VersionIdentifier resolvedVersion = installation.resolvedVersion();
3✔
100
    if (request.isAlreadyInstalled()) {
3✔
101
      return installation;
2✔
102
    } else {
103
      LOG.debug("Installation from {} to {}.", request.getInstalled(), request.getRequested());
7✔
104
    }
105
    FileAccess fileAccess = this.context.getFileAccess();
4✔
106
    boolean ignoreSoftwareRepo = isIgnoreSoftwareRepo();
3✔
107
    Path toolPath = request.getToolPath();
3✔
108
    if (!ignoreSoftwareRepo) {
2✔
109
      // we need to link the version or update the link.
110
      if (Files.exists(toolPath, LinkOption.NOFOLLOW_LINKS)) {
9✔
111
        fileAccess.backup(toolPath);
4✔
112
      }
113
      fileAccess.mkdirs(toolPath.getParent());
4✔
114
      fileAccess.symlink(installation.linkDir(), toolPath);
5✔
115
    }
116
    if (!request.isExtraInstallation() && (installation.binDir() != null)) {
6!
117
      this.context.getPath().setPath(this.tool, installation.binDir());
8✔
118
    }
119
    postInstall(request);
3✔
120
    ToolEditionAndVersion installed = request.getInstalled();
3✔
121
    GenericVersionRange installedVersion = null;
2✔
122
    if (installed != null) {
2!
123
      installedVersion = installed.getVersion();
3✔
124
    }
125
    ToolEditionAndVersion requested = request.getRequested();
3✔
126
    ToolEdition toolEdition = requested.getEdition();
3✔
127
    Step step = request.getStep();
3✔
128
    if (installedVersion == null) {
2✔
129
      IdeLogLevel.SUCCESS.log(LOG, "Successfully installed {} in version {} at {}", toolEdition, resolvedVersion, toolPath);
19✔
130
    } else {
131
      IdeLogLevel.SUCCESS.log(LOG, "Successfully installed {} in version {} replacing previous version {} of {} at {}", toolEdition,
21✔
132
          resolvedVersion, installedVersion, installed.getEdition(), toolPath);
6✔
133
    }
134
    if (step != null) {
2!
135
      step.success(true);
×
136
    }
137
    return installation;
2✔
138
  }
139

140
  /**
141
   * Determines whether this tool should be installed directly in the software folder or in the software repository.
142
   *
143
   * @return {@code true} if the tool should be installed directly in the software folder, ignoring the central software repository; {@code false} if the tool
144
   *     should be installed in the central software repository (default behavior).
145
   */
146
  protected boolean isIgnoreSoftwareRepo() {
147

148
    return false;
2✔
149
  }
150

151
  /**
152
   * Performs the installation of the {@link #getName() tool} together with the environment context  managed by this
153
   * {@link com.devonfw.tools.ide.commandlet.Commandlet}.
154
   *
155
   * @param request the {@link ToolInstallRequest}.
156
   * @return the resulting {@link ToolInstallation}.
157
   */
158
  public ToolInstallation installTool(ToolInstallRequest request) {
159

160
    completeRequest(request); // most likely already done, but if installTool was called directly and not from install
3✔
161
    if (request.isInstallLoop()) {
3!
162
      return toolAlreadyInstalled(request);
×
163
    }
164
    ToolEditionAndVersion requested = request.getRequested();
3✔
165
    ToolEdition toolEdition = requested.getEdition();
3✔
166
    assert (toolEdition.tool().equals(this.tool)) : "Mismatch " + this.tool + " != " + toolEdition.tool();
7!
167
    String edition = toolEdition.edition();
3✔
168
    VersionIdentifier resolvedVersion = cveCheck(request);
4✔
169
    installToolDependencies(request);
3✔
170
    // cveCheck might have changed resolvedVersion so let us re-check...
171
    if (request.isAlreadyInstalled()) {
3✔
172
      return toolAlreadyInstalled(request);
4✔
173
    } else {
174
      ToolEditionAndVersion installed = request.getInstalled();
3✔
175
      LOG.debug("Installation from {} to {}.", installed, requested);
5✔
176
    }
177
    Path installationPath = getInstallationPath(edition, resolvedVersion);
5✔
178

179
    ProcessContext processContext = request.getProcessContext();
3✔
180
    boolean additionalInstallation = request.isAdditionalInstallation();
3✔
181
    boolean ignoreSoftwareRepo = isIgnoreSoftwareRepo();
3✔
182
    Path toolVersionFile = installationPath.resolve(IdeContext.FILE_SOFTWARE_VERSION);
4✔
183
    FileAccess fileAccess = this.context.getFileAccess();
4✔
184
    if (Files.isDirectory(installationPath)) {
5✔
185
      if (Files.exists(toolVersionFile)) {
5!
186
        if (!ignoreSoftwareRepo) {
2✔
187
          assert resolvedVersion.equals(getInstalledVersion(installationPath)) :
7!
188
              "Found version " + getInstalledVersion(installationPath) + " in " + toolVersionFile + " but expected " + resolvedVersion;
×
189
          LOG.debug("Version {} of tool {} is already installed at {}", resolvedVersion, toolEdition, installationPath);
17✔
190
          return createToolInstallation(installationPath, resolvedVersion, false, processContext, additionalInstallation);
8✔
191
        }
192
      } else {
193
        // Makes sure that IDEasy will not delete itself
194
        if (this.tool.equals(IdeasyCommandlet.TOOL_NAME)) {
×
195
          LOG.warn("Your IDEasy installation is missing the version file at {}", toolVersionFile);
×
196
          return createToolInstallation(installationPath, resolvedVersion, false, processContext, additionalInstallation);
×
197
        } else if (!isIgnoreMissingSoftwareVersionFile()) {
×
198
          LOG.warn("Deleting corrupted installation at {}", installationPath);
×
199
          fileAccess.delete(installationPath);
×
200
        } else {
201
          // Version file missing but tool allows this - restore it and preserve installation
202
          LOG.warn("Version file missing at {} - restoring it for tool {}", toolVersionFile, this.tool);
×
203
          // Restore the missing file
204
          this.context.writeVersionFile(resolvedVersion, installationPath);
×
205
          return createToolInstallation(installationPath, resolvedVersion, false, processContext, additionalInstallation);
×
206
        }
207
      }
208
    }
209
    VersionIdentifier actualInstalledVersion = resolvedVersion;
2✔
210
    try {
211
      performToolInstallation(request, installationPath);
4✔
212
    } catch (CliOfflineException e) {
1✔
213
      // If we are offline and cannot download, check if we can continue with an existing installation
214
      ToolEditionAndVersion installed = request.getInstalled();
3✔
215
      if ((installed != null) && (installed.getResolvedVersion() != null)) {
5!
216
        LOG.warn("Cannot download {} in version {} because we are offline. Continuing with already installed version {}.", this.tool,
17✔
217
            resolvedVersion, installed.getResolvedVersion());
2✔
218
        // If offline and could not download, actualInstalledVersion will be the old version, not resolvedVersion
219
        // In that case, we need to recalculate the installation path for the actually installed version
220
        actualInstalledVersion = installed.getResolvedVersion();
3✔
221
        installationPath = getInstallationPath(edition, actualInstalledVersion);
6✔
222
      } else {
223
        // No existing installation available, re-throw the exception
224
        throw e;
2✔
225
      }
226
    }
1✔
227
    return createToolInstallation(installationPath, actualInstalledVersion, true, processContext, additionalInstallation);
8✔
228
  }
229

230
  /**
231
   * Performs the installation of the {@link #getName() tool} by using {@link #installDownloadedToolPayload(ToolInstallRequest, Path, Path)} for tool-specific
232
   * logic, backing up any existing installation, and writing the version file.
233
   * <p>
234
   * This method assumes that the version has already been resolved and dependencies installed. It handles the final steps of placing the tool into the
235
   * appropriate installation directory.
236
   *
237
   * @param request the {@link ToolInstallRequest}.
238
   * @param installationPath the target {@link Path} where the {@link #getName() tool} should be installed.
239
   */
240
  protected void performToolInstallation(ToolInstallRequest request, Path installationPath) {
241

242
    FileAccess fileAccess = this.context.getFileAccess();
4✔
243
    ToolEditionAndVersion requested = request.getRequested();
3✔
244
    VersionIdentifier resolvedVersion = requested.getResolvedVersion();
3✔
245
    Path downloadedToolFile = downloadTool(requested.getEdition().edition(), resolvedVersion);
7✔
246

247
    if (Files.isDirectory(installationPath)) {
5!
248
      if (this.tool.equals(IdeasyCommandlet.TOOL_NAME)) {
×
249
        LOG.warn("Your IDEasy installation is missing the version file.");
×
250
      } else {
251
        fileAccess.backup(installationPath);
×
252
      }
253
    }
254
    fileAccess.mkdirs(installationPath.getParent());
4✔
255

256
    installDownloadedToolPayload(request, installationPath, downloadedToolFile);
5✔
257

258
    this.context.writeVersionFile(resolvedVersion, installationPath);
5✔
259
    // fix macOS Gatekeeper blocking - must run after version file is written but before any executables are launched
260
    getMacOsHelper().removeQuarantineAttribute(installationPath);
4✔
261
    LOG.debug("Installed {} in version {} at {}", this.tool, resolvedVersion, installationPath);
18✔
262
  }
1✔
263

264
  /**
265
   * Performs the actual installation of the tool bits.
266
   *
267
   * @param request the {@link ToolInstallRequest}.
268
   * @param installationPath the target {@link Path} where the tool should be installed.
269
   * @param downloadedToolFile the {@link Path} to the downloaded tool file.
270
   */
271
  protected void installDownloadedToolPayload(ToolInstallRequest request, Path installationPath, Path downloadedToolFile) {
272

273
    boolean extract = isExtract();
3✔
274
    if (!extract) {
2✔
275
      LOG.trace("Extraction is disabled for '{}' hence just moving the downloaded file {}.", this.tool, downloadedToolFile);
6✔
276
    }
277
    this.context.getFileAccess().extract(downloadedToolFile, installationPath, this::postExtract, extract);
9✔
278
  }
1✔
279

280
  /**
281
   * @param edition the {@link #getConfiguredEdition() tool edition} to download.
282
   * @param resolvedVersion the resolved {@link VersionIdentifier version} to download.
283
   * @return the {@link Path} to the downloaded release file.
284
   */
285
  protected Path downloadTool(String edition, VersionIdentifier resolvedVersion) {
286
    return getToolRepository().download(this.tool, edition, resolvedVersion, this);
9✔
287
  }
288

289
  /**
290
   * Install this tool as dependency of another tool.
291
   *
292
   * @param versionRange the required {@link VersionRange}. See {@link ToolDependency#versionRange()}.
293
   * @param parentRequest the {@link ToolInstallRequest} of the tool causing this dependency.
294
   * @return the corresponding {@link ToolInstallation}.
295
   */
296
  public ToolInstallation installAsDependency(VersionRange versionRange, ToolInstallRequest parentRequest) {
297
    ToolInstallRequest request = new ToolInstallRequest(parentRequest);
5✔
298
    ToolEditionAndVersion requested = new ToolEditionAndVersion(getToolWithConfiguredEdition());
6✔
299
    request.setRequested(requested);
3✔
300
    VersionIdentifier configuredVersion = getConfiguredVersion();
3✔
301
    if (versionRange.contains(configuredVersion)) {
4✔
302
      // prefer configured version if contained in version range
303
      requested.setVersion(configuredVersion);
3✔
304
      // return install(true, configuredVersion, processContext, null);
305
      return install(request);
4✔
306
    } else {
307
      if (isIgnoreSoftwareRepo()) {
3!
308
        throw new IllegalStateException(
×
309
            "Cannot satisfy dependency to " + this.tool + " in version " + versionRange + " for " + parentRequest.getRequested()
×
310
                + " since it is conflicting with configured version "
311
                + configuredVersion
312
                + " and this tool does not support the software repository.");
313
      }
314
      LOG.info(
8✔
315
          "The tool {} requires {} in the version range {}, but your project uses version {}, which does not match."
316
              + " Therefore, we install a compatible version in that range.",
317
          parentRequest.getRequested().getEdition(), this.tool, versionRange, configuredVersion);
16✔
318
      requested.setVersion(versionRange);
3✔
319
      return installTool(request);
4✔
320
    }
321
  }
322

323
  /**
324
   * Installs the tool dependencies for the current tool.
325
   *
326
   * @param request the {@link ToolInstallRequest}.
327
   */
328
  protected void installToolDependencies(ToolInstallRequest request) {
329

330
    ToolEditionAndVersion requested = request.getRequested();
3✔
331
    VersionIdentifier version = requested.getResolvedVersion();
3✔
332
    ToolEdition toolEdition = requested.getEdition();
3✔
333
    Collection<ToolDependency> dependencies = getToolRepository().findDependencies(this.tool, toolEdition.edition(), version);
9✔
334
    int size = dependencies.size();
3✔
335
    LOG.debug("Tool {} has {} other tool(s) as dependency", toolEdition, size);
6✔
336
    for (ToolDependency dependency : dependencies) {
10✔
337
      LOG.trace("Ensuring dependency {} for tool {}", dependency.tool(), toolEdition);
6✔
338
      LocalToolCommandlet dependencyTool = this.context.getCommandletManager().getRequiredLocalToolCommandlet(dependency.tool());
7✔
339
      dependencyTool.installAsDependency(dependency.versionRange(), request);
6✔
340
    }
1✔
341
  }
1✔
342

343
  /**
344
   * Post-extraction hook that can be overridden to add custom processing after unpacking and before moving to the final destination folder.
345
   *
346
   * @param extractedDir the {@link Path} to the folder with the unpacked tool.
347
   */
348
  protected void postExtract(Path extractedDir) {
349

350
  }
1✔
351

352
  @Override
353
  public VersionIdentifier getInstalledVersion() {
354

355
    return getInstalledVersion(getToolPath());
5✔
356
  }
357

358
  /**
359
   * @param toolPath the installation {@link Path} where to find the version file.
360
   * @return the currently installed {@link VersionIdentifier version} of this tool or {@code null} if not installed.
361
   */
362
  protected VersionIdentifier getInstalledVersion(Path toolPath) {
363

364
    if (isToolNotInstalled(toolPath)) {
4✔
365
      return null;
2✔
366
    }
367
    Path versionLookupPath = getInstalledSoftwareRepoPath(toolPath, false);
5✔
368
    if (versionLookupPath == null) {
2✔
369
      versionLookupPath = toolPath;
2✔
370
    }
371
    Path toolVersionFile = versionLookupPath.resolve(IdeContext.FILE_SOFTWARE_VERSION);
4✔
372
    if (!Files.exists(toolVersionFile)) {
5✔
373
      Path legacyToolVersionFile = versionLookupPath.resolve(IdeContext.FILE_LEGACY_SOFTWARE_VERSION);
4✔
374
      if (Files.exists(legacyToolVersionFile)) {
5!
375
        toolVersionFile = legacyToolVersionFile;
3✔
376
      } else {
377
        LOG.warn("Tool {} is missing version file in {}", getName(), toolVersionFile);
×
378
        return null;
×
379
      }
380
    }
381
    String version = this.context.getFileAccess().readFileContent(toolVersionFile).trim();
7✔
382
    return VersionIdentifier.of(version);
3✔
383
  }
384

385
  @Override
386
  public String getInstalledEdition() {
387

388
    return getInstalledEdition(getToolPath());
5✔
389
  }
390

391
  /**
392
   * @param toolPath the installation {@link Path} where to find currently installed tool. The name of the parent directory of the real path corresponding
393
   *     to the passed {@link Path path} must be the name of the edition.
394
   * @return the installed edition of this tool or {@code null} if not installed.
395
   */
396
  protected String getInstalledEdition(Path toolPath) {
397
    if (isToolNotInstalled(toolPath)) {
4✔
398
      return null;
2✔
399
    }
400
    Path realPath = this.context.getFileAccess().toRealPath(toolPath);
6✔
401
    // if the realPath changed, a link has been resolved
402
    if (realPath.equals(toolPath)) {
4✔
403
      if (!isIgnoreSoftwareRepo()) {
3✔
404
        LOG.warn("Tool {} is not installed via software repository (maybe from devonfw-ide). Please consider reinstalling it.", this.tool);
5✔
405
      }
406
      // I do not see any reliable way how we could determine the edition of a tool that does not use software repo or that was installed by devonfw-ide
407
      return getConfiguredEdition();
3✔
408
    }
409
    Path toolRepoFolder = context.getSoftwareRepositoryPath().resolve(ToolRepository.ID_DEFAULT).resolve(this.tool);
9✔
410
    String edition = getEdition(toolRepoFolder, realPath);
5✔
411
    if (edition == null) {
2!
412
      edition = this.tool;
×
413
    }
414
    if (!getToolRepository().getSortedEditions(this.tool).contains(edition)) {
8✔
415
      LOG.warn("Undefined edition {} of tool {}", edition, this.tool);
6✔
416
    }
417
    return edition;
2✔
418
  }
419

420
  private String getEdition(Path toolRepoFolder, Path toolInstallFolder) {
421

422
    int toolRepoNameCount = toolRepoFolder.getNameCount();
3✔
423
    int toolInstallNameCount = toolInstallFolder.getNameCount();
3✔
424
    if (toolRepoNameCount < toolInstallNameCount) {
3!
425
      // ensure toolInstallFolder starts with $IDE_ROOT/_ide/software/default/«tool»
426
      for (int i = 0; i < toolRepoNameCount; i++) {
7✔
427
        if (!toolRepoFolder.getName(i).toString().equals(toolInstallFolder.getName(i).toString())) {
10!
428
          return null;
×
429
        }
430
      }
431
      return toolInstallFolder.getName(toolRepoNameCount).toString();
5✔
432
    }
433
    return null;
×
434
  }
435

436
  private Path getInstalledSoftwareRepoPath(Path toolPath) {
437
    return getInstalledSoftwareRepoPath(toolPath, false);
×
438
  }
439

440
  private Path getInstalledSoftwareRepoPath(Path toolPath, boolean logIfNotSoftwareRepo) {
441
    if (isToolNotInstalled(toolPath)) {
4!
442
      return null;
×
443
    }
444
    Path installPath = this.context.getFileAccess().toRealPath(toolPath);
6✔
445
    // if the installPath changed, a link has been resolved
446
    if (installPath.equals(toolPath)) {
4✔
447
      if (logIfNotSoftwareRepo && !isIgnoreSoftwareRepo()) {
2!
448
        LOG.warn("Tool {} is not installed via software repository (maybe from devonfw-ide). Please consider reinstalling it.", this.tool);
×
449
      }
450
      // I do not see any reliable way how we could determine the edition of a tool that does not use software repo or that was installed by devonfw-ide
451
      return null;
2✔
452
    }
453
    installPath = getValidInstalledSoftwareRepoPath(installPath, context.getSoftwareRepositoryPath());
7✔
454
    return installPath;
2✔
455
  }
456

457
  Path getValidInstalledSoftwareRepoPath(Path installPath, Path softwareRepoPath) {
458
    int softwareRepoNameCount = softwareRepoPath.getNameCount();
3✔
459
    int toolInstallNameCount = installPath.getNameCount();
3✔
460
    int targetToolInstallNameCount = softwareRepoNameCount + 4;
4✔
461

462
    // installPath can't be shorter than softwareRepoPath
463
    if (toolInstallNameCount < softwareRepoNameCount) {
3!
464
      LOG.warn("The installation path is not located within the software repository {}.", installPath);
×
465
      return null;
×
466
    }
467
    // ensure installPath starts with $IDE_ROOT/_ide/software/
468
    for (int i = 0; i < softwareRepoNameCount; i++) {
7✔
469
      if (!softwareRepoPath.getName(i).toString().equals(installPath.getName(i).toString())) {
10✔
470
        LOG.warn("The installation path is not located within the software repository {}.", installPath);
4✔
471
        return null;
2✔
472
      }
473
    }
474
    // return $IDE_ROOT/_ide/software/«id»/«tool»/«edition»/«version»
475
    if (toolInstallNameCount == targetToolInstallNameCount) {
3✔
476
      return installPath;
2✔
477
    } else if (toolInstallNameCount > targetToolInstallNameCount) {
3✔
478
      Path validInstallPath = installPath;
2✔
479
      for (int i = 0; i < toolInstallNameCount - targetToolInstallNameCount; i++) {
9✔
480
        validInstallPath = validInstallPath.getParent();
3✔
481
      }
482
      return validInstallPath;
2✔
483
    } else {
484
      LOG.warn("The installation path is faulty {}.", installPath);
4✔
485
      return null;
2✔
486
    }
487
  }
488

489
  private boolean isToolNotInstalled(Path toolPath) {
490

491
    if ((toolPath == null) || !Files.isDirectory(toolPath)) {
7✔
492
      LOG.debug("Tool {} not installed in {}", this.tool, toolPath);
6✔
493
      return true;
2✔
494
    }
495
    return false;
2✔
496
  }
497

498
  @Override
499
  public void uninstall() {
500
    try {
501
      Path toolPath = getToolPath();
3✔
502
      if (!Files.exists(toolPath)) {
5!
503
        LOG.warn("An installed version of {} does not exist.", this.tool);
×
504
        return;
×
505
      }
506
      if (this.context.isForceMode() && !isIgnoreSoftwareRepo()) {
7!
507
        LOG.warn(
6✔
508
            "You triggered an uninstall of {} in version {} with force mode!\n"
509
                + "This will physically delete the currently installed version including its plugins from the machine.\n"
510
                + "This may cause issues with other projects, that use the same version of that tool."
511
            , this.tool, getInstalledVersion());
1✔
512
        uninstallPluginsOfTool();
2✔
513
        uninstallFromSoftwareRepository(toolPath);
3✔
514
      }
515
      performUninstall(toolPath);
3✔
516
      IdeLogLevel.SUCCESS.log(LOG, "Successfully uninstalled {}", this.tool);
11✔
517
    } catch (Exception e) {
×
518
      LOG.error("Failed to uninstall {}", this.tool, e);
×
519
    }
1✔
520
  }
1✔
521

522
  /**
523
   * Performs the actual uninstallation of this tool.
524
   *
525
   * @param toolPath the current {@link #getToolPath() tool path}.
526
   */
527
  protected void performUninstall(Path toolPath) {
528
    this.context.getFileAccess().delete(toolPath);
5✔
529
  }
1✔
530

531
  /**
532
   * Deletes the installed version of the tool from the shared software repository.
533
   */
534
  private void uninstallFromSoftwareRepository(Path toolPath) {
535
    Path repoPath = getInstalledSoftwareRepoPath(toolPath, true);
5✔
536
    if ((repoPath == null) || !Files.exists(repoPath)) {
7!
537
      LOG.warn("An installed version of {} does not exist in software repository.", this.tool);
×
538
      return;
×
539
    }
540
    LOG.info("Physically deleting {} as requested by the user via force mode.", repoPath);
4✔
541
    this.context.getFileAccess().delete(repoPath);
5✔
542
    IdeLogLevel.SUCCESS.log(LOG, "Successfully deleted {} from your computer.", repoPath);
10✔
543
  }
1✔
544

545
  /**
546
   * Deletes the installed plugins of the tool from the plugins path.
547
   */
548
  private void uninstallPluginsOfTool() {
549

550
    Path toolPluginsPath = this.context.getPluginsPath().resolve(this.tool);
7✔
551
    if (!Files.exists(toolPluginsPath)) {
5!
552
      LOG.info("There are no plugins of {} present to delete.", this.tool);
5✔
553
      return;
1✔
554
    }
555
    LOG.info("Physically deleting {} as requested by the user via force mode.", toolPluginsPath);
×
556
    this.context.getFileAccess().delete(toolPluginsPath);
×
557
    IdeLogLevel.SUCCESS.log(LOG, "Successfully deleted {} from your computer.", toolPluginsPath);
×
558
  }
×
559

560
  @Override
561
  protected Path getInstallationPath(String edition, VersionIdentifier resolvedVersion) {
562
    Path installationPath;
563
    if (isIgnoreSoftwareRepo()) {
3✔
564
      installationPath = getToolPath();
4✔
565
    } else {
566
      Path softwareRepositoryPath = this.context.getSoftwareRepositoryPath();
4✔
567
      if (softwareRepositoryPath == null) {
2!
568
        return null;
×
569
      }
570
      Path softwareRepoPath = softwareRepositoryPath.resolve(getToolRepository().getId()).resolve(this.tool).resolve(edition);
11✔
571
      installationPath = softwareRepoPath.resolve(resolvedVersion.toString());
5✔
572
    }
573
    return installationPath;
2✔
574
  }
575

576
  /**
577
   * @return {@link VersionIdentifier} with latest version of the tool}.
578
   */
579
  public VersionIdentifier getLatestToolVersion() {
580

581
    return this.context.getDefaultToolRepository().resolveVersion(this.tool, getConfiguredEdition(), VersionIdentifier.LATEST, this);
×
582
  }
583

584

585
  /**
586
   * Searches for a wrapper file in valid projects (containing a build file f.e. build.gradle or pom.xml) and returns its path.
587
   *
588
   * @param wrapperFileName the name of the wrapper file
589
   * @return Path of the wrapper file or {@code null} if none was found.
590
   */
591
  protected Path findWrapper(String wrapperFileName) {
592
    Path dir = this.context.getCwd();
4✔
593
    // traverse the cwd directory containing a build descriptor up till a wrapper file was found
594
    while ((dir != null) && (findBuildDescriptor(dir) != null)) {
6!
595
      Path wrapper = dir.resolve(wrapperFileName);
4✔
596
      if (Files.exists(wrapper)) {
5✔
597
        LOG.debug("Using wrapper: {}", wrapper);
4✔
598
        return wrapper;
2✔
599
      }
600
      dir = dir.getParent();
3✔
601
    }
1✔
602
    return null;
2✔
603
  }
604

605
  /**
606
   * @param directory the {@link Path} to the build directory.
607
   * @return the build configuration file for this tool or {@code null} if not found (or this is not a build tool).
608
   */
609
  public Path findBuildDescriptor(Path directory) {
610
    return null;
2✔
611
  }
612

613
  /**
614
   * @return Bash completion command for this tool or {@code null} if this tool does not provide Bash completion.
615
   */
616
  public String getBashCompletion() {
617

618
    return null;
×
619
  }
620
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE TRIAL · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc