11970498949

Committed 22 Nov 2024 10:05AM UTC coverage: 67.435% (-0.007%) from 67.442%

Build # 11970498949

Build Type

push

github

Committed by

web-flow

Commit Message

#637: Option to disable updates (#765)

Run Details

2491 of 4036 branches covered (61.72%)

Branch coverage included in aggregate %.

6467 of 9248 relevant lines covered (69.93%)

3.09 hits per line

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

86.11

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

package com.devonfw.tools.ide.tool;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.StandardOpenOption;
import java.util.Collection;
import java.util.Locale;
import java.util.Set;

import com.devonfw.tools.ide.common.Tag;
import com.devonfw.tools.ide.context.IdeContext;
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.repo.ToolRepository;
import com.devonfw.tools.ide.step.Step;
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 final boolean install(boolean silent, EnvironmentContext environmentContext) {

    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, environmentContext);

      // 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);
      }
      if (!isIgnoreSoftwareRepo()) {
        // we need to link the version or update the link.
        Path toolPath = getToolPath();
        FileAccess fileAccess = this.context.getFileAccess();
        if (Files.exists(toolPath)) {
          fileAccess.backup(toolPath);
        }
        fileAccess.mkdirs(toolPath.getParent());
        fileAccess.symlink(installation.linkDir(), toolPath);
      }
      this.context.getPath().setPath(this.tool, installation.binDir());
      postInstall(true);
      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).
   */
  protected void postInstall(boolean newlyInstalled) {

    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) {
    if (!silent) {
      this.context.info("Version {} of tool {} is already installed", installedVersion, getToolWithEdition());
    }
    postInstall(false);
    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 environmentContext the {@link EnvironmentContext} used to
   *     {@link #setEnvironment(EnvironmentContext, ToolInstallation, boolean) configure environment variables}.
   * @return the {@link ToolInstallation} matching the given {@code version}.
   */
  public ToolInstallation installTool(GenericVersionRange version, EnvironmentContext environmentContext) {

    return installTool(version, environmentContext, 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 environmentContext the {@link EnvironmentContext} 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, EnvironmentContext environmentContext, String edition) {

    return installTool(version, environmentContext, edition, this.context.getDefaultToolRepository());
  }

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

    // 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);
    VersionIdentifier resolvedVersion = toolRepository.resolveVersion(this.tool, edition, version);
    installToolDependencies(resolvedVersion, edition, environmentContext, toolRepository);

    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, environmentContext, extraInstallation);
        }
      } else {
        this.context.warning("Deleting corrupted installation at {}", installationPath);
        fileAccess.delete(installationPath);
      }
    }
    Path target = toolRepository.download(this.tool, edition, resolvedVersion);
    boolean extract = isExtract();
    if (!extract) {
      this.context.trace("Extraction is disabled for '{}' hence just moving the downloaded file {}.", this.tool, target);
    }
    if (Files.exists(installationPath)) {
      fileAccess.backup(installationPath);
    }
    fileAccess.mkdirs(installationPath.getParent());
    fileAccess.extract(target, installationPath, this::postExtract, extract);
    try {
      Files.writeString(toolVersionFile, resolvedVersion.toString(), StandardOpenOption.CREATE_NEW);
    } catch (IOException e) {
      throw new IllegalStateException("Failed to write version file " + toolVersionFile, e);
    }
    this.context.debug("Installed {} in version {} at {}", this.tool, resolvedVersion, installationPath);
    return createToolInstallation(installationPath, resolvedVersion, toolVersionFile, true, environmentContext, extraInstallation);
  }

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

    VersionIdentifier configuredVersion = getConfiguredVersion();
    if (version.contains(configuredVersion)) {
      // prefer configured version if contained in version range
      return install(false, environmentContext);
    } 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(
          "Configured version of tool {} is {} but does not match version to install {} - need to use different version from software repository.",
          this.tool, configuredVersion, version);
    }
    ToolInstallation toolInstallation = installTool(version, environmentContext);
    return toolInstallation.newInstallation();
  }

  private void installToolDependencies(VersionIdentifier version, String edition, EnvironmentContext environmentContext, ToolRepository toolRepository) {
    Collection<ToolDependency> dependencies = toolRepository.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(), environmentContext);
    }
  }

  /**
   * 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;
      }
    }
    this.context.trace("Reading tool version from {}", toolVersionFile);
    try {
      String version = Files.readString(toolVersionFile).trim();
      this.context.trace("Read tool version {} from {}", version, toolVersionFile);
      return VersionIdentifier.of(version);
    } catch (IOException e) {
      throw new IllegalStateException("Failed to read file " + toolVersionFile, e);
    }
  }

  @Override
  public String getInstalledEdition() {

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

  /**
   * @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.
   */
  public String getInstalledEdition(Path toolPath) {

    if (!Files.isDirectory(toolPath)) {
      this.context.debug("Tool {} not installed in {}", getName(), toolPath);
      return null;
    }
    try {
      String edition = toolPath.toRealPath().getParent().getFileName().toString();
      if (!this.context.getUrls().getSortedEditions(getName()).contains(edition)) {
        edition = getConfiguredEdition();
      }
      return edition;
    } catch (IOException e) {
      throw new IllegalStateException(
          "Couldn't determine the edition of " + getName() + " from the directory structure of its software path "
              + toolPath
              + ", assuming the name of the parent directory of the real path of the software path to be the edition "
              + "of the tool.", e);
    }
  }

  @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.
   */
  protected void setEnvironment(EnvironmentContext environmentContext, ToolInstallation toolInstallation, boolean extraInstallation) {

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

}

1	package com.devonfw.tools.ide.tool;
2
3	import java.io.IOException;
4	import java.nio.file.Files;
5	import java.nio.file.Path;
6	import java.nio.file.StandardOpenOption;
7	import java.util.Collection;
8	import java.util.Locale;
9	import java.util.Set;
10
11	import com.devonfw.tools.ide.common.Tag;
12	import com.devonfw.tools.ide.context.IdeContext;
13	import com.devonfw.tools.ide.io.FileAccess;
14	import com.devonfw.tools.ide.io.FileCopyMode;
15	import com.devonfw.tools.ide.process.EnvironmentContext;
16	import com.devonfw.tools.ide.repo.ToolRepository;
17	import com.devonfw.tools.ide.step.Step;
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 final boolean install(boolean silent, EnvironmentContext environmentContext) {
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, environmentContext);	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())) {	2!
85	return toolAlreadyInstalled(silent, installedVersion, step);	8✔
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)) {	5✔
92	fileAccess.backup(toolPath);	3✔
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);	3✔
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);	×
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	*/
120	protected void postInstall(boolean newlyInstalled) {
121
122	if (newlyInstalled) {	2✔
123	postInstall();	2✔
124	}
125	}	1✔
126
127	/**
128	* This method is called after the tool has been newly installed or updated to a new version.
129	*/
130	protected void postInstall() {
131
132	// nothing to do by default
133	}	1✔
134
135	private boolean toolAlreadyInstalled(boolean silent, VersionIdentifier installedVersion, Step step) {
136	if (!silent) {	2✔
137	this.context.info("Version {} of tool {} is already installed", installedVersion, getToolWithEdition());	15✔
138	}
139	postInstall(false);	3✔
140	step.success();	2✔
141	return false;	2✔
142	}
143
144	/**
145	* Determines whether this tool should be installed directly in the software folder or in the software repository.
146	*
147	* @return {@code true} if the tool should be installed directly in the software folder, ignoring the central software repository; {@code false} if the tool
148	* should be installed in the central software repository (default behavior).
149	*/
150	protected boolean isIgnoreSoftwareRepo() {
151
152	return false;	2✔
153	}
154
155	/**
156	* Performs the installation of the {@link #getName() tool} together with the environment context, managed by this
157	* {@link com.devonfw.tools.ide.commandlet.Commandlet}.
158	*
159	* @param version the {@link GenericVersionRange} requested to be installed.
160	* @param environmentContext the {@link EnvironmentContext} used to
161	* {@link #setEnvironment(EnvironmentContext, ToolInstallation, boolean) configure environment variables}.
162	* @return the {@link ToolInstallation} matching the given {@code version}.
163	*/
164	public ToolInstallation installTool(GenericVersionRange version, EnvironmentContext environmentContext) {
165
166	return installTool(version, environmentContext, getConfiguredEdition());	7✔
167	}
168
169	/**
170	* Performs the installation of the {@link #getName() tool} together with the environment context managed by this
171	* {@link com.devonfw.tools.ide.commandlet.Commandlet}.
172	*
173	* @param version the {@link GenericVersionRange} requested to be installed.
174	* @param environmentContext the {@link EnvironmentContext} used to
175	* {@link #setEnvironment(EnvironmentContext, ToolInstallation, boolean) configure environment variables}.
176	* @param edition the specific {@link #getConfiguredEdition() edition} to install.
177	* @return the {@link ToolInstallation} matching the given {@code version}.
178	*/
179	public ToolInstallation installTool(GenericVersionRange version, EnvironmentContext environmentContext, String edition) {
180
181	return installTool(version, environmentContext, edition, this.context.getDefaultToolRepository());	9✔
182	}
183
184	/**
185	* Performs the installation of the {@link #getName() tool} managed by this {@link com.devonfw.tools.ide.commandlet.Commandlet}.
186	*
187	* @param version the {@link GenericVersionRange} requested to be installed.
188	* @param environmentContext the {@link EnvironmentContext} used to
189	* {@link #setEnvironment(EnvironmentContext, ToolInstallation, boolean) configure environment variables}.
190	* @param edition the specific {@link #getConfiguredEdition() edition} to install.
191	* @param toolRepository the {@link ToolRepository} to use.
192	* @return the {@link ToolInstallation} matching the given {@code version}.
193	*/
194	public ToolInstallation installTool(GenericVersionRange version, EnvironmentContext environmentContext, String edition, ToolRepository toolRepository) {
195
196	// if version is a VersionRange, we are not called from install() but directly from installAsDependency() due to a version conflict of a dependency
197	boolean extraInstallation = (version instanceof VersionRange);	3✔
198	VersionIdentifier resolvedVersion = toolRepository.resolveVersion(this.tool, edition, version);	7✔
199	installToolDependencies(resolvedVersion, edition, environmentContext, toolRepository);	6✔
200
201	Path installationPath;
202	boolean ignoreSoftwareRepo = isIgnoreSoftwareRepo();	3✔
203	if (ignoreSoftwareRepo) {	2✔
204	installationPath = getToolPath();	4✔
205	} else {
206	Path softwareRepoPath = this.context.getSoftwareRepositoryPath().resolve(toolRepository.getId()).resolve(this.tool).resolve(edition);	12✔
207	installationPath = softwareRepoPath.resolve(resolvedVersion.toString());	5✔
208	}
209	Path toolVersionFile = installationPath.resolve(IdeContext.FILE_SOFTWARE_VERSION);	4✔
210	FileAccess fileAccess = this.context.getFileAccess();	4✔
211	if (Files.isDirectory(installationPath)) {	5✔
212	if (Files.exists(toolVersionFile)) {	5!
213	if (!ignoreSoftwareRepo \|\| resolvedVersion.equals(getInstalledVersion())) {	2!
214	this.context.debug("Version {} of tool {} is already installed at {}", resolvedVersion, getToolWithEdition(this.tool, edition), installationPath);	21✔
215	return createToolInstallation(installationPath, resolvedVersion, toolVersionFile, false, environmentContext, extraInstallation);	9✔
216	}
217	} else {
218	this.context.warning("Deleting corrupted installation at {}", installationPath);	×
219	fileAccess.delete(installationPath);	×
220	}
221	}
222	Path target = toolRepository.download(this.tool, edition, resolvedVersion);	7✔
223	boolean extract = isExtract();	3✔
224	if (!extract) {	2✔
225	this.context.trace("Extraction is disabled for '{}' hence just moving the downloaded file {}.", this.tool, target);	15✔
226	}
227	if (Files.exists(installationPath)) {	5!
228	fileAccess.backup(installationPath);	×
229	}
230	fileAccess.mkdirs(installationPath.getParent());	4✔
231	fileAccess.extract(target, installationPath, this::postExtract, extract);	7✔
232	try {
233	Files.writeString(toolVersionFile, resolvedVersion.toString(), StandardOpenOption.CREATE_NEW);	11✔
234	} catch (IOException e) {	×
235	throw new IllegalStateException("Failed to write version file " + toolVersionFile, e);	×
236	}	1✔
237	this.context.debug("Installed {} in version {} at {}", this.tool, resolvedVersion, installationPath);	19✔
238	return createToolInstallation(installationPath, resolvedVersion, toolVersionFile, true, environmentContext, extraInstallation);	9✔
239	}
240
241	/**
242	* Install this tool as dependency of another tool.
243	*
244	* @param version the required {@link VersionRange}. See {@link ToolDependency#versionRange()}.
245	* @param environmentContext the {@link EnvironmentContext}.
246	* @return {@code true} if the tool was newly installed, {@code false} otherwise (installation was already present).
247	*/
248	public boolean installAsDependency(VersionRange version, EnvironmentContext environmentContext) {
249
250	VersionIdentifier configuredVersion = getConfiguredVersion();	3✔
251	if (version.contains(configuredVersion)) {	4!
252	// prefer configured version if contained in version range
253	return install(false, environmentContext);	×
254	} else {
255	if (isIgnoreSoftwareRepo()) {	3!
256	throw new IllegalStateException(	×
257	"Cannot satisfy dependency to " + this.tool + " in version " + version + " since it is conflicting with configured version " + configuredVersion
258	+ " and this tool does not support the software repository.");
259	}
260	this.context.info(	19✔
261	"Configured version of tool {} is {} but does not match version to install {} - need to use different version from software repository.",
262	this.tool, configuredVersion, version);
263	}
264	ToolInstallation toolInstallation = installTool(version, environmentContext);	5✔
265	return toolInstallation.newInstallation();	3✔
266	}
267
268	private void installToolDependencies(VersionIdentifier version, String edition, EnvironmentContext environmentContext, ToolRepository toolRepository) {
269	Collection<ToolDependency> dependencies = toolRepository.findDependencies(this.tool, edition, version);	7✔
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(), environmentContext);	6✔
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	this.context.trace("Reading tool version from {}", toolVersionFile);	10✔
316	try {
317	String version = Files.readString(toolVersionFile).trim();	4✔
318	this.context.trace("Read tool version {} from {}", version, toolVersionFile);	14✔
319	return VersionIdentifier.of(version);	3✔
320	} catch (IOException e) {	×
321	throw new IllegalStateException("Failed to read file " + toolVersionFile, e);	×
322	}
323	}
324
325	@Override
326	public String getInstalledEdition() {
327
328	return getInstalledEdition(this.context.getSoftwarePath().resolve(getName()));	9✔
329	}
330
331	/**
332	* @param toolPath the installation {@link Path} where to find currently installed tool. The name of the parent directory of the real path corresponding
333	* to the passed {@link Path path} must be the name of the edition.
334	* @return the installed edition of this tool or {@code null} if not installed.
335	*/
336	public String getInstalledEdition(Path toolPath) {
337
338	if (!Files.isDirectory(toolPath)) {	5✔
339	this.context.debug("Tool {} not installed in {}", getName(), toolPath);	15✔
340	return null;	2✔
341	}
342	try {
343	String edition = toolPath.toRealPath().getParent().getFileName().toString();	8✔
344	if (!this.context.getUrls().getSortedEditions(getName()).contains(edition)) {	9!
345	edition = getConfiguredEdition();	3✔
346	}
347	return edition;	2✔
348	} catch (IOException e) {	×
349	throw new IllegalStateException(	×
350	"Couldn't determine the edition of " + getName() + " from the directory structure of its software path "	×
351	+ toolPath
352	+ ", assuming the name of the parent directory of the real path of the software path to be the edition "
353	+ "of the tool.", e);
354	}
355	}
356
357	@Override
358	public void uninstall() {
359
360	try {
361	Path softwarePath = getToolPath();	3✔
362	if (Files.exists(softwarePath)) {	5✔
363	try {
364	this.context.getFileAccess().delete(softwarePath);	5✔
365	this.context.success("Successfully uninstalled " + this.tool);	6✔
366	} catch (Exception e) {	1✔
367	this.context.error("Couldn't uninstall " + this.tool);	6✔
368	}	2✔
369	} else {
370	this.context.warning("An installed version of " + this.tool + " does not exist");	6✔
371	}
372	} catch (Exception e) {	×
373	this.context.error(e.getMessage());	×
374	}	1✔
375	}	1✔
376
377	private ToolInstallation createToolInstallation(Path rootDir, VersionIdentifier resolvedVersion, Path toolVersionFile,
378	boolean newInstallation, EnvironmentContext environmentContext, boolean extraInstallation) {
379
380	Path linkDir = getMacOsHelper().findLinkDir(rootDir, getBinaryName());	7✔
381	Path binDir = linkDir;	2✔
382	Path binFolder = binDir.resolve(IdeContext.FOLDER_BIN);	4✔
383	if (Files.isDirectory(binFolder)) {	5✔
384	binDir = binFolder;	2✔
385	}
386	if (linkDir != rootDir) {	3✔
387	assert (!linkDir.equals(rootDir));	5!
388	this.context.getFileAccess().copy(toolVersionFile, linkDir, FileCopyMode.COPY_FILE_OVERRIDE);	7✔
389	}
390	ToolInstallation toolInstallation = new ToolInstallation(rootDir, linkDir, binDir, resolvedVersion, newInstallation);	9✔
391	setEnvironment(environmentContext, toolInstallation, extraInstallation);	5✔
392	return toolInstallation;	2✔
393	}
394
395	/**
396	* Method to set environment variables for the process context.
397	*
398	* @param environmentContext the {@link EnvironmentContext} where to {@link EnvironmentContext#withEnvVar(String, String) set environment variables} for
399	* this tool.
400	* @param toolInstallation the {@link ToolInstallation}.
401	* @param extraInstallation {@code true} if the {@link ToolInstallation} is an additional installation to the
402	* {@link #getConfiguredVersion() configured version} due to a conflicting version of a {@link ToolDependency}, {@code false} otherwise.
403	*/
404	protected void setEnvironment(EnvironmentContext environmentContext, ToolInstallation toolInstallation, boolean extraInstallation) {
405
406	String pathVariable = this.tool.toUpperCase(Locale.ROOT) + "_HOME";	6✔
407	environmentContext.withEnvVar(pathVariable, toolInstallation.linkDir().toString());	7✔
408	if (extraInstallation) {	2✔
409	environmentContext.withPathEntry(toolInstallation.binDir());	5✔
410	}
411	}	1✔
412
413	}

devonfw / IDEasy / 11970498949

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