fix(atlantis): allow .gitconfig write

[GMartinez-Sisti]

what

Chart users want to edit /home/atlantis/.gitconfig while specifying a default value for the file.

This PRs allows setting gitconfig and introduces gitconfigReadOnly to allow editing the .gitconfig file on the atlantis pod. While this is a technically a feature, it was something that was working previously (see references below) and gitconfigReadOnly behavior matches the existing version, so this is being treated as a fix.

The fix leverages /docker-entrypoint.d/ scripts to run the desired script on start, the script copies the gitconfig data into the file, ensuring that the file can be edited by atlantis.

Unit tests were added for this fix.

tests

Deploy with default value

Deploy command:

helm upgrade -i test-atlantis ./charts/atlantis/ -f ./charts/atlantis/test-values.yaml

Log from atlantis pod:

No files found in /docker-entrypoint.d/, skipping
{"level":"info","ts":"2024-07-17T11:59:58.011Z","caller":"server/server.go:319","msg":"Supported VCS Hosts%!(EXTRA string=hosts, ]models.VCSHostType=[Github])","json":{}}
{"level":"info","ts":"2024-07-17T11:59:58.359Z","caller":"server/server.go:467","msg":"Utilizing BoltDB","json":{}}
{"level":"info","ts":"2024-07-17T11:59:58.362Z","caller":"policy/conftest_client.go:153","msg":"failed to get default conftest version. Will attempt request scoped lazy loads DEFAULT_CONFTEST_VERSION not set","json":{}}
{"level":"info","ts":"2024-07-17T11:59:58.362Z","caller":"server/server.go:1017","msg":"Atlantis started - listening on port 4141","json":{}}
{"level":"info","ts":"2024-07-17T11:59:58.362Z","caller":"scheduled/executor_service.go:51","msg":"Scheduled Executor Service started","json":{}}

Deploy with gitconfigReadOnly set to false

Deploy command:

→ helm upgrade -i test-atlantis ./charts/atlantis/ -f ./charts/atlantis/test-values.yaml --set gitconfigReadOnly=false --set "gitconfig=foo
> bar
> "

Log from atlantis pod:

/docker-entrypoint.d/ is not empty, will attempt to perform script execition
Looking for shell scripts in /docker-entrypoint.d/
Launching /docker-entrypoint.d/gitconfig-init.sh
+ cp -v /etc/.gitconfig /home/atlantis/.gitconfig
'/etc/.gitconfig' -> '/home/atlantis/.gitconfig'
+ chown -v atlantis /home/atlantis/.gitconfig
changed ownership of '/home/atlantis/.gitconfig' to 100:0
Configuration complete; ready for start up
{"level":"info","ts":"2024-07-17T12:20:27.226Z","caller":"server/server.go:319","msg":"Supported VCS Hosts%!(EXTRA string=hosts, ]models.VCSHostType=[Github])","json":{}}
{"level":"info","ts":"2024-07-17T12:20:27.833Z","caller":"server/server.go:467","msg":"Utilizing BoltDB","json":{}}
{"level":"info","ts":"2024-07-17T12:20:27.834Z","caller":"policy/conftest_client.go:153","msg":"failed to get default conftest version. Will attempt request scoped lazy loads DEFAULT_CONFTEST_VERSION not set","json":{}}
{"level":"info","ts":"2024-07-17T12:20:27.834Z","caller":"server/server.go:1017","msg":"Atlantis started - listening on port 4141","json":{}}
{"level":"info","ts":"2024-07-17T12:20:27.834Z","caller":"scheduled/executor_service.go:51","msg":"Scheduled Executor Service started","json":{}}

Confirm we can edit the file, from the pod:

test-atlantis-0:/$ cat /home/atlantis/.gitconfig
foo
bar
test-atlantis-0:/$ echo baz >> /home/atlantis/.gitconfig
test-atlantis-0:/$ cat /home/atlantis/.gitconfig
foo
bar
baz
test-atlantis-0:/$

references

• Closes helm chart gitconfig option ignored atlantis#1257
• Closes gitconfig credential.helper error: Resource busy #222
• Reverts fix(atlantis): permissions for .gitconfig file #384

[chenrui333]

lgtm

[fede-r1c0]

This works, thanks!