11560364436

Committed 28 Oct 2024 06:31PM UTC coverage: 66.705% (-0.04%) from 66.746%

Build # 11560364436

Build Type

push

github

Committed by

web-flow

Commit Message

#710: make workspace configuration robust (#719)

Run Details

2406 of 3950 branches covered (60.91%)

Branch coverage included in aggregate %.

6275 of 9064 relevant lines covered (69.23%)

3.05 hits per line

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

63.38

cli/src/main/java/com/devonfw/tools/ide/tool/eclipse/Eclipse.java

package com.devonfw.tools.ide.tool.eclipse;

import java.io.File;
import java.io.RandomAccessFile;
import java.nio.channels.FileLock;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.Set;

import com.devonfw.tools.ide.cli.CliException;
import com.devonfw.tools.ide.common.Tag;
import com.devonfw.tools.ide.context.IdeContext;
import com.devonfw.tools.ide.log.IdeLogLevel;
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.step.Step;
import com.devonfw.tools.ide.tool.ide.IdeToolCommandlet;
import com.devonfw.tools.ide.tool.java.Java;
import com.devonfw.tools.ide.tool.plugin.ToolPluginDescriptor;

/**
 * {@link IdeToolCommandlet} for <a href="https://www.eclipse.org/">Eclipse</a>.
 */
public class Eclipse extends IdeToolCommandlet {

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

    super(context, "eclipse", Set.of(Tag.ECLIPSE));
  }

  @Override
  protected void configureToolBinary(ProcessContext pc, ProcessMode processMode, ProcessErrorHandling errorHandling) {

    if ((processMode == ProcessMode.DEFAULT_CAPTURE) && this.context.getSystemInfo().isWindows()) {
      pc.executable(Path.of("eclipsec"));
    } else {
      super.configureToolBinary(pc, processMode, errorHandling);
    }
  }

  @Override
  protected void configureToolArgs(ProcessContext pc, ProcessMode processMode, ProcessErrorHandling errorHandling, String... args) {

    // configure workspace location
    pc.addArg("-data").addArg(this.context.getWorkspacePath());
    // use keyring from user home to keep secrets and share across projects and workspaces
    pc.addArg("-keyring").addArg(this.context.getUserHome().resolve(".eclipse").resolve(".keyring"));
    // use isolated plugins folder from project instead of modifying eclipse installation in software repo on plugin installation
    pc.addArg("-configuration").addArg(getPluginsInstallationPath().resolve("configuration"));
    if (processMode == ProcessMode.BACKGROUND) {
      // to start eclipse as GUI
      pc.addArg("gui").addArg("-showlocation").addArg(this.context.getIdeHome().getFileName());
    } else if (processMode == ProcessMode.DEFAULT_CAPTURE) {
      pc.addArg("-consoleLog").addArg("-nosplash");
    }
    super.configureToolArgs(pc, processMode, errorHandling, args);
  }

  @Override
  protected void installDependencies() {

    // TODO create eclipse/eclipse/dependencies.json file in ide-urls and delete this method
    getCommandlet(Java.class).install();
  }

  @Override
  protected boolean isPluginUrlNeeded() {

    return true;
  }

  @Override
  public void installPlugin(ToolPluginDescriptor plugin, Step step) {

    ProcessResult result = runTool(ProcessMode.DEFAULT_CAPTURE, null, ProcessErrorHandling.LOG_WARNING, "-application", "org.eclipse.equinox.p2.director",
        "-repository", plugin.url(), "-installIU", plugin.id());
    if (result.isSuccessful()) {
      for (String line : result.getOut()) {
        if (line.contains("Overall install request is satisfiable")) {
          step.success();
          return;
        }
      }
    }
    log(IdeLogLevel.DEBUG, result.getOut());
    log(IdeLogLevel.ERROR, result.getErr());
    step.error("Failed to install plugin {} ({}): exit code was {}", plugin.name(), plugin.id(), result.getExitCode());
  }

  private void log(IdeLogLevel level, List<String> lines) {

    for (String line : lines) {
      if (line.startsWith("!MESSAGE ")) {
        line = line.substring(9);
      }
      this.context.level(level).log(line);
    }
  }

  @Override
  protected void configureWorkspace() {

    Path lockfile = this.context.getWorkspacePath().resolve(".metadata/.lock");
    if (isLocked(lockfile)) {
      throw new CliException("Your workspace is locked at " + lockfile);
    }
    super.configureWorkspace();
  }

  /**
   * @param lockfile the {@link File} pointing to the lockfile to check.
   * @return {@code true} if the given {@link File} is locked, {@code false} otherwise.
   */
  private static boolean isLocked(Path lockfile) {

    if (Files.isRegularFile(lockfile)) {
      try (RandomAccessFile raFile = new RandomAccessFile(lockfile.toFile(), "rw")) {
        FileLock fileLock = raFile.getChannel().tryLock(0, 1, false);
        // success, file was not locked so we immediately unlock again...
        fileLock.release();
        return false;
      } catch (Exception e) {
        return true;
      }
    }
    return false;
  }

}

1	package com.devonfw.tools.ide.tool.eclipse;
2
3	import java.io.File;
4	import java.io.RandomAccessFile;
5	import java.nio.channels.FileLock;
6	import java.nio.file.Files;
7	import java.nio.file.Path;
8	import java.util.List;
9	import java.util.Set;
10
11	import com.devonfw.tools.ide.cli.CliException;
12	import com.devonfw.tools.ide.common.Tag;
13	import com.devonfw.tools.ide.context.IdeContext;
14	import com.devonfw.tools.ide.log.IdeLogLevel;
15	import com.devonfw.tools.ide.process.ProcessContext;
16	import com.devonfw.tools.ide.process.ProcessErrorHandling;
17	import com.devonfw.tools.ide.process.ProcessMode;
18	import com.devonfw.tools.ide.process.ProcessResult;
19	import com.devonfw.tools.ide.step.Step;
20	import com.devonfw.tools.ide.tool.ide.IdeToolCommandlet;
21	import com.devonfw.tools.ide.tool.java.Java;
22	import com.devonfw.tools.ide.tool.plugin.ToolPluginDescriptor;
23
24	/**
25	* {@link IdeToolCommandlet} for <a href="https://www.eclipse.org/">Eclipse</a>.
26	*/
27	public class Eclipse extends IdeToolCommandlet {
28
29	/**
30	* The constructor.
31	*
32	* @param context the {@link IdeContext}.
33	*/
34	public Eclipse(IdeContext context) {
35
36	super(context, "eclipse", Set.of(Tag.ECLIPSE));	6✔
37	}	1✔
38
39	@Override
40	protected void configureToolBinary(ProcessContext pc, ProcessMode processMode, ProcessErrorHandling errorHandling) {
41
42	if ((processMode == ProcessMode.DEFAULT_CAPTURE) && this.context.getSystemInfo().isWindows()) {	8✔
43	pc.executable(Path.of("eclipsec"));	8✔
44	} else {
45	super.configureToolBinary(pc, processMode, errorHandling);	5✔
46	}
47	}	1✔
48
49	@Override
50	protected void configureToolArgs(ProcessContext pc, ProcessMode processMode, ProcessErrorHandling errorHandling, String... args) {
51
52	// configure workspace location
53	pc.addArg("-data").addArg(this.context.getWorkspacePath());	8✔
54	// use keyring from user home to keep secrets and share across projects and workspaces
55	pc.addArg("-keyring").addArg(this.context.getUserHome().resolve(".eclipse").resolve(".keyring"));	12✔
56	// use isolated plugins folder from project instead of modifying eclipse installation in software repo on plugin installation
57	pc.addArg("-configuration").addArg(getPluginsInstallationPath().resolve("configuration"));	9✔
58	if (processMode == ProcessMode.BACKGROUND) {	3✔
59	// to start eclipse as GUI
60	pc.addArg("gui").addArg("-showlocation").addArg(this.context.getIdeHome().getFileName());	12✔
61	} else if (processMode == ProcessMode.DEFAULT_CAPTURE) {	3!
62	pc.addArg("-consoleLog").addArg("-nosplash");	6✔
63	}
64	super.configureToolArgs(pc, processMode, errorHandling, args);	6✔
65	}	1✔
66
67	@Override
68	protected void installDependencies() {
69
70	// TODO create eclipse/eclipse/dependencies.json file in ide-urls and delete this method
71	getCommandlet(Java.class).install();	6✔
72	}	1✔
73
74	@Override
75	protected boolean isPluginUrlNeeded() {
76
77	return true;	2✔
78	}
79
80	@Override
81	public void installPlugin(ToolPluginDescriptor plugin, Step step) {
82
83	ProcessResult result = runTool(ProcessMode.DEFAULT_CAPTURE, null, ProcessErrorHandling.LOG_WARNING, "-application", "org.eclipse.equinox.p2.director",	23✔
84	"-repository", plugin.url(), "-installIU", plugin.id());	11✔
85	if (result.isSuccessful()) {	3!
86	for (String line : result.getOut()) {	11!
87	if (line.contains("Overall install request is satisfiable")) {	4✔
88	step.success();	2✔
89	return;	1✔
90	}
91	}	1✔
92	}
93	log(IdeLogLevel.DEBUG, result.getOut());	×
94	log(IdeLogLevel.ERROR, result.getErr());	×
95	step.error("Failed to install plugin {} ({}): exit code was {}", plugin.name(), plugin.id(), result.getExitCode());	×
96	}	×
97
98	private void log(IdeLogLevel level, List<String> lines) {
99
100	for (String line : lines) {	×
101	if (line.startsWith("!MESSAGE ")) {	×
102	line = line.substring(9);	×
103	}
104	this.context.level(level).log(line);	×
105	}	×
106	}	×
107
108	@Override
109	protected void configureWorkspace() {
110
111	Path lockfile = this.context.getWorkspacePath().resolve(".metadata/.lock");	6✔
112	if (isLocked(lockfile)) {	3!
113	throw new CliException("Your workspace is locked at " + lockfile);	×
114	}
115	super.configureWorkspace();	2✔
116	}	1✔
117
118	/**
119	* @param lockfile the {@link File} pointing to the lockfile to check.
120	* @return {@code true} if the given {@link File} is locked, {@code false} otherwise.
121	*/
122	private static boolean isLocked(Path lockfile) {
123
124	if (Files.isRegularFile(lockfile)) {	5!
125	try (RandomAccessFile raFile = new RandomAccessFile(lockfile.toFile(), "rw")) {	×
126	FileLock fileLock = raFile.getChannel().tryLock(0, 1, false);	×
127	// success, file was not locked so we immediately unlock again...
128	fileLock.release();	×
129	return false;	×
130	} catch (Exception e) {	×
131	return true;	×
132	}
133	}
134	return false;	2✔
135	}
136
137	}

devonfw / IDEasy / 11560364436

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