14971720032

Committed 12 May 2025 12:04PM UTC coverage: 67.637% (-0.004%) from 67.641%

Build # 14971720032

Build Type

Pull #1254

github

Committed by

web-flow

Commit Message

Merge da06a8c1f into 70dd86242

Pull Request Pull Request #1254: #1213: changed the tool installation log

Run Details

3094 of 4982 branches covered (62.1%)

Branch coverage included in aggregate %.

7964 of 11367 relevant lines covered (70.06%)

3.07 hits per line

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

87.08

cli/src/main/java/com/devonfw/tools/ide/tool/LocalToolCommandlet.java

package com.devonfw.tools.ide.tool;

import java.nio.file.Files;
import java.nio.file.LinkOption;
import java.nio.file.Path;
import java.util.Collection;
import java.util.Set;

import com.devonfw.tools.ide.common.Tag;
import com.devonfw.tools.ide.context.IdeContext;
import com.devonfw.tools.ide.environment.EnvironmentVariables;
import com.devonfw.tools.ide.io.FileAccess;
import com.devonfw.tools.ide.io.FileCopyMode;
import com.devonfw.tools.ide.process.EnvironmentContext;
import com.devonfw.tools.ide.process.ProcessContext;
import com.devonfw.tools.ide.step.Step;
import com.devonfw.tools.ide.tool.repository.ToolRepository;
import com.devonfw.tools.ide.url.model.file.json.ToolDependency;
import com.devonfw.tools.ide.version.GenericVersionRange;
import com.devonfw.tools.ide.version.VersionIdentifier;
import com.devonfw.tools.ide.version.VersionRange;

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

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

    super(context, tool, tags);
  }

  /**
   * @return the {@link Path} where the tool is located (installed).
   */
  public Path getToolPath() {

    return this.context.getSoftwarePath().resolve(getName());
  }

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

    Path toolPath = getToolPath();
    Path binPath = this.context.getFileAccess().findFirst(toolPath, path -> path.getFileName().toString().equals("bin"), false);
    if ((binPath != null) && Files.isDirectory(binPath)) {
      return binPath;
    }
    return toolPath;
  }

  /**
   * @deprecated will be removed once all "dependencies.json" are created in ide-urls.
   */
  @Deprecated
  protected void installDependencies() {

  }

  @Override
  public boolean install(boolean silent, ProcessContext processContext) {

    installDependencies();
    VersionIdentifier configuredVersion = getConfiguredVersion();
    // get installed version before installInRepo actually may install the software
    VersionIdentifier installedVersion = getInstalledVersion();
    Step step = this.context.newStep(silent, "Install " + this.tool, configuredVersion);
    try {
      // install configured version of our tool in the software repository if not already installed
      ToolInstallation installation = installTool(configuredVersion, processContext);

      // check if we already have this version installed (linked) locally in IDE_HOME/software
      VersionIdentifier resolvedVersion = installation.resolvedVersion();
      if ((resolvedVersion.equals(installedVersion) && !installation.newInstallation())
          || (configuredVersion.matches(installedVersion) && context.isSkipUpdatesMode())) {
        return toolAlreadyInstalled(silent, installedVersion, step, processContext);
      }
      if (!isIgnoreSoftwareRepo()) {
        // we need to link the version or update the link.
        Path toolPath = getToolPath();
        FileAccess fileAccess = this.context.getFileAccess();
        if (Files.exists(toolPath, LinkOption.NOFOLLOW_LINKS)) {
          fileAccess.backup(toolPath);
        }
        fileAccess.mkdirs(toolPath.getParent());
        fileAccess.symlink(installation.linkDir(), toolPath);
      }
      this.context.getPath().setPath(this.tool, installation.binDir());
      postInstall(true, processContext);
      if (installedVersion == null) {
        step.success("Successfully installed {} in version {}", this.tool, resolvedVersion);
      } else {
        step.success("Successfully installed {} in version {} replacing previous version {}", this.tool, resolvedVersion, installedVersion);
      }
      return true;
    } catch (RuntimeException e) {
      step.error(e, true);
      throw e;
    } finally {
      step.close();
    }

  }

  /**
   * This method is called after a tool was requested to be installed or updated.
   *
   * @param newlyInstalled {@code true} if the tool was installed or updated (at least link to software folder was created/updated), {@code false} otherwise
   *     (configured version was already installed and nothing changed).
   * @param pc the {@link ProcessContext} to use.
   */
  protected void postInstall(boolean newlyInstalled, ProcessContext pc) {

    if (newlyInstalled) {
      postInstall();
    }
  }

  /**
   * This method is called after the tool has been newly installed or updated to a new version.
   */
  protected void postInstall() {

    // nothing to do by default
  }

  private boolean toolAlreadyInstalled(boolean silent, VersionIdentifier installedVersion, Step step, ProcessContext pc) {
    if (!silent) {
      this.context.info("Version {} of tool {} is already installed", installedVersion, getToolWithEdition());
    }
    postInstall(false, pc);
    step.success();
    return false;
  }

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

    return false;
  }

  /**
   * Performs the installation of the {@link #getName() tool} together with the environment context, managed by this
   * {@link com.devonfw.tools.ide.commandlet.Commandlet}.
   *
   * @param version the {@link GenericVersionRange} requested to be installed.
   * @param processContext the {@link ProcessContext} used to
   *     {@link #setEnvironment(EnvironmentContext, ToolInstallation, boolean) configure environment variables}.
   * @return the {@link ToolInstallation} matching the given {@code version}.
   */
  public ToolInstallation installTool(GenericVersionRange version, ProcessContext processContext) {

    return installTool(version, processContext, getConfiguredEdition());
  }

  /**
   * Performs the installation of the {@link #getName() tool} together with the environment context  managed by this
   * {@link com.devonfw.tools.ide.commandlet.Commandlet}.
   *
   * @param version the {@link GenericVersionRange} requested to be installed.
   * @param processContext the {@link ProcessContext} used to
   *     {@link #setEnvironment(EnvironmentContext, ToolInstallation, boolean) configure environment variables}.
   * @param edition the specific {@link #getConfiguredEdition() edition} to install.
   * @return the {@link ToolInstallation} matching the given {@code version}.
   */
  public ToolInstallation installTool(GenericVersionRange version, ProcessContext processContext, String edition) {

    // if version is a VersionRange, we are not called from install() but directly from installAsDependency() due to a version conflict of a dependency
    boolean extraInstallation = (version instanceof VersionRange);
    ToolRepository toolRepository = getToolRepository();
    VersionIdentifier resolvedVersion = toolRepository.resolveVersion(this.tool, edition, version, this);
    installToolDependencies(resolvedVersion, edition, processContext);

    Path installationPath;
    boolean ignoreSoftwareRepo = isIgnoreSoftwareRepo();
    if (ignoreSoftwareRepo) {
      installationPath = getToolPath();
    } else {
      Path softwareRepoPath = this.context.getSoftwareRepositoryPath().resolve(toolRepository.getId()).resolve(this.tool).resolve(edition);
      installationPath = softwareRepoPath.resolve(resolvedVersion.toString());
    }
    Path toolVersionFile = installationPath.resolve(IdeContext.FILE_SOFTWARE_VERSION);
    FileAccess fileAccess = this.context.getFileAccess();
    if (Files.isDirectory(installationPath)) {
      if (Files.exists(toolVersionFile)) {
        if (!ignoreSoftwareRepo || resolvedVersion.equals(getInstalledVersion())) {
          this.context.debug("Version {} of tool {} is already installed at {}", resolvedVersion, getToolWithEdition(this.tool, edition), installationPath);
          return createToolInstallation(installationPath, resolvedVersion, toolVersionFile, false, processContext, extraInstallation);
        }
      } else {
        // Makes sure that IDEasy will not delete itself
        if (this.tool.equals(IdeasyCommandlet.TOOL_NAME)) {
          this.context.warning("Your IDEasy installation is missing the version file at {}", toolVersionFile);
        } else {
          this.context.warning("Deleting corrupted installation at {}", installationPath);
          fileAccess.delete(installationPath);
        }
      }
    }
    Path downloadedToolFile = downloadTool(edition, toolRepository, resolvedVersion);
    boolean extract = isExtract();
    if (!extract) {
      this.context.trace("Extraction is disabled for '{}' hence just moving the downloaded file {}.", this.tool, downloadedToolFile);
    }
    if (Files.exists(installationPath)) {
      fileAccess.backup(installationPath);
    }
    fileAccess.mkdirs(installationPath.getParent());
    fileAccess.extract(downloadedToolFile, installationPath, this::postExtract, extract);
    this.context.writeVersionFile(resolvedVersion, installationPath);
    this.context.debug("Installed {} in version {} at {}", this.tool, resolvedVersion, installationPath);
    return createToolInstallation(installationPath, resolvedVersion, toolVersionFile, true, processContext, extraInstallation);
  }

  /**
   * @param edition the {@link #getConfiguredEdition() tool edition} to download.
   * @param toolRepository the {@link ToolRepository} to use.
   * @param resolvedVersion the resolved {@link VersionIdentifier version} to download.
   * @return the {@link Path} to the downloaded release file.
   */
  protected Path downloadTool(String edition, ToolRepository toolRepository, VersionIdentifier resolvedVersion) {
    return toolRepository.download(this.tool, edition, resolvedVersion, this);
  }

  /**
   * Install this tool as dependency of another tool.
   *
   * @param version the required {@link VersionRange}. See {@link ToolDependency#versionRange()}.
   * @param processContext the {@link ProcessContext}.
   * @param toolParent the parent tool name needing the dependency
   * @return {@code true} if the tool was newly installed, {@code false} otherwise (installation was already present).
   */
  public boolean installAsDependency(VersionRange version, ProcessContext processContext, String toolParent) {

    VersionIdentifier configuredVersion = getConfiguredVersion();
    if (version.contains(configuredVersion)) {
      // prefer configured version if contained in version range
      return install(false, processContext);
    } else {
      if (isIgnoreSoftwareRepo()) {
        throw new IllegalStateException(
            "Cannot satisfy dependency to " + this.tool + " in version " + version + " since it is conflicting with configured version " + configuredVersion
                + " and this tool does not support the software repository.");
      }
      this.context.info(
          "The tool {} requires {} in the version range {}, but your project uses version {}, which does not match."
              + " Therefore, we install a compatible version in that range.",
          toolParent, this.tool, version, configuredVersion);
    }
    ToolInstallation toolInstallation = installTool(version, processContext);
    return toolInstallation.newInstallation();
  }

  private void installToolDependencies(VersionIdentifier version, String edition, ProcessContext processContext) {
    Collection<ToolDependency> dependencies = getToolRepository().findDependencies(this.tool, edition, version);
    String toolWithEdition = getToolWithEdition(this.tool, edition);
    int size = dependencies.size();
    this.context.debug("Tool {} has {} other tool(s) as dependency", toolWithEdition, size);
    for (ToolDependency dependency : dependencies) {
      this.context.trace("Ensuring dependency {} for tool {}", dependency.tool(), toolWithEdition);
      LocalToolCommandlet dependencyTool = this.context.getCommandletManager().getRequiredLocalToolCommandlet(dependency.tool());
      dependencyTool.installAsDependency(dependency.versionRange(), processContext, toolWithEdition);
    }
  }

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

  }

  @Override
  public VersionIdentifier getInstalledVersion() {

    return getInstalledVersion(this.context.getSoftwarePath().resolve(getName()));
  }

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

    if (!Files.isDirectory(toolPath)) {
      this.context.debug("Tool {} not installed in {}", getName(), toolPath);
      return null;
    }
    Path toolVersionFile = toolPath.resolve(IdeContext.FILE_SOFTWARE_VERSION);
    if (!Files.exists(toolVersionFile)) {
      Path legacyToolVersionFile = toolPath.resolve(IdeContext.FILE_LEGACY_SOFTWARE_VERSION);
      if (Files.exists(legacyToolVersionFile)) {
        toolVersionFile = legacyToolVersionFile;
      } else {
        this.context.warning("Tool {} is missing version file in {}", getName(), toolVersionFile);
        return null;
      }
    }
    String version = this.context.getFileAccess().readFileContent(toolVersionFile).trim();
    return VersionIdentifier.of(version);
  }

  @Override
  public String getInstalledEdition() {

    if (this.context.getSoftwarePath() == null) {
      return "";
    }
    return getInstalledEdition(this.context.getSoftwarePath().resolve(this.tool));
  }

  /**
   * @param toolPath the installation {@link Path} where to find currently installed tool. The name of the parent directory of the real path corresponding
   *     to the passed {@link Path path} must be the name of the edition.
   * @return the installed edition of this tool or {@code null} if not installed.
   */
  private String getInstalledEdition(Path toolPath) {

    if (!Files.isDirectory(toolPath)) {
      this.context.debug("Tool {} not installed in {}", this.tool, toolPath);
      return null;
    }
    Path realPath = this.context.getFileAccess().toRealPath(toolPath);
    // if the realPath changed, a link has been resolved
    if (realPath.equals(toolPath)) {
      if (!isIgnoreSoftwareRepo()) {
        this.context.warning("Tool {} is not installed via software repository (maybe from devonfw-ide). Please consider reinstalling it.", this.tool);
      }
      // 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
      return getConfiguredEdition();
    }
    Path toolRepoFolder = context.getSoftwareRepositoryPath().resolve(ToolRepository.ID_DEFAULT).resolve(this.tool);
    String edition = getEdition(toolRepoFolder, realPath);
    if (!getToolRepository().getSortedEditions(this.tool).contains(edition)) {
      this.context.warning("Undefined edition {} of tool {}", edition, this.tool);
    }
    return edition;
  }

  private String getEdition(Path toolRepoFolder, Path toolInstallFolder) {

    int toolRepoNameCount = toolRepoFolder.getNameCount();
    int toolInstallNameCount = toolInstallFolder.getNameCount();
    if (toolRepoNameCount < toolInstallNameCount) {
      // ensure toolInstallFolder starts with $IDE_ROOT/_ide/software/default/«tool»
      for (int i = 0; i < toolRepoNameCount; i++) {
        if (!toolRepoFolder.getName(i).toString().equals(toolInstallFolder.getName(i).toString())) {
          return null;
        }
      }
      return toolInstallFolder.getName(toolRepoNameCount).toString();
    }
    return null;
  }

  @Override
  public void uninstall() {

    try {
      Path softwarePath = getToolPath();
      if (Files.exists(softwarePath)) {
        try {
          this.context.getFileAccess().delete(softwarePath);
          this.context.success("Successfully uninstalled " + this.tool);
        } catch (Exception e) {
          this.context.error("Couldn't uninstall " + this.tool);
        }
      } else {
        this.context.warning("An installed version of " + this.tool + " does not exist");
      }
    } catch (Exception e) {
      this.context.error(e.getMessage());
    }
  }

  private ToolInstallation createToolInstallation(Path rootDir, VersionIdentifier resolvedVersion, Path toolVersionFile,
      boolean newInstallation, EnvironmentContext environmentContext, boolean extraInstallation) {

    Path linkDir = getMacOsHelper().findLinkDir(rootDir, getBinaryName());
    Path binDir = linkDir;
    Path binFolder = binDir.resolve(IdeContext.FOLDER_BIN);
    if (Files.isDirectory(binFolder)) {
      binDir = binFolder;
    }
    if (linkDir != rootDir) {
      assert (!linkDir.equals(rootDir));
      this.context.getFileAccess().copy(toolVersionFile, linkDir, FileCopyMode.COPY_FILE_OVERRIDE);
    }
    ToolInstallation toolInstallation = new ToolInstallation(rootDir, linkDir, binDir, resolvedVersion, newInstallation);
    setEnvironment(environmentContext, toolInstallation, extraInstallation);
    return toolInstallation;
  }

  /**
   * Method to set environment variables for the process context.
   *
   * @param environmentContext the {@link EnvironmentContext} where to {@link EnvironmentContext#withEnvVar(String, String) set environment variables} for
   *     this tool.
   * @param toolInstallation the {@link ToolInstallation}.
   * @param extraInstallation {@code true} if the {@link ToolInstallation} is an additional installation to the
   *     {@link #getConfiguredVersion() configured version} due to a conflicting version of a {@link ToolDependency}, {@code false} otherwise.
   */
  public void setEnvironment(EnvironmentContext environmentContext, ToolInstallation toolInstallation, boolean extraInstallation) {

    String pathVariable = EnvironmentVariables.getToolVariablePrefix(this.tool) + "_HOME";
    environmentContext.withEnvVar(pathVariable, toolInstallation.linkDir().toString());
    if (extraInstallation) {
      environmentContext.withPathEntry(toolInstallation.binDir());
    }
  }

  /**
   * @return {@link VersionIdentifier} with latest version of the tool}.
   */
  public VersionIdentifier getLatestToolVersion() {

    return this.context.getDefaultToolRepository().resolveVersion(this.tool, getConfiguredEdition(), VersionIdentifier.LATEST, this);
  }


}

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 com.devonfw.tools.ide.common.Tag;
10	import com.devonfw.tools.ide.context.IdeContext;
11	import com.devonfw.tools.ide.environment.EnvironmentVariables;
12	import com.devonfw.tools.ide.io.FileAccess;
13	import com.devonfw.tools.ide.io.FileCopyMode;
14	import com.devonfw.tools.ide.process.EnvironmentContext;
15	import com.devonfw.tools.ide.process.ProcessContext;
16	import com.devonfw.tools.ide.step.Step;
17	import com.devonfw.tools.ide.tool.repository.ToolRepository;
18	import com.devonfw.tools.ide.url.model.file.json.ToolDependency;
19	import com.devonfw.tools.ide.version.GenericVersionRange;
20	import com.devonfw.tools.ide.version.VersionIdentifier;
21	import com.devonfw.tools.ide.version.VersionRange;
22
23	/**
24	* {@link ToolCommandlet} that is installed locally into the IDEasy.
25	*/
26	public abstract class LocalToolCommandlet extends ToolCommandlet {	1✔
27
28	/**
29	* The constructor.
30	*
31	* @param context the {@link IdeContext}.
32	* @param tool the {@link #getName() tool name}.
33	* @param tags the {@link #getTags() tags} classifying the tool. Should be created via {@link Set#of(Object) Set.of} method.
34	*/
35	public LocalToolCommandlet(IdeContext context, String tool, Set<Tag> tags) {
36
37	super(context, tool, tags);	5✔
38	}	1✔
39
40	/**
41	* @return the {@link Path} where the tool is located (installed).
42	*/
43	public Path getToolPath() {
44
45	return this.context.getSoftwarePath().resolve(getName());	7✔
46	}
47
48	/**
49	* @return the {@link Path} where the executables of the tool can be found. Typically a "bin" folder inside {@link #getToolPath() tool path}.
50	*/
51	public Path getToolBinPath() {
52
53	Path toolPath = getToolPath();	3✔
54	Path binPath = this.context.getFileAccess().findFirst(toolPath, path -> path.getFileName().toString().equals("bin"), false);	14✔
55	if ((binPath != null) && Files.isDirectory(binPath)) {	7!
56	return binPath;	2✔
57	}
58	return toolPath;	2✔
59	}
60
61	/**
62	* @deprecated will be removed once all "dependencies.json" are created in ide-urls.
63	*/
64	@Deprecated
65	protected void installDependencies() {
66
67	}	1✔
68
69	@Override
70	public boolean install(boolean silent, ProcessContext processContext) {
71
72	installDependencies();	2✔
73	VersionIdentifier configuredVersion = getConfiguredVersion();	3✔
74	// get installed version before installInRepo actually may install the software
75	VersionIdentifier installedVersion = getInstalledVersion();	3✔
76	Step step = this.context.newStep(silent, "Install " + this.tool, configuredVersion);	14✔
77	try {
78	// install configured version of our tool in the software repository if not already installed
79	ToolInstallation installation = installTool(configuredVersion, processContext);	5✔
80
81	// check if we already have this version installed (linked) locally in IDE_HOME/software
82	VersionIdentifier resolvedVersion = installation.resolvedVersion();	3✔
83	if ((resolvedVersion.equals(installedVersion) && !installation.newInstallation())	9✔
84	\|\| (configuredVersion.matches(installedVersion) && context.isSkipUpdatesMode())) {	6!
85	return toolAlreadyInstalled(silent, installedVersion, step, processContext);	9✔
86	}
87	if (!isIgnoreSoftwareRepo()) {	3✔
88	// we need to link the version or update the link.
89	Path toolPath = getToolPath();	3✔
90	FileAccess fileAccess = this.context.getFileAccess();	4✔
91	if (Files.exists(toolPath, LinkOption.NOFOLLOW_LINKS)) {	9✔
92	fileAccess.backup(toolPath);	4✔
93	}
94	fileAccess.mkdirs(toolPath.getParent());	4✔
95	fileAccess.symlink(installation.linkDir(), toolPath);	5✔
96	}
97	this.context.getPath().setPath(this.tool, installation.binDir());	8✔
98	postInstall(true, processContext);	4✔
99	if (installedVersion == null) {	2✔
100	step.success("Successfully installed {} in version {}", this.tool, resolvedVersion);	15✔
101	} else {
102	step.success("Successfully installed {} in version {} replacing previous version {}", this.tool, resolvedVersion, installedVersion);	18✔
103	}
104	return true;	4✔
105	} catch (RuntimeException e) {	1✔
106	step.error(e, true);	4✔
107	throw e;	2✔
108	} finally {
109	step.close();	2✔
110	}
111
112	}
113
114	/**
115	* This method is called after a tool was requested to be installed or updated.
116	*
117	* @param newlyInstalled {@code true} if the tool was installed or updated (at least link to software folder was created/updated), {@code false} otherwise
118	* (configured version was already installed and nothing changed).
119	* @param pc the {@link ProcessContext} to use.
120	*/
121	protected void postInstall(boolean newlyInstalled, ProcessContext pc) {
122
123	if (newlyInstalled) {	2✔
124	postInstall();	2✔
125	}
126	}	1✔
127
128	/**
129	* This method is called after the tool has been newly installed or updated to a new version.
130	*/
131	protected void postInstall() {
132
133	// nothing to do by default
134	}	1✔
135
136	private boolean toolAlreadyInstalled(boolean silent, VersionIdentifier installedVersion, Step step, ProcessContext pc) {
137	if (!silent) {	2✔
138	this.context.info("Version {} of tool {} is already installed", installedVersion, getToolWithEdition());	15✔
139	}
140	postInstall(false, pc);	4✔
141	step.success();	2✔
142	return false;	2✔
143	}
144
145	/**
146	* Determines whether this tool should be installed directly in the software folder or in the software repository.
147	*
148	* @return {@code true} if the tool should be installed directly in the software folder, ignoring the central software repository; {@code false} if the tool
149	* should be installed in the central software repository (default behavior).
150	*/
151	protected boolean isIgnoreSoftwareRepo() {
152
153	return false;	2✔
154	}
155
156	/**
157	* Performs the installation of the {@link #getName() tool} together with the environment context, managed by this
158	* {@link com.devonfw.tools.ide.commandlet.Commandlet}.
159	*
160	* @param version the {@link GenericVersionRange} requested to be installed.
161	* @param processContext the {@link ProcessContext} used to
162	* {@link #setEnvironment(EnvironmentContext, ToolInstallation, boolean) configure environment variables}.
163	* @return the {@link ToolInstallation} matching the given {@code version}.
164	*/
165	public ToolInstallation installTool(GenericVersionRange version, ProcessContext processContext) {
166
167	return installTool(version, processContext, getConfiguredEdition());	7✔
168	}
169
170	/**
171	* Performs the installation of the {@link #getName() tool} together with the environment context managed by this
172	* {@link com.devonfw.tools.ide.commandlet.Commandlet}.
173	*
174	* @param version the {@link GenericVersionRange} requested to be installed.
175	* @param processContext the {@link ProcessContext} used to
176	* {@link #setEnvironment(EnvironmentContext, ToolInstallation, boolean) configure environment variables}.
177	* @param edition the specific {@link #getConfiguredEdition() edition} to install.
178	* @return the {@link ToolInstallation} matching the given {@code version}.
179	*/
180	public ToolInstallation installTool(GenericVersionRange version, ProcessContext processContext, String edition) {
181
182	// if version is a VersionRange, we are not called from install() but directly from installAsDependency() due to a version conflict of a dependency
183	boolean extraInstallation = (version instanceof VersionRange);	3✔
184	ToolRepository toolRepository = getToolRepository();	3✔
185	VersionIdentifier resolvedVersion = toolRepository.resolveVersion(this.tool, edition, version, this);	8✔
186	installToolDependencies(resolvedVersion, edition, processContext);	5✔
187
188	Path installationPath;
189	boolean ignoreSoftwareRepo = isIgnoreSoftwareRepo();	3✔
190	if (ignoreSoftwareRepo) {	2✔
191	installationPath = getToolPath();	4✔
192	} else {
193	Path softwareRepoPath = this.context.getSoftwareRepositoryPath().resolve(toolRepository.getId()).resolve(this.tool).resolve(edition);	12✔
194	installationPath = softwareRepoPath.resolve(resolvedVersion.toString());	5✔
195	}
196	Path toolVersionFile = installationPath.resolve(IdeContext.FILE_SOFTWARE_VERSION);	4✔
197	FileAccess fileAccess = this.context.getFileAccess();	4✔
198	if (Files.isDirectory(installationPath)) {	5✔
199	if (Files.exists(toolVersionFile)) {	5!
200	if (!ignoreSoftwareRepo \|\| resolvedVersion.equals(getInstalledVersion())) {	2!
201	this.context.debug("Version {} of tool {} is already installed at {}", resolvedVersion, getToolWithEdition(this.tool, edition), installationPath);	21✔
202	return createToolInstallation(installationPath, resolvedVersion, toolVersionFile, false, processContext, extraInstallation);	9✔
203	}
204	} else {
205	// Makes sure that IDEasy will not delete itself
206	if (this.tool.equals(IdeasyCommandlet.TOOL_NAME)) {	×
207	this.context.warning("Your IDEasy installation is missing the version file at {}", toolVersionFile);	×
208	} else {
209	this.context.warning("Deleting corrupted installation at {}", installationPath);	×
210	fileAccess.delete(installationPath);	×
211	}
212	}
213	}
214	Path downloadedToolFile = downloadTool(edition, toolRepository, resolvedVersion);	6✔
215	boolean extract = isExtract();	3✔
216	if (!extract) {	2✔
217	this.context.trace("Extraction is disabled for '{}' hence just moving the downloaded file {}.", this.tool, downloadedToolFile);	15✔
218	}
219	if (Files.exists(installationPath)) {	5!
220	fileAccess.backup(installationPath);	×
221	}
222	fileAccess.mkdirs(installationPath.getParent());	4✔
223	fileAccess.extract(downloadedToolFile, installationPath, this::postExtract, extract);	7✔
224	this.context.writeVersionFile(resolvedVersion, installationPath);	5✔
225	this.context.debug("Installed {} in version {} at {}", this.tool, resolvedVersion, installationPath);	19✔
226	return createToolInstallation(installationPath, resolvedVersion, toolVersionFile, true, processContext, extraInstallation);	9✔
227	}
228
229	/**
230	* @param edition the {@link #getConfiguredEdition() tool edition} to download.
231	* @param toolRepository the {@link ToolRepository} to use.
232	* @param resolvedVersion the resolved {@link VersionIdentifier version} to download.
233	* @return the {@link Path} to the downloaded release file.
234	*/
235	protected Path downloadTool(String edition, ToolRepository toolRepository, VersionIdentifier resolvedVersion) {
236	return toolRepository.download(this.tool, edition, resolvedVersion, this);	8✔
237	}
238
239	/**
240	* Install this tool as dependency of another tool.
241	*
242	* @param version the required {@link VersionRange}. See {@link ToolDependency#versionRange()}.
243	* @param processContext the {@link ProcessContext}.
244	* @param toolParent the parent tool name needing the dependency
245	* @return {@code true} if the tool was newly installed, {@code false} otherwise (installation was already present).
246	*/
247	public boolean installAsDependency(VersionRange version, ProcessContext processContext, String toolParent) {
248
249	VersionIdentifier configuredVersion = getConfiguredVersion();	3✔
250	if (version.contains(configuredVersion)) {	4✔
251	// prefer configured version if contained in version range
252	return install(false, processContext);	5✔
253	} else {
254	if (isIgnoreSoftwareRepo()) {	3!
255	throw new IllegalStateException(	×
256	"Cannot satisfy dependency to " + this.tool + " in version " + version + " since it is conflicting with configured version " + configuredVersion
257	+ " and this tool does not support the software repository.");
258	}
259	this.context.info(	23✔
260	"The tool {} requires {} in the version range {}, but your project uses version {}, which does not match."
261	+ " Therefore, we install a compatible version in that range.",
262	toolParent, this.tool, version, configuredVersion);
263	}
264	ToolInstallation toolInstallation = installTool(version, processContext);	5✔
265	return toolInstallation.newInstallation();	3✔
266	}
267
268	private void installToolDependencies(VersionIdentifier version, String edition, ProcessContext processContext) {
269	Collection<ToolDependency> dependencies = getToolRepository().findDependencies(this.tool, edition, version);	8✔
270	String toolWithEdition = getToolWithEdition(this.tool, edition);	5✔
271	int size = dependencies.size();	3✔
272	this.context.debug("Tool {} has {} other tool(s) as dependency", toolWithEdition, size);	15✔
273	for (ToolDependency dependency : dependencies) {	10✔
274	this.context.trace("Ensuring dependency {} for tool {}", dependency.tool(), toolWithEdition);	15✔
275	LocalToolCommandlet dependencyTool = this.context.getCommandletManager().getRequiredLocalToolCommandlet(dependency.tool());	7✔
276	dependencyTool.installAsDependency(dependency.versionRange(), processContext, toolWithEdition);	7✔
277	}	1✔
278	}	1✔
279
280	/**
281	* Post-extraction hook that can be overridden to add custom processing after unpacking and before moving to the final destination folder.
282	*
283	* @param extractedDir the {@link Path} to the folder with the unpacked tool.
284	*/
285	protected void postExtract(Path extractedDir) {
286
287	}	1✔
288
289	@Override
290	public VersionIdentifier getInstalledVersion() {
291
292	return getInstalledVersion(this.context.getSoftwarePath().resolve(getName()));	9✔
293	}
294
295	/**
296	* @param toolPath the installation {@link Path} where to find the version file.
297	* @return the currently installed {@link VersionIdentifier version} of this tool or {@code null} if not installed.
298	*/
299	protected VersionIdentifier getInstalledVersion(Path toolPath) {
300
301	if (!Files.isDirectory(toolPath)) {	5✔
302	this.context.debug("Tool {} not installed in {}", getName(), toolPath);	15✔
303	return null;	2✔
304	}
305	Path toolVersionFile = toolPath.resolve(IdeContext.FILE_SOFTWARE_VERSION);	4✔
306	if (!Files.exists(toolVersionFile)) {	5✔
307	Path legacyToolVersionFile = toolPath.resolve(IdeContext.FILE_LEGACY_SOFTWARE_VERSION);	4✔
308	if (Files.exists(legacyToolVersionFile)) {	5✔
309	toolVersionFile = legacyToolVersionFile;	3✔
310	} else {
311	this.context.warning("Tool {} is missing version file in {}", getName(), toolVersionFile);	15✔
312	return null;	2✔
313	}
314	}
315	String version = this.context.getFileAccess().readFileContent(toolVersionFile).trim();	7✔
316	return VersionIdentifier.of(version);	3✔
317	}
318
319	@Override
320	public String getInstalledEdition() {
321
322	if (this.context.getSoftwarePath() == null) {	4!
323	return "";	×
324	}
325	return getInstalledEdition(this.context.getSoftwarePath().resolve(this.tool));	9✔
326	}
327
328	/**
329	* @param toolPath the installation {@link Path} where to find currently installed tool. The name of the parent directory of the real path corresponding
330	* to the passed {@link Path path} must be the name of the edition.
331	* @return the installed edition of this tool or {@code null} if not installed.
332	*/
333	private String getInstalledEdition(Path toolPath) {
334
335	if (!Files.isDirectory(toolPath)) {	5✔
336	this.context.debug("Tool {} not installed in {}", this.tool, toolPath);	15✔
337	return null;	2✔
338	}
339	Path realPath = this.context.getFileAccess().toRealPath(toolPath);	6✔
340	// if the realPath changed, a link has been resolved
341	if (realPath.equals(toolPath)) {	4✔
342	if (!isIgnoreSoftwareRepo()) {	3!
343	this.context.warning("Tool {} is not installed via software repository (maybe from devonfw-ide). Please consider reinstalling it.", this.tool);	11✔
344	}
345	// 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
346	return getConfiguredEdition();	3✔
347	}
348	Path toolRepoFolder = context.getSoftwareRepositoryPath().resolve(ToolRepository.ID_DEFAULT).resolve(this.tool);	9✔
349	String edition = getEdition(toolRepoFolder, realPath);	5✔
350	if (!getToolRepository().getSortedEditions(this.tool).contains(edition)) {	8✔
351	this.context.warning("Undefined edition {} of tool {}", edition, this.tool);	15✔
352	}
353	return edition;	2✔
354	}
355
356	private String getEdition(Path toolRepoFolder, Path toolInstallFolder) {
357
358	int toolRepoNameCount = toolRepoFolder.getNameCount();	3✔
359	int toolInstallNameCount = toolInstallFolder.getNameCount();	3✔
360	if (toolRepoNameCount < toolInstallNameCount) {	3!
361	// ensure toolInstallFolder starts with $IDE_ROOT/_ide/software/default/«tool»
362	for (int i = 0; i < toolRepoNameCount; i++) {	7✔
363	if (!toolRepoFolder.getName(i).toString().equals(toolInstallFolder.getName(i).toString())) {	10!
364	return null;	×
365	}
366	}
367	return toolInstallFolder.getName(toolRepoNameCount).toString();	5✔
368	}
369	return null;	×
370	}
371
372	@Override
373	public void uninstall() {
374
375	try {
376	Path softwarePath = getToolPath();	3✔
377	if (Files.exists(softwarePath)) {	5!
378	try {
379	this.context.getFileAccess().delete(softwarePath);	5✔
380	this.context.success("Successfully uninstalled " + this.tool);	6✔
381	} catch (Exception e) {	×
382	this.context.error("Couldn't uninstall " + this.tool);	×
383	}	1✔
384	} else {
385	this.context.warning("An installed version of " + this.tool + " does not exist");	×
386	}
387	} catch (Exception e) {	×
388	this.context.error(e.getMessage());	×
389	}	1✔
390	}	1✔
391
392	private ToolInstallation createToolInstallation(Path rootDir, VersionIdentifier resolvedVersion, Path toolVersionFile,
393	boolean newInstallation, EnvironmentContext environmentContext, boolean extraInstallation) {
394
395	Path linkDir = getMacOsHelper().findLinkDir(rootDir, getBinaryName());	7✔
396	Path binDir = linkDir;	2✔
397	Path binFolder = binDir.resolve(IdeContext.FOLDER_BIN);	4✔
398	if (Files.isDirectory(binFolder)) {	5✔
399	binDir = binFolder;	2✔
400	}
401	if (linkDir != rootDir) {	3✔
402	assert (!linkDir.equals(rootDir));	5!
403	this.context.getFileAccess().copy(toolVersionFile, linkDir, FileCopyMode.COPY_FILE_OVERRIDE);	7✔
404	}
405	ToolInstallation toolInstallation = new ToolInstallation(rootDir, linkDir, binDir, resolvedVersion, newInstallation);	9✔
406	setEnvironment(environmentContext, toolInstallation, extraInstallation);	5✔
407	return toolInstallation;	2✔
408	}
409
410	/**
411	* Method to set environment variables for the process context.
412	*
413	* @param environmentContext the {@link EnvironmentContext} where to {@link EnvironmentContext#withEnvVar(String, String) set environment variables} for
414	* this tool.
415	* @param toolInstallation the {@link ToolInstallation}.
416	* @param extraInstallation {@code true} if the {@link ToolInstallation} is an additional installation to the
417	* {@link #getConfiguredVersion() configured version} due to a conflicting version of a {@link ToolDependency}, {@code false} otherwise.
418	*/
419	public void setEnvironment(EnvironmentContext environmentContext, ToolInstallation toolInstallation, boolean extraInstallation) {
420
421	String pathVariable = EnvironmentVariables.getToolVariablePrefix(this.tool) + "_HOME";	5✔
422	environmentContext.withEnvVar(pathVariable, toolInstallation.linkDir().toString());	7✔
423	if (extraInstallation) {	2✔
424	environmentContext.withPathEntry(toolInstallation.binDir());	5✔
425	}
426	}	1✔
427
428	/**
429	* @return {@link VersionIdentifier} with latest version of the tool}.
430	*/
431	public VersionIdentifier getLatestToolVersion() {
432
433	return this.context.getDefaultToolRepository().resolveVersion(this.tool, getConfiguredEdition(), VersionIdentifier.LATEST, this);	×
434	}
435
436
437	}

devonfw / IDEasy / 14971720032

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

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