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

devonfw / IDEasy / 26271569121

22 May 2026 06:10AM UTC coverage: 70.925% (-0.1%) from 71.062%
26271569121

Pull #1913

github

web-flow
Merge f150bd625 into 58ae6752b
Pull Request #1913: 1719: Rust Integration

4471 of 6972 branches covered (64.13%)

Branch coverage included in aggregate %.

11546 of 15611 relevant lines covered (73.96%)

3.13 hits per line

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

80.6
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;
×
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

171
    // cveCheck might have changed resolvedVersion so let us re-check...
172
    if (request.isAlreadyInstalled()) {
3✔
173
      return toolAlreadyInstalled(request);
4✔
174
    } else {
175
      ToolEditionAndVersion installed = request.getInstalled();
3✔
176
      LOG.debug("Installation from {} to {}.", installed, requested);
5✔
177
    }
178
    Path installationPath = getInstallationPath(edition, resolvedVersion);
5✔
179

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

225
  /**
226
   * Performs the actual installation of the {@link #getName() tool}.
227
   *
228
   * @param request the {@link ToolInstallRequest}.
229
   * @param installationPath the target {@link Path} where the {@link #getName() tool} should be installed.
230
   * @see #doInstall(ToolInstallRequest, Path, Path)
231
   */
232
  protected void performToolInstallation(ToolInstallRequest request, Path installationPath) {
233

234
    installDependencies(request);
3✔
235
    FileAccess fileAccess = this.context.getFileAccess();
4✔
236
    ToolEditionAndVersion requested = request.getRequested();
3✔
237
    VersionIdentifier resolvedVersion = requested.getResolvedVersion();
3✔
238
    Path downloadedToolFile = getDownloadedToolFile(request);
4✔
239

240
    if (Files.isDirectory(installationPath)) {
5!
241
      if (this.tool.equals(IdeasyCommandlet.TOOL_NAME)) {
×
242
        LOG.warn("Your IDEasy installation is missing the version file.");
×
243
      } else {
244
        fileAccess.backup(installationPath);
×
245
      }
246
    }
247
    fileAccess.mkdirs(installationPath.getParent());
4✔
248

249
    doInstall(request, installationPath, downloadedToolFile);
5✔
250

251
    this.context.writeVersionFile(resolvedVersion, installationPath);
5✔
252
    // fix macOS Gatekeeper blocking - must run after version file is written but before any executables are launched
253
    getMacOsHelper().removeQuarantineAttribute(installationPath);
4✔
254
    LOG.debug("Installed {} in version {} at {}", this.tool, resolvedVersion, installationPath);
18✔
255
  }
1✔
256

257
  /**
258
   * @param request the {@link ToolInstallRequest}.
259
   * @return the {@link Path} to the downloaded tool file.
260
   */
261
  protected Path getDownloadedToolFile(ToolInstallRequest request) {
262

263
    ToolEditionAndVersion requested = request.getRequested();
3✔
264
    VersionIdentifier resolvedVersion = requested.getResolvedVersion();
3✔
265
    return downloadTool(requested.getEdition().edition(), resolvedVersion);
7✔
266
  }
267

268
  /**
269
   * Hook to install dependencies of this tool.
270
   *
271
   * @param request the {@link ToolInstallRequest}.
272
   */
273
  protected void installDependencies(ToolInstallRequest request) {
274

275
    // nothing to do by default...
276
  }
1✔
277

278
  /**
279
   * Hook for the actual installation of the {@link #getName() tool}. The default implementation performs an
280
   * {@link FileAccess#extract(Path, Path, java.util.function.Consumer, boolean) extraction}.
281
   *
282
   * @param request the {@link ToolInstallRequest}.
283
   * @param installationPath the target {@link Path} where the {@link #getName() tool} should be installed.
284
   * @param downloadedToolFile the {@link Path} to the downloaded tool file.
285
   */
286
  protected void doInstall(ToolInstallRequest request, Path installationPath, Path downloadedToolFile) {
287

288
    boolean extract = isExtract();
3✔
289
    if (!extract) {
2✔
290
      LOG.trace("Extraction is disabled for '{}' hence just moving the downloaded file {}.", this.tool, downloadedToolFile);
6✔
291
    }
292
    this.context.getFileAccess().extract(downloadedToolFile, installationPath, this::postExtract, extract);
9✔
293
  }
1✔
294

295
  /**
296
   * @param edition the {@link #getConfiguredEdition() tool edition} to download.
297
   * @param resolvedVersion the resolved {@link VersionIdentifier version} to download.
298
   * @return the {@link Path} to the downloaded release file.
299
   */
300
  protected Path downloadTool(String edition, VersionIdentifier resolvedVersion) {
301
    return getToolRepository().download(this.tool, edition, resolvedVersion, this);
9✔
302
  }
303

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

338
  /**
339
   * Installs the tool dependencies for the current tool.
340
   *
341
   * @param request the {@link ToolInstallRequest}.
342
   */
343
  protected void installToolDependencies(ToolInstallRequest request) {
344

345
    ToolEditionAndVersion requested = request.getRequested();
3✔
346
    VersionIdentifier version = requested.getResolvedVersion();
3✔
347
    ToolEdition toolEdition = requested.getEdition();
3✔
348
    Collection<ToolDependency> dependencies = getToolRepository().findDependencies(this.tool, toolEdition.edition(), version);
9✔
349
    int size = dependencies.size();
3✔
350
    LOG.debug("Tool {} has {} other tool(s) as dependency", toolEdition, size);
6✔
351
    for (ToolDependency dependency : dependencies) {
10✔
352
      LOG.trace("Ensuring dependency {} for tool {}", dependency.tool(), toolEdition);
6✔
353
      LocalToolCommandlet dependencyTool = this.context.getCommandletManager().getRequiredLocalToolCommandlet(dependency.tool());
7✔
354
      dependencyTool.installAsDependency(dependency.versionRange(), request);
6✔
355
    }
1✔
356
  }
1✔
357

358
  /**
359
   * Post-extraction hook that can be overridden to add custom processing after unpacking and before moving to the final destination folder.
360
   *
361
   * @param extractedDir the {@link Path} to the folder with the unpacked tool.
362
   */
363
  protected void postExtract(Path extractedDir) {
364

365
  }
1✔
366

367
  @Override
368
  public VersionIdentifier getInstalledVersion() {
369

370
    return getInstalledVersion(getToolPath());
5✔
371
  }
372

373
  /**
374
   * @param toolPath the installation {@link Path} where to find the version file.
375
   * @return the currently installed {@link VersionIdentifier version} of this tool or {@code null} if not installed.
376
   */
377
  protected VersionIdentifier getInstalledVersion(Path toolPath) {
378

379
    if (isToolNotInstalled(toolPath)) {
4✔
380
      return null;
2✔
381
    }
382
    Path versionLookupPath = getInstalledSoftwareRepoPath(toolPath, false);
5✔
383
    if (versionLookupPath == null) {
2✔
384
      versionLookupPath = toolPath;
2✔
385
    }
386
    Path toolVersionFile = versionLookupPath.resolve(IdeContext.FILE_SOFTWARE_VERSION);
4✔
387
    if (!Files.exists(toolVersionFile)) {
5✔
388
      Path legacyToolVersionFile = versionLookupPath.resolve(IdeContext.FILE_LEGACY_SOFTWARE_VERSION);
4✔
389
      if (Files.exists(legacyToolVersionFile)) {
5!
390
        toolVersionFile = legacyToolVersionFile;
3✔
391
      } else {
392
        LOG.warn("Tool {} is missing version file in {}", getName(), toolVersionFile);
×
393
        return null;
×
394
      }
395
    }
396
    String version = this.context.getFileAccess().readFileContent(toolVersionFile).trim();
7✔
397
    return VersionIdentifier.of(version);
3✔
398
  }
399

400
  @Override
401
  public String getInstalledEdition() {
402

403
    return getInstalledEdition(getToolPath());
5✔
404
  }
405

406
  /**
407
   * @param toolPath the installation {@link Path} where to find currently installed tool. The name of the parent directory of the real path corresponding
408
   *     to the passed {@link Path path} must be the name of the edition.
409
   * @return the installed edition of this tool or {@code null} if not installed.
410
   */
411
  protected String getInstalledEdition(Path toolPath) {
412
    if (isToolNotInstalled(toolPath)) {
4✔
413
      return null;
2✔
414
    }
415
    Path realPath = this.context.getFileAccess().toRealPath(toolPath);
6✔
416
    // if the realPath changed, a link has been resolved
417
    if (realPath.equals(toolPath)) {
4✔
418
      if (!isIgnoreSoftwareRepo()) {
3✔
419
        LOG.warn("Tool {} is not installed via software repository (maybe from devonfw-ide). Please consider reinstalling it.", this.tool);
5✔
420
      }
421
      // 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
422
      return getConfiguredEdition();
3✔
423
    }
424
    Path toolRepoFolder = context.getSoftwareRepositoryPath().resolve(ToolRepository.ID_DEFAULT).resolve(this.tool);
9✔
425
    String edition = getEdition(toolRepoFolder, realPath);
5✔
426
    if (edition == null) {
2!
427
      edition = this.tool;
×
428
    }
429
    if (!getToolRepository().getSortedEditions(this.tool).contains(edition)) {
8✔
430
      LOG.warn("Undefined edition {} of tool {}", edition, this.tool);
6✔
431
    }
432
    return edition;
2✔
433
  }
434

435
  private String getEdition(Path toolRepoFolder, Path toolInstallFolder) {
436

437
    int toolRepoNameCount = toolRepoFolder.getNameCount();
3✔
438
    int toolInstallNameCount = toolInstallFolder.getNameCount();
3✔
439
    if (toolRepoNameCount < toolInstallNameCount) {
3!
440
      // ensure toolInstallFolder starts with $IDE_ROOT/_ide/software/default/«tool»
441
      for (int i = 0; i < toolRepoNameCount; i++) {
7✔
442
        if (!toolRepoFolder.getName(i).toString().equals(toolInstallFolder.getName(i).toString())) {
10!
443
          return null;
×
444
        }
445
      }
446
      return toolInstallFolder.getName(toolRepoNameCount).toString();
5✔
447
    }
448
    return null;
×
449
  }
450

451
  private Path getInstalledSoftwareRepoPath(Path toolPath) {
452
    return getInstalledSoftwareRepoPath(toolPath, false);
×
453
  }
454

455
  private Path getInstalledSoftwareRepoPath(Path toolPath, boolean logIfNotSoftwareRepo) {
456
    if (isToolNotInstalled(toolPath)) {
4!
457
      return null;
×
458
    }
459
    Path installPath = this.context.getFileAccess().toRealPath(toolPath);
6✔
460
    // if the installPath changed, a link has been resolved
461
    if (installPath.equals(toolPath)) {
4✔
462
      if (logIfNotSoftwareRepo && !isIgnoreSoftwareRepo()) {
2!
463
        LOG.warn("Tool {} is not installed via software repository (maybe from devonfw-ide). Please consider reinstalling it.", this.tool);
×
464
      }
465
      // 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
466
      return null;
2✔
467
    }
468
    installPath = getValidInstalledSoftwareRepoPath(installPath, context.getSoftwareRepositoryPath());
7✔
469
    return installPath;
2✔
470
  }
471

472
  Path getValidInstalledSoftwareRepoPath(Path installPath, Path softwareRepoPath) {
473
    int softwareRepoNameCount = softwareRepoPath.getNameCount();
3✔
474
    int toolInstallNameCount = installPath.getNameCount();
3✔
475
    int targetToolInstallNameCount = softwareRepoNameCount + 4;
4✔
476

477
    // installPath can't be shorter than softwareRepoPath
478
    if (toolInstallNameCount < softwareRepoNameCount) {
3!
479
      LOG.warn("The installation path is not located within the software repository {}.", installPath);
×
480
      return null;
×
481
    }
482
    // ensure installPath starts with $IDE_ROOT/_ide/software/
483
    for (int i = 0; i < softwareRepoNameCount; i++) {
7✔
484
      if (!softwareRepoPath.getName(i).toString().equals(installPath.getName(i).toString())) {
10✔
485
        LOG.warn("The installation path is not located within the software repository {}.", installPath);
4✔
486
        return null;
2✔
487
      }
488
    }
489
    // return $IDE_ROOT/_ide/software/«id»/«tool»/«edition»/«version»
490
    if (toolInstallNameCount == targetToolInstallNameCount) {
3✔
491
      return installPath;
2✔
492
    } else if (toolInstallNameCount > targetToolInstallNameCount) {
3✔
493
      Path validInstallPath = installPath;
2✔
494
      for (int i = 0; i < toolInstallNameCount - targetToolInstallNameCount; i++) {
9✔
495
        validInstallPath = validInstallPath.getParent();
3✔
496
      }
497
      return validInstallPath;
2✔
498
    } else {
499
      LOG.warn("The installation path is faulty {}.", installPath);
4✔
500
      return null;
2✔
501
    }
502
  }
503

504
  private boolean isToolNotInstalled(Path toolPath) {
505

506
    if ((toolPath == null) || !Files.isDirectory(toolPath)) {
7!
507
      LOG.debug("Tool {} not installed in {}", this.tool, toolPath);
6✔
508
      return true;
2✔
509
    }
510
    return false;
2✔
511
  }
512

513
  @Override
514
  public void uninstall() {
515
    try {
516
      Path toolPath = getToolPath();
3✔
517
      if (!Files.exists(toolPath)) {
5!
518
        LOG.warn("An installed version of {} does not exist.", this.tool);
×
519
        return;
×
520
      }
521
      if (this.context.isForceMode() && !isIgnoreSoftwareRepo()) {
7!
522
        LOG.warn(
6✔
523
            "You triggered an uninstall of {} in version {} with force mode!\n"
524
                + "This will physically delete the currently installed version including its plugins from the machine.\n"
525
                + "This may cause issues with other projects, that use the same version of that tool."
526
            , this.tool, getInstalledVersion());
1✔
527
        uninstallPluginsOfTool();
2✔
528
        uninstallFromSoftwareRepository(toolPath);
3✔
529
      }
530
      performUninstall(toolPath);
3✔
531
      IdeLogLevel.SUCCESS.log(LOG, "Successfully uninstalled {}", this.tool);
11✔
532
    } catch (Exception e) {
×
533
      LOG.error("Failed to uninstall {}", this.tool, e);
×
534
    }
1✔
535
  }
1✔
536

537
  /**
538
   * Performs the actual uninstallation of this tool.
539
   *
540
   * @param toolPath the current {@link #getToolPath() tool path}.
541
   */
542
  protected void performUninstall(Path toolPath) {
543
    this.context.getFileAccess().delete(toolPath);
5✔
544
  }
1✔
545

546
  /**
547
   * Deletes the installed version of the tool from the shared software repository.
548
   */
549
  private void uninstallFromSoftwareRepository(Path toolPath) {
550
    Path repoPath = getInstalledSoftwareRepoPath(toolPath, true);
5✔
551
    if ((repoPath == null) || !Files.exists(repoPath)) {
7!
552
      LOG.warn("An installed version of {} does not exist in software repository.", this.tool);
×
553
      return;
×
554
    }
555
    LOG.info("Physically deleting {} as requested by the user via force mode.", repoPath);
4✔
556
    this.context.getFileAccess().delete(repoPath);
5✔
557
    IdeLogLevel.SUCCESS.log(LOG, "Successfully deleted {} from your computer.", repoPath);
10✔
558
  }
1✔
559

560
  /**
561
   * Deletes the installed plugins of the tool from the plugins path.
562
   */
563
  private void uninstallPluginsOfTool() {
564

565
    Path toolPluginsPath = this.context.getPluginsPath().resolve(this.tool);
7✔
566
    if (!Files.exists(toolPluginsPath)) {
5!
567
      LOG.info("There are no plugins of {} present to delete.", this.tool);
5✔
568
      return;
1✔
569
    }
570
    LOG.info("Physically deleting {} as requested by the user via force mode.", toolPluginsPath);
×
571
    this.context.getFileAccess().delete(toolPluginsPath);
×
572
    IdeLogLevel.SUCCESS.log(LOG, "Successfully deleted {} from your computer.", toolPluginsPath);
×
573
  }
×
574

575
  @Override
576
  protected Path getInstallationPath(String edition, VersionIdentifier resolvedVersion) {
577
    Path installationPath;
578
    if (isIgnoreSoftwareRepo()) {
3✔
579
      installationPath = getToolPath();
4✔
580
    } else {
581
      Path softwareRepositoryPath = this.context.getSoftwareRepositoryPath();
4✔
582
      if (softwareRepositoryPath == null) {
2!
583
        return null;
×
584
      }
585
      Path softwareRepoPath = softwareRepositoryPath.resolve(getToolRepository().getId()).resolve(this.tool).resolve(edition);
11✔
586
      installationPath = softwareRepoPath.resolve(resolvedVersion.toString());
5✔
587
    }
588
    return installationPath;
2✔
589
  }
590

591
  /**
592
   * @return {@link VersionIdentifier} with latest version of the tool}.
593
   */
594
  public VersionIdentifier getLatestToolVersion() {
595

596
    return this.context.getDefaultToolRepository().resolveVersion(this.tool, getConfiguredEdition(), VersionIdentifier.LATEST, this);
×
597
  }
598

599

600
  /**
601
   * Searches for a wrapper file in valid projects (containing a build file f.e. build.gradle or pom.xml) and returns its path.
602
   *
603
   * @param wrapperFileName the name of the wrapper file
604
   * @return Path of the wrapper file or {@code null} if none was found.
605
   */
606
  protected Path findWrapper(String wrapperFileName) {
607
    Path dir = this.context.getCwd();
4✔
608
    // traverse the cwd directory containing a build descriptor up till a wrapper file was found
609
    while ((dir != null) && (findBuildDescriptor(dir) != null)) {
6!
610
      Path wrapper = dir.resolve(wrapperFileName);
4✔
611
      if (Files.exists(wrapper)) {
5✔
612
        LOG.debug("Using wrapper: {}", wrapper);
4✔
613
        return wrapper;
2✔
614
      }
615
      dir = dir.getParent();
3✔
616
    }
1✔
617
    return null;
2✔
618
  }
619

620
  /**
621
   * @param directory the {@link Path} to the build directory.
622
   * @return the build configuration file for this tool or {@code null} if not found (or this is not a build tool).
623
   */
624
  public Path findBuildDescriptor(Path directory) {
625
    return null;
2✔
626
  }
627
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc