chore: update local git config when user changes Che Theia git settings #1319

vinokurig · 2022-02-17T08:45:35Z

What does this PR do?

When user gitconfig home/theia/.gitconfig is updated with a new value, local gitconfig <project directory>/.git/config is updated with the value automatically.
When an existing value is updated in user gitconfig:
- If the old value is equal with one in local gitconfig, it is updated in the local gitconfig.
- If the old value is NOT equal with one in local gitconfig, it is NOT updated in the local gitconfig.
When a value is deleted in user gitconfig:
- If the value is equal with one in local gitconfig, it is deleted in the local gitconfig.
- If the value is NOT equal with one in local gitconfig, it is NOT deleted in the local gitconfig.

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

run factory:

https://github.com/che-samples/bash/tree/devfilev2?che-editor=https://gist.githubusercontent.com/vinokurig/8240d845067c89e295e2cb4dc2c0070b/raw/ad3452ee49b0eeddfaf086f55557d46206073fea/che-theia.yaml

Set some gitconfig settings e.g. user.name and user.email.
Restart workspace.

See: The gitconfig settings are present.

PR Checklist

As the author of this Pull Request I made sure that:

Reviewers

Reviewers, please comment how you tested the PR when approving it.

Happy Path Channel

HAPPY_PATH_CHANNEL=stable

vinokurig · 2022-02-17T08:46:58Z

depends on eclipse-che/che#21147

codecov · 2022-02-17T09:32:15Z

Codecov Report

Merging #1319 (c1aab10) into main (c299f59) will increase coverage by 3.95%.
The diff coverage is 39.52%.

@@            Coverage Diff             @@
##             main    #1319      +/-   ##
==========================================
+ Coverage   32.78%   36.74%   +3.95%     
==========================================
  Files         290      330      +40     
  Lines        9885    11393    +1508     
  Branches     1457     1572     +115     
==========================================
+ Hits         3241     4186     +945     
- Misses       6641     7202     +561     
- Partials        3        5       +2

Impacted Files	Coverage Δ
...theia-about/src/browser/about-che-theia-dialog.tsx	`0.00% <0.00%> (ø)`
...credentials/src/browser/che-credentials-service.ts	`0.00% <0.00%> (ø)`
...entials/src/browser/credentials-frontend-module.ts	`0.00% <0.00%> (ø)`
...eia-credentials/src/common/credentials-protocol.ts	`0.00% <0.00%> (ø)`
...eia-credentials/src/node/che-credentials-server.ts	`0.00% <0.00%> (ø)`
...s/src/node/che-theia-credentials-backend-module.ts	`0.00% <0.00%> (ø)`
...ashboard/src/browser/che-theia-dashboard-module.ts	`0.00% <0.00%> (ø)`
...ia-dashboard/src/browser/theia-dashboard-client.ts	`0.00% <0.00%> (ø)`
...rowser/src/browser/che-mini-browser-environment.ts	`0.00% <0.00%> (ø)`
...in-ext/src/browser/che-sidecar-file-system-main.ts	`100.00% <ø> (ø)`
... and 295 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c58f5bd...c1aab10. Read the comment docs.

svor

LGTM

extensions/eclipse-che-theia-git-provisioner/package.json

l0rd · 2022-04-08T11:08:24Z

I have just started a workspace using this editor definition, and although the git user and email are set in Theia preferences, Theia still shows the warning in the status bar:

Note that theia git email and username preferences were set previously, in another workspace.

l0rd · 2022-04-08T11:15:22Z

And git commit from the terminal doesn't seem to like:

l0rd · 2022-04-08T11:21:36Z

After editing the preferences the warning in the status bar disappear. Even when I restart the workspace 👍
But the terminal is still unhappy.

vinokurig · 2022-04-15T14:11:56Z

@l0rd
I've fixed all the issues above, could you please take a look?

l0rd · 2022-04-15T15:07:44Z

Thanks @vinokurig I will test it later

l0rd · 2022-04-21T11:15:14Z

I have tried this PR and there is a problem. Theia now creates a configmap with the gitconfig. But if a gitconfig ConfigMap already existed in the namespace we will end up with 2 ConfigMaps:

$ oc get cm -l controller.devfile.io/mount-to-devworkspace=true
NAME                  DATA   AGE
git-config            1      12d
workspace-gitconfig   1      74m

And then workspaces will fail to start.

l0rd · 2022-04-21T11:42:39Z

As discussed a couple of weeks ago I think that Theia should not create or update the git configmap. It should instead:

At startup, if git user and email are NOT in Theia preferences yet, it should read them in /etc/gitconfig if it exists
At startup, if git user and email are already in Theia preferences, it should add them in file $PROJECT_SOURCE/.git/config (if they are not there yet) so that git config is available when using the command line too. Note that /etc/gitconfig/ may have different values but Theia preference have priority: theia preferences override global git config.
When user sets or updates git user/email in Theia preferences, the file $PROJECT_SOURCE/.git/config should be updated accordingly so that the git config is also available when using the command line.

l0rd · 2022-04-25T09:45:02Z

Other acceptance criteria:

If local git config is updated (manually by the user), Theia preferences should not be changed.
If local git config is created, Theia preferences should not be changed.
if Theia preferences are updated and local git config matches old theia preferences then local git config should be updated too.
if Theia preferences are updated and local git config didn't match old theia preferences then local git config should NOT be updated.

Signed-off-by: Igor Vinokur <ivinokur@redhat.com>

vinokurig · 2022-05-05T13:45:42Z

PR update:

When user gitconfig home/theia/.gitconfig is updated with a new value, local gitconfig <project directory>/.git/config is updated with the value automatically.
When an existed value is updated in user gitconfig:
- If the old value is equal with one in local gitconfig, it is updated in the local gitconfig.
- If the old value is NOT equal with one in local gitconfig, it is NOT updated in the local gitconfig.
When a value is deleted in user gitconfig:
- If the value is equal with one in local gitconfig, it is deleted in the local gitconfig.
- If the value is NOT equal with one in local gitconfig, it is NOT deleted in the local gitconfig.

@l0rd @svor Please take a look

vinokurig · 2022-05-06T09:02:49Z

To test this PR run a factory:

https://github.com/che-samples/bash/tree/devfilev2?che-editor=https://gist.githubusercontent.com/vinokurig/8240d845067c89e295e2cb4dc2c0070b/raw/ad3452ee49b0eeddfaf086f55557d46206073fea/che-theia.yaml

svor

LGTM

l0rd · 2022-05-11T09:29:08Z

I have tried your Theia image as mentioned in this PR description. I don't understand why I am asked to configure my git config email when it's already configured:

Note that I had a theia preferences configmap:

kubectl cm workspace-preferences-configmap -o json | jq -r '.data[]' | jq .
{
  "git.user.email": "mario.loriedo@gmail.com",
  "git.user.name": "Mario"
}

vinokurig · 2022-05-12T08:05:06Z

@l0rd @svor

I have tried your Theia image as mentioned in this PR description. I don't understand why I am asked to configure my git config email when it's already configured

I've fixed this bug, could you please try again?

vinokurig · 2022-05-12T09:56:47Z

@l0rd @svor
There is another bug: panel is not updated if a new workspace started with existing user git preferences, working on it

vinokurig · 2022-05-13T13:43:31Z

@l0rd @svor

There is another bug: panel is not updated if a new workspace started with existing user git preferences, working on it

The bug has been fixed, could you please take a look?

svor · 2022-05-13T15:23:59Z

seems ok to me, thanks for updating the PR

svor · 2022-05-23T12:37:24Z

@l0rd @azatsarynnyy we are going to merge this PR after 2 days.
If you have any concerns with that, please let us know

vinokurig requested review from azatsarynnyy, RomanNikitenko, vzhukovs and benoitf as code owners February 17, 2022 08:45

vinokurig requested a review from svor February 17, 2022 08:46

chore: store gitconfig in a configmap

793e873

vinokurig force-pushed the che-21115 branch from 9f40847 to 793e873 Compare February 17, 2022 09:18

svor mentioned this pull request Feb 21, 2022

Plugins Sprint 215 eclipse-che/che#21196

Closed

12 tasks

svor approved these changes Feb 22, 2022

View reviewed changes

azatsarynnyy reviewed Feb 22, 2022

View reviewed changes

extensions/eclipse-che-theia-git-provisioner/package.json Outdated Show resolved Hide resolved

vinokurig added 3 commits February 23, 2022 18:03

Merge branch 'main' of github.com:eclipse-che/che-theia into che-21115

66f6e20

Merge branch 'main' of github.com:eclipse-che/che-theia into che-21115

daadb55

Merge branch 'main' of github.com:eclipse-che/che-theia into che-21115

ca32a38

vinokurig force-pushed the che-21115 branch 2 times, most recently from 9f92e3f to 2f0286f Compare April 1, 2022 11:26

fixup! chore: store gitconfig in a configmap

e05548c

vinokurig force-pushed the che-21115 branch from 2f0286f to e05548c Compare April 1, 2022 12:47

vinokurig force-pushed the che-21115 branch from 12d520e to f5f6d13 Compare April 15, 2022 12:50

fixup! chore: store gitconfig in a configmap

b93f879

vinokurig force-pushed the che-21115 branch from f5f6d13 to b93f879 Compare April 15, 2022 14:13

Merge branch 'main' of github.com:eclipse-che/che-theia into che-21115

4f23c6e

vinokurig force-pushed the che-21115 branch from 7567351 to d5f834c Compare May 5, 2022 12:14

Update local gitconfig when user gitconfig is updated

6ef0518

Signed-off-by: Igor Vinokur <ivinokur@redhat.com>

vinokurig force-pushed the che-21115 branch from d5f834c to 6ef0518 Compare May 5, 2022 12:17

svor approved these changes May 6, 2022

View reviewed changes

svor changed the title ~~chore: store gitconfig in a configmap~~ chore: update local git config when user changes Che Theia git settings May 10, 2022

vinokurig added 2 commits May 11, 2022 15:28

Merge branch 'main' of github.com:eclipse-che/che-theia into che-21115

f694e59

fixup! Update local gitconfig when user gitconfig is updated

30534c4

fixup! Update local gitconfig when user gitconfig is updated

c1aab10

azatsarynnyy approved these changes May 23, 2022

View reviewed changes

svor merged commit 6655bed into main May 25, 2022

svor deleted the che-21115 branch May 25, 2022 09:08

che-bot added this to the 7.49 milestone May 25, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: update local git config when user changes Che Theia git settings #1319

chore: update local git config when user changes Che Theia git settings #1319

vinokurig commented Feb 17, 2022 •

edited by l0rd

Loading

vinokurig commented Feb 17, 2022

codecov bot commented Feb 17, 2022 •

edited

Loading

svor left a comment

l0rd commented Apr 8, 2022 •

edited

Loading

l0rd commented Apr 8, 2022

l0rd commented Apr 8, 2022

vinokurig commented Apr 15, 2022

l0rd commented Apr 15, 2022 •

edited

Loading

l0rd commented Apr 21, 2022 •

edited

Loading

l0rd commented Apr 21, 2022 •

edited

Loading

l0rd commented Apr 25, 2022

vinokurig commented May 5, 2022

vinokurig commented May 6, 2022

svor left a comment

l0rd commented May 11, 2022

vinokurig commented May 12, 2022

vinokurig commented May 12, 2022

vinokurig commented May 13, 2022

svor commented May 13, 2022

svor commented May 23, 2022

chore: update local git config when user changes Che Theia git settings #1319

chore: update local git config when user changes Che Theia git settings #1319

Conversation

vinokurig commented Feb 17, 2022 • edited by l0rd Loading

What does this PR do?

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

PR Checklist

Reviewers

Happy Path Channel

vinokurig commented Feb 17, 2022

codecov bot commented Feb 17, 2022 • edited Loading

Codecov Report

svor left a comment

Choose a reason for hiding this comment

l0rd commented Apr 8, 2022 • edited Loading

l0rd commented Apr 8, 2022

l0rd commented Apr 8, 2022

vinokurig commented Apr 15, 2022

l0rd commented Apr 15, 2022 • edited Loading

l0rd commented Apr 21, 2022 • edited Loading

l0rd commented Apr 21, 2022 • edited Loading

l0rd commented Apr 25, 2022

vinokurig commented May 5, 2022

vinokurig commented May 6, 2022

svor left a comment

Choose a reason for hiding this comment

l0rd commented May 11, 2022

vinokurig commented May 12, 2022

vinokurig commented May 12, 2022

vinokurig commented May 13, 2022

svor commented May 13, 2022

svor commented May 23, 2022

vinokurig commented Feb 17, 2022 •

edited by l0rd

Loading

codecov bot commented Feb 17, 2022 •

edited

Loading

l0rd commented Apr 8, 2022 •

edited

Loading

l0rd commented Apr 15, 2022 •

edited

Loading

l0rd commented Apr 21, 2022 •

edited

Loading

l0rd commented Apr 21, 2022 •

edited

Loading