resultOnEr
}
}
+ /**
+ * @param error the {@link Throwable} that occurred inside a {@link Step}.
+ * @return {@code true} if the given {@code error} has to be rethrown even if the {@link Step} was not asked to rethrow errors, {@code false} otherwise.
+ */
+ private static boolean isForceRethrow(Throwable error) {
+
+ return (error instanceof CliException cliException) && cliException.isForceRethrowInStep();
+ }
+
}
diff --git a/cli/src/main/resources/nls/Help.properties b/cli/src/main/resources/nls/Help.properties
index e678805cc2..0f9d3dabbe 100644
--- a/cli/src/main/resources/nls/Help.properties
+++ b/cli/src/main/resources/nls/Help.properties
@@ -187,7 +187,6 @@ cmd.yarn.detail=Yarn is a package manager and build tool for JavaScript. Detaile
commandlets=Available commandlets:
icd-hint=Hint: Use 'icd' command to easily navigate between your IDE home, projects, and workspaces. Type 'icd --help' for more details.
opt.--batch=enable batch mode (non-interactive).
-opt.--code=clone given code repository containing a settings folder into workspaces so that settings can be committed alongside code changes.
opt.--debug=enable debug logging.
opt.--force=enable force mode.
opt.--force-plugin-reinstall=resets installed plugins to the project configuration
diff --git a/cli/src/main/resources/nls/Help_de.properties b/cli/src/main/resources/nls/Help_de.properties
index 8276ff9bae..3413367b59 100644
--- a/cli/src/main/resources/nls/Help_de.properties
+++ b/cli/src/main/resources/nls/Help_de.properties
@@ -187,7 +187,6 @@ cmd.yarn.detail=Yarn ist ein Package Manager und Build-Werkzeug für JavaScript.
commandlets=Verfügbare Kommandos:
icd-hint=Hinweis: Verwenden Sie den Befehl 'icd' um einfach zwischen Ihrem IDE-Hauptverzeichnis, Projekten und Workspaces zu navigieren. Geben Sie 'icd --help' für weitere Details ein.
opt.--batch=Aktiviert den Batch-Modus (nicht-interaktive Stapelverarbeitung).
-opt.--code=Git-Repository sowohl als Code- als auch als Settings-Repository verwenden.
opt.--debug=Aktiviert Debug-Ausgaben (Fehleranalyse).
opt.--force=Aktiviert den Force-Modus (Erzwingen).
opt.--force-plugin-reinstall=Setzt installierte Plugins zurück auf die Projektkonfiguration.
diff --git a/cli/src/test/java/com/devonfw/tools/ide/commandlet/CreateCommandletTest.java b/cli/src/test/java/com/devonfw/tools/ide/commandlet/CreateCommandletTest.java
index 98534e72a9..56e6f403cb 100644
--- a/cli/src/test/java/com/devonfw/tools/ide/commandlet/CreateCommandletTest.java
+++ b/cli/src/test/java/com/devonfw/tools/ide/commandlet/CreateCommandletTest.java
@@ -7,18 +7,16 @@
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.ValueSource;
import com.devonfw.tools.ide.cli.CliArguments;
import com.devonfw.tools.ide.cli.CliException;
import com.devonfw.tools.ide.context.AbstractIdeContextTest;
import com.devonfw.tools.ide.context.IdeContext;
import com.devonfw.tools.ide.context.IdeTestContext;
-import com.devonfw.tools.ide.context.ProcessContextGitMock;
import com.devonfw.tools.ide.environment.EnvironmentVariables;
import com.devonfw.tools.ide.environment.EnvironmentVariablesType;
import com.devonfw.tools.ide.git.GitContextImplMock;
+import com.devonfw.tools.ide.io.WindowsSymlinkTestHelper;
import com.devonfw.tools.ide.version.IdeVersion;
/**
@@ -67,54 +65,9 @@ void testCreateCommandletRun() {
assertThat(newProjectPath.resolve(IdeContext.FOLDER_PLUGINS)).exists();
assertThat(newProjectPath.resolve(IdeContext.FOLDER_SOFTWARE)).exists();
assertThat(newProjectPath.resolve(IdeContext.FOLDER_WORKSPACES).resolve(IdeContext.WORKSPACE_MAIN)).exists();
- }
-
- @ParameterizedTest
- @ValueSource(strings = { "https://some-code-repository", "ssh://some-settings-repository" })
- void testWarningWhenRepoDoesNotMeetNamingConvention(String invalidRepo, @TempDir Path tempDir) {
- // arrange
- ProcessContextGitMock gitMock = new ProcessContextGitMock(context, tempDir);
- context.setProcessContext(gitMock);
- CreateCommandlet cc = context.getCommandletManager().getCommandlet(CreateCommandlet.class);
- cc.newProject.setValueAsString(NEW_PROJECT_NAME, context);
- cc.codeRepositoryFlag.setValue(!invalidRepo.contains("code")); // raise conflict
- cc.settingsRepo.setValue(invalidRepo);
- cc.skipTools.setValue(true);
- context.setAnswers("yes");
- // act
- cc.run();
- // assert
- assertThat(context).logAtInteraction().hasMessageContaining("Do you really want to create the project?");
- Path newProjectPath = context.getIdeRoot().resolve(NEW_PROJECT_NAME);
- assertThat(newProjectPath).exists();
- assertThat(context.getIdeHome()).isEqualTo(newProjectPath);
- assertThat(newProjectPath.resolve(IdeContext.FOLDER_PLUGINS)).exists();
- assertThat(newProjectPath.resolve(IdeContext.FOLDER_SOFTWARE)).exists();
- assertThat(newProjectPath.resolve(IdeContext.FOLDER_WORKSPACES).resolve(IdeContext.WORKSPACE_MAIN)).exists();
- }
-
- @Test
- void testWarningWhenCodeRepoUsingDefaultMark(@TempDir Path tempDir) {
- String invalidCodeRepo = "-";
- // arrange
- ProcessContextGitMock gitMock = new ProcessContextGitMock(context, tempDir);
- context.setProcessContext(gitMock);
- CreateCommandlet cc = context.getCommandletManager().getCommandlet(CreateCommandlet.class);
- cc.newProject.setValueAsString(NEW_PROJECT_NAME, context);
- cc.settingsRepo.setValue(invalidCodeRepo);
- cc.codeRepositoryFlag.setValue(true);
- cc.skipTools.setValue(true);
- context.setAnswers("https://some-code-repository");
- // act
- cc.run();
- // assert
- assertThat(context).logAtWarning().hasMessageContaining("'-' is found after '--code'. This is invalid.");
- Path newProjectPath = context.getIdeRoot().resolve(NEW_PROJECT_NAME);
- assertThat(newProjectPath).exists();
- assertThat(context.getIdeHome()).isEqualTo(newProjectPath);
- assertThat(newProjectPath.resolve(IdeContext.FOLDER_PLUGINS)).exists();
- assertThat(newProjectPath.resolve(IdeContext.FOLDER_SOFTWARE)).exists();
- assertThat(newProjectPath.resolve(IdeContext.FOLDER_WORKSPACES).resolve(IdeContext.WORKSPACE_MAIN)).exists();
+ // the settings have to be cloned into the new project and not into the project the create command was started from
+ assertThat(newProjectPath.resolve(IdeContext.FOLDER_SETTINGS).resolve("ide.properties")).exists();
+ assertThat(context.getIdeRoot().resolve("_ide/tmp/projects").resolve(NEW_PROJECT_NAME)).doesNotExist();
}
@Test
@@ -220,6 +173,79 @@ void testWelcomeMessageDisplayed() {
assertThat(context).logAtInfo().hasMessageContaining("Welcome to your new IDEasy project!");
}
+ @Test
+ void testProjectWithInvalidRepositoryNotCreated() {
+
+ // arrange - create a new project that is invalid (does not contain ide.properties file)
+ GitContextImplMock gitContextImplMock = new GitContextImplMock(context, TEST_RESOURCES.resolve("pypi"));
+
+ context.setGitContext(gitContextImplMock);
+ CreateCommandlet cc = context.getCommandletManager().getCommandlet(CreateCommandlet.class);
+ cc.newProject.setValueAsString(NEW_PROJECT_NAME, context);
+ cc.settingsRepo.setValue(IdeContext.DEFAULT_SETTINGS_REPO_URL);
+ cc.skipTools.setValue(true);
+
+ // act - run the create command
+ assertThatThrownBy(cc::run)
+ .isInstanceOf(CliException.class)
+ .hasMessageContaining(
+ "Settings repository integrity check failed: "
+ + "The given git repository URL does not point to a valid settings or code-settings repository. Please verify and try again.");
+
+ // assert - if "ide create" fails then no project shall be created at all
+ assertThat(context.getIdeRoot().resolve(NEW_PROJECT_NAME)).doesNotExist();
+ assertThat(context.getTempPath().resolve(IdeContext.FOLDER_PROJECTS).resolve(NEW_PROJECT_NAME)).doesNotExist();
+ }
+
+ @Test
+ void testCreateWithCodeSettingsRepository() {
+
+ // arrange - a combined code and settings repository has the settings in a top-level "settings" folder
+ WindowsSymlinkTestHelper.assumeSymlinksSupported();
+ GitContextImplMock gitContextImplMock = new GitContextImplMock(context, TEST_RESOURCES.resolve("code-settings"));
+ context.setGitContext(gitContextImplMock);
+ CreateCommandlet cc = context.getCommandletManager().getCommandlet(CreateCommandlet.class);
+ cc.newProject.setValueAsString(NEW_PROJECT_NAME, context);
+ cc.settingsRepo.setValue("https://github.com/devonfw/code-settings-repo.git");
+ cc.skipTools.setValue(true);
+
+ // act
+ cc.run();
+
+ // assert - the repository is placed into the workspace and IDE_HOME/settings is a symlink to its settings folder
+ Path newProjectPath = context.getIdeRoot().resolve(NEW_PROJECT_NAME);
+ Path codePath = newProjectPath.resolve(IdeContext.FOLDER_WORKSPACES).resolve(IdeContext.WORKSPACE_MAIN).resolve("code-settings-repo");
+ assertThat(codePath.resolve("pom.xml")).exists();
+ assertThat(codePath.resolve(IdeContext.FOLDER_SETTINGS).resolve("ide.properties")).exists();
+ Path settingsLink = newProjectPath.resolve(IdeContext.FOLDER_SETTINGS);
+ assertThat(settingsLink).isSymbolicLink();
+ assertThat(settingsLink.resolve("ide.properties")).exists();
+ }
+
+ @Test
+ void testCreateWithInvalidRepositoryContinuesInForceMode() {
+
+ // arrange - force mode lets the user decide to continue even though the health check failed
+ GitContextImplMock gitContextImplMock = new GitContextImplMock(context, TEST_RESOURCES.resolve("pypi"));
+ context.setGitContext(gitContextImplMock);
+ context.getStartContext().setForceMode(true);
+ context.setAnswers("yes");
+ CreateCommandlet cc = context.getCommandletManager().getCommandlet(CreateCommandlet.class);
+ cc.newProject.setValueAsString(NEW_PROJECT_NAME, context);
+ cc.settingsRepo.setValue(IdeContext.DEFAULT_SETTINGS_REPO_URL);
+ cc.skipTools.setValue(true);
+ cc.skipRepositories.setValue(true);
+
+ // act
+ cc.run();
+
+ // assert
+ Path newProjectPath = context.getIdeRoot().resolve(NEW_PROJECT_NAME);
+ assertThat(newProjectPath).exists();
+ assertThat(context).logAtWarning()
+ .hasMessageContaining("does not point to a valid settings or code-settings repository");
+ }
+
@Test
void testCreateWithDashPlaceholderAsCliArgument() {
// arrange - see https://github.com/devonfw/IDEasy/issues/2106
@@ -234,7 +260,7 @@ void testCreateWithDashPlaceholderAsCliArgument() {
assertThat(result).isEqualTo(0);
assertThat(context).logAtError().hasNoMessageContaining("not found for commandlet");
assertThat(context).logAtInfo()
- .hasMessageContaining("'-' was found for settings repository, the default settings repository");
+ .hasMessageContaining("'-' was found for the repository, the default settings repository");
Path newProjectPath = context.getIdeRoot().resolve(NEW_PROJECT_NAME);
assertThat(newProjectPath).exists();
}
diff --git a/cli/src/test/java/com/devonfw/tools/ide/commandlet/UpdateCommandletTest.java b/cli/src/test/java/com/devonfw/tools/ide/commandlet/UpdateCommandletTest.java
index 626d0b0aa4..a1efb8035a 100644
--- a/cli/src/test/java/com/devonfw/tools/ide/commandlet/UpdateCommandletTest.java
+++ b/cli/src/test/java/com/devonfw/tools/ide/commandlet/UpdateCommandletTest.java
@@ -7,11 +7,14 @@
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
+import com.devonfw.tools.ide.commandlet.update.UpdateCommandlet;
import com.devonfw.tools.ide.context.AbstractIdeContextTest;
import com.devonfw.tools.ide.context.IdeContext;
import com.devonfw.tools.ide.context.IdeTestContext;
import com.devonfw.tools.ide.environment.EnvironmentVariables;
import com.devonfw.tools.ide.environment.EnvironmentVariablesType;
+import com.devonfw.tools.ide.git.GitContext;
+import com.devonfw.tools.ide.git.GitContextMock;
import com.devonfw.tools.ide.tool.java.Java;
import com.devonfw.tools.ide.tool.mvn.Mvn;
import com.devonfw.tools.ide.variable.IdeVariables;
@@ -25,7 +28,7 @@
class UpdateCommandletTest extends AbstractIdeContextTest {
private static final String PROJECT_UPDATE = "update";
- private static final String SUCCESS_UPDATE_SETTINGS = "Successfully ended step 'update (pull) settings repository'.";
+ private static final String SUCCESS_UPDATE_SETTINGS = "Successfully ended step 'Update settings repository'.";
private static final String SUCCESS_INSTALL_OR_UPDATE_SOFTWARE = "Install or update software";
@Test
@@ -155,4 +158,57 @@ void testRunUpdateSoftwareDoesNotFailWhenSettingsPathIsDeleted(WireMockRuntimeIn
assertThat(context).logAtSuccess().hasMessage(SUCCESS_UPDATE_SETTINGS);
assertThat(context).logAtSuccess().hasMessageContaining(SUCCESS_INSTALL_OR_UPDATE_SOFTWARE);
}
+
+ /**
+ * Tests that a settings folder that exists but is not a git repository is backed up and cloned from scratch after the user confirmed.
+ */
+ @Test
+ void testRunUpdateWithBrokenSettingsFolder() {
+
+ // arrange
+ IdeTestContext context = newContext(PROJECT_UPDATE);
+ Path settingsPath = context.getSettingsPath();
+ // remove the '.git' folder so the settings are present but broken
+ context.getFileAccess().delete(settingsPath.resolve(GitContext.GIT_FOLDER));
+ UpdateCommandlet update = context.getCommandletManager().getCommandlet(UpdateCommandlet.class);
+ // first answer confirms the backup of the broken settings, second answer picks the default settings repository
+ context.setAnswers("yes", "-");
+
+ // act
+ update.run();
+
+ // assert
+ assertThat(context).logAtSuccess().hasMessage(SUCCESS_UPDATE_SETTINGS);
+ assertThat(context.getIdeHome().resolve(IdeContext.FOLDER_BACKUPS)).exists();
+ assertThat(settingsPath.resolve(GitContext.GIT_FOLDER)).exists();
+ assertThat(context).logAtSuccess().hasMessageContaining(SUCCESS_INSTALL_OR_UPDATE_SOFTWARE);
+ }
+
+ /**
+ * Tests that a failing "git pull" (e.g. due to an error of a custom git server) only fails the settings step while the software is still installed.
+ *
+ * See: #2335 for reference.
+ */
+ @Test
+ void testRunUpdateContinuesWhenPullFails() {
+
+ // arrange
+ IdeTestContext context = newContext(PROJECT_UPDATE);
+ context.setGitContext(new GitContextMock(context) {
+ @Override
+ public void pull(Path repository) {
+
+ throw new IllegalStateException("git pull failed due to an error of the custom git server");
+ }
+ });
+ UpdateCommandlet update = context.getCommandletManager().getCommandlet(UpdateCommandlet.class);
+
+ // act
+ update.run();
+
+ // assert
+ assertThat(context).logAtError().hasMessage("Step 'Applying settings' ended with failure.");
+ assertThat(context).log().hasNoMessage(SUCCESS_UPDATE_SETTINGS);
+ assertThat(context).logAtSuccess().hasMessageContaining(SUCCESS_INSTALL_OR_UPDATE_SOFTWARE);
+ }
}
diff --git a/cli/src/test/java/com/devonfw/tools/ide/git/GitContextMock.java b/cli/src/test/java/com/devonfw/tools/ide/git/GitContextMock.java
index d794f0ad12..27723760ac 100644
--- a/cli/src/test/java/com/devonfw/tools/ide/git/GitContextMock.java
+++ b/cli/src/test/java/com/devonfw/tools/ide/git/GitContextMock.java
@@ -20,7 +20,8 @@
*/
public class GitContextMock extends GitContextImpl {
- private static final String MOCKED_URL_VALUE = "mocked url value";
+ /** Fallback URL for repositories without a mocked {@code .git/config} - has to be a {@link GitUrl#isValid() valid} git URL. */
+ private static final String MOCKED_URL_VALUE = DEFAULT_SETTINGS_GIT_URL;
/** Filename used to persist mocked remotes inside the {@code .git} folder. */
private static final String REMOTES_FILE = "remotes.properties";
@@ -57,6 +58,9 @@ public void clone(GitUrl gitUrl, Path repository) {
FileAccess fileAccess = this.context.getFileAccess();
fileAccess.mkdirs(repository);
+ // Create ide.properties to simulate a valid repository
+ fileAccess.touch(repository.resolve("ide.properties"));
+
Path gitFolder = repository.resolve(GIT_FOLDER);
fileAccess.mkdirs(gitFolder);
String branch = gitUrl.branch();
diff --git a/cli/src/test/java/com/devonfw/tools/ide/step/StepTest.java b/cli/src/test/java/com/devonfw/tools/ide/step/StepTest.java
index 0a5b87d12c..c4ff3587b5 100644
--- a/cli/src/test/java/com/devonfw/tools/ide/step/StepTest.java
+++ b/cli/src/test/java/com/devonfw/tools/ide/step/StepTest.java
@@ -2,6 +2,7 @@
import org.junit.jupiter.api.Test;
+import com.devonfw.tools.ide.cli.CliFatalException;
import com.devonfw.tools.ide.context.AbstractIdeContextTest;
import com.devonfw.tools.ide.context.IdeTestContext;
import com.devonfw.tools.ide.log.IdeLogEntry;
@@ -130,4 +131,60 @@ void testInvalidUsageErrorSuccess() {
IdeLogEntry.ofDebug("Step 'Test-Step' ended successfully."));
}
+ @Test
+ void testRunSwallowsRegularError() {
+
+ // arrange
+ IdeTestContext context = newContext(PROJECT_BASIC, "project", false);
+ Step step = context.newStep("Test-Step");
+ // act
+ boolean success = step.run(() -> {
+ throw new IllegalStateException("regular error");
+ });
+ // assert
+ assertThat(success).isFalse();
+ assertThat(step.isFailure()).isTrue();
+ }
+
+ @Test
+ void testRunRethrowsForcedError() {
+
+ // arrange
+ IdeTestContext context = newContext(PROJECT_BASIC, "project", false);
+ Step step = context.newStep("Test-Step");
+ // act & assert
+ assertThatThrownBy(() -> step.run(() -> {
+ throw new CliFatalException("fatal error");
+ })).isInstanceOf(CliFatalException.class).hasMessage("fatal error");
+ assertThat(step.isFailure()).isTrue();
+ }
+
+ @Test
+ void testCallReturnsFallbackOnRegularError() {
+
+ // arrange
+ IdeTestContext context = newContext(PROJECT_BASIC, "project", false);
+ Step step = context.newStep("Test-Step");
+ // act
+ String result = step.call(() -> {
+ throw new IllegalStateException("regular error");
+ }, () -> "fallback");
+ // assert
+ assertThat(result).isEqualTo("fallback");
+ assertThat(step.isFailure()).isTrue();
+ }
+
+ @Test
+ void testCallRethrowsForcedError() {
+
+ // arrange
+ IdeTestContext context = newContext(PROJECT_BASIC, "project", false);
+ Step step = context.newStep("Test-Step");
+ // act & assert
+ assertThatThrownBy(() -> step.call(() -> {
+ throw new CliFatalException("fatal error");
+ }, () -> "fallback")).isInstanceOf(CliFatalException.class).hasMessage("fatal error");
+ assertThat(step.isFailure()).isTrue();
+ }
+
}
diff --git a/cli/src/test/resources/code-settings/pom.xml b/cli/src/test/resources/code-settings/pom.xml
new file mode 100644
index 0000000000..6d465deda5
--- /dev/null
+++ b/cli/src/test/resources/code-settings/pom.xml
@@ -0,0 +1 @@
+code
diff --git a/cli/src/test/resources/code-settings/settings/ide.properties b/cli/src/test/resources/code-settings/settings/ide.properties
new file mode 100644
index 0000000000..28913aee06
--- /dev/null
+++ b/cli/src/test/resources/code-settings/settings/ide.properties
@@ -0,0 +1 @@
+IDE_TOOLS=java,mvn
diff --git a/cli/src/test/resources/settings/ide.properties b/cli/src/test/resources/settings/ide.properties
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/documentation/settings.adoc b/documentation/settings.adoc
index e9de2335ca..3bf2f8e240 100644
--- a/documentation/settings.adoc
+++ b/documentation/settings.adoc
@@ -18,17 +18,18 @@ This gives you the freedom to control and manage the tools with their versions a
To setup and customize these settings simply follow the link:usage.adoc#admin[admin usage guide].
Then tell your team to create the project using your project sepcific settings git URL:
```
-ide create «project-name» --code «settings-url»
+ide create «project-name» «settings-url»
```
== Code-repository
It is even possible to include your settings into your code repository by having the `settings` folder directly on top-level of your code git repository.
This allows you to keep settings changes in sync with code changes and manage them in the same pull/merge requests.
-To use this approach simply copy the content of https://github.com/devonfw/ide-settings[ide-settings] to a top-level `settings` folder in your code repository root and tell your developers to create the project usining the `--code` option:
+To use this approach simply copy the content of https://github.com/devonfw/ide-settings[ide-settings] to a top-level `settings` folder in your code repository root.
+IDEasy will automatically recognize that you are using a code repository, therefore just use the same command as above:
```
-ide create «project-name» --code «code-repo-url»
+ide create «project-name» «code-repo-url»
```
IDEasy will clone your repository and create a symlink to the settings folder.
@@ -50,6 +51,21 @@ But we do not want to forget the following advantage:
Anyhow you can still create feature branches in standalone settings repositories to manage such scenarios and follow KISS and trunk-based development so you more or less avoid such problems.
However, if you are in a monolithic project with complex release branches you may consider using the "settings in code repository" approach.
+== Health check
+
+Whenever `IDEasy` clones or updates your settings it first clones the git repository into a temporary directory and performs a health check on it:
+
+* the given git URL has to be valid,
+* cloning the repository has to succeed,
+* and the repository has to be a settings repository or a combined code and settings repository (see link:#code-repository[above]).
+
+Only if this health check succeeded the settings are installed: an existing settings repository is updated via `git pull` while a new one is moved from the temporary directory to its final location.
+This way a broken or wrong git URL can never leave you with a damaged project.
+In particular `ide create` will not create the project at all if the health check fails, so you can simply fix the URL and try again.
+
+If you are sure that you know better, you can use the `--force` option.
+`IDEasy` will then still report the problem but ask you whether you want to continue anyway.
+
== Structure
The settings folder has to follow this file structure: