22241505980

Committed 20 Feb 2026 09:16PM UTC coverage: 70.656% (+0.2%) from 70.474%

Build # 22241505980

Build Type

Pull #1710

github

Committed by

web-flow

Commit Message

Merge 04e4bdacd into 379acdc9d

Pull Request Pull Request #1710: #404: allow logging via SLF4J

Run Details

4121 of 6440 branches covered (63.99%)

Branch coverage included in aggregate %.

10704 of 14542 relevant lines covered (73.61%)

3.13 hits per line

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

49.81

cli/src/main/java/com/devonfw/tools/ide/git/GitContextImpl.java

package com.devonfw.tools.ide.git;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

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

import com.devonfw.tools.ide.cli.CliException;
import com.devonfw.tools.ide.context.IdeContext;
import com.devonfw.tools.ide.log.IdeLogLevel;
import com.devonfw.tools.ide.os.SystemInfoImpl;
import com.devonfw.tools.ide.process.ProcessContext;
import com.devonfw.tools.ide.process.ProcessErrorHandling;
import com.devonfw.tools.ide.process.ProcessMode;
import com.devonfw.tools.ide.process.ProcessResult;
import com.devonfw.tools.ide.variable.IdeVariables;

/**
 * Implements the {@link GitContext}.
 */
public class GitContextImpl implements GitContext {

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

  /** @see #getContext() */
  protected final IdeContext context;
  private Path git;

  /**
   * @param context the {@link IdeContext context}.
   */
  public GitContextImpl(IdeContext context) {

    this.context = context;
  }

  @Override
  public void pullOrCloneIfNeeded(GitUrl gitUrl, Path repository) {

    GitOperation.PULL_OR_CLONE.executeIfNeeded(this.context, gitUrl, repository, null);
  }

  @Override
  public boolean fetchIfNeeded(Path repository) {

    return fetchIfNeeded(repository, null, null);
  }

  @Override
  public boolean fetchIfNeeded(Path repository, String remote, String branch) {

    return GitOperation.FETCH.executeIfNeeded(this.context, new GitUrl("https://dummy.url/repo.git", branch), repository, remote);
  }

  @Override
  public boolean isRepositoryUpdateAvailable(Path repository) {

    String localFailureMessage = String.format("Failed to get the local commit id of settings repository '%s'.", repository);
    String remoteFailureMessage = String.format("Failed to get the remote commit id of settings repository '%s', missing remote upstream branch?", repository);
    String localCommitId = runGitCommandAndGetSingleOutput(localFailureMessage, repository, ProcessMode.DEFAULT_CAPTURE, "rev-parse", "HEAD");
    String remoteCommitId = runGitCommandAndGetSingleOutput(remoteFailureMessage, repository, ProcessMode.DEFAULT_CAPTURE, "rev-parse", "@{u}");
    if ((localCommitId == null) || (remoteCommitId == null)) {
      return false;
    }
    return !localCommitId.equals(remoteCommitId);
  }

  @Override
  public boolean isRepositoryUpdateAvailable(Path repository, Path trackedCommitIdPath) {

    String trackedCommitId;
    try {
      trackedCommitId = Files.readString(trackedCommitIdPath);
    } catch (IOException e) {
      return false;
    }
    String remoteFailureMessage = String.format("Failed to get the remote commit id of settings repository '%s', missing remote upstream branch?", repository);
    String remoteCommitId = runGitCommandAndGetSingleOutput(remoteFailureMessage, repository, ProcessMode.DEFAULT_CAPTURE, "rev-parse", "@{u}");
    return !trackedCommitId.equals(remoteCommitId);
  }

  @Override
  public void pullOrCloneAndResetIfNeeded(GitUrl gitUrl, Path repository, String remoteName) {

    pullOrCloneIfNeeded(gitUrl, repository);
    reset(repository, gitUrl.branch(), remoteName);
    cleanup(repository);
  }

  @Override
  public void pullOrClone(GitUrl gitUrl, Path repository) {

    Objects.requireNonNull(repository);
    Objects.requireNonNull(gitUrl);
    if (Files.isDirectory(repository.resolve(GIT_FOLDER))) {
      // checks for remotes
      String remote = determineRemote(repository);
      if (remote == null) {
        String message = repository + " is a local git repository with no remote - if you did this for testing, you may continue...\n"
            + "Do you want to ignore the problem and continue anyhow?";
        this.context.askToContinue(message);
      } else {
        pull(repository);
      }
    } else {
      clone(gitUrl, repository);
    }
  }

  /**
   * Handles errors which occurred during git pull.
   *
   * @param targetRepository the {@link Path} to the target folder where the git repository should be cloned or pulled. It is not the parent directory where
   *     git will by default create a sub-folder by default on clone but the * final folder that will contain the ".git" subfolder.
   * @param result the {@link ProcessResult} to evaluate.
   */
  private void handleErrors(Path targetRepository, ProcessResult result) {

    if (!result.isSuccessful()) {
      String message = "Failed to update git repository at " + targetRepository;
      if (this.context.isOfflineMode()) {
        LOG.warn(message);
        LOG.info(IdeLogLevel.INTERACTION.getSlf4jMarker(), "Continuing as we are in offline mode - results may be outdated!");
      } else {
        LOG.error(message);
        if (this.context.isOnline()) {
          LOG.error("See above error for details. If you have local changes, please stash or revert and retry.");
        } else {
          LOG.error("It seems you are offline - please ensure Internet connectivity and retry or activate offline mode (-o or --offline).");
        }
        this.context.askToContinue("Typically you should abort and fix the problem. Do you want to continue anyways?");
      }
    }
  }

  @Override
  public void clone(GitUrl gitUrl, Path repository) {

    GitUrlSyntax gitUrlSyntax = IdeVariables.PREFERRED_GIT_PROTOCOL.get(getContext());
    gitUrl = gitUrlSyntax.format(gitUrl);
    if (this.context.isOfflineMode()) {
      this.context.requireOnline("git clone of " + gitUrl, false);
    }
    this.context.getFileAccess().mkdirs(repository);
    List<String> args = new ArrayList<>(7);
    args.add("clone");
    if (this.context.isQuietMode()) {
      args.add("-q");
    }
    args.add("--recursive");
    args.add(gitUrl.url());
    args.add("--config");
    args.add("core.autocrlf=false");
    args.add(".");
    runGitCommand(repository, args);
    String branch = gitUrl.branch();
    if (branch != null) {
      runGitCommand(repository, "switch", branch);
    }
  }

  @Override
  public void pull(Path repository) {

    if (this.context.isOffline()) {
      LOG.info("Skipping git pull on {} because offline", repository);
      return;
    }
    ProcessResult result = runGitCommand(repository, ProcessMode.DEFAULT, "--no-pager", "pull", "--quiet");
    if (!result.isSuccessful()) {
      String branchName = determineCurrentBranch(repository);
      LOG.warn("Git pull on branch {} failed for repository {}.", branchName, repository);
      handleErrors(repository, result);
    }
  }

  @Override
  public void fetch(Path repository, String remote, String branch) {

    if (branch == null) {
      branch = determineCurrentBranch(repository);
    }
    if (remote == null) {
      remote = determineRemote(repository);
    }

    ProcessResult result = runGitCommand(repository, ProcessMode.DEFAULT_CAPTURE, "fetch", Objects.requireNonNullElse(remote, "origin"), branch);

    if (!result.isSuccessful()) {
      LOG.warn("Git fetch for '{}/{} failed.'.", remote, branch);
    }
  }

  @Override
  public String determineCurrentBranch(Path repository) {

    return runGitCommandAndGetSingleOutput("Failed to determine current branch of git repository", repository, "branch", "--show-current");
  }

  @Override
  public String determineRemote(Path repository) {

    return runGitCommandAndGetSingleOutput("Failed to determine current origin of git repository.", repository, "remote");
  }

  @Override
  public void reset(Path repository, String branchName, String remoteName) {

    if ((remoteName == null) || remoteName.isEmpty()) {
      remoteName = DEFAULT_REMOTE;
    }
    if ((branchName == null) || branchName.isEmpty()) {
      branchName = GitUrl.BRANCH_MASTER;
    }
    ProcessResult result = runGitCommand(repository, ProcessMode.DEFAULT, "diff-index", "--quiet", "HEAD");
    if (!result.isSuccessful()) {
      // reset to origin/master
      LOG.warn("Git has detected modified files -- attempting to reset {} to '{}/{}'.", repository, remoteName, branchName);
      result = runGitCommand(repository, ProcessMode.DEFAULT, "reset", "--hard", remoteName + "/" + branchName);
      if (!result.isSuccessful()) {
        LOG.warn("Git failed to reset {} to '{}/{}'.", remoteName, branchName, repository);
        handleErrors(repository, result);
      }
    }
  }

  @Override
  public void cleanup(Path repository) {

    // check for untracked files
    ProcessResult result = runGitCommand(repository, ProcessMode.DEFAULT_CAPTURE, "ls-files", "--other", "--directory", "--exclude-standard");
    if (!result.getOut().isEmpty()) {
      // delete untracked files
      LOG.warn("Git detected untracked files in {} and is attempting a cleanup.", repository);
      runGitCommand(repository, "clean", "-df");
    }
  }

  @Override
  public String retrieveGitUrl(Path repository) {

    return runGitCommandAndGetSingleOutput("Failed to retrieve git URL for repository", repository, "config", "--get", "remote.origin.url");
  }

  IdeContext getContext() {

    return this.context;
  }

  @Override
  public Path findGitRequired() {

    Path gitPath = findGit();
    if (gitPath == null) {
      String message = "Git " + IdeContext.IS_NOT_INSTALLED_BUT_REQUIRED;
      if (SystemInfoImpl.INSTANCE.isWindows()) {
        message += IdeContext.PLEASE_DOWNLOAD_AND_INSTALL_GIT + ":\n "
            + IdeContext.WINDOWS_GIT_DOWNLOAD_URL;
      }
      throw new CliException(message);
    }
    return gitPath;
  }

  @Override
  public Path findGit() {
    if (this.git != null) {
      return this.git;
    }

    Path gitPath = findGitInPath(Path.of("git"));

    if (gitPath == null) {
      if (SystemInfoImpl.INSTANCE.isWindows()) {
        gitPath = findGitOnWindowsViaBash();
      }
    }

    if (gitPath != null) {
      this.git = gitPath;
      LOG.trace("Found git at: {}", gitPath);
    }

    return gitPath;
  }

  private Path findGitOnWindowsViaBash() {
    Path gitPath;
    Path bashBinary = this.context.findBashRequired();
    LOG.trace("Trying to find git path on Windows");
    if (Files.exists(bashBinary)) {
      gitPath = bashBinary.getParent().resolve("git.exe");
      if (Files.exists(gitPath)) {
        LOG.trace("Git path was extracted from bash path at: {}", gitPath);
      } else {
        LOG.error("Git path: {} was extracted from bash path at: {} but it does not exist", gitPath, bashBinary);
        return null;
      }
    } else {
      LOG.error("Bash path was checked at: {} but it does not exist", bashBinary);
      return null;
    }
    return gitPath;
  }

  private Path findGitInPath(Path gitPath) {
    LOG.trace("Trying to find git executable within the PATH environment variable");
    Path binaryGitPath = this.context.getPath().findBinary(gitPath);
    if (gitPath == binaryGitPath) {
      LOG.debug("No git executable could be found within the PATH environment variable");
      return null;
    }
    return binaryGitPath;
  }

  private void runGitCommand(Path directory, String... args) {

    ProcessResult result = runGitCommand(directory, ProcessMode.DEFAULT, args);
    if (!result.isSuccessful()) {
      String command = result.getCommand();
      this.context.requireOnline(command, false);
      result.failOnError();
    }
  }

  private void runGitCommand(Path directory, List<String> args) {

    runGitCommand(directory, args.toArray(String[]::new));
  }

  private String runGitCommandAndGetSingleOutput(String warningOnError, Path directory, String... args) {

    return runGitCommandAndGetSingleOutput(warningOnError, directory, ProcessMode.DEFAULT_CAPTURE, args);
  }

  private String runGitCommandAndGetSingleOutput(String warningOnError, Path directory, ProcessMode mode, String... args) {
    ProcessErrorHandling errorHandling = ProcessErrorHandling.NONE;
    if (LOG.isDebugEnabled()) {
      errorHandling = ProcessErrorHandling.LOG_WARNING;
    }
    ProcessResult result = runGitCommand(directory, mode, errorHandling, args);
    if (result.isSuccessful()) {
      List<String> out = result.getOut();
      int size = out.size();
      if (size == 1) {
        return out.getFirst();
      } else if (size == 0) {
        warningOnError += " - No output received from " + result.getCommand();
      } else {
        warningOnError += " - Expected single line of output but received " + size + " lines from " + result.getCommand();
      }
    }
    LOG.warn(warningOnError);
    return null;
  }

  private ProcessResult runGitCommand(Path directory, ProcessMode mode, String... args) {

    return runGitCommand(directory, mode, ProcessErrorHandling.LOG_WARNING, args);
  }

  private ProcessResult runGitCommand(Path directory, ProcessMode mode, ProcessErrorHandling errorHandling, String... args) {

    ProcessContext processContext;

    if (this.context.isBatchMode()) {
      processContext = this.context.newProcess().executable(findGitRequired()).withEnvVar("GIT_TERMINAL_PROMPT", "0").withEnvVar("GCM_INTERACTIVE", "never")
          .withEnvVar("GIT_ASKPASS", "echo").withEnvVar("SSH_ASKPASS", "echo").errorHandling(errorHandling).directory(directory);
    } else {
      processContext = this.context.newProcess().executable(findGitRequired()).errorHandling(errorHandling)
          .directory(directory);
    }

    processContext.addArgs(args);
    return processContext.run(mode);
  }

  @Override
  public void saveCurrentCommitId(Path repository, Path trackedCommitIdPath) {

    if ((repository == null) || (trackedCommitIdPath == null)) {
      LOG.warn("Invalid usage of saveCurrentCommitId with null value");
      return;
    }
    LOG.trace("Saving commit Id of {} into {}", repository, trackedCommitIdPath);
    String currentCommitId = determineCurrentCommitId(repository);
    if (currentCommitId != null) {
      try {
        Files.writeString(trackedCommitIdPath, currentCommitId);
      } catch (IOException e) {
        throw new IllegalStateException("Failed to save commit ID", e);
      }
    }
  }

  /**
   * @param repository the {@link Path} to the git repository.
   * @return the current commit ID of the given {@link Path repository}.
   */
  protected String determineCurrentCommitId(Path repository) {
    return runGitCommandAndGetSingleOutput("Failed to get current commit id.", repository, "rev-parse", FILE_HEAD);
  }
}



1	package com.devonfw.tools.ide.git;
2
3	import java.io.IOException;
4	import java.nio.file.Files;
5	import java.nio.file.Path;
6	import java.util.ArrayList;
7	import java.util.List;
8	import java.util.Objects;
9
10	import org.slf4j.Logger;
11	import org.slf4j.LoggerFactory;
12
13	import com.devonfw.tools.ide.cli.CliException;
14	import com.devonfw.tools.ide.context.IdeContext;
15	import com.devonfw.tools.ide.log.IdeLogLevel;
16	import com.devonfw.tools.ide.os.SystemInfoImpl;
17	import com.devonfw.tools.ide.process.ProcessContext;
18	import com.devonfw.tools.ide.process.ProcessErrorHandling;
19	import com.devonfw.tools.ide.process.ProcessMode;
20	import com.devonfw.tools.ide.process.ProcessResult;
21	import com.devonfw.tools.ide.variable.IdeVariables;
22
23	/**
24	* Implements the {@link GitContext}.
25	*/
26	public class GitContextImpl implements GitContext {
27
28	private static final Logger LOG = LoggerFactory.getLogger(GitContextImpl.class);	4✔
29
30	/** @see #getContext() */
31	protected final IdeContext context;
32	private Path git;
33
34	/**
35	* @param context the {@link IdeContext context}.
36	*/
37	public GitContextImpl(IdeContext context) {	2✔
38
39	this.context = context;	3✔
40	}	1✔
41
42	@Override
43	public void pullOrCloneIfNeeded(GitUrl gitUrl, Path repository) {
44
45	GitOperation.PULL_OR_CLONE.executeIfNeeded(this.context, gitUrl, repository, null);	8✔
46	}	1✔
47
48	@Override
49	public boolean fetchIfNeeded(Path repository) {
50
51	return fetchIfNeeded(repository, null, null);	×
52	}
53
54	@Override
55	public boolean fetchIfNeeded(Path repository, String remote, String branch) {
56
57	return GitOperation.FETCH.executeIfNeeded(this.context, new GitUrl("https://dummy.url/repo.git", branch), repository, remote);	12✔
58	}
59
60	@Override
61	public boolean isRepositoryUpdateAvailable(Path repository) {
62
63	String localFailureMessage = String.format("Failed to get the local commit id of settings repository '%s'.", repository);	9✔
64	String remoteFailureMessage = String.format("Failed to get the remote commit id of settings repository '%s', missing remote upstream branch?", repository);	9✔
65	String localCommitId = runGitCommandAndGetSingleOutput(localFailureMessage, repository, ProcessMode.DEFAULT_CAPTURE, "rev-parse", "HEAD");	16✔
66	String remoteCommitId = runGitCommandAndGetSingleOutput(remoteFailureMessage, repository, ProcessMode.DEFAULT_CAPTURE, "rev-parse", "@{u}");	16✔
67	if ((localCommitId == null) \|\| (remoteCommitId == null)) {	2!
68	return false;	2✔
69	}
70	return !localCommitId.equals(remoteCommitId);	×
71	}
72
73	@Override
74	public boolean isRepositoryUpdateAvailable(Path repository, Path trackedCommitIdPath) {
75
76	String trackedCommitId;
77	try {
78	trackedCommitId = Files.readString(trackedCommitIdPath);	×
79	} catch (IOException e) {	×
80	return false;	×
81	}	×
82	String remoteFailureMessage = String.format("Failed to get the remote commit id of settings repository '%s', missing remote upstream branch?", repository);	×
83	String remoteCommitId = runGitCommandAndGetSingleOutput(remoteFailureMessage, repository, ProcessMode.DEFAULT_CAPTURE, "rev-parse", "@{u}");	×
84	return !trackedCommitId.equals(remoteCommitId);	×
85	}
86
87	@Override
88	public void pullOrCloneAndResetIfNeeded(GitUrl gitUrl, Path repository, String remoteName) {
89
90	pullOrCloneIfNeeded(gitUrl, repository);	4✔
91	reset(repository, gitUrl.branch(), remoteName);	6✔
92	cleanup(repository);	3✔
93	}	1✔
94
95	@Override
96	public void pullOrClone(GitUrl gitUrl, Path repository) {
97
98	Objects.requireNonNull(repository);	3✔
99	Objects.requireNonNull(gitUrl);	3✔
100	if (Files.isDirectory(repository.resolve(GIT_FOLDER))) {	7✔
101	// checks for remotes
102	String remote = determineRemote(repository);	4✔
103	if (remote == null) {	2!
104	String message = repository + " is a local git repository with no remote - if you did this for testing, you may continue...\n"	×
105	+ "Do you want to ignore the problem and continue anyhow?";
106	this.context.askToContinue(message);	×
107	} else {	×
108	pull(repository);	3✔
109	}
110	} else {	1✔
111	clone(gitUrl, repository);	4✔
112	}
113	}	1✔
114
115	/**
116	* Handles errors which occurred during git pull.
117	*
118	* @param targetRepository the {@link Path} to the target folder where the git repository should be cloned or pulled. It is not the parent directory where
119	* git will by default create a sub-folder by default on clone but the * final folder that will contain the ".git" subfolder.
120	* @param result the {@link ProcessResult} to evaluate.
121	*/
122	private void handleErrors(Path targetRepository, ProcessResult result) {
123
124	if (!result.isSuccessful()) {	×
125	String message = "Failed to update git repository at " + targetRepository;	×
126	if (this.context.isOfflineMode()) {	×
127	LOG.warn(message);	×
128	LOG.info(IdeLogLevel.INTERACTION.getSlf4jMarker(), "Continuing as we are in offline mode - results may be outdated!");	×
129	} else {
130	LOG.error(message);	×
131	if (this.context.isOnline()) {	×
132	LOG.error("See above error for details. If you have local changes, please stash or revert and retry.");	×
133	} else {
134	LOG.error("It seems you are offline - please ensure Internet connectivity and retry or activate offline mode (-o or --offline).");	×
135	}
136	this.context.askToContinue("Typically you should abort and fix the problem. Do you want to continue anyways?");	×
137	}
138	}
139	}	×
140
141	@Override
142	public void clone(GitUrl gitUrl, Path repository) {
143
144	GitUrlSyntax gitUrlSyntax = IdeVariables.PREFERRED_GIT_PROTOCOL.get(getContext());	6✔
145	gitUrl = gitUrlSyntax.format(gitUrl);	4✔
146	if (this.context.isOfflineMode()) {	4✔
147	this.context.requireOnline("git clone of " + gitUrl, false);	×
148	}
149	this.context.getFileAccess().mkdirs(repository);	5✔
150	List<String> args = new ArrayList<>(7);	5✔
151	args.add("clone");	4✔
152	if (this.context.isQuietMode()) {	4!
153	args.add("-q");	×
154	}
155	args.add("--recursive");	4✔
156	args.add(gitUrl.url());	5✔
157	args.add("--config");	4✔
158	args.add("core.autocrlf=false");	4✔
159	args.add(".");	4✔
160	runGitCommand(repository, args);	4✔
161	String branch = gitUrl.branch();	3✔
162	if (branch != null) {	2!
163	runGitCommand(repository, "switch", branch);	×
164	}
165	}	1✔
166
167	@Override
168	public void pull(Path repository) {
169
170	if (this.context.isOffline()) {	4!
171	LOG.info("Skipping git pull on {} because offline", repository);	×
172	return;	×
173	}
174	ProcessResult result = runGitCommand(repository, ProcessMode.DEFAULT, "--no-pager", "pull", "--quiet");	19✔
175	if (!result.isSuccessful()) {	3!
176	String branchName = determineCurrentBranch(repository);	×
177	LOG.warn("Git pull on branch {} failed for repository {}.", branchName, repository);	×
178	handleErrors(repository, result);	×
179	}
180	}	1✔
181
182	@Override
183	public void fetch(Path repository, String remote, String branch) {
184
185	if (branch == null) {	2!
186	branch = determineCurrentBranch(repository);	×
187	}
188	if (remote == null) {	2!
189	remote = determineRemote(repository);	×
190	}
191
192	ProcessResult result = runGitCommand(repository, ProcessMode.DEFAULT_CAPTURE, "fetch", Objects.requireNonNullElse(remote, "origin"), branch);	22✔
193
194	if (!result.isSuccessful()) {	3!
195	LOG.warn("Git fetch for '{}/{} failed.'.", remote, branch);	×
196	}
197	}	1✔
198
199	@Override
200	public String determineCurrentBranch(Path repository) {
201
202	return runGitCommandAndGetSingleOutput("Failed to determine current branch of git repository", repository, "branch", "--show-current");	×
203	}
204
205	@Override
206	public String determineRemote(Path repository) {
207
208	return runGitCommandAndGetSingleOutput("Failed to determine current origin of git repository.", repository, "remote");	11✔
209	}
210
211	@Override
212	public void reset(Path repository, String branchName, String remoteName) {
213
214	if ((remoteName == null) \|\| remoteName.isEmpty()) {	5!
215	remoteName = DEFAULT_REMOTE;	2✔
216	}
217	if ((branchName == null) \|\| branchName.isEmpty()) {	5!
218	branchName = GitUrl.BRANCH_MASTER;	2✔
219	}
220	ProcessResult result = runGitCommand(repository, ProcessMode.DEFAULT, "diff-index", "--quiet", "HEAD");	19✔
221	if (!result.isSuccessful()) {	3!
222	// reset to origin/master
223	LOG.warn("Git has detected modified files -- attempting to reset {} to '{}/{}'.", repository, remoteName, branchName);	17✔
224	result = runGitCommand(repository, ProcessMode.DEFAULT, "reset", "--hard", remoteName + "/" + branchName);	21✔
225	if (!result.isSuccessful()) {	3!
226	LOG.warn("Git failed to reset {} to '{}/{}'.", remoteName, branchName, repository);	×
227	handleErrors(repository, result);	×
228	}
229	}
230	}	1✔
231
232	@Override
233	public void cleanup(Path repository) {
234
235	// check for untracked files
236	ProcessResult result = runGitCommand(repository, ProcessMode.DEFAULT_CAPTURE, "ls-files", "--other", "--directory", "--exclude-standard");	23✔
237	if (!result.getOut().isEmpty()) {	4✔
238	// delete untracked files
239	LOG.warn("Git detected untracked files in {} and is attempting a cleanup.", repository);	4✔
240	runGitCommand(repository, "clean", "-df");	13✔
241	}
242	}	1✔
243
244	@Override
245	public String retrieveGitUrl(Path repository) {
246
247	return runGitCommandAndGetSingleOutput("Failed to retrieve git URL for repository", repository, "config", "--get", "remote.origin.url");	×
248	}
249
250	IdeContext getContext() {
251
252	return this.context;	3✔
253	}
254
255	@Override
256	public Path findGitRequired() {
257
258	Path gitPath = findGit();	×
259	if (gitPath == null) {	×
260	String message = "Git " + IdeContext.IS_NOT_INSTALLED_BUT_REQUIRED;	×
261	if (SystemInfoImpl.INSTANCE.isWindows()) {	×
262	message += IdeContext.PLEASE_DOWNLOAD_AND_INSTALL_GIT + ":\n "	×
263	+ IdeContext.WINDOWS_GIT_DOWNLOAD_URL;
264	}
265	throw new CliException(message);	×
266	}
267	return gitPath;	×
268	}
269
270	@Override
271	public Path findGit() {
272	if (this.git != null) {	×
273	return this.git;	×
274	}
275
276	Path gitPath = findGitInPath(Path.of("git"));	×
277
278	if (gitPath == null) {	×
279	if (SystemInfoImpl.INSTANCE.isWindows()) {	×
280	gitPath = findGitOnWindowsViaBash();	×
281	}
282	}
283
284	if (gitPath != null) {	×
285	this.git = gitPath;	×
286	LOG.trace("Found git at: {}", gitPath);	×
287	}
288
289	return gitPath;	×
290	}
291
292	private Path findGitOnWindowsViaBash() {
293	Path gitPath;
294	Path bashBinary = this.context.findBashRequired();	×
295	LOG.trace("Trying to find git path on Windows");	×
296	if (Files.exists(bashBinary)) {	×
297	gitPath = bashBinary.getParent().resolve("git.exe");	×
298	if (Files.exists(gitPath)) {	×
299	LOG.trace("Git path was extracted from bash path at: {}", gitPath);	×
300	} else {
301	LOG.error("Git path: {} was extracted from bash path at: {} but it does not exist", gitPath, bashBinary);	×
302	return null;	×
303	}
304	} else {
305	LOG.error("Bash path was checked at: {} but it does not exist", bashBinary);	×
306	return null;	×
307	}
308	return gitPath;	×
309	}
310
311	private Path findGitInPath(Path gitPath) {
312	LOG.trace("Trying to find git executable within the PATH environment variable");	×
313	Path binaryGitPath = this.context.getPath().findBinary(gitPath);	×
314	if (gitPath == binaryGitPath) {	×
315	LOG.debug("No git executable could be found within the PATH environment variable");	×
316	return null;	×
317	}
318	return binaryGitPath;	×
319	}
320
321	private void runGitCommand(Path directory, String... args) {
322
323	ProcessResult result = runGitCommand(directory, ProcessMode.DEFAULT, args);	6✔
324	if (!result.isSuccessful()) {	3!
325	String command = result.getCommand();	×
326	this.context.requireOnline(command, false);	×
327	result.failOnError();	×
328	}
329	}	1✔
330
331	private void runGitCommand(Path directory, List<String> args) {
332
333	runGitCommand(directory, args.toArray(String[]::new));	10✔
334	}	1✔
335
336	private String runGitCommandAndGetSingleOutput(String warningOnError, Path directory, String... args) {
337
338	return runGitCommandAndGetSingleOutput(warningOnError, directory, ProcessMode.DEFAULT_CAPTURE, args);	7✔
339	}
340
341	private String runGitCommandAndGetSingleOutput(String warningOnError, Path directory, ProcessMode mode, String... args) {
342	ProcessErrorHandling errorHandling = ProcessErrorHandling.NONE;	2✔
343	if (LOG.isDebugEnabled()) {	3!
344	errorHandling = ProcessErrorHandling.LOG_WARNING;	2✔
345	}
346	ProcessResult result = runGitCommand(directory, mode, errorHandling, args);	7✔
347	if (result.isSuccessful()) {	3!
348	List<String> out = result.getOut();	3✔
349	int size = out.size();	3✔
350	if (size == 1) {	3✔
351	return out.getFirst();	4✔
352	} else if (size == 0) {	2!
353	warningOnError += " - No output received from " + result.getCommand();	6✔
354	} else {
355	warningOnError += " - Expected single line of output but received " + size + " lines from " + result.getCommand();	×
356	}
357	}
358	LOG.warn(warningOnError);	3✔
359	return null;	2✔
360	}
361
362	private ProcessResult runGitCommand(Path directory, ProcessMode mode, String... args) {
363
364	return runGitCommand(directory, mode, ProcessErrorHandling.LOG_WARNING, args);	7✔
365	}
366
367	private ProcessResult runGitCommand(Path directory, ProcessMode mode, ProcessErrorHandling errorHandling, String... args) {
368
369	ProcessContext processContext;
370
371	if (this.context.isBatchMode()) {	4!
372	processContext = this.context.newProcess().executable(findGitRequired()).withEnvVar("GIT_TERMINAL_PROMPT", "0").withEnvVar("GCM_INTERACTIVE", "never")	×
373	.withEnvVar("GIT_ASKPASS", "echo").withEnvVar("SSH_ASKPASS", "echo").errorHandling(errorHandling).directory(directory);	×
374	} else {
375	processContext = this.context.newProcess().executable(findGitRequired()).errorHandling(errorHandling)	9✔
376	.directory(directory);	2✔
377	}
378
379	processContext.addArgs(args);	4✔
380	return processContext.run(mode);	4✔
381	}
382
383	@Override
384	public void saveCurrentCommitId(Path repository, Path trackedCommitIdPath) {
385
386	if ((repository == null) \|\| (trackedCommitIdPath == null)) {	4!
387	LOG.warn("Invalid usage of saveCurrentCommitId with null value");	×
388	return;	×
389	}
390	LOG.trace("Saving commit Id of {} into {}", repository, trackedCommitIdPath);	5✔
391	String currentCommitId = determineCurrentCommitId(repository);	4✔
392	if (currentCommitId != null) {	2!
393	try {
394	Files.writeString(trackedCommitIdPath, currentCommitId);	6✔
395	} catch (IOException e) {	×
396	throw new IllegalStateException("Failed to save commit ID", e);	×
397	}	1✔
398	}
399	}	1✔
400
401	/**
402	* @param repository the {@link Path} to the git repository.
403	* @return the current commit ID of the given {@link Path repository}.
404	*/
405	protected String determineCurrentCommitId(Path repository) {
406	return runGitCommandAndGetSingleOutput("Failed to get current commit id.", repository, "rev-parse", FILE_HEAD);	×
407	}
408	}
409
410

devonfw / IDEasy / 22241505980

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