26475099762

Committed 26 May 2026 09:04PM UTC coverage: 71.132% (+0.02%) from 71.115%

Build # 26475099762

Build Type

push

github

Committed by

web-flow

Commit Message

#1788: Created a commandlet to simulate the behaviour of ln -s (#1847)

Co-authored-by: Jörg Hohwiller <hohwille@users.noreply.github.com>

Coverage Stats

4471 of 6952 branches covered (64.31%)

Branch coverage included in aggregate %.

11577 of 15609 relevant lines covered (74.17%)

3.14 hits per line

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

82.14

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.cli.CliException;
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();

    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();
        checkProjectNameConvention(gitUrl.getProjectName());
        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;
    String defaultUrl;
    if (isCodeRepository()) {
      userPromt = "Code repository URL:";
      defaultUrl = null;
      LOG.info(MESSAGE_CODE_REPO_URL);
    } else {
      userPromt = "Settings URL [" + IdeContext.DEFAULT_SETTINGS_REPO_URL + "]:";
      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)) {
      if (isCodeRepository()) {
        LOG.warn("'-' is found after '--code'. This is invalid.");
        repository = null;
      } else {
        LOG.info("'-' was found for settings repository, the default settings repository '{}' will be used.", IdeContext.DEFAULT_SETTINGS_REPO_URL);
        repository = IdeContext.DEFAULT_SETTINGS_REPO_URL;
      }
    }
    return repository;
  }

  private void checkProjectNameConvention(String projectName) {
    boolean isSettingsRepo = projectName.contains(IdeContext.SETTINGS_REPOSITORY_KEYWORD);
    boolean codeRepository = isCodeRepository();
    if (isSettingsRepo == codeRepository) {
      String warningTemplate;
      if (codeRepository) {
        warningTemplate = """
            Your git URL is pointing to the project name {} that contains the keyword '{}'.
            Therefore we assume that you did a mistake by adding the '--code' option to the ide project creation.
            Do you really want to create the project?""";
      } else {
        warningTemplate = """
            Your git URL is pointing to the project name {} that does not contain the keyword ''{}''.
            Therefore we assume that you forgot to add the '--code' option to the ide project creation.
            Do you really want to create the project?""";
      }
      this.context.askToContinue(warningTemplate, projectName, IdeContext.SETTINGS_REPOSITORY_KEYWORD);
    }
  }

  private void initializeRepository(GitUrl gitUrl) {

    GitContext gitContext = this.context.getGitContext();
    Path settingsPath = this.context.getSettingsPath();
    Path repoPath = settingsPath;
    boolean codeRepository = isCodeRepository();
    if (codeRepository) {
      // clone the given code repository into IDE_HOME/workspaces/main
      repoPath = context.getWorkspacePath().resolve(gitUrl.getProjectName());
    }
    gitContext.pullOrClone(gitUrl, repoPath);
    if (codeRepository) {
      // check for settings folder and create symlink to IDE_HOME/settings
      Path settingsFolder = repoPath.resolve(IdeContext.FOLDER_SETTINGS);
      if (Files.exists(settingsFolder)) {
        context.getFileAccess().symlink(settingsFolder, settingsPath);
      } else {
        throw new CliException("Invalid code repository " + gitUrl + ": missing a settings folder at " + settingsFolder);
      }
    }
    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);
  }

  /**
   * Judge if the repository is a code repository.
   *
   * @return true when the repository is a code repository, otherwise false.
   */
  protected boolean isCodeRepository() {
    return false;
  }

}

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

devonfw / IDEasy / 26475099762

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