#312: Added ability to prefer `git` (ssh) protocol instead of `https`for cloning repos #625

diiinesh · 2024-09-17T09:36:41Z

Introduced GIT_PREFERRED_PROTOCOL property to allow configuration of preferred Git protocol (SSH or HTTPS).
Default behavior remains unchanged if the property is not set, using the provided Git URL as is.
Implemented GitUrlSyntax enum to manage and convert between SSH and HTTPS URL formats.
Updated GitUrl class for URL parsing and protocol conversion based on the property.
Added tests to validate URL conversion and ensure no changes for specific domains like GitHub.

… GitUrl.java to process ssh urls as well, and added tests

coveralls · 2024-09-17T10:27:09Z

Pull Request Test Coverage Report for Build 11477617445

Details

0 of 0 changed or added relevant lines in 0 files are covered.
4 unchanged lines in 2 files lost coverage.
Overall coverage increased (+0.04%) to 66.841%

Files with Coverage Reduction	New Missed Lines	%
com/devonfw/tools/ide/variable/IdeVariables.java	1	96.15%
com/devonfw/tools/ide/context/GitUrl.java	3	71.43%

Totals
Change from base Build 11406095376:	0.04%
Covered Lines:	6293
Relevant Lines:	9071

💛 - Coveralls

hohwille

@diiinesh I already had a look even though still in draft mode.
You did already a great job with GitUrlSyntax and the integration into GitContextImpl plus adding a wonderful JUnit test. 👍
I already left some suggestions for improvement and refactoring early on...
Please have a look.

cli/src/main/java/com/devonfw/tools/ide/context/GitUrl.java

cli/src/main/java/com/devonfw/tools/ide/context/GitUrlSyntax.java

cli/src/test/java/com/devonfw/tools/ide/context/GitContextTest.java

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

cli/src/main/java/com/devonfw/tools/ide/context/GitUrl.java

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

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

…num.java and seperate IdeVariable, moved test functions to GitUrlSyntax.java

# Conflicts: # cli/src/main/java/com/devonfw/tools/ide/context/GitContextImpl.java

…project for git based implementations and its config file

…to Enhancement/git_ssh_protocol

…aces and home dir in test env

…to Enhancement/git_ssh_protocol

alfeilex

LGTM

hohwille

@diiinesh thanks for your rework. 👍
I left some small review comments for improvement.
However, this PR does not integrate the new feature so story #312 is not yet implemented.
You need to change GitContextImpl to actually make use of the new infrastructure that you have created in order to transform the GitUrl before calling the actual git clone command.

Also I would suggest to add GitUrlSyntax.DEFAULT and provide this via default lambda in IdeVariables as default so that you can avoid NullPointerException and do not always need to check if configured GitUrlSyntax is null.

cli/src/main/java/com/devonfw/tools/ide/variable/VariableDefinitionEnum.java

cli/src/main/java/com/devonfw/tools/ide/variable/IdeVariables.java

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

…to Enhancement/git_ssh_protocol

hohwille · 2024-10-26T00:07:49Z

cli/src/main/java/com/devonfw/tools/ide/variable/IdeVariables.java

@@ -73,6 +75,11 @@ public interface IdeVariables {
  /** {@link VariableDefinition} for {@link com.devonfw.tools.ide.context.IdeContext#getProjectName() PROJECT_NAME}. */
  VariableDefinitionString PROJECT_NAME = new VariableDefinitionString("PROJECT_NAME", null, c -> c.getProjectName());

+  /** Preferred Git protocol (HTTPS/SSH) as defined by {@link GitUrlSyntax}. */
+  VariableDefinitionEnum<GitUrlSyntax> PREFERRED_GIT_PROTOCOL = new VariableDefinitionEnum<>("PREFERRED_GIT_PROTOCOL", null, GitUrlSyntax.class,
+      c -> GitUrlSyntax.HTTPS


The default should be not to change the URL. Only if the user sets the property explicitly, the URL should be changed.
See #625:

Default behavior remains unchanged if the property is not set, using the provided Git URL as is.

Done in #724

hohwille · 2024-10-31T11:58:43Z

This PR is replaced by PR #724 - hence closing.

added git url enum GitUrlSyntax.java for ssh and https urls, modified…

1c3750b

… GitUrl.java to process ssh urls as well, and added tests

diiinesh self-assigned this Sep 17, 2024

Merge branch 'main' into Enhancement/git_ssh_protocol

73805f7

hohwille reviewed Sep 17, 2024

View reviewed changes

diiinesh and others added 19 commits September 18, 2024 10:42

Update cli/src/main/java/com/devonfw/tools/ide/context/GitUrl.java

69d70fd

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

Update cli/src/test/java/com/devonfw/tools/ide/context/GitContextTest…

c8a4778

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

modifed enum to not take strings as inputs, added VariableDefinitionE…

21ddcf2

…num.java and seperate IdeVariable, moved test functions to GitUrlSyntax.java

Merge branch 'main' into Enhancement/git_ssh_protocol

a2dc43d

# Conflicts: # cli/src/main/java/com/devonfw/tools/ide/context/GitContextImpl.java

Merge branch 'main' into Enhancement/git_ssh_protocol

c4e38b8

added PREFERRED_GIT_PROTOCOL property to assert ide properties file

dec7402

Merge branch 'main' into Enhancement/git_ssh_protocol

89e1b02

removed property from basic project config file and created new test …

1c5dc97

…project for git based implementations and its config file

Merge remote-tracking branch 'origin/Enhancement/git_ssh_protocol' in…

cb2dd52

…to Enhancement/git_ssh_protocol

changed test context from basic to git, and added some java docs

d7807ed

changed test context from basic to git, and added some java docs

98c11d0

Merge branch 'main' into Enhancement/git_ssh_protocol

b6f18bc

logging for git action build error

00c2bec

Merge remote-tracking branch 'origin/Enhancement/git_ssh_protocol' in…

649c9a0

…to Enhancement/git_ssh_protocol

logging for git action build error

816bbaf

logging for git action build error

ca7b2db

Merge branch 'main' into Enhancement/git_ssh_protocol

42b5adc

revert logging code for searching error in git ci build, added worksp…

8afd40a

…aces and home dir in test env

Merge remote-tracking branch 'origin/Enhancement/git_ssh_protocol' in…

1e39f35

…to Enhancement/git_ssh_protocol

diiinesh marked this pull request as ready for review October 8, 2024 09:46

alfeilex self-requested a review October 9, 2024 15:35

alfeilex approved these changes Oct 9, 2024

View reviewed changes

hohwille requested changes Oct 18, 2024

View reviewed changes

cli/src/main/java/com/devonfw/tools/ide/variable/VariableDefinitionEnum.java Outdated Show resolved Hide resolved

cli/src/main/java/com/devonfw/tools/ide/variable/IdeVariables.java Outdated Show resolved Hide resolved

diiinesh and others added 2 commits October 23, 2024 10:41

Update cli/src/main/java/com/devonfw/tools/ide/variable/VariableDefin…

d4ad4cf

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

added javadoc

5fc97d1

diiinesh added 3 commits October 23, 2024 12:00

Merge remote-tracking branch 'origin/Enhancement/git_ssh_protocol' in…

f1039e9

…to Enhancement/git_ssh_protocol

added default value

35ef77e

Merge branch 'main' into Enhancement/git_ssh_protocol

386089a

diiinesh assigned alfeilex and unassigned diiinesh Oct 23, 2024

hohwille changed the title ~~Added ability to prefer git (ssh) protocol instead of httpsfor cloning repos~~ #312: Added ability to prefer git (ssh) protocol instead of httpsfor cloning repos Oct 26, 2024

hohwille reviewed Oct 26, 2024

View reviewed changes

hohwille assigned diiinesh and hohwille Oct 28, 2024

alfeilex mentioned this pull request Oct 29, 2024

#312: Added ability to prefer git (ssh) protocol instead of https for cloning repos #724

Merged

hohwille closed this Oct 31, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#312: Added ability to prefer `git` (ssh) protocol instead of `https`for cloning repos #625

#312: Added ability to prefer `git` (ssh) protocol instead of `https`for cloning repos #625

diiinesh commented Sep 17, 2024 •

edited

Loading

coveralls commented Sep 17, 2024 •

edited

Loading

hohwille left a comment

alfeilex left a comment

hohwille left a comment

hohwille Oct 26, 2024

alfeilex Oct 30, 2024

hohwille commented Oct 31, 2024

#312: Added ability to prefer git (ssh) protocol instead of httpsfor cloning repos #625

#312: Added ability to prefer git (ssh) protocol instead of httpsfor cloning repos #625

Conversation

diiinesh commented Sep 17, 2024 • edited Loading

coveralls commented Sep 17, 2024 • edited Loading

Pull Request Test Coverage Report for Build 11477617445

Details

💛 - Coveralls

hohwille left a comment

Choose a reason for hiding this comment

alfeilex left a comment

Choose a reason for hiding this comment

hohwille left a comment

Choose a reason for hiding this comment

hohwille Oct 26, 2024

Choose a reason for hiding this comment

alfeilex Oct 30, 2024

Choose a reason for hiding this comment

hohwille commented Oct 31, 2024

#312: Added ability to prefer `git` (ssh) protocol instead of `https`for cloning repos #625

#312: Added ability to prefer `git` (ssh) protocol instead of `https`for cloning repos #625

diiinesh commented Sep 17, 2024 •

edited

Loading

coveralls commented Sep 17, 2024 •

edited

Loading