Version hash is dependent on repository source folder name

[dadadom]

Bug

I have the suspicion that ever since https://github.com/garden-io/garden/releases/tag/0.12.61 and the introduction of the fix for #4661 the version depends on the path of the source repository.

Current Behavior

The version hash generated to determine if an action needs to be executed again seems to depend on the source folder name of the checked out remote repository.

Expected behavior

The version hash should only depend on the contents of the repository, not on the folder name.

Reproducible example

$> cat umbrella/project.garden.yml

apiVersion: garden.io/v1
kind: Project
name: umbrella

defaultEnvironment: local

environments:
  - name: local
    defaultNamespace: garden-local

providers:
  - name: local-kubernetes
    environments:
      - local
  - name: jib
 
sources:
  - name: app
    repositoryUrl: https://github.com/dadadom/app-testing#master

$> garden version
garden version: 0.13.21

$>  git clone git@github.com:dadadom/app-testing.git app1
...
$>  git clone git@github.com:dadadom/app-testing.git app2
...

$> garden --root umbrella link source app app1

$> garden --root umbrella build --log-level=debug
...
Execing ... -Djib.container.args=GARDEN_MODULE_VERSION=v-9c6dacb57c ...
...

$> garden --root umbrella unlink source app
$> garden --root umbrella link source app app2
$> garden --root umbrella build --log-level=debug
...
Execing ... -Djib.container.args=GARDEN_MODULE_VERSION=v-a469a92ed9 ...
...

Workaround

Suggested solution(s)

As far as I understand the system, the "source" of the files should be irrelevant as long as the contents and locations of the files within a repository don't change.

Additional context

For us the issue is critical as we re-execute all gradle jib builds for every production deployment although the exact same image was already built for the staging environment.
In our CI, the repository where garden checks out the sources into is different on every run (not sure how the folder names are calculated).

Looking back a few months I saw that this did not happen with Garden 0.12.56 and only happened when we (directly) upgraded to Garden 0.12.61, hence my suspicion about the mentioned release/issue.

Your environment

Happens on our CI (linux/amd64), but the example above was executed on an M1 MacBook.

[stefreak]

Hello, thank you for the report! Indeed, the absolute path to the git repository should not matter for version calculation. We'll look into this.

[vvagaytsev]

The fix will be released in 0.13.22.

[dadadom]

Good day,

could this ticket be reopened? I still have the same issue, here is a full reproducer:

$> minikube start
$> garden version # returns 0.13.24
$> cd /tmp
$> mkdir -p garden-testing/umbrella && cd garden-testing/umbrella
$> git init
$> cat >project.garden.yml <<EOL
apiVersion: garden.io/v1
kind: Project
name: umbrella

defaultEnvironment: local

environments:
  - name: local
    defaultNamespace: garden-local

providers:
  - name: local-kubernetes
    environments:
      - local
  - name: jib

sources:
  - name: app
    repositoryUrl: https://github.com/dadadom/app-testing#master
EOL
$> cd ..
$> git clone git@github.com:dadadom/app-testing.git app1
$> git clone git@github.com:dadadom/app-testing.git app2

$> garden --root umbrella link source app app1
$> garden --root umbrella build --log-level=debug # ... -Djib.to.image=app-builder:v-1c7f44ec67 ...
$> garden --root umbrella unlink source app
$> garden --root umbrella link source app app2
$> garden --root umbrella build --log-level=debug # ... -Djib.to.image=app-builder:v-5d90f256ba ...

From my understanding of the logic, there seem (cave: my personal hypothesis) to be two issues.

On the one hand, the calculated hash is still different although the contents of umbrella/.garden/build/app-builder are identical between the two different sources.

On the other hand, at least according to the logs, the hash calculation happens before all files are synced to the build/app-builder directory. If I understand it correctly, the build/* directories are used to determine the version of the sources and the exceptions from .gardenignore` are taken into account here.

❯ /opt/homebrew/bin/garden --root umbrella build --log-level=debug
[verbose] garden version: 0.13.24
Build 🔨
...
ℹ graph                     → Resolving actions and modules...
ℹ git                       → [debug] Scanning Build action app-builder root at /Users/myuser/development/tmp/garden/app2
  → Includes: (none)
  → Excludes: **/.garden/**/*
ℹ git                       → [debug] Found 9 files in Build action app-builder root /Users/myuser/development/tmp/garden/app2
ℹ graph                     → [debug] Found 9 files in module path, filtering by 1 include and 0 exclude globs
ℹ graph                     → [debug] Found 9 files in module path after glob matching
✔ graph                     → Finished resolving graph (took 0 sec)
ℹ garden                    → Finished initializing Garden (took 1.5 sec)

─
The following actions are linked to a local path:
  Build type=jib-container name=app-builder linked to path /Users/myuser/development/tmp/garden/app2
─
ℹ build.app-builder         → [debug] resolve Build type=jib-container name=app-builder is ready.
ℹ build.app-builder         → Getting status for Build app-builder (type jib-container)...
ℹ build.app-builder         → [debug] Spawning '/Users/myuser/.garden/tools/docker/1cbaf5c26b78806e/docker/docker images app-builder:v-6447dfc5dc -q' in /Users/myuser/development/tmp/garden/umbrella
ℹ build.app-builder         → Status is not ready, app-builder will be built
ℹ build.app-builder         → Building app-builder (type jib-container) at version v-aa663d09d4...
ℹ build.app-builder         → [verbose] Syncing sources (8 files)...
ℹ build.app-builder         → [debug] Syncing 8 files from ../app2 to .garden/build/app-builder (and removing any extraneous files)
ℹ build.app-builder         → [verbose] Done syncing sources (took 0.5 sec)
...
ℹ build.app-builder         → [debug] Execing /Users/myuser/development/tmp/garden/app2/gradlew jibDockerBuild -Djib.to.image=app-builder:v-6447dfc5dc -Djib.container.args=GARDEN_MODULE_VERSION=v-6447dfc5dc,GARDEN_ACTION_VERSION=v-6447dfc5dc -Dstyle.color=always -Djansi.passthrough=true -Djib.console=plain
...
Done! ✔️

Please let me know if I am misunderstanding something and the hashes don't actually matter, but at least the execution of the jib build happens way too often ... ;-)

[stefreak]

@dadadom Sorry for closing this despite the issue still being present! We'll look into this and post updates here.

[dadadom]

Just validated that this issue still exists on 0.13.25.