28849265105

Committed 07 Jul 2026 07:28AM UTC coverage: 71.962% (-0.1%) from 72.066%

Build # 28849265105

Build Type

Pull #1878

github

Committed by

web-flow

Commit Message

Merge 36018b14f into 2cf3f5070

Pull Request Pull Request #1878: #1695: Clone settings to temporary directory, analyse, and then move

Coverage Stats

4845 of 7426 branches covered (65.24%)

Branch coverage included in aggregate %.

12418 of 16563 relevant lines covered (74.97%)

3.18 hits per line

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

80.54

cli/src/main/java/com/devonfw/tools/ide/commandlet/AbstractUpdateCommandlet.java

package com.devonfw.tools.ide.commandlet;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.stream.Stream;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.devonfw.tools.ide.context.AbstractIdeContext;
import com.devonfw.tools.ide.context.IdeContext;
import com.devonfw.tools.ide.context.IdeStartContextImpl;
import com.devonfw.tools.ide.git.GitContext;
import com.devonfw.tools.ide.git.GitUrl;
import com.devonfw.tools.ide.git.repository.RepositoryCommandlet;
import com.devonfw.tools.ide.io.FileAccess;
import com.devonfw.tools.ide.property.FlagProperty;
import com.devonfw.tools.ide.property.StringProperty;
import com.devonfw.tools.ide.step.Step;
import com.devonfw.tools.ide.tool.LocalToolCommandlet;
import com.devonfw.tools.ide.tool.ToolCommandlet;
import com.devonfw.tools.ide.tool.ToolEdition;
import com.devonfw.tools.ide.tool.ToolEditionAndVersion;
import com.devonfw.tools.ide.tool.ToolInstallRequest;
import com.devonfw.tools.ide.tool.custom.CustomToolCommandlet;
import com.devonfw.tools.ide.tool.custom.CustomToolMetadata;
import com.devonfw.tools.ide.tool.extra.ExtraToolInstallation;
import com.devonfw.tools.ide.tool.extra.ExtraTools;
import com.devonfw.tools.ide.tool.extra.ExtraToolsMapper;
import com.devonfw.tools.ide.variable.IdeVariables;
import com.devonfw.tools.ide.version.VersionIdentifier;

/**
 * Abstract {@link Commandlet} base-class for both {@link UpdateCommandlet} and {@link CreateCommandlet}.
 */
public abstract class AbstractUpdateCommandlet extends Commandlet {

  private static final Logger LOG = LoggerFactory.getLogger(AbstractUpdateCommandlet.class);

  private static final String MESSAGE_CODE_REPO_URL = """
      No code repository was given after '--code'.
      Further details can be found here: https://github.com/devonfw/IDEasy/blob/main/documentation/settings.adoc
      Please enter the code repository below that includes your settings folder.""";

  private static final String MESSAGE_SETTINGS_REPO_URL = """
      No settings found at {} and no SETTINGS_URL is defined.
      Further details can be found here: https://github.com/devonfw/IDEasy/blob/main/documentation/settings.adoc
      Please contact the technical lead of your project to get the SETTINGS_URL for your project to enter.
      In case you just want to test IDEasy you may simply hit return to install the default settings.""";

  /** {@link StringProperty} for the settings repository URL. */
  public final StringProperty settingsRepo;

  /** {@link FlagProperty} for skipping installation/updating of tools. */
  public final FlagProperty skipTools;

  /** {@link FlagProperty} for skipping the setup of git repositories. */
  public final FlagProperty skipRepositories;

  /** {@link FlagProperty} to force the update of the settings git repository. */
  public final FlagProperty forcePull;

  /** {@link FlagProperty} to force the installation/update of plugins. */
  public final FlagProperty forcePlugins;

  /** {@link FlagProperty} to force the setup of git repositories. */
  public final FlagProperty forceRepositories;

  /**
   * The constructor.
   *
   * @param context the {@link IdeContext}.
   */
  public AbstractUpdateCommandlet(IdeContext context) {

    super(context);
    addKeyword(getName());
    this.skipTools = add(new FlagProperty("--skip-tools"));
    this.skipRepositories = add(new FlagProperty("--skip-repositories"));
    this.forcePull = add(new FlagProperty("--force-pull"));
    this.forcePlugins = add(new FlagProperty("--force-plugins"));
    this.forceRepositories = add(new FlagProperty("--force-repositories"));
    this.settingsRepo = new StringProperty("", false, "settingsRepository");
  }

  @Override
  protected void doRun() {

    IdeStartContextImpl startContext = ((AbstractIdeContext) this.context).getStartContext();
    startContext.setForcePull(forcePull.isTrue());
    startContext.setForcePlugins(forcePlugins.isTrue());
    startContext.setForceRepositories(forceRepositories.isTrue());

    updateSettings();
    updateConf();
    reloadContext();
    this.context.verifyIdeMinVersion(true);

    updateSoftware();
    updateRepositories();
    createStartScripts();
  }



  private void reloadContext() {

    ((AbstractIdeContext) this.context).reload();
  }

  private void updateConf() {

    Path templatesFolder = this.context.getSettingsPath().resolve(IdeContext.FOLDER_TEMPLATES);
    if (!Files.exists(templatesFolder)) {
      Path legacyTemplatesFolder = this.context.getSettingsPath().resolve(IdeContext.FOLDER_LEGACY_TEMPLATES);
      if (Files.exists(legacyTemplatesFolder)) {
        templatesFolder = legacyTemplatesFolder;
      } else {
        LOG.warn("Templates folder is missing in settings repository.");
        return;
      }
    }

    Step step = this.context.newStep("Copy configuration templates", templatesFolder);
    final Path finalTemplatesFolder = templatesFolder;
    step.run(() -> setupConf(finalTemplatesFolder, this.context.getIdeHome()));
  }

  private void setupConf(Path template, Path conf) {

    List<Path> children = this.context.getFileAccess().listChildren(template, f -> true);
    for (Path child : children) {

      String basename = child.getFileName().toString();
      Path confPath = conf.resolve(basename);

      if (Files.isDirectory(child)) {
        if (!Files.isDirectory(confPath)) {
          this.context.getFileAccess().mkdirs(confPath);
        }
        setupConf(child, confPath);
      } else if (Files.isRegularFile(child)) {
        if (Files.isRegularFile(confPath)) {
          LOG.debug("Configuration {} already exists - skipping to copy from {}", confPath, child);
        } else {
          if (!basename.equals("settings.xml")) {
            LOG.info("Copying template {} to {}.", child, conf);
            this.context.getFileAccess().copy(child, conf);
          }
        }
      }
    }
  }

  /**
   * Updates the settings repository in IDE_HOME/settings by either cloning if no such repository exists or pulling if the repository exists then saves the
   * latest current commit ID in the file ".commit.id".
   */
  protected void updateSettings() {

    boolean codeRepository = this.context.isSettingsCodeRepository();
    if (codeRepository && !(this.context.isForceMode() || forcePull.isTrue())) {
      LOG.info("Skipping git pull in settings due to code repository. Use --force-pull to enforce pulling.");
      return;
    }
    this.context.newStep(getStepMessage()).run(() -> updateSettingsInStep(codeRepository));
  }

  protected String getStepMessage() {

    return "update (pull) settings repository";
  }

  private void updateSettingsInStep(boolean codeRepository) {
    Path settingsPath = this.context.getSettingsPath();
    if (!codeRepository) {
      boolean settingsRepository = this.context.getGitContext().isGitRepo(settingsPath);
      if (!settingsRepository) {
        if (Files.exists(settingsPath)) {
          if (!this.context.getFileAccess().isEmptyDir(settingsPath)) {
            this.context.askToContinue(
                "Your settings repository seems to be broken ('.git' folder not present). "
                    + "We can fix this by moving  your settings the backed up. "
                    + "You will be asked for the settings git URL and your settings will be cloned from scratch. "
                    + "Do you want to proceed?"
            );
          }
          this.context.getFileAccess().backup(settingsPath);
        }
        GitUrl gitUrl = getOrAskSettingsUrl();
        initializeRepository(gitUrl);
        return;
      }
    }
    GitContext gitContext = this.context.getGitContext();
    if (gitContext.hasUntrackedFiles(settingsPath)) {
      gitContext.pullSafelyWithStash(settingsPath);
    } else {
      gitContext.pull(settingsPath);
    }
    this.context.getGitContext().saveCurrentCommitId(settingsPath, this.context.getSettingsCommitIdPath());
  }

  private GitUrl getOrAskSettingsUrl() {

    String repository = this.settingsRepo.getValue();
    repository = handleDefaultRepository(repository);
    String userPromt = "Repository URL [" + IdeContext.DEFAULT_SETTINGS_REPO_URL + "]:";
    String defaultUrl = IdeContext.DEFAULT_SETTINGS_REPO_URL;
    LOG.info(MESSAGE_SETTINGS_REPO_URL, this.context.getSettingsPath());

    GitUrl gitUrl = null;
    if (repository != null) {
      gitUrl = GitUrl.of(repository);
    }
    while ((gitUrl == null) || !gitUrl.isValid()) {
      repository = this.context.askForInput(userPromt, defaultUrl);
      repository = handleDefaultRepository(repository);
      gitUrl = GitUrl.of(repository);
      if (!gitUrl.isValid()) {
        LOG.warn("The input URL is not valid, please try again.");
      }
    }
    return gitUrl;
  }

  private String handleDefaultRepository(String repository) {
    if ("-".equals(repository)) {
      LOG.info("'-' was found for the repository, the default settings repository '{}' will be used.", IdeContext.DEFAULT_SETTINGS_REPO_URL);
      repository = IdeContext.DEFAULT_SETTINGS_REPO_URL;
    }
    return repository;
  }

  private void initializeRepository(GitUrl gitUrl) {

    GitContext gitContext = this.context.getGitContext();
    Path settingsPath = this.context.getSettingsPath();
    Path repoPath = settingsPath;
    gitContext.pullOrClone(gitUrl, repoPath);
    this.context.getGitContext().saveCurrentCommitId(settingsPath, this.context.getSettingsCommitIdPath());
  }

  private void updateSoftware() {

    if (this.skipTools.isTrue()) {
      LOG.info("Skipping installation/update of tools as specified by the user.");
      return;
    }
    Step step = this.context.newStep("Install or update software");
    step.run(() -> doUpdateSoftwareStep(step));
  }

  private void doUpdateSoftwareStep(Step step) {

    Set<ToolCommandlet> toolCommandlets = new HashSet<>();
    CommandletManager commandletManager = this.context.getCommandletManager();
    // installed tools in IDE_HOME/software
    List<Path> softwarePaths = this.context.getFileAccess().listChildren(this.context.getSoftwarePath(), Files::isDirectory);
    for (Path softwarePath : softwarePaths) {
      String toolName = softwarePath.getFileName().toString();
      ToolCommandlet toolCommandlet = commandletManager.getToolCommandlet(toolName);
      if (toolCommandlet != null) {
        toolCommandlets.add(toolCommandlet);
      }
    }

    // regular tools in $IDE_TOOLS
    List<String> regularTools = IdeVariables.IDE_TOOLS.get(this.context);
    if (regularTools != null) {
      for (String regularTool : regularTools) {
        ToolCommandlet toolCommandlet = commandletManager.getToolCommandlet(regularTool);
        if (toolCommandlet == null) {
          String displayName = (regularTool == null || regularTool.isBlank()) ? "<empty>" : "'" + regularTool + "'";
          LOG.error("Cannot install or update tool '{}''. No matching commandlet found. Please check your IDE_TOOLS configuration.", displayName);
        } else {
          toolCommandlets.add(toolCommandlet);
        }
      }
    }

    // custom tools in ide-custom-tools.json
    for (CustomToolMetadata customTool : this.context.getCustomToolRepository().getTools()) {
      CustomToolCommandlet customToolCommandlet = new CustomToolCommandlet(this.context, customTool);
      toolCommandlets.add(customToolCommandlet);
    }

    // update/install the toolCommandlets
    for (ToolCommandlet toolCommandlet : toolCommandlets) {
      this.context.newStep("Install " + toolCommandlet.getName()).run(() -> toolCommandlet.install(false));
    }

    ExtraTools extraTools = ExtraToolsMapper.get().loadJsonFromFolder(this.context.getSettingsPath());
    if (extraTools != null) {
      List<String> toolNames = extraTools.getSortedToolNames();
      LOG.info("Found extra installation of the following tools: {}", toolNames);
      for (String tool : toolNames) {
        List<ExtraToolInstallation> installations = extraTools.getExtraInstallations(tool);
        this.context.newStep("Install extra version(s) of " + tool).run(() -> installExtraToolInstallations(tool, installations));
      }
    }
  }

  private void installExtraToolInstallations(String tool, List<ExtraToolInstallation> extraInstallations) {

    CommandletManager commandletManager = this.context.getCommandletManager();
    FileAccess fileAccess = this.context.getFileAccess();
    Path extraPath = this.context.getSoftwareExtraPath();
    LocalToolCommandlet toolCommandlet = commandletManager.getRequiredLocalToolCommandlet(tool);
    for (ExtraToolInstallation extraInstallation : extraInstallations) {
      ToolInstallRequest request = new ToolInstallRequest(false);
      String edition = extraInstallation.edition();
      if (edition == null) {
        edition = toolCommandlet.getConfiguredEdition();
      }
      ToolEdition toolEdition = new ToolEdition(tool, edition);
      VersionIdentifier version = extraInstallation.version();
      request.setRequested(new ToolEditionAndVersion(toolEdition, version));
      Path extraToolPath = extraPath.resolve(tool);
      Path toolPath = extraToolPath.resolve(extraInstallation.name());
      request.setToolPathForExtraInstallation(toolPath);
      toolCommandlet.install(request);
    }
  }

  private void updateRepositories() {

    if (this.skipRepositories.isTrue()) {
      if (this.forceRepositories.isTrue()) {
        LOG.warn("Options to skip and force repositories are incompatible and should not be combined. Ignoring --force-repositories to proceed.");
      }
      LOG.info("Skipping setup of repositories as specified by the user.");
      return;
    }
    RepositoryCommandlet repositoryCommandlet = this.context.getCommandletManager().getCommandlet(RepositoryCommandlet.class);
    repositoryCommandlet.reset();
    repositoryCommandlet.run();
  }

  private void createStartScripts() {

    List<String> ides = IdeVariables.CREATE_START_SCRIPTS.get(this.context);
    if (ides == null) {
      LOG.info("Variable CREATE_START_SCRIPTS is undefined - skipping start script creation.");
      return;
    }
    for (String ide : ides) {
      ToolCommandlet tool = this.context.getCommandletManager().getToolCommandlet(ide);
      if (tool == null) {
        LOG.error("Undefined IDE '{}' configured in variable CREATE_START_SCRIPTS.", ide);
      } else {
        createStartScript(ide);
      }
    }
  }

  private void createStartScript(String ide) {

    LOG.info("Creating start scripts for {}", ide);
    Path workspaces = this.context.getIdeHome().resolve(IdeContext.FOLDER_WORKSPACES);
    try (Stream<Path> childStream = Files.list(workspaces)) {
      Iterator<Path> iterator = childStream.iterator();
      while (iterator.hasNext()) {
        Path child = iterator.next();
        if (Files.isDirectory(child)) {
          createStartScript(ide, child.getFileName().toString());
        }
      }
    } catch (IOException e) {
      throw new RuntimeException("Failed to list children of directory " + workspaces, e);
    }
  }

  private void createStartScript(String ide, String workspace) {

    Path ideHome = this.context.getIdeHome();
    String scriptName = ide + "-" + workspace;
    boolean windows = this.context.getSystemInfo().isWindows();
    if (windows) {
      scriptName = scriptName + ".bat";
    } else {
      scriptName = scriptName + ".sh";
    }
    Path scriptPath = ideHome.resolve(scriptName);
    if (Files.exists(scriptPath)) {
      return;
    }
    String scriptContent;
    if (windows) {
      scriptContent = "@echo off\r\n" + "pushd %~dp0\r\n" + "cd workspaces/" + workspace + "\r\n" + "call ide " + ide + "\r\n" + "popd\r\n";
    } else {
      scriptContent = "#!/usr/bin/env bash\n" + "cd \"$(dirname \"$0\")\"\n" + "cd workspaces/" + workspace + "\n" + "ideasy " + ide + "\n";
    }
    FileAccess fileAccess = this.context.getFileAccess();
    fileAccess.writeFileContent(scriptContent, scriptPath);
    fileAccess.makeExecutable(scriptPath);
  }
}

1	package com.devonfw.tools.ide.commandlet;
2
3	import java.io.IOException;
4	import java.nio.file.Files;
5	import java.nio.file.Path;
6	import java.util.HashSet;
7	import java.util.Iterator;
8	import java.util.List;
9	import java.util.Set;
10	import java.util.stream.Stream;
11
12	import org.slf4j.Logger;
13	import org.slf4j.LoggerFactory;
14
15	import com.devonfw.tools.ide.context.AbstractIdeContext;
16	import com.devonfw.tools.ide.context.IdeContext;
17	import com.devonfw.tools.ide.context.IdeStartContextImpl;
18	import com.devonfw.tools.ide.git.GitContext;
19	import com.devonfw.tools.ide.git.GitUrl;
20	import com.devonfw.tools.ide.git.repository.RepositoryCommandlet;
21	import com.devonfw.tools.ide.io.FileAccess;
22	import com.devonfw.tools.ide.property.FlagProperty;
23	import com.devonfw.tools.ide.property.StringProperty;
24	import com.devonfw.tools.ide.step.Step;
25	import com.devonfw.tools.ide.tool.LocalToolCommandlet;
26	import com.devonfw.tools.ide.tool.ToolCommandlet;
27	import com.devonfw.tools.ide.tool.ToolEdition;
28	import com.devonfw.tools.ide.tool.ToolEditionAndVersion;
29	import com.devonfw.tools.ide.tool.ToolInstallRequest;
30	import com.devonfw.tools.ide.tool.custom.CustomToolCommandlet;
31	import com.devonfw.tools.ide.tool.custom.CustomToolMetadata;
32	import com.devonfw.tools.ide.tool.extra.ExtraToolInstallation;
33	import com.devonfw.tools.ide.tool.extra.ExtraTools;
34	import com.devonfw.tools.ide.tool.extra.ExtraToolsMapper;
35	import com.devonfw.tools.ide.variable.IdeVariables;
36	import com.devonfw.tools.ide.version.VersionIdentifier;
37
38	/**
39	* Abstract {@link Commandlet} base-class for both {@link UpdateCommandlet} and {@link CreateCommandlet}.
40	*/
41	public abstract class AbstractUpdateCommandlet extends Commandlet {
42
43	private static final Logger LOG = LoggerFactory.getLogger(AbstractUpdateCommandlet.class);	4✔
44
45	private static final String MESSAGE_CODE_REPO_URL = """
46	No code repository was given after '--code'.
47	Further details can be found here: https://github.com/devonfw/IDEasy/blob/main/documentation/settings.adoc
48	Please enter the code repository below that includes your settings folder.""";
49
50	private static final String MESSAGE_SETTINGS_REPO_URL = """
51	No settings found at {} and no SETTINGS_URL is defined.
52	Further details can be found here: https://github.com/devonfw/IDEasy/blob/main/documentation/settings.adoc
53	Please contact the technical lead of your project to get the SETTINGS_URL for your project to enter.
54	In case you just want to test IDEasy you may simply hit return to install the default settings.""";
55
56	/** {@link StringProperty} for the settings repository URL. */
57	public final StringProperty settingsRepo;
58
59	/** {@link FlagProperty} for skipping installation/updating of tools. */
60	public final FlagProperty skipTools;
61
62	/** {@link FlagProperty} for skipping the setup of git repositories. */
63	public final FlagProperty skipRepositories;
64
65	/** {@link FlagProperty} to force the update of the settings git repository. */
66	public final FlagProperty forcePull;
67
68	/** {@link FlagProperty} to force the installation/update of plugins. */
69	public final FlagProperty forcePlugins;
70
71	/** {@link FlagProperty} to force the setup of git repositories. */
72	public final FlagProperty forceRepositories;
73
74	/**
75	* The constructor.
76	*
77	* @param context the {@link IdeContext}.
78	*/
79	public AbstractUpdateCommandlet(IdeContext context) {
80
81	super(context);	3✔
82	addKeyword(getName());	4✔
83	this.skipTools = add(new FlagProperty("--skip-tools"));	9✔
84	this.skipRepositories = add(new FlagProperty("--skip-repositories"));	9✔
85	this.forcePull = add(new FlagProperty("--force-pull"));	9✔
86	this.forcePlugins = add(new FlagProperty("--force-plugins"));	9✔
87	this.forceRepositories = add(new FlagProperty("--force-repositories"));	9✔
88	this.settingsRepo = new StringProperty("", false, "settingsRepository");	8✔
89	}	1✔
90
91	@Override
92	protected void doRun() {
93
94	IdeStartContextImpl startContext = ((AbstractIdeContext) this.context).getStartContext();	5✔
95	startContext.setForcePull(forcePull.isTrue());	5✔
96	startContext.setForcePlugins(forcePlugins.isTrue());	5✔
97	startContext.setForceRepositories(forceRepositories.isTrue());	5✔
98
99	updateSettings();	2✔
100	updateConf();	2✔
101	reloadContext();	2✔
102	this.context.verifyIdeMinVersion(true);	4✔
103
104	updateSoftware();	2✔
105	updateRepositories();	2✔
106	createStartScripts();	2✔
107	}	1✔
108
109
110
111	private void reloadContext() {
112
113	((AbstractIdeContext) this.context).reload();	4✔
114	}	1✔
115
116	private void updateConf() {
117
118	Path templatesFolder = this.context.getSettingsPath().resolve(IdeContext.FOLDER_TEMPLATES);	6✔
119	if (!Files.exists(templatesFolder)) {	5✔
120	Path legacyTemplatesFolder = this.context.getSettingsPath().resolve(IdeContext.FOLDER_LEGACY_TEMPLATES);	6✔
121	if (Files.exists(legacyTemplatesFolder)) {	5!
122	templatesFolder = legacyTemplatesFolder;	×
123	} else {
124	LOG.warn("Templates folder is missing in settings repository.");	3✔
125	return;	1✔
126	}
127	}
128
129	Step step = this.context.newStep("Copy configuration templates", templatesFolder);	11✔
130	final Path finalTemplatesFolder = templatesFolder;	2✔
131	step.run(() -> setupConf(finalTemplatesFolder, this.context.getIdeHome()));	13✔
132	}	1✔
133
134	private void setupConf(Path template, Path conf) {
135
136	List<Path> children = this.context.getFileAccess().listChildren(template, f -> true);	9✔
137	for (Path child : children) {	10✔
138
139	String basename = child.getFileName().toString();	4✔
140	Path confPath = conf.resolve(basename);	4✔
141
142	if (Files.isDirectory(child)) {	5✔
143	if (!Files.isDirectory(confPath)) {	5!
144	this.context.getFileAccess().mkdirs(confPath);	5✔
145	}
146	setupConf(child, confPath);	5✔
147	} else if (Files.isRegularFile(child)) {	5!
148	if (Files.isRegularFile(confPath)) {	5!
149	LOG.debug("Configuration {} already exists - skipping to copy from {}", confPath, child);	×
150	} else {
151	if (!basename.equals("settings.xml")) {	4!
152	LOG.info("Copying template {} to {}.", child, conf);	5✔
153	this.context.getFileAccess().copy(child, conf);	6✔
154	}
155	}
156	}
157	}	1✔
158	}	1✔
159
160	/**
161	* Updates the settings repository in IDE_HOME/settings by either cloning if no such repository exists or pulling if the repository exists then saves the
162	* latest current commit ID in the file ".commit.id".
163	*/
164	protected void updateSettings() {
165
166	boolean codeRepository = this.context.isSettingsCodeRepository();	4✔
167	if (codeRepository && !(this.context.isForceMode() \|\| forcePull.isTrue())) {	2!
168	LOG.info("Skipping git pull in settings due to code repository. Use --force-pull to enforce pulling.");	×
169	return;	×
170	}
171	this.context.newStep(getStepMessage()).run(() -> updateSettingsInStep(codeRepository));	14✔
172	}	1✔
173
174	protected String getStepMessage() {
175
176	return "update (pull) settings repository";	2✔
177	}
178
179	private void updateSettingsInStep(boolean codeRepository) {
180	Path settingsPath = this.context.getSettingsPath();	4✔
181	if (!codeRepository) {	2!
182	boolean settingsRepository = this.context.getGitContext().isGitRepo(settingsPath);	6✔
183	if (!settingsRepository) {	2✔
184	if (Files.exists(settingsPath)) {	5!
185	if (!this.context.getFileAccess().isEmptyDir(settingsPath)) {	×
186	this.context.askToContinue(	×
187	"Your settings repository seems to be broken ('.git' folder not present). "
188	+ "We can fix this by moving your settings the backed up. "
189	+ "You will be asked for the settings git URL and your settings will be cloned from scratch. "
190	+ "Do you want to proceed?"
191	);
192	}
193	this.context.getFileAccess().backup(settingsPath);	×
194	}
195	GitUrl gitUrl = getOrAskSettingsUrl();	3✔
196	initializeRepository(gitUrl);	3✔
197	return;	1✔
198	}
199	}
200	GitContext gitContext = this.context.getGitContext();	4✔
201	if (gitContext.hasUntrackedFiles(settingsPath)) {	4!
202	gitContext.pullSafelyWithStash(settingsPath);	×
203	} else {
204	gitContext.pull(settingsPath);	3✔
205	}
206	this.context.getGitContext().saveCurrentCommitId(settingsPath, this.context.getSettingsCommitIdPath());	8✔
207	}	1✔
208
209	private GitUrl getOrAskSettingsUrl() {
210
211	String repository = this.settingsRepo.getValue();	5✔
212	repository = handleDefaultRepository(repository);	4✔
213	String userPromt = "Repository URL [" + IdeContext.DEFAULT_SETTINGS_REPO_URL + "]:";	2✔
214	String defaultUrl = IdeContext.DEFAULT_SETTINGS_REPO_URL;	2✔
215	LOG.info(MESSAGE_SETTINGS_REPO_URL, this.context.getSettingsPath());	6✔
216
217	GitUrl gitUrl = null;	2✔
218	if (repository != null) {	2✔
219	gitUrl = GitUrl.of(repository);	3✔
220	}
221	while ((gitUrl == null) \|\| !gitUrl.isValid()) {	5!
222	repository = this.context.askForInput(userPromt, defaultUrl);	6✔
223	repository = handleDefaultRepository(repository);	4✔
224	gitUrl = GitUrl.of(repository);	3✔
225	if (!gitUrl.isValid()) {	3!
226	LOG.warn("The input URL is not valid, please try again.");	×
227	}
228	}
229	return gitUrl;	2✔
230	}
231
232	private String handleDefaultRepository(String repository) {
233	if ("-".equals(repository)) {	4✔
234	LOG.info("'-' was found for the repository, the default settings repository '{}' will be used.", IdeContext.DEFAULT_SETTINGS_REPO_URL);	4✔
235	repository = IdeContext.DEFAULT_SETTINGS_REPO_URL;	2✔
236	}
237	return repository;	2✔
238	}
239
240	private void initializeRepository(GitUrl gitUrl) {
241
242	GitContext gitContext = this.context.getGitContext();	4✔
243	Path settingsPath = this.context.getSettingsPath();	4✔
244	Path repoPath = settingsPath;	2✔
245	gitContext.pullOrClone(gitUrl, repoPath);	4✔
246	this.context.getGitContext().saveCurrentCommitId(settingsPath, this.context.getSettingsCommitIdPath());	8✔
247	}	1✔
248
249	private void updateSoftware() {
250
251	if (this.skipTools.isTrue()) {	4✔
252	LOG.info("Skipping installation/update of tools as specified by the user.");	3✔
253	return;	1✔
254	}
255	Step step = this.context.newStep("Install or update software");	5✔
256	step.run(() -> doUpdateSoftwareStep(step));	10✔
257	}	1✔
258
259	private void doUpdateSoftwareStep(Step step) {
260
261	Set<ToolCommandlet> toolCommandlets = new HashSet<>();	4✔
262	CommandletManager commandletManager = this.context.getCommandletManager();	4✔
263	// installed tools in IDE_HOME/software
264	List<Path> softwarePaths = this.context.getFileAccess().listChildren(this.context.getSoftwarePath(), Files::isDirectory);	14✔
265	for (Path softwarePath : softwarePaths) {	10✔
266	String toolName = softwarePath.getFileName().toString();	4✔
267	ToolCommandlet toolCommandlet = commandletManager.getToolCommandlet(toolName);	4✔
268	if (toolCommandlet != null) {	2!
269	toolCommandlets.add(toolCommandlet);	4✔
270	}
271	}	1✔
272
273	// regular tools in $IDE_TOOLS
274	List<String> regularTools = IdeVariables.IDE_TOOLS.get(this.context);	6✔
275	if (regularTools != null) {	2!
276	for (String regularTool : regularTools) {	10✔
277	ToolCommandlet toolCommandlet = commandletManager.getToolCommandlet(regularTool);	4✔
278	if (toolCommandlet == null) {	2!
279	String displayName = (regularTool == null \|\| regularTool.isBlank()) ? "<empty>" : "'" + regularTool + "'";	×
280	LOG.error("Cannot install or update tool '{}''. No matching commandlet found. Please check your IDE_TOOLS configuration.", displayName);	×
281	} else {	×
282	toolCommandlets.add(toolCommandlet);	4✔
283	}
284	}	1✔
285	}
286
287	// custom tools in ide-custom-tools.json
288	for (CustomToolMetadata customTool : this.context.getCustomToolRepository().getTools()) {	9!
289	CustomToolCommandlet customToolCommandlet = new CustomToolCommandlet(this.context, customTool);	×
290	toolCommandlets.add(customToolCommandlet);	×
291	}	×
292
293	// update/install the toolCommandlets
294	for (ToolCommandlet toolCommandlet : toolCommandlets) {	10✔
295	this.context.newStep("Install " + toolCommandlet.getName()).run(() -> toolCommandlet.install(false));	15✔
296	}	1✔
297
298	ExtraTools extraTools = ExtraToolsMapper.get().loadJsonFromFolder(this.context.getSettingsPath());	7✔
299	if (extraTools != null) {	2✔
300	List<String> toolNames = extraTools.getSortedToolNames();	3✔
301	LOG.info("Found extra installation of the following tools: {}", toolNames);	4✔
302	for (String tool : toolNames) {	10✔
303	List<ExtraToolInstallation> installations = extraTools.getExtraInstallations(tool);	4✔
304	this.context.newStep("Install extra version(s) of " + tool).run(() -> installExtraToolInstallations(tool, installations));	16✔
305	}	1✔
306	}
307	}	1✔
308
309	private void installExtraToolInstallations(String tool, List<ExtraToolInstallation> extraInstallations) {
310
311	CommandletManager commandletManager = this.context.getCommandletManager();	4✔
312	FileAccess fileAccess = this.context.getFileAccess();	4✔
313	Path extraPath = this.context.getSoftwareExtraPath();	4✔
314	LocalToolCommandlet toolCommandlet = commandletManager.getRequiredLocalToolCommandlet(tool);	4✔
315	for (ExtraToolInstallation extraInstallation : extraInstallations) {	10✔
316	ToolInstallRequest request = new ToolInstallRequest(false);	5✔
317	String edition = extraInstallation.edition();	3✔
318	if (edition == null) {	2✔
319	edition = toolCommandlet.getConfiguredEdition();	3✔
320	}
321	ToolEdition toolEdition = new ToolEdition(tool, edition);	6✔
322	VersionIdentifier version = extraInstallation.version();	3✔
323	request.setRequested(new ToolEditionAndVersion(toolEdition, version));	7✔
324	Path extraToolPath = extraPath.resolve(tool);	4✔
325	Path toolPath = extraToolPath.resolve(extraInstallation.name());	5✔
326	request.setToolPathForExtraInstallation(toolPath);	3✔
327	toolCommandlet.install(request);	4✔
328	}	1✔
329	}	1✔
330
331	private void updateRepositories() {
332
333	if (this.skipRepositories.isTrue()) {	4!
334	if (this.forceRepositories.isTrue()) {	×
335	LOG.warn("Options to skip and force repositories are incompatible and should not be combined. Ignoring --force-repositories to proceed.");	×
336	}
337	LOG.info("Skipping setup of repositories as specified by the user.");	×
338	return;	×
339	}
340	RepositoryCommandlet repositoryCommandlet = this.context.getCommandletManager().getCommandlet(RepositoryCommandlet.class);	7✔
341	repositoryCommandlet.reset();	2✔
342	repositoryCommandlet.run();	2✔
343	}	1✔
344
345	private void createStartScripts() {
346
347	List<String> ides = IdeVariables.CREATE_START_SCRIPTS.get(this.context);	6✔
348	if (ides == null) {	2✔
349	LOG.info("Variable CREATE_START_SCRIPTS is undefined - skipping start script creation.");	3✔
350	return;	1✔
351	}
352	for (String ide : ides) {	10✔
353	ToolCommandlet tool = this.context.getCommandletManager().getToolCommandlet(ide);	6✔
354	if (tool == null) {	2!
355	LOG.error("Undefined IDE '{}' configured in variable CREATE_START_SCRIPTS.", ide);	×
356	} else {
357	createStartScript(ide);	3✔
358	}
359	}	1✔
360	}	1✔
361
362	private void createStartScript(String ide) {
363
364	LOG.info("Creating start scripts for {}", ide);	4✔
365	Path workspaces = this.context.getIdeHome().resolve(IdeContext.FOLDER_WORKSPACES);	6✔
366	try (Stream<Path> childStream = Files.list(workspaces)) {	3✔
367	Iterator<Path> iterator = childStream.iterator();	3✔
368	while (iterator.hasNext()) {	3✔
369	Path child = iterator.next();	4✔
370	if (Files.isDirectory(child)) {	5!
371	createStartScript(ide, child.getFileName().toString());	6✔
372	}
373	}	1✔
374	} catch (IOException e) {	×
375	throw new RuntimeException("Failed to list children of directory " + workspaces, e);	×
376	}	1✔
377	}	1✔
378
379	private void createStartScript(String ide, String workspace) {
380
381	Path ideHome = this.context.getIdeHome();	4✔
382	String scriptName = ide + "-" + workspace;	4✔
383	boolean windows = this.context.getSystemInfo().isWindows();	5✔
384	if (windows) {	2!
385	scriptName = scriptName + ".bat";	×
386	} else {
387	scriptName = scriptName + ".sh";	3✔
388	}
389	Path scriptPath = ideHome.resolve(scriptName);	4✔
390	if (Files.exists(scriptPath)) {	5!
391	return;	×
392	}
393	String scriptContent;
394	if (windows) {	2!
395	scriptContent = "@echo off\r\n" + "pushd %~dp0\r\n" + "cd workspaces/" + workspace + "\r\n" + "call ide " + ide + "\r\n" + "popd\r\n";	×
396	} else {
397	scriptContent = "#!/usr/bin/env bash\n" + "cd \"$(dirname \"$0\")\"\n" + "cd workspaces/" + workspace + "\n" + "ideasy " + ide + "\n";	4✔
398	}
399	FileAccess fileAccess = this.context.getFileAccess();	4✔
400	fileAccess.writeFileContent(scriptContent, scriptPath);	4✔
401	fileAccess.makeExecutable(scriptPath);	3✔
402	}	1✔
403	}

devonfw / IDEasy / 28849265105

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