vendir succeeds when includePath list item does not exist?

[caphrim007]

imho this is a bug, but I'm asking first in case this is a "functions as designed". If it is functioning as designed, then might I humbly request that design be revisited.

I have a config which is similar to what is shown below (git repos are different)

---
apiVersion: vendir.k14s.io/v1alpha1
kind: Config
directories:
- path: .vendir
  contents:
    - path: service
      git:
        url: [email protected]:org/software.git
        ref: 40ef6a
      includePaths:
        - k8s/modules/base/*
        - this/*
        - does/not/exist/*

I can guarantee that there are files in the first list item (the k8s path). The other two paths I made up.

When I run vendir sync, the output that I get is

Fetching: .vendir + service (git from [email protected]:org/software.git@40ef6a)

  --> git init
 ...bunch of git command output here...


Lock config

apiVersion: vendir.k14s.io/v1alpha1
directories:
- contents:
  - git:
      commitTitle: 'fix: remove sharder annotations'
      sha: 40ef6a85a4fa84a23a0193db9ea2773ba3b5614e
    path: service
  path: .vendir
kind: LockConfig

Succeeded

I can verify this is successful with the output of $? as well

$ echo $?
0

Is this expected behavior?

If so, I think this can very likely lead to some (bad) unintended consequences. The worst being that the end-user trusts that vendir will arrange some files correctly, when it actually doesn't.

For example, consider kubernetes manifests via ytt being vendir'd. Due to "reasons" (network hiccup, fat fingered path, path not existing at a particular version, etc) the paths include invalid paths. vendir produces a set of files and ignores the paths it couldn't find. k8s app gets deployed without a subset of content. The world spirals into chaos.

Thoughts?

[cppforlife]

@caphrim007 currently that's intentional behaviour.

Due to "reasons" (network hiccup, fat fingered path, path not existing at a particular version, etc) the paths include invalid paths. vendir produces a set of files and ignores the paths it couldn't find

network hiccup would result in a much earlier failure at asset download time. includePaths/excludePaths are filters are all has been successfully downloaded.

making a mistake is definitely a possibility though. i dont think we can change default behaviour at this point; but, ill have to think about how to enhance this feature to provide you with extra safety. (globs are typically meant to represent 0+, but in your case, you really want 1+.)

[github-actions[bot]]

This issue is being marked as stale due to a long period of inactivity and will be closed in 5 days if there is no response.